@signageos/front-applet 8.1.3 → 8.2.0

package/docs/sos/browser.md

@@ -81,9 +81,9 @@ type Event<TType extends EventType = EventType> = {
 
 #### Params
 
-| Name       | Type                          | Description                                           |
-|------------|-------------------------------|-------------------------------------------------------|
-| `listener` | `(event: CloseEvent) => void` | The listener to be called when the browser is closed. |
+| Name       | Type                          | Required         | Description                                           |
+|------------|-------------------------------|------------------|-------------------------------------------------------|
+| `listener` | `(event: CloseEvent) => void` |  <div>Yes</div>  | The listener to be called when the browser is closed. |
 
 #### Return value
 
@@ -159,20 +159,20 @@ type ITheme = {
 
 #### Params
 
-| Name                                      | Type                                                       | Description                                                                                                                                                               |
-|-------------------------------------------|------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `uri`                                     | `string`                                                   | The URL to open in the browser.                                                                                                                                           |
-| `options` *(optional)*                    | `IOpenLinkOptions`                                         | Optional parameters to configure the browser window.                                                                                                                      |
-| `options.aclDomains` *(optional)*         | `string[]`                                                 | List of domains to be interpreted according to `aclMode`. Example: `signageos.io`, `www.example.com`                                                                      |
-| `options.aclMode` *(optional)*            | `"blacklist" \| "whitelist"`                               | `blacklist` – Allow access to all domains except those in aclDomains and their subdomains, `whitelist` – Allow access only to domains in aclDomains and their subdomains. |
-| `options.readOnlyAddressBar` *(optional)* | `boolean`                                                  | If `true`, the address bar is read-only, if `false` the user can navigate away by entering a URL in the address bar.                                                      |
-| `options.idleTimeout` *(optional)*        | `number`                                                   | The browser will automatically close after a specified period of inactivity (in milliseconds).                                                                            |
-| `options.coordinates` *(optional)*        | `{ x: number; y: number; width: number; height: number; }` | Size and position of the browser window. Defaults to fullscreen.                                                                                                          |
-| `options.theme` *(optional)*              | `ITheme`                                                   | Specify custom UI theme. (Android only)                                                                                                                                   |
-| `options.headlessMode` *(optional)*       | `boolean`                                                  | Headless mode hides the entire address bar. (Android only)                                                                                                                |
-| `options.canUserClose` *(optional)*       | `boolean`                                                  | Whether the user can manually close the browser. (default if headless false, else true)                                                                                   |
-| `options.clearData` *(optional)*          | `boolean`                                                  | Clear cache after the browser closes. (default if headless false, else true)                                                                                              |
-| `options.method` *(optional)*             | `"native" \| "iframe"`                                     | Can only be native (which opens a new, fully sandboxed fullscreen window) or iframe (which opens a configurable-sized window). (only Linux)                               |
+| Name                         | Type                                                       | Required         | Description                                                                                                                                                               |
+|------------------------------|------------------------------------------------------------|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `uri`                        | `string`                                                   |  <div>Yes</div>  | The URL to open in the browser.                                                                                                                                           |
+| `options`                    | `IOpenLinkOptions`                                         |  <div>No</div>   | Optional parameters to configure the browser window.                                                                                                                      |
+| `options.aclDomains`         | `string[]`                                                 |  <div>No</div>   | List of domains to be interpreted according to `aclMode`. Example: `signageos.io`, `www.example.com`                                                                      |
+| `options.aclMode`            | `"blacklist" \| "whitelist"`                               |  <div>No</div>   | `blacklist` – Allow access to all domains except those in aclDomains and their subdomains, `whitelist` – Allow access only to domains in aclDomains and their subdomains. |
+| `options.readOnlyAddressBar` | `boolean`                                                  |  <div>No</div>   | If `true`, the address bar is read-only, if `false` the user can navigate away by entering a URL in the address bar.                                                      |
+| `options.idleTimeout`        | `number`                                                   |  <div>No</div>   | The browser will automatically close after a specified period of inactivity (in milliseconds).                                                                            |
+| `options.coordinates`        | `{ x: number; y: number; width: number; height: number; }` |  <div>No</div>   | Size and position of the browser window. Defaults to fullscreen.                                                                                                          |
+| `options.theme`              | `ITheme`                                                   |  <div>No</div>   | Specify custom UI theme. (Android only)                                                                                                                                   |
+| `options.headlessMode`       | `boolean`                                                  |  <div>No</div>   | Headless mode hides the entire address bar. (Android only)                                                                                                                |
+| `options.canUserClose`       | `boolean`                                                  |  <div>No</div>   | Whether the user can manually close the browser. (default if headless false, else true)                                                                                   |
+| `options.clearData`          | `boolean`                                                  |  <div>No</div>   | Clear cache after the browser closes. (default if headless false, else true)                                                                                              |
+| `options.method`             | `"native" \| "iframe"`                                     |  <div>No</div>   | Can only be native (which opens a new, fully sandboxed fullscreen window) or iframe (which opens a configurable-sized window). (only Linux)                               |
 
 #### Return value
 

package/docs/sos/command.md

@@ -38,9 +38,9 @@ interface ICommand {
 
 #### Params
 
-| Name      | Type       | Description                   |
-|-----------|------------|-------------------------------|
-| `command` | `TCommand` | The command to be dispatched. |
+| Name      | Type       | Required         | Description                   |
+|-----------|------------|------------------|-------------------------------|
+| `command` | `TCommand` |  <div>Yes</div>  | The command to be dispatched. |
 
 #### Possible errors
 
@@ -103,9 +103,9 @@ interface ICommand {
 
 #### Params
 
-| Name       | Type                               | Description                                               |
-|------------|------------------------------------|-----------------------------------------------------------|
-| `listener` | `(command: ICommandEvent) => void` | The listener to be called when a new command is received. |
+| Name       | Type                               | Required         | Description                                               |
+|------------|------------------------------------|------------------|-----------------------------------------------------------|
+| `listener` | `(command: ICommandEvent) => void` |  <div>Yes</div>  | The listener to be called when a new command is received. |
 
 #### Return value
 

package/docs/sos/debug.md

@@ -21,6 +21,10 @@ The `isRemoteDebugEnabled()` method returns the state of the Device debug mode.
 isRemoteDebugEnabled(): Promise<boolean>;
 ```
 
+#### Return value
+
+Resolves to `true` if the remote debug mode is enabled, otherwise `false`.
+
 <Separator />
 
 ### onRemoteDebugChanged()
@@ -35,9 +39,9 @@ onRemoteDebugChanged(listener: (data: {
 
 #### Params
 
-| Name       | Type                                    | Description                                                                   |
-|------------|-----------------------------------------|-------------------------------------------------------------------------------|
-| `listener` | `(data: { enabled: boolean; }) => void` | The listener to be called when the state of the remote debug mode is changed. |
+| Name       | Type                                    | Required         | Description                                                                   |
+|------------|-----------------------------------------|------------------|-------------------------------------------------------------------------------|
+| `listener` | `(data: { enabled: boolean; }) => void` |  <div>Yes</div>  | The listener to be called when the state of the remote debug mode is changed. |
 
 #### Return value
 

package/docs/sos/deviceInfo.md

@@ -14,6 +14,10 @@ tags.
 The `getDeviceName()` method returns a name of the device. Name is requested from server on application start, automatically
 updated when changed and persisted in local storage.
 
+:::note
+Device name can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/Device/paths/~1v2~1device~1%7BdeviceUid%7D/get).
+:::
+
 ```ts expandable
 getDeviceName(): Promise<string>;
 ```
@@ -37,7 +41,7 @@ The `getLocation()` method returns location of the device. Location is requested
 updated when changed and persisted in local storage.
 
 :::note
-Location can be set only in CloudControl on Device Info page, or via Rest API.
+Location can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/DeviceLocation/paths/~1v1~1device~1%7BdeviceUid%7D~1location~1%7BlocationUid%7D/get).
 :::
 
 ```ts expandable
@@ -63,7 +67,7 @@ The `getOrganizationTags()` method returns all tags assigned to the device. Tags
 updated when changed and persisted in local storage.
 
 :::note
-Tags can be set only in CloudControl on Device Info page, or via Rest API.
+Tags can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/DeviceTag-(Device-Tags)).
 :::
 
 ```ts expandable

package/docs/sos/display.md

@@ -47,9 +47,9 @@ type AnyString = string & {};
 
 #### Params
 
-| Name         | Type                | Description                            |
-|--------------|---------------------|----------------------------------------|
-| `capability` | `DisplayCapability` | - The capability to check for support. |
+| Name         | Type                | Required         | Description                          |
+|--------------|---------------------|------------------|--------------------------------------|
+| `capability` | `DisplayCapability` |  <div>Yes</div>  | The capability to check for support. |
 
 #### Return value
 

package/docs/sos/fileSystem.md

@@ -96,10 +96,10 @@ interface IStorageUnit {
 
 #### Params
 
-| Name       | Type        | Description                             |
-|------------|-------------|-----------------------------------------|
-| `filePath` | `IFilePath` | The path to the file to be appended.    |
-| `contents` | `string`    | The content to be appended to the file. |
+| Name       | Type        | Required         | Description                             |
+|------------|-------------|------------------|-----------------------------------------|
+| `filePath` | `IFilePath` |  <div>Yes</div>  | The path to the file to be appended.    |
+| `contents` | `string`    |  <div>Yes</div>  | The content to be appended to the file. |
 
 #### Return value
 
@@ -182,12 +182,12 @@ interface ICopyFileOptions {
 
 #### Params
 
-| Name                             | Type               | Description                                                                            |
-|----------------------------------|--------------------|----------------------------------------------------------------------------------------|
-| `sourceFilePath`                 | `IFilePath`        | The path to the file to be copied.                                                     |
-| `destinationFilePath`            | `IFilePath`        | The path where the file will be copied to.                                             |
-| `options` *(optional)*           | `ICopyFileOptions` | Options for copying the file.                                                          |
-| `options.overwrite` *(optional)* | `boolean`          | If set to `true`, the method will overwrite the destination file if it already exists. |
+| Name                  | Type               | Required         | Description                                                                            |
+|-----------------------|--------------------|------------------|----------------------------------------------------------------------------------------|
+| `sourceFilePath`      | `IFilePath`        |  <div>Yes</div>  | The path to the file to be copied.                                                     |
+| `destinationFilePath` | `IFilePath`        |  <div>Yes</div>  | The path where the file will be copied to.                                             |
+| `options`             | `ICopyFileOptions` |  <div>No</div>   | Options for copying the file.                                                          |
+| `options.overwrite`   | `boolean`          |  <div>No</div>   | If set to `true`, the method will overwrite the destination file if it already exists. |
 
 #### Return value
 
@@ -281,10 +281,10 @@ interface IStorageUnit {
 
 #### Params
 
-| Name              | Type          | Description                                           |
-|-------------------|---------------|-------------------------------------------------------|
-| `archiveFilePath` | `IFilePath`   | The path where the archive file will be created.      |
-| `archiveEntries`  | `IFilePath[]` | An array of file paths to be included in the archive. |
+| Name              | Type          | Required         | Description                                           |
+|-------------------|---------------|------------------|-------------------------------------------------------|
+| `archiveFilePath` | `IFilePath`   |  <div>Yes</div>  | The path where the archive file will be created.      |
+| `archiveEntries`  | `IFilePath[]` |  <div>Yes</div>  | An array of file paths to be included in the archive. |
 
 #### Return value
 
@@ -384,9 +384,9 @@ interface IStorageUnit {
 
 #### Params
 
-| Name            | Type        | Description                                       |
-|-----------------|-------------|---------------------------------------------------|
-| `directoryPath` | `IFilePath` | The path where the new directory will be created. |
+| Name            | Type        | Required         | Description                                       |
+|-----------------|-------------|------------------|---------------------------------------------------|
+| `directoryPath` | `IFilePath` |  <div>Yes</div>  | The path where the new directory will be created. |
 
 #### Return value
 
@@ -464,10 +464,10 @@ interface IStorageUnit {
 
 #### Params
 
-| Name        | Type        | Description                                                                              |
-|-------------|-------------|------------------------------------------------------------------------------------------|
-| `filePath`  | `IFilePath` | The path to the file or directory to be deleted.                                         |
-| `recursive` | `boolean`   | If set to `true`, the method will delete the directory and all its contents recursively. |
+| Name        | Type        | Required         | Description                                                                              |
+|-------------|-------------|------------------|------------------------------------------------------------------------------------------|
+| `filePath`  | `IFilePath` |  <div>Yes</div>  | The path to the file or directory to be deleted.                                         |
+| `recursive` | `boolean`   |  <div>Yes</div>  | If set to `true`, the method will delete the directory and all its contents recursively. |
 
 #### Return value
 
@@ -591,11 +591,11 @@ interface IHeaders {
 
 #### Params
 
-| Name                   | Type        | Description                                                                                                                     |
-|------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------|
-| `filePath`             | `IFilePath` | The path where the downloaded file will be saved.                                                                               |
-| `sourceUri`            | `string`    | The URI of the file to be downloaded.                                                                                           |
-| `headers` *(optional)* | `IHeaders`  | Key, value pairs of HTTP headers to send along with the request. Used when the target file is protected by a password or if any |
+| Name        | Type        | Required         | Description                                                                                                                     |
+|-------------|-------------|------------------|---------------------------------------------------------------------------------------------------------------------------------|
+| `filePath`  | `IFilePath` |  <div>Yes</div>  | The path where the downloaded file will be saved.                                                                               |
+| `sourceUri` | `string`    |  <div>Yes</div>  | The URI of the file to be downloaded.                                                                                           |
+| `headers`   | `IHeaders`  |  <div>No</div>   | Key, value pairs of HTTP headers to send along with the request. Used when the target file is protected by a password or if any |
 
 #### Return value
 
@@ -677,9 +677,9 @@ interface IStorageUnit {
 
 #### Params
 
-| Name       | Type        | Description                                 |
-|------------|-------------|---------------------------------------------|
-| `filePath` | `IFilePath` | The path to the file or directory to check. |
+| Name       | Type        | Required         | Description                                 |
+|------------|-------------|------------------|---------------------------------------------|
+| `filePath` | `IFilePath` |  <div>Yes</div>  | The path to the file or directory to check. |
 
 #### Return value
 
@@ -768,11 +768,11 @@ type AnyString = string & {};
 
 #### Params
 
-| Name                       | Type                | Description                                                           |
-|----------------------------|---------------------|-----------------------------------------------------------------------|
-| `archiveFilePath`          | `IFilePath`         | The path to the archive file to be decompressed.                      |
-| `destinationDirectoryPath` | `IFilePath`         | The path to the directory where the decompressed files will be saved. |
-| `method`                   | `ExtractMethodType` | Extract method to use for extracting, e.g. 'zip'.                     |
+| Name                       | Type                | Required         | Description                                                           |
+|----------------------------|---------------------|------------------|-----------------------------------------------------------------------|
+| `archiveFilePath`          | `IFilePath`         |  <div>Yes</div>  | The path to the archive file to be decompressed.                      |
+| `destinationDirectoryPath` | `IFilePath`         |  <div>Yes</div>  | The path to the directory where the decompressed files will be saved. |
+| `method`                   | `ExtractMethodType` |  <div>Yes</div>  | Extract method to use for extracting, e.g. 'zip'.                     |
 
 #### Possible errors
 
@@ -878,9 +878,9 @@ interface IStorageUnit {
 
 #### Params
 
-| Name       | Type        | Description                           |
-|------------|-------------|---------------------------------------|
-| `filePath` | `IFilePath` | The path to the file to be retrieved. |
+| Name       | Type        | Required         | Description                           |
+|------------|-------------|------------------|---------------------------------------|
+| `filePath` | `IFilePath` |  <div>Yes</div>  | The path to the file to be retrieved. |
 
 #### Return value
 
@@ -972,10 +972,10 @@ type AnyString = string & {};
 
 #### Params
 
-| Name       | Type            | Description                                                   |
-|------------|-----------------|---------------------------------------------------------------|
-| `filePath` | `IFilePath`     | The path to the file for which the checksum will be computed. |
-| `hashType` | `HashAlgorithm` | The type of hash algorithm to use for computing the checksum. |
+| Name       | Type            | Required         | Description                                                   |
+|------------|-----------------|------------------|---------------------------------------------------------------|
+| `filePath` | `IFilePath`     |  <div>Yes</div>  | The path to the file for which the checksum will be computed. |
+| `hashType` | `HashAlgorithm` |  <div>Yes</div>  | The type of hash algorithm to use for computing the checksum. |
 
 #### Return value
 
@@ -1054,9 +1054,9 @@ interface IStorageUnit {
 
 #### Params
 
-| Name       | Type        | Description             |
-|------------|-------------|-------------------------|
-| `filePath` | `IFilePath` | The file path to check. |
+| Name       | Type        | Required         | Description             |
+|------------|-------------|------------------|-------------------------|
+| `filePath` | `IFilePath` |  <div>Yes</div>  | The file path to check. |
 
 #### Return value
 
@@ -1140,10 +1140,10 @@ interface IStorageUnit {
 
 #### Params
 
-| Name                  | Type        | Description                                                          |
-|-----------------------|-------------|----------------------------------------------------------------------|
-| `sourceFilePath`      | `IFilePath` | The path to the existing file or directory that you want to link to. |
-| `destinationFilePath` | `IFilePath` | The path where the symbolic link will be created.                    |
+| Name                  | Type        | Required         | Description                                                          |
+|-----------------------|-------------|------------------|----------------------------------------------------------------------|
+| `sourceFilePath`      | `IFilePath` |  <div>Yes</div>  | The path to the existing file or directory that you want to link to. |
+| `destinationFilePath` | `IFilePath` |  <div>Yes</div>  | The path where the symbolic link will be created.                    |
 
 #### Return value
 
@@ -1226,9 +1226,9 @@ interface IStorageUnit {
 
 #### Params
 
-| Name            | Type        | Description                                           |
-|-----------------|-------------|-------------------------------------------------------|
-| `directoryPath` | `IFilePath` | The path to the directory where files will be listed. |
+| Name            | Type        | Required         | Description                                           |
+|-----------------|-------------|------------------|-------------------------------------------------------|
+| `directoryPath` | `IFilePath` |  <div>Yes</div>  | The path to the directory where files will be listed. |
 
 #### Return value
 
@@ -1434,12 +1434,12 @@ interface IMoveFileOptions {
 
 #### Params
 
-| Name                             | Type               | Description                                                                            |
-|----------------------------------|--------------------|----------------------------------------------------------------------------------------|
-| `sourceFilePath`                 | `IFilePath`        | The path to the file to be moved.                                                      |
-| `destinationFilePath`            | `IFilePath`        | The path where the file will be moved to.                                              |
-| `options` *(optional)*           | `IMoveFileOptions` | Options for moving the file.                                                           |
-| `options.overwrite` *(optional)* | `boolean`          | If set to `true`, the method will overwrite the destination file if it already exists. |
+| Name                  | Type               | Required         | Description                                                                            |
+|-----------------------|--------------------|------------------|----------------------------------------------------------------------------------------|
+| `sourceFilePath`      | `IFilePath`        |  <div>Yes</div>  | The path to the file to be moved.                                                      |
+| `destinationFilePath` | `IFilePath`        |  <div>Yes</div>  | The path where the file will be moved to.                                              |
+| `options`             | `IMoveFileOptions` |  <div>No</div>   | Options for moving the file.                                                           |
+| `options.overwrite`   | `boolean`          |  <div>No</div>   | If set to `true`, the method will overwrite the destination file if it already exists. |
 
 #### Return value
 
@@ -1482,9 +1482,9 @@ onStorageUnitsChanged(listener: () => void): void;
 
 #### Params
 
-| Name       | Type         | Description                                                       |
-|------------|--------------|-------------------------------------------------------------------|
-| `listener` | `() => void` | The listener function to be called when the storage units change. |
+| Name       | Type         | Required         | Description                                                       |
+|------------|--------------|------------------|-------------------------------------------------------------------|
+| `listener` | `() => void` |  <div>Yes</div>  | The listener function to be called when the storage units change. |
 
 #### Possible errors
 
@@ -1544,9 +1544,9 @@ interface IStorageUnit {
 
 #### Params
 
-| Name       | Type        | Description                      |
-|------------|-------------|----------------------------------|
-| `filePath` | `IFilePath` | The path to the file to be read. |
+| Name       | Type        | Required         | Description                      |
+|------------|-------------|------------------|----------------------------------|
+| `filePath` | `IFilePath` |  <div>Yes</div>  | The path to the file to be read. |
 
 #### Return value
 
@@ -1664,10 +1664,10 @@ interface IStorageUnit {
 
 #### Params
 
-| Name       | Type        | Description                            |
-|------------|-------------|----------------------------------------|
-| `filePath` | `IFilePath` | The path to the file to be written.    |
-| `contents` | `string`    | The content to be written to the file. |
+| Name       | Type        | Required         | Description                            |
+|------------|-------------|------------------|----------------------------------------|
+| `filePath` | `IFilePath` |  <div>Yes</div>  | The path to the file to be written.    |
+| `contents` | `string`    |  <div>Yes</div>  | The content to be written to the file. |
 
 #### Return value
 

package/docs/sos/hardware/barcodeScanner.md

@@ -4,36 +4,39 @@ sidebar_position: 0
 
 # barcodeScanner
 
-## Methods
+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.
 
-### getVersion()
+:::note
+This API is experimental and may change in the future.
+:::
 
-:::warning
+## Methods
 
-This API is experimental and may change in the future.
+### getVersion()
 
-:::
+The `getVersion()` method returns the version of the barcode scanner.
 
 ```ts expandable
 getVersion(): Promise<string>;
 ```
 
-<Separator />
+#### Return value
 
-### start()
+Returns a promise that resolves to the version of the barcode scanner.
 
-:::warning
+#### Possible errors
 
-This API is experimental and may change in the future.
+If the version cannot be retrieved.
 
-:::
+<Separator />
+
+### start()
+
+The `start()` starts the barcode scanner and starts listening for scanned data.
 
 ```ts expandable
-start(userOptions?: Omit<IBarcodeScannerOptions, 'scannerId'>): Promise<{
-    stop: () => Promise<void>;
-    onData: (listener: (data: string) => void) => void;
-    onError: (listener: (error: Error) => void) => void;
-}>;
+start(userOptions?: Omit<IBarcodeScannerOptions, 'scannerId'>): Promise<IBarcodeScannerResponse>;
 // show-more
 interface IBarcodeScannerOptions {
     timeout?: number;
@@ -41,4 +44,44 @@ interface IBarcodeScannerOptions {
     scannerId?: number;
 }
 
+interface IBarcodeScannerResponse {
+    stop: () => Promise<void>;
+    onData: (listener: (data: string) => void) => void;
+    onError: (listener: (error: Error) => void) => void;
+}
+
+```
+
+#### Params
+
+| Name                         | Type                                        | Required        | Description                                                                               |
+|------------------------------|---------------------------------------------|-----------------|-------------------------------------------------------------------------------------------|
+| `userOptions`                | `Omit<IBarcodeScannerOptions, "scannerId">` |  <div>No</div>  | User options to configure the scanner.                                                    |
+| `userOptions.timeout`        | `number`                                    |  <div>No</div>  | The maximum time to wait for a scan before timing out.                                    |
+| `userOptions.cancelPrevious` | `boolean`                                   |  <div>No</div>  | If set to `true`, it will cancel any previous scanner instance with the same `scannerId`. |
+
+#### Return value
+
+Returns a promise that resolves to an object with methods to stop the scanner and listen for scanned data and errors.
+
+#### Possible errors
+
+
+- If the scanner cannot be started.
+- If the scanner is already running and `cancelPrevious` option is not set to `true`.
+- If any other error occurs while starting the scanner.
+
+#### Example
+
+```ts
+// 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}`);
+});
 ```

package/docs/sos/hardware/index.md

@@ -4,21 +4,39 @@ sidebar_position: 0
 
 # hardware
 
-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`) |
 
 ## Methods
 
 ### openSerialPort()
 
-<Admonition type="info" icon="" title="">
-  Learn more about using this API [here](https://developers.signageos.io/docs/applets/api-guides/serial-port)
-</Admonition>
-
-The `openSerialPort()` method opens a serial port for reading/writing. After the port is opened the method returns ISerialPort interface.
+The `openSerialPort()` method opens a serial port for reading/writing. After the port is opened the method returns 
 
 ```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 {
     device?: string;
     baudRate: number;
@@ -36,14 +54,27 @@ 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
+     * 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()
@@ -54,6 +85,9 @@ 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>;
 }
@@ -62,14 +96,37 @@ interface ISerialPort {
 
 #### 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. |
+| Name               | Type      | Required         | Description                                                                                                         |
+|--------------------|-----------|------------------|---------------------------------------------------------------------------------------------------------------------|
+| `options.device`   | `string`  |  <div>No</div>   | Specifies the address of the external device, check the table above for ports.                                      |
+| `options.baudRate` | `number`  |  <div>Yes</div>  | Specifies the data transmission speed in bits per second.                                                           |
+| `options.parity`   | `Parity`  |  <div>No</div>   | Specifies the form of error checking, whether (or what) extra bits are added to a byte.                             |
+| `options.databits` | `number`  |  <div>No</div>   | Specifies the number of bits in a byte.                                                                             |
+| `options.stopbits` | `number`  |  <div>No</div>   | Specifies the number of bits used to signal the end of a communication packet.                                      |
+| `options.rtscts`   | `boolean` |  <div>No</div>   | Enables or disables RTS/CTS handshaking over the serial port. Currently supported by selected models of BrightSign. |
+
+#### Return value
+
+Returns a promise that resolves to an instance of 
+
+#### Possible errors
+
+
+- If the serial port cannot be opened.
+- If the device address is not supported by the platform.
+- If the device fails to process the data.
+- If any other error occurs while opening the serial port.
+
+#### Example
+
+```ts
+// 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
+```
 
 ## API Example