@signageos/front-applet 7.1.1 → 8.0.0

package/docs/management/js-management-monitoring-commands.md

@@ -1,107 +0,0 @@
----
-title:  Monitoring Commands
-author: Miroslav Behina
-date:   22.11.2018
-type:   js-management-api
-tags:
-- applet
-- applet_api
-- api
-- js_api
-description: "[Content JS API] All commands have type prefixed with sos. string. It is not recommended using this prefix as a type in your custom commands. Predefined monitoring commands are not dispatched until monitoring is enabled. There are two ways how to enable it."
----
-
-# Monitoring Commands
-
-:::warning
-This is only a preview, not supported by all platforms. Supported since: 2.0.0
-:::
-
-All commands have type prefixed with sos. string. It is not recommended using this prefix as a type in your custom commands. Predefined monitoring commands are not dispatched until monitoring is enabled. There are two ways how to enable it. 
-
-* Adding a special reserved key in Timing configuration sosMonitoring' to 1
-* Sending a command to a device with type ```sos.Monitoring.EnableMonitoring``` 
-OR
-```sos.Monitoring.DisableMonitoring```
-
-## List of monitoring commands:
-
-### Typescript
-```typescript
-export const VideoStateChanged = 'sos.Monitoring.Video.VideoStateChanged';
-export interface VideoStateChanged {
-	type: typeof VideoStateChanged;
-	state: 'play' | 'prepare' | 'stop' | 'pause' | 'resume' | 'ended' | 'error';
-	uri: string;
-	x: number;
-	y: number;
-	width: number;
-	height: number;
-}
- 
- 
-export const TimingLoaded = 'sos.Monitoring.Timing.TimingLoaded';
-export interface TimingLoaded { type: typeof TimingLoaded; }
- 
-export const OfflineCacheFilesListed = 'sos.Monitoring.Offline.Cache.OfflineCacheFilesListed';
-export interface OfflineCacheFilesListed {
-	type: typeof OfflineCacheFilesListed;
-	fileUids: string[];
-}
- 
-export const OfflineCacheFileLoaded = 'sos.Monitoring.Offline.Cache.OfflineCacheFileLoaded';
-export interface OfflineCacheFileLoaded {
-	type: typeof OfflineCacheFileLoaded;
-	file: IFile;
-}
- 
-export const HtmlSnapshotTaken = 'sos.Monitoring.Html.HtmlSnapshotTaken';
-export interface HtmlSnapshotTaken {
-	type: typeof HtmlSnapshotTaken;
-	html: string;
-}
- 
-export const ConsoleLogged = 'sos.Monitoring.Console.ConsoleLogged';
-export interface ConsoleLogged {
-	type: typeof ConsoleLogged;
-	level: 'log' | 'debug' | 'info' | 'warn' | 'error';
-	messages: string[];
-}
-```
-
-To trigger some monitoring commands to be dispatched from a device. This REST API can be used to send monitoring [commands to the device](https://developers.signageos.io/api/#tag/DeviceApplet-Command/paths/~1v1~1device~1%7BdeviceUid%7D~1applet~1%7BappletUid%7D~1command/post). Following commands can be used:
-
-### Typescript
-```typescript
-export const EnableMonitoring = 'sos.Monitoring.EnableMonitoring';
-export interface EnableMonitoring { type: typeof EnableMonitoring; }
- 
-export const DisableMonitoring = 'sos.Monitoring.DisableMonitoring';
-export interface DisableMonitoring { type: typeof DisableMonitoring; }
- 
-export const TakeHtmlSnapshot = 'sos.Html.TakeHtmlSnapshot';
-export interface TakeHtmlSnapshot {
-	type: typeof TakeHtmlSnapshot;
-}
- 
-export const OfflineCacheListFiles = 'sos.Monitoring.Offline.Cache.OfflineCacheListFiles';
-export interface OfflineCacheListFiles {
-	type: typeof OfflineCacheListFiles;
-}
- 
-export const OfflineCacheLoadFile = 'sos.Monitoring.Offline.Cache.OfflineCacheLoadFile';
-export interface OfflineCacheLoadFile {
-	type: typeof OfflineCacheLoadFile;
-	uid: string;
-}
-```
-
-## Errors
-Although we are doing our best, following errors may occur when working with the commands.
-
-
-| Code | Type | Message |
-| ---- | ---- | ------- |
-| 40401 | AppletCommandTypeError | Type contains invalid characters, allowed are `/^[a-zA-Z0-9\.\-_]+$/g` |
-| 40402 | AppletCommandTypeError | Type is longer then 100 characters. |
-| 40403 | AppletCommandTypeError | Command type must be a string. 

package/docs/management/js-management-monitors.md

@@ -1,55 +0,0 @@
----
-title:  Monitors
-author: Alisher Nurmatov
-date:   29.12.2020
-type:   js-management-api
-tags:
-- applet
-- applet_api
-- api
-- js_api 
-description: "[Content JS API] Monitors provides info about connected **monitors**"
----
-
-# Monitors
-
-Provides information about currently connected monitors. Such as manufacturer, model, serial, firmware (optional).
-
-## All methods
-
-| Method/Events  | Description                       | Supported since |
-| ----------------- | --------------------------------- | :---------------: |
-| `getList()` | Method gets list of monitors.  | 4.0.0 |
-
-## getList()
-
-### Monitor object
-
-Here is the monitor object defined as Typescript interface:
-
-```typescript
-interface IMonitor {
-    manufacturer: string;
-    model: string;
-    serial: string;
-    firmware?: string;
-}
-```
-
-### Javascript example
-```javascript
-// gets list of monitors
-await sos.monitors.getList();
-```
-### Returns
-
-```json
-[
-   {
-      "model":"LG Ultra HD",
-      "manufacturer":"GSM",
-      "serial":"232111"
-   }
-]
-```
-

package/docs/management/js-management-native-commands-mdc.md

@@ -1,90 +0,0 @@
----
-title: Native Commands (MDC)
-author: Josef Král
-date: 19.3.2024
-type: js-management-api
-tags:
-- applet
-- applet_api
-- api
-- js_management_api
-- mdc
-- tizen
----
-
-# Native Commands (MDC)
-Native Commands API allows you to control the device using native commands.
-
-:::warning
-- This API is supported only on Tizen devices.
-- You can ensure that the device supports MDC commands via `sos.management.supports("NATIVE_COMMANDS_MDC")`.
-:::
-
-## All methods
-
-| Method  | Description | Supported since |
-| ------ | ------ |-----------------|
-| `sendOne()` | Send MDC command on one IP address (or localhost) | 6.5.1 |
-| `sendOneRaw()` | Send MDC command on one IP address (or localhost) with subcommands | 6.7.1 |
-
-
-## sendOne()
-Method `sendOne()` will send MDC command on one IP address (or localhost).
-
-|      Param     | Type                  | Required | Description           |
-| -------------- | ----------------------| :-------: | -------------------- |
-| `ipAddress`    | string                | <div class="red">Yes</div> | IP address or `localhost` |
-| `command`      | number                | <div class="red">Yes</div> | Command to send |
-| `data`         | array                | <div class="yellow">No</div> | Data for command/subcommands |
-
-### Javascript example
-```javascript
-await sos.native.mdc.sendOne('localhost', CodesMDC.BRIGHTNESS_CONTROL); // Promise<IMDCResponse>
-await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.VOLUME_CONTROL, [50]); // Promise<IMDCResponse>
-await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.PICTURE_CONTROL, [0x54, 0x03]); // Promise<IMDCResponse>
-
-// You can also send custom number if we don't have predefined command in our enum
-await sos.native.mdc.sendOne('192.168.0.10', 0x01, []); // Promise<IMDCResponse>
-```
-
-## sendOneRaw()
-Method `sendOneRaw()` will send MDC command on one IP address (or localhost) with subcommands .
-
-|      Param     | Type                  | Required | Description           |
-| -------------- | ----------------------| :-------: | -------------------- |
-| `ipAddress`    | string                | <div class="red">Yes</div> | IP address or `localhost` |
-| `data`      | number                | <div class="red">Yes</div> | Data for command/subcommands |
-
-### Javascript example
-```javascript
-await sos.native.mdc.sendOneRaw('localhost', [0x1B, 0x00, 0x01, 0x74]); // Promise<IMDCResponse>
-```
-
-### Example of returned object
-```javascript
-{
-    "type": "ACK", // or NACK
-    "commandType": 4,
-    "result": 0, // Value what command returned
-}
-```
-
-## CodesMDC
-CodesMDC is an enum with all predefined commands, it's useful if you are writing applet in JavaScript or TypeScript.
-
-### Example of few commands
-```typescript
-import { CodesMDC } from '@signageos/front-applet/es6/FrontApplet/NativeCommands/MDC/CodesMDC';
-export enum CodesMDC {
-    STATUS_CONTROL = 0x00,
-    VIDEO_CONTROL = 0x04,
-    RGB_CONTROL = 0x06,
-    PIP_STATUS_CONTROL = 0x07,
-    MAINTENANCE_CONTROL = 0x08,
-    SOUND_CONTROL = 0x09,
-    // ...
-}
-```
-
-
-

package/docs/management/js-management-network.md

@@ -1,223 +0,0 @@
----
-title:  Network
-author: Miroslav Behina
-date:   1.4.2018
-type:   js-management-api
-tags:
-- applet
-- applet_api
-- api
-- js_management_api
-- network
-description: "[Management JS API] Network management API allows you to manually set network interfaces or set back DHCP and current active network info."
----
-
-# Network
-Network management API allows you to manually set network interfaces or set back DHCP and current active network info.
-
-## All methods
-
-| Method  | Description | Supported since |
-| ------ | -------- | :-------------: |
-| `getActiveInfo()` | Information about network interfaces, IP addesses and MAC addresses (**DEPRECATED**) | 4.0 |
-| `listInterfaces()` | Information about network interfaces | 4.9 |
-| `setManual()` | Allows you to set network settings manually | 4.0 |
-| `setDHCP()` | Allows you to set network settings automatically from DHCP | 4.0 |
-| `disableInterface()` | Disables a network interface | 4.13 |
-
-## getActiveInfo()
-Method `getActiveInfo()` will display information about connected network.
-
-:::warning
-This method is deprecated. Use `listInterfaces()` instead.
-:::
-
-### Javascript example
-```javascript
-await sos.management.network.getActiveInfo();
-```
-
-### Example of response
-```json
-{
-	"activeInterface": "ethernet",
-	"dns": [
-		"192.168.1.1",
-		"1.1.1.1"
-	],
-	"gateway": "192.168.1.1",
-	"localAddress": "192.168.1.137",
-	"ethernetMacAddress": "b8:27:eb:25:8f:63",
-	"wifiMacAddress": "b8:27:eb:25:8f:63",
-	"netmask": "255.255.255.0"
-}
-```
-
-Wifi connection strength is described as percentage in range from 0 to 100, linearly converted from dBm -90 to -30 respectively based on platform.
-
-```json
-{
-	"activeInterface": "wifi",
-	"dns": [
-		"192.168.1.1",
-		"1.1.1.1"
-	],
-	"gateway": "192.168.1.1",
-	"localAddress": "192.168.1.137",
-	"ethernetMacAddress": "b8:27:eb:25:8f:63",
-	"wifiMacAddress": "b8:27:eb:25:8f:63",
-	"netmask": "255.255.255.0",
-    "wifiSsid": "hotel",
-    "wifiStrength": "87"
-}
-```
-
-:::note[GitHub Example]
-[Getting network data from device](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/network/)
-:::
-
-## listInterfaces()
-Returns list of all network interfaces, and their information like MAC address, IP address, etc.
-
-### Javascript example
-```javascript
-const interfaces = await sos.management.network.listInterfaces();
-```
-
-### Example of response
-
-Wifi connection strength is described as percentage in range from 0 to 100, linearly converted from dBm -90 to -30 respectively based on platform.
-
-```json
-[
-  {
-    "type": "ethernet",
-    "name": "eth0",
-    "macAddress": "b8:27:eb:25:8f:63",
-    "localAddress": "192.168.1.137",
-    "gateway": "192.168.1.1",
-    "netmask": "255.255.255.0",
-    "dns": [
-      "192.168.1.1",
-      "1.1.1.1"
-    ]
-  },
-  {
-    "type": "wifi",
-    "name": "wlan0",
-    "macAddress": "b8:27:eb:25:8f:63",
-    "localAddress": "192.168.1.138",
-    "gateway": "192.168.1.1",
-    "netmask": "255.255.255.0",
-    "dns": [
-      "192.168.1.1",
-      "1.1.1.1"
-    ],
-    "wifiSsid": "hotel",
-    "wifiStrength": "87"
-  }
-]
-```
-
-:::note[GitHub Example]
-[Getting network interfaces from device](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/network/)
-:::
-
-## setManual()
-Manually configures a network interface.
-If the interface is disabled, it will be enabled.
-
-:::warning
-Wi-Fi interface can be configured with this method but it has to be first enabled via the [Wi-Fi API](js-management-wifi).
-:::
-
-### Object properties
-
-#### New way
-| Name | Type | Required | Description |
-| ---- | ---- | :------: | ------ |
-| `interfaceName` | String | <div class="red">Yes</div> | Network interface name, can be retrieved from `listInterfaces()` |
-| `options.localAddress` | String | <div class="red">Yes</div> | Network local address |
-| `options.gateway` | String | <div class="red">Yes</div> | Network gateway |
-| `options.netmask` | String | <div class="red">Yes</div> | Network netmask |
-| `options.dns` | Array | <div class="red">Yes</div> | Array of additionally DNSs |
-
-#### Old way (deprecated)
-| Name | Type | Required | Description |
-| ---- | ---- | :------: | ------ |
-| `interface` | String | <div class="red">Yes</div> | Network type interface, can be only `ethernet` or `wifi` |
-| `localAddress` | String | <div class="red">Yes</div> | Network local address |
-| `gateway` | String | <div class="red">Yes</div> | Network gateway |
-| `netmask` | String | <div class="red">Yes</div> | Network netmask |
-| `dns` | Array | <div class="red">Yes</div> | Array of additionally DNSs |
-
-### Javascript example
-```javascript
-// new way
-await sos.management.network.setManual('eth0', {
-	localAddress: '192.168.1.133',
-	gateway: '192.168.1.1',
-	netmask: '255.255.255.0',
-	dns: ['8.8.8.8', '192.168.1.1'],
-});
-
-// old way (deprecated)
-await sos.management.network.setManual({
-	interface: 'ethernet',
-	localAddress: '192.168.1.133',
-	gateway: '192.168.1.1',
-	netmask: '255.255.255.0',
-	dns: ['8.8.8.8', '192.168.1.1'],
-});
-```
-
-## setDHCP() 
-Configures a network interface to use DHCP to get an IP address asigned from the network.
-If the interface is disabled, it will be enabled.
-
-:::warning
-Wi-Fi interface can be configured with this method but it has to be first enabled via the [Wi-Fi API](js-management-wifi).
-:::
-
-### Object properties
-
-#### New way
-| Name | Type | Required | Description |
-| ---- | ---- | :------: | ------ |
-| `interfaceName` | String | <div class="red">Yes</div> | Network interface name, can be retrieved from `listInterfaces()` |
-
-#### Old way (deprecated)
-| Name | Type | Required | Description |
-| ---- | ---- | :------: | ------ |
-| `networkInterface` | String | <div class="red">Yes</div> | Network type interface, can be only `ethernet` or `wifi` |
-
-### Javascript example
-```javascript
-// new way
-await sos.management.network.setDHCP('eth0');
-
-// old way (deprecated)
-await sos.management.network.setDHCP('ethernet');
-```
-
-## disableInterface()
-Disables a network interface
-
-
-| Param           | Type   | Required                   | Description                                          |
-| --------------- | ------ | :------------------------: | ---------------------------------------------------- |
-| `interfaceName` | String | <div class="red">Yes</div> | Name of the network interface, that will be disabled 
-
-### Javascript example
-```javascript
-await sos.management.wifi.disableInterface("eth0");
-```
-
-:::info
-A disabled network interface can be re-enabled simply by calling either `setDHCP()` or `setManual()`.
-:::
-
-:::warning
-Don't use this method to disable Wi-Fi.
-Use [Wi-Fi API](js-management-wifi) to enable/disable Wi-Fi.
-:::

package/docs/management/js-management-os.md

@@ -1,62 +0,0 @@
----
-title:  OS
-author: Michael Zabka
-date:   1.4.2018
-type:   js-management-api
-tags:
-- applet
-- applet_api
-- api
-- js_management_api
-description: "[Management JS API] OS management API allows you to manage information of operating system on your current device."
----
-
-# OS
-OS management API allows you to manage information of operating system on your current device.
-
-## All methods
-
-
-| Method  | Description | Supported since |
-| ------ | ------ | ------------- |
-| `getInfo()` | Get current OS version | 5.0 |
-| `getCpuUsage()` | Get current CPU usage | 5.4 |
-| `getMemoryUsage()` | Get current RAM usage | 5.4 
-
-## getInfo()
-Method `getInfo()` will specify info about device like a what current version of is is installed on a device.
-
-Major version of current operating system. It's usually 1 or 2 digits including or excluding dot notation.
-
-**Examples:**
-
-- Windows -> 7, 8, 10, 11
-- WebOS -> 3, 3.2, 4, 4.1, 6
-- Tizen -> 2.4, 3, 4, 5, 6.5
-
-### Javascript example
-```javascript
-sos.management.os.getInfo().then((info) => {
-    console.log(info); // Returns Object e.g. { version: 3 }
-});
-```
-
-## getCpuUsage()
-Method `getCpuUsage()` returns current CPU usage as number from 0 to 100.
-
-### Javascript example
-```javascript
-sos.management.os.getCpuUsage().then((usage) => {
-    console.log(usage); // Returns number e.g. 50 as 50 %
-});
-```
-
-## getMemoryUsage()
-Method `getMemoryUsage()` returns total memory amount in bytes, currently used memory and remaining free memory.
-
-### Javascript example
-```javascript
-sos.management.os.getMemoryUsage().then((usage) => {
-    console.log(usage); // Returns number e.g. { total: 2048, used: 1024, free 1024 }
-});
-```

package/docs/management/js-management-package.md

@@ -1,48 +0,0 @@
----
-title:  Package
-author: Krystof Woldrich
-date:   24.4.2018
-type:   js-management-api
-tags:
-- applet
-- applet_api
-- api
-- js_management_api
-description: "[Management JS API] Management API package allows you to install new packages."
----
-
-# Package
-Management API package allows you to install new packages.
-
-## All methods
-
-
-| Methods  | Description | Supported since |
-| ------ | -------- | :-------------: |
-| `install()` | Install additional packages to Android devices (eg. new WebView) | 3.0 
-
-
-## install()
-Method `install()` will install a certain package from the specified url.
-
-
-|      Param     |Type          | Required | Value | Description                   |
-| -------------- | --------------| :---------------: | ------ | ---------------------- |
-| `baseUrl`     | String                 | <div class="red">Yes</div> |  `https://cdn.your-cms.com`   | URL where the package is available |
-| `packageName`  | String                   | <div class="red">Yes</div> |  `io.signageosWebView.app.ota` | Name of the android package |
-| `version`     | String                    | <div class="red">Yes</div> |  `2.4.0` | Package version |
-| `build`     | String or null               | <div class="red">Yes</div> | `benq` or `philips`,... | If relevant for your device 
-
-### Javascript example
-```javascript
-await sos.management.package.install(
-    'https://cdn.your-cms.com',
-    'io.signageosWebView.app.ota',
-    '2.4.0',
-    'benq'
-);
-```
-
-:::note[GitHub Example]
-[How to install package on device](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/package-install/)
-:::