@signageos/front-applet 7.1.1 → 8.0.0

package/docs/content/js-offline-cache-simple-data.md

@@ -1,129 +0,0 @@
----
-title:  Offline Cache for storing data
-author: Miroslav Behina
-date:   22.11.2018
-type:   js-api
-tags:
-- applet
-- applet_api
-- api
-- js_api
-description: "[Content JS API] This API provides you with approach similar to the HTML5's Local Storage, but implemented internally via native device API and completely device agnostic."
----
-
-# Offline Cache for storing simple data
-
-Use when you need to save some data into local memory. 
-This API provides you with approach similar to the HTML5's Local Storage, but implemented internally via native device API and completely device agnostic. 
-We do not recommend using a different storage type then Offline Cache or full featured [File System API](js-file-system) that will provide you with more low-level methods.
-
-## All methods
-
-| Method | Description | Supported Since |
-| ------ | -------- | :--------: |
-| `loadContent()` | Loads content from internal storage | 1.0.3 |
-| `saveContent()` | Saves content to internal storage | 1.0.3 |
-| `listContents()` | List all content items saved previously to internal storage | 2.0.0 |
-| `deleteContent()` | Delete content item previously saved to internal storage	 | 2.0.0 |
-
-:::warning
-Emulator has certain limitations while handling offline files. [Read more here](https://docs.signageos.io/hc/en-us/articles/4405238997138)
-:::
-
-## loadContent()
-Method `loadContent()` loads content from internal storage.
-
-### Parameters
-
-|      Param     | Type   | Required | Description  |
-| -------------- | ------ | :-------: | ----------- |
-| `uid` | string | <div class="red">Yes</div> | Unique file identifier is used for later file retrieval, must contain a-z,A-Z,0-9 and . characters |             				  
-
-### Javascript example
-```javascript
-await sos.offline.cache.saveContent('ApplicationSecret', '123SuperSecretHash');
-```
-
-## saveContent()
-Method for saving content into internal storage. 
-
-### Parameters
-
-|      Param     | Type   | Required | Description  |
-| -------------- | ------ | :-------: | ----------- |
-| `uid` | string | <div class="red">Yes</div> | Unique file identifier is used for later file retrieval, must contain a-z,A-Z,0-9 and . characters |
-| `content` | string | <div class="red">Yes</div> | Only string variables enabled. For JSON values use `JSON.Stringify()`               				  
-
-### Javascript Example
-```javascript
-sos.offline.cache.saveContent('ApplicationSecret', '123SuperSecretHash')
-.then(() => {
-    //Content was successfully saved, retrieve it. 
-    return sos.offline.cache.loadContent('ApplicationSecret');
-})
-.then((content) => {
-    console.log('Loaded', content); // print 123SuperSecretHash
-})
-```
-
-## listContents()
-List all content items saved previously to internal storage
-
-### Javascript example
-```javascript
-await sos.offline.cache.listContents();
-```
-
-## deleteContent()
-Delete content item previously saved to internal storage.
-
-### Parameters
-
-|      Param     | Type   | Required | Description  |
-| -------------- | ------ | :-------: | ----------- |
-| `uid` | string | <div class="red">Yes</div> | Unique file identifier is used for later file retrieval, must contain a-z,A-Z,0-9 and . characters |             				  
-
-### Javascript example
-```javascript
-//Store
-sos.offline.cache.saveContent('ApplicationSecret', '123SuperSecretHash')
-.then(() => {
-    //Content was successfully saved, retrieve it. 
-    return sos.offline.cache.loadContent('ApplicationSecret');
-})
-.then((content) => {
-    console.log('Loaded', content); // print 123SuperSecretHash
- 
-    // Let's delete the content now
-    return sos.offline.cache.deleteContent('ApplicationSecret')
-})
-.then(() => {
-    console.log("Deleted");
-})
-.catch((error) => { console.error(error); });
-```
-
-## Usage with Typescript
-You can also use all these methods with [signageOS TypeScript](https://docs.signageos.io/hc/en-us/articles/4405069154962#signageos-typescript).
-
-```typescript
-loadContent(uid: string): Promise<string>;
-saveContent(uid: string, content: string): Promise<void>;
-
-listContents(): Promise<string[]>;
-deleteContent(uid: string): Promise<void>;
-```
-
-## Errors
-Although we are doing our best, following errors may occur when working with the offline cache.
-
-
-| Code | Type | Message |
-| ---- | ---- | ------- |
-| 41001 | AppletNativeCacheError | Already saving the file with UID: ```uid``` |
-| 51001 | InternalNativeCacheError | Couldn't not read the files from the offline cache. |
-| 51001 | InternalNativeCacheError | Couldn\'t load the file from offline cache. |
-| 51001 | InternalNativeCacheError | Couldn\'t load the file before deleting it. |
-| 51002 | InternalNativeCacheError | Couldn\'t save the file to the offline cache. |
-| 51003 | InternalNativeCacheError | File wasn\'t deleted correctly. |
-| 40901 | AppletOfflineCacheError | Uid contains invalid characters, allowed: $$ALLOWED_CHARS$$, got $$ACTUAL_UID$$ 

package/docs/content/js-osd.md

@@ -1,32 +0,0 @@
----
-title:  OSD
-author: Patrik Bily
-date:   24.10.2022
-type:   js-api
-tags:
-- applet
-- applet_api
-- api
-- osd
-- js_api
-description: "[Content JS API] OSD API allows you to open OSD."
----
-
-# OSD
-
-OSD API allows you to open OSD for initial setup with applet.
-
-## All methods
-
-| Method             | Description            | Supported since |
-| ------------------ | ---------------------- | :-------------: |
-| `showOSD()` |Open OSD on the display | 5.5.0 |
-
-## showOSD()
-
-This method allow you to open OSD through the JS API without typing the pin.
-
-### Javascript example
-```javascript
-await sos.osd.showOSD();
-```

package/docs/content/js-proof-of-play.md

@@ -1,60 +0,0 @@
----
-title: Proof of Play
-author: Robert Pecha
-date:  31.01.2023
-type: js-api
-tags:
-- applet
-- applet_api
-- api
-- js_api
-description: "[Content JS API] You can use our Prooof of Play mechanism to log that some content was played on end device successfully or not. Our system includes important metadata about applet and device out-of-box to simplify solution of issues with content. You can use SignageOS to analyze, if, where, when and how long proposed content was playing in front of audience."
----
-
-## All methods
-
-| Methods | Description | Supported since |
-| ----------- | ------------ | -----------|
-| `recordItemPlayed()` | Log that content was played successfully | 5.5.1 |
-
-## recordItemPlayed()
-
-Send provided information about played content along with additional metadata about current applet and device to SignageOS.
-
-### Parameters
-
-
-| Param     | Type   | Required                   | Description                                        |
-| --------- | ------ | :------------------------: | -------------------------------------------------- |
-| `options` | Object | <div class="red">Yes</div> | Object containing information about played content 
-
-### Options
-
-Here is the options object defined as Typescript interface:
-
-```typescript
-interface IRecordItemOptions {
-  name: string;
-  customId?: string;
-  type?: 'video' | 'image' | 'html' | 'custom';
-  tags?: string[];
-  fileName?: string;
-  playbackSuccess?: boolean;
-  errorMessage?: string;
-}
-```
-
-### Javascript example
-```javascript
-
-await sos.proofOfPlay.recordItemPlayed({
-  name: 'tesla-commercial-ad-christmas-campaign',
-  customId: 'dBE43bFB3312VFfvd34bgGHJVV334cd2',
-  type: 'video',
-  tags: ['tesla', 'christmas'],
-  fileName: 'tesla.mp4',
-  playbackSuccess: false,
-  errorMessage: 'Unsupported framerate 60fps',
-});
-
-```

package/docs/content/js-sensors.md

@@ -1,70 +0,0 @@
----
-title:  Sensors
-author: Michal Artazov
-date:   28.9.2020
-type:   js-api
-tags:
-- applet
-- applet_api
-- api
-- js_api
-- sensors
-description: "[Content JS API] We don't directly provide any sensors API but we provide a set of tools to implement your own integration of the hardware that you want to use."
----
-
-# Sensors
-
-We don't directly provide any sensors API but we provide a set of tools to implement your own integration of
-the hardware that you want to use.
-
-## Sensors interfaces
-
-We provide a set of interfaces, that any integration should implement.
-If every implementation implements the same set of interfaces, it's easy to swap it for a different implementation.
-It also requires less code to be written to use various types of hardware.
-If possible, you should always implement these interfaces.
-
-:::info
-Right now, the list of interfaces is very short. We will be adding more types soon.
-If there's any particular type of interfaces you'd like, kindly let us know.
-:::
-
-### Button
-
-A regular button, that can be pressed or released.
-
-```typescript
-interface IButton {
-    isPressed(): Promise<boolean>;
-    on(event: 'pressed' | 'released', listener: () => void): void;
-}
-```
-
-### RFID Antenna
-
-Antenna that detects presence of RFID tags. An RFID tag is simply a number.
-Whenever a tag is placed at close proximity to the antenna, it will emit a `placed` event.
-Whenever a tag is picked and is no longer detected by the antenna, it will emit a `picked` event.
-
-```typescript
-interface IRfidAntenna {
-	getPlacedTags(): Promise<number[]>;
-	on(event: 'picked' | 'placed', listener: (rfidTag: number) => void): void;
-}
-```
-
-## Ready to use integrations
-
-We already did the hard work for you and implemented some of the popular hardware. All you have to do is use it in your project.
-For more information read [this article](https://docs.signageos.io/hc/en-us/articles/4405231196946-Supported-devices-for-Sensors-usage).
-
-## Writing your own implementation
-
-Sometimes you might want to use hardware that we don't support out of the box yet.
-
-Firstly, you will need to read the documentation for the [serial API](js-serial).
-Most often, the hardware you will decide to use connects to the device via USB and internally uses a serial communication, like RS232.
-In that case you will use the serial API.
-
-You can approach this any way you like, but remember that you should always implement the [interfaces defined by us](js-sensors#sensors-interfaces).
-That will allow for greater code reusability and readability.

package/docs/content/js-serial.md

@@ -1,165 +0,0 @@
----
-title:  Serial Port
-author: Michal Artazov
-date:   25.9.2020
-type:   js-api
-tags:
-- applet
-- applet_api
-- api
-- serial
-- js_api
-description: "[Content JS API] Some platforms support connecting hardware via serial port, either directly via UART or via USB. This can be leveraged to integrate a wide variety of hardware into your digital signage application."
----
-
-# Serial
-
-Some platforms support connecting hardware via serial port, either directly via UART or via USB.
-This can be leveraged to integrate a wide variety of hardware into your digital signage application.
-
-Such hardware could be, for example, printers, payment terminals or sensors.
-
-:::warning
-* Before using this API, ensure that the display supports serial via `sos.display.supports("SERIAL")`.
-* More info [**HERE**](js-display#supports).
-* Samsung Kiosk serial connection only works over serial ports, not over USB ports
-:::
-
-## All methods
-
-
-| Method             | Description            | Supported since |
-| ------------------ | ---------------------- | :-------------: |
-| `openSerialPort()` | Open a new serial port | 4.4.0
-
-## openSerialPort()
-
-Creates a new instance of serial port. You can then use that instance to handle the communication.
-
-
-| Param     | Type   | Required                   | Description                                        |
-| --------- | ------ | :------------------------: | -------------------------------------------------- |
-| `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
-interface ISerialPortOptions {
-    device?: string;
-    baudRate: number;
-    parity?: 'none' | 'even' | 'mark' | 'odd' | 'space';
-    databits?: number;
-    stopbits?: number;
-    rtscts?: boolean;
-}
-```
-
-### Javascript example
-```javascript
-// Open default serial port based platform
-const serialPort = await sos.hardware.openSerialPort({
-    baudRate: 115200,
-});
-
-// Open specific serial port
-const serialPort = await sos.hardware.openSerialPort({
-    device: '/dev/ttyUSB0',
-    baudRate: 115200,
-});
-```
-
-:::info
-Device address is different per platform (at least for now). Kindly find the respective device address:
-
-| Device type | Default value | Other values for `device` |
-| ----------- | ---------- | ----------------- |
-| RaspberryPi / Linux | `/dev/ttyUSB0` | `/dev/ttyUSB0` |
-| 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` (Serial jack /dev/ttyS0), `1` (GPIO port /dev/ttyS1), `USB:A/0` (USB-to-serial /dev/ttyUSB0) |
-
-## Serial port methods
-
-Once you create a serial port instance using `openSerialPort()` method listed above,
-you can call following methods on it.
-
-
-| Method     | Description                                                 | Supported since |
-| ---------- | ----------------------------------------------------------- | :-------------: |
-| `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
-
-## onData()
-
-Call a listener callback anytime the opened serial port receiving data.
-The listener will stop if the serial port is closed.
-
-Since data may be either text or binary, it's emitted as [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)
-and should be processed further according to the requirements of your application.
-
-### Javascript example
-In case of binary data:
-```javascript
-// serial port instance previously created via sos.hardware.openSerialPort()
-serialPort.onData((data) => {
-    // data is array of numbers so can be processed as binary
-});
-```
-
-In case of text data:
-```javascript
-// serial port instance previously created via sos.hardware.openSerialPort()
-serialPort.onData((data) => {
-    const dataString = [...data].map((char) => String.fromCharCode(char)).join('');
-});
-```
-
-## write()
-
-Write data to the serial port. The data can be a string of hexadecimal digits, array of numbers or [Uint8Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array). And converted to hexadecimals
-
-### Javascript example
-```javascript
-// serial port instance previously created via sos.hardware.openSerialPort()
-await serialPort.write('68656c6c6f'); // hexadecimal string
-await serialPort.write([ 10, 20, 30, 40 ]); // array of numbers
-await serialPort.write(Uint8Array.from([ 10, 20, 30, 40 ])); // Uint8Array
-```
-
-## close()
-
-Close serial port and prevent any more communication
-
-### Javascript example
-```javascript
-// serial port instance previously created via sos.hardware.openSerialPort()
-await serialPort.close();
-```
-
-## Errors
-
-Following errors may occur when working with the serial ports. However they don't reflect on actual physical connectivity of the ports due to Samsung b2bapi does not register these events.
-
-
-
-| Code  | Type                  | Message                                   |
-| ----- | --------------------- | ----------------------------------------- |
-| 50602 | InternalHardwareError | Failed to open serial port                |
-| 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