@signageos/front-applet 8.2.1 → 8.2.2

package/docs/sos_management/network.md

@@ -4,24 +4,25 @@ sidebar_position: 0
 
 # network
 
-The `sos.management.network` API groups together methods for networking.
+The `sos.management.network` API groups together networking methods. For Wi-Fi setup, use the [Wi-Fi API](https://developers.signageos.io/sdk/sos_management/wifi).
 
-:::info
+<details>
+    <summary>Network Management Capabilities</summary>
+		| Capability | Description |
+		|:------------|:-------------|
+		| `NETWORK_INFO` | If device supports returning network information |
 
-Use `sos.management.supports('NETWORK_INFO')` to check if the device supports managing the network setup.
-
-:::
+		If you want to check if the device supports this capability, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+</details>
 
 ## Methods
 
 ### disableInterface()
 
-The `disableInterface()` disables a network interface.
+The `disableInterface()` turns off a selected network interface.
 
 :::warning
-
-Don't use this method to disable Wi-Fi. Use [Wi-Fi API](./wifi) to enable/disable Wi-Fi.
-
+Don't use this method to disable Wi-Fi. Use [Wi-Fi API](https://developers.signageos.io/sdk/sos_management/wifi) to turn Wi-Fi on/off.
 :::
 
 ```ts expandable
@@ -30,17 +31,32 @@ disableInterface(interfaceName: string): Promise<void>;
 
 #### Params
 
-| Name            | Type     | Required         | Description                                                                                        |
-|-----------------|----------|------------------|----------------------------------------------------------------------------------------------------|
-| `interfaceName` | `string` |  <div>Yes</div>  | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
+| Name            | Type     | Required         | Description                                                                                          |
+|-----------------|----------|------------------|------------------------------------------------------------------------------------------------------|
+| `interfaceName` | `string` |  <div>Yes</div>  | The interface name which can be retrieved from the list of interfaces returned by `listInterfaces()` |
+
+#### Return value
+
+A promise that resolves when the network interface is disabled.
+
+#### Possible errors
+
+
+- If the interface name is invalid.
+- If the device does not support network management.
+
+#### Example
+
+```ts
+await sos.management.network.disableInterface('eth0');
+```
 
 <Separator />
 
 ### listInterfaces()
 
-The `listInterface()` method returns list of all network interfaces, and their information like MAC address, IP address, etc. Wifi
-connection strength is described as percentage in range from 0 to 100, linearly converted from dBm -90 to -30 respectively based on
-platform.
+The `listInterface()` method returns a list of all network interfaces, and their information like MAC address, IP address, etc.
+Wi-Fi connection strength is described as a percentage in the range from 0 to 100, linearly converted from dBm -90 to -30, respectively, based on the platform.
 
 ```ts expandable
 listInterfaces(): Promise<INetworkInterface[]>;
@@ -67,16 +83,33 @@ type NetworkInterface = 'wifi' | 'ethernet';
 
 ```
 
+#### Return value
+
+Resolves to an array of network interfaces with their information.
+
+#### Example
+
+```ts
+const interfaces = await sos.management.network.listInterfaces();
+interfaces.forEach((iface) => {
+   console.log(`Interface: ${iface.name}, IP: ${iface.ipAddress}, MAC: ${iface.macAddress}`);
+});
+```
+
+:::note[GitHub Example]
+
+- [ Applet Example with Network Interfaces](https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/network)
+
+:::
+
 <Separator />
 
 ### setDHCP(interfaceName)
 
-The `setDHCP()` method configures a network interface to use DHCP.
+The `setDHCP()` method configures a selected network interface to use DHCP.
 
 :::warning
-
-Wi-Fi interface can be configured with this method but it has to be first enabled via the [Wi-Fi API](./wifi#enableClient).
-
+Wi-Fi interface can be configured with this method, but it has to be first enabled via the [Wi-Fi API](https://developers.signageos.io/sdk/sos_management/wifi#enableclient).
 :::
 
 ```ts expandable
@@ -85,9 +118,19 @@ setDHCP(interfaceName: string): Promise<void>;
 
 #### Params
 
-| Name            | Type     | Required         | Description                                                                                        |
-|-----------------|----------|------------------|----------------------------------------------------------------------------------------------------|
-| `interfaceName` | `string` |  <div>Yes</div>  | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
+| Name            | Type     | Required         | Description                                                                                          |
+|-----------------|----------|------------------|------------------------------------------------------------------------------------------------------|
+| `interfaceName` | `string` |  <div>Yes</div>  | The interface name which can be retrieved from the list of interfaces returned by `listInterfaces()` |
+
+#### Return value
+
+A promise that resolves when the network interface is set to use DHCP.
+
+#### Example
+
+```ts
+await sos.management.network.setDHCP('eth0');
+```
 
 <Separator />
 
@@ -96,9 +139,7 @@ setDHCP(interfaceName: string): Promise<void>;
 The `setManual()` method manually configures a network interface.
 
 :::warning
-
-Wi-Fi interface can be configured with this method but it has to be first enabled via the [Wi-Fi API](./wifi#enableClient).
-
+Wi-Fi interface can be configured with this method, but it has to be first enabled via the [Wi-Fi API](https://developers.signageos.io/sdk/sos_management/wifi#enableclient).
 :::
 
 ```ts expandable
@@ -115,10 +156,24 @@ interface INetworkOptions {
 
 #### Params
 
-| Name            | Type              | Required         | Description                                                                                        |
-|-----------------|-------------------|------------------|----------------------------------------------------------------------------------------------------|
-| `interfaceName` | `string`          |  <div>Yes</div>  | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
-| `options`       | `INetworkOptions` |  <div>Yes</div>  | The network configuration options.                                                                 |
+| Name                   | Type              | Required         | Description                                                                                          |
+|------------------------|-------------------|------------------|------------------------------------------------------------------------------------------------------|
+| `interfaceName`        | `string`          |  <div>Yes</div>  | The interface name which can be retrieved from the list of interfaces returned by `listInterfaces()` |
+| `options`              | `INetworkOptions` |  <div>Yes</div>  | The network configuration options.                                                                   |
+| `options.localAddress` | `string`          |  <div>Yes</div>  | The local IP address to be set.                                                                      |
+| `options.gateway`      | `string`          |  <div>Yes</div>  | The gateway IP address to be set.                                                                    |
+| `options.netmask`      | `string`          |  <div>Yes</div>  | The netmask to be set.                                                                               |
+| `options.dns`          | `string[]`        |  <div>Yes</div>  | The DNS server array of IP addresses to be set.                                                      |
+
+#### Return value
+
+A promise that resolves when the network is set.
+
+#### Possible errors
+
+
+- If the network options are invalid.
+- If the device does not support network management.
 
 <Separator />
 

package/docs/sos_management/os.md

@@ -6,22 +6,48 @@ sidebar_position: 0
 
 The `sos.management.os` API groups together methods for retrieving information about the system.
 
+
+<details>
+    <summary>OS Management Capabilities</summary>
+		| Capability | Description |
+		|:------------|:-------------|
+		| `SYSTEM_CPU` | If device supports collecting CPU usage information |
+		| `SYSTEM_MEMORY` | If device supports collecting memory usage information |
+
+		If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+</details>
+
 ## Methods
 
 ### getCpuUsage()
 
-The `getCpuUsage()` method returns current CPU usage (ranging 0-100).
+The `getCpuUsage()` method returns the current total CPU usage (ranging from 0 to 100%).
 
 ```ts expandable
 getCpuUsage(): Promise<number>;
 ```
 
+#### Return value
+
+Resolves to the current CPU usage percentage.
+
+#### Possible errors
+
+If the CPU usage is not supported.
+
+#### Example
+
+```ts
+const cpuUsage = await sos.management.os.getCpuUsage();
+console.log(`Current CPU usage is: ${cpuUsage}%`);
+```
+
 <Separator />
 
 ### getInfo()
 
-The `getInfo()` method returns info about the system of the device, such as what current version of it is installed on a device. Major
-version of current operating system. It's usually 1 or 2 digits including or excluding dot notation.
+The `getInfo()` method returns info about the system of the device, such as what current version of it is installed on the device. Major
+version of the current operating system. It's usually 1 or 2 digits, including or excluding dot notation.
 
 ```ts expandable
 getInfo(): Promise<IOSInfo>;
@@ -40,19 +66,48 @@ interface IOSInfo {
 
 ```
 
+#### Return value
+
+Resolves to an object containing information about the operating system.
+
+#### Example
+
+```ts
+const osInfo = await sos.management.os.getInfo();
+console.log(`Current OS version is: ${osInfo.version}`);
+```
+
 <Separator />
 
 ### getMemoryUsage()
 
-The `getMemoryUsage()` method returns total memory amount in bytes, currently used memory and remaining free memory.
+The `getMemoryUsage()` method returns the total memory amount in bytes, the currently used memory, and the remaining free memory.
 
 ```ts expandable
 getMemoryUsage(): Promise<SystemMemoryInfo>;
 // show-more
+/**
+ * Returned object from `getMemoryUsage()` method.
+ */
 interface SystemMemoryInfo {
     used: number;
     total: number;
     free: number;
 }
 
+```
+
+#### Return value
+
+Resolves to an object containing total, used, and free memory in bytes.
+
+#### Possible errors
+
+If the memory usage is not supported.
+
+#### Example
+
+```ts
+const memoryUsage = await sos.management.os.getMemoryUsage();
+console.log(`Memory usage: ${((memoryUsage.used / memoryUsage.total) * 100).toFixed(2)}%`);
 ```

package/docs/sos_management/package.md

@@ -4,13 +4,23 @@ sidebar_position: 0
 
 # package
 
-The `sos.management.package` API groups together methods for installing and stopping custom Android packages.
+The `sos.management.package` API groups together methods for installing custom Android packages.
+
+<details>
+    <summary>Package Management Capabilities</summary>
+		| Capability | Description |
+		|:------------|:-------------|
+		| `PACKAGE_INSTALL` | If device supports installing packages |
+		| `STOP_PACKAGE` | If device supports stopping packages |
+
+		If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+</details>
 
 ## Methods
 
 ### install()
 
-The `install()` method installs a certain package from the specified url.
+The `install()` method installs a particular package from the specified URL.
 
 ```ts expandable
 install(baseUrl: string, packageName: string, version: string, build: string | null): Promise<void>;
@@ -21,10 +31,22 @@ install(baseUrl: string, packageName: string, version: string, build: string | n
 | Name          | Type             | Required         | Description                        |
 |---------------|------------------|------------------|------------------------------------|
 | `baseUrl`     | `string`         |  <div>Yes</div>  | URL where the package is available |
-| `packageName` | `string`         |  <div>Yes</div>  | Name of the android package        |
+| `packageName` | `string`         |  <div>Yes</div>  | Name of the Android package        |
 | `version`     | `string`         |  <div>Yes</div>  | Package version                    |
 | `build`       | `string \| null` |  <div>Yes</div>  | If relevant for your device        |
 
+#### Return value
+
+A promise that resolves when the package is successfully installed.
+
+#### Possible errors
+
+
+- If `baseUrl` is not a valid URL
+- If `packageName` is not a string
+- If `version` is not a string
+- If `build` is not a string or null
+
 <Separator />
 
 ### stop()

package/docs/sos_management/power.md

@@ -7,6 +7,19 @@ sidebar_position: 0
 The `sos.management.power` API groups together methods related to the power state of the device. Such as rebooting, shutting down,
 setting timers.
 
+<details>
+    <summary>Power Management Capabilities</summary>
+		| Capability | Description |
+		|:------------|:-------------|
+		| `SYSTEM_REBOOT` | If device supports system reboot power action |
+		| `APP_RESTART` | If device supports app restart power action |
+		| `TIMERS_PROPRIETARY` | If device supports proprietary timers |
+		| `TIMERS_NATIVE` | If device supports native timers |
+		| `SCHEDULE_POWER_ACTION` | If device supports scheduled power actions |
+
+		If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+</details>
+
 ## Methods
 
 ### appRestart()
@@ -17,6 +30,10 @@ The `appRestart()` method initializes a restart of the signageOS app.
 appRestart(): Promise<void>;
 ```
 
+#### Return value
+
+Resolves when the app restart is initiated.
+
 #### Example
 
 ```ts
@@ -33,6 +50,10 @@ Removes all scheduled reboot rules from the device.
 clearScheduledReboots(): Promise<void>;
 ```
 
+#### Return value
+
+Resolves when all scheduled reboots are cleared.
+
 #### Example
 
 ```ts
@@ -58,6 +79,14 @@ interface IProprietaryTimer {
 
 ```
 
+#### Return value
+
+Resolves with an array of proprietary timers.
+
+#### Possible errors
+
+If the timers cannot be retrieved.
+
 #### Example
 
 ```ts
@@ -68,11 +97,14 @@ const timers = await sos.management.power.getProprietaryTimers();
 
 ### getScheduledReboots()
 
-Returns all scheduled reboot rules on the device.
+Returns all scheduled reboot rules on the device set by the `setScheduledReboot()` method.
 
 ```ts expandable
 getScheduledReboots(): Promise<IScheduledRebootActions[]>;
 // show-more
+/**
+ * Interface representing the scheduled reboot action.
+ */
 interface IScheduledRebootActions {
     id: string;
     rule: IScheduledRebootRule;
@@ -85,6 +117,10 @@ interface IScheduledRebootRule {
 
 ```
 
+#### Return value
+
+Resolves with an array of scheduled reboot actions.
+
 #### Example
 
 ```ts
@@ -110,17 +146,21 @@ interface ITimer {
 
 ```
 
+#### Return value
+
+Resolves with an array of timers.
+
 #### Example
 
 ```ts
-const timers = await sos.management.power.getTimers();
+await sos.management.power.getTimers();
 ```
 
 <Separator />
 
 ### removeScheduledReboot()
 
-Removes scheduled reboot rule from the device.
+Removes scheduled reboot rule from the device (if it exists).
 
 ```ts expandable
 removeScheduledReboot(id: string): Promise<void>;
@@ -128,9 +168,17 @@ removeScheduledReboot(id: string): Promise<void>;
 
 #### Params
 
-| Name | Type     | Required         | Description                     |
-|------|----------|------------------|---------------------------------|
-| `id` | `string` |  <div>Yes</div>  | - ID of the rule to be removed. |
+| Name | Type     | Required         | Description                   |
+|------|----------|------------------|-------------------------------|
+| `id` | `string` |  <div>Yes</div>  | ID of the rule to be removed. |
+
+#### Return value
+
+Resolves when the scheduled reboot is removed.
+
+#### Possible errors
+
+If the `id` is not a string or is empty.
 
 #### Example
 
@@ -138,7 +186,7 @@ removeScheduledReboot(id: string): Promise<void>;
 // Get scheduled reboots
 const scheduledReboots = await sos.management.power.getScheduledReboots();
 
-// Remove scheduled reboot
+// Remove scheduled reboot on the first position
 await sos.management.power.removeScheduledReboot(scheduledReboots[0].id);
 ```
 
@@ -163,22 +211,38 @@ setProprietaryTimer(type: ProprietaryTimerType, timeOn: string | null, timeOff:
 | `weekdays`          | `string[]`          |  <div>Yes</div>  | The days of the week when the timer should be active (`mon`, ..., `sun`).               |
 | `keepAppletRunning` | `boolean`           |  <div>No</div>   | If `true`, the applet will be kept running when the timer is active on certain devices. |
 
+#### Return value
+
+Resolves when the proprietary timer is set.
+
+#### Possible errors
+
+
+- If the timer type is invalid or if the time format is incorrect.
+- If the weekdays array contains an invalid weekday.
+- If the `keepAppletRunning` parameter is not a boolean.
+- If the `timeOn` or `timeOff` parameters do not match the expected time format (`HH:mm:ss`).
+- If the `weekdays` parameter is not an array of strings.
+- If the `weekdays` array contains an invalid weekday.
+- If the `timeOn` or `timeOff` parameters do not match the expected time format (`HH:mm:ss`).
+- If the `type` parameter is not a valid timer type (e.g., `TIMER_1`, `TIMER_2`, ..., `TIMER_7`).
+
 #### Example
 
 ```ts
-await sos.management.power.setProprietaryTimer("TIMER_20", "08:00", "22:00", ["mon", "tue", "wed", "thu", "fri", "sat", "sun"], 30);
+await sos.management.power.setProprietaryTimer("TIMER_2", "08:00:00", "22:00:00", ["mon", "tue", "wed", "thu", "fri", "sat", "sun"], false);
 ```
 
 <Separator />
 
 ### setScheduledReboot()
 
-Schedule automatic reboot on the device. Calling this function will create one rule.
-It is possible to set multiple rules, which can be later obtained by `getScheduledReboots` function.
+Schedule an automatic reboot on the device. Calling this function will create one rule.
+It is possible to set multiple rules, which can be later obtained by the `getScheduledReboots` function.
 
 :::note
-- Setting new scheduled reboot on device might take up to 10 minutes to show in Box.
-- Every new scheduled reboot rule gets unique identifier generated by device, it might be later returned by `getScheduledReboots()`.
+- Setting a new scheduled reboot on the device might take up to 10 minutes to show in the Box.
+- Every new scheduled reboot rule gets a unique identifier generated by the device, which might be later returned by `getScheduledReboots()`.
 :::
 
 ```ts expandable
@@ -190,10 +254,23 @@ type WeekdayType = 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' |
 
 #### Params
 
-| Name       | Type            | Required         | Description                                                      |
-|------------|-----------------|------------------|------------------------------------------------------------------|
-| `weekdays` | `WeekdayType[]` |  <div>Yes</div>  |                                                                  |
-| `time`     | `string`        |  <div>Yes</div>  | - Time when the reboot should be executed. Format is `HH:mm:ss`. |
+| Name       | Type            | Required         | Description                                                    |
+|------------|-----------------|------------------|----------------------------------------------------------------|
+| `weekdays` | `WeekdayType[]` |  <div>Yes</div>  |                                                                |
+| `time`     | `string`        |  <div>Yes</div>  | Time when the reboot should be executed. Format is `HH:mm:ss`. |
+
+#### Return value
+
+Resolves when the scheduled reboot is set.
+
+#### Possible errors
+
+
+- If the `weekdays` parameter is not an array of strings.
+- If the `time` parameter does not match the expected time format (`HH:mm:ss`).
+- If the `weekdays` array contains an invalid weekday.
+- If the `time` parameter is not a string or does not match the expected format (`HH:mm:ss`).
+- If the `weekdays` array is empty or contains invalid values.
 
 #### Example
 
@@ -209,7 +286,7 @@ await sos.management.power.setScheduledReboot(["MONDAY", "FRIDAY"], "19:30:00");
 
 ### setTimer()
 
-The `setTimers()` method creates or updates a native timer.
+The `setTimer()` method creates or updates a native timer.
 
 ```ts expandable
 setTimer(type: keyof typeof TimerType, timeOn: string | null, timeOff: string | null, weekdays: string[], volume: number): Promise<void>;
@@ -225,12 +302,33 @@ setTimer(type: keyof typeof TimerType, timeOn: string | null, timeOff: string |
 | `weekdays` | `string[]`                                                                                |  <div>Yes</div>  | The days of the week when the timer should be active (`mon`, ..., `sun`). |
 | `volume`   | `number`                                                                                  |  <div>Yes</div>  | The volume level set when the device is turned on.                        |
 
+#### Return value
+
+Resolves when the timer is set.
+
+#### Possible errors
+
+
+- If the timer type is invalid.
+- If the time format is incorrect.
+- If the weekdays array contains an invalid weekday.
+- If the `volume` parameter is not a number between 0 and 100.
+- If the `timeOn` or `timeOff` parameters do not match the expected time format (`HH:mm:ss`).
+- If the `weekdays` parameter is not an array of strings.
+- If the `type` parameter is not a valid timer type (e.g., `TIMER_1`, `TIMER_2`, ..., `TIMER_7`).
+
 #### Example
 
 ```ts
-await sos.management.power.setTimer("TIMER_1", "08:00", "22:00", ["mon", "tue", "wed", "thu", "fri", "sat", "sun"], 30);
+await sos.management.power.setTimer("TIMER_1", "08:00:00", "22:00:00", ["mon", "tue", "wed", "thu", "fri", "sat", "sun"], 30);
 ```
 
+:::note[GitHub Example]
+
+- [ Applet Example for Native Timers](https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/timer)
+
+:::
+
 <Separator />
 
 ### systemReboot()
@@ -241,12 +339,22 @@ The `systemReboot()` method initializes a system reboot.
 systemReboot(): Promise<void>;
 ```
 
+#### Return value
+
+Resolves when the system reboot is initiated.
+
 #### Example
 
 ```ts
 await sos.management.power.systemReboot();
 ```
 
+:::note[GitHub Example]
+
+- [ Applet Example for System Reboot](https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/system-reboot)
+
+:::
+
 <Separator />
 
 ### unsetProprietaryTimer()
@@ -264,6 +372,14 @@ unsetProprietaryTimer(type: ProprietaryTimerType): Promise<void>;
 |--------|---------------------|------------------|----------------------------------------------------|
 | `type` | ``TIMER_${number}`` |  <div>Yes</div>  | The type of the timer (`TIMER_1`, ..., `TIMER_7`). |
 
+#### Return value
+
+Resolves when the proprietary timer is removed.
+
+#### Possible errors
+
+If the timer type is invalid.
+
 #### Example
 
 ```ts
@@ -286,6 +402,14 @@ unsetTimer(type: keyof typeof TimerType): Promise<void>;
 |--------|-------------------------------------------------------------------------------------------|------------------|----------------------------------------------------|
 | `type` | `"TIMER_1" \| "TIMER_2" \| "TIMER_3" \| "TIMER_4" \| "TIMER_5" \| "TIMER_6" \| "TIMER_7"` |  <div>Yes</div>  | The type of the timer (`TIMER_1`, ..., `TIMER_7`). |
 
+#### Return value
+
+Resolves when the timer is removed.
+
+#### Possible errors
+
+If the timer type is invalid.
+
 #### Example
 
 ```ts