@signageos/front-applet 7.2.0 → 8.0.0

package/docs/sos_management/debug.md

@@ -0,0 +1,33 @@
+# debug
+
+The `sos.management.debug` API groups together method for working with native debug mode.
+
+## Methods
+
+### disable()
+
+The `enable()` method disables the [native debug](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) mode.
+
+```ts expandable
+disable(): Promise<void>;
+```
+
+<Separator />
+
+### enable()
+
+The `enable()` method enables the [native debug](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) mode.
+
+```ts expandable
+enable(): Promise<void>;
+```
+
+<Separator />
+
+### isEnabled()
+
+The `isEnabled()` method returns whether the [native debug](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) mode is enabled.
+
+```ts expandable
+isEnabled(): Promise<boolean>;
+```

package/docs/sos_management/firmware.md

@@ -0,0 +1,86 @@
+# firmware
+
+The `sos.management.firmware` API groups together methods for working with the firmware of the device.
+
+## Methods
+
+### getType()
+
+The `getType()` method returns the type of the firmware currently installed on the device.
+
+This information, when combined with firmware version, can be used to identify a correct firmware image to install on the current device.
+
+```ts expandable
+getType(): Promise<string>;
+```
+
+<Separator />
+
+### getVersion()
+
+The `getVersion()` method returns the version of the firmware currently installed on the device.
+
+```ts expandable
+getVersion(): Promise<string>;
+```
+
+<Separator />
+
+### upgrade(baseUrl, version)
+
+The `upgrade(baseUrl, version)` does the same as `upgrade(version, baseUrl)`.
+
+```ts expandable
+upgrade(baseUrl: string, version: string): Promise<void>;
+```
+
+#### Params
+
+| Name      | Type     | Description                                      |
+|-----------|----------|--------------------------------------------------|
+| `baseUrl` | `string` | The server URL where firmware files are located. |
+| `version` | `string` | The version of the firmware being installed.     |
+
+<Separator />
+
+### upgrade(fwUri)
+
+The `upgrade(fwUri)` method initializes a firmware upgrade. Open users can upgrade fw passing FQN
+uri where the firmware main file is located.
+
+This file type/extension differs for every platform. E.g.:
+- SSSP: http://example.com/fw/T-0.0.0.msd
+- Tizen: http://example.com/fw/T-0.0.0.bem
+- Webos: http://example.com/fw/0.0.0.epk
+- Brightsign: http://example.com/fw/hd2-0.0.0.bsfw
+- Linux: http://example.com/fw/rpi-0.0.0.img.zip
+- Android: http://example.com/fw/FB-00.0.0.zip
+
+```ts expandable
+upgrade(fwUri: string): Promise<void>;
+```
+
+#### Params
+
+| Name    | Type     | Description                                      |
+|---------|----------|--------------------------------------------------|
+| `fwUri` | `string` | FQN uri where the firmware main file is located. |
+
+<Separator />
+
+### upgrade(version, baseUrl)
+
+The `upgrade(version, baseUrl?)` method initializes a firmware upgrade using version and baseUrl. Platform users can install general
+firmware version directly with passing just version number. Optionally, the baseUrl can be passed as argument to specify server where
+the firmware files are accessible.
+
+```ts expandable
+upgrade(version: string, baseUrl?: string): Promise<void>;
+```
+
+#### Params
+
+| Name                   | Type     | Description                                                                                           |
+|------------------------|----------|-------------------------------------------------------------------------------------------------------|
+| `version`              | `string` | The version of the firmware being installed.                                                          |
+| `baseUrl` *(optional)* | `string` | Optional server URL where firmware files are located.<br/>(Default value: `"https://2.signageos.io"`) |

package/docs/sos_management/index.md

@@ -0,0 +1,212 @@
+# sos.management
+
+The `sos.management` API group provides methods for managing the device. Through this API things like device firmware,
+battery status, brightness, network information, remote control, power, time or volume can be monitored.
+
+## Methods
+
+### factoryReset()
+
+The `factoryReset()` method initializes the factory reset of the device.
+
+```ts expandable
+factoryReset(): Promise<void>;
+```
+
+<Separator />
+
+### getBatteryStatus()
+
+The `getBatteryStatus()` method returns information about the battery of the device.
+
+```ts expandable
+getBatteryStatus(): Promise<IBatteryStatus>;
+// show-more
+interface IBatteryStatus {
+    readonly chargeType: string;
+    readonly isCharging: boolean;
+    readonly lastChargingTime: Date;
+    readonly percentage: number;
+    readonly updatedAt: Date;
+}
+
+```
+
+<Separator />
+
+### getBrand()
+
+The `getBrand()` method returns the manufacturer brand of the device.
+
+```ts expandable
+getBrand(): Promise<string>;
+```
+
+<Separator />
+
+### getExtendedManagementUrl()
+
+The `getExtendedManagementUrl()` method returns the management url of the device.
+
+:::info
+
+This is currently only implemented for the MagicInfo on Tizen platform.
+
+:::
+
+```ts expandable
+getExtendedManagementUrl(): Promise<string | null>;
+```
+
+<Separator />
+
+### getModel()
+
+The `getModel()` method returns the model of the device.
+
+```ts expandable
+getModel(): Promise<string>;
+```
+
+<Separator />
+
+### getSerialNumber()
+
+The `getSerialNumber()` method returns the serial number of the device.
+
+```ts expandable
+getSerialNumber(): Promise<string>;
+```
+
+<Separator />
+
+### getTemperature()
+
+The `getTemperature()` method returns the temperature of the device (in 0-100 range of degrees Celsius).
+
+```ts expandable
+getTemperature(): Promise<number>;
+```
+
+<Separator />
+
+### isHardwareAccelerationEnabled()
+
+The `isHardwareAccelerationEnabled()` method returns whether hardware acceleration is enabled.
+
+```ts expandable
+isHardwareAccelerationEnabled(): Promise<boolean>;
+```
+
+<Separator />
+
+### resetSettings()
+
+The `resetSettings()` method initializes the reset of the specific device settings.
+
+:::info
+
+This is currently only implemented on Linux platform.
+
+:::
+
+```ts expandable
+resetSettings(): Promise<void>;
+```
+
+<Separator />
+
+### setExtendedManagementUrl()
+
+The `getExtendedManagementUrl()` set the management url of the device.
+
+:::info
+
+This is currently only implemented for the MagicInfo on Tizen platform.
+
+:::
+
+```ts expandable
+setExtendedManagementUrl(url: string | null): Promise<void>;
+```
+
+#### Params
+
+| Name  | Type             | Description                |
+|-------|------------------|----------------------------|
+| `url` | `string \| null` | The management URL to set. |
+
+<Separator />
+
+### setHardwareAcceleration()
+
+The `setHardwareAcceleration()` method enables or disables hardware acceleration.
+
+```ts expandable
+setHardwareAcceleration(enabled: boolean): Promise<void>;
+```
+
+#### Params
+
+| Name      | Type      | Description                                      |
+|-----------|-----------|--------------------------------------------------|
+| `enabled` | `boolean` | Whether hardware acceleration should be enabled. |
+
+<Separator />
+
+### supports()
+
+The `supports()` method determines whether a queried capability is supported.
+
+```ts expandable
+supports(capability: ManagementCapability): Promise<boolean>;
+// show-more
+type ManagementCapability = 'MODEL' | 'SERIAL_NUMBER' | 'BRAND' | 'OS_VERSION' | 'BATTERY_STATUS' | 'STORAGE_UNITS' | 'TEMPERATURE' | 'SCREENSHOT_UPLOAD' | 'NETWORK_INFO' | 'WIFI' | 'WIFI_SCAN' | 'WIFI_AP' | 'WIFI_STRENGTH' | 'TIMERS_PROPRIETARY' | 'BRIGHTNESS_SCHEDULING' | 'TIMERS_NATIVE' | 'SET_BRIGHTNESS' | 'GET_BRIGHTNESS' | 'SCREEN_RESIZE' | 'SET_TIME' | 'SET_TIMEZONE' | 'GET_TIMEZONE' | 'NTP_TIME' | 'APP_UPGRADE' | 'FIRMWARE_UPGRADE' | 'PACKAGE_INSTALL' | 'SET_VOLUME' | 'GET_VOLUME' | 'SET_REMOTE_CONTROL_ENABLED' | 'SET_DEBUG' | 'SYSTEM_REBOOT' | 'APP_RESTART' | 'DISPLAY_POWER' | 'SERVLET' | 'HARDWARE_LED_SET_COLOR' | 'PROXIMITY_SENSOR' | 'FACTORY_RESET' | 'ORIENTATION_LANDSCAPE' | 'ORIENTATION_PORTRAIT' | 'ORIENTATION_LANDSCAPE_FLIPPED' | 'ORIENTATION_PORTRAIT_FLIPPED' | 'ORIENTATION_AUTO' | 'SCHEDULE_POWER_ACTION' | 'EXTENDED_MANAGEMENT' | 'SYSTEM_CPU' | 'SYSTEM_MEMORY' | 'PROXY' | 'AUTO_RECOVERY' | 'PEER_RECOVERY' | 'FILE_SYSTEM_WIPEOUT' | 'REMOTE_DESKTOP' | 'HOTEL_MODE' | 'VPN' | 'CUSTOM_SCRIPTS' | 'NATIVE_COMMANDS_MDC' | 'DEVICE_OWNER' | 'ACCESSIBILITY_SERVICE' | 'DISPLAY_MANAGER' | 'SECRETS' | 'HARDWARE_ACCELERATION' | 'WIFI_COUNTRY' | AnyString;
+
+type AnyString = string & {};
+
+```
+
+#### Params
+
+| Name         | Type                   | Description                          |
+|--------------|------------------------|--------------------------------------|
+| `capability` | `ManagementCapability` | The capability to check for support. |
+
+<Separator />
+
+### ~getNetworkInfo()~
+
+:::danger
+
+This method was deprecated. Use `sos.management.network.listInterfaces()` instead.
+
+:::
+
+```ts expandable
+getNetworkInfo(): Promise<INetworkInfo>;
+// show-more
+/**
+ * @deprecated use `INetworkInterface` instead
+ */
+interface INetworkInfo {
+    localAddress: string;
+    ethernetMacAddress: string;
+    wifiMacAddress: string;
+    activeInterface: NetworkInterface;
+    gateway?: string;
+    netmask?: string;
+    dns?: string[];
+    interfaceName?: string;
+    /**
+     * Number in range from 0 to 100 (percentage)
+     * mapped from -90 dBm unusable signal
+     * to -30 dBm excellent signal.
+     */
+    wifiStrength?: number;
+    wifiSsid?: string;
+}
+
+type NetworkInterface = 'wifi' | 'ethernet';
+
+```

package/docs/sos_management/network.md

@@ -0,0 +1,197 @@
+# network
+
+The `sos.management.network` API groups together methods for networking.
+
+:::info
+
+Use `sos.management.supports('NETWORK_INFO')` to check if the device supports managing the network setup.
+
+:::
+
+## Methods
+
+### disableInterface()
+
+The `disableInterface()` disables a network interface.
+
+:::warning
+
+Don't use this method to disable Wi-Fi. Use [Wi-Fi API](./wifi) to enable/disable Wi-Fi.
+
+:::
+
+```ts expandable
+disableInterface(interfaceName: string): Promise<void>;
+```
+
+#### Params
+
+| Name            | Type     | Description                                                                                        |
+|-----------------|----------|----------------------------------------------------------------------------------------------------|
+| `interfaceName` | `string` | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
+
+<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.
+
+```ts expandable
+listInterfaces(): Promise<INetworkInterface[]>;
+// show-more
+interface INetworkInterface {
+    type: NetworkInterface;
+    name: string;
+    macAddress: string;
+    localAddress?: string;
+    gateway?: string;
+    netmask?: string;
+    dns?: string[];
+    disabled?: boolean;
+    /**
+     * Number in range from 0 to 100 (percentage)
+     * mapped from -90 dBm unusable signal
+     * to -30 dBm excellent signal.
+     */
+    wifiStrength?: number;
+    wifiSsid?: string;
+}
+
+type NetworkInterface = 'wifi' | 'ethernet';
+
+```
+
+<Separator />
+
+### setDHCP(interfaceName)
+
+The `setDHCP()` method configures a 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).
+
+:::
+
+```ts expandable
+setDHCP(interfaceName: string): Promise<void>;
+```
+
+#### Params
+
+| Name            | Type     | Description                                                                                        |
+|-----------------|----------|----------------------------------------------------------------------------------------------------|
+| `interfaceName` | `string` | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
+
+<Separator />
+
+### setManual(interfaceName, options)
+
+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).
+
+:::
+
+```ts expandable
+setManual(interfaceName: string, options: INetworkOptions): Promise<void>;
+// show-more
+interface INetworkOptions {
+    localAddress: string;
+    gateway: string;
+    netmask: string;
+    dns: string[];
+}
+
+```
+
+#### Params
+
+| Name            | Type              | Description                                                                                        |
+|-----------------|-------------------|----------------------------------------------------------------------------------------------------|
+| `interfaceName` | `string`          | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
+| `options`       | `INetworkOptions` | The network configuration options.                                                                 |
+
+<Separator />
+
+### ~getActiveInfo()~
+
+:::danger
+
+This method was deprecated. Use `sos.management.network.listInterfaces()` instead.
+
+:::
+
+```ts expandable
+getActiveInfo(): Promise<INetworkInfo>;
+// show-more
+/**
+ * @deprecated use `INetworkInterface` instead
+ */
+interface INetworkInfo {
+    localAddress: string;
+    ethernetMacAddress: string;
+    wifiMacAddress: string;
+    activeInterface: NetworkInterface;
+    gateway?: string;
+    netmask?: string;
+    dns?: string[];
+    interfaceName?: string;
+    /**
+     * Number in range from 0 to 100 (percentage)
+     * mapped from -90 dBm unusable signal
+     * to -30 dBm excellent signal.
+     */
+    wifiStrength?: number;
+    wifiSsid?: string;
+}
+
+type NetworkInterface = 'wifi' | 'ethernet';
+
+```
+
+<Separator />
+
+### ~setDHCP(networkInterface)~
+
+:::danger
+
+This method was deprecated. Use `sos.management.network.setDHCP(interfaceName)` instead.
+
+:::
+
+```ts expandable
+setDHCP(networkInterface: NetworkInterface): Promise<void>;
+// show-more
+type NetworkInterface = 'wifi' | 'ethernet';
+
+```
+
+<Separator />
+
+### ~setManual(options)~
+
+:::danger
+
+This method was deprecated. Use `sos.management.network.setManual(interfaceName, options)` instead.
+
+:::
+
+```ts expandable
+setManual(options: INetworkOptionsLegacy): Promise<void>;
+// show-more
+interface INetworkOptionsLegacy {
+    interface: NetworkInterface;
+    localAddress: string;
+    gateway: string;
+    netmask: string;
+    dns: string[];
+}
+
+type NetworkInterface = 'wifi' | 'ethernet';
+
+```

package/docs/sos_management/os.md

@@ -0,0 +1,54 @@
+# os
+
+The `sos.management.os` API groups together methods for retrieving information about the system.
+
+## Methods
+
+### getCpuUsage()
+
+The `getCpuUsage()` method returns current CPU usage (ranging 0-100).
+
+```ts expandable
+getCpuUsage(): Promise<number>;
+```
+
+<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.
+
+```ts expandable
+getInfo(): Promise<IOSInfo>;
+// show-more
+interface IOSInfo {
+    /**
+     * Major version of current operating system.
+     * It's usually 1 or 2 digits including or excluding dot notation.
+     * E.g.:
+     * Windows -> 7, 8, 10, 11
+     * WebOS -> 3, 3.2, 4, 4.1
+     * Tizen -> 2.4, 3, 4, 5
+     */
+    version: string;
+}
+
+```
+
+<Separator />
+
+### getMemoryUsage()
+
+The `getMemoryUsage()` method returns total memory amount in bytes, currently used memory and remaining free memory.
+
+```ts expandable
+getMemoryUsage(): Promise<SystemMemoryInfo>;
+// show-more
+interface SystemMemoryInfo {
+    used: number;
+    total: number;
+    free: number;
+}
+
+```

package/docs/sos_management/package.md

@@ -0,0 +1,33 @@
+# package
+
+The `sos.management.package` API groups together methods for installing custom Android packages.
+
+## Methods
+
+### install()
+
+The `install()` method installs a certain package from the specified url.
+
+```ts expandable
+install(baseUrl: string, packageName: string, version: string, build: string | null): Promise<void>;
+```
+
+#### Params
+
+| Name          | Type             | Description                        |
+|---------------|------------------|------------------------------------|
+| `baseUrl`     | `string`         | URL where the package is available |
+| `packageName` | `string`         | Name of the android package        |
+| `version`     | `string`         | Package version                    |
+| `build`       | `string \| null` | If relevant for your device        |
+
+#### Example
+
+```ts
+await sos.management.package.install(
+  'https://cdn.your-cms.com',
+  'io.signageosWebView.app.ota',
+  '2.4.0',
+  'benq'
+);
+```