@signageos/front-applet 6.5.1 → 6.5.3

package/CHANGELOG.md

@@ -4,6 +4,16 @@ 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.3] - 2024-04-30
+### Fixed
+- Documentation patch: Browser.open() is supported on BrightSign
+- Documentation patch: improved iFrames snippet intro text to be less scary
+- Documentation patch: Added platform-specific details for using streaming on BrightSign and Samsung
+
+## [6.5.2]
+### Added
+- Support for the `rtscts` option for the serial port configuration. This option is used when opening a serial port and determines whether to enable or disable RTS/CTS handshaking.
+
 ## [6.5.1] - 2024-04-08
 ### Fixed
 - Incompatibility with latest changes in MDC implementation

package/docs/content/js-browser.md

@@ -33,7 +33,8 @@ Default URL can be opened and even the whitelisting/blacklisting of certain doma
 **With some limitation you can use this API also on**
 - Samsung Tizen (SSSP 4 and above); where the website is just in fullscreen without an address bar or theme options (headless mode)
 - LG webOS (webOS 3.0 and above); where the website is just in fullscreen without an address bar or theme options (headless mode)
-- Raspberry Pi and NEC Compute Module; where the website is just in fullscreen without an address bar or theme options (headless mode)
+- Linux (Fedora, Ubuntu), Raspberry Pi, NEC Compute Module; where the website is just in fullscreen without an address bar or theme options (headless mode)
+- BrightSign; where the website is just in fullscreen without an address bar or theme options (headless mode)
 :::
 
 ### Javascript

package/docs/content/js-iframes.md

@@ -13,7 +13,7 @@ description: "[Content JS API] We **do not recommend** to use iframes inside you
 ---
 
 # Iframes
-We **do not recommend** to use iframes inside your Applet. However, if you have to use it, you can add full support of the sOS JS API to every one of your iframe. Just add the JS snippet script below to every page load in iframe before ending </body>. Everything will be prepared, and you can call the very same methods as described for Applet.
+We **recommend limiting the use of iframes** inside your Applet to avoid performance hiccups. However, if you you are leveraging iframes, you can also add full support of the sOS JS API within the iframe context. Add the JS snippet script below to every page load in iframe before ending </body>. Everything will be prepared, and you can call the very same methods as described for Applet.
 
 :::warning
 The signageOS Snippet and API works **ONLY** if the iframe is served from the display's internal storage - `<iframe src="file://...`. If your iframe is served from a live URL - `<iframe src="https://your-iframe-url"...` the snippet and signageOS API will **NOT** work. This is a security limitation to prevent random site took advantage of the API and alter the display behavior. There is a simple way to [save and load your iframe from the internal storage](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/iframes). Just make sure you are using full paths in your iframe for linking javascripts and css instead of the relative ones.

package/docs/content/js-serial.md

@@ -30,7 +30,7 @@ Such hardware could be, for example, printers, payment terminals or sensors.
 
 | Method             | Description            | Supported since |
 | ------------------ | ---------------------- | :-------------: |
-| `openSerialPort()` | Open a new serial port | 4.4.0           
+| `openSerialPort()` | Open a new serial port | 4.4.0
 
 ## openSerialPort()
 
@@ -39,10 +39,20 @@ Creates a new instance of serial port. You can then use that instance to handle
 
 | Param     | Type   | Required                   | Description                                        |
 | --------- | ------ | :------------------------: | -------------------------------------------------- |
-| `options` | Object | <div class="red">Yes</div> | Object containing configuration of the serial port 
+| `options` | Object | <div class="red">Yes</div> | Object containing configuration of the serial port
 
 ### Options
 
+| Property | Type | Required | Description |
+| -------- | ------ | -------- | -------- |
+| `device` | String | No | Specifies the device address |
+| `baudRate` | Number | Yes | Specifies the data transmission speed in bits per second |
+| `parity` | **none**, **even**, **mark** or **space** | No | Specifies the form of error checking, whether (or what) extra bits are added to a byte |
+| `databits` | Number | No | Specifies the number of bits in a byte |
+| `stopbits` | Number | No | Specifies the number of bits used to signal the end of a communication packet |
+| `rtscts` | Boolean | No | Enables or disables RTS/CTS handshaking over the serial port. Currently supported by selected models of BrightSign |
+:::
+
 Here is the options object defined as Typescript interface:
 
 ```typescript
@@ -52,6 +62,7 @@ interface ISerialPortOptions {
     parity?: 'none' | 'even' | 'mark' | 'odd' | 'space';
     databits?: number;
     stopbits?: number;
+    rtscts?: boolean;
 }
 ```
 
@@ -78,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`, `1`, `USB:A/0`
 
 ## Serial port methods
 
@@ -90,7 +101,7 @@ you can call following methods on it.
 | ---------- | ----------------------------------------------------------- | :-------------: |
 | `onData()` | Call a listener callback anytime the opened serial port receiving data. | 4.4.0           |
 | `write()`  | Write data to the serial port                               | 4.4.0           |
-| `close()`  | Close serial port                                           | 4.4.0           
+| `close()`  | Close serial port                                           | 4.4.0
 
 ## onData()
 
@@ -151,4 +162,4 @@ Following errors may occur when working with the serial ports. However they don'
 | 50603 | InternalHardwareError | Closing serial port that isn't open       |
 | 50603 | InternalHardwareError | Failed to close serial port               |
 | 50604 | InternalHardwareError | Writing to a serial port that isn't open |
-| 50604 | InternalHardwareError | Failed to write to serial port            
+| 50604 | InternalHardwareError | Failed to write to serial port

package/docs/content/js-video-stream.md

@@ -154,8 +154,6 @@ document.documentElement.clientHeight as setup parameters.
 | `autoReconnectInterval` | Number  | <div class="yellow">No</div> | Interval in miliseconds between reconnect attempts  |
 | ^^                      | ^^      |              ^^              | Default value: 30000 ms                             |
 | `volume`                | Number  | <div class="yellow">No</div> | Volume of the stream                                |
-| `trackSelection`        | Object  | <div class="yellow">No</div> | Track selection options                             |
-| `drm`                   | Object  | <div class="yellow">No</div> | DRM options                                         |
 
 ### Javascript syntax
 
@@ -580,3 +578,41 @@ Although we are doing our best, following errors may occur when working with the
 | 51303 | InternalStreamError | Couldn't get stream tracks.                          |
 | 51304 | InternalStreamError | Couldn't select stream track.                        |
 | 51305 | InternalStreamError | Couldn't reset stream track.                         |
+
+## Platform-specific notes
+
+### BrightSign
+
+BrightSign allows the configuration of [buffering](https://support.brightsign.biz/hc/en-us/articles/218067097-Customizing-the-size-of-the-streaming-buffer), [latency and jitter](https://support.brightsign.biz/hc/en-us/articles/218067127-Modifying-the-latency-and-jitter-of-audio-video-streams) by adding additional query parameters to stream `uri`.
+
+#### Buffering
+
+You can modify the default buffer size by appending optional parameters to the end of a streaming URL in a BrightAuthor Video Stream or Audio Stream state (this method also applies to custom scripts). The URL parameters must be formatted as follows:
+
+```
+<streaming_url>?buffersize=<number>&vcdbsize=<number>&acdbsize=<number>
+```
+
+Example: `http://www.example.com/stream1?buffersize=10000000&vcdbsize=10000000&acdbsize=256000`
+
+Note that all buffer sizes are specified in bytes.
+
+buffersize: The size of the main buffer. Once streaming data comes into the main buffer, it is immediately split into the audio and video buffers. The default size of the main buffer is 1.5MB for HD models, 3MB for XD models, and 6MB for 4K models.
+vcdbsize: The size of the video-coded data buffer. The default size of this buffer is 3MB for HD models, 3MB for XD models, and 6MB for 4K models.
+acdbsize: The size of the audio-coded data buffer.  The default size of this buffer is 256KB for all models.
+
+#### Latency and Jitter
+
+You can modify the amount of time it takes for audio/video streams to begin playback by formatting the stream URL as follows: 
+
+```
+<streaming_url>?latency=<value_in_ms>&jitter=<value_in_ms>
+```
+
+Example: `http://www.example.com/stream1?latency=-450&jitter=50`
+
+### Samsung
+
+UDP and RTP streams are only available if you use specific version of signageOS Tizen CoreApp.
+
+Details are documented in Docs: [[Tizen] Stream playback issues & limitation](https://docs.signageos.io/hc/en-us/articles/4405387373458--Tizen-Stream-playback-issues-limitation)

package/es6/FrontApplet/Hardware/ISerialPortOptions.d.ts

@@ -11,5 +11,6 @@ interface ISerialPortOptions {
     parity?: Parity;
     databits?: number;
     stopbits?: number;
+    rtscts?: boolean;
 }
 export default ISerialPortOptions;

package/package.json

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