@signageos/front-applet 8.2.0 → 8.2.2

package/docs/sos_management/proxy.md

@@ -4,6 +4,17 @@ sidebar_position: 0
 
 # proxy
 
+The `sos.management.proxy` API groups together methods for managing the proxy settings on the device.
+
+<details>
+    <summary>Proxy Management Capabilities</summary>
+		| Capability | Description |
+		|:------------|:-------------|
+		| `PROXY` | If device supports Proxy setup connection |
+
+		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
 
 ### disable()
@@ -14,6 +25,14 @@ The `disable()` method disables the proxy on the device.
 disable(): Promise<void>;
 ```
 
+#### Return value
+
+A promise that resolves when the proxy is disabled.
+
+#### Possible errors
+
+If the device does not support proxy management.
+
 #### Example
 
 ```ts
@@ -24,12 +43,20 @@ await sos.management.proxy.disable();
 
 ### getConnectedTo()
 
-The `getConnectedTo()` methods returns the current connected proxy server uri on the device.
+The `getConnectedTo()` method returns the current connected proxy server URI on the device.
 
 ```ts expandable
 getConnectedTo(): Promise<string>;
 ```
 
+#### Return value
+
+A promise that resolves to the URI of the connected proxy server.
+
+#### Possible errors
+
+If the device does not support proxy management.
+
 #### Example
 
 ```ts
@@ -47,24 +74,48 @@ The `isEnabled()` method returns whether the proxy is enabled on the device.
 isEnabled(): Promise<boolean>;
 ```
 
+#### Return value
+
+A promise that resolves to a boolean indicating if the proxy is enabled.
+
 #### Example
 
 ```ts
 const enabled = await sos.management.proxy.isEnabled();
+console.log(`Proxy is enabled: ${enabled}`);
 ```
 
 <Separator />
 
 ### setManual()
 
-The `setManual()` method sets the proxy on the device.
+The `setManual()` allows you to manually configure the proxy settings on the device.
 
 ```ts expandable
 setManual(uri: string, port: number, username?: string, password?: string): Promise<void>;
 ```
 
+#### Params
+
+| Name       | Type     | Required         | Description                       |
+|------------|----------|------------------|-----------------------------------|
+| `uri`      | `string` |  <div>Yes</div>  | The URI of the proxy server       |
+| `port`     | `number` |  <div>Yes</div>  | The port of the proxy server      |
+| `username` | `string` |  <div>No</div>   | The username for the proxy server |
+| `password` | `string` |  <div>No</div>   | The password for the proxy server |
+
+#### Return value
+
+A promise that resolves when the proxy is set.
+
+#### Possible errors
+
+
+- If the proxy settings are invalid.
+- If the device does not support proxy management.
+
 #### Example
 
 ```ts
-const enabled = await sos.management.proxy.setManual('178.62.193.192', 1080, 'username', 'password');
+await sos.management.proxy.setManual('178.62.193.192', 1080, 'username', 'password');
 ```

package/docs/sos_management/remoteControl.md

@@ -4,7 +4,16 @@ sidebar_position: 0
 
 # remoteControl
 
-The `sos.management.remoteControl` groups together methods for enabling or disabling control of the device using IR remote controller (TV controller).
+The `sos.management.remoteControl` groups together methods for enabling or disabling control of the device using an IR remote controller (TV controller).
+
+<details>
+    <summary>Remote Control Management Capabilities</summary>
+		| Capability | Description |
+		|:------------|:-------------|
+		| `SET_REMOTE_CONTROL_ENABLED` | If device supports setting remote control |
+
+		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
 
@@ -16,6 +25,10 @@ The `disable()` method disables remote control.
 disable(): Promise<void>;
 ```
 
+#### Possible errors
+
+If the device does not support remote control management.
+
 #### Example
 
 ```ts
@@ -29,18 +42,24 @@ await sos.management.remoteControl.disable();
 The `enable()` method enables remote control.
 
 :::warning
-
-**Android:** In order to prevent Android from displaying Android homepage and thus not showing your content, you
+**Android:** To prevent Android from displaying the Android homepage and thus not showing your content, you
 must Enable Kiosk Mode (or Lock Remote Control) either through Box device settings or through API.
 
 Always set the Remote Control Lock to `enable` after the deployment.
-
 :::
 
 ```ts expandable
 enable(): Promise<void>;
 ```
 
+#### Return value
+
+A promise that resolves when the remote control is successfully enabled.
+
+#### Possible errors
+
+If the device does not support remote control management.
+
 #### Example
 
 ```ts
@@ -57,6 +76,14 @@ The `isEnabled()` method returns whether the remote control is enabled.
 isEnabled(): Promise<boolean>;
 ```
 
+#### Return value
+
+A promise that resolves to `true` if remote control is enabled, otherwise `false`.
+
+#### Possible errors
+
+If the device does not support remote control management.
+
 #### Example
 
 ```ts
@@ -73,6 +100,14 @@ The `isLocked()` method returns whether the remote control is locked (disabled).
 isLocked(): Promise<boolean>;
 ```
 
+#### Return value
+
+A promise that resolves to `true` if the remote control is locked (disabled), otherwise `false`.
+
+#### Possible errors
+
+If the device does not support remote control management.
+
 #### Example
 
 ```ts
@@ -89,6 +124,14 @@ The `lock()` method is an alias for the `disable()` method.
 lock(): Promise<void>;
 ```
 
+#### Return value
+
+A promise that resolves when the remote control is successfully locked (disabled).
+
+#### Possible errors
+
+If the device does not support remote control management.
+
 #### Example
 
 ```ts
@@ -105,6 +148,14 @@ The `unlock()` method is an alias for the `enable()` method.
 unlock(): Promise<void>;
 ```
 
+#### Return value
+
+A promise that resolves when the remote control is successfully unlocked (enabled).
+
+#### Possible errors
+
+If the device does not support remote control management.
+
 #### Example
 
 ```ts

package/docs/sos_management/screen.md

@@ -4,27 +4,38 @@ sidebar_position: 0
 
 # screen
 
-The `sos.management.screen` API groups together methods for controlling the screen of the device. It allows to manipulate the screen
-resolution or orientation, set brightness, retrieve the current brightness of the display and manipulate the power mode.
+The `sos.management.screen` API groups together methods for controlling the screen of the device. It allows for manipulating the screen
+resolution or orientation, set brightness, retrieve the current brightness of the display, and manipulate the power mode.
 
 :::warning
-
-This method only turns on/off the display/backlight. It will **not** set any power-saving mode. We also strongly recommend to reboot any
+This method only turns on/off the display/backlight. It will **not** set any power-saving mode. We also strongly recommend rebooting any
 device once a day.
-
 :::
 
 :::info
-
 There is a specific behavior based on the device type you operate:
-**On SoC displays** (e.g. Samsung Tizen, LG webOS, Android-based SoC displays from Sony, Vestel Philips,...)
+**On SoC displays** (e.g., Samsung Tizen, LG webOS, Android-based SoC displays from Sony, Vestel Philips,...)
 - `powerOn()` and `powerOff()` are turning the display backlight and the panel off
-
-**On external media players** (e.g. BrightSign, Windows PC, Android players, Raspberry Pi)
-- `powerOn()` and `powerOff()` are turning off the video output (typically HDMI-out); the connected display backlight is not managed by this functionality and needs to be controlled via RS232 or another way.
-
+**On external media players** (e.g., BrightSign, Windows PC, Android players, Raspberry Pi)
+- `powerOn()` and `powerOff()` are turning off the video output (typically HDMI-out); this functionality does not manage the connected display backlight and needs to be controlled via RS232 or another way.
 :::
 
+<details>
+    <summary>Screen Management Capabilities</summary>
+		| Capability | Description |
+		|:------------|:-------------|
+		| `SET_BRIGHTNESS` | If device can brightness. |
+		| `GET_BRIGHTNESS` | If device can return current brightness. |
+		| `SCREEN_RESIZE` | If the device can change screen resolution and orientation. |
+		| `ORIENTATION_LANDSCAPE` | If device supports landscape orientation. |
+		| `ORIENTATION_PORTRAIT` | If device supports portrait orientation. |
+		| `ORIENTATION_LANDSCAPE_FLIPPED` | If device supports flipped landscape orientation. |
+		| `ORIENTATION_PORTRAIT_FLIPPED` | If device supports flipped portrait orientation. |
+		| `ORIENTATION_AUTO` | If device supports auto orientation. |
+
+		If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+</details>
+
 ## Methods
 
 ### getBrightness()
@@ -43,6 +54,14 @@ interface IBrightness {
 
 ```
 
+#### Return value
+
+A promise that resolves to the current brightness settings.
+
+#### Possible errors
+
+If the brightness cannot be retrieved.
+
 <Separator />
 
 ### getOrientation()
@@ -60,6 +79,21 @@ type Orientation = 'LANDSCAPE' | 'PORTRAIT' | 'LANDSCAPE_FLIPPED' | 'PORTRAIT_FL
 
 ```
 
+#### Return value
+
+A promise that resolves to the current screen orientation.
+
+#### Possible errors
+
+If the orientation cannot be retrieved.
+
+#### Example
+
+```ts
+const orientation = (await sos.management.screen.getOrientation()).screenOrientation;
+console.log(`Current screen orientation is: ${orientation}`);
+```
+
 <Separator />
 
 ### isPoweredOn()
@@ -70,25 +104,39 @@ The `isPoweredOn()` method returns whether the screen is on.
 isPoweredOn(): Promise<boolean>;
 ```
 
+#### Return value
+
+A promise that resolves to a boolean indicating whether the screen is powered on.
+
+#### Possible errors
+
+If the power state cannot be retrieved.
+
 <Separator />
 
 ### powerOff()
 
-The `powerOff()` method turn the screen off. It will turn off the display backlight and the panel, and it will also disable applet.
+The `powerOff()` method turns the screen off. It will turn off the display backlight and the panel, and it will also disable the applet.
 
 :::warning
-
-On Android devices, `powerOff()` also shuts down the webview and the Applet. It's default Android behavior that cannot be changed. Once
+On Android devices, `powerOff()` also shuts down the webview and the Applet. It's the default Android behavior that cannot be changed. Once
 the Applet is off, you cannot call `powerOn()` to resume the playback.
 
 To manage the display On/Off state, use [REST API Power Actions](https://developers.signageos.io/api/#tag/DevicePower-Actions) instead.
-
 :::
 
 ```ts expandable
 powerOff(): Promise<void>;
 ```
 
+#### Return value
+
+A promise that resolves when the screen is successfully turned off.
+
+#### Possible errors
+
+If the screen cannot be turned off.
+
 <Separator />
 
 ### powerOn()
@@ -99,16 +147,22 @@ The `powerOn()` method turns the screen on.
 powerOn(): Promise<void>;
 ```
 
+#### Return value
+
+A promise that resolves when the screen is successfully turned on.
+
+#### Possible errors
+
+If the screen cannot be turned on.
+
 <Separator />
 
 ### resize()
 
-The `resize()` method changes resolution and orientation of the display.
+The `resize()` method changes the resolution and orientation of the display.
 
 :::info
-
-For Tizen, you have to provide `baseUrl` which points to the Core App for Tizen which will be downloaded to the device [Read more how to upload your Core Apps here.](https://docs.signageos.io/hc/en-us/articles/4405245195666).
-
+For Tizen, you have to provide `baseUrl` which points to the Core App for Tizen, which will be downloaded to the device [Read more on how to upload your Core Apps here.](https://docs.signageos.io/hc/en-us/articles/4405245195666).
 :::
 
 ```ts expandable
@@ -119,11 +173,24 @@ resize(baseUrl: string, orientation: string, resolution: string, currentVersion:
 
 | Name               | Type     | Required         | Description                                                                                                                          |
 |--------------------|----------|------------------|--------------------------------------------------------------------------------------------------------------------------------------|
-| `baseUrl`          | `string` |  <div>Yes</div>  | SSSP & Tizen devices requires to install a orientation-specific Core App if you want to switch orientation to portrait or landscape. |
+| `baseUrl`          | `string` |  <div>Yes</div>  | SSSP & Tizen devices require installing an orientation-specific Core App if you want to switch orientation to portrait or landscape. |
 | `orientation`      | `string` |  <div>Yes</div>  | Screen orientation                                                                                                                   |
 | `resolution`       | `string` |  <div>Yes</div>  | Where it applies (mainly SSSP 2/3)                                                                                                   |
 | `currentVersion`   | `string` |  <div>Yes</div>  | Core App version                                                                                                                     |
-| `videoOrientation` | `string` |  <div>No</div>   | If the video has different orientation than the HTML5 content                                                                        |
+| `videoOrientation` | `string` |  <div>No</div>   | If the video has a different orientation than the HTML5 content                                                                      |
+
+#### Return value
+
+A promise that resolves when the screen is successfully resized.
+
+#### Possible errors
+
+
+- If `baseUrl` is not a valid URL
+- If `orientation` is not a valid orientation
+- If `resolution` is not a valid resolution
+- If `currentVersion` is not a valid string
+- If `videoOrientation` is not a valid video orientation
 
 #### Example
 
@@ -136,7 +203,7 @@ await sos.management.screen.resize(
     "1.0.4"
 );
 
-// for all other supported device
+// for all other supported devices
 await sos.management.screen.resize(
     "",
     "PORTRAIT",
@@ -155,7 +222,7 @@ await sos.management.screen.resize(
 
 ### setBrightness()
 
-The `setBrightness()` method sets the brightness of the screen. It supports 2 different brightness values for 2 time points in the day.
+The `setBrightness()` method sets the brightness of the screen. It supports two different brightness values for 2 time points in the day.
 
 ```ts expandable
 setBrightness(timeFrom1: string, brightness1: number, timeFrom2: string, brightness2: number): Promise<void>;
@@ -170,31 +237,58 @@ setBrightness(timeFrom1: string, brightness1: number, timeFrom2: string, brightn
 | `timeFrom2`   | `string` |  <div>Yes</div>  | Time in the XX:XX format           |
 | `brightness2` | `number` |  <div>Yes</div>  | Brightness value between 0 and 100 |
 
+#### Return value
+
+A promise that resolves when the brightness is successfully set.
+
+#### Possible errors
+
+
+- If `timeFrom1` is not a valid time in the XX:XX format
+- If `brightness1` is not a number between 0 and 100
+- If `timeFrom2` is not a valid time in the XX:XX format
+- If `brightness2` is not a number between 0 and 100
+
 #### Example
 
 ```ts
+// Set brightness to 10% between 00:00 and 17:00, and to 30% between 17:00 and 23:59
 await sos.management.screen.setBrightness(
     '00:00',
     '10',
     '17:00',
     '30'
 );
+
+// Set brightness to 50% all day
+await sos.management.screen.setBrightness(
+   00:00,
+   50,
+   23:59,
+   50
+);
 ```
 
+:::note[GitHub Example]
+
+- [ Applet Example with Brightness setup](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/brightness/)
+
+:::
+
 <Separator />
 
 ### takeAndUploadScreenshot(uploadBaseUrl, computeHash)
 
-The `takeAndUploadScreenshot()` method takes a screenshot and uploads it to a specified url. This can be either a signageOS upload url
-(`https://upload.signageos.io`) or a dedicated server url for uploading screenshots. Format in which the screenshot is uploaded may be
+The `takeAndUploadScreenshot()` method takes a screenshot and uploads it to a specified URL. This can be either a signageOS upload URL
+(`https://upload.signageos.io`) or a dedicated server URL for uploading screenshots. The format in which the screenshot is uploaded may be
 different for every platform.
 
 To implement a custom screenshot upload server, it needs to implement these endpoints:
 - POST `/upload/file?prefix=screenshot/` - Endpoint for receiving screenshot using form data, with the image set to the `file` field.
-- POST `/upload/raw?prefix=screenshot/` - Endpoint for receiving screenshots as a raw data.
-- POST `/upload/image-data-uri?prefix=screenshot/` - Endpoint for receiving screenshots encoded as a data url.
+- POST `/upload/raw?prefix=screenshot/` - Endpoint for receiving screenshots as raw data.
+- POST `/upload/image-data-uri?prefix=screenshot/` - Endpoint for receiving screenshots encoded as a data URL.
 
-signageOS provides standalone server which is implements all of those methods. It is provided to all of our partners through the
+signageOS provides a standalone server that implements all of those methods. It is offered to all of our partners through the
 [support ticketing system](https://box.signageos.io/support/).
 
 ```ts expandable
@@ -208,9 +302,20 @@ takeAndUploadScreenshot(uploadBaseUrl: string, computeHash?: boolean): Promise<{
 
 | Name            | Type      | Required         | Description                                                                                                   |
 |-----------------|-----------|------------------|---------------------------------------------------------------------------------------------------------------|
-| `uploadBaseUrl` | `string`  |  <div>Yes</div>  | URL to which the screenshot will be uploaded. It can be either a signageOS upload url or a custom server url. |
+| `uploadBaseUrl` | `string`  |  <div>Yes</div>  | URL to which the screenshot will be uploaded. It can be either a signageOS upload URL or a custom server URL. |
 | `computeHash`   | `boolean` |  <div>No</div>   | Whether to compute a hash of the screenshot and return it in the response.                                    |
 
+#### Return value
+
+A promise that resolves to an object containing the screenshot URL and optionally a hash of the screenshot.
+
+#### Possible errors
+
+
+- If `uploadBaseUrl` is not a valid URL
+- If `computeHash` is not a boolean
+- If the screenshot cannot be taken or uploaded.
+
 #### Example
 
 ```ts
@@ -220,6 +325,12 @@ const { screenshotUrl, aHash } = await sos.management.screen.takeAndUploadScreen
 );
 ```
 
+:::note[GitHub Example]
+
+- [ Applet Example with Screenshot Upload](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/screenshot-upload)
+
+:::
+
 <Separator />
 
 ### ~takeAndUploadScreenshot(uploadBaseUrl)~

package/docs/sos_management/security.md

@@ -4,18 +4,30 @@ sidebar_position: 0
 
 # security
 
-The `sos.management.security` API groups together methods for management of a security PIN code of the device.
+The `sos.management.security` API groups together methods for the management of a security PIN code of the device.
 
 ## Methods
 
 ### generateRandomPinCode()
 
-The `getPinCode()` method sets the PIN code to a randomly generated one.
+The `generateRandomPinCode()` generates a random 4-digit PIN code and sets it as the current PIN code.
 
 ```ts expandable
 generateRandomPinCode(): Promise<void>;
 ```
 
+#### Return value
+
+A promise that resolves when the random PIN code is successfully set.
+
+#### Example
+
+```ts
+await sos.management.security.generateRandomPinCode(); // Generate new random PIN code
+const newPinCode = await sos.management.security.getPinCode(); // Get PIN code as string
+console.log(newPinCode);
+```
+
 <Separator />
 
 ### getPinCode()
@@ -26,9 +38,20 @@ The `getPinCode()` method returns the currently set PIN code.
 getPinCode(): Promise<string>;
 ```
 
+#### Return value
+
+A promise that resolves to the currently set PIN code.
+
 #### Possible errors
 
-**41703**: Get PIN code failed because the PIN code has not been set yet.
+Get PIN code failed because the PIN code has not been set yet.
+
+#### Example
+
+```ts
+const pinCode = await sos.management.security.getPinCode();
+console.log(`Current PIN code is: ${pinCode}`);
+```
 
 <Separator />
 
@@ -36,6 +59,10 @@ getPinCode(): Promise<string>;
 
 The `setPinCode()` method sets the pin code.
 
+:::warning
+The maximum length of the PIN code is four characters.
+:::
+
 ```ts expandable
 setPinCode(pinCode: string): Promise<void>;
 ```
@@ -46,8 +73,24 @@ setPinCode(pinCode: string): Promise<void>;
 |-----------|----------|------------------|-------------------------|
 | `pinCode` | `string` |  <div>Yes</div>  | The PIN code to be set. |
 
+#### Return value
+
+A promise that resolves when the PIN code is successfully set.
+
 #### Possible errors
 
 
-- **41701**: Invalid PIN code format (has to be 4-digits string).
-- **41702**: PIN code 0000 is not allowed, use another PIN code.
+- Invalid PIN code format.
+- PIN code 0000 is not allowed, use another PIN code.
+
+#### Example
+
+```ts
+await sos.management.security.setPinCode("9999");
+```
+
+:::note[GitHub Example]
+
+- [ Applet Example with PIN setup](https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/security-pin-code)
+
+:::