@signageos/front-applet 8.1.3 → 8.1.4

package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.js

@@ -3,6 +3,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DEFAULT_SCANNER_ID = void 0;
 const events_1 = require("events");
 exports.DEFAULT_SCANNER_ID = 0;
+/**
+ * The `sos.hardware.barcodeScanner` API provides methods for working with barcode scanners.
+ * It allows starting and stopping the scanner, as well as listening for scanned data and errors.
+ *
+ * :::note
+ * This API is experimental and may change in the future.
+ * :::
+ */
 class BarcodeScanner {
     messagePrefix;
     postMessage;
@@ -15,7 +23,11 @@ class BarcodeScanner {
         this.eventEmitter = new events_1.EventEmitter();
     }
     /**
-     * @experimental
+     * The `getVersion()` method returns the version of the barcode scanner.
+     *
+     * @returns {Promise<string>} Returns a promise that resolves to the version of the barcode scanner.
+     * @throws {Error} If the version cannot be retrieved.
+     * @since 3.0.0
      */
     async getVersion() {
         const { version } = await this.postMessage({
@@ -24,7 +36,27 @@ class BarcodeScanner {
         return version;
     }
     /**
-     * @experimental
+     * The `start()` starts the barcode scanner and starts listening for scanned data.
+     * @param userOptions User options to configure the scanner.
+     * @param userOptions.timeout The maximum time to wait for a scan before timing out.
+     * @param userOptions.cancelPrevious If set to `true`, it will cancel any previous scanner instance with the same `scannerId`.
+     * @returns Returns a promise that resolves to an object with methods to stop the scanner and listen for scanned data and errors.
+     * @throws {Error} If the scanner cannot be started.
+     * @throws {Error} If the scanner is already running and `cancelPrevious` option is not set to `true`.
+     * @throws {Error} If any other error occurs while starting the scanner.
+     * @since 3.0.0
+     *
+     * @example
+     * // Start the barcode scanner with default options
+     * const scanner = await sos.hardware.barcodeScanner.start();
+     * // Listen for scanned data
+     * scanner.onData((data) => {
+     * 	console.log(`Scanned data: ${data}`);
+     * });
+     * // Listen for errors
+     * scanner.onError((error) => {
+     * 	console.error(`Scanner error: ${error.message}`);
+     * });
      */
     async start(userOptions) {
         const defaultOptions = { scannerId: exports.DEFAULT_SCANNER_ID, timeout: 10000, cancelPrevious: false };

package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.js.map

@@ -1 +1 @@
-{"version":3,"file":"BarcodeScanner.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.ts"],"names":[],"mappings":";;;AAAA,mCAAsC;AAKzB,QAAA,kBAAkB,GAAG,CAAC,CAAC;AAEpC,MAAqB,cAAc;IAOzB;IACA;IAPF,MAAM,CAAC,cAAc,GAAsB,iBAAiB,CAAC;IAE5D,YAAY,CAAe;IAEnC,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;QAEtC,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,UAAU;QACtB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC1C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;SACpC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAK,CAAC,WAAuD;QAKzE,MAAM,cAAc,GAAG,EAAE,SAAS,EAAE,0BAAkB,EAAE,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC;QAChG,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,WAAW,EAAE,CAAC;QACxE,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAC5B,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,cAAc,SAAS,OAAO,CAAC,CAAC;YACrE,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,cAAc,SAAS,QAAQ,CAAC,CAAC;QACvE,CAAC;QACD,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;YAC9B,SAAS;YACT,OAAO;SACP,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,CAAC,QAAgC,EAAE,EAAE;YACnD,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,cAAc,SAAS,OAAO,EAAE,QAAQ,CAAC,CAAC;QACzE,CAAC,CAAC;QACF,MAAM,OAAO,GAAG,CAAC,QAAgC,EAAE,EAAE;YACpD,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,cAAc,SAAS,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC1E,CAAC,CAAC;QACF,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;YACvB,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;gBAC7B,SAAS;aACT,CAAC,CAAC;YACH,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,cAAc,SAAS,OAAO,CAAC,CAAC;YACrE,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,cAAc,SAAS,QAAQ,CAAC,CAAC;QACvE,CAAC,CAAC;QACF,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAClC,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,GAA+B;QACvD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;gBAC3B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,GAAG,CAAC,SAAS,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;gBACrE,MAAM;YACP,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;gBAC5B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,GAAG,CAAC,SAAS,QAAQ,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;gBACtE,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,cAAc,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5E,CAAC;;AA3EF,iCA4EC"}
+{"version":3,"file":"BarcodeScanner.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.ts"],"names":[],"mappings":";;;AAAA,mCAAsC;AAKzB,QAAA,kBAAkB,GAAG,CAAC,CAAC;AAEpC;;;;;;;GAOG;AACH,MAAqB,cAAc;IAOzB;IACA;IAPF,MAAM,CAAC,cAAc,GAAsB,iBAAiB,CAAC;IAE5D,YAAY,CAAe;IAEnC,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;QAEtC,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU;QACtB,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC1C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;SACpC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IAChB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,KAAK,CAAC,KAAK,CAAC,WAAuD;QACzE,MAAM,cAAc,GAAG,EAAE,SAAS,EAAE,0BAAkB,EAAE,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC;QAChG,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,EAAE,GAAG,EAAE,GAAG,cAAc,EAAE,GAAG,WAAW,EAAE,CAAC;QACxE,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAC5B,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,cAAc,SAAS,OAAO,CAAC,CAAC;YACrE,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,cAAc,SAAS,QAAQ,CAAC,CAAC;QACvE,CAAC;QACD,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;YAC9B,SAAS;YACT,OAAO;SACP,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,CAAC,QAAgC,EAAE,EAAE;YACnD,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,cAAc,SAAS,OAAO,EAAE,QAAQ,CAAC,CAAC;QACzE,CAAC,CAAC;QACF,MAAM,OAAO,GAAG,CAAC,QAAgC,EAAE,EAAE;YACpD,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,cAAc,SAAS,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC1E,CAAC,CAAC;QACF,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;YACvB,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;gBAC7B,SAAS;aACT,CAAC,CAAC;YACH,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,cAAc,SAAS,OAAO,CAAC,CAAC;YACrE,IAAI,CAAC,YAAY,CAAC,kBAAkB,CAAC,cAAc,SAAS,QAAQ,CAAC,CAAC;QACvE,CAAC,CAAC;QACF,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAClC,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,GAA+B;QACvD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;YAClB,KAAK,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;gBAC3B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,GAAG,CAAC,SAAS,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;gBACrE,MAAM;YACP,KAAK,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;gBAC5B,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,cAAc,GAAG,CAAC,SAAS,QAAQ,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;gBACtE,MAAM;YACP,QAAQ;QACT,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,cAAc,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC5E,CAAC;;AA/FF,iCAgGC"}

package/es6/FrontApplet/Hardware/BarcodeScanner/IBarcodeScanner.d.ts

@@ -4,6 +4,11 @@ export interface IBarcodeScannerOptions {
     cancelPrevious?: boolean;
     scannerId?: number;
 }
+export interface IBarcodeScannerResponse {
+    stop: () => Promise<void>;
+    onData: (listener: (data: string) => void) => void;
+    onError: (listener: (error: Error) => void) => void;
+}
 export default interface IBarcodeScanner {
     getVersion(): Promise<string>;
     start(userOptions?: Omit<IBarcodeScannerOptions, 'scannerId'>): Promise<{

package/es6/FrontApplet/Hardware/Hardware.d.ts

@@ -7,7 +7,23 @@ import IBarcodeScannerDataMessage from './BarcodeScanner/IBarcodeScannerDataMess
 import IHardware from './IHardware';
 import ISerialPort from './ISerialPort';
 /**
- * The `sos.hardware` API groups together methods for working with hardware. It allows opening serials ports, using bar scanner or controlling LEDs.
+ * The `sos.hardware` API groups together methods for working with hardware. It allows opening serial ports, using bar scanner or controlling LEDs.
+ *
+ * :::warning
+ * - Before using this API, ensure that the display [supports](/sdk/sos/display#supports) serial via `sos.display.supports("SERIAL")`.
+ * - Samsung Kiosk serial connection only works over serial ports, not over USB ports.
+ * :::
+ *
+ * ### List of supported serial ports
+ * Bellow is example list of serial ports that can be used with `sos.hardware.openSerialPort()` method.
+ *
+ * | Device type | Default value | Other available values |
+ * |:----|:-----|:------|
+ * | RaspberryPi / Linux | `/dev/ttyS0` | `/dev/ttyS1`, `/dev/ttyUSB0`, `/dev/ttyUSB1` |
+ * | Windows | `COM3` | `COM1`, `COM2`, `COM4` etc. Usually it's always `COM3` |
+ * | Samsung Kiosk | `PORT1` | `PORT2`, `PORT3`, `PORT4` |
+ * | Android | `/dev/ttyusb0` | `/dev/ttyusb1`, `/dev/ttyusb2` |
+ * | BrightSign | `0` | `0` (Serial Jack as `/dev/ttyS0`), `1` (GPIO port as `/dev/ttyS1`), `USB:A/0` (USB-to-serial as `/dev/ttyUSB0`) |
  */
 export default class Hardware implements IHardware {
     private messagePrefix;
@@ -15,19 +31,32 @@ export default class Hardware implements IHardware {
     static MESSAGE_PREFIX: string;
     readonly led: Led;
     barcodeScanner: BarcodeScanner;
-    private eventEmitter;
+    private readonly eventEmitter;
     /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
     /**
-     * The `openSerialPort()` method opens a serial port for reading/writing. After the port is opened the method returns ISerialPort interface.
-     * @param options.device Specifies the address of the external device.
+     * The `openSerialPort()` method opens a serial port for reading/writing. After the port is opened the method returns {@link ISerialPort} interface.
+     *
+     * @param options.device Specifies the address of the external device, check the table above for ports.
      * @param options.baudRate Specifies the data transmission speed in bits per second.
      * @param options.parity Specifies the form of error checking, whether (or what) extra bits are added to a byte.
      * @param options.databits Specifies the number of bits in a byte.
      * @param options.stopbits Specifies the number of bits used to signal the end of a communication packet.
      * @param options.rtscts  Enables or disables RTS/CTS handshaking over the serial port. Currently supported by selected models of BrightSign.
+     * @returns Returns a promise that resolves to an instance of {@link ISerialPort} interface, which can be used to read/write data from/to the serial port.
+     * @throws {Error} If the serial port cannot be opened.
+     * @throws {Error} If the device address is not supported by the platform.
+     * @throws {Error} If the device fails to process the data.
+     * @throws {Error} If any other error occurs while opening the serial port.
+     * @since 4.4.0
      *
-     * @tutorial https://developers.signageos.io/docs/applets/api-guides/serial-port
+     * @example
+     * // Open serial port on BrightSign with default settings
+     * const serialPort = await sos.hardware.openSerialPort({
+     * 	device: '0',
+     * 	baudRate: 9600,
+     * });
+     * serialPort.write('68656c6c6f'); // Write "hello" in hexadecimal
      */
     openSerialPort(options: ISerialPortOptions): Promise<ISerialPort>;
     /** @internal */

package/es6/FrontApplet/Hardware/Hardware.js

@@ -7,9 +7,24 @@ const events_1 = require("events");
 const Led_1 = __importDefault(require("./Led/Led"));
 const SerialPort_1 = __importDefault(require("./SerialPort"));
 const BarcodeScanner_1 = __importDefault(require("./BarcodeScanner/BarcodeScanner"));
-// TODO: add warnings from the old docs
 /**
- * The `sos.hardware` API groups together methods for working with hardware. It allows opening serials ports, using bar scanner or controlling LEDs.
+ * The `sos.hardware` API groups together methods for working with hardware. It allows opening serial ports, using bar scanner or controlling LEDs.
+ *
+ * :::warning
+ * - Before using this API, ensure that the display [supports](/sdk/sos/display#supports) serial via `sos.display.supports("SERIAL")`.
+ * - Samsung Kiosk serial connection only works over serial ports, not over USB ports.
+ * :::
+ *
+ * ### List of supported serial ports
+ * Bellow is example list of serial ports that can be used with `sos.hardware.openSerialPort()` method.
+ *
+ * | Device type | Default value | Other available values |
+ * |:----|:-----|:------|
+ * | RaspberryPi / Linux | `/dev/ttyS0` | `/dev/ttyS1`, `/dev/ttyUSB0`, `/dev/ttyUSB1` |
+ * | Windows | `COM3` | `COM1`, `COM2`, `COM4` etc. Usually it's always `COM3` |
+ * | Samsung Kiosk | `PORT1` | `PORT2`, `PORT3`, `PORT4` |
+ * | Android | `/dev/ttyusb0` | `/dev/ttyusb1`, `/dev/ttyusb2` |
+ * | BrightSign | `0` | `0` (Serial Jack as `/dev/ttyS0`), `1` (GPIO port as `/dev/ttyS1`), `USB:A/0` (USB-to-serial as `/dev/ttyUSB0`) |
  */
 class Hardware {
     messagePrefix;
@@ -27,15 +42,28 @@ class Hardware {
         this.barcodeScanner = new BarcodeScanner_1.default(this.getMessagePrefix(), this.postMessage);
     }
     /**
-     * The `openSerialPort()` method opens a serial port for reading/writing. After the port is opened the method returns ISerialPort interface.
-     * @param options.device Specifies the address of the external device.
+     * The `openSerialPort()` method opens a serial port for reading/writing. After the port is opened the method returns {@link ISerialPort} interface.
+     *
+     * @param options.device Specifies the address of the external device, check the table above for ports.
      * @param options.baudRate Specifies the data transmission speed in bits per second.
      * @param options.parity Specifies the form of error checking, whether (or what) extra bits are added to a byte.
      * @param options.databits Specifies the number of bits in a byte.
      * @param options.stopbits Specifies the number of bits used to signal the end of a communication packet.
      * @param options.rtscts  Enables or disables RTS/CTS handshaking over the serial port. Currently supported by selected models of BrightSign.
+     * @returns Returns a promise that resolves to an instance of {@link ISerialPort} interface, which can be used to read/write data from/to the serial port.
+     * @throws {Error} If the serial port cannot be opened.
+     * @throws {Error} If the device address is not supported by the platform.
+     * @throws {Error} If the device fails to process the data.
+     * @throws {Error} If any other error occurs while opening the serial port.
+     * @since 4.4.0
      *
-     * @tutorial https://developers.signageos.io/docs/applets/api-guides/serial-port
+     * @example
+     * // Open serial port on BrightSign with default settings
+     * const serialPort = await sos.hardware.openSerialPort({
+     * 	device: '0',
+     * 	baudRate: 9600,
+     * });
+     * serialPort.write('68656c6c6f'); // Write "hello" in hexadecimal
      */
     async openSerialPort(options) {
         const { refid } = await this.postMessage({

package/es6/FrontApplet/Hardware/Hardware.js.map

@@ -1 +1 @@
-{"version":3,"file":"Hardware.js","sourceRoot":"","sources":["../../../src/FrontApplet/Hardware/Hardware.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAEtC,oDAA4B;AAC5B,8DAAsC;AAGtC,qFAA6D;AAK7D,uCAAuC;AACvC;;GAEG;AACH,MAAqB,QAAQ;IAUnB;IACA;IAVF,MAAM,CAAC,cAAc,GAAW,UAAU,CAAC;IAElC,GAAG,CAAM;IAClB,cAAc,CAAiB;IAE9B,YAAY,CAAe;IAEnC,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;QAEtC,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;QACvC,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,IAAI,wBAAc,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,cAAc,CAAC,OAA2B;QACtD,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACxC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;YACzC,OAAO;SACP,CAAC,CAAC;QACH,OAAO,IAAI,oBAAU,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC5F,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAyD;QACjF,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;gBACvC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBACpE,MAAM;YACP;gBACC,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,IAAkC,CAAC,CAAC;QAC5E,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,gBAAgB,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC;IAC7C,CAAC;IAEO,gBAAgB;QACvB,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,QAAQ,CAAC,cAAc,CAAC;IAC3D,CAAC;;AAtDF,2BAuDC"}
+{"version":3,"file":"Hardware.js","sourceRoot":"","sources":["../../../src/FrontApplet/Hardware/Hardware.ts"],"names":[],"mappings":";;;;;AAAA,mCAAsC;AAEtC,oDAA4B;AAC5B,8DAAsC;AAGtC,qFAA6D;AAK7D;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAqB,QAAQ;IAUnB;IACA;IAVF,MAAM,CAAC,cAAc,GAAW,UAAU,CAAC;IAElC,GAAG,CAAM;IAClB,cAAc,CAAiB;IAErB,YAAY,CAAe;IAE5C,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;QAEtC,IAAI,CAAC,YAAY,GAAG,IAAI,qBAAY,EAAE,CAAC;QACvC,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,IAAI,wBAAc,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACrF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,KAAK,CAAC,cAAc,CAAC,OAA2B;QACtD,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACxC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;YACzC,OAAO;SACP,CAAC,CAAC;QACH,OAAO,IAAI,oBAAU,CAAC,KAAK,EAAE,IAAI,CAAC,YAAY,EAAE,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC5F,CAAC;IAED,gBAAgB;IACT,iBAAiB,CAAC,IAAyD;QACjF,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;gBACvC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBACpE,MAAM;YACP;gBACC,IAAI,CAAC,cAAc,CAAC,iBAAiB,CAAC,IAAkC,CAAC,CAAC;QAC5E,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,gBAAgB,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC;IAC7C,CAAC;IAEO,gBAAgB;QACvB,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,QAAQ,CAAC,cAAc,CAAC;IAC3D,CAAC;;AAnEF,2BAoEC"}

package/es6/FrontApplet/Hardware/ISerialPort.d.ts

@@ -1,11 +1,24 @@
+/**
+ * Returned by sos.hardware.openSerialPort() method.
+ * This interface provides methods to read/write data from/to the serial port.
+ */
 export default interface ISerialPort {
     /**
      * The `onData()` method sets up a listener, which is called whenever new data are received. The listener will stop after the serial port
      * is closed.
+     *
+     * @param listener A function that will be called with the received data as a Uint8Array.
+     * @returns {void} Returns when the listener is set up.
      */
     onData(listener: (data: Uint8Array) => void): void;
     /**
-     * The `write()` method writes data to the serial port. The data can be a string of hexadecimal digits, array of numbers or Uint8Array
+     * The `write()` method writes data to the serial port. The data can be a string of hexadecimal digits, array of numbers or Uint8Array.
+     *
+     * @param data The data to write to the serial port.
+     * @returns {Promise<void>} Returns a promise that resolves when the data is successfully written to the serial port.
+     * @throws {Error} If the data cannot be written to the serial port.
+     * @throws {Error} If the serial port is not open.
+     * @throws {Error} If any other error occurs while writing to the serial port.
      *
      * @example
      * // serial port instance previously created via sos.hardware.openSerialPort()
@@ -16,6 +29,9 @@ export default interface ISerialPort {
     write(data: string | number[] | Uint8Array): Promise<void>;
     /**
      * The `close()` method closes the serial port.
+     *
+     * @returns {Promise<void>} Returns a promise that resolves when the serial port is successfully closed.
+     * @throws {Error} If the serial port cannot be closed.
      */
     close(): Promise<void>;
 }

package/es6/FrontApplet/Hardware/ISerialPortDataMessage.d.ts

@@ -1,4 +1,7 @@
 import IMessage from '../IMessage';
+/**
+ * Received message from the serial port with data.
+ */
 interface ISerialPortDataMessage extends IMessage {
     refid: string;
     data: any;

package/es6/FrontApplet/Hardware/ISerialPortOptions.d.ts

@@ -5,6 +5,12 @@ export declare enum Parity {
     ODD = "odd",
     SPACE = "space"
 }
+/**
+ * Options for opening a serial port used by the `sos.hardware.openSerialPort()` method.
+ *
+ * @remarks
+ * All properties are optional except `baudRate`.
+ */
 interface ISerialPortOptions {
     device?: string;
     baudRate: number;

package/es6/FrontApplet/Hardware/ISerialPortOptions.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Parity = void 0;
+/*
+ * Available parity options for the serial port.
+ */
 var Parity;
 (function (Parity) {
     Parity["NONE"] = "none";

package/es6/FrontApplet/Hardware/ISerialPortOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"ISerialPortOptions.js","sourceRoot":"","sources":["../../../src/FrontApplet/Hardware/ISerialPortOptions.ts"],"names":[],"mappings":";;;AAAA,IAAY,MAMX;AAND,WAAY,MAAM;IACjB,uBAAa,CAAA;IACb,uBAAa,CAAA;IACb,uBAAa,CAAA;IACb,qBAAW,CAAA;IACX,yBAAe,CAAA;AAChB,CAAC,EANW,MAAM,sBAAN,MAAM,QAMjB"}
+{"version":3,"file":"ISerialPortOptions.js","sourceRoot":"","sources":["../../../src/FrontApplet/Hardware/ISerialPortOptions.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,IAAY,MAMX;AAND,WAAY,MAAM;IACjB,uBAAa,CAAA;IACb,uBAAa,CAAA;IACb,uBAAa,CAAA;IACb,qBAAW,CAAA;IACX,yBAAe,CAAA;AAChB,CAAC,EANW,MAAM,sBAAN,MAAM,QAMjB"}

package/es6/FrontApplet/Hardware/Led/Led.d.ts

@@ -2,8 +2,11 @@ import IPostMessage from '../../IPostMessage';
 import ISetColorMessage from './ISetColorMessage';
 import ILed from './ILed';
 /**
- * The `sos.hardware.led` API groups together methods for controlling LEDs of the device. **This is currently only supported by Phillips
- * devices.**
+ * The `sos.hardware.led` API groups together methods for controlling LEDs of the device.
+ *
+ * :::warning
+ * This is currently only supported by Phillips devices.
+ * :::
  */
 export default class Led implements ILed {
     private messagePrefix;
@@ -12,7 +15,20 @@ export default class Led implements ILed {
     /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<ISetColorMessage>);
     /**
-     * The `setColor()` methods sets the LED color (if string is passed) or disabled (if null is passed).
+     * The `setColor()` methods sets the LED color.
+     *
+     * @param color The color to set the LED to, in hexadecimal format (e.g. `#FF0000` for red). If `null`, it will turn off the LED.
+     * @returns {Promise<void>} Returns a promise that resolves when the color is successfully set.
+     * @throws {Error} If the color is not a valid hexadecimal string or is not a string at all.
+     * @throws {Error} If the LED cannot be controlled by the device.
+     * @throws {Error} If any other error occurs while setting the color.
+     * @since 4.4.0
+     *
+     * @example
+     * // Set the LED color to red
+     * await sos.hardware.led.setColor('#FF0000');
+     * // Turn off the LED
+     * await sos.hardware.led.setColor(null);
      */
     setColor(color: string | null): Promise<void>;
     private checkColorValidity;

package/es6/FrontApplet/Hardware/Led/Led.js

@@ -6,8 +6,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const ErrorCodes_1 = __importDefault(require("../../Error/ErrorCodes"));
 const Validate_1 = __importDefault(require("../../Validate/Validate"));
 /**
- * The `sos.hardware.led` API groups together methods for controlling LEDs of the device. **This is currently only supported by Phillips
- * devices.**
+ * The `sos.hardware.led` API groups together methods for controlling LEDs of the device.
+ *
+ * :::warning
+ * This is currently only supported by Phillips devices.
+ * :::
  */
 class Led {
     messagePrefix;
@@ -19,7 +22,20 @@ class Led {
         this.postMessage = postMessage;
     }
     /**
-     * The `setColor()` methods sets the LED color (if string is passed) or disabled (if null is passed).
+     * The `setColor()` methods sets the LED color.
+     *
+     * @param color The color to set the LED to, in hexadecimal format (e.g. `#FF0000` for red). If `null`, it will turn off the LED.
+     * @returns {Promise<void>} Returns a promise that resolves when the color is successfully set.
+     * @throws {Error} If the color is not a valid hexadecimal string or is not a string at all.
+     * @throws {Error} If the LED cannot be controlled by the device.
+     * @throws {Error} If any other error occurs while setting the color.
+     * @since 4.4.0
+     *
+     * @example
+     * // Set the LED color to red
+     * await sos.hardware.led.setColor('#FF0000');
+     * // Turn off the LED
+     * await sos.hardware.led.setColor(null);
      */
     async setColor(color) {
         this.checkColorValidity(color);

package/es6/FrontApplet/Hardware/Led/Led.js.map

@@ -1 +1 @@
-{"version":3,"file":"Led.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Hardware/Led/Led.ts"],"names":[],"mappings":";;;;;AAEA,wEAAgD;AAChD,uEAA+C;AAG/C;;;GAGG;AACH,MAAqB,GAAG;IAKd;IACA;IALF,MAAM,CAAC,cAAc,GAAW,KAAK,CAAC;IAE7C,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA2C;QAD3C,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAgC;IACjD,CAAC;IAEJ;;OAEG;IACI,KAAK,CAAC,QAAQ,CAAC,KAAoB;QACzC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/B,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAClC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI;SACzC,CAAC,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,KAAoB;QAC9C,IAAA,kBAAQ,EAAC,EAAE,KAAK,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,oBAAU,CAAC,gCAAgC,CAAC,CAAC;QAC1F,IAAA,kBAAQ,EAAC,EAAE,KAAK,EAAE,CAAC;aACjB,SAAS,EAAE;aACX,WAAW,CAAC,qBAAqB,EAAE,oBAAU,CAAC,+BAA+B,CAAC,CAAC;IAClF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,GAAG,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACnE,CAAC;;AA7BF,sBA8BC"}
+{"version":3,"file":"Led.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Hardware/Led/Led.ts"],"names":[],"mappings":";;;;;AAEA,wEAAgD;AAChD,uEAA+C;AAG/C;;;;;;GAMG;AACH,MAAqB,GAAG;IAKd;IACA;IALF,MAAM,CAAC,cAAc,GAAW,KAAK,CAAC;IAE7C,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA2C;QAD3C,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAgC;IACjD,CAAC;IAEJ;;;;;;;;;;;;;;;OAeG;IACI,KAAK,CAAC,QAAQ,CAAC,KAAoB;QACzC,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/B,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAClC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI;SACzC,CAAC,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,KAAoB;QAC9C,IAAA,kBAAQ,EAAC,EAAE,KAAK,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,oBAAU,CAAC,gCAAgC,CAAC,CAAC;QAC1F,IAAA,kBAAQ,EAAC,EAAE,KAAK,EAAE,CAAC;aACjB,SAAS,EAAE;aACX,WAAW,CAAC,qBAAqB,EAAE,oBAAU,CAAC,+BAA+B,CAAC,CAAC;IAClF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,GAAG,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACnE,CAAC;;AA1CF,sBA2CC"}

package/es6/FrontApplet/Monitors/Monitors.d.ts

@@ -2,6 +2,10 @@ import IPostMessage from '../IPostMessage';
 import IMonitor, { IConnectedMonitor } from './IMonitor';
 /**
  * The `sos.monitors` API groups together methods for providing information about monitors connected to the device.
+ *
+ * :::note
+ * This API is available only on Linux devices.
+ * :::
  */
 declare class Monitors implements IMonitor {
     private messagePrefix;
@@ -12,6 +16,7 @@ declare class Monitors implements IMonitor {
     /**
      * The `getList()` method returns a list of monitors currently connected to the device.
      *
+     * @returns {Promise<IConnectedMonitor[]>} A promise that resolves to an array of connected monitors.
      * @since 4.0.0
      */
     getList(): Promise<IConnectedMonitor[]>;

package/es6/FrontApplet/Monitors/Monitors.js

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
  * The `sos.monitors` API groups together methods for providing information about monitors connected to the device.
+ *
+ * :::note
+ * This API is available only on Linux devices.
+ * :::
  */
 class Monitors {
     messagePrefix;
@@ -15,6 +19,7 @@ class Monitors {
     /**
      * The `getList()` method returns a list of monitors currently connected to the device.
      *
+     * @returns {Promise<IConnectedMonitor[]>} A promise that resolves to an array of connected monitors.
      * @since 4.0.0
      */
     async getList() {

package/es6/FrontApplet/Monitors/Monitors.js.map

@@ -1 +1 @@
-{"version":3,"file":"Monitors.js","sourceRoot":"","sources":["../../../src/FrontApplet/Monitors/Monitors.ts"],"names":[],"mappings":";;AAGA;;GAEG;AACH,MAAM,QAAQ;IAKJ;IACA;IALF,MAAM,CAAC,cAAc,GAAW,UAAU,CAAC;IAElD,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;OAIG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC3C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;SACjC,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IACjB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,QAAQ,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACxE,CAAC;;AAGF,kBAAe,QAAQ,CAAC"}
+{"version":3,"file":"Monitors.js","sourceRoot":"","sources":["../../../src/FrontApplet/Monitors/Monitors.ts"],"names":[],"mappings":";;AAGA;;;;;;GAMG;AACH,MAAM,QAAQ;IAKJ;IACA;IALF,MAAM,CAAC,cAAc,GAAW,UAAU,CAAC;IAElD,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;OAKG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC3C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;SACjC,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;IACjB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,QAAQ,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACxE,CAAC;;AAGF,kBAAe,QAAQ,CAAC"}

package/es6/FrontApplet/NativeCommands/MDC/INativeMdcCommands.d.ts

@@ -2,4 +2,5 @@ import { IMDCResponse, IpAddressType } from './Mdc';
 import { CodesMDC } from './CodesMDC';
 export default interface INativeMdcCommands {
     sendOne(ipAddress: IpAddressType, command: CodesMDC, data?: number[] | []): Promise<IMDCResponse>;
+    sendOneRaw(ipAddress: IpAddressType, data: number[] | []): Promise<IMDCResponse>;
 }

package/es6/FrontApplet/OSD/OSD.d.ts

@@ -1,7 +1,9 @@
 import IPostMessage from '../IPostMessage';
 import IOSD from './IOSD';
 /**
- * The `sos.osd` API groups together methods for working with the OSD (On Screen Display).
+ * The `sos.osd` API groups together methods for working with the signageOS OSD (On Screen Display).
+ *
+ * More information about the OSD can be found in the [OSD Introduction](https://docs.signageos.io/hc/en-us/articles/4405231839890-OSD-menu-by-signageOS)
  */
 export default class OSD implements IOSD {
     private messagePrefix;
@@ -11,7 +13,9 @@ export default class OSD implements IOSD {
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
     /**
      * The `showOSD()` method opens the OSD without typing the pin.
+     * Note: The OSD will be opened after 6 seconds.
      *
+     * @returns {Promise<void>} A promise that resolves when the OSD is shown.
      * @since 5.5.0
      */
     showOSD(): Promise<void>;

package/es6/FrontApplet/OSD/OSD.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 /**
- * The `sos.osd` API groups together methods for working with the OSD (On Screen Display).
+ * The `sos.osd` API groups together methods for working with the signageOS OSD (On Screen Display).
+ *
+ * More information about the OSD can be found in the [OSD Introduction](https://docs.signageos.io/hc/en-us/articles/4405231839890-OSD-menu-by-signageOS)
  */
 class OSD {
     messagePrefix;
@@ -14,7 +16,9 @@ class OSD {
     }
     /**
      * The `showOSD()` method opens the OSD without typing the pin.
+     * Note: The OSD will be opened after 6 seconds.
      *
+     * @returns {Promise<void>} A promise that resolves when the OSD is shown.
      * @since 5.5.0
      */
     async showOSD() {

package/es6/FrontApplet/OSD/OSD.js.map

@@ -1 +1 @@
-{"version":3,"file":"OSD.js","sourceRoot":"","sources":["../../../src/FrontApplet/OSD/OSD.ts"],"names":[],"mappings":";;AAGA;;GAEG;AACH,MAAqB,GAAG;IAKd;IACA;IALF,MAAM,CAAC,cAAc,GAAW,KAAK,CAAC;IAE7C,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;OAIG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;SACjC,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,GAAG,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACnE,CAAC;;AAtBF,sBAuBC"}
+{"version":3,"file":"OSD.js","sourceRoot":"","sources":["../../../src/FrontApplet/OSD/OSD.ts"],"names":[],"mappings":";;AAGA;;;;GAIG;AACH,MAAqB,GAAG;IAKd;IACA;IALF,MAAM,CAAC,cAAc,GAAW,KAAK,CAAC;IAE7C,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;;OAMG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;SACjC,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,GAAG,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACnE,CAAC;;AAxBF,sBAyBC"}