@amazon-devices/kepler-system-info 1.0.2

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 Amazon.com, Inc. or its affiliates.  All rights reserved.
+
+These materials are licensed as "Program Materials" under the Program Materials License Agreement (the "Agreement").  The Agreement is available at https://developer.amazon.com/support/legal/pml.  See the Agreement for the specific terms and conditions of the Agreement.  Capitalized terms not defined in this file have the meanings given to them in the Agreement.  
+
+If you do not agree to the above terms and conditions, you may not use any file in this package. 
+
+YOUR USE OF THE PROGRAM MATERIALS IN OR ASSOCIATED WITH THIS PACKAGE IS AT YOUR SOLE RISK.  IN NO EVENT WILL AMAZON BE LIABLE FOR ANY DAMAGES, INCLUDING WITHOUT LIMITATION ANY DIRECT, INDIRECT, CONSEQUENTIAL, SPECIAL, INCIDENTAL, OR PUNITIVE DAMAGES (INCLUDING FOR ANY LOSS OF GOODWILL, BUSINESS INTERRUPTION, LOST PROFITS OR DATA, OR COMPUTER FAILURE OR MALFUNCTION) ARISING FROM OR RELATING TO SUCH PROGRAM MATERIALS, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, EVEN IF AMAZON HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS AND DISCLAIMERS APPLY EXCEPT TO THE EXTENT PROHIBITED BY APPLICABLE LAW.

package/README.md

@@ -0,0 +1,183 @@
+# @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:
+
+```json
+"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
+
+```ts
+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
+
+```ts
+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
+
+```ts
+try {
+    console.log('Is running in emulator: ', systemInfo.isEmulator());
+} catch (error) {
+    console.error(error);
+}
+```
+
+## Accessing {@link IOperatingSystemInfo} interface object
+
+```js
+import { IOperatingSystemInfo } from '@amazon-devices/kepler-system-info';
+try {
+    let osInfo = systemInfo.getOperatingSystemInfo();
+} catch (error) {
+    console.error(error);
+}
+```
+
+### OperatingSystem Display Name
+
+```ts
+try {
+    console.log('OS display name: ', osInfo.getDisplayName());
+} catch (error) {
+    console.error(error);
+}
+```
+
+### OperatingSystem Codename
+
+```ts
+try {
+    console.log('OS codename: ', osInfo.getCodeName());
+} catch (error) {
+    console.error(error);
+}
+```
+
+### OperatingSystem Version
+
+```ts
+try {
+    console.log('OS version: ', osInfo.getVersion());
+} catch (error) {
+    console.error(error);
+}
+```
+
+## Accessing Operating System {@link IBuildInfo} interface object
+
+```ts
+import { IBuildInfo } from '@amazon-devices/kepler-system-info';
+try {
+    let buildInfo = osInfo.getBuildInfo();
+} catch (error) {
+    console.error(error);
+}
+```
+
+### OS Build Display Name
+
+```ts
+try {
+    console.log('OS build display name: ', buildInfo.getDisplayName());
+} catch (error) {
+    console.error(error);
+}
+```
+
+### OS Build ID
+
+```ts
+try {
+    console.log('OS build ID: ', buildInfo.getId());
+} catch (error) {
+    console.error(error);
+}
+```
+
+### OS Build Variant
+
+```ts
+try {
+    console.log('OS build variant: ', buildInfo.getVariant());
+} catch (error) {
+    console.error(error);
+}
+```
+
+### OS Build Timestamp
+
+```ts
+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
+
+```ts
+try {
+    let tags = buildInfo.getTags();
+    console.log('OS build tags: ', JSON.stringify(tags));
+} catch (error) {
+    console.error(error);
+}
+```
+
+### OS Build Fingerprint
+
+```ts
+try {
+    console.log('OS build fingerprint: ', buildInfo.getFingerprint());
+} catch (error) {
+    console.error(error);
+}
+```