@signageos/front-applet 7.1.1 → 8.0.0

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 (457) hide show
  1. package/dist/bundle.js +5 -5
  2. package/dist/bundle.js.map +1 -1
  3. package/docs/fpath/index.md +316 -0
  4. package/docs/index.md +18 -85
  5. package/docs/sos/browser.md +210 -0
  6. package/docs/sos/command.md +68 -0
  7. package/docs/sos/debug.md +25 -0
  8. package/docs/sos/deviceInfo.md +49 -0
  9. package/docs/sos/display.md +21 -0
  10. package/docs/sos/fileSystem.md +594 -0
  11. package/docs/sos/hardware/barcodeScanner.md +40 -0
  12. package/docs/sos/hardware/index.md +64 -0
  13. package/docs/sos/hardware/led.md +14 -0
  14. package/docs/sos/index.md +82 -0
  15. package/docs/sos/input.md +73 -0
  16. package/docs/sos/monitors.md +21 -0
  17. package/docs/sos/native/index.md +5 -0
  18. package/docs/sos/native/mdc.md +240 -0
  19. package/docs/sos/offline/cache.md +183 -0
  20. package/docs/sos/offline/index.md +188 -0
  21. package/docs/sos/osd.md +13 -0
  22. package/docs/sos/proofOfPlay.md +37 -0
  23. package/docs/sos/stream.md +960 -0
  24. package/docs/sos/sync.md +298 -0
  25. package/docs/sos/video.md +285 -0
  26. package/docs/sos_management/app.md +102 -0
  27. package/docs/sos_management/audio.md +29 -0
  28. package/docs/sos_management/debug.md +33 -0
  29. package/docs/sos_management/firmware.md +86 -0
  30. package/docs/sos_management/index.md +212 -0
  31. package/docs/sos_management/network.md +197 -0
  32. package/docs/sos_management/os.md +54 -0
  33. package/docs/sos_management/package.md +33 -0
  34. package/docs/sos_management/power.md +136 -0
  35. package/docs/sos_management/proxy.md +41 -0
  36. package/docs/sos_management/remoteControl.md +72 -0
  37. package/docs/sos_management/screen.md +198 -0
  38. package/docs/sos_management/security.md +47 -0
  39. package/docs/sos_management/time.md +101 -0
  40. package/docs/sos_management/wifi.md +366 -0
  41. package/es6/FrontApplet/Browser/Browser.d.ts +61 -8
  42. package/es6/FrontApplet/Browser/Browser.js +92 -40
  43. package/es6/FrontApplet/Browser/Browser.js.map +1 -1
  44. package/es6/FrontApplet/Browser/IOpenLinkOptions.d.ts +2 -2
  45. package/es6/FrontApplet/Browser/events.d.ts +1 -1
  46. package/es6/FrontApplet/Browser/events.js +2 -2
  47. package/es6/FrontApplet/Browser/events.js.map +1 -1
  48. package/es6/FrontApplet/Browser/messages.d.ts +2 -2
  49. package/es6/FrontApplet/Command/Command.d.ts +37 -3
  50. package/es6/FrontApplet/Command/Command.js +52 -23
  51. package/es6/FrontApplet/Command/Command.js.map +1 -1
  52. package/es6/FrontApplet/Command/ICommandEvent.d.ts +6 -2
  53. package/es6/FrontApplet/Connect/Connect.d.ts +19 -0
  54. package/es6/FrontApplet/Connect/Connect.js +162 -0
  55. package/es6/FrontApplet/Connect/Connect.js.map +1 -0
  56. package/es6/FrontApplet/Connect/IConnectMessage.d.ts +4 -0
  57. package/es6/FrontApplet/{Stream/streamListeners.js → Connect/IConnectMessage.js} +1 -1
  58. package/es6/FrontApplet/Connect/IConnectMessage.js.map +1 -0
  59. package/es6/FrontApplet/Debug/Debug.d.ts +15 -1
  60. package/es6/FrontApplet/Debug/Debug.js +28 -18
  61. package/es6/FrontApplet/Debug/Debug.js.map +1 -1
  62. package/es6/FrontApplet/Debug/debugDecorator.d.ts +3 -3
  63. package/es6/FrontApplet/Debug/debugDecorator.js +15 -9
  64. package/es6/FrontApplet/Debug/debugDecorator.js.map +1 -1
  65. package/es6/FrontApplet/DeviceInfo/DeviceInfo.d.ts +23 -0
  66. package/es6/FrontApplet/DeviceInfo/DeviceInfo.js +36 -27
  67. package/es6/FrontApplet/DeviceInfo/DeviceInfo.js.map +1 -1
  68. package/es6/FrontApplet/Dimensions/coordinationsHelper.js +1 -2
  69. package/es6/FrontApplet/Dimensions/coordinationsHelper.js.map +1 -1
  70. package/es6/FrontApplet/Display/Display.d.ts +25 -3
  71. package/es6/FrontApplet/Display/Display.js +35 -19
  72. package/es6/FrontApplet/Display/Display.js.map +1 -1
  73. package/es6/FrontApplet/Display/IDisplay.d.ts +3 -1
  74. package/es6/FrontApplet/Error/AppletCommandError.js +12 -3
  75. package/es6/FrontApplet/Error/AppletCommandError.js.map +1 -1
  76. package/es6/FrontApplet/Error/AppletError.js +10 -2
  77. package/es6/FrontApplet/Error/AppletError.js.map +1 -1
  78. package/es6/FrontApplet/Error/AppletHardwareError.js +12 -3
  79. package/es6/FrontApplet/Error/AppletHardwareError.js.map +1 -1
  80. package/es6/FrontApplet/Error/AppletOfflineCacheError.js +10 -2
  81. package/es6/FrontApplet/Error/AppletOfflineCacheError.js.map +1 -1
  82. package/es6/FrontApplet/Error/AppletResourcesError.js +12 -3
  83. package/es6/FrontApplet/Error/AppletResourcesError.js.map +1 -1
  84. package/es6/FrontApplet/Error/AppletSecurityError.js +12 -3
  85. package/es6/FrontApplet/Error/AppletSecurityError.js.map +1 -1
  86. package/es6/FrontApplet/Error/AppletStreamError.js +10 -2
  87. package/es6/FrontApplet/Error/AppletStreamError.js.map +1 -1
  88. package/es6/FrontApplet/Error/AppletVideoError.js +12 -3
  89. package/es6/FrontApplet/Error/AppletVideoError.js.map +1 -1
  90. package/es6/FrontApplet/Error/ErrorCodesMessages.js +4 -1
  91. package/es6/FrontApplet/Error/ErrorCodesMessages.js.map +1 -1
  92. package/es6/FrontApplet/Error/ErrorSuggestions.js +1 -0
  93. package/es6/FrontApplet/Error/ErrorSuggestions.js.map +1 -1
  94. package/es6/FrontApplet/Error/FileNotFoundError.js +10 -2
  95. package/es6/FrontApplet/Error/FileNotFoundError.js.map +1 -1
  96. package/es6/FrontApplet/Error/SosError.js +5 -1
  97. package/es6/FrontApplet/Error/SosError.js.map +1 -1
  98. package/es6/FrontApplet/Error/errorHelper.js +5 -6
  99. package/es6/FrontApplet/Error/errorHelper.js.map +1 -1
  100. package/es6/FrontApplet/Exchange/Exchange.js +7 -14
  101. package/es6/FrontApplet/Exchange/Exchange.js.map +1 -1
  102. package/es6/FrontApplet/FileSystem/FileSystem.d.ts +156 -1
  103. package/es6/FrontApplet/FileSystem/FileSystem.js +318 -195
  104. package/es6/FrontApplet/FileSystem/FileSystem.js.map +1 -1
  105. package/es6/FrontApplet/FileSystem/HashAlgorithm.d.ts +2 -0
  106. package/es6/FrontApplet/{Input/IKeyUpEventListener.js → FileSystem/HashAlgorithm.js} +1 -1
  107. package/es6/FrontApplet/FileSystem/HashAlgorithm.js.map +1 -0
  108. package/es6/FrontApplet/Font/fontFaceGenerator.js.map +1 -1
  109. package/es6/FrontApplet/FrontApplet.d.ts +57 -4
  110. package/es6/FrontApplet/FrontApplet.js +129 -49
  111. package/es6/FrontApplet/FrontApplet.js.map +1 -1
  112. package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.d.ts +2 -0
  113. package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.js +35 -54
  114. package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.js.map +1 -1
  115. package/es6/FrontApplet/Hardware/Hardware.d.ts +16 -2
  116. package/es6/FrontApplet/Hardware/Hardware.js +31 -19
  117. package/es6/FrontApplet/Hardware/Hardware.js.map +1 -1
  118. package/es6/FrontApplet/Hardware/IHardware.d.ts +2 -2
  119. package/es6/FrontApplet/Hardware/ISerialPort.d.ts +16 -0
  120. package/es6/FrontApplet/Hardware/ISerialPortOptions.js +1 -1
  121. package/es6/FrontApplet/Hardware/ISerialPortOptions.js.map +1 -1
  122. package/es6/FrontApplet/Hardware/Led/Led.d.ts +8 -0
  123. package/es6/FrontApplet/Hardware/Led/Led.js +22 -20
  124. package/es6/FrontApplet/Hardware/Led/Led.js.map +1 -1
  125. package/es6/FrontApplet/Hardware/SerialPort.d.ts +1 -1
  126. package/es6/FrontApplet/Hardware/SerialPort.js +15 -23
  127. package/es6/FrontApplet/Hardware/SerialPort.js.map +1 -1
  128. package/es6/FrontApplet/Hash/generator.js +2 -3
  129. package/es6/FrontApplet/Hash/generator.js.map +1 -1
  130. package/es6/FrontApplet/Iframe/Iframe.d.ts +9 -8
  131. package/es6/FrontApplet/Iframe/Iframe.js +10 -0
  132. package/es6/FrontApplet/Iframe/Iframe.js.map +1 -1
  133. package/es6/FrontApplet/Input/IInput.d.ts +1 -2
  134. package/es6/FrontApplet/Input/IKeyUpEvent.d.ts +32 -2
  135. package/es6/FrontApplet/Input/IKeyUpEvent.js +32 -0
  136. package/es6/FrontApplet/Input/IKeyUpEvent.js.map +1 -1
  137. package/es6/FrontApplet/Input/Input.d.ts +19 -3
  138. package/es6/FrontApplet/Input/Input.js +44 -23
  139. package/es6/FrontApplet/Input/Input.js.map +1 -1
  140. package/es6/FrontApplet/Management/App/App.d.ts +48 -10
  141. package/es6/FrontApplet/Management/App/App.js +45 -30
  142. package/es6/FrontApplet/Management/App/App.js.map +1 -1
  143. package/es6/FrontApplet/Management/App/IApp.d.ts +3 -1
  144. package/es6/FrontApplet/Management/Audio/Audio.d.ts +16 -0
  145. package/es6/FrontApplet/Management/Audio/Audio.js +30 -22
  146. package/es6/FrontApplet/Management/Audio/Audio.js.map +1 -1
  147. package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.d.ts +4 -0
  148. package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.js +15 -22
  149. package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.js.map +1 -1
  150. package/es6/FrontApplet/Management/AutoRecovery/IAutoRecovery.d.ts +1 -1
  151. package/es6/FrontApplet/Management/AutoRecovery/IAutoRecovery.js +5 -2
  152. package/es6/FrontApplet/Management/AutoRecovery/IAutoRecovery.js.map +1 -1
  153. package/es6/FrontApplet/Management/Debug/Debug.d.ts +19 -0
  154. package/es6/FrontApplet/Management/Debug/Debug.js +37 -30
  155. package/es6/FrontApplet/Management/Debug/Debug.js.map +1 -1
  156. package/es6/FrontApplet/Management/Firmware/Firmware.d.ts +37 -10
  157. package/es6/FrontApplet/Management/Firmware/Firmware.js +34 -30
  158. package/es6/FrontApplet/Management/Firmware/Firmware.js.map +1 -1
  159. package/es6/FrontApplet/Management/Firmware/IFirmware.d.ts +1 -2
  160. package/es6/FrontApplet/Management/IManagement.d.ts +3 -1
  161. package/es6/FrontApplet/Management/Management.d.ts +106 -15
  162. package/es6/FrontApplet/Management/Management.js +191 -113
  163. package/es6/FrontApplet/Management/Management.js.map +1 -1
  164. package/es6/FrontApplet/Management/Network/INetworkInfo.d.ts +2 -2
  165. package/es6/FrontApplet/Management/Network/Network.d.ts +56 -8
  166. package/es6/FrontApplet/Management/Network/Network.js +86 -68
  167. package/es6/FrontApplet/Management/Network/Network.js.map +1 -1
  168. package/es6/FrontApplet/Management/OS/OS.d.ts +20 -0
  169. package/es6/FrontApplet/Management/OS/OS.js +34 -27
  170. package/es6/FrontApplet/Management/OS/OS.js.map +1 -1
  171. package/es6/FrontApplet/Management/Package/Package.d.ts +20 -0
  172. package/es6/FrontApplet/Management/Package/Package.js +37 -22
  173. package/es6/FrontApplet/Management/Package/Package.js.map +1 -1
  174. package/es6/FrontApplet/Management/PeerRecovery/IPeerRecovery.d.ts +1 -1
  175. package/es6/FrontApplet/Management/PeerRecovery/IPeerRecovery.js +5 -2
  176. package/es6/FrontApplet/Management/PeerRecovery/IPeerRecovery.js.map +1 -1
  177. package/es6/FrontApplet/Management/PeerRecovery/PeerRecovery.d.ts +4 -0
  178. package/es6/FrontApplet/Management/PeerRecovery/PeerRecovery.js +15 -22
  179. package/es6/FrontApplet/Management/PeerRecovery/PeerRecovery.js.map +1 -1
  180. package/es6/FrontApplet/Management/Power/Power.d.ts +64 -0
  181. package/es6/FrontApplet/Management/Power/Power.js +160 -115
  182. package/es6/FrontApplet/Management/Power/Power.js.map +1 -1
  183. package/es6/FrontApplet/Management/Proxy/Proxy.d.ts +21 -0
  184. package/es6/FrontApplet/Management/Proxy/Proxy.js +41 -35
  185. package/es6/FrontApplet/Management/Proxy/Proxy.js.map +1 -1
  186. package/es6/FrontApplet/Management/RemoteControl/RemoteControl.d.ts +43 -0
  187. package/es6/FrontApplet/Management/RemoteControl/RemoteControl.js +63 -39
  188. package/es6/FrontApplet/Management/RemoteControl/RemoteControl.js.map +1 -1
  189. package/es6/FrontApplet/Management/Screen/IOrientation.d.ts +1 -1
  190. package/es6/FrontApplet/Management/Screen/Screen.d.ts +127 -0
  191. package/es6/FrontApplet/Management/Screen/Screen.js +197 -89
  192. package/es6/FrontApplet/Management/Screen/Screen.js.map +1 -1
  193. package/es6/FrontApplet/Management/Security/Security.d.ts +20 -5
  194. package/es6/FrontApplet/Management/Security/Security.js +33 -31
  195. package/es6/FrontApplet/Management/Security/Security.js.map +1 -1
  196. package/es6/FrontApplet/Management/Time/Time.d.ts +31 -5
  197. package/es6/FrontApplet/Management/Time/Time.js +49 -40
  198. package/es6/FrontApplet/Management/Time/Time.js.map +1 -1
  199. package/es6/FrontApplet/Management/Wifi/IWifiEvent.d.ts +19 -1
  200. package/es6/FrontApplet/Management/Wifi/IWifiEvent.js +19 -1
  201. package/es6/FrontApplet/Management/Wifi/IWifiEvent.js.map +1 -1
  202. package/es6/FrontApplet/Management/Wifi/Wifi.d.ts +108 -7
  203. package/es6/FrontApplet/Management/Wifi/Wifi.js +162 -86
  204. package/es6/FrontApplet/Management/Wifi/Wifi.js.map +1 -1
  205. package/es6/FrontApplet/Management/helpers/DeviceHelper.js +2 -2
  206. package/es6/FrontApplet/Management/helpers/DeviceHelper.js.map +1 -1
  207. package/es6/FrontApplet/Management/helpers/ProprietaryTimerHelper.d.ts +1 -1
  208. package/es6/FrontApplet/Management/helpers/SecurityHelper.js +8 -6
  209. package/es6/FrontApplet/Management/helpers/SecurityHelper.js.map +1 -1
  210. package/es6/FrontApplet/Management/helpers/TimerHelper.js +2 -2
  211. package/es6/FrontApplet/Management/helpers/TimerHelper.js.map +1 -1
  212. package/es6/FrontApplet/Management/helpers/UpgradeHelper.js +35 -3
  213. package/es6/FrontApplet/Management/helpers/UpgradeHelper.js.map +1 -1
  214. package/es6/FrontApplet/Management/helpers/VideoHelper.js +1 -1
  215. package/es6/FrontApplet/Management/helpers/VideoHelper.js.map +1 -1
  216. package/es6/FrontApplet/Monitors/Monitors.d.ts +9 -0
  217. package/es6/FrontApplet/Monitors/Monitors.js +16 -16
  218. package/es6/FrontApplet/Monitors/Monitors.js.map +1 -1
  219. package/es6/FrontApplet/NativeCommands/MDC/CodesMDC.js +1 -1
  220. package/es6/FrontApplet/NativeCommands/MDC/CodesMDC.js.map +1 -1
  221. package/es6/FrontApplet/NativeCommands/MDC/Mdc.d.ts +52 -3
  222. package/es6/FrontApplet/NativeCommands/MDC/Mdc.js +79 -38
  223. package/es6/FrontApplet/NativeCommands/MDC/Mdc.js.map +1 -1
  224. package/es6/FrontApplet/NativeCommands/NativeCommands.d.ts +4 -0
  225. package/es6/FrontApplet/NativeCommands/NativeCommands.js +12 -2
  226. package/es6/FrontApplet/NativeCommands/NativeCommands.js.map +1 -1
  227. package/es6/FrontApplet/OSD/OSD.d.ts +9 -0
  228. package/es6/FrontApplet/OSD/OSD.js +15 -15
  229. package/es6/FrontApplet/OSD/OSD.js.map +1 -1
  230. package/es6/FrontApplet/Offline/Cache/Cache.d.ts +91 -2
  231. package/es6/FrontApplet/Offline/Cache/Cache.js +193 -131
  232. package/es6/FrontApplet/Offline/Cache/Cache.js.map +1 -1
  233. package/es6/FrontApplet/Offline/Flags/AppendFlagController.d.ts +1 -1
  234. package/es6/FrontApplet/Offline/Flags/AppendFlagController.js +18 -26
  235. package/es6/FrontApplet/Offline/Flags/AppendFlagController.js.map +1 -1
  236. package/es6/FrontApplet/Offline/Flags/IFlags.d.ts +5 -5
  237. package/es6/FrontApplet/Offline/IAddFont.d.ts +3 -1
  238. package/es6/FrontApplet/Offline/IAddFont.js.map +1 -1
  239. package/es6/FrontApplet/Offline/IFileType.d.ts +1 -1
  240. package/es6/FrontApplet/Offline/ISaveFile.js +5 -2
  241. package/es6/FrontApplet/Offline/ISaveFile.js.map +1 -1
  242. package/es6/FrontApplet/Offline/LoadFile/CssLoadFileController.js +2 -1
  243. package/es6/FrontApplet/Offline/LoadFile/CssLoadFileController.js.map +1 -1
  244. package/es6/FrontApplet/Offline/LoadFile/JavascriptLoadFileController.js +2 -1
  245. package/es6/FrontApplet/Offline/LoadFile/JavascriptLoadFileController.js.map +1 -1
  246. package/es6/FrontApplet/Offline/Offline.d.ts +79 -8
  247. package/es6/FrontApplet/Offline/Offline.js +119 -59
  248. package/es6/FrontApplet/Offline/Offline.js.map +1 -1
  249. package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.d.ts +19 -1
  250. package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.js +41 -29
  251. package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.js.map +1 -1
  252. package/es6/FrontApplet/Sensors/Proximity.d.ts +4 -3
  253. package/es6/FrontApplet/Sensors/Proximity.js +13 -5
  254. package/es6/FrontApplet/Sensors/Proximity.js.map +1 -1
  255. package/es6/FrontApplet/Sensors/Sensors.d.ts +3 -1
  256. package/es6/FrontApplet/Sensors/Sensors.js +9 -2
  257. package/es6/FrontApplet/Sensors/Sensors.js.map +1 -1
  258. package/es6/FrontApplet/Stream/IStream.d.ts +10 -10
  259. package/es6/FrontApplet/Stream/IStreamMessage.d.ts +1 -1
  260. package/es6/FrontApplet/Stream/IStreamTrackInfo.d.ts +2 -2
  261. package/es6/FrontApplet/Stream/Stream.d.ts +130 -15
  262. package/es6/FrontApplet/Stream/Stream.js +262 -163
  263. package/es6/FrontApplet/Stream/Stream.js.map +1 -1
  264. package/es6/FrontApplet/Stream/StreamProtocol.js.map +1 -1
  265. package/es6/FrontApplet/Stream/streamEvents.d.ts +1 -1
  266. package/es6/FrontApplet/Sync/Sync.d.ts +152 -6
  267. package/es6/FrontApplet/Sync/Sync.js +199 -115
  268. package/es6/FrontApplet/Sync/Sync.js.map +1 -1
  269. package/es6/FrontApplet/Sync/syncEvents.d.ts +3 -1
  270. package/es6/FrontApplet/Sync/syncMessages.js +1 -1
  271. package/es6/FrontApplet/Sync/syncMessages.js.map +1 -1
  272. package/es6/FrontApplet/Timing/Timing.d.ts +1 -0
  273. package/es6/FrontApplet/Timing/Timing.js +9 -2
  274. package/es6/FrontApplet/Timing/Timing.js.map +1 -1
  275. package/es6/FrontApplet/Timing/Triggers/ITimingTriggersMessage.d.ts +1 -1
  276. package/es6/FrontApplet/Timing/Triggers/Triggers.d.ts +9 -0
  277. package/es6/FrontApplet/Timing/Triggers/Triggers.js +16 -18
  278. package/es6/FrontApplet/Timing/Triggers/Triggers.js.map +1 -1
  279. package/es6/FrontApplet/Touch/Touch.d.ts +3 -0
  280. package/es6/FrontApplet/Touch/Touch.js +13 -3
  281. package/es6/FrontApplet/Touch/Touch.js.map +1 -1
  282. package/es6/FrontApplet/Validate/Validate.d.ts +5 -5
  283. package/es6/FrontApplet/Validate/Validate.js +27 -24
  284. package/es6/FrontApplet/Validate/Validate.js.map +1 -1
  285. package/es6/FrontApplet/Validate/ValidateObjectInterface.js +7 -2
  286. package/es6/FrontApplet/Validate/ValidateObjectInterface.js.map +1 -1
  287. package/es6/FrontApplet/Video/IOptions.d.ts +8 -1
  288. package/es6/FrontApplet/Video/IVideo.d.ts +8 -8
  289. package/es6/FrontApplet/Video/IVideoEvent.d.ts +1 -1
  290. package/es6/FrontApplet/Video/IVideoEvent.js +3 -3
  291. package/es6/FrontApplet/Video/IVideoEvent.js.map +1 -1
  292. package/es6/FrontApplet/Video/IVideoMessage.d.ts +1 -1
  293. package/es6/FrontApplet/Video/Video.d.ts +84 -12
  294. package/es6/FrontApplet/Video/Video.js +196 -137
  295. package/es6/FrontApplet/Video/Video.js.map +1 -1
  296. package/es6/FrontApplet/createFrontApplet.js +5 -2
  297. package/es6/FrontApplet/createFrontApplet.js.map +1 -1
  298. package/es6/Monitoring/Console/consoleCommands.d.ts +1 -1
  299. package/es6/Monitoring/Display/displayCommands.d.ts +1 -1
  300. package/es6/Monitoring/Display/handleDisplayRequests.d.ts +2 -2
  301. package/es6/Monitoring/Display/handleDisplayRequests.js +5 -15
  302. package/es6/Monitoring/Display/handleDisplayRequests.js.map +1 -1
  303. package/es6/Monitoring/EmptyObject.d.ts +1 -1
  304. package/es6/Monitoring/FileSystem/fileSystemCommands.d.ts +10 -1
  305. package/es6/Monitoring/FileSystem/fileSystemCommands.js +3 -1
  306. package/es6/Monitoring/FileSystem/fileSystemCommands.js.map +1 -1
  307. package/es6/Monitoring/FileSystem/handleFileSystemRequests.d.ts +2 -2
  308. package/es6/Monitoring/FileSystem/handleFileSystemRequests.js +41 -45
  309. package/es6/Monitoring/FileSystem/handleFileSystemRequests.js.map +1 -1
  310. package/es6/Monitoring/Html/handleHtmlSnapshotTakingRequests.d.ts +2 -2
  311. package/es6/Monitoring/Html/handleHtmlSnapshotTakingRequests.js +4 -14
  312. package/es6/Monitoring/Html/handleHtmlSnapshotTakingRequests.js.map +1 -1
  313. package/es6/Monitoring/Management/App/applicationCommands.d.ts +1 -1
  314. package/es6/Monitoring/Management/App/handleApplicationRequests.d.ts +2 -2
  315. package/es6/Monitoring/Management/App/handleApplicationRequests.js +9 -19
  316. package/es6/Monitoring/Management/App/handleApplicationRequests.js.map +1 -1
  317. package/es6/Monitoring/Management/Audio/audioCommands.d.ts +1 -1
  318. package/es6/Monitoring/Management/Audio/handleAudioRequests.d.ts +2 -2
  319. package/es6/Monitoring/Management/Audio/handleAudioRequests.js +7 -17
  320. package/es6/Monitoring/Management/Audio/handleAudioRequests.js.map +1 -1
  321. package/es6/Monitoring/Management/AutoRecovery/autoRecoveryCommands.d.ts +1 -1
  322. package/es6/Monitoring/Management/AutoRecovery/handleAutoRecoveryRequests.d.ts +2 -2
  323. package/es6/Monitoring/Management/AutoRecovery/handleAutoRecoveryRequests.js +7 -17
  324. package/es6/Monitoring/Management/AutoRecovery/handleAutoRecoveryRequests.js.map +1 -1
  325. package/es6/Monitoring/Management/Debug/debugCommands.d.ts +1 -1
  326. package/es6/Monitoring/Management/Debug/handleDebugRequests.d.ts +2 -2
  327. package/es6/Monitoring/Management/Debug/handleDebugRequests.js +9 -19
  328. package/es6/Monitoring/Management/Debug/handleDebugRequests.js.map +1 -1
  329. package/es6/Monitoring/Management/Network/handleManagementNetworkRequests.d.ts +2 -2
  330. package/es6/Monitoring/Management/Network/handleManagementNetworkRequests.js +11 -21
  331. package/es6/Monitoring/Management/Network/handleManagementNetworkRequests.js.map +1 -1
  332. package/es6/Monitoring/Management/Network/managementNetworkCommands.d.ts +1 -1
  333. package/es6/Monitoring/Management/Os/managementOsRequests.d.ts +2 -2
  334. package/es6/Monitoring/Management/Os/managementOsRequests.js +9 -19
  335. package/es6/Monitoring/Management/Os/managementOsRequests.js.map +1 -1
  336. package/es6/Monitoring/Management/Os/osCommands.d.ts +1 -1
  337. package/es6/Monitoring/Management/PeerRecovery/handlePeerRecoveryRequests.d.ts +2 -2
  338. package/es6/Monitoring/Management/PeerRecovery/handlePeerRecoveryRequests.js +7 -17
  339. package/es6/Monitoring/Management/PeerRecovery/handlePeerRecoveryRequests.js.map +1 -1
  340. package/es6/Monitoring/Management/PeerRecovery/peerRecoveryCommands.d.ts +1 -1
  341. package/es6/Monitoring/Management/Power/handlePowerRequests.d.ts +2 -2
  342. package/es6/Monitoring/Management/Power/handlePowerRequests.js +19 -29
  343. package/es6/Monitoring/Management/Power/handlePowerRequests.js.map +1 -1
  344. package/es6/Monitoring/Management/Power/powerCommands.d.ts +1 -1
  345. package/es6/Monitoring/Management/RemoteControl/handleRemoteControlRequests.d.ts +2 -2
  346. package/es6/Monitoring/Management/RemoteControl/handleRemoteControlRequests.js +15 -25
  347. package/es6/Monitoring/Management/RemoteControl/handleRemoteControlRequests.js.map +1 -1
  348. package/es6/Monitoring/Management/RemoteControl/remoteControlCommands.d.ts +1 -1
  349. package/es6/Monitoring/Management/Screen/handleScreenRequests.d.ts +2 -2
  350. package/es6/Monitoring/Management/Screen/handleScreenRequests.js +19 -29
  351. package/es6/Monitoring/Management/Screen/handleScreenRequests.js.map +1 -1
  352. package/es6/Monitoring/Management/Screen/screenCommands.d.ts +1 -1
  353. package/es6/Monitoring/Management/Security/handleSecurityCommands.d.ts +2 -2
  354. package/es6/Monitoring/Management/Security/handleSecurityCommands.js +9 -19
  355. package/es6/Monitoring/Management/Security/handleSecurityCommands.js.map +1 -1
  356. package/es6/Monitoring/Management/Security/securityCommands.d.ts +1 -1
  357. package/es6/Monitoring/Management/Time/handleTimeCommands.d.ts +2 -2
  358. package/es6/Monitoring/Management/Time/handleTimeCommands.js +9 -19
  359. package/es6/Monitoring/Management/Time/handleTimeCommands.js.map +1 -1
  360. package/es6/Monitoring/Management/Time/timeCommands.d.ts +1 -1
  361. package/es6/Monitoring/Management/handleManagementRequests.d.ts +2 -2
  362. package/es6/Monitoring/Management/handleManagementRequests.js +23 -33
  363. package/es6/Monitoring/Management/handleManagementRequests.js.map +1 -1
  364. package/es6/Monitoring/Management/managementCommands.d.ts +1 -1
  365. package/es6/Monitoring/{Montoring.d.ts → Monitoring.d.ts} +1 -0
  366. package/es6/Monitoring/Monitoring.js +83 -0
  367. package/es6/Monitoring/Monitoring.js.map +1 -0
  368. package/es6/Monitoring/NativeCommands/handleNativeCommands.d.ts +2 -2
  369. package/es6/Monitoring/NativeCommands/handleNativeCommands.js +5 -15
  370. package/es6/Monitoring/NativeCommands/handleNativeCommands.js.map +1 -1
  371. package/es6/Monitoring/NativeCommands/nativeMdcCommands.d.ts +1 -1
  372. package/es6/Monitoring/OSD/handleOsdRequests.d.ts +2 -2
  373. package/es6/Monitoring/OSD/handleOsdRequests.js +5 -15
  374. package/es6/Monitoring/OSD/handleOsdRequests.js.map +1 -1
  375. package/es6/Monitoring/Offline/Cache/handleOfflineCacheRequests.d.ts +2 -2
  376. package/es6/Monitoring/Offline/Cache/handleOfflineCacheRequests.js +23 -33
  377. package/es6/Monitoring/Offline/Cache/handleOfflineCacheRequests.js.map +1 -1
  378. package/es6/Monitoring/Video/handleVideoRequests.d.ts +2 -2
  379. package/es6/Monitoring/Video/handleVideoRequests.js +36 -9
  380. package/es6/Monitoring/Video/handleVideoRequests.js.map +1 -1
  381. package/es6/Monitoring/handleMonitoringRequests.d.ts +2 -2
  382. package/es6/Monitoring/handleMonitoringRequests.js +6 -16
  383. package/es6/Monitoring/handleMonitoringRequests.js.map +1 -1
  384. package/es6/Monitoring/monitoringCommands.d.ts +1 -1
  385. package/es6/Sensors/IButton.js +1 -1
  386. package/es6/Sensors/IButton.js.map +1 -1
  387. package/es6/Sensors/IRfidAntenna.d.ts +1 -1
  388. package/es6/Sensors/IRfidAntenna.js +1 -1
  389. package/es6/Sensors/IRfidAntenna.js.map +1 -1
  390. package/es6/Util/Console/enhancer.d.ts +11 -0
  391. package/es6/Util/Console/enhancer.js +23 -0
  392. package/es6/Util/Console/enhancer.js.map +1 -0
  393. package/es6/bundle.d.ts +1 -1
  394. package/es6/bundle.js +12 -5
  395. package/es6/bundle.js.map +1 -1
  396. package/es6/fpath.d.ts +1 -1
  397. package/es6/fpath.js +34 -1
  398. package/es6/fpath.js.map +1 -1
  399. package/es6/utils/types.d.ts +1 -0
  400. package/es6/{FrontApplet/Video/IVideoEventListener.js → utils/types.js} +1 -1
  401. package/es6/utils/types.js.map +1 -0
  402. package/package.json +28 -26
  403. package/CHANGELOG.md +0 -480
  404. package/docs/applet-basics.md +0 -272
  405. package/docs/content/js-applet-resources.md +0 -154
  406. package/docs/content/js-browser.md +0 -163
  407. package/docs/content/js-command.md +0 -154
  408. package/docs/content/js-debug.md +0 -36
  409. package/docs/content/js-device-info.md +0 -56
  410. package/docs/content/js-display.md +0 -56
  411. package/docs/content/js-file-system.md +0 -670
  412. package/docs/content/js-fonts.md +0 -115
  413. package/docs/content/js-hardware.md +0 -55
  414. package/docs/content/js-iframes.md +0 -66
  415. package/docs/content/js-input.md +0 -71
  416. package/docs/content/js-offline-cache-media-files.md +0 -257
  417. package/docs/content/js-offline-cache-simple-data.md +0 -129
  418. package/docs/content/js-osd.md +0 -32
  419. package/docs/content/js-proof-of-play.md +0 -60
  420. package/docs/content/js-sensors.md +0 -70
  421. package/docs/content/js-serial.md +0 -165
  422. package/docs/content/js-sync-playback.md +0 -384
  423. package/docs/content/js-video-inputs-internal-ports.md +0 -131
  424. package/docs/content/js-video-stream.md +0 -618
  425. package/docs/content/js-video.md +0 -232
  426. package/docs/management/js-management-application.md +0 -107
  427. package/docs/management/js-management-audio.md +0 -44
  428. package/docs/management/js-management-debug.md +0 -40
  429. package/docs/management/js-management-firmware.md +0 -93
  430. package/docs/management/js-management-management.md +0 -178
  431. package/docs/management/js-management-monitoring-commands.md +0 -107
  432. package/docs/management/js-management-monitors.md +0 -55
  433. package/docs/management/js-management-native-commands-mdc.md +0 -90
  434. package/docs/management/js-management-network.md +0 -223
  435. package/docs/management/js-management-os.md +0 -62
  436. package/docs/management/js-management-package.md +0 -48
  437. package/docs/management/js-management-power.md +0 -175
  438. package/docs/management/js-management-proxy.md +0 -81
  439. package/docs/management/js-management-remote-control.md +0 -58
  440. package/docs/management/js-management-screen.md +0 -225
  441. package/docs/management/js-management-security.md +0 -71
  442. package/docs/management/js-management-time.md +0 -161
  443. package/docs/management/js-management-wifi.md +0 -341
  444. package/es6/FrontApplet/Command/ICommandEventListener.d.ts +0 -6
  445. package/es6/FrontApplet/Command/ICommandEventListener.js +0 -3
  446. package/es6/FrontApplet/Command/ICommandEventListener.js.map +0 -1
  447. package/es6/FrontApplet/Input/IKeyUpEventListener.d.ts +0 -5
  448. package/es6/FrontApplet/Input/IKeyUpEventListener.js.map +0 -1
  449. package/es6/FrontApplet/Management/Firmware/FirmwareType.d.ts +0 -4
  450. package/es6/FrontApplet/Management/Firmware/FirmwareType.js +0 -9
  451. package/es6/FrontApplet/Management/Firmware/FirmwareType.js.map +0 -1
  452. package/es6/FrontApplet/Stream/streamListeners.d.ts +0 -10
  453. package/es6/FrontApplet/Stream/streamListeners.js.map +0 -1
  454. package/es6/FrontApplet/Video/IVideoEventListener.d.ts +0 -5
  455. package/es6/FrontApplet/Video/IVideoEventListener.js.map +0 -1
  456. package/es6/Monitoring/Montoring.js +0 -131
  457. package/es6/Monitoring/Montoring.js.map +0 -1
@@ -1,232 +0,0 @@
1
- ---
2
- title: Video Playback
3
- author: Miroslav Behina
4
- date: 22.11.2018
5
- type: js-api
6
- tags:
7
- - applet
8
- - applet_api
9
- - api
10
- - js_api
11
- description: "[Content JS API] We know how crucial video is for digital signage. So we made it easy. There are several methods you can use for video manipulation."
12
- ---
13
-
14
- # Video Playback
15
- We know how crucial video is for digital signage. So we made it easy. There are several methods you can use for video manipulation.
16
-
17
- ## All methods/events
18
-
19
- | Methods/Events | Description | Supported since |
20
- | ----------------- | ----------- | :---------------: |
21
- | `play()` | Start video playing | 1.0.3 |
22
- | `prepare()` | Prepare next video | 1.0.3 |
23
- | `pause()` | Pause video | 1.0.3 |
24
- | `stop()` | Completely stop video | 1.0.3 |
25
- | `resume()` | Continue in playing | 1.0.3 |
26
- | `onceEnded()` | Wait until video ends | 1.0.29 |
27
- | `onEnded()` | Event called when video ends | 1.0.3 |
28
- | `onError()` | Event called when video emits error | 1.0.3 |
29
-
30
- :::warning
31
- First 5 parameters (uri, x, y, width, height) are unique identifiers for playing the video using play, stop, resume and pause methods.
32
- :::
33
-
34
- :::info
35
- If you want to play video in full screen mode, use x = y = 0 and width = document.documentElement.clientWidth and height = document.documentElement.clientHeight as setup parameters.
36
- :::
37
-
38
- ## How it works
39
- ![Gapless video playback lifecycle](https://docs.signageos.io/hc/article_attachments/9093558407708)
40
-
41
-
42
- ## play()
43
- Play method calls the internal player and starts the video in correct position.
44
-
45
- ### Parameters
46
-
47
- | Param | Type | Required | Description |
48
- | ------ | ------ | :--------: | -------- |
49
- | `uri` | String | <div class="red">Yes</div> | Address to remote (online) or local video file |
50
- | `x` | Number | <div class="red">Yes</div> | x-position for video on screen |
51
- | `y` | Number | <div class="red">Yes</div> | y-position for video on screen |
52
- | `width` | Number | <div class="red">Yes</div> | Video width on screen |
53
- | `height` | Number | <div class="red">Yes</div> | Video height on screen
54
-
55
- ### Javascript
56
- ```javascript
57
- await sos.video.play(uri, x, y, width, height);
58
- ```
59
-
60
- :::note[GitHub Example]
61
- - [Play one video in infinite loop](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/video-loop-one)
62
- - [Play multiple videos in infinite loop](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/video-multiple)
63
- - [Switching video and images in infinite loop](https://github.com/signageos/applet-examples/blob/master/examples/content-js-api/video-and-images)
64
- :::
65
-
66
- ## prepare()
67
- Prepare method calls the internal player and preload the video into memory.
68
-
69
- :::info
70
- Using `prepare()` is mandatory for gapless playback
71
- :::
72
-
73
- :::warning
74
- `4k` parameter is no longer needed since Front-display v7.5.0, Tizen Core App v2.1.0.
75
- `volume` is supported only on the RaspberryPi.
76
- :::
77
-
78
- ### Parameters
79
-
80
- | Param | Type | Required | Description |
81
- | ------ | ------ | :--------: | -------- |
82
- | `uri` | String | <div class="red">Yes</div> | Address to remote /online/ or local video file |
83
- | `x` | Number | <div class="red">Yes</div> | x-position for video on screen |
84
- | `y` | Number | <div class="red">Yes</div> | y-position for video on screen |
85
- | `width` | Number | <div class="red">Yes</div> | Video width on screen |
86
- | `height` | Number | <div class="red">Yes</div> | Video height on screen |
87
- | `options` | Object | <div class="yellow">No</div> | Additional video properties
88
-
89
- ### Options properties
90
-
91
- | Property | Type | Required | Description |
92
- | ------- | ------ | :------:| -----------|
93
- | `4k` | Boolean | <div class="yellow">No</div> | Support for 4k video |
94
- |^^|^^|^^| Deprecated since Tizen Core App v2.1.0 |
95
- | `background` | Boolean | <div class="yellow">No</div> | Bring video behind the applet html (similar to z-index: -1) |
96
- | `volume` | Number | <div class="yellow">No</div> | Adjust volume of playing video itself (doesn't adjust display speaker volume) |
97
- |^^|^^|^^| Supported only on **RaspberryPi**
98
-
99
- ### Javascript
100
- ```javascript
101
- // playing video
102
- await sos.video.prepare(uri, x, y, width, height);
103
- // or advanced usage
104
- await sos.video.prepare(uri, x, y, width, height, {
105
- '4k': true,
106
- background: true,
107
- volume: 60,
108
- });
109
- ```
110
-
111
- ## stop(), pause() and resume()
112
- All these methods call the internal player. All variables are mandatory in order to ensure video identification.
113
-
114
- ### Parameters
115
-
116
- | Param | Type | Required | Description |
117
- | ------ | ------ | :--------: | -------- |
118
- | `uri` | String | <div class="red">Yes</div> | Address to remote (online) or local video file |
119
- | `x` | Number | <div class="red">Yes</div> | x-position for video on screen |
120
- | `y` | Number | <div class="red">Yes</div> | y-position for video on screen |
121
- | `width` | Number | <div class="red">Yes</div> | Video width on screen |
122
- | `height` | Number | <div class="red">Yes</div> | Video height on screen
123
-
124
- ### Javascript
125
- ```javascript
126
- // stop video
127
- await sos.video.stop(uri, x, y, width, height);
128
-
129
- // pause
130
- await sos.video.pause(uri, x, y, width, height);
131
-
132
- // resume
133
- await sos.video.resume(uri, x, y, width, height);
134
- ```
135
-
136
- ## Event onceEnded
137
- Wait until one specific video is ended.
138
-
139
- ### Parameters
140
-
141
- | Param | Type | Required | Description |
142
- | ------ | ------ | :--------: | -------- |
143
- | `uri` | String | <div class="red">Yes</div> | Address to remote (online) or local video file |
144
- | `x` | Number | <div class="red">Yes</div> | x-position for video on screen |
145
- | `y` | Number | <div class="red">Yes</div> | y-position for video on screen |
146
- | `width` | Number | <div class="red">Yes</div> | Video width on screen |
147
- | `height` | Number | <div class="red">Yes</div> | Video height on screen
148
-
149
- ### Javascript
150
- ```javascript
151
- // wai on end of video
152
- await sos.video.onceEnded(uri, x, y, width, height);
153
- ```
154
-
155
- ## Events onEnded, onError
156
- All events about played videos can be binded using above mentioned methods. It will emit all events of all playing videos. Video source of emited event can be identified by srcArguments object available in event.
157
-
158
- Listener method added as argument accepts event object. It contains these properties:
159
-
160
-
161
- | Property | Description |
162
- | ------ | ------ |
163
- | `type` | Type of event which can be ended or error string |
164
- | `srcArguments` | Arguments which was passed to play method.<br/> Contains uri, x, y, width & height.
165
-
166
- ### Javascript
167
- ```javascript
168
- // detect video ended
169
- await sos.video.onEnded((event) => { console.log(event); });
170
-
171
- // detect video error
172
- await sos.video.onError((event) => { console.log(event); });
173
- ```
174
-
175
- ## Usage with Typescript
176
- You can also use all these methods with [signageOS TypeScript](https://docs.signageos.io/hc/en-us/articles/4405069154962#signageos-typescript).
177
-
178
- ```typescript
179
- play(
180
- uri: string,
181
- x: number,
182
- y: number,
183
- width: number,
184
- height: number
185
- ): Promise<void>;
186
- prepare(
187
- uri: string,
188
- x: number,
189
- y: number,
190
- width: number,
191
- height: number,
192
- options?: {
193
- '4k'?: boolean;
194
- background?: boolean;
195
- volume?: number;
196
- }
197
- ): Promise<void>;
198
- stop(
199
- uri: string,
200
- x: number,
201
- y: number,
202
- width: number,
203
- height: number
204
- ): Promise<void>;
205
- pause(
206
- uri: string,
207
- x: number,
208
- y: number,
209
- width: number,
210
- height: number
211
- ): Promise<void>;
212
- resume(
213
- uri: string,
214
- x: number,
215
- y: number,
216
- width: number,
217
- height: number
218
- ): Promise<void>;
219
- ```
220
-
221
- ## Errors
222
- Although we are doing our best, following errors may occur when working with the video stream.
223
-
224
-
225
- | Code | Type | Message |
226
- | ---- | ---- | ------- |
227
- | 41501 | AppletVideoError | This video was not played yet. The arguments: `arguments` |
228
- | 51501 | InternalVideoError | Couldn't play the video. |
229
- | 51502 | InternalVideoError | Couldn't prepare the video. |
230
- | 51503 | InternalVideoError | Couldn't stop the video. |
231
- | 51504 | InternalVideoError | Couldn't pause the video. |
232
- | 51505 | InternalVideoError | Couldn't resume the video.
@@ -1,107 +0,0 @@
1
- ---
2
- title: Application
3
- author: Krystof Woldrich
4
- date: 24.4.2018
5
- type: js-management-api
6
- tags:
7
- - applet
8
- - applet_api
9
- - api
10
- - js_management_api
11
- description: "[Management JS API] Management API app lets you check application type and upgrade the application."
12
- ---
13
-
14
- # App
15
-
16
- Management API app lets you check application type and upgrade the application.
17
-
18
- ## All methods
19
-
20
- | Method | Description | Supported since |
21
- | ------ | -------- | ------------- |
22
- | `getType()` | Information about the platform your application is running on (eg. Tizen) | |
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
-
26
- ## getType()
27
- Method `getType()` returns the display type of application on the device.
28
-
29
- ```javascript
30
- await sos.management.app.getType(); // Returns ex. sssp, android
31
- ```
32
-
33
- **Returns one of the following types:**
34
- - `android`
35
- - `brightsign`
36
- - `default` (Emulator)
37
- - `linux` (Raspberry Pi)
38
- - `sssp`
39
- - `tizen`
40
- - `webos`
41
- - `windows`
42
-
43
- :::info
44
- If you need to get specific Android brand or Raspberry Pi model, use the [Firmware API](js-management-firmware) `getType()`.
45
- :::
46
-
47
- ## getVersion()
48
- Method `getVersion()` returns the version of Core App application on the device.
49
-
50
- *This API is only available for Applets deployed via Timing from Box or REST API.*
51
-
52
- ```javascript
53
- await sos.management.app.getVersion(); // Returns ex. 2.0.0
54
- ```
55
-
56
- ## upgrade()
57
- Method `upgrade()` will upgrade the [Core App](https://docs.signageos.io/hc/en-us/articles/4405381466898) on the device.
58
-
59
-
60
- ### A) Upgrading signageOS Core App
61
- To upgrade to signageOS Core App, use the following parameters:
62
-
63
-
64
- | Param |Type | Value |Description |
65
- | -------------- | ----------------------------- | ------- | --------------------- |
66
- | `baseUrl` | String | `https://cdn.your-cms.com/tizen/`| Location of the new version of the Core App |
67
- | `version` | String | `x.x.x` | Core App version
68
-
69
- :::tip
70
- [List of our latest core app versions](https://docs.signageos.io/hc/en-us/sections/4409161443730-Core-Apps)
71
- :::
72
-
73
- ### Javascript example
74
- ```javascript
75
- await sos.management.app.upgrade('https://example.com/signageos-core-app.zip', '2.0.0');
76
- ```
77
-
78
- <br/>
79
-
80
- ### B) Upgrading Open Core App with built-in Applet
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`.
82
-
83
- The `absolutePathUrl` should point to the application file, e.g. `https://cdn.your-cms.com/rpi/linux_202006100815_1.0.1_779c303408.zip`.
84
-
85
-
86
- | Param |Type | Value |Description |
87
- | -------------- | ----------------------------- | ------- | --------------------- |
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
89
-
90
- ### Javascript example
91
- ```javascript
92
- await sos.management.app.upgrade('https://cdn.your-cms.com/rpi/linux_xxx.zip');
93
- ```
94
-
95
- <br/>
96
-
97
- Because each of the platforms (Tizen, webOS, BrightSign, etc.) are different, use the following table to define correct `absolutePathUrl`:
98
-
99
-
100
- | Platform | absolutePathUrl | Note |
101
- | -------- | --------------- | ---- |
102
- | Tizen | `https://cdn.your-cms.com/core-apps/landscape` <br/> `https://cdn.your-cms.com/core-apps/portrait` | |
103
- | SSSP | `https://cdn.your-cms.com/core-apps/landscape_full-hd` <br/> `https://cdn.your-cms.com/core-apps/portrait_full-hd` | |
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 |
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|
106
- | BrightSign | `https://cdn.your-cms.com/core-apps/display-brightsign.zip` | |
107
- | NEC / RPi | `https://cdn.your-cms.com/core-apps/linux_202006100815_1.0.1_779c303408.zip` |
@@ -1,44 +0,0 @@
1
- ---
2
- title: Audio
3
- author: Miroslav Behina
4
- date: 1.4.2018
5
- type: js-management-api
6
- tags:
7
- - applet
8
- - applet_api
9
- - api
10
- - js_management_api
11
- description: "[Management JS API] Management API audio allows you to check and set your devices current audio volume setting."
12
- ---
13
-
14
- # Audio
15
- Management API audio allows you to check and set your devices current audio volume setting.
16
-
17
- ## All methods
18
-
19
-
20
- | Method | Description | Supported since |
21
- | ------ | ------ | :-------------: |
22
- | `getVolume()` | Get current volume level | 2.0 |
23
- | `setVolume()` | Set volume level | 2.0
24
-
25
- ## getVolume()
26
- Method `getVolume()` lets you check for current level of volume set on the device.
27
-
28
- ### Javascript example
29
- ```javascript
30
- await sos.management.audio.getVolume(); // Returns number e.g. 39
31
- ```
32
-
33
- ## setVolume()
34
- Method `setVolume()` lets you set level of volume on your device.
35
-
36
-
37
- | Param |Type | Required | Value | Description |
38
- | -------------- | ----------------| :-------------: | -------- | -------------------- |
39
- | `volume` | Number | <div class="red">Yes</div> | `0` - `100` | Volume level
40
-
41
- ### Javascript example
42
- ```javascript
43
- await sos.management.audio.setVolume(90);
44
- ```
@@ -1,40 +0,0 @@
1
- ---
2
- title: Debug
3
- author: Krystof Woldrich
4
- date: 24.4.2018
5
- type: js-management-api
6
- tags:
7
- - applet
8
- - applet_api
9
- - api
10
- - js_management_api
11
- description: "[Management JS API] Management API debug lets you enable and disable debug mode."
12
- ---
13
-
14
- # Debug
15
- Management API debug lets you enable and disable debug mode.
16
-
17
- ## All methods
18
-
19
-
20
- | Method | Description | Supported since |
21
- | ------ | -------- | :-------------: |
22
- | `enable()` | Enable native debug on the device | 3.0 |
23
- | `disable()` | Disable native debug on the device | 3.0
24
-
25
- ## enable()
26
- Method `enable()` enable the [Native debug](https://docs.signageos.io/hc/en-us/articles/4405238849938) on the device.
27
-
28
- ```javascript
29
- await sos.management.debug.enable();
30
- ```
31
-
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
- :::
35
-
36
- ## disable()
37
- Method `disable()` disable the [Native debug](https://docs.signageos.io/hc/en-us/articles/4405238849938) on the device.
38
-
39
- ```javascript
40
- await sos.management.debug.disable();
@@ -1,93 +0,0 @@
1
- ---
2
- title: Firmware
3
- author: Miroslav Behina
4
- date: 1.4.2018
5
- type: js-management-api
6
- tags:
7
- - applet
8
- - applet_api
9
- - api
10
- - js_management_api
11
- description: "[Management JS API] Firmware management API allows you to remotely upgrade firmware version and check version on your current device."
12
- ---
13
-
14
- # Firmware
15
- Firmware management API allows you to remotely upgrade firmware version and check version on your current device.
16
-
17
- ## All methods
18
-
19
-
20
- | Method | Description | Supported since |
21
- | ------ | ------ | ------------- |
22
- | `upgrade()` | Allows you to upgrade device FW | 3.0 |
23
- | `getVersion()` | Get current FW version | 3.0 |
24
- | `getType()` | Get current FW type | 5.0 |
25
-
26
- ## upgrade()
27
- Method `upgrade()` will upgrade current firmware version to a specified one.
28
-
29
-
30
- | Param |Type | Required | Description |
31
- | -------------- | ----------------------| :-------: | -------------------- |
32
- | `baseUrl` | string | <div class="red">Yes</div> | Location of the FW package for specific device |
33
- |^^|^^|^^| `https://cdn.your-cms.com/tizen/pmf/fw/2080_4.bem` |
34
- | `version` | string | <div class="yellow">No</div> | FW version |
35
- |^^|^^|^^| `T-HKMLAKUC-2080.4` |
36
- | `(progress: number)` | callback | <div class="yellow">No</div> | FW progress upgrade
37
-
38
- ### Javascript example
39
- ```javascript
40
- await sos.management.firmware.upgrade(
41
- 'https://cdn.your-cms.com/tizen/pmf/fw/2080_4.bem',
42
- 'T-HKMLAKUC-2080.4',
43
- (progress: number) => {
44
- console.log(progress + "%");
45
- }
46
- );
47
-
48
- await sos.management.firmware.upgrade('https://cdn.your-cms.com/tizen/pmf/fw/2080_4.bem');
49
- ```
50
-
51
- :::warning
52
- Always check if your absolute firmware URL ends with firmware file.
53
- Example: `https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw`
54
- :::
55
-
56
- :::info
57
- For BrightSign firmware upgrade please ensure that you have txt file with SHA1 hash of that firmware file.
58
- - Firmware file path: `https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw`
59
- - SHA1 txt file: `https://cnd.your-cms.com/brightsign/fw/brightsign-update.bsfw.sha1.txt`
60
- :::
61
-
62
- :::note[GitHub Example]
63
- [How to upgrade firmware](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/firmware/)
64
- :::
65
-
66
- ## getVersion()
67
- Method `getVersion()` will specify what current version of firmware is installed on a device.
68
-
69
- ### Javascript example
70
- ```javascript
71
- sos.management.firmware.getVersion().then((version) => {
72
- console.log(version); // Returns String e.g. T-HKMLAKUC-2020.5
73
- });
74
- ```
75
-
76
- ## getType()
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.
78
-
79
-
80
- | Type | Description |
81
- | ------------- | -------------------------------------- |
82
- | `rpi` | any Raspberry Pi 3 or Compute Module 3 |
83
- | `rpi4` | any Raspberry Pi 4 or Compute Module 4 |
84
- | `benq-` | any Benq display |
85
- | `philips-` | any Philips display |
86
- | `sharp-` | any Sharp display |
87
- | `elo-` | any Elo display
88
-
89
- ### Javascript example
90
- ```javascript
91
- const type = await sos.management.firmware.getType();
92
- console.log(type); // e.g. rpi4
93
- ```
@@ -1,178 +0,0 @@
1
- ---
2
- title: Management
3
- author: Miroslav Behina
4
- date: 1.4.2018
5
- type: js-management-api
6
- tags:
7
- - applet
8
- - applet_api
9
- - api
10
- - js_management_api
11
- description: "[Management JS API] 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."
12
- ---
13
-
14
- # Management
15
-
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
-
18
- ## All methods
19
-
20
- | Method | Description | Supported since |
21
- |-----------------------------------|-----------------------------------------------------------------|:---------------:|
22
- | `supports()` | Enum of supported features | 2.0.0 |
23
- | `getModel()` | Information about device model | 2.0.0 |
24
- | `getSerialNumber()` | Information about device serial number | 2.1.0 |
25
- | `getBatteryStatus()` | Information about the battery level and battery charging status | 2.1.0 |
26
- | `getNetworkInfo()` | Information about network connections, IPs and DNS | 4.0.0 |
27
- | `getTemperature()` | Current device temperature | 3.0.0 |
28
- | `resetSettings()` | Clear all settings on device | 4.0.0 |
29
- | `factoryReset()` | Do a device factory reset | 4.0.0 |
30
- | `getBrand()` | Information about device brand | 5.7.0 |
31
- | `setHardwareAcceleration()` | Enable or disable hardware acceleration | 7.1.0 |
32
- | `isHardwareAccelerationEnabled()` | Check if hardware acceleration is enabled | 7.1.0 |
33
-
34
- ## Examples
35
- :::note[GitHub Example]
36
- [Basic usage of management API](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/basics)
37
- :::
38
-
39
- :::note[GitHub Example]
40
- - [Getting basic management API data](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/js-management-getters/)
41
- - [Setting basic management API data](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/js-management-setters/">
42
- :::
43
-
44
- ## supports()
45
- Method `supports()` will show you what capabilities the deployed device currently has.
46
-
47
- ### Javascript example
48
-
49
- ```javascript
50
- await sos.management.supports("NETWORK_INFO"); // Returns boolean
51
- ```
52
-
53
- ### Capabilities
54
-
55
- | Param |
56
- | -------------- |
57
- | MODEL |
58
- | SERIAL_NUMBER |
59
- | BRAND |
60
- | OS_VERSION |
61
- | BATTERY_STATUS |
62
- | STORAGE_UNITS |
63
- | TEMPERATURE |
64
- | SCREENSHOT_UPLOAD |
65
- | NETWORK_INFO |
66
- | WIFI |
67
- | WIFI_SCAN |
68
- | WIFI_AP |
69
- | WIFI_STRENGTH |
70
- | TIMERS_PROPRIETARY |
71
- | BRIGHTNESS_SCHEDULING |
72
- | TIMERS_NATIVE |
73
- | SET_BRIGHTNESS |
74
- | GET_BRIGHTNESS |
75
- | SCREEN_RESIZE |
76
- | SET_TIME |
77
- | SET_TIMEZONE |
78
- | GET_TIMEZONE |
79
- | NTP_TIME |
80
- | APP_UPGRADE |
81
- | FIRMWARE_UPGRADE |
82
- | PACKAGE_INSTALL |
83
- | SET_VOLUME |
84
- | GET_VOLUME |
85
- | SET_REMOTE_CONTROL_ENABLED |
86
- | SET_DEBUG |
87
- | SYSTEM_REBOOT |
88
- | APP_RESTART |
89
- | DISPLAY_POWER |
90
- | SERVLET |
91
- | HARDWARE_LED_SET_COLOR |
92
- | PROXIMITY_SENSOR |
93
- | FACTORY_RESET |
94
- | ORIENTATION_LANDSCAPE |
95
- | ORIENTATION_PORTRAIT |
96
- | ORIENTATION_LANDSCAPE_FLIPPED |
97
- | ORIENTATION_PORTRAIT_FLIPPED |
98
- | ORIENTATION_AUTO |
99
- | SCHEDULE_POWER_ACTION |
100
- | EXTENDED_MANAGEMENT |
101
- | SYSTEM_CPU |
102
- | SYSTEM_MEMORY |
103
- | PROXY |
104
- | AUTO_RECOVERY |
105
- | PEER_RECOVERY |
106
- | FILE_SYSTEM_WIPEOUT |
107
- | REMOTE_DESKTOP |
108
-
109
- ## getModel()
110
- Method `getModel()` will display the model of your device.
111
-
112
- ```javascript
113
- await sos.management.getModel(); // Returns string ex. Philips-10BDL3051T
114
- ```
115
-
116
- ## getSerialNumber()
117
- Method `getSerialNumber()` will display device's serial number.
118
-
119
- ```javascript
120
- await sos.management.getSerialNumber(); // Returns string ex. AU1A1xxxxxx07502
121
- ```
122
-
123
-
124
- ## getBatteryStatus()
125
- Method `getBatteryStatus()` will display information about device's battery.
126
-
127
- ```javascript
128
- await sos.management.getBatteryStatus(); // Returns object
129
- ```
130
-
131
- ### Example of response
132
- ```json
133
- {
134
- "chargeType": "AC",
135
- "isCharging": true,
136
- "lastChargingTime": "2019-02-01T19:27:30.393Z",
137
- "percentage": 100,
138
- "updatedAt": "2019-02-01T19:27:31.247Z"
139
- }
140
- ```
141
-
142
- ## getTemperature()
143
- Method `getTemperature()` will display information about the current temperature of the device.
144
-
145
- ```typescript
146
- await sos.management.getTemperature(); // Returns number values 0-100
147
- ```
148
-
149
- ## getBrand()
150
- Method `getBrand()` will display the manufacturer brand of your device.
151
-
152
- ```typescript
153
- await sos.management.getBrand(); // Returns string ex. Google, Samsung, signageOS for emulators
154
- ```
155
-
156
- ## setHardwareAcceleration()
157
- Method `setHardwareAcceleration()` will enable or disable hardware acceleration.
158
-
159
- :::note
160
- - Check if device supports hardware acceleration changing by calling `sos.management.supports("HARDWARE_ACCELERATION")`.
161
- - By default, hardware acceleration is always enabled.
162
- :::
163
-
164
- | Param | Type | Required | Description |
165
- |-----------|---------|:--------------------------:|-----------------------------------------|
166
- | `enabled` | boolean | <div class="red">Yes</div> | Enable or disable hardware acceleration |
167
-
168
- ```typescript
169
- await sos.management.setHardwareAcceleration(true); // Promise<void>
170
- ```
171
-
172
- ## isHardwareAccelerationEnabled()
173
- Method `isHardwareAccelerationEnabled()` will return if hardware acceleration is enabled.
174
-
175
- ```typescript
176
- await sos.management.isHardwareAccelerationEnabled(); // Promise<boolean>
177
- ```
178
-