@amazon-devices/kepler-system-info

Overview

@amazon-devices/kepler-system-info provides SystemInfo API for querying basic system-level information about the running operating system instance, including system uptime, operating system details, and build information.

Getting Started

Installation

1. Add the JavaScript library dependency in the package.json file:

"dependencies": {
    ...
    "@amazon-devices/kepler-system-info": "~0.0.1"
}

2. Regenerate the package-lock.json file using the npm install command.

Accessing {@link ISystemInfo} interface object

import { SystemInfoModule } from '@amazon-devices/kepler-system-info';
import { ISystemInfo } from '@amazon-devices/kepler-system-info';
try {
    let systemInfo = SystemInfoModule.getSystemInfo();
} catch (error) {
    console.error(error);
}

System Uptime

import { MonotonicDuration } from '@amazon-devices/kepler-system-info';
import { RawTimeValue } from '@amazon-devices/kepler-system-info';

try {
    let uptime = await systemInfo.getUptime();
    console.log(
        'Uptime seconds: ',
        uptime.time.seconds,
        ' nanoseconds: ',
        uptime.time.nanoseconds
    );
} catch (error) {
    console.error(error);
}

Emulator

try {
    console.log('Is running in emulator: ', systemInfo.isEmulator());
} catch (error) {
    console.error(error);
}

Accessing {@link IOperatingSystemInfo} interface object

import { IOperatingSystemInfo } from '@amazon-devices/kepler-system-info';
try {
    let osInfo = systemInfo.getOperatingSystemInfo();
} catch (error) {
    console.error(error);
}

OperatingSystem Display Name

try {
    console.log('OS display name: ', osInfo.getDisplayName());
} catch (error) {
    console.error(error);
}

OperatingSystem Codename

try {
    console.log('OS codename: ', osInfo.getCodeName());
} catch (error) {
    console.error(error);
}

OperatingSystem Version

try {
    console.log('OS version: ', osInfo.getVersion());
} catch (error) {
    console.error(error);
}

Accessing Operating System {@link IBuildInfo} interface object

import { IBuildInfo } from '@amazon-devices/kepler-system-info';
try {
    let buildInfo = osInfo.getBuildInfo();
} catch (error) {
    console.error(error);
}

OS Build Display Name

try {
    console.log('OS build display name: ', buildInfo.getDisplayName());
} catch (error) {
    console.error(error);
}

OS Build ID

try {
    console.log('OS build ID: ', buildInfo.getId());
} catch (error) {
    console.error(error);
}

OS Build Variant

try {
    console.log('OS build variant: ', buildInfo.getVariant());
} catch (error) {
    console.error(error);
}

OS Build Timestamp

import { RealTimeInstant } from '@amazon-devices/kepler-system-info';
import { RawTimeValue } from '@amazon-devices/kepler-system-info';

try {
    let timestamp = buildInfo.getTimestamp();
    console.log(
        'OS build time seconds: ',
        timestamp.time.seconds,
        ' nanoseconds: ',
        timestamp.time.nanoseconds
    );
} catch (error) {
    console.error(error);
}

OS Build Tags

try {
    let tags = buildInfo.getTags();
    console.log('OS build tags: ', JSON.stringify(tags));
} catch (error) {
    console.error(error);
}

OS Build Fingerprint

try {
    console.log('OS build fingerprint: ', buildInfo.getFingerprint());
} catch (error) {
    console.error(error);
}