@signageos/front-applet 8.6.0 → 8.7.0

package/docs/sos/hardware/index.md

@@ -35,35 +35,20 @@ Bellow is example list of serial ports that can be used with `sos.hardware.openS
 
 ### openSerialPort()
 
-The `openSerialPort()` method opens a serial port for reading/writing. After the port is opened the method returns 
+The `openSerialPort()` method opens a serial port for reading/writing. After the port is opened the method returns `ISerialPort` interface.
 
 ```ts expandable
 openSerialPort(options: ISerialPortOptions): Promise<ISerialPort>;
 // show-more
-/**
- * Options for opening a serial port used by the `sos.hardware.openSerialPort()` method.
- *
- * @remarks
- * All properties are optional except `baudRate`.
- */
 interface ISerialPortOptions {
-    /** Unique address of the external device. */
     device?: string;
-    /** Data transmission speed in bits per second. */
     baudRate: number;
-    /** Form of error checking, whether (or what) extra bits are added to a byte. */
     parity?: Parity;
-    /** Number of bits in a byte. */
     databits?: number;
-    /** Number of bits used to signal the end of a communication packet. */
     stopbits?: number;
-    /** Enables or disables RTS/CTS handshaking over the serial port. Currently supported by selected models of BrightSign. */
     rtscts?: boolean;
 }
 
-/**
- * Available parity options for the serial port.
- */
 enum Parity {
     NONE = "none",
     EVEN = "even",
@@ -72,41 +57,9 @@ enum Parity {
     SPACE = "space"
 }
 
-/**
- * Returned by sos.hardware.openSerialPort() method.
- * This interface provides methods to read/write data from/to the serial port.
- */
 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.
-     *
-     * @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()
-     * await serialPort.write('68656c6c6f'); // hexadecimal string
-     * await serialPort.write([ 10, 20, 30, 40 ]); // array of numbers
-     * await serialPort.write(Uint8Array.from([ 10, 20, 30, 40 ])); // Uint8Array
-     */
     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>;
 }
 
@@ -125,7 +78,7 @@ interface ISerialPort {
 
 #### Return value
 
-Returns a promise that resolves to an instance of 
+Returns a promise that resolves to an instance of `ISerialPort` interface, which can be used to read/write data from/to the serial port.
 
 #### Possible errors
 

package/docs/sos/input.md

@@ -22,24 +22,12 @@ This feature must be tested by users on real devices.
 ```ts expandable
 onKeyUp(listener: (event: IKeyUpEvent) => void): void;
 // show-more
-/**
- * KeyUp event interface for handling key release events.
- */
 interface IKeyUpEvent {
-    /** KeyUp event type */
     type: 'keyup';
-    /** Key code representing the key that was released */
     keyCode: KeyUpEventMap;
-    /** Key name representing the key that was released */
     keyName: keyof typeof KeyUpEventMap;
 }
 
-/**
- * Enum of supported key codes for KeyUp events.
- *
- * @remarks
- * If a key is not listed here, it will show warning in the console.
- */
 enum KeyUpEventMap {
     UNKNOWN = 0,
     NUM_0 = 1,

package/docs/sos/native/mdc.md

@@ -28,29 +28,12 @@ The `sendOne()` method sends an MDC command to another Tizen device on the same
 ```ts expandable
 sendOne(ipAddress: IpAddressType, command: CodesMDC, data?: number[]): Promise<IMDCResponse>;
 // show-more
-/**
- * Response object returned by Tizen Core App.
- */
 interface IMDCResponse {
-    /**
-     * The type of the response, either 'ACK' for acknowledgment or 'NACK' for negative acknowledgment.
-     */
     type: 'ACK' | 'NACK';
-    /**
-     * The command type that was executed, represented as a number.
-     * Should match the command number in {@link CodesMDC}.
-     */
     commandType: number;
-    /**
-     * The result of the command execution, represented as a number.
-     * This value can vary depending on the command executed.
-     */
     result: number;
 }
 
-/**
- * This enum contains valid command codes for Tizen MDC communication.
- */
 enum CodesMDC {
     STATUS_CONTROL = 0,
     VIDEO_CONTROL = 4,
@@ -170,9 +153,6 @@ enum CodesMDC {
     EDIT_NAME_CONTROL = 175,
     VIRTUAL_REMOTE_CONTROL = 176,
     DISPLAY_PORT_DAISY_CHAIN = 177,
-    /**
-     * 3Screen/4Screen Mode Control
-     */
     THREESCREEN_MODE_CONTROL = 178,
     VIDEO_CONFERENCE_SOUND_MODE_CONTROL = 179,
     VIDEO_STANDBY_CONTROL = 181,
@@ -205,7 +185,7 @@ enum CodesMDC {
 | Name        | Type       | Required         | Description                                          |
 |-------------|------------|------------------|------------------------------------------------------|
 | `ipAddress` | `string`   |  <div>Yes</div>  | The IP address of the device to send the command to. |
-| `command`   | `CodesMDC` |  <div>Yes</div>  | The MDC command to send                              |
+| `command`   | `CodesMDC` |  <div>Yes</div>  | The MDC command to send `CodesMDC`.                  |
 | `data`      | `number[]` |  <div>No</div>   | The optional data to send with the command.          |
 
 #### Return value
@@ -241,23 +221,9 @@ but without explicitly specifying the command.
 sendOneRaw(ipAddress: IpAddressType, data: number[] | [
 ]): Promise<IMDCResponse>;
 // show-more
-/**
- * Response object returned by Tizen Core App.
- */
 interface IMDCResponse {
-    /**
-     * The type of the response, either 'ACK' for acknowledgment or 'NACK' for negative acknowledgment.
-     */
     type: 'ACK' | 'NACK';
-    /**
-     * The command type that was executed, represented as a number.
-     * Should match the command number in {@link CodesMDC}.
-     */
     commandType: number;
-    /**
-     * The result of the command execution, represented as a number.
-     * This value can vary depending on the command executed.
-     */
     result: number;
 }
 

package/docs/sos/native/nmc.md

@@ -0,0 +1,127 @@
+---
+sidebar_position: 0
+---
+
+# nmc
+
+The `sos.native.nmc` API groups together methods for controlling WebOs devices using NMC commands.
+
+:::warning
+This API is currently available on WebOs devices only.
+:::
+
+<details>
+    <summary>NMC Management Capabilities</summary>
+		| Capability | Description |
+		|:------------|:-------------|
+		| `NATIVE_COMMANDS_NMC` | If device supports performing NMC commands |
+
+		If you want to check if the device supports this capability, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+</details>
+
+## Methods
+
+### sendOne()
+
+The `sendOne()` method sends an NMC command to another WebOS device on the same network or to the localhost.
+
+```ts expandable
+sendOne(ipAddress: IpAddressType, command: typeof NmcCommands, data: string[] | [
+]): Promise<INMCResponse>;
+// show-more
+interface INMCResponse {
+    type: 'ACK' | 'NACK';
+    commandType: string[];
+    result: number;
+}
+
+const NmcCommands = [
+	['k', 'a'], // Power
+	['k', 'b'], // Input Select
+	['k', 'c'], // Aspect Ratio
+	['k', 'd'], // Screen Mute
+	['k', 'e'], // Volume Mute
+	['k', 'f'], // Volume Control
+	['k', 'g'], // Contrast
+	['k', 'h'], // Brightness
+	['k', 'i'], // Color
+	['k', 'j'], // Tint
+	['k', 'k'], // Sharpness
+	['k', 'l'], // OSD Select
+	['k', 'm'], // Remote Lock/Key Lock
+	['k', 't'], // Balance
+	['k', 'u'], // Color Temperature
+	['k', 'z'], // Abnormal state
+	['j', 'p'], // ISM mode
+	['j', 'u'], // Auto configuration
+	['m', 'c'], // Key
+	['d', 'd'], // Tile Mode
+	['d', 'e'], // Tile H Position
+	['d', 'f'], // Tile V Position
+	['d', 'g'], // Tile H Size
+	['d', 'h'], // Tile V Size
+	['d', 'i'], // Tile ID Set
+	['d', 'j'], // Natural Mode (In Tile mode)
+	['d', 'x'], // Picture Mode (PSM)
+	['d', 'y'], // Sound Mode
+	['d', 'w'], // Fan Fault check
+	['d', 'l'], // Elapsed time return
+	['d', 'n'], // Temperature value
+	['d', 'd'], // Lamp fault check
+	['d', 'u'], // Auto Volume
+	['d', 'v'], // Speak
+	['f', 'a'], // Time
+	['f', 'd'], // On Timer(On/Off Timer)Time
+	['f', 'e'], // Off Timer(On/Off Timer) Time
+	['f', 'u'], // Scheduling Input Select
+	['f', 'f'], // Sleep Time
+	['f', 'g'], // Auto Sleep
+	['f', 'h'], // Power On Delay
+	['f', 'i'], // Language
+	['f', 'j'], // DPM Select
+	['f', 'k'], // Reset
+	['f', 'l'], // Power Saving
+	['f', 'o'], // Power Indicator
+	['f', 'p'], // Logo Indicator
+	['f', 'y'], // Serial no
+	['f', 'z'], // S/W Version
+	['x', 'b'], // Input Select
+	['f', '#'], // USB Connection Check
+	['f', '#'], // USB File List Count.
+	['f', '#'], // USB Get File Info.
+	['f', '#'], // USB Media Control
+	['f', '#'], // USB Add Play List
+	['f', '#'], // USB Add Schedule
+	['f', '#'], // USB Set Schedule
+][0];
+
+```
+
+#### Params
+
+| Name        | Type                 | Required         | Description                                                        |
+|-------------|----------------------|------------------|--------------------------------------------------------------------|
+| `ipAddress` | `string`             |  <div>Yes</div>  | The IP address of the device to send the command to.               |
+| `command`   | `typeof NmcCommands` |  <div>Yes</div>  | The NMC command to send. See `NmcCommands` for available commands. |
+| `data`      | `string[] \| []`     |  <div>Yes</div>  | The optional data to send with the command.                        |
+
+#### Return value
+
+NMC response object containing the result of the command execution.
+
+#### Possible errors
+
+
+- If the `ipAddress` is not a valid string or if the `command` is not a valid number.
+- If the `data` is not an array of strings.
+- If any error occurs during the command execution.
+
+#### Example
+
+```ts
+// Send a command to a WebOS device at IP address for menu open
+await sos.native.nmc.sendOne('192.168.0.10', ['m','c'], ['43']);
+
+// Send a command to a WebOS device at IP address for device power on
+await sos.native.nmc.sendOne('192.168.0.10', ['k', 'a'], ['1']);
+```

package/docs/sos/offline/cache.md

@@ -155,9 +155,6 @@ The `getChecksumFile()` computes a checksum of the file specified by `uid`.
 ```ts expandable
 getChecksumFile(uid: string, hashType: HashAlgorithm): Promise<string>;
 // show-more
-/**
- * Represents the supported hash algorithms by Core Apps.
- */
 type HashAlgorithm = 'md5' | 'crc32' | AnyString;
 
 type AnyString = string & {};
@@ -515,9 +512,6 @@ The `validateChecksumFile()` method validates whether the file, specified by `ui
 ```ts expandable
 validateChecksumFile(uid: string, hash: string, hashType: HashAlgorithm): Promise<boolean>;
 // show-more
-/**
- * Represents the supported hash algorithms by Core Apps.
- */
 type HashAlgorithm = 'md5' | 'crc32' | AnyString;
 
 type AnyString = string & {};

package/docs/sos/offline/index.md

@@ -37,21 +37,13 @@ The file URL must point to a file. If your URI leads to a redirect (e.g. from ht
 ```ts expandable
 addFile(file: ISaveFile): Promise<void>;
 // show-more
-/**
- * Interface represents a file that can be saved to cache and loaded into applet resources.
- */
 interface ISaveFile {
-    /** Unique identifier for the file. This is used to reference the file in the applet. */
     uid: string;
-    /** URI of the file to be saved. */
     uri: string;
-    /** Type of the file, e.g. 'javascript', 'css', etc. */
     type: IFileType;
-    /** HTTP headers to be sent with the request for the file. */
     headers?: {
         [key: string]: string;
     };
-    /** Additional flags for appending stored files to the DOM or other operations. */
     flags?: IFlag[];
 }
 
@@ -111,21 +103,13 @@ CSS and JavaScript files are specific because they must be loaded with an HTML t
 ```ts expandable
 addFiles(files: ISaveFile[]): Promise<Awaited<void>[]>;
 // show-more
-/**
- * Interface represents a file that can be saved to cache and loaded into applet resources.
- */
 interface ISaveFile {
-    /** Unique identifier for the file. This is used to reference the file in the applet. */
     uid: string;
-    /** URI of the file to be saved. */
     uri: string;
-    /** Type of the file, e.g. 'javascript', 'css', etc. */
     type: IFileType;
-    /** HTTP headers to be sent with the request for the file. */
     headers?: {
         [key: string]: string;
     };
-    /** Additional flags for appending stored files to the DOM or other operations. */
     flags?: IFlag[];
 }
 
@@ -189,21 +173,13 @@ The order in which the files are downloaded and stored **is** guaranteed.
 ```ts expandable
 addFilesSync(files: ISaveFile[]): Promise<void>;
 // show-more
-/**
- * Interface represents a file that can be saved to cache and loaded into applet resources.
- */
 interface ISaveFile {
-    /** Unique identifier for the file. This is used to reference the file in the applet. */
     uid: string;
-    /** URI of the file to be saved. */
     uri: string;
-    /** Type of the file, e.g. 'javascript', 'css', etc. */
     type: IFileType;
-    /** HTTP headers to be sent with the request for the file. */
     headers?: {
         [key: string]: string;
     };
-    /** Additional flags for appending stored files to the DOM or other operations. */
     flags?: IFlag[];
 }
 
@@ -258,11 +234,8 @@ using `addFile()`, because it also generates appropriate font-face definition.
 addFont(font: IAddFont): Promise<void>;
 // show-more
 interface IAddFont extends IFontFaceProperties {
-    /** Unique identifier for the font face. This is used to reference the font in the applet. */
     uid: string;
-    /** Element to which the font face will be appended. */
     append: HTMLElement;
-    /** Available formats for the font. */
     formats: IFontFormats;
 }
 

package/docs/sos/proofOfPlay.md

@@ -18,23 +18,13 @@ with additional metadata about current applet and device to signageOS.
 ```ts expandable
 recordItemPlayed(options: IRecordItemOptions): Promise<void>;
 // show-more
-/**
- * Interface representing options for a record item in the Proof of Play applet.
- */
 interface IRecordItemOptions {
-    /** The name of the item that was played. */
     name: string;
-    /** An optional custom identifier for the item. */
     customId?: string;
-    /** The type of the item that was played. */
     type?: 'video' | 'image' | 'html' | 'custom';
-    /** An array of tags associated with the item. */
     tags?: string[];
-    /** The name of the file that was played. */
     fileName?: string;
-    /** A boolean indicating whether the playback was successful. */
     playbackSuccess?: boolean;
-    /** An optional error message if the playback was not successful. */
     errorMessage?: string;
 }