@signageos/front-applet 6.1.1 → 6.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/bundle.js +1 -1
  3. package/dist/bundle.js.map +1 -1
  4. package/docs/{js-api/js-applet-basics.md → applet-basics.md} +37 -98
  5. package/docs/index.md +97 -0
  6. package/docs/js-api/js-applet-resources.md +10 -28
  7. package/docs/js-api/js-browser.md +15 -30
  8. package/docs/js-api/js-command.md +33 -91
  9. package/docs/js-api/{js-api-debug.md → js-debug.md} +2 -3
  10. package/docs/js-api/js-device-info.md +4 -5
  11. package/docs/js-api/js-display.md +5 -7
  12. package/docs/js-api/js-file-system.md +13 -14
  13. package/docs/js-api/{js-loading-fonts.md → js-fonts.md} +21 -44
  14. package/docs/js-api/js-hardware.md +6 -9
  15. package/docs/js-api/js-iframes.md +3 -3
  16. package/docs/js-api/js-input.md +2 -3
  17. package/docs/js-api/js-offline-cache-media-files.md +26 -83
  18. package/docs/js-api/js-offline-cache-simple-data.md +11 -16
  19. package/docs/js-api/js-osd.md +0 -2
  20. package/docs/js-api/js-proof-of-play.md +4 -6
  21. package/docs/js-api/js-sensors.md +1 -1
  22. package/docs/js-api/{js-hardware-serial.md → js-serial.md} +12 -17
  23. package/docs/js-api/js-sync-playback.md +30 -70
  24. package/docs/js-api/js-video-inputs-internal-ports.md +15 -33
  25. package/docs/js-api/js-video-stream.md +49 -85
  26. package/docs/js-api/js-video.md +25 -75
  27. package/docs/management-api/{10-js-management-application.md → js-management-application.md} +16 -32
  28. package/docs/management-api/{7-js-management-volume.md → js-management-audio.md} +4 -6
  29. package/docs/management-api/{9-js-management-debug.md → js-management-debug.md} +5 -18
  30. package/docs/management-api/{2-js-management-firmware.md → js-management-firmware.md} +11 -25
  31. package/docs/management-api/{1-js-management.md → js-management-management.md} +8 -37
  32. package/docs/{js-api/js-monitoring-commands.md → management-api/js-management-monitoring-commands.md} +5 -6
  33. package/docs/{js-api/js-monitors.md → management-api/js-management-monitors.md} +9 -9
  34. package/docs/management-api/{11-js-management-network.md → js-management-network.md} +14 -40
  35. package/docs/management-api/{2-js-management-os.md → js-management-os.md} +2 -3
  36. package/docs/management-api/{8-js-management-package.md → js-management-package.md} +4 -6
  37. package/docs/management-api/{4-js-management-power.md → js-management-power.md} +10 -15
  38. package/docs/management-api/{14-js-management-proxy.md → js-management-proxy.md} +4 -6
  39. package/docs/management-api/{3-js-management-remote-control.md → js-management-remote-control.md} +5 -20
  40. package/docs/management-api/{5-js-management-screen.md → js-management-screen.md} +27 -81
  41. package/docs/management-api/{12-js-management-security.md → js-management-security.md} +6 -9
  42. package/docs/management-api/{6-js-management-time.md → js-management-time.md} +19 -26
  43. package/docs/management-api/{13-js-management-wifi.md → js-management-wifi.md} +31 -40
  44. package/es6/FrontApplet/Management/Management.d.ts +2 -0
  45. package/es6/FrontApplet/Management/Management.js +17 -0
  46. package/es6/FrontApplet/Management/Management.js.map +1 -1
  47. package/es6/FrontApplet/Management/Power.d.ts +1 -1
  48. package/es6/FrontApplet/Management/Power.js +3 -1
  49. package/es6/FrontApplet/Management/Power.js.map +1 -1
  50. package/package.json +1 -1
  51. package/docs/js-api/js-api-introduction.md +0 -91
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: App
2
+ title: Application
3
3
  author: Krystof Woldrich
4
4
  date: 24.4.2018
5
5
  type: js-management-api
@@ -16,13 +16,12 @@ description: "[Management JS API] Management API app lets you check application
16
16
  Management API app lets you check application type and upgrade the application.
17
17
 
18
18
  ## All methods
19
- ::: table-responsive
19
+
20
20
  | Method | Description | Supported since |
21
21
  | ------ | -------- | ------------- |
22
22
  | `getType()` | Information about the platform your application is running on (eg. Tizen) | |
23
23
  | `getVersion()` | Information about current version of your application is running on the device (eg. 2.0.5) | |
24
- | `upgrade()` | Upgrade/Downgrade the Core App | |
25
- :::
24
+ | `upgrade()` | Upgrade/Downgrade the Core App |
26
25
 
27
26
  ## getType()
28
27
  Method `getType()` returns the display type of application on the device.
@@ -41,8 +40,8 @@ await sos.management.app.getType(); // Returns ex. sssp, android
41
40
  - `webos`
42
41
  - `windows`
43
42
 
44
- ::: alert alert--info
45
- If you need to get specific Android brand or Raspberry Pi model, use the [Firmware API](api/js/management/latest/2-js-management-firmware) `getType()`.
43
+ :::info
44
+ If you need to get specific Android brand or Raspberry Pi model, use the [Firmware API](js-management-firmware) `getType()`.
46
45
  :::
47
46
 
48
47
  ## getVersion()
@@ -61,57 +60,43 @@ Method `upgrade()` will upgrade the [Core App](https://docs.signageos.io/hc/en-u
61
60
  ### A) Upgrading signageOS Core App
62
61
  To upgrade to signageOS Core App, use the following parameters:
63
62
 
64
- ::: table-responsive
63
+
65
64
  | Param |Type | Value |Description |
66
65
  | -------------- | ----------------------------- | ------- | --------------------- |
67
66
  | `baseUrl` | String | `https://cdn.your-cms.com/tizen/`| Location of the new version of the Core App |
68
- | `version` | String | `x.x.x` | Core App version |
69
- :::
67
+ | `version` | String | `x.x.x` | Core App version
70
68
 
71
- <div class="row d-flex align-content-stretch force-padding-10">
72
- <div class="col-12 d-flex">
73
- <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" href="/changelogs">
74
- <div>
75
- <div class="wide-box__image d-flex align-items-center">
76
- <i class="fas fa-sticky-note svg-black"></i>
77
- </div>
78
- <div>
79
- <h3 class="wide-box__title wide-box__title__small pl-85">List of our latest core app versions</h3>
80
- <div class="wide-box__description">signageOS Documentation</div>
81
- </div>
82
- </div>
83
- </a>
84
- </div>
85
- </div>
69
+ :::tip
70
+ [List of our latest core app versions](https://docs.signageos.io/hc/en-us/sections/4409161443730-Core-Apps)
71
+ :::
86
72
 
87
73
  ### Javascript example
88
74
  ```javascript
89
75
  await sos.management.app.upgrade('https://example.com/signageos-core-app.zip', '2.0.0');
90
76
  ```
91
77
 
92
- <br>
78
+ <br/>
93
79
 
94
80
  ### B) Upgrading Open Core App with built-in Applet
95
81
  If you are [building your own Core App](https://docs.signageos.io/hc/en-us/articles/4405245195666) with the built-in Applet, use only one parameter `absolutePathUrl`.
96
82
 
97
83
  The `absolutePathUrl` should point to the application file, e.g. `https://cdn.your-cms.com/rpi/linux_202006100815_1.0.1_779c303408.zip`.
98
84
 
99
- ::: table-responsive
85
+
100
86
  | Param |Type | Value |Description |
101
87
  | -------------- | ----------------------------- | ------- | --------------------- |
102
- | `absolutePathUrl`| String | `https://cdn.your-cms.com/rpi/linux_xxx.zip`| Location of the new version of the Open Core App with built-in Applet |
103
- :::
88
+ | `absolutePathUrl`| String | `https://cdn.your-cms.com/rpi/linux_xxx.zip`| Location of the new version of the Open Core App with built-in Applet
104
89
 
105
90
  ### Javascript example
106
91
  ```javascript
107
92
  await sos.management.app.upgrade('https://cdn.your-cms.com/rpi/linux_xxx.zip');
108
93
  ```
109
94
 
110
- <br>
95
+ <br/>
111
96
 
112
97
  Because each of the platforms (Tizen, webOS, BrightSign, etc.) are different, use the following table to define correct `absolutePathUrl`:
113
98
 
114
- ::: table-responsive
99
+
115
100
  | Platform | absolutePathUrl | Note |
116
101
  | -------- | --------------- | ---- |
117
102
  | Tizen | `https://cdn.your-cms.com/core-apps/landscape` <br/> `https://cdn.your-cms.com/core-apps/portrait` | |
@@ -119,5 +104,4 @@ Because each of the platforms (Tizen, webOS, BrightSign, etc.) are different, us
119
104
  | webOS | `https://cdn.your-cms.com/core-apps/com.lg.app.signage_latest.ipk` <br/> `https://cdn.your-cms.com/core-apps/com.lg.app.signage_latest.zip` | `.zip` is for old webOS 1.0 and 2.0 only |
120
105
  | Android | `https://cdn.your-cms.com/core-apps/io.signageos.open_3.1.0.android.apk` | If you are building for specific version of Android (e.g. Benq) you will have a BenQ specific apk|
121
106
  | BrightSign | `https://cdn.your-cms.com/core-apps/display-brightsign.zip` | |
122
- | NEC / RPi | `https://cdn.your-cms.com/core-apps/linux_202006100815_1.0.1_779c303408.zip` | |
123
- :::
107
+ | NEC / RPi | `https://cdn.your-cms.com/core-apps/linux_202006100815_1.0.1_779c303408.zip` |
@@ -16,12 +16,11 @@ Management API audio allows you to check and set your devices current audio volu
16
16
 
17
17
  ## All methods
18
18
 
19
- ::: table-responsive
19
+
20
20
  | Method | Description | Supported since |
21
21
  | ------ | ------ | :-------------: |
22
22
  | `getVolume()` | Get current volume level | 2.0 |
23
- | `setVolume()` | Set volume level | 2.0 |
24
- :::
23
+ | `setVolume()` | Set volume level | 2.0
25
24
 
26
25
  ## getVolume()
27
26
  Method `getVolume()` lets you check for current level of volume set on the device.
@@ -34,11 +33,10 @@ await sos.management.audio.getVolume(); // Returns number e.g. 39
34
33
  ## setVolume()
35
34
  Method `setVolume()` lets you set level of volume on your device.
36
35
 
37
- ::: table-responsive
36
+
38
37
  | Param |Type | Required | Value | Description |
39
38
  | -------------- | ----------------| :-------------: | -------- | -------------------- |
40
- | `volume` | Number | <div class="red">Yes</div> | `0` - `100` | Volume level |
41
- :::
39
+ | `volume` | Number | <div class="red">Yes</div> | `0` - `100` | Volume level
42
40
 
43
41
  ### Javascript example
44
42
  ```javascript
@@ -16,12 +16,11 @@ Management API debug lets you enable and disable debug mode.
16
16
 
17
17
  ## All methods
18
18
 
19
- ::: table-responsive
19
+
20
20
  | Method | Description | Supported since |
21
21
  | ------ | -------- | :-------------: |
22
22
  | `enable()` | Enable native debug on the device | 3.0 |
23
- | `disable()` | Disable native debug on the device | 3.0 |
24
- :::
23
+ | `disable()` | Disable native debug on the device | 3.0
25
24
 
26
25
  ## enable()
27
26
  Method `enable()` enable the [Native debug](https://docs.signageos.io/hc/en-us/articles/4405238849938) on the device.
@@ -30,21 +29,9 @@ Method `enable()` enable the [Native debug](https://docs.signageos.io/hc/en-us/a
30
29
  await sos.management.debug.enable();
31
30
  ```
32
31
 
33
- <div class="row d-flex align-content-stretch force-padding-20">
34
- <div class="col-12 d-flex">
35
- <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/debug/">
36
- <div>
37
- <div class="wide-box__image d-flex align-items-center">
38
- <i class="fab fa-github svg-black"></i>
39
- </div>
40
- <div>
41
- <h3 class="wide-box__title wide-box__title__small pl-85">How to enable debug on device</h3>
42
- <div class="wide-box__description">Working example on our Github</div>
43
- </div>
44
- </div>
45
- </a>
46
- </div>
47
- </div>
32
+ :::note[GitHub Example]
33
+ [How to enable debug on device](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/debug/)
34
+ :::
48
35
 
49
36
  ## disable()
50
37
  Method `disable()` disable the [Native debug](https://docs.signageos.io/hc/en-us/articles/4405238849938) on the device.
@@ -16,25 +16,24 @@ Firmware management API allows you to remotely upgrade firmware version and chec
16
16
 
17
17
  ## All methods
18
18
 
19
- ::: table-responsive
19
+
20
20
  | Method | Description | Supported since |
21
21
  | ------ | ------ | ------------- |
22
22
  | `upgrade()` | Allows you to upgrade device FW | 3.0 |
23
23
  | `getVersion()` | Get current FW version | 3.0 |
24
- :::
24
+ | `getType()` | Get current FW type | 5.0 |
25
25
 
26
26
  ## upgrade()
27
27
  Method `upgrade()` will upgrade current firmware version to a specified one.
28
28
 
29
- ::: table-responsive
29
+
30
30
  | Param |Type | Required | Description |
31
31
  | -------------- | ----------------------| :-------: | -------------------- |
32
32
  | `baseUrl` | string | <div class="red">Yes</div> | Location of the FW package for specific device |
33
33
  |^^|^^|^^| `https://cdn.your-cms.com/tizen/pmf/fw/2080_4.bem` |
34
34
  | `version` | string | <div class="yellow">No</div> | FW version |
35
35
  |^^|^^|^^| `T-HKMLAKUC-2080.4` |
36
- | `(progress: number)` | callback | <div class="yellow">No</div> | FW progress upgrade |
37
- :::
36
+ | `(progress: number)` | callback | <div class="yellow">No</div> | FW progress upgrade
38
37
 
39
38
  ### Javascript example
40
39
  ```javascript
@@ -49,32 +48,20 @@ await sos.management.firmware.upgrade(
49
48
  await sos.management.firmware.upgrade('https://cdn.your-cms.com/tizen/pmf/fw/2080_4.bem');
50
49
  ```
51
50
 
52
- ::: alert alert--warning
51
+ :::warning
53
52
  Always check if your absolute firmware URL ends with firmware file.
54
53
  Example: `https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw`
55
54
  :::
56
55
 
57
- ::: alert alert--info
56
+ :::info
58
57
  For BrightSign firmware upgrade please ensure that you have txt file with SHA1 hash of that firmware file.
59
58
  - Firmware file path: `https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw`
60
59
  - SHA1 txt file: `https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw.sha1.txt`
61
60
  :::
62
61
 
63
- <div class="row d-flex align-content-stretch force-padding-20">
64
- <div class="col-12 d-flex">
65
- <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/firmware/">
66
- <div>
67
- <div class="wide-box__image d-flex align-items-center">
68
- <i class="fab fa-github svg-black"></i>
69
- </div>
70
- <div>
71
- <h3 class="wide-box__title wide-box__title__small pl-85">How to upgrade firmware</h3>
72
- <div class="wide-box__description">Working example on our Github</div>
73
- </div>
74
- </div>
75
- </a>
76
- </div>
77
- </div>
62
+ :::note[GitHub Example]
63
+ [How to upgrade firmware](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/firmware/)
64
+ :::
78
65
 
79
66
  ## getVersion()
80
67
  Method `getVersion()` will specify what current version of firmware is installed on a device.
@@ -89,7 +76,7 @@ sos.management.firmware.getVersion().then((version) => {
89
76
  ## getType()
90
77
  Returns a string identifier that, when combined with firmware version, can be used to identify a correct firmware image to install on the current device.
91
78
 
92
- ::: table-responsive
79
+
93
80
  | Type | Description |
94
81
  | ------------- | -------------------------------------- |
95
82
  | `rpi` | any Raspberry Pi 3 or Compute Module 3 |
@@ -97,8 +84,7 @@ Returns a string identifier that, when combined with firmware version, can be us
97
84
  | `benq-` | any Benq display |
98
85
  | `philips-` | any Philips display |
99
86
  | `sharp-` | any Sharp display |
100
- | `elo-` | any Elo display |
101
- :::
87
+ | `elo-` | any Elo display
102
88
 
103
89
  ### Javascript example
104
90
  ```javascript
@@ -16,7 +16,7 @@ description: "[Management JS API] To make the management of devices more viable
16
16
  To make the management of devices more viable and open there is a management API prepared. Through this API things like device firmware, battery status, brightness, network information, remote control, power, time or volume can be monitored.
17
17
 
18
18
  ## All methods
19
- ::: table-responsive
19
+
20
20
  | Method | Description | Supported since |
21
21
  | ------ | -------- | :------------: |
22
22
  | `supports()` | Enum of supported features | 2.0.0 |
@@ -27,8 +27,7 @@ To make the management of devices more viable and open there is a management API
27
27
  | `getTemperature()` | Current device temperature | 3.0.0 |
28
28
  | `resetSettings()` | Clear all settings on device | 4.0.0 |
29
29
  | `factoryReset()` | Do a device factory reset | 4.0.0 |
30
- | `getBrand()` | Information about device brand | 5.7.0 |
31
- :::
30
+ | `getBrand()` | Information about device brand | 5.7.0
32
31
 
33
32
  ## Examples
34
33
  <div class="row d-flex align-content-stretch force-padding-10">
@@ -47,46 +46,18 @@ To make the management of devices more viable and open there is a management API
47
46
  </div>
48
47
  </div>
49
48
 
50
- <div class="row d-flex align-content-stretch force-padding-10">
51
- <div class="col-12 d-flex">
52
- <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/js-management-getters/">
53
- <div>
54
- <div class="wide-box__image d-flex align-items-center">
55
- <i class="fab fa-github svg-black"></i>
56
- </div>
57
- <div>
58
- <h3 class="wide-box__title wide-box__title__small pl-85">Getting basic management API data</h3>
59
- <div class="wide-box__description">Working example on our Github</div>
60
- </div>
61
- </div>
62
- </a>
63
- </div>
64
- </div>
65
-
66
- <div class="row d-flex align-content-stretch force-padding-10">
67
- <div class="col-12 d-flex">
68
- <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/js-management-setters/">
69
- <div>
70
- <div class="wide-box__image d-flex align-items-center">
71
- <i class="fab fa-github svg-black"></i>
72
- </div>
73
- <div>
74
- <h3 class="wide-box__title wide-box__title__small pl-85">Setting basic management API data</h3>
75
- <div class="wide-box__description">Working example on our Github</div>
76
- </div>
77
- </div>
78
- </a>
79
- </div>
80
- </div>
49
+ :::note[GitHub Example]
50
+ - [Getting basic management API data](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/js-management-getters/)
51
+ - [Setting basic management API data](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/js-management-setters/">
52
+ :::
81
53
 
82
54
  ## supports()
83
55
  Method `supports()` will show you what capabilities the deployed device currently has.
84
56
 
85
- ::: table-responsive
57
+
86
58
  | Param | Type |Description |
87
59
  | -------------- | ----------------------------- | ---------------------------- |
88
- | `capability` | String | Name of capability |
89
- :::
60
+ | `capability` | String | Name of capability
90
61
 
91
62
  ### Javascript example
92
63
  ```javascript
@@ -2,7 +2,7 @@
2
2
  title: Monitoring Commands
3
3
  author: Miroslav Behina
4
4
  date: 22.11.2018
5
- type: js-api
5
+ type: js-management-api
6
6
  tags:
7
7
  - applet
8
8
  - applet_api
@@ -13,7 +13,7 @@ description: "[Content JS API] All commands have type prefixed with sos. string.
13
13
 
14
14
  # Monitoring Commands
15
15
 
16
- ::: alert alert--warning
16
+ :::warning
17
17
  This is only a preview, not supported by all platforms. Supported since: 2.0.0
18
18
  :::
19
19
 
@@ -69,7 +69,7 @@ export interface ConsoleLogged {
69
69
  }
70
70
  ```
71
71
 
72
- To trigger some monitoring commands to be dispatched from a device. This REST API can be used to send monitoring [commands to the device](https://sdk.docs.signageos.io/api/device-monitoring-api/#Send_Device_Applet_Command_to_device). Following commands can be used:
72
+ To trigger some monitoring commands to be dispatched from a device. This REST API can be used to send monitoring [commands to the device](https://api.docs.signageos.io/#056b9284-56c6-4f50-8068-5e22a3df071f). Following commands can be used:
73
73
 
74
74
  ### Typescript
75
75
  ```typescript
@@ -99,10 +99,9 @@ export interface OfflineCacheLoadFile {
99
99
  ## Errors
100
100
  Although we are doing our best, following errors may occur when working with the commands.
101
101
 
102
- ::: table-responsive
102
+
103
103
  | Code | Type | Message |
104
104
  | ---- | ---- | ------- |
105
105
  | 40401 | AppletCommandTypeError | Type contains invalid characters, allowed are `/^[a-zA-Z0-9\.\-_]+$/g` |
106
106
  | 40402 | AppletCommandTypeError | Type is longer then 100 characters. |
107
- | 40403 | AppletCommandTypeError | Command type must be a string. |
108
- :::
107
+ | 40403 | AppletCommandTypeError | Command type must be a string.
@@ -2,7 +2,7 @@
2
2
  title: Monitors
3
3
  author: Alisher Nurmatov
4
4
  date: 29.12.2020
5
- type: js-api
5
+ type: js-management-api
6
6
  tags:
7
7
  - applet
8
8
  - applet_api
@@ -15,6 +15,14 @@ description: "[Content JS API] Monitors provides info about connected **monitors
15
15
 
16
16
  Provides information about currently connected monitors. Such as manufacturer, model, serial, firmware (optional).
17
17
 
18
+ ## All methods
19
+
20
+ | Method/Events | Description | Supported since |
21
+ | ----------------- | --------------------------------- | :---------------: |
22
+ | `getList()` | Method gets list of monitors. | 4.0.0 |
23
+
24
+ ## getList()
25
+
18
26
  ### Monitor object
19
27
 
20
28
  Here is the monitor object defined as Typescript interface:
@@ -28,14 +36,6 @@ interface IMonitor {
28
36
  }
29
37
  ```
30
38
 
31
- ## All methods
32
-
33
- ::: table-responsive
34
- | Method/Events | Description | Supported since |
35
- | ----------------- | --------------------------------- | :---------------: |
36
- | `getList()` | Method gets list of monitors. | 4.0.0 |
37
- :::
38
-
39
39
  ### Javascript example
40
40
  ```javascript
41
41
  // gets list of monitors
@@ -16,7 +16,7 @@ description: "[Management JS API] Network management API allows you to manually
16
16
  Network management API allows you to manually set network interfaces or set back DHCP and current active network info.
17
17
 
18
18
  ## All methods
19
- ::: table-responsive
19
+
20
20
  | Method | Description | Supported since |
21
21
  | ------ | -------- | :-------------: |
22
22
  | `getActiveInfo()` | Information about network interfaces, IP addesses and MAC addresses (**DEPRECATED**) | 4.0 |
@@ -24,12 +24,11 @@ Network management API allows you to manually set network interfaces or set back
24
24
  | `setManual()` | Allows you to set network settings manually | 4.0 |
25
25
  | `setDHCP()` | Allows you to set network settings automatically from DHCP | 4.0 |
26
26
  | `disableInterface()` | Disables a network interface | 4.13 |
27
- :::
28
27
 
29
28
  ## getActiveInfo()
30
29
  Method `getActiveInfo()` will display information about connected network.
31
30
 
32
- ::: alert alert--warning
31
+ :::warning
33
32
  This method is deprecated. Use `listInterfaces()` instead.
34
33
  :::
35
34
 
@@ -73,21 +72,9 @@ Wifi connection strength is described as percentage in range from 0 to 100, line
73
72
  }
74
73
  ```
75
74
 
76
- <div class="row d-flex align-content-stretch force-padding-20">
77
- <div class="col-12 d-flex">
78
- <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/network/">
79
- <div>
80
- <div class="wide-box__image d-flex align-items-center">
81
- <i class="fab fa-github svg-black"></i>
82
- </div>
83
- <div>
84
- <h3 class="wide-box__title wide-box__title__small pl-85">Getting network data from device</h3>
85
- <div class="wide-box__description">Working example on our Github</div>
86
- </div>
87
- </div>
88
- </a>
89
- </div>
90
- </div>
75
+ :::note[GitHub Example]
76
+ [Getting network data from device](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/network/)
77
+ :::
91
78
 
92
79
  ## listInterfaces()
93
80
  Returns list of all network interfaces, and their information like MAC address, IP address, etc.
@@ -132,27 +119,15 @@ Wifi connection strength is described as percentage in range from 0 to 100, line
132
119
  ]
133
120
  ```
134
121
 
135
- <div class="row d-flex align-content-stretch force-padding-20">
136
- <div class="col-12 d-flex">
137
- <a class="wide-box wide-box--white d-flex align-content-stretch widebox-kb-color" target="_blank" href="https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/network/">
138
- <div>
139
- <div class="wide-box__image d-flex align-items-center">
140
- <i class="fab fa-github svg-black"></i>
141
- </div>
142
- <div>
143
- <h3 class="wide-box__title wide-box__title__small pl-85">Getting network interfaces from device</h3>
144
- <div class="wide-box__description">Working example on our Github</div>
145
- </div>
146
- </div>
147
- </a>
148
- </div>
149
- </div>
122
+ :::note[GitHub Example]
123
+ [Getting network interfaces from device](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/network/)
124
+ :::
150
125
 
151
126
  ## setManual()
152
127
  Manually configures a network interface.
153
128
  If the interface is disabled, it will be enabled.
154
129
 
155
- ::: alert alert--warning
130
+ :::warning
156
131
  Wi-Fi interface can be configured with this method but it has to be first enabled via the [Wi-Fi API](/api/js/management/11-js-management-network).
157
132
  :::
158
133
 
@@ -200,7 +175,7 @@ await sos.management.network.setManual({
200
175
  Configures a network interface to use DHCP to get an IP address asigned from the network.
201
176
  If the interface is disabled, it will be enabled.
202
177
 
203
- ::: alert alert--warning
178
+ :::warning
204
179
  Wi-Fi interface can be configured with this method but it has to be first enabled via the [Wi-Fi API](/api/js/management/11-js-management-network).
205
180
  :::
206
181
 
@@ -228,22 +203,21 @@ await sos.management.network.setDHCP('ethernet');
228
203
  ## disableInterface()
229
204
  Disables a network interface
230
205
 
231
- ::: table-responsive
206
+
232
207
  | Param | Type | Required | Description |
233
208
  | --------------- | ------ | :------------------------: | ---------------------------------------------------- |
234
- | `interfaceName` | String | <div class="red">Yes</div> | Name of the network interface, that will be disabled |
235
- :::
209
+ | `interfaceName` | String | <div class="red">Yes</div> | Name of the network interface, that will be disabled
236
210
 
237
211
  ### Javascript example
238
212
  ```javascript
239
213
  await sos.management.wifi.disableInterface("eth0");
240
214
  ```
241
215
 
242
- ::: alert alert--info
216
+ :::info
243
217
  A disabled network interface can be re-enabled simply by calling either `setDHCP()` or `setManual()`.
244
218
  :::
245
219
 
246
- ::: alert alert--warning
220
+ :::warning
247
221
  Don't use this method to disable Wi-Fi.
248
222
  Use [Wi-Fi API](/api/js/management/11-js-management-network) to enable/disable Wi-Fi.
249
223
  :::
@@ -16,13 +16,12 @@ OS management API allows you to manage information of operating system on your c
16
16
 
17
17
  ## All methods
18
18
 
19
- ::: table-responsive
19
+
20
20
  | Method | Description | Supported since |
21
21
  | ------ | ------ | ------------- |
22
22
  | `getInfo()` | Get current OS version | 5.0 |
23
23
  | `getCpuUsage()` | Get current CPU usage | 5.4 |
24
- | `getMemoryUsage()` | Get current RAM usage | 5.4 |
25
- :::
24
+ | `getMemoryUsage()` | Get current RAM usage | 5.4
26
25
 
27
26
  ## getInfo()
28
27
  Method `getInfo()` will specify info about device like a what current version of is is installed on a device.
@@ -16,24 +16,22 @@ Management API package allows you to install new packages.
16
16
 
17
17
  ## All methods
18
18
 
19
- ::: table-responsive
19
+
20
20
  | Methods | Description | Supported since |
21
21
  | ------ | -------- | :-------------: |
22
- | `install()` | Install additional packages to Android devices (eg. new WebView) | 3.0 |
23
- :::
22
+ | `install()` | Install additional packages to Android devices (eg. new WebView) | 3.0
24
23
 
25
24
 
26
25
  ## install()
27
26
  Method `install()` will install a certain package from the specified url.
28
27
 
29
- ::: table-responsive
28
+
30
29
  | Param |Type | Required | Value | Description |
31
30
  | -------------- | --------------| :---------------: | ------ | ---------------------- |
32
31
  | `baseUrl` | String | <div class="red">Yes</div> | `https://cdn.your-cms.com` | URL where the package is available |
33
32
  | `packageName` | String | <div class="red">Yes</div> | `io.signageosWebView.app.ota` | Name of the android package |
34
33
  | `version` | String | <div class="red">Yes</div> | `2.4.0` | Package version |
35
- | `build` | String or null | <div class="red">Yes</div> | `benq` or `philips`,... | If relevant for your device |
36
- :::
34
+ | `build` | String or null | <div class="red">Yes</div> | `benq` or `philips`,... | If relevant for your device
37
35
 
38
36
  ### Javascript example
39
37
  ```javascript