@signageos/front-applet 7.1.1 → 8.0.0

package/docs/sos/hardware/barcodeScanner.md

@@ -0,0 +1,40 @@
+# barcodeScanner
+
+## Methods
+
+### getVersion()
+
+:::warning
+
+This API is experimental and may change in the future.
+
+:::
+
+```ts expandable
+getVersion(): Promise<string>;
+```
+
+<Separator />
+
+### start()
+
+:::warning
+
+This API is experimental and may change in the future.
+
+:::
+
+```ts expandable
+start(userOptions?: Omit<IBarcodeScannerOptions, 'scannerId'>): Promise<{
+    stop: () => Promise<void>;
+    onData: (listener: (data: string) => void) => void;
+    onError: (listener: (error: Error) => void) => void;
+}>;
+// show-more
+interface IBarcodeScannerOptions {
+    timeout?: number;
+    cancelPrevious?: boolean;
+    scannerId?: number;
+}
+
+```

package/docs/sos/hardware/index.md

@@ -0,0 +1,64 @@
+# hardware
+
+The `sos.hardware` API groups together methods for working with hardware. It allows opening serials ports, using bar scanner or controlling LEDs.
+
+## Methods
+
+### openSerialPort()
+
+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
+interface ISerialPortOptions {
+    device?: string;
+    baudRate: number;
+    parity?: Parity;
+    databits?: number;
+    stopbits?: number;
+    rtscts?: boolean;
+}
+
+enum Parity {
+    NONE = "none",
+    EVEN = "even",
+    MARK = "mark",
+    ODD = "odd",
+    SPACE = "space"
+}
+
+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.
+     */
+    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
+     *
+     * @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.
+     */
+    close(): Promise<void>;
+}
+
+```
+
+#### Params
+
+| Name                            | Type      | Description                                                                                                         |
+|---------------------------------|-----------|---------------------------------------------------------------------------------------------------------------------|
+| `options.device` *(optional)*   | `string`  | Specifies the address of the external device.                                                                       |
+| `options.baudRate`              | `number`  | Specifies the data transmission speed in bits per second.                                                           |
+| `options.parity` *(optional)*   | `Parity`  | Specifies the form of error checking, whether (or what) extra bits are added to a byte.                             |
+| `options.databits` *(optional)* | `number`  | Specifies the number of bits in a byte.                                                                             |
+| `options.stopbits` *(optional)* | `number`  | Specifies the number of bits used to signal the end of a communication packet.                                      |
+| `options.rtscts` *(optional)*   | `boolean` | Enables or disables RTS/CTS handshaking over the serial port. Currently supported by selected models of BrightSign. |

package/docs/sos/hardware/led.md

@@ -0,0 +1,14 @@
+# led
+
+The `sos.hardware.led` API groups together methods for controlling LEDs of the device. **This is currently only supported by Phillips
+devices.**
+
+## Methods
+
+### setColor()
+
+The `setColor()` methods sets the LED color (if string is passed) or disabled (if null is passed).
+
+```ts expandable
+setColor(color: string | null): Promise<void>;
+```

package/docs/sos/index.md

@@ -0,0 +1,82 @@
+# sos
+
+The `sos` API groups together all functionality the
+
+## Properties
+
+### appletVersion
+
+The `appletVersion` is the version of the current applet.
+
+```ts expandable
+readonly appletVersion: string;
+```
+
+### authHash
+
+The `authHash` property is an alternative device identifier, which is designed for secure pairing and locating devices through
+the REST API.
+
+1. The `authHash` is commonly used as a link between the Applet deployed on the device and the device in device management.
+2. The `authHash` is unique and can be revoked upon request.
+3. The `authHash` can be used as a universal identifier for your Applet application.
+
+```ts expandable
+readonly authHash: string;
+```
+
+### config
+
+The `config` property is a Key-value dictionary of the applet configuration.
+
+```ts expandable
+readonly config: Record<string, number | string | boolean>;
+```
+
+## Methods
+
+### onReady()
+
+The `onReady()` method accepts an optional listener which is called after the sos API are loaded and ready. It also returns a promise
+which is resolved at the same time as the listener.
+
+```ts expandable
+onReady(listener?: () => void): Promise<void>;
+```
+
+#### Example
+
+```ts
+sos.onReady().then(async function () {
+  console.log(await sos.app.getType());
+});
+
+sos.onReady(async function () {
+  console.log(await sos.app.getType());
+});
+```
+
+<Separator />
+
+### refresh()
+
+The `refresh()` method initializes refresh of the applet. Similar to window.location.reload(), but the applet is not downloaded again.
+
+```ts expandable
+refresh(): Promise<void>;
+```
+
+<Separator />
+
+### restore()
+
+The `restore()` method clears all previously played videos, streams, clear display view. The typical case of usage for digital signage
+is playing a loop with some specified duration. This method should be called always when the loop is changed. It will clear all
+previously played videos, streams, clear display views, and notify for garbage collection.
+
+ It stops all video playback and clears out the memory. The following function should be triggered only in a case the whole playback
+needs to be restarted as it's completely switching the playback 'loop/playlist'.
+
+```ts expandable
+restore(): void;
+```

package/docs/sos/input.md

@@ -0,0 +1,73 @@
+# input
+
+## Methods
+
+### onKeyUp()
+
+The `onKeyUp` method sets up a listeners, which is called on every key stroke of the remote controller. 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.
+
+```ts expandable
+onKeyUp(listener: (event: IKeyUpEvent) => void): void;
+// show-more
+interface IKeyUpEvent {
+    type: 'keyup';
+    keyCode: KeyUpEventMap;
+    keyName: keyof typeof KeyUpEventMap;
+}
+
+enum KeyUpEventMap {
+    UNKNOWN = 0,
+    NUM_0 = 1,
+    NUM_1 = 2,
+    NUM_2 = 3,
+    NUM_3 = 4,
+    NUM_4 = 5,
+    NUM_5 = 6,
+    NUM_6 = 7,
+    NUM_7 = 8,
+    NUM_8 = 9,
+    NUM_9 = 10,
+    ARROW_LEFT = 11,
+    ARROW_UP = 12,
+    ARROW_RIGHT = 13,
+    ARROW_DOWN = 14,
+    YELLOW = 16,
+    BLUE = 17,
+    RED = 18,
+    GREEN = 19,
+    VOLUME_DOWN = 20,
+    VOLUME_UP = 30,
+    POWER = 31,
+    POWER_OFF = 32,
+    HOME = 33,
+    EXIT = 34,
+    RETURN = 35,
+    BACKSPACE = 36,
+    LOCK = 37
+}
+
+```
+
+<Separator />
+
+### removeEventListener()
+
+The `removeEventListener()` method removes all event listeners for a specific event (only `keyup` is supported).
+
+```ts expandable
+removeEventListener(event: 'keyup', listener: (...args: any[]) => void): void;
+```
+
+<Separator />
+
+### removeEventListeners()
+
+The `removeEventListeners()` method removes all event listeners bind on `sos.input` object.
+
+```ts expandable
+removeEventListeners(): void;
+```

package/docs/sos/monitors.md

@@ -0,0 +1,21 @@
+# monitors
+
+The `sos.management.monitors` API groups together methods for providing information about monitors connected to the device.
+
+## Methods
+
+### getList()
+
+The `getList()` method returns a list of monitors currently connected to the device.
+
+```ts expandable
+getList(): Promise<IConnectedMonitor[]>;
+// show-more
+interface IConnectedMonitor {
+    manufacturer: string;
+    model: string;
+    serial: string;
+    firmware?: string;
+}
+
+```

package/docs/sos/native/index.md

@@ -0,0 +1,5 @@
+# native
+
+The `sos.native` API groups together methods for controlling the device using native commands.
+
+## Methods

package/docs/sos/native/mdc.md

@@ -0,0 +1,240 @@
+# mdc
+
+The `sos.native.mdc` API groups together methods for controlling Tizen devices using MDC commands.
+
+:::warning
+
+This API is currently available on Tizen devices only.
+
+:::
+
+:::info
+
+You can ensure that the device supports MDC commands via `sos.management.supports("NATIVE_COMMANDS_MDC")`.
+
+:::
+
+## Methods
+
+### sendOne()
+
+The `sendOne()` method sends an MDC command to another Tizen device on the same network or to the localhost.
+
+```ts expandable
+sendOne(ipAddress: IpAddressType, command: CodesMDC, data?: number[]): Promise<IMDCResponse>;
+// show-more
+/**
+ * This enum contains valid command codes for Tizen MDC communication.
+ */
+enum CodesMDC {
+    STATUS_CONTROL = 0,
+    VIDEO_CONTROL = 4,
+    RGB_CONTROL = 6,
+    PIP_STATUS_CONTROL = 7,
+    MAINTENANCE_CONTROL = 8,
+    SOUND_CONTROL = 9,
+    SERIAL_NUMBER_CONTROL = 11,
+    DISPLAY_STATUS_CONTROL = 13,
+    SW_VERSION_CONTROL = 14,
+    AUTO_MOTION_PLUS = 15,
+    MODEL_NUMBER_CONTROL = 16,
+    POWER_CONTROL = 17,
+    VOLUME_CONTROL = 18,
+    MUTE_CONTROL = 19,
+    INPUT_SOURCE = 20,
+    IMAGE_SIZE_CONTROL = 21,
+    DIRECT_CHANNEL_CONTROL = 23,
+    SCREEN_MODE_CONTROL = 24,
+    SCREEN_SIZE_CONTROL = 25,
+    OUTDOOR = 26,
+    SYSTEM_CONFIGURATION = 27,
+    MAGIC_INFO_CONTROL = 28,
+    MDC_CONNECTION_TYPE = 29,
+    STILL_CONTROL = 31,
+    PICTURE_CONTROL = 33,
+    CONTRAST_CONTROL = 36,
+    BRIGHTNESS_CONTROL = 37,
+    SHARPNESS_CONTROL = 38,
+    COLOR_CONTROL = 39,
+    TINT_CONTROL = 40,
+    COARSE_CONTROL = 47,
+    FINE_CONTROL = 48,
+    H_POSITION_CONTROL = 49,
+    V_POSITION_CONTROL = 50,
+    AUTO_POWER = 51,
+    CLEAR_MENU_CONTROL = 52,
+    REMOTE_CONTROL = 54,
+    RGB_CONTRAST_CONTROL = 55,
+    RGB_BRIGHTNESS_CONTROL = 56,
+    PIP_CONTROL = 60,
+    AUTO_ADJUST_CONTROL = 61,
+    COLOR_TONE_CONTROL = 62,
+    COLOR_TEMPERATURE_CONTROL = 63,
+    PIP_SOURCE_CONTROL = 64,
+    PIP_SIZE_CONTROL = 66,
+    PIP_LOCATE_CONTROL = 67,
+    FAN_SPEED_SETTING = 68,
+    USER_AUTO_COLOR = 69,
+    SOUND_SELECT_CONTROL = 71,
+    AUTO_VOLUME = 72,
+    STANDBY_CONTROL = 74,
+    VIDEO_PICTURE_POSITION_AND_SIZE = 75,
+    PIXEL_SHIFT_CONTROL = 76,
+    SENSOR_CONTROL = 80,
+    EQ_100HZ_CONTROL = 81,
+    EQ_300HZ_CONTROL = 82,
+    EQ_1KHZ_CONTROL = 83,
+    EQ_3KHZ_CONTROL = 84,
+    EQ_10KHZ_CONTROL = 85,
+    ENERGY_SAVING_LFG = 86,
+    AUTO_LAMP_CONTROL = 87,
+    MANUAL_LAMP_CONTROL_BACKLIGHT = 88,
+    SAFETY_SCREEN_RUN_CONTROL = 89,
+    INVERSE_CONTROL = 90,
+    SAFETY_SCREEN_CONTROL_MFM = 91,
+    VIDEO_WALL_MODE_CONTROL = 92,
+    SAFETY_LOCK = 93,
+    KEY_LOCK_CONTROL_MFM = 95,
+    CHANNEL_UP_DOWN = 97,
+    VOLUME_UP_DOWN = 98,
+    TICKER = 99,
+    PC_MODULE_DETECT = 102,
+    DEVICE_NAME = 103,
+    SPEAKER_SELECT = 104,
+    OSD_OFF_ON = 112,
+    PICTURE_MODE_CONTROL = 113,
+    SOUND_MODE_CONTROL = 114,
+    DIGITAL_NR = 115,
+    PC_COLOR_TONE_CONTROL = 117,
+    AUTO_AUTO_ADJUSTMENT = 118,
+    ALL_KEYS_LOCK = 119,
+    SRS_TSXT_CONTROL = 120,
+    FILM_MODE = 121,
+    PANEL_ON_TIME = 131,
+    VIDEO_WALL_ON = 132,
+    TEMPERATURE_CONTROL = 133,
+    BRIGHTNESS_SENSOR = 134,
+    DYNAMIC_CONTRAST = 135,
+    VIDEO_WALL_USER_CONTROL = 137,
+    MODEL_NAME = 138,
+    VIDEO_WALL_DIRECT_USER_CONTROL = 139,
+    VIDEO_WALL_FEATURE_CONTROL = 140,
+    FRAME_ALIGNMENT = 129,
+    FAN = 143,
+    GAME_MODE = 144,
+    ENERGY_SAVING = 146,
+    HDMI_BLACK_LEVEL = 148,
+    BLACK_ADJUST = 149,
+    GAMMA = 150,
+    EDGE_ENHANCEMENT = 156,
+    COLOR_SPACE = 157,
+    XVYCC = 158,
+    RESET_CONTROL = 159,
+    AMBIENT_BRIGHTNESS_MODE = 161,
+    OSD_DISPLAY_TYPE = 163,
+    TIMER_1_CONTROL_MFM = 164,
+    TIMER_2_CONTROL_MFM = 165,
+    TIMER_3_CONTROL_MFM = 166,
+    CLOCK_CONTROL_MFM = 167,
+    HOLIDAY_CONTROL = 168,
+    HOLIDAY_GET_CONTROL = 169,
+    TIMER_4_CONTROL = 171,
+    TIMER_5_CONTROL = 172,
+    TIMER_6_CONTROL = 173,
+    TIMER_7_CONTROL = 174,
+    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,
+    DAYLIGHT_SAVING_TIME_CONTROL = 182,
+    CUSTOM_PIP_CONTROL = 183,
+    AUTO_ID_SETTING_STATUS_CONTROL = 184,
+    DISPLAY_ID_INFORMATION = 185,
+    APPLY_CALIBRATED_DATA_FOR_ALL_SOURCE_OR_CURRENT_SOURCE = 195,
+    CLOCK_CONTROL_MFM_2 = 197,
+    ECO_SOLUTION = 198,
+    EXECUTE_LAUNCHER = 199,
+    ONSCREEN_DISPLAY_MENU_CONTROL = 200,
+    SOUND_MENU_CONTROL = 201,
+    SYSTEM_MENU_CONTROL = 202,
+    OTHER_PROTOCOL_INTERFACE = 207,
+    LED_PRODUCT_FEATURE = 208,
+    LARGE_SIZE_AND_GENERAL_REPLY_FUNCTIONS = 210,
+    NET_PIP_COMMAND = 224,
+    APPLY_TO_CONTROL = 228,
+    PANEL_ON_OFF = 249,
+    AUTO_ID = 253,
+    WHITE_BALANCE_MDC_CONTROL = 254,
+    REPLY = 255
+}
+
+interface IMDCResponse {
+    type: 'ACK' | 'NACK';
+    commandType: number;
+    result: number;
+}
+
+```
+
+#### Params
+
+| Name                | Type       | Description                                          |
+|---------------------|------------|------------------------------------------------------|
+| `ipAddress`         | `string`   | The IP address of the device to send the command to. |
+| `command`           | `CodesMDC` | The MDC command to send.                             |
+| `data` *(optional)* | `number[]` | The optional data to send with the command.          |
+
+#### Example
+
+```ts
+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>
+```
+
+<Separator />
+
+### sendOneRaw()
+
+The `sendOneRaw()` method sends an MDC command to another Tizen device on the same network or to the localhost,
+but without explicitly specifying the command.
+
+```ts expandable
+sendOneRaw(ipAddress: IpAddressType, data: number[] | [
+]): Promise<IMDCResponse>;
+// show-more
+interface IMDCResponse {
+    type: 'ACK' | 'NACK';
+    commandType: number;
+    result: number;
+}
+
+```
+
+#### Params
+
+| Name        | Type             | Description                                          |
+|-------------|------------------|------------------------------------------------------|
+| `ipAddress` | `string`         | The IP address of the device to send the command to. |
+| `data`      | `number[] \| []` | The data to send with the command.                   |
+
+#### Example
+
+```ts
+await sos.native.mdc.sendOneRaw('localhost', [0x1B, 0x00, 0x01, 0x74]); // Promise<IMDCResponse>
+
+// Example of returned object
+{
+    "type": "ACK", // or NACK
+    "commandType": 4,
+    "result": 0, // Value what command returned
+}
+```