@signageos/front-applet 6.5.3 → 6.5.5

package/CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [6.5.5] - 2024-05-24
+### Fixed
+- Documentation patch: Addind Applet Dispatch Throttling information 
+
+## [6.5.4] - 2024-05-15
+### Fixed
+- Better description of the serial port options on BrightSign
+- Documentation patch: New section in Applet Basics for the sos.authHash used as unique device identification from Applet
+
 ## [6.5.3] - 2024-04-30
 ### Fixed
 - Documentation patch: Browser.open() is supported on BrightSign

package/docs/applet-basics.md

@@ -26,6 +26,7 @@ This thread contains basic methods of every Applet used to load necessary config
 | `appletVersion`  | Returns current Applet version | JS API `4.5.0`, Front-display `7.8.0`|
 | `config` object  | Returns object with key-values set via Timing or as a bundled config| JS API `1.5.0`, Front-display `6.8.0`|
 | `config` object  | Returns object with key-values set via Timing or as a bundled config| `1.0.0`|
+| `authHash` token  | Returns string with unique device identifier | `1.0.0`|
 | `capabilities`  | Enum of device-specific capabilities and features | `1.0.0`
 
 ## Starting Applet
@@ -176,9 +177,33 @@ console.log(sos.config.imgUrl);
 ```
 
 :::note[Guide]
-[Custom variables in Applet](https://docs.signageos.io/hc/en-us/articles/4405238989458)
+[Custom variables in Applet](https://developers.signageos.io/docs/devspace-extras/env-variables-configuration)
 
-How to pass custom variables and cofiguration to your Applet
+How to pass custom variables and configuration to your Applet.
+:::
+
+## The authHash for unique device identification
+
+The `sos.authHash` is an alternative device identifier 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.
+1. The `authHash` is unique and can be revoked upon request.
+1. The `authHash` can be used as a universal identifier for your Applet application.
+
+The `authHash` can be retrieved from the JS SDK API - it's available as `sos.authHash`. 
+
+```javascript
+async function startApplet() {
+			await sos.onReady();
+      console.log(sos.authHash);
+}
+window.addEventListener('sos.loaded', startApplet);
+```
+
+:::note[Guide]
+[Using authHash for device identification](https://developers.signageos.io/docs/devspace-extras/sos-authhash-device-pairing.md)
+
+How to get `authHash` and use it in the REST API for device identification.
 :::
 
 ## Applet JS API version

package/docs/content/js-command.md

@@ -28,6 +28,10 @@ All commands will be available in [Applet Command REST API](https://developers.s
 
 Dispatch() is used for sending your custom logs or data from device to signageOS.
 
+:::warning[Throttling in place]
+The maximum allowed frequency for dispatching commands is 30 commands per 30 seconds. Any commands sent that exceed this frequency will be discarded.
+:::
+
 ### Parameters
 
 |   Parameter    | Type | Required |  Description  |

package/docs/content/js-serial.md

@@ -89,7 +89,7 @@ Device address is different per platform (at least for now). Kindly find the res
 | Windows | `COM3` | `COM3` (typically, but check your Win machine if this does not work) |
 | Samsung Kiosk | `PORT1` |`PORT1`, `PORT2`, `PORT3` |
 | Android | `/dev/ttyusb0` | `/dev/ttyusb0` |
-| BrightSign | `0` | `0`, `1`, `USB:A/0`
+| BrightSign | `0` | `0` (Serial jack /dev/ttyS0), `1` (GPIO port /dev/ttyS1), `USB:A/0` (USB-to-serial /dev/ttyUSB0) |
 
 ## Serial port methods
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signageos/front-applet",
-  "version": "6.5.3",
+  "version": "6.5.5",
   "main": "dist/bundle.js",
   "types": "es6/bundle.d.ts",
   "files": [