@signageos/front-applet 7.1.1 → 8.0.0

package/docs/management/js-management-power.md

@@ -1,175 +0,0 @@
----
-title:  Power
-author: Krystof Woldrich
-date:   24.4.2018
-type:   js-management-api
-tags:
-- applet
-- applet_api
-- api
-- js_management_api
-description: "[Management JS API] POWER allows you to reboot the system, restart the application and set timer."
----
-
-# Power
-Management API power allows you to reboot the system, restart the application and set timer.
-
-## All methods
-
-
-| Methods  | Description | Supported since |
-| ------ | ------ | ------------- |
-| `systemReboot()` | Safely reboot device | 3.0.0 |
-| `appRestart()` | Restart Core App | 3.0.0 |
-| `setTimer()` | Create/Set Timer - when the device turns on and off based on the days in a week | 3.0.0 |
-| `unsetTimer()` | Remove Timer - when the device turns on and off based on the days in a week | 4.0.0 |
-| `getTimers()` | List All Timers - when the device turns on and off based on the days in a week | 4.0.0 |
-| `setProprietaryTimer()` | Create/Set Proprietary Timer - when the device turns on and off based on the days in a week | 5.10.0 |
-| `unsetProprietaryTimer()` | Remove Proprietary Timer - when the device turns on and off based on the days in a week | 5.10.0 |
-| `getProprietaryTimers()` | List All Proprietary Timers - when the device turns on and off based on the days in a week | 5.10.0 
-
-## systemReboot()
-Method `systemReboot()` will reboot a targeted device.
-
-```javascript
-await sos.management.power.systemReboot(); // Returns void
-```
-
-:::note[GitHub Example]
-[Management System Reboot](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/system-reboot/)
-:::
-
-## appRestart()
-Method `appRestart()` will restart the application on a targeted device.
-
-```javascript
-await sos.management.power.appRestart(); // Returns void
-```
-
-## setTimer() 
-Method `setTimer()` will set the time of the timer.
-
-
-|      Param     | Type                   | Required |Description                   |
-| -------------- | ----------------------| :-------: | ---------------------------- |
-| `type`     | TimerType                 | <div class="red">Yes</div> | 7 slots for your timers |
-|^^|^^|^^| `TIMER_1`, `TIMER_2`, `TIMER_3`, `TIMER_4`, `TIMER_5`, `TIMER_6`, `TIMER_7` |
-| `timeOn`     | String or null                  | <div class="red">Yes</div> | When the device/display should be turned on  |
-|^^|^^|^^| `00:00:00` - `23:59:00` |
-| `timeOff`     | String or null               | <div class="red">Yes</div> | When the device/display should be turned off |
-|^^|^^|^^| `00:00:00` - `23:59:00` |
-| `weekdays`     | TimerWeekday[]                  | <div class="red">Yes</div> | Weekdays when timer is applied |
-|^^|^^|^^| `sun`, `mon`, `tue`, `wed`, `thu`, `fri`, `sat` |
-| `volume`     | Number                   | <div class="red">Yes</div> | Volume level set when the device/display is turned on |
-|^^|^^|^^| `0` - `100` 
-
-### Javascript example
-```javascript
-await sos.management.power.setTimer("TIMER_1", "09:00:00", "23:00:05", ["mon"], 10);
-```
-
-## unsetTimer() 
-Method `unsetTimer()` will remove the timer.
-
-
-|      Param     | Type                   | Required |Description                   |
-| -------------- | ----------------------| :-------: | ---------------------------- |
-| `type`     | TimerType                 | <div class="red">Yes</div> | 7 slots for your timers |
-|^^|^^|^^| `TIMER_1`, `TIMER_2`, `TIMER_3`, `TIMER_4`, `TIMER_5`, `TIMER_6`, `TIMER_7` 
-
-### Javascript example
-```javascript
-await sos.management.power.unsetTimer("TIMER_1");
-```
-
-## getTimers() 
-Method `getTimer()` will return all currently set timers.
-
-### Javascript example
-```javascript
-const timers = await sos.management.power.getTimers();
-```
-
-### Example of response
-```json
-[
-    {
-        "type": "TIMER_1",
-        "timeOn": "05:00:00",
-        "timeOff": "15:00:00",
-        "weekdays": ["mon", "sun"],
-        "volume": 29
-    },
-    {
-        "type": "TIMER_3",
-        "timeOn": "08:00:00",
-        "timeOff": "19:00:00",
-        "weekdays": ["fri", "sat"],
-        "volume": 85
-    },
-]
-```
-
-## setProprietaryTimer()
-Method `setProprietaryTimer()` will set the time of the proprietary timer.
-
-
-|      Param     | Type                   | Required |Description                   |
-| -------------- | ----------------------| :-------: | ---------------------------- |
-| `type`     | TimerType                 | <div class="red">Yes</div> | Slots for your timers in format `TIMER_${number}` |
-|^^|^^|^^| `TIMER_1`, `TIMER_2`, `TIMER_3`, `TIMER_4`, `TIMER_5`, `TIMER_6`, `TIMER_XX` |
-| `timeOn`     | String or null                  | <div class="red">Yes</div> | When the display/screen should be turned on  |
-|^^|^^|^^| `00:00:00` - `23:59:00` |
-| `timeOff`     | String or null               | <div class="red">Yes</div> | When the display/screen should be turned off |
-|^^|^^|^^| `00:00:00` - `23:59:00` |
-| `weekdays`     | TimerWeekday[]                  | <div class="red">Yes</div> | Weekdays when timer is applied |
-|^^|^^|^^| `sun`, `mon`, `tue`, `wed`, `thu`, `fri`, `sat` 
-
-### Javascript example
-```javascript
-await sos.management.power.setProprietaryTimer("TIMER_105", "09:00:00", "23:00:05", ["mon"]);
-```
-
-## unsetProprietaryTimer()
-Method `unsetProprietaryTimer()` will remove the proprietary timer.
-
-
-|      Param     | Type                   | Required |Description                   |
-| -------------- | ----------------------| :-------: | ---------------------------- |
-| `type`     | TimerType                 | <div class="red">Yes</div> | Slots for your timers in format `TIMER_${number}` |
-|^^|^^|^^| `TIMER_1`, `TIMER_2`, `TIMER_3`, `TIMER_4`, `TIMER_5`, `TIMER_6`, `TIMER_XX` 
-
-### Javascript example
-```javascript
-await sos.management.power.unsetProprietaryTimer("TIMER_105");
-```
-
-## getProprietaryTimers()
-Method `getProprietaryTimers()` will return all currently set proprietary timers.
-
-### Javascript example
-```javascript
-const timers = await sos.management.power.getProprietaryTimers();
-```
-
-### Example of response
-```json
-[
-    {
-        "type": "TIMER_1",
-        "timeOn": "05:00:00",
-        "timeOff": "15:00:00",
-        "weekdays": ["mon", "sun"]
-    },
-    {
-        "type": "TIMER_105",
-        "timeOn": "08:00:00",
-        "timeOff": "19:00:00",
-        "weekdays": ["fri", "sat"]
-    },
-]
-```
-
-:::note[GitHub Example]
-[How to use timer in Applet](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/timer/)
-:::

package/docs/management/js-management-proxy.md

@@ -1,81 +0,0 @@
----
-title:  Proxy
-author: Krystof Woldrich
-date:   16.6.2022
-type:   js-management-api
-tags:
-- applet
-- applet_api
-- api
-- js_management_api
-- proxy
-description: "[Management JS API] Proxy management API enables you to manage currently connected proxy on your device."
----
-
-# Proxy
-Proxy management API enables you to manage currently connected proxy on your device.
-
-## All methods
-
-
-| Method             | Description                         | Supported since |
-| ------------------ | ----------------------------------- | --------------- |
-| `isEnabled()`      | Get proxy setting state             | 5.4             |
-| `setManual()`      | Set proxy using provides parameters | 5.4             |
-| `disable()`        | Disable proxy                       | 5.4             |
-| `getConnectedTo()` | Get connected proxy uri             | 5.4             
-
-## isEnabled()
-Method `isEnabled()` returns the current state of a proxy on your device.
-
-### Javascript example
-```javascript
-sos.management.proxy.isEnabled().then((isEnabled) => {
-    console.log(isEnabled);
-});
-```
-
-## setManual()
-Method `setManual()` lets you set proxy settings on your device.
-
-
-| Param          | Type   | Required                   | Value             | Description              |
-| -------------- | -------| :------------------------: | ----------------- | ------------------------ |
-| `uri`          | String | <div class="red">Yes</div> |  `178.62.193.192` | URI of the proxy server  |
-| `port`         | Number | <div class="red">No</div>  |  `0` - `65353`    | Port number              |
-| `username`     | String | <div class="red">No</div>  |  `johndoe`        | Username                 |
-| `password`     | String | <div class="red">No</div>  |  `superpass`      | Password                 
-
-### Javascript example
-```javascript
-sos.management.proxy.setManual(
-	'178.62.193.192',
-	1080,
-	'username',
-	'password'
-).then(() => {
-    console.log('Proxy successfully set.');
-});
-```
-
-## disable()
-Method `disable()` lets you disable current active proxy setting on your device.
-
-### Javascript example
-```javascript
-sos.management.proxy.disable().then(() => {
-    console.log('Proxy successfully disabled.');
-});
-```
-
-## getConnectedTo()
-Method `getConnectedTo()` returns the current connected proxy server uri on your device.
-
-### Javascript example
-```javascript
-sos.management.proxy.getConnectedTo().then((uri) => {
-    console.log(uri); //178.62.193.192
-});
-```
-
-

package/docs/management/js-management-remote-control.md

@@ -1,58 +0,0 @@
----
-title:  IR Remote control
-author: Miroslav Behina
-date:   1.4.2018
-type:   js-management-api
-tags:
-- applet
-- applet_api
-- api
-- js_management_api
-description: "[Management JS API] Remote control API allows you to enable, disable and check status of remote control of your device."
----
-
-# IR Remote control
-Remote control API allows you to enable, disable and check status of remote control of your device.
-
-## All methods
-
-| Method | Description | Supported since |
-| ------ | ------ | :-------------: |
-| `enable()` | Enables IR Remote control allows you to operate the device with IR Remote control (available alias `unlock()`) | 3.0.0 |
-| `disable()` | Disables IR Remote control allows you to operate the device with IR Remote control (available alias `lock()`) | 3.0.0 |
-| `isEnabled()` | Check is the IR Remote control is enabled or not (available alias `isLocked()`) | 3.0.0 |
-
-## enable()
-Method `enable()` allows for a simple on state of remote control on your device.
-
-:::danger
-**Android Devices Attention Required:**
-In order to prevent Android from displaying 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.
-:::
-
-```javascript
-await sos.management.remoteControl.enable(); // Returns void
-// or await sos.management.remoteControl.unlock();
-```
-
-:::note[GitHub Example]
-[Enable remote control on device](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/remote/)
-:::
-
-## disable() 
-Method `disable()` allows for a simple off state of remote control on your device.
-
-```javascript
-await sos.management.remoteControl.disable(); // Returns void
-// or await sos.management.remoteControl.lock();
-```
-
-## isEnabled() 
-Method `isEnabled()` allows to check whether the remote control is turned on or off.
-
-```javascript
-await sos.management.remoteControl.isEnabled(); // Returns boolean
-// or await sos.management.remoteControl.isLocked();
-```

package/docs/management/js-management-screen.md

@@ -1,225 +0,0 @@
----
-title:  Screen
-author: Miroslav Behina
-date:   1.4.2018
-type:   js-management-api
-tags:
-- applet
-- applet_api
-- api
-- js_management_api
-description: "[Management JS API] Management API screen allows for manipulation with screen resolution, orientation, content, set displays brightness, retrieve current brightness of your display and manipulate with the power mode. It enables you to turn display on, off and check whether the display is on/off."
----
-
-# Screen
-Management API screen allows for manipulation with screen resolution, orientation, content, set displays brightness, retrieve current brightness of your display and manipulate with the power mode. It enables you to turn display on, off and check whether the display is on/off.
-
-:::warning
-This method turns on/off only display/backlight. It will **not** set any power-safe mode. We strongly recommend to
-reboot 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,...)
-- `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.
-:::
-
-
-## All methods
-
-| Method  | Description | Supported since |
-| ------ | ------ | :-------------: |
-| `resize()` | Set screen settings like resolution, orientation and video orientation | 3.0.0 |
-| `getOrientation()` | Get screen orientation | 4.7.0 |
-| `setBrightness()` | Set screen brightness | 3.0.0 |
-| `getBrightness()` | Get current brightness value | 3.0.0 |
-| `powerOn()` | Turn `ON` the display (only the display) | 3.0.0 |
-| `powerOff()` | Turn `OFF` the display (only the display, except Android devices where it turns off the webview as well) | 3.0.0 |
-| `isPoweredOn()` | Check the display status | 3.0.0 |
-| `takeAndUploadScreenshot()` | Takes screenshot from the device and upload it to server | 3.0.0 |
-
-## resize()
-Method `resize()` helps you manipulate with several aspects of your displays screen settings.
-
-|      Param     |Type               | Required | Description                   |
-| -------------- | -------------------| :----------: | -------------------- |
-| `baseUrl`     | String               | <div class="red">Yes</div> | SSSP & Tizen devices  requires to install a orientation-specific Core App if you want to switch orientation to portrait or landscape. |
-|^^|^^|^^| `https://cdn.your-cms.com/tizen/1.0.4` |
-| `orientation`     | Orientation               | <div class="red">Yes</div> | Screen orientation  |
-|^^|^^|^^| `PORTRAIT`, `LANDSCAPE`, `PORTRAIT_FLIPED`, `LANDSCAPE_FLIPPED`, `AUTO` |
-| `resolution`     | Resolution                  | <div class="red">Yes</div> | Where it applies (mainly SSSP 2/3) |
-|^^|^^|^^| `FULL_HD`, `HD_READY` |
-| `currentVersion`     | String                  | <div class="red">Yes</div> |  Core App version |
-|^^|^^|^^| `1.0.4` |
-| `videoOrientation`     | VideoOrientation       | <div class="red">Yes</div> | If the video has different orientation than the HTML5 content |
-|^^|^^|^^| `LANDSCAPE`, `PORTRAIT` 
-
-:::info
-For Tizen, you have to provide `baseUrl` which points to your server where you uploaded previously built Core App for Tizen with your buiult-in Applet. [Read more how to upload your Core Apps here.](https://docs.signageos.io/hc/en-us/articles/4405245195666).
-:::
-
-### Javascript example
-```javascript
-// for Tizen
-await sos.management.screen.resize(
-    "https://cdn.your-cms.com/tizen/1.0.4",
-    "PORTRAIT",
-    "FULL_READY",
-    "1.0.4"
-);
-
-//for all other supported device
-await sos.management.screen.resize(
-    "",
-    "PORTRAIT",
-    "HD_READY",
-    ""
-);
-```
-
-:::note[GitHub Example]
-[How to resize screen on device](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/resize/)
-:::
-
-
-## getOrientation()
-Method `getOrientation()` lets you check current orientation of the screen. Possible values are listed in the table above.
-
-### Javascript example
-```javascript
-await sos.management.screen.getOrientation();
-```
-
-## setBrightness()
-Function `setBrightness()` lets you control the power of brightness emmited by your device and even set different brightness during the day.
-
-
-|      Param     |Type                  | Required | Description                   |
-| -------------- | ---------------------| :--------: | --------------------- |
-| `timeFrom1`     | String                | <div class="red">Yes</div> | Day time since `brightness1` value will be applied (eg. 06:00, 24hour values) |
-|^^|^^|^^| Example: `00:00` - `23:59` |
-| `brightness1`     | Number               | <div class="red">Yes</div> | Brightness level `0-100`  |
-|^^|^^|^^| Example: `0` - `100` |
-| `timeFrom2`     | String                 | <div class="red">Yes</div> | Day time since `brightness2` value will be applied (eg. 22:00, 24hour values) |
-|^^|^^|^^| Example: `00:00` - `23:59` |
-| `brightness2`     | Number                | <div class="red">Yes</div> | Brightness level `0-100` |
-|^^|^^|^^| Example: `0` - `100` 
-
-### Javascript example
-```javascript
-await sos.management.screen.setBrightness(
-    '00:00',
-    '10',
-    '17:00',
-    '30'
-);
-```
-
-:::note[GitHub Example]
-[How change brightness on device](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/brightness/)
-:::
-
-## getBrightness()
-Method `getBrightness()` lets you check the power of brightness emitted by your device.
-
-### Javascript example
-```javascript
-await sos.management.screen.getBrightness();
-```
-
-### Example of response
-```json
-{
-	"timeFrom1": "06:00:00",
-	"brightness1": 80,
-	"timeFrom2": "22:00:00",
-	"brightness2": 40
-}
-```
-
-## powerOn()
-Method `powerOn()` turns on the targeted display.
-
-```javascript
-await sos.management.screen.powerOn(); // Returns void
-```
-
-:::note[GitHub Example]
-[Management Display](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/display/)
-:::
-
-## powerOff()
-Method `powerOff()` turns off the targeted display.
-
-:::warning
-On Android devices, `powerOff()` also shuts down the webview and the Applet. It's 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.
-:::
-
-```javascript
-await sos.management.screen.powerOff(); // Returns void
-```
-
-## isPoweredOn() 
-Method `isPoweredOn()` lets you check whether the display is turned on or off.
-
-```javascript
-await sos.management.screen.isPoweredOn(); // Returns boolean
-```
-
-## takeAndUploadScreenshot()
-Method `takeAndUploadScreenshot()` will upload a screenshot directly to the device.
-
-
-|      Param     |Type                           | Required | Description                   |
-| -------------- | ----------------------------- | :------: | ---------------------- |
-| `uploadBaseUrl`  | String                     | <div class="red">Yes</div>| Location of your Upload server for screenshots |
-|^^|^^|^^| Example: `https://upload-screenshot.your-cms.com` 
-
-### Javascript example
-```javascript
-await sos.management.screen.takeAndUploadScreenshot(
-    'https://upload-screenshot.your-cms.com'
-);
-```
-
-:::note[GitHub Example]
-[Management Screenshot Upload](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/screenshot-upload)
-:::
-
-<br/>
-
-:::warning
-Open users (who is using screenshot capturing on device using JS API) have to run their own server for uploading screenshots. It differs for every platform! So it's not easy to achieve the unified output (screenshots url upload).  
-There are 2 options how to manage this:  
-   
-**Option 1.**   
-Specify the signageOS upload URL which is available for every our partner. However it's not granted SLA on this server for open users. The URL is https://upload.signageos.io  
-
-Cons:
-- internet required (no local instances in local networks).
-- SLA is not granted, dependency on signageos infrastructure for open users.  
-
-Pros:
-- it's easy to use
-- zero configuration, zero programming work needed  
-
-**Option 2.**  
-There is available standalone server for uploading screenshots with all available methods of uploading for every platform (Tizen, Webos, Linux etc.). It's created in node.js and open users have to host it on the own infrastructure.  
-
-Cons:  
-- The screenshot traffic needed to be paid/covered.
-- The upload server needs to be configured and managed by our customer who is running it.  
-
-Pros:
-- it's signageOS independent
-- it can be run in local, close networks without internet access (or firewalls)
-- zero programming work and cost needed  
-
-**The standalone server is available on request via the support ticketing system: [create new support ticket](https://docs.signageos.io/tickets/create)**  
-:::

package/docs/management/js-management-security.md

@@ -1,71 +0,0 @@
----
-title:  Security
-author: Michael Zabka
-date:   20.5.2020
-type:   js-management-api
-tags:
-- applet
-- applet_api
-- api
-- js_management_api
-- security
-description: "[Management JS API] Security management API allows you to manually set PIN code interfaces or get current PIN code."
----
-
-# Security
-Security management API allows you to manually set PIN code interfaces or get current PIN code.
-
-## All methods
-
-
-| Methods  | Description | Supported since |
-| ------ | -------- | :-------------: |
-| `getPinCode()` | Get PIN code, 4 digits number string | 4.1 |
-| `setPinCode()` | Set PIN code, 4 digits number string | 4.1 |
-| `generateRandomPinCode()` | Generate 4 digits number string and set it as PIN code | 4.1 
-
-## getPinCode()
-Method `getPinCode()` will returns current PIN code, 4 digits number string.
-
-```javascript
-await sos.management.security.getPinCode(); // Returns e.g. "1234"
-```
-
-## setPinCode()
-Method `setPinCode()` will set the current PIN code, 4 digits number string.
-PIN code `0000` is not allowed according to the default PIN after boot when the device is not connected to the internet!
-
-
-| Param    | Type   | Required | Description                                                                                              |
-| -------- | ------ | :----------: | ---------------------------------------------------------------------------------------------- |
-| `pinCode`     | String | <div class="red">Yes</div> | Set new PIN code 
-
-### Javascript example
-```javascript
-await sos.management.security.setPinCode("9999");
-```
-
-:::note[GitHub Example]
-[Management Security PIN code](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/security-pin-code/)
-:::
-
-
-## generateRandomPinCode()
-Method `generateRandomPinCode()` will generate random 4 digits number string and set it as current PIN code.
-
-### Javascript example
-```javascript
-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);
-```
-
-## Errors
-Although we are doing our best, following errors may occur when working with the Applet Resources.
-
-
-| Code | Type | Message |
-| ---- | ---- | ------- |
-| 41701 | AppletSecurityError | Invalid PIN code (has to be 4 digits string) |
-| 41702 | AppletSecurityError | Not allowed PIN code 0000, use another pin code |
-| 41703 | AppletSecurityError | Get PIN code failed because was not set yet. Try to get PIN code later or set the PIN code using `setPinCode` method first.