@signageos/front-applet 7.1.1 → 8.0.0

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

@@ -1,161 +0,0 @@
----
-title:  Time
-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 time allows you to check your devices current time with a timezone and set current time with a timezone."
----
-
-# Time
-Management API time allows you to check your devices current time with a timezone and set current time with a timezone.
-
-## All methods
-
-
-| Method     | Description                                       | Supported since |
-| ----------- | ------------------------------------------------- | :---------------: |
-| `get()`       | Get current time settings                         | 4.0.0           |
-| `setManual()` | Set manual datetime and timezone                  | 4.0.0           |
-| `setNTP()`    | Configure NTP server and timezone                 | 4.0.0           |
-| `set()`       | Set manual datetime and timezone (**DEPRECATED**) | 4.0.0           
-
-## get()
-Method `get()` lets you check for current time with time zone. 
-
-### Javascript example
-```javascript
-const time = await sos.management.time.get();
-```
-
-:::note[GitHub Example]
-[How to manage time on device](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/time)
-:::
-
-### Example of response
-
-When NTP is set:
-
-```json
-{
-    "currentDate": Date("2019-04-01T01:11:11.111Z"),
-    "timezone": "Asia/Tokyo",
-    "ntpServer": "pool.ntp.org"
-}
-```
-
-When NTP is not set:
-
-```json
-{
-    "currentDate": Date("2019-04-01T01:11:11.111Z"),
-    "timezone": "Asia/Tokyo"
-}
-```
-
-## set()
-Method `set()` lets you set manual time and timezone of the device.
-
-:::warning
-This method is deprecated. Use `setManual()` instead.
-:::
-
-:::info
-Calling `set()` will disable NTP server settings.
-:::
-
-
-|      Param     |Type        | Required | Description                  |
-| -------------- | ---------- | :---------: | ------------------- |
-| `currentDate`    | Date       | <div class="red">Yes</div> | Datetime to set              |
-| `timezone`       | String     | <div class="red">Yes</div> | Timezone to set. Accepted values are timezone names from [timezone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). 
-
-### Javascript example
-```javascript
-const currentDate = new Date();
-const timezone = "Europe/Amsterdam";
-await sos.management.time.set(currentDate, timezone);
-```
-
-:::warning
-Setting time and timezone has side effects:
-
-| Platform    | Side effect                                  |
-| ----------- | -------------------------------------------- |
-| Tizen       | After calling this API, display **Reboots**! |
-| webOS       | After calling this API, display **Reboots**! |
-| RaspberryPi | After calling this API, RPi **Reboots backend server which can take up to 60 seconds**!<br /> During the reboot no JS API is available.<br />Always wait for Promise resolution. 
-
-## setManual()
-Method `setManual()` lets you set manual time and timezone of the device.
-
-:::info
-Calling `setManual()` will disable NTP server settings.
-:::
-
-
-|      Param     |Type        | Required | Description                  |
-| -------------- | ---------- | :---------: | ------------------- |
-| `currentDate`    | Date \| object | <div class="red">Yes</div> | Datetime to set              |
-| `timezone`       | String     | <div class="red">Yes</div> | Timezone to set. Accepted values are timezone names from [timezone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). 
-
-### Javascript example
-```javascript
-const datetimeObj = {
-    year: 2021,
-    month: 12,
-    day: 15,
-    hour: 9,
-    minute: 30,
-    seconds: 0,
-};
-const timezone = "Europe/Amsterdam";
-await sos.management.time.setManual(datetimeObj, timezone);
-
-// Using Date is deprecated. Use the example above.
-const currentDate = new Date();
-const timezone = "Europe/Amsterdam";
-await sos.management.time.setManual(currentDate, timezone);
-```
-
-:::warning
-Calling this method with currentDate as Date is deprecated.
-You should call it with datetime object instead. See example code.
-:::
-
-:::warning
-Setting time and timezone has side effects:
-
-| Platform    | Side effect                                  |
-| ----------- | -------------------------------------------- |
-| Tizen       | After calling this API, display **Reboots**! |
-| webOS       | After calling this API, display **Reboots**! |
-| RaspberryPi | After calling this API, RPi **Reboots backend server which can take up to 60 seconds**!<br /> During the reboot no JS API is available.<br />Always wait for Promise resolution. 
-
-## setNTP()
-Method `setNTP()` lets you configure NTP server and timezone.
-
-
-|      Param     |Type        | Required | Description                  |
-| -------------- | ---------- | :----------: | ------------------ |
-| `ntpServer`      | string     | <div class="red">Yes</div> | Address of the NTP server    |
-| `timezone`       | string     | <div class="red">Yes</div> | Timezone to set. Accepted values are timezone names from [timezone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). 
-
-### Javascript example
-```javascript
-const ntpServer = "pool.ntp.org";
-const timezone = "Europe/Amsterdam";
-await sos.management.time.setNTP(ntpServer, timezone);
-```
-
-:::warning
-Setting NTP server and timezone has side effects:
-
-| Platform    | Side effect                                  |
-| ----------- | -------------------------------------------- |
-| Tizen       | After calling this API, display **Reboots**!<br/><br/> Tizen has [**limited set of available timezones**. Read more here.](https://docs.signageos.io/hc/en-us/articles/4405381271314) |
-| RaspberryPi | After calling this API, RPi **Reboots backend server which can take up to 60 seconds**!<br /> During the reboot no JS API is available.<br />Always wait for Promise resolution. 

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

@@ -1,341 +0,0 @@
----
-title:  Wi-Fi
-author: Michal Artazov
-date:   1.9.2020
-type:   js-management-api
-tags:
-- applet
-- applet_api
-- api
-- js_management_api
-description: "[Management JS API] Wi-Fi API allows you to configure Wi-Fi, if the device supports it."
----
-
-# Wi-Fi
-
-Wi-Fi API allows you to configure Wi-Fi, if the device supports it.
-
-:::warning
-* Before using this API, ensure that the device supports Wi-Fi via `sos.management.supports("WIFI")`.
-* More info about how to check it, you can find [**THERE**](js-management-management#supports)
-:::
-
-## State management
-Wi-Fi can be in several states. Depending on which state it is in, its behavior will vary. The 3 possible states are:
-
-* DISABLED
-* CLIENT
-* AP
-
-:::info
-It is only allowed to switch to another state when in the DISABLED state. It is not allowed to go directly from CLIENT to AP or vice versa.
-:::
-
-### DISABLED
-
-Wi-Fi is disabled. The DISABLED state is persistent between reboots.
-
-### CLIENT
-
-Wi-Fi is in the client state, i.e. it is capable of connecting to a network, similarly to a phone or laptop.
-CLIENT state is persistent between reboots with all of its configuration.
-
-### AP
-
-Wi-Fi is in access point state, i.e. it itself becomes a Wi-Fi network that others can connect to.
-AP state is not persistent and on reboot the device will be in DISABLED state.
-
-## Country settings
-
-Different regulations apply to Wi-Fi communication in different countries.
-Under normal circumstances, everything should work with default settings.
-However, if you experience any problems, you might want to try changing Wi-Fi country configuration to your country.
-See [`getCountry()`](js-management-wifi#getcountry) and [`setCountry()`](js-management-wifi#setcountry) methods.
-
-## All methods
-
-
-| Methods              | Description                                                        | Supported since |
-| -------------------- | ------------------------------------------------------------------ | :---------------: |
-| `isClientEnabled()`    | Is in CLIENT state?                                                | 4.3.0           |
-| `enableClient()`       | Switch to CLIENT state                                             | 4.3.0           |
-| `isAPEnabled()`        | Is in AP state?                                                    | 4.3.0           |
-| `enableAP()`           | Switch to AP state                                                 | 4.3.0           |
-| `disable()`            | Switch to DISABLED state                                           | 4.3.0           |
-| `getConnectedTo()`     | When in CLIENT state, return which network it is connected to      | 4.3.0           |
-| `connect()`            | When in CLIENT state, connect to a network                         | 4.3.0           |
-| `disconnect()`         | When in CLIENT state, disconnect from a network                    | 4.3.0           |
-| `getCountry()`         | Get which country Wi-Fi is configured for                          | 4.3.0           |
-| `setCountry()`        | Configure Wi-Fi for a specific country                             | 4.3.0           |
-| `scanDevices()`        | When in CLIENT or AP states, scan available networks               | 4.3.0           |
-| `on()`                 | Call listener anytime an event is emitted                          | 4.3.0           |
-| `once()`               | Call listener the first time an event is emitted                   | 4.3.0           |
-| `removeListener()`     | Remove a listener previously registered via on() or once() methods | 4.3.0           |
-| `removeAllListeners()` | Remove all listeners                                               | 4.3.0           
-
-## Events
-
-
-| Event               | Description                                              |
-| ------------------- | -------------------------------------------------------- |
-| `client_enabled`      | Wi-Fi was set to CLIENT state                            |
-| `client_connected`    | Wi-Fi is in CLIENT state and connected to a network      |
-| `client_disconnected` | Wi-Fi is in CLIENT state and disconnected from a network |
-| `ap_enabled`          | Wi-Fi was set to AP state                                |
-| `disabled`            | Wi-Fi was set to DISABLED state                          
-
-## Examples
-
-:::note[GitHub Example]
-[Applet with Wi-Fi Access Point](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/wifi-access-point/)
-:::
-
-## isClientEnabled()
-Returns true, if Wi-Fi is in CLIENT state. Otherwise, returns false. 
-
-### Javascript example
-```javascript
-const isClientEnabled = await sos.management.wifi.isClientEnabled();
-if (isClientEnabled) {
-    // do something
-}
-```
-
-## enableClient()
-Sets Wi-Fi to CLIENT state, meaning it has the ability to connect to a Wi-Fi network or scan available networks in the area.
-
-:::info
-It is not allowed to call this method, when in AP state. You must first switch to **DISABLED** state.
-:::
-
-### Javascript example
-```javascript
-await sos.management.wifi.enableClient();
-```
-
-## isAPEnabled()
-Returns true, if Wi-Fi is in AP state. Otherwise, returns false. 
-
-### Javascript example
-```javascript
-const isAPEnabled = await sos.management.wifi.isAPEnabled();
-if (isAPEnabled) {
-    // do something
-}
-```
-
-## enableAP()
-Sets Wi-Fi to AP state, meaning the device will become a Wi-Fi network that other devices can connect to.
-It will run in WPA-Personal mode. As such, it requires an SSID (network name) and password that other devices will use to connect.
-
-:::info
-* It is not allowed to call this method when in CLIENT state. You must first switch to **DISABLED** state.
-* Before calling this method, make sure the device supports Wi-Fi AP via `sos.management.supports("WIFI_AP")`
-:::
-
-
-| Param    | Type   | Required | Description                                                                                              |
-| -------- | ------ | :----------: | ---------------------------------------------------------------------------------------------- |
-| `ssid`     | String | <div class="red">Yes</div> | Device will be visible as a Wi-Fi network with this name. Max. allowed length is 32 characters.          |
-| `password` | String | <div class="red">Yes</div> | Devices that wish to connect to this network will use this password. Must be between 8 and 32 characters. 
-
-### Javascript example
-```javascript
-await sos.management.wifi.enableAP("my_network", "secretPassword123#");
-```
-
-## disable()
-Sets Wi-Fi to **DISABLED** state. All previously configured networks will be forgotten.
-
-### Javascript example
-```javascript
-await sos.management.wifi.disable();
-```
-
-## getConnectedTo()
-If connected to a Wi-Fi network, returns the name of the network. Otherwise, returns null.
-
-:::info
-It is only allowed to call this method in CLIENT state.
-:::
-
-### Javascript example
-
-```javascript
-const connectedTo = await sos.management.wifi.getConnectedTo();
-```
-
-## connect()
-Connect to a network.
-
-:::info
-It is only allowed to call this method in the **CLIENT** state.
-:::
-
-
-| Param               | Type   | Required | Description                                 |
-| ------------------- | ------ | :---------: | ---------------------------------- |
-| `ssid`     | String | <div class="red">Yes</div> | Name of the network you want to connect to. |
-| `password` | String | <div class="yellow">No</div> | Network's password.                         |
-| `options`  | Object | <div class="yellow">No</div> | Additional options.                         
-
-### Javascript example
-```javascript
-// network without password
-await sos.management.wifi.connect('network1');
-
-// or network with password
-await sos.management.wifi.connect('network2', 'password123');
-
-// connect to a hidden network
-await sos.management.wifi.connect('network3', 'password123', { hidden: true });
-```
-
-## disconnect()
-Disconnect from the network, if connected to one.
-
-:::info
-It is only allowed to call this method in the **CLIENT** state.
-:::
-
-### Javascript example
-
-```javascript
-await sos.management.wifi.disconnect();
-```
-
-## getCountry()
-Get currently configured country code. 
-
-:::info
-It is not allowed to call this method in the **DISABLED** state.
-:::
-
-### Javascript example
-```javascript
-const countryCode = await sos.management.wifi.getCountry();
-```
-
-## setCountry()
-Configure Wi-Fi for country-specific regulations. 
-
-:::info
-It is not allowed to call this method in the **DISABLED** state.
-:::
-
-
-| Param       | Type   | Required | Description                                                                                             |
-| ----------- | ------ | :-----------: | -------------------------------------------------------------------------------------------- |
-| `countryCode` | String | <div class="red">Yes</div> |2-letter country code. See this [list of countries and their codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes). 
-
-### Javascript example
-```javascript
-await sos.management.wifi.setCountry('ES');
-```
-
-## scanDevices()
-Get list of available Wi-Fi networks in the area. 
-
-:::info
-* It is only allowed to call this method in the **CLIENT** state.
-* Before calling this method, make sure the device supports scanning via `sos.management.supports("WIFI_SCAN")`
-:::
-
-### Javascript example
-```javascript
-const devices = await sos.management.wifi.scanDevices();
-```
-
-## on()
-Call a callback everytime an event is emitted.
-
-
-| Param    | Type     | Required | Description                                                       |
-| -------- | -------- | :--------------: |  --------------------------------------------------- |
-| `event`    | String   | <div class="red">Yes</div> | Event name. See [events](js-management-wifi#events) for valid event names.          |
-| `listener` | Method | <div class="red">Yes</div> | Callback that will be called everytime the given event is emitted 
-
-### Javascript example
-```javascript
-sos.management.wifi.on('client_connected', () => {
-    console.log('Wi-Fi is connected');
-});
-sos.management.wifi.on('client_disconnected', () => {
-    console.log('Wi-Fi is disconnected');
-});
-```
-
-## once()
-Call a callback the first time an event is emitted.
-
-
-| Param    | Type     | Required | Description                                                       |
-| -------- | -------- | :------------: | ----------------------------------------------------- |
-| `event`    | String   | <div class="red">Yes</div> | Event name. See [events](js-management-wifi#events) for valid event names.          |
-| `listener` | Method | <div class="red">Yes</div> | Callback that will be called everytime the given event is emitted 
-
-### Javascript example
-```javascript
-sos.management.wifi.once('client_connected', () => {
-    console.log('Wi-Fi is connected');
-});
-sos.management.wifi.once('client_disconnected', () => {
-    console.log('Wi-Fi is disconnected');
-});
-```
-
-## removeListener()
-Remove an event listener previously registered via [`on`](js-management-wifi#on) or [`once`](js-management-wifi#once).
-
-
-| Param    | Type     | Required | Description                                                       |
-| -------- | -------- | :----------: | ------------------------------------------------------- |
-| `event`    | String   | <div class="red">Yes</div> | Event name. See [events](js-management-wifi#events) for valid event names.          |
-| `listener` | Method | <div class="red">Yes</div> | Callback that was previously registered 
-
-### Javascript example
-```javascript
-// first register a listener
-const listener = () => {
-    console.log('Wi-Fi is connected');
-};
-sos.management.wifi.on('client_connected', listener);
-
-// then remove it
-sos.management.wifi.removeListener('client_connected', listener);
-
-// now if client_connected is emitted, the listener callback wouldn't be called anymore
-```
-
-## removeAllListeners()
-Remove all listeners previously registered via [`on`](js-management-wifi#on) or [`once`](js-management-wifi#once), either for a specific event or for all events.
-
-
-| Param            | Type   | Required | Description                                              |
-| ---------------- | ------ | :--------: | -------------------------------------------------------- |
-| `event` | String | <div class="yellow">No</div> | Event name. See [events](js-management-wifi#events) for valid event names. 
-
-### Javascript example
-```javascript
-// first register a listener
-sos.management.wifi.on('client_connected', () => {
-   console.log('Wi-Fi is connected');
-});
-
-// then remove it
-sos.management.wifi.removeAllListeners('client_connected');
-// now if client_connected is emitted, the listener callback wouldn't be called anymore
-
-// next remove all listeners
-sos.management.wifi.removeAllListeners();
-// now if any event is emitted, no listener callbacks would be called
-```
-
-### FAQ
-- Do I need to reboot my RPi for the Wi-Fi changes to take place?<br/>
-No, the device will automatically adapt to any saved changes
-
-- How can I tell if the device has successfuly connected to the network?<br/>
-Once the device starts the connecting process and sucessfully connects, 2 events will be emmited:<br/>
-    1. client_enabled
-    1. client_connected

package/es6/FrontApplet/Command/ICommandEventListener.d.ts

@@ -1,6 +0,0 @@
-import ICommandEvent from './ICommandEvent';
-import ICommand from './ICommand';
-interface ICommandEventListener<TCommand extends ICommand> {
-    (event: ICommandEvent<TCommand>): void;
-}
-export default ICommandEventListener;

package/es6/FrontApplet/Command/ICommandEventListener.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=ICommandEventListener.js.map

package/es6/FrontApplet/Command/ICommandEventListener.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ICommandEventListener.js","sourceRoot":"","sources":["../../../src/FrontApplet/Command/ICommandEventListener.ts"],"names":[],"mappings":""}

package/es6/FrontApplet/Input/IKeyUpEventListener.d.ts

@@ -1,5 +0,0 @@
-import IKeyUpEvent from './IKeyUpEvent';
-interface IKeyUpEventListener {
-    (event: IKeyUpEvent): void;
-}
-export default IKeyUpEventListener;

package/es6/FrontApplet/Input/IKeyUpEventListener.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IKeyUpEventListener.js","sourceRoot":"","sources":["../../../src/FrontApplet/Input/IKeyUpEventListener.ts"],"names":[],"mappings":""}

package/es6/FrontApplet/Management/Firmware/FirmwareType.d.ts

@@ -1,4 +0,0 @@
-export declare enum FirmwareType {
-    RPI3 = "rpi",
-    RPI4 = "rpi4"
-}

package/es6/FrontApplet/Management/Firmware/FirmwareType.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FirmwareType = void 0;
-var FirmwareType;
-(function (FirmwareType) {
-    FirmwareType["RPI3"] = "rpi";
-    FirmwareType["RPI4"] = "rpi4";
-})(FirmwareType = exports.FirmwareType || (exports.FirmwareType = {}));
-//# sourceMappingURL=FirmwareType.js.map

package/es6/FrontApplet/Management/Firmware/FirmwareType.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FirmwareType.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Firmware/FirmwareType.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAGX;AAHD,WAAY,YAAY;IACvB,4BAAY,CAAA;IACZ,6BAAa,CAAA;AACd,CAAC,EAHW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAGvB"}

package/es6/FrontApplet/Stream/streamListeners.d.ts

@@ -1,10 +0,0 @@
-import { IStreamErrorEvent, IStreamEvent, IStreamTracksChangedEvent, StreamEventType } from './streamEvents';
-export interface IStreamEventListener<T extends StreamEventType> {
-    (event: IStreamEvent<T>): void;
-}
-export interface IStreamErrorEventListener extends IStreamEventListener<'error'> {
-    (event: IStreamErrorEvent): void;
-}
-export interface IStreamTracksChangedEventListener extends IStreamEventListener<'tracks_changed'> {
-    (event: IStreamTracksChangedEvent): void;
-}

package/es6/FrontApplet/Stream/streamListeners.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"streamListeners.js","sourceRoot":"","sources":["../../../src/FrontApplet/Stream/streamListeners.ts"],"names":[],"mappings":""}

package/es6/FrontApplet/Video/IVideoEventListener.d.ts

@@ -1,5 +0,0 @@
-import IVideoEvent from './IVideoEvent';
-interface IVideoEventListener {
-    (event: IVideoEvent): void;
-}
-export default IVideoEventListener;

package/es6/FrontApplet/Video/IVideoEventListener.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"IVideoEventListener.js","sourceRoot":"","sources":["../../../src/FrontApplet/Video/IVideoEventListener.ts"],"names":[],"mappings":""}