@signageos/front-applet 4.11.0

package/docs/js-api/js-hardware-serial.md

@@ -0,0 +1,142 @@
+---
+title:  Serial
+author: Michal Artazov
+date:   25.9.2020
+type:   js-api
+tags:
+- applet
+- applet_api
+- api
+- serial
+- js_api
+description: "[Content JS API] Some platforms support connecting hardware via serial port, either directly via UART or via USB. This can be leveraged to integrate a wide variety of hardware into your digital signage application."
+---
+
+# Serial
+
+Some platforms support connecting hardware via serial port, either directly via UART or via USB.
+This can be leveraged to integrate a wide variety of hardware into your digital signage application.
+
+Such hardware could be, for example, printers, payment terminals or sensors.
+
+::: alert alert--warning
+* Before using this API, ensure that the display supports serial via `sos.display.supports("SERIAL")`.
+* More info [**HERE**](/api/js/content/js-display#supports).
+:::
+
+## All methods
+
+::: table-responsive
+| Method             | Description            | Supported since |
+| ------------------ | ---------------------- | :-------------: |
+| `openSerialPort()` | Open a new serial port | 4.4.0           |
+:::
+
+## openSerialPort()
+
+Creates a new instance of serial port. You can then use that instance to handle the communication.
+
+::: table-responsive
+| Param     | Type   | Required                   | Description                                        |
+| --------- | ------ | :------------------------: | -------------------------------------------------- |
+| `options` | Object | <div class="red">Yes</div> | Object containing configuration of the serial port |
+:::
+
+### Options
+
+Here is the options object defined as Typescript interface:
+
+```typescript
+interface ISerialPortOptions {
+    device: string;
+    baudRate: number;
+    parity?: 'none' | 'even' | 'mark' | 'odd' | 'space';
+    databits?: number;
+    stopbits?: number;
+}
+```
+
+### Javascript example
+```javascript
+const serialPort = await sos.hardware.openSerialPort({
+    device: '/dev/ttyUSB0',
+    baudRate: 115200,
+});
+```
+
+::: alert alert--info
+Right now, it's necessary to always use `/dev/ttyUSB0` for the device. We are currently working on a more robust solution.
+:::
+
+## Serial port methods
+
+Once you create a serial port instance using `openSerialPort()` method listed above,
+you can call following methods on it.
+
+::: table-responsive
+| Method     | Description                                                 | Supported since |
+| ---------- | ----------------------------------------------------------- | :-------------: |
+| `onData()` | Call a listener callback anytime serial port emits new data | 4.4.0           |
+| `write()`  | Write data to the serial port                               | 4.4.0           |
+| `close()`  | Close serial port                                           | 4.4.0           |
+:::
+
+## onData()
+
+Call a listener callback anytime serial port emits data.
+
+Since data may be either text or binary, it's emitted as [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
+and should be processed further according to the requirements of your application.
+
+### Javascript example
+In case of binary data:
+```javascript
+// serial port instance previously created via sos.hardware.openSerialPort()
+serialPort.onData((data) => {
+    // data is array of numbers so can be processed as binary
+});
+```
+
+In case of text data:
+```javascript
+// serial port instance previously created via sos.hardware.openSerialPort()
+serialPort.onData((data) => {
+    const dataString = [...data].map((char) => String.fromCharCode(char)).join('');
+});
+```
+
+## write()
+
+Write data to the serial port. The data can be a string, array of numbers or [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array).
+
+### Javascript example
+```javascript
+// serial port instance previously created via sos.hardware.openSerialPort()
+await serialPort.write('string data'); // string
+await serialPort.write([ 10, 20, 30, 40 ]); // array of numbers
+await serialPort.write(Uint8Array.from([ 10, 20, 30, 40 ])); // Uint8Array
+```
+
+## close()
+
+Close serial port and prevent any more communication
+
+### Javascript example
+```javascript
+// serial port instance previously created via sos.hardware.openSerialPort()
+await serialPort.close();
+```
+
+## Errors
+
+Following errors may occur when working with the serial ports.
+
+::: table-responsive
+| Code  | Type                  | Message                                   |
+| ----- | --------------------- | ----------------------------------------- |
+| 50602 | InternalHardwareError | Failed to open serial port                |
+| 50603 | InternalHardwareError | Closing serial port that isn't open       |
+| 50603 | InternalHardwareError | Failed to close serial port               |
+| 50604 | InternalHardwareError | Writing to a serial port that isn't open |
+| 50604 | InternalHardwareError | Failed to write to serial port            |
+:::

package/docs/js-api/js-hardware.md

@@ -0,0 +1,70 @@
+---
+title:  Hardware
+author: Miroslav Behina
+date:   22.11.2018
+type:   js-api
+tags:
+- applet
+- applet_api
+- api
+- philips
+- led
+- js_api
+description: "[Content JS API] Some platforms support special hardware, that can be easily managed by JS using sOS hardware API."
+---
+
+# Hardware
+Some platforms support special hardware, that can be easily managed by JS using sOS hardware API.
+
+
+## LED
+
+Some Philips brand devices have LED lights built into them. The color of lights can be changed or disabled:
+
+### All methods
+
+::: table-responsive
+| Method | Description | Supported since |
+| ------ | -------- | :---------: |
+| `setColor()` | Method supports a string in hexa format to display color of LED light or null value to not be disabled | 1.0.1 |
+:::
+
+### setColor()
+
+::: table-responsive
+| Param | Type | Required | Description |
+| ------ | ------ | :--------: | -------- |
+| `color` | string | <div class="red">Yes</div> | Color of LED to be set in CSS hexa format `#000000`. To disable LED pass null value instead. |
+:::
+
+#### Javascript example
+```javascript
+sos.hardware.led.setColor("#00FF00"); // For GREEN light
+```
+
+<div class="row d-flex align-content-stretch force-padding-20">
+    <div class="col-12 d-flex">
+        <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/hardware-led">
+            <div>
+                <div class="wide-box__image d-flex align-items-center">
+                    <i class="fab fa-github svg-black"></i>
+                </div>
+            <div>
+                <h3 class="wide-box__title wide-box__title__small pl-85">Example of Applet with LED usage</h3>
+                <div class="wide-box__description">Working example on our Github</div>
+            </div>
+            </div>
+        </a>
+    </div>
+</div>
+
+## Errors
+Although we are doing our best, following errors may occur when working with the hardware.
+
+::: table-responsive
+| Code | Type | Message |
+| ---- | ---- | ------- |
+| 50601 | InternalHardwareError | Unexpected error occurred when working with hardware. |
+| 40601 | AppletHardwareError | Color must be string |
+| 40602 | AppletHardwareError | Color must be in format #000000 or null, allowed are `/^[a-zA-Z0-9\.\-_]+$/g` |
+:::

package/docs/js-api/js-iframes.md

@@ -0,0 +1,88 @@
+---
+title:  Iframes
+author: Josef Král
+date:   7.9.2020
+type:   js-api
+tags:
+- applet
+- applet_api
+- api
+- js_api
+- iframe
+description: "[Content JS API] We **do not recommend** to use iframes inside your Applet. However, if you have to use it, you can add full support of the sOS JS API to every one of your iframe. Just add the JS snippet script below to every page load in iframe before ending </body>. Everything will be prepared, and you can call the very same methods as described for Applet."
+---
+
+# Iframes
+We **do not recommend** to use iframes inside your Applet. However, if you have to use it, you can add full support of the sOS JS API to every one of your iframe. Just add the JS snippet script below to every page load in iframe before ending </body>. Everything will be prepared, and you can call the very same methods as described for Applet.
+
+::: alert alert--warning
+The signageOS Snippet and API works **ONLY** if the iframe is served from the display's internal storage - `<iframe src="file://...`. If your iframe is served from a live URL - `<iframe src="https://your-iframe-url"...` the snippet and signageOS API will **NOT** work. This is a security limitation to prevent random site took advantage of the API and alter the display behavior. There is a simple way to [save and load your iframe from the internal storage](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/iframes). Just make sure you are using full paths in your iframe for linking javascripts and css instead of the relative ones.
+:::
+
+## Create applet
+First applet, what will be as iframe in main applet. There is also **required event listener** to work iframes in an applet. Insert this snippet on bottom of iframe applet code.
+```javascript
+<script type="text/javascript">
+// sOS JS API loader
+!function(){window.addEventListener("message",function(t){
+    if(t.source===window.parent&&"hug.api_js_uri"===t.data.type) {
+        var e=t.data.uri;
+        if(!e)throw new Error("Front applet JS is not set.");
+        var a=document.createElement("script");
+        a.setAttribute("type","text/javascript"),a.setAttribute("src",e),a.onload=a.onreadystatechange=function(){
+            this.readyState&&"loaded"!=this.readyState&&"complete"!=this.readyState||(window.sos.apiJsUri=t.data.uri,window.dispatchEvent(new Event("hug.loaded")),window.dispatchEvent(new Event("sos.loaded")))},document.head.appendChild(a)}}),window.parent.postMessage({type:"hug_loader.ready"},"*")}();
+</script>
+```
+
+<div class="row d-flex align-content-stretch force-padding-20">
+    <div class="col-12 d-flex">
+        <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/iframes">
+            <div>
+                <div class="wide-box__image d-flex align-items-center">
+                    <i class="fab fa-github svg-black"></i>
+                </div>
+            <div>
+                <h3 class="wide-box__title wide-box__title__small pl-85">Applet that will be in Iframe</h3>
+                <div class="wide-box__description">Working example on our Github</div>
+            </div>
+            </div>
+        </a>
+    </div>
+</div>
+
+## Finally, use created applet in another applet as iframe.
+
+```javascript
+window.addEventListener('sos.loaded', () => {
+  sos.onReady().then(() => {
+        const contentElement = document.getElementById('index');
+        const iframeElement = document.getElementById('iframe');
+        sos.onReady();
+        
+        // Download created iframe into main applet
+        const iframeUri = sos.config.iframeUri || 'https://raw.githubusercontent.com/signageos/applet-examples/master/examples/iframes/iframe.html';
+        const { filePath } = sos.offline.cache.loadOrSaveFile('iframe.html', iframeUri);
+        
+        // Setup iframe
+        contentElement.innerHTML = '';
+        iframeElement.src = filePath;
+        iframeElement.style.display = 'block';
+  });
+});
+```
+
+<div class="row d-flex align-content-stretch force-padding-20">
+    <div class="col-12 d-flex">
+        <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/iframes">
+            <div>
+                <div class="wide-box__image d-flex align-items-center">
+                    <i class="fab fa-github svg-black"></i>
+                </div>
+            <div>
+                <h3 class="wide-box__title wide-box__title__small pl-85">How to use Iframes in Applet</h3>
+                <div class="wide-box__description">Working example on our Github</div>
+            </div>
+            </div>
+        </a>
+    </div>
+</div>

package/docs/js-api/js-input.md

@@ -0,0 +1,84 @@
+---
+title:  IR Remote Control Input
+author: Miroslav Behina
+date:   22.11.2018
+type:   js-api
+tags:
+- applet
+- applet_api
+- api
+- js_api
+description: "[Content JS API] For the specific logic of an application (games for example), binding the remote control inputs can be helpful."
+---
+
+# IR Remote Control Input
+For the specific logic of an application (games for example), binding the remote control inputs can be helpful. 
+Only a subset of all remote control keys is supported on the specific device. Only numerical digits are guaranteed to be supported. 
+This feature must be tested by users on real devices.
+
+## Event onKeyUp()
+
+### Parameters
+
+::: table-responsive
+| Parameters | Type | Required | Description | Supported Since | 
+| ------ | ------ | :--------: | -------- | :-----: |
+| event (in listener) | Object | <div class="red">Yes</div> | Plain JS object containing keyCode as number and keyName as string and type of event (always keyup string) | 1.3.0 |
+:::
+
+### Javascript syntax
+```javascript
+await sos.input.onKeyUp((keyUpEvent) => {
+  console.log(`Pressed: ${keyUpEvent.keyCode} (${keyUpEvent.keyName})`);
+});
+```
+
+## Map of keyCodes:
+| Name | Key code | Name | Key Code |
+| ---- | :----: | ----- | :----: |
+| UNKNOWN | 0 | OK | 15 |
+| NUM_0 | 1 | YELLOW | 16 |
+| NUM_1 | 2 | BLUE | 17 |
+| NUM_2 | 3 | RED | 18 |
+| NUM_3 | 4 | GREEN | 19 |
+| NUM_4 | 5 | VOLUME_DOWN | 20 |
+| NUM_5 | 6 | VOLUME_UP | 30 |
+| NUM_6 | 7 | POWER | 31 |
+| NUM_7 | 8 | POWER_OFF | 32 |
+| NUM_8 | 9 | HOME | 33 |
+| NUM_9 | 10 | EXIT | 34 |
+| ARROW_LEFT | 11 | RETURN | 35 |
+| ARROW_UP | 12 | BACKSPACE | 36 |
+| ARROW_RIGHT | 13 | LOCK | 37 |
+| ARROW_DOWN | 14 | | |
+
+## Usage with Typescript
+You can also use all these methods with [signageOS TypeScript](/knowledge-base/dev-tools-cli-typescript).
+
+```typescript
+interface IKeyUpEvent {
+  type: 'keyup';
+  keyCode: number;
+  keyName: string;
+}
+interface IKeyUpEventListener {
+  (event: IKeyUpEvent): void;
+}
+onKeyUp(listener: IKeyUpEventListener): void;
+```
+
+<div class="row d-flex align-content-stretch force-padding-20">
+    <div class="col-12 d-flex">
+        <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/tree/master/examples/content-js-api/remote-control">
+            <div>
+                <div class="wide-box__image d-flex align-items-center">
+                    <i class="fab fa-github svg-black"></i>
+                </div>
+            <div>
+                <h3 class="wide-box__title wide-box__title__small pl-85">IR Input handling</h3>
+                <div class="wide-box__description">Working example on our Github</div>
+            </div>
+            </div>
+        </a>
+    </div>
+</div>

package/docs/js-api/js-loading-fonts.md

@@ -0,0 +1,138 @@
+---
+title:  Loading fonts
+author: Miroslav Behina
+date:   22.11.2018
+type:   js-api
+tags:
+- applet
+- applet_api
+- api
+- js_api
+description: "[Content JS API] When working with custom font families, you should use this method that downloads fonts into offline storage and generates the appropriate font-face definition."
+---
+
+# Loading fonts
+When working with custom font families, you should use this method that downloads fonts into offline storage and generates the appropriate font-face definition.
+
+### All methods
+::: table-responsive
+| Method | Description | Supported since |
+| ------ | -------- | ----- | :----------: |
+| `addFont()` | Load additionally font into applet cache | 2.0.0  |
+:::
+
+### Parameters
+
+::: table-responsive
+|      Param     | Type | Required | Description                  					                                                        |
+| ------- | --------- | :----------: | ------ |
+| `uid`            | string | <div class="red">Yes</div> | Unique file identifier is used for later file retrieval, must contain a-z,A-Z,0-9 and . characters  |
+| `append`         | HTMLElement | <div class="red">Yes</div> |Reference to HTMLElement where the generated font-face will resist                   				|
+| `fontFamily`     | string | <div class="yellow">No</div> | Font family that can be referenced from your CSS                                     				|
+| `formats`        | object | <div class="yellow">No</div> | URI where these formats will be downloaded from                                      				|
+| `fontStretch`    | string | <div class="yellow">No</div> | Allows you to make text wider or narrower                                            				|
+| `fontStyle`      | string | <div class="yellow">No</div> | Apecifies the font stlye for a text                                                 				|
+|^^|^^|^^| Types: `normal`, `italic`, `oblique`, `initial`, `inherit`                                                               				|
+| `fontWeight`     | string | <div class="yellow">No</div> | Sets how thick or thin characters in text should be displayed                        				|
+| `unicodeRage`    | string | <div class="yellow">No</div> | Defines the range of unicode characters the font supports, default value is "U+0-10FFFF"			|
+:::
+
+### Formats parameters
+|      Param     | Type | Required | Description                  					                                                        |
+| ------- | --------- | :----------: | ------ |
+| `woff2` | String | <div class="yellow">No</div> | URI points to woff2 file |
+| `woff` | String | <div class="yellow">No</div> | URI points to woff file |
+| `svg` | String | <div class="yellow">No</div> | URI points to svg file |
+| `ttf` | String | <div class="yellow">No</div> | URI points to ttf file |
+| `eot` | String | <div class="yellow">No</div> | URI points to eot file |
+
+### Javascript Example
+```javascript
+await sos.offline.addFont({
+    uid: 'my-tondo-font',
+    fontFamily: 'tondo',
+    fontStretch: 'normal',
+    fontStyle: 'normal',
+    fontWeight: 'bold',
+    unicodeRange: 'U+0-10FFFF',
+    formats: {
+        woff2: 'https://mycms.signageos.io/fonts/tondo-woff2',
+        eot: 'https://mycms.signageos.io/fonts/tondo-eot',
+        ttf: 'https://mycms.signageos.io/fonts/tondo-ttf',
+        svg: 'https://mycms.signageos.io/fonts/tondo-svg',
+        woff: 'https://mycms.signageos.io/fonts/tondo-woff',
+    },
+    append: document.body,
+})
+.then(() => {
+    console.log('Generated');
+});
+```
+
+<div class="row d-flex align-content-stretch force-padding-20">
+    <div class="col-12 d-flex">
+        <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face">
+            <div>
+                <div class="wide-box__image d-flex align-items-center">
+                    <i class="fas fa-atlas svg-black"></i>
+                </div>
+            <div>
+                <h3 class="wide-box__title wide-box__title__small pl-85">Most properties follow the official CSS properties found</h3>
+                <div class="wide-box__description">Mozilla Developer Page</div>
+            </div>
+            </div>
+        </a>
+    </div>
+</div>
+
+<div class="row d-flex align-content-stretch force-padding-10">
+    <div class="col-12 d-flex">
+        <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/fonts">
+            <div>
+                <div class="wide-box__image d-flex align-items-center">
+                    <i class="fab fa-github svg-black"></i>
+                </div>
+            <div>
+                <h3 class="wide-box__title wide-box__title__small pl-85">Example of Applet that load custom fonts</h3>
+                <div class="wide-box__description">Working example on our Github</div>
+            </div>
+            </div>
+        </a>
+    </div>
+</div>
+
+## Usage with Typescript
+You can also use all these methods with [signageOS TypeScript](/knowledge-base/dev-tools-cli-typescript).
+
+```typescript
+addFont(
+    uid: string;
+    append: HTMLElement;
+    fontFamily: string;
+    formats: {
+        woff2: string;
+        woff?: string;
+        svg?: string;
+        ttf?: string;
+        svg?: string;
+    },
+    fontStretch?: string;
+    fontStyle?: 'normal' | 'italic' | 'oblique' | 'initial' | 'inherit';
+    fontWeight?: string;
+    unicodeRange?: string;
+);
+```
+
+## Errors
+Although we are doing our best, following errors may occur when working with the Applet Resources.
+
+::: table-responsive
+| Code | Type | Message |
+| ---- | ---- | ------- |
+| 40105 | AppletResourcesError | Already loading file: `$$FILE_NAME$$` |
+|^^|^^| Please, check your code for multiple occurrences of addFile/s methods. |
+| 40106 | AppletResourcesError | Already existing file: `$$FILE_NAME$$` |
+|^^|^^| Please, check your code for occurrences of addFile/s methods on lines before this error. |
+| 49901 | AppletResourceError | Please, check if the used URL is correct. |
+| 49902 | FileNotFoundError    | File was not found `$$FILE_ID$$` |
+:::

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

@@ -0,0 +1,108 @@
+---
+title:  Monitoring Commands
+author: Miroslav Behina
+date:   22.11.2018
+type:   js-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
+
+::: alert alert--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://docs.signageos.io/api/device-monitoring-api/#Send_Device_Applet_Command_to_device). 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.
+
+::: table-responsive
+| 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/js-api/js-monitors.md

@@ -0,0 +1,55 @@
+---
+title:  Monitors
+author: Alisher Nurmatov
+date:   29.12.2020
+type:   js-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).
+
+### Monitor object
+
+Here is the monitor object defined as Typescript interface:
+
+```typescript
+interface IMonitor {
+    manufacturer: string;
+    model: string;
+    serial: string;
+    firmware?: string;
+}
+```
+
+## All methods
+
+::: table-responsive
+| Method/Events  | Description                       | Supported since |
+| ----------------- | --------------------------------- | :---------------: |
+| `getList()` | Method gets list of monitors.  | 4.0.0 |
+:::
+
+### Javascript example
+```javascript
+// gets list of monitors
+await sos.monitors.getList();
+```
+### Returns
+
+```json
+[
+   {
+      "model":"LG Ultra HD",
+      "manufacturer":"GSM",
+      "serial":"232111"
+   }
+]
+```
+