@signageos/front-applet 4.11.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 (443) hide show
  1. package/CHANGELOG.md +207 -0
  2. package/README.md +3 -0
  3. package/dist/bundle.js +9 -0
  4. package/dist/bundle.js.map +1 -0
  5. package/docs/README.md +5 -0
  6. package/docs/js-api/js-api-introduction.md +73 -0
  7. package/docs/js-api/js-applet-basics.md +294 -0
  8. package/docs/js-api/js-applet-resources.md +172 -0
  9. package/docs/js-api/js-browser.md +170 -0
  10. package/docs/js-api/js-command.md +208 -0
  11. package/docs/js-api/js-display.md +48 -0
  12. package/docs/js-api/js-file-system.md +568 -0
  13. package/docs/js-api/js-hardware-serial.md +142 -0
  14. package/docs/js-api/js-hardware.md +70 -0
  15. package/docs/js-api/js-iframes.md +88 -0
  16. package/docs/js-api/js-input.md +84 -0
  17. package/docs/js-api/js-loading-fonts.md +138 -0
  18. package/docs/js-api/js-monitoring-commands.md +108 -0
  19. package/docs/js-api/js-monitors.md +55 -0
  20. package/docs/js-api/js-offline-cache-media-files.md +314 -0
  21. package/docs/js-api/js-offline-cache-simple-data.md +134 -0
  22. package/docs/js-api/js-sensors.md +70 -0
  23. package/docs/js-api/js-sync-playback.md +197 -0
  24. package/docs/js-api/js-timing.md +54 -0
  25. package/docs/js-api/js-video-inputs-internal-ports.md +149 -0
  26. package/docs/js-api/js-video-stream.md +230 -0
  27. package/docs/js-api/js-video.md +282 -0
  28. package/docs/management-api/1-js-management.md +133 -0
  29. package/docs/management-api/10-js-management-application.md +123 -0
  30. package/docs/management-api/11-js-management-network.md +185 -0
  31. package/docs/management-api/12-js-management-security.md +86 -0
  32. package/docs/management-api/13-js-management-wifi.md +357 -0
  33. package/docs/management-api/2-js-management-firmware.md +93 -0
  34. package/docs/management-api/3-js-management-remote-control.md +73 -0
  35. package/docs/management-api/4-js-management-power.md +94 -0
  36. package/docs/management-api/5-js-management-screen.md +263 -0
  37. package/docs/management-api/6-js-management-time.md +166 -0
  38. package/docs/management-api/7-js-management-volume.md +46 -0
  39. package/docs/management-api/8-js-management-package.md +62 -0
  40. package/docs/management-api/9-js-management-debug.md +53 -0
  41. package/es6/FrontApplet/Browser/Browser.d.ts +24 -0
  42. package/es6/FrontApplet/Browser/Browser.js +73 -0
  43. package/es6/FrontApplet/Browser/Browser.js.map +1 -0
  44. package/es6/FrontApplet/Browser/IOpenLinkOptions.d.ts +174 -0
  45. package/es6/FrontApplet/Browser/IOpenLinkOptions.js +55 -0
  46. package/es6/FrontApplet/Browser/IOpenLinkOptions.js.map +1 -0
  47. package/es6/FrontApplet/Browser/events.d.ts +15 -0
  48. package/es6/FrontApplet/Browser/events.js +14 -0
  49. package/es6/FrontApplet/Browser/events.js.map +1 -0
  50. package/es6/FrontApplet/Browser/messages.d.ts +5 -0
  51. package/es6/FrontApplet/Browser/messages.js +3 -0
  52. package/es6/FrontApplet/Browser/messages.js.map +1 -0
  53. package/es6/FrontApplet/Command/Command.d.ts +16 -0
  54. package/es6/FrontApplet/Command/Command.js +68 -0
  55. package/es6/FrontApplet/Command/Command.js.map +1 -0
  56. package/es6/FrontApplet/Command/ICommand.d.ts +4 -0
  57. package/es6/FrontApplet/Command/ICommand.js +3 -0
  58. package/es6/FrontApplet/Command/ICommand.js.map +1 -0
  59. package/es6/FrontApplet/Command/ICommandDispatchToAppletMessage.d.ts +6 -0
  60. package/es6/FrontApplet/Command/ICommandDispatchToAppletMessage.js +3 -0
  61. package/es6/FrontApplet/Command/ICommandDispatchToAppletMessage.js.map +1 -0
  62. package/es6/FrontApplet/Command/ICommandEvent.d.ts +6 -0
  63. package/es6/FrontApplet/Command/ICommandEvent.js +3 -0
  64. package/es6/FrontApplet/Command/ICommandEvent.js.map +1 -0
  65. package/es6/FrontApplet/Command/ICommandEventListener.d.ts +6 -0
  66. package/es6/FrontApplet/Command/ICommandEventListener.js +3 -0
  67. package/es6/FrontApplet/Command/ICommandEventListener.js.map +1 -0
  68. package/es6/FrontApplet/Debug/Debug.d.ts +22 -0
  69. package/es6/FrontApplet/Debug/Debug.js +35 -0
  70. package/es6/FrontApplet/Debug/Debug.js.map +1 -0
  71. package/es6/FrontApplet/Display/Display.d.ts +11 -0
  72. package/es6/FrontApplet/Display/Display.js +35 -0
  73. package/es6/FrontApplet/Display/Display.js.map +1 -0
  74. package/es6/FrontApplet/Error/AppletCommandError.d.ts +9 -0
  75. package/es6/FrontApplet/Error/AppletCommandError.js +11 -0
  76. package/es6/FrontApplet/Error/AppletCommandError.js.map +1 -0
  77. package/es6/FrontApplet/Error/AppletError.d.ts +7 -0
  78. package/es6/FrontApplet/Error/AppletError.js +10 -0
  79. package/es6/FrontApplet/Error/AppletError.js.map +1 -0
  80. package/es6/FrontApplet/Error/AppletHardwareError.d.ts +9 -0
  81. package/es6/FrontApplet/Error/AppletHardwareError.js +11 -0
  82. package/es6/FrontApplet/Error/AppletHardwareError.js.map +1 -0
  83. package/es6/FrontApplet/Error/AppletOfflineCacheError.d.ts +8 -0
  84. package/es6/FrontApplet/Error/AppletOfflineCacheError.js +10 -0
  85. package/es6/FrontApplet/Error/AppletOfflineCacheError.js.map +1 -0
  86. package/es6/FrontApplet/Error/AppletResourcesError.d.ts +9 -0
  87. package/es6/FrontApplet/Error/AppletResourcesError.js +11 -0
  88. package/es6/FrontApplet/Error/AppletResourcesError.js.map +1 -0
  89. package/es6/FrontApplet/Error/AppletSecurityError.d.ts +9 -0
  90. package/es6/FrontApplet/Error/AppletSecurityError.js +11 -0
  91. package/es6/FrontApplet/Error/AppletSecurityError.js.map +1 -0
  92. package/es6/FrontApplet/Error/AppletStreamError.d.ts +8 -0
  93. package/es6/FrontApplet/Error/AppletStreamError.js +10 -0
  94. package/es6/FrontApplet/Error/AppletStreamError.js.map +1 -0
  95. package/es6/FrontApplet/Error/AppletVideoError.d.ts +9 -0
  96. package/es6/FrontApplet/Error/AppletVideoError.js +11 -0
  97. package/es6/FrontApplet/Error/AppletVideoError.js.map +1 -0
  98. package/es6/FrontApplet/Error/ErrorCodes.d.ts +18 -0
  99. package/es6/FrontApplet/Error/ErrorCodes.js +23 -0
  100. package/es6/FrontApplet/Error/ErrorCodes.js.map +1 -0
  101. package/es6/FrontApplet/Error/ErrorCodesMessages.d.ts +3 -0
  102. package/es6/FrontApplet/Error/ErrorCodesMessages.js +22 -0
  103. package/es6/FrontApplet/Error/ErrorCodesMessages.js.map +1 -0
  104. package/es6/FrontApplet/Error/ErrorSuggestions.d.ts +6 -0
  105. package/es6/FrontApplet/Error/ErrorSuggestions.js +10 -0
  106. package/es6/FrontApplet/Error/ErrorSuggestions.js.map +1 -0
  107. package/es6/FrontApplet/Error/FileNotFoundError.d.ts +8 -0
  108. package/es6/FrontApplet/Error/FileNotFoundError.js +10 -0
  109. package/es6/FrontApplet/Error/FileNotFoundError.js.map +1 -0
  110. package/es6/FrontApplet/Error/SosError.d.ts +20 -0
  111. package/es6/FrontApplet/Error/SosError.js +22 -0
  112. package/es6/FrontApplet/Error/SosError.js.map +1 -0
  113. package/es6/FrontApplet/Error/errorHelper.d.ts +12 -0
  114. package/es6/FrontApplet/Error/errorHelper.js +50 -0
  115. package/es6/FrontApplet/Error/errorHelper.js.map +1 -0
  116. package/es6/FrontApplet/Exchange/Exchange.d.ts +7 -0
  117. package/es6/FrontApplet/Exchange/Exchange.js +28 -0
  118. package/es6/FrontApplet/Exchange/Exchange.js.map +1 -0
  119. package/es6/FrontApplet/FileSystem/FileSystem.d.ts +30 -0
  120. package/es6/FrontApplet/FileSystem/FileSystem.js +210 -0
  121. package/es6/FrontApplet/FileSystem/FileSystem.js.map +1 -0
  122. package/es6/FrontApplet/FileSystem/StorageUnitsChangedMessage.d.ts +4 -0
  123. package/es6/FrontApplet/FileSystem/StorageUnitsChangedMessage.js +3 -0
  124. package/es6/FrontApplet/FileSystem/StorageUnitsChangedMessage.js.map +1 -0
  125. package/es6/FrontApplet/FileSystem/types.d.ts +66 -0
  126. package/es6/FrontApplet/FileSystem/types.js +20 -0
  127. package/es6/FrontApplet/FileSystem/types.js.map +1 -0
  128. package/es6/FrontApplet/Font/fontFaceGenerator.d.ts +6 -0
  129. package/es6/FrontApplet/Font/fontFaceGenerator.js +46 -0
  130. package/es6/FrontApplet/Font/fontFaceGenerator.js.map +1 -0
  131. package/es6/FrontApplet/FrontApplet.d.ts +56 -0
  132. package/es6/FrontApplet/FrontApplet.js +183 -0
  133. package/es6/FrontApplet/FrontApplet.js.map +1 -0
  134. package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.d.ts +30 -0
  135. package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.js +92 -0
  136. package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.js.map +1 -0
  137. package/es6/FrontApplet/Hardware/BarcodeScanner/IBarcodeScannerDataMessage.d.ts +5 -0
  138. package/es6/FrontApplet/Hardware/BarcodeScanner/IBarcodeScannerDataMessage.js +3 -0
  139. package/es6/FrontApplet/Hardware/BarcodeScanner/IBarcodeScannerDataMessage.js.map +1 -0
  140. package/es6/FrontApplet/Hardware/Hardware.d.ts +20 -0
  141. package/es6/FrontApplet/Hardware/Hardware.js +51 -0
  142. package/es6/FrontApplet/Hardware/Hardware.js.map +1 -0
  143. package/es6/FrontApplet/Hardware/ISerialPortDataMessage.d.ts +6 -0
  144. package/es6/FrontApplet/Hardware/ISerialPortDataMessage.js +3 -0
  145. package/es6/FrontApplet/Hardware/ISerialPortDataMessage.js.map +1 -0
  146. package/es6/FrontApplet/Hardware/ISerialPortOptions.d.ts +15 -0
  147. package/es6/FrontApplet/Hardware/ISerialPortOptions.js +11 -0
  148. package/es6/FrontApplet/Hardware/ISerialPortOptions.js.map +1 -0
  149. package/es6/FrontApplet/Hardware/Led/ISetColorMessage.d.ts +5 -0
  150. package/es6/FrontApplet/Hardware/Led/ISetColorMessage.js +3 -0
  151. package/es6/FrontApplet/Hardware/Led/ISetColorMessage.js.map +1 -0
  152. package/es6/FrontApplet/Hardware/Led/Led.d.ts +11 -0
  153. package/es6/FrontApplet/Hardware/Led/Led.js +38 -0
  154. package/es6/FrontApplet/Hardware/Led/Led.js.map +1 -0
  155. package/es6/FrontApplet/Hardware/SerialPort.d.ts +14 -0
  156. package/es6/FrontApplet/Hardware/SerialPort.js +45 -0
  157. package/es6/FrontApplet/Hardware/SerialPort.js.map +1 -0
  158. package/es6/FrontApplet/Hash/generator.d.ts +1 -0
  159. package/es6/FrontApplet/Hash/generator.js +10 -0
  160. package/es6/FrontApplet/Hash/generator.js.map +1 -0
  161. package/es6/FrontApplet/IMessage.d.ts +6 -0
  162. package/es6/FrontApplet/IMessage.js +3 -0
  163. package/es6/FrontApplet/IMessage.js.map +1 -0
  164. package/es6/FrontApplet/IPostMessage.d.ts +5 -0
  165. package/es6/FrontApplet/IPostMessage.js +3 -0
  166. package/es6/FrontApplet/IPostMessage.js.map +1 -0
  167. package/es6/FrontApplet/Iframe/Iframe.d.ts +24 -0
  168. package/es6/FrontApplet/Iframe/Iframe.js +51 -0
  169. package/es6/FrontApplet/Iframe/Iframe.js.map +1 -0
  170. package/es6/FrontApplet/Input/IInputKeyMessage.d.ts +6 -0
  171. package/es6/FrontApplet/Input/IInputKeyMessage.js +3 -0
  172. package/es6/FrontApplet/Input/IInputKeyMessage.js.map +1 -0
  173. package/es6/FrontApplet/Input/IKeyUpEvent.d.ts +6 -0
  174. package/es6/FrontApplet/Input/IKeyUpEvent.js +3 -0
  175. package/es6/FrontApplet/Input/IKeyUpEvent.js.map +1 -0
  176. package/es6/FrontApplet/Input/IKeyUpEventListener.d.ts +5 -0
  177. package/es6/FrontApplet/Input/IKeyUpEventListener.js +3 -0
  178. package/es6/FrontApplet/Input/IKeyUpEventListener.js.map +1 -0
  179. package/es6/FrontApplet/Input/Input.d.ts +20 -0
  180. package/es6/FrontApplet/Input/Input.js +35 -0
  181. package/es6/FrontApplet/Input/Input.js.map +1 -0
  182. package/es6/FrontApplet/Management/App.d.ts +37 -0
  183. package/es6/FrontApplet/Management/App.js +50 -0
  184. package/es6/FrontApplet/Management/App.js.map +1 -0
  185. package/es6/FrontApplet/Management/Audio.d.ts +9 -0
  186. package/es6/FrontApplet/Management/Audio.js +40 -0
  187. package/es6/FrontApplet/Management/Audio.js.map +1 -0
  188. package/es6/FrontApplet/Management/Debug.d.ts +11 -0
  189. package/es6/FrontApplet/Management/Debug.js +50 -0
  190. package/es6/FrontApplet/Management/Debug.js.map +1 -0
  191. package/es6/FrontApplet/Management/Firmware.d.ts +37 -0
  192. package/es6/FrontApplet/Management/Firmware.js +50 -0
  193. package/es6/FrontApplet/Management/Firmware.js.map +1 -0
  194. package/es6/FrontApplet/Management/FirmwareType.d.ts +4 -0
  195. package/es6/FrontApplet/Management/FirmwareType.js +8 -0
  196. package/es6/FrontApplet/Management/FirmwareType.js.map +1 -0
  197. package/es6/FrontApplet/Management/IBatteryStatus.d.ts +7 -0
  198. package/es6/FrontApplet/Management/IBatteryStatus.js +3 -0
  199. package/es6/FrontApplet/Management/IBatteryStatus.js.map +1 -0
  200. package/es6/FrontApplet/Management/IBrightness.d.ts +6 -0
  201. package/es6/FrontApplet/Management/IBrightness.js +3 -0
  202. package/es6/FrontApplet/Management/IBrightness.js.map +1 -0
  203. package/es6/FrontApplet/Management/INetworkInfo.d.ts +53 -0
  204. package/es6/FrontApplet/Management/INetworkInfo.js +17 -0
  205. package/es6/FrontApplet/Management/INetworkInfo.js.map +1 -0
  206. package/es6/FrontApplet/Management/IOrientation.d.ts +4 -0
  207. package/es6/FrontApplet/Management/IOrientation.js +3 -0
  208. package/es6/FrontApplet/Management/IOrientation.js.map +1 -0
  209. package/es6/FrontApplet/Management/IWifiEvent.d.ts +11 -0
  210. package/es6/FrontApplet/Management/IWifiEvent.js +12 -0
  211. package/es6/FrontApplet/Management/IWifiEvent.js.map +1 -0
  212. package/es6/FrontApplet/Management/Management.d.ts +44 -0
  213. package/es6/FrontApplet/Management/Management.js +113 -0
  214. package/es6/FrontApplet/Management/Management.js.map +1 -0
  215. package/es6/FrontApplet/Management/Network.d.ts +26 -0
  216. package/es6/FrontApplet/Management/Network.js +83 -0
  217. package/es6/FrontApplet/Management/Network.js.map +1 -0
  218. package/es6/FrontApplet/Management/Package.d.ts +8 -0
  219. package/es6/FrontApplet/Management/Package.js +38 -0
  220. package/es6/FrontApplet/Management/Package.js.map +1 -0
  221. package/es6/FrontApplet/Management/Power.d.ts +13 -0
  222. package/es6/FrontApplet/Management/Power.js +78 -0
  223. package/es6/FrontApplet/Management/Power.js.map +1 -0
  224. package/es6/FrontApplet/Management/RemoteControl.d.ts +14 -0
  225. package/es6/FrontApplet/Management/RemoteControl.js +61 -0
  226. package/es6/FrontApplet/Management/RemoteControl.js.map +1 -0
  227. package/es6/FrontApplet/Management/Screen.d.ts +18 -0
  228. package/es6/FrontApplet/Management/Screen.js +114 -0
  229. package/es6/FrontApplet/Management/Screen.js.map +1 -0
  230. package/es6/FrontApplet/Management/Security.d.ts +21 -0
  231. package/es6/FrontApplet/Management/Security.js +56 -0
  232. package/es6/FrontApplet/Management/Security.js.map +1 -0
  233. package/es6/FrontApplet/Management/Time.d.ts +16 -0
  234. package/es6/FrontApplet/Management/Time.js +59 -0
  235. package/es6/FrontApplet/Management/Time.js.map +1 -0
  236. package/es6/FrontApplet/Management/Wifi.d.ts +29 -0
  237. package/es6/FrontApplet/Management/Wifi.js +151 -0
  238. package/es6/FrontApplet/Management/Wifi.js.map +1 -0
  239. package/es6/FrontApplet/Management/helpers/DeviceHelper.d.ts +21 -0
  240. package/es6/FrontApplet/Management/helpers/DeviceHelper.js +16 -0
  241. package/es6/FrontApplet/Management/helpers/DeviceHelper.js.map +1 -0
  242. package/es6/FrontApplet/Management/helpers/SecurityHelper.d.ts +2 -0
  243. package/es6/FrontApplet/Management/helpers/SecurityHelper.js +21 -0
  244. package/es6/FrontApplet/Management/helpers/SecurityHelper.js.map +1 -0
  245. package/es6/FrontApplet/Management/helpers/TimerHelper.d.ts +25 -0
  246. package/es6/FrontApplet/Management/helpers/TimerHelper.js +23 -0
  247. package/es6/FrontApplet/Management/helpers/TimerHelper.js.map +1 -0
  248. package/es6/FrontApplet/Management/helpers/UpgradeHelper.d.ts +5 -0
  249. package/es6/FrontApplet/Management/helpers/UpgradeHelper.js +35 -0
  250. package/es6/FrontApplet/Management/helpers/UpgradeHelper.js.map +1 -0
  251. package/es6/FrontApplet/Management/helpers/VideoHelper.d.ts +4 -0
  252. package/es6/FrontApplet/Management/helpers/VideoHelper.js +8 -0
  253. package/es6/FrontApplet/Management/helpers/VideoHelper.js.map +1 -0
  254. package/es6/FrontApplet/Monitors/Monitors.d.ts +16 -0
  255. package/es6/FrontApplet/Monitors/Monitors.js +31 -0
  256. package/es6/FrontApplet/Monitors/Monitors.js.map +1 -0
  257. package/es6/FrontApplet/Offline/Cache/Cache.d.ts +38 -0
  258. package/es6/FrontApplet/Offline/Cache/Cache.js +199 -0
  259. package/es6/FrontApplet/Offline/Cache/Cache.js.map +1 -0
  260. package/es6/FrontApplet/Offline/Cache/IChecksumMessage.d.ts +5 -0
  261. package/es6/FrontApplet/Offline/Cache/IChecksumMessage.js +3 -0
  262. package/es6/FrontApplet/Offline/Cache/IChecksumMessage.js.map +1 -0
  263. package/es6/FrontApplet/Offline/Cache/IFile.d.ts +4 -0
  264. package/es6/FrontApplet/Offline/Cache/IFile.js +3 -0
  265. package/es6/FrontApplet/Offline/Cache/IFile.js.map +1 -0
  266. package/es6/FrontApplet/Offline/Cache/IListedContentsMessage.d.ts +5 -0
  267. package/es6/FrontApplet/Offline/Cache/IListedContentsMessage.js +3 -0
  268. package/es6/FrontApplet/Offline/Cache/IListedContentsMessage.js.map +1 -0
  269. package/es6/FrontApplet/Offline/Cache/IListedFilesMessage.d.ts +5 -0
  270. package/es6/FrontApplet/Offline/Cache/IListedFilesMessage.js +3 -0
  271. package/es6/FrontApplet/Offline/Cache/IListedFilesMessage.js.map +1 -0
  272. package/es6/FrontApplet/Offline/Cache/ILoadedContentMessage.d.ts +5 -0
  273. package/es6/FrontApplet/Offline/Cache/ILoadedContentMessage.js +3 -0
  274. package/es6/FrontApplet/Offline/Cache/ILoadedContentMessage.js.map +1 -0
  275. package/es6/FrontApplet/Offline/Cache/ILoadedFileMessage.d.ts +6 -0
  276. package/es6/FrontApplet/Offline/Cache/ILoadedFileMessage.js +3 -0
  277. package/es6/FrontApplet/Offline/Cache/ILoadedFileMessage.js.map +1 -0
  278. package/es6/FrontApplet/Offline/Cache/ISavedContentMessage.d.ts +5 -0
  279. package/es6/FrontApplet/Offline/Cache/ISavedContentMessage.js +3 -0
  280. package/es6/FrontApplet/Offline/Cache/ISavedContentMessage.js.map +1 -0
  281. package/es6/FrontApplet/Offline/Cache/ISavedContents.d.ts +4 -0
  282. package/es6/FrontApplet/Offline/Cache/ISavedContents.js +3 -0
  283. package/es6/FrontApplet/Offline/Cache/ISavedContents.js.map +1 -0
  284. package/es6/FrontApplet/Offline/Cache/ISavedFileMessage.d.ts +6 -0
  285. package/es6/FrontApplet/Offline/Cache/ISavedFileMessage.js +3 -0
  286. package/es6/FrontApplet/Offline/Cache/ISavedFileMessage.js.map +1 -0
  287. package/es6/FrontApplet/Offline/Cache/ISavedFiles.d.ts +5 -0
  288. package/es6/FrontApplet/Offline/Cache/ISavedFiles.js +3 -0
  289. package/es6/FrontApplet/Offline/Cache/ISavedFiles.js.map +1 -0
  290. package/es6/FrontApplet/Offline/Cache/IValidatedChecksumMessage.d.ts +5 -0
  291. package/es6/FrontApplet/Offline/Cache/IValidatedChecksumMessage.js +3 -0
  292. package/es6/FrontApplet/Offline/Cache/IValidatedChecksumMessage.js.map +1 -0
  293. package/es6/FrontApplet/Offline/Flags/AppendFlagController.d.ts +12 -0
  294. package/es6/FrontApplet/Offline/Flags/AppendFlagController.js +47 -0
  295. package/es6/FrontApplet/Offline/Flags/AppendFlagController.js.map +1 -0
  296. package/es6/FrontApplet/Offline/Flags/IFlag.d.ts +16 -0
  297. package/es6/FrontApplet/Offline/Flags/IFlag.js +8 -0
  298. package/es6/FrontApplet/Offline/Flags/IFlag.js.map +1 -0
  299. package/es6/FrontApplet/Offline/Flags/IFlagController.d.ts +12 -0
  300. package/es6/FrontApplet/Offline/Flags/IFlagController.js +3 -0
  301. package/es6/FrontApplet/Offline/Flags/IFlagController.js.map +1 -0
  302. package/es6/FrontApplet/Offline/Flags/IFlags.d.ts +7 -0
  303. package/es6/FrontApplet/Offline/Flags/IFlags.js +3 -0
  304. package/es6/FrontApplet/Offline/Flags/IFlags.js.map +1 -0
  305. package/es6/FrontApplet/Offline/IAddFont.d.ts +50 -0
  306. package/es6/FrontApplet/Offline/IAddFont.js +22 -0
  307. package/es6/FrontApplet/Offline/IAddFont.js.map +1 -0
  308. package/es6/FrontApplet/Offline/IElement.d.ts +7 -0
  309. package/es6/FrontApplet/Offline/IElement.js +6 -0
  310. package/es6/FrontApplet/Offline/IElement.js.map +1 -0
  311. package/es6/FrontApplet/Offline/IFileType.d.ts +3 -0
  312. package/es6/FrontApplet/Offline/IFileType.js +4 -0
  313. package/es6/FrontApplet/Offline/IFileType.js.map +1 -0
  314. package/es6/FrontApplet/Offline/ISaveFile.d.ts +49 -0
  315. package/es6/FrontApplet/Offline/ISaveFile.js +26 -0
  316. package/es6/FrontApplet/Offline/ISaveFile.js.map +1 -0
  317. package/es6/FrontApplet/Offline/LoadFile/CssLoadFileController.d.ts +7 -0
  318. package/es6/FrontApplet/Offline/LoadFile/CssLoadFileController.js +26 -0
  319. package/es6/FrontApplet/Offline/LoadFile/CssLoadFileController.js.map +1 -0
  320. package/es6/FrontApplet/Offline/LoadFile/ILoadFile.d.ts +8 -0
  321. package/es6/FrontApplet/Offline/LoadFile/ILoadFile.js +3 -0
  322. package/es6/FrontApplet/Offline/LoadFile/ILoadFile.js.map +1 -0
  323. package/es6/FrontApplet/Offline/LoadFile/ILoadFileController.d.ts +8 -0
  324. package/es6/FrontApplet/Offline/LoadFile/ILoadFileController.js +3 -0
  325. package/es6/FrontApplet/Offline/LoadFile/ILoadFileController.js.map +1 -0
  326. package/es6/FrontApplet/Offline/LoadFile/JavascriptLoadFileController.d.ts +7 -0
  327. package/es6/FrontApplet/Offline/LoadFile/JavascriptLoadFileController.js +25 -0
  328. package/es6/FrontApplet/Offline/LoadFile/JavascriptLoadFileController.js.map +1 -0
  329. package/es6/FrontApplet/Offline/Offline.d.ts +27 -0
  330. package/es6/FrontApplet/Offline/Offline.js +105 -0
  331. package/es6/FrontApplet/Offline/Offline.js.map +1 -0
  332. package/es6/FrontApplet/Offline/Types.d.ts +7 -0
  333. package/es6/FrontApplet/Offline/Types.js +9 -0
  334. package/es6/FrontApplet/Offline/Types.js.map +1 -0
  335. package/es6/FrontApplet/Sensors/Proximity.d.ts +16 -0
  336. package/es6/FrontApplet/Sensors/Proximity.js +36 -0
  337. package/es6/FrontApplet/Sensors/Proximity.js.map +1 -0
  338. package/es6/FrontApplet/Sensors/Sensors.d.ts +11 -0
  339. package/es6/FrontApplet/Sensors/Sensors.js +18 -0
  340. package/es6/FrontApplet/Sensors/Sensors.js.map +1 -0
  341. package/es6/FrontApplet/Stream/IStreamEvent.d.ts +6 -0
  342. package/es6/FrontApplet/Stream/IStreamEvent.js +3 -0
  343. package/es6/FrontApplet/Stream/IStreamEvent.js.map +1 -0
  344. package/es6/FrontApplet/Stream/IStreamEventListener.d.ts +5 -0
  345. package/es6/FrontApplet/Stream/IStreamEventListener.js +3 -0
  346. package/es6/FrontApplet/Stream/IStreamEventListener.js.map +1 -0
  347. package/es6/FrontApplet/Stream/IStreamMessage.d.ts +6 -0
  348. package/es6/FrontApplet/Stream/IStreamMessage.js +3 -0
  349. package/es6/FrontApplet/Stream/IStreamMessage.js.map +1 -0
  350. package/es6/FrontApplet/Stream/IStreamProperties.d.ts +10 -0
  351. package/es6/FrontApplet/Stream/IStreamProperties.js +3 -0
  352. package/es6/FrontApplet/Stream/IStreamProperties.js.map +1 -0
  353. package/es6/FrontApplet/Stream/Stream.d.ts +22 -0
  354. package/es6/FrontApplet/Stream/Stream.js +131 -0
  355. package/es6/FrontApplet/Stream/Stream.js.map +1 -0
  356. package/es6/FrontApplet/Stream/StreamProtocol.d.ts +9 -0
  357. package/es6/FrontApplet/Stream/StreamProtocol.js +13 -0
  358. package/es6/FrontApplet/Stream/StreamProtocol.js.map +1 -0
  359. package/es6/FrontApplet/Stream/streamEvents.d.ts +8 -0
  360. package/es6/FrontApplet/Stream/streamEvents.js +3 -0
  361. package/es6/FrontApplet/Stream/streamEvents.js.map +1 -0
  362. package/es6/FrontApplet/Sync/ISyncEvent.d.ts +4 -0
  363. package/es6/FrontApplet/Sync/ISyncEvent.js +3 -0
  364. package/es6/FrontApplet/Sync/ISyncEvent.js.map +1 -0
  365. package/es6/FrontApplet/Sync/ISyncSetValueMessage.d.ts +7 -0
  366. package/es6/FrontApplet/Sync/ISyncSetValueMessage.js +3 -0
  367. package/es6/FrontApplet/Sync/ISyncSetValueMessage.js.map +1 -0
  368. package/es6/FrontApplet/Sync/Sync.d.ts +20 -0
  369. package/es6/FrontApplet/Sync/Sync.js +102 -0
  370. package/es6/FrontApplet/Sync/Sync.js.map +1 -0
  371. package/es6/FrontApplet/Sync/syncEvents.d.ts +6 -0
  372. package/es6/FrontApplet/Sync/syncEvents.js +3 -0
  373. package/es6/FrontApplet/Sync/syncEvents.js.map +1 -0
  374. package/es6/FrontApplet/Timing/Timing.d.ts +10 -0
  375. package/es6/FrontApplet/Timing/Timing.js +16 -0
  376. package/es6/FrontApplet/Timing/Timing.js.map +1 -0
  377. package/es6/FrontApplet/Timing/Triggers/ITimingTriggersMessage.d.ts +2 -0
  378. package/es6/FrontApplet/Timing/Triggers/ITimingTriggersMessage.js +4 -0
  379. package/es6/FrontApplet/Timing/Triggers/ITimingTriggersMessage.js.map +1 -0
  380. package/es6/FrontApplet/Timing/Triggers/Triggers.d.ts +11 -0
  381. package/es6/FrontApplet/Timing/Triggers/Triggers.js +33 -0
  382. package/es6/FrontApplet/Timing/Triggers/Triggers.js.map +1 -0
  383. package/es6/FrontApplet/Touch/ITouchEventMessage.d.ts +6 -0
  384. package/es6/FrontApplet/Touch/ITouchEventMessage.js +3 -0
  385. package/es6/FrontApplet/Touch/ITouchEventMessage.js.map +1 -0
  386. package/es6/FrontApplet/Touch/Touch.d.ts +13 -0
  387. package/es6/FrontApplet/Touch/Touch.js +54 -0
  388. package/es6/FrontApplet/Touch/Touch.js.map +1 -0
  389. package/es6/FrontApplet/Validate/Validate.d.ts +43 -0
  390. package/es6/FrontApplet/Validate/Validate.js +266 -0
  391. package/es6/FrontApplet/Validate/Validate.js.map +1 -0
  392. package/es6/FrontApplet/Validate/ValidateObjectInterface.d.ts +8 -0
  393. package/es6/FrontApplet/Validate/ValidateObjectInterface.js +140 -0
  394. package/es6/FrontApplet/Validate/ValidateObjectInterface.js.map +1 -0
  395. package/es6/FrontApplet/Video/IVideoEvent.d.ts +8 -0
  396. package/es6/FrontApplet/Video/IVideoEvent.js +6 -0
  397. package/es6/FrontApplet/Video/IVideoEvent.js.map +1 -0
  398. package/es6/FrontApplet/Video/IVideoEventListener.d.ts +5 -0
  399. package/es6/FrontApplet/Video/IVideoEventListener.js +3 -0
  400. package/es6/FrontApplet/Video/IVideoEventListener.js.map +1 -0
  401. package/es6/FrontApplet/Video/IVideoMessage.d.ts +4 -0
  402. package/es6/FrontApplet/Video/IVideoMessage.js +3 -0
  403. package/es6/FrontApplet/Video/IVideoMessage.js.map +1 -0
  404. package/es6/FrontApplet/Video/IVideoProperties.d.ts +8 -0
  405. package/es6/FrontApplet/Video/IVideoProperties.js +3 -0
  406. package/es6/FrontApplet/Video/IVideoProperties.js.map +1 -0
  407. package/es6/FrontApplet/Video/Video.d.ts +39 -0
  408. package/es6/FrontApplet/Video/Video.js +242 -0
  409. package/es6/FrontApplet/Video/Video.js.map +1 -0
  410. package/es6/FrontApplet/createFrontApplet.d.ts +2 -0
  411. package/es6/FrontApplet/createFrontApplet.js +9 -0
  412. package/es6/FrontApplet/createFrontApplet.js.map +1 -0
  413. package/es6/Monitoring/Console/consoleCommands.d.ts +6 -0
  414. package/es6/Monitoring/Console/consoleCommands.js +4 -0
  415. package/es6/Monitoring/Console/consoleCommands.js.map +1 -0
  416. package/es6/Monitoring/Html/htmlCommands.d.ts +9 -0
  417. package/es6/Monitoring/Html/htmlCommands.js +5 -0
  418. package/es6/Monitoring/Html/htmlCommands.js.map +1 -0
  419. package/es6/Monitoring/Montoring.d.ts +12 -0
  420. package/es6/Monitoring/Montoring.js +159 -0
  421. package/es6/Monitoring/Montoring.js.map +1 -0
  422. package/es6/Monitoring/Offline/Cache/offlineCacheCommands.d.ts +20 -0
  423. package/es6/Monitoring/Offline/Cache/offlineCacheCommands.js +7 -0
  424. package/es6/Monitoring/Offline/Cache/offlineCacheCommands.js.map +1 -0
  425. package/es6/Monitoring/Timing/timingCommands.d.ts +4 -0
  426. package/es6/Monitoring/Timing/timingCommands.js +4 -0
  427. package/es6/Monitoring/Timing/timingCommands.js.map +1 -0
  428. package/es6/Monitoring/Video/videoCommands.d.ts +10 -0
  429. package/es6/Monitoring/Video/videoCommands.js +4 -0
  430. package/es6/Monitoring/Video/videoCommands.js.map +1 -0
  431. package/es6/Monitoring/monitoringCommands.d.ts +8 -0
  432. package/es6/Monitoring/monitoringCommands.js +5 -0
  433. package/es6/Monitoring/monitoringCommands.js.map +1 -0
  434. package/es6/Sensors/IButton.d.ts +9 -0
  435. package/es6/Sensors/IButton.js +8 -0
  436. package/es6/Sensors/IButton.js.map +1 -0
  437. package/es6/Sensors/IRfidAntenna.d.ts +10 -0
  438. package/es6/Sensors/IRfidAntenna.js +8 -0
  439. package/es6/Sensors/IRfidAntenna.js.map +1 -0
  440. package/es6/bundle.d.ts +12 -0
  441. package/es6/bundle.js +13 -0
  442. package/es6/bundle.js.map +1 -0
  443. package/package.json +70 -0
@@ -0,0 +1,93 @@
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
+ ::: table-responsive
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
+ :::
25
+
26
+ ## upgrade()
27
+ Method `upgrade()` will upgrade current firmware version to a specified one.
28
+
29
+ ::: table-responsive
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="red">Yes</div> | FW version |
35
+ |^^|^^|^^| `T-HKMLAKUC-2080.4` |
36
+ :::
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
+
49
+ <div class="row d-flex align-content-stretch force-padding-20">
50
+ <div class="col-12 d-flex">
51
+ <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/">
52
+ <div>
53
+ <div class="wide-box__image d-flex align-items-center">
54
+ <i class="fab fa-github svg-black"></i>
55
+ </div>
56
+ <div>
57
+ <h3 class="wide-box__title wide-box__title__small pl-85">How to upgrade firmware</h3>
58
+ <div class="wide-box__description">Working example on our Github</div>
59
+ </div>
60
+ </div>
61
+ </a>
62
+ </div>
63
+ </div>
64
+
65
+ ## getVersion()
66
+ Method `getVersion()` will specify what current version of firmware is installed on a device.
67
+
68
+ ### Javascript example
69
+ ```javascript
70
+ sos.management.firmware.getVersion().then((version) => {
71
+ console.log(version); // Returns String e.g. T-HKMLAKUC-2020.5
72
+ });
73
+ ```
74
+
75
+ ## getType()
76
+ 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.
77
+
78
+ ::: table-responsive
79
+ | Type | Description |
80
+ | ------------- | -------------------------------------- |
81
+ | `rpi` | any Raspberry Pi 3 or Compute Module 3 |
82
+ | `rpi4` | any Raspberry Pi 4 or Compute Module 4 |
83
+ | `benq-` | any Benq display |
84
+ | `philips-` | any Philips display |
85
+ | `sharp-` | any Sharp display |
86
+ | `elo-` | any Elo display |
87
+ :::
88
+
89
+ ### Javascript example
90
+ ```javascript
91
+ const type = await sos.management.firmware.getType();
92
+ console.log(type); // e.g. rpi4
93
+ ```
@@ -0,0 +1,73 @@
1
+ ---
2
+ title: IR Remote control
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] Remote control API allows you to enable, disable and check status of remote control of your device."
12
+ ---
13
+
14
+ # IR Remote control
15
+ Remote control API allows you to enable, disable and check status of remote control of your device.
16
+
17
+ ## All methods
18
+
19
+ ::: table-responsive
20
+ | Method | Description | Supported since |
21
+ | ------ | ------ | -------- | :-------------: |
22
+ | `enable()` | Enables IR Remote control allows you to operate the device with IR Remote control (available alias `unlock()`) | 3.0.0 |
23
+ | `disable()` | Disables IR Remote control allows you to operate the device with IR Remote control (available alias `lock()`) | 3.0.0 |
24
+ | `isEnabled()` | Check is the IR Remote control is enabled or not (available alias `isLocked()`) | 3.0.0 |
25
+ ::: table-responsive
26
+
27
+
28
+ ## enable()
29
+ Method `enable()` allows for a simple on state of remote control on your device.
30
+
31
+ ::: alert alert--danger
32
+ **Android Devices Attention Required:**
33
+ In order to prevent Android from displaying Android homepage and thus not showing your content, you must Enable Kiosk Mode (or Lock Remote Control) either through Box device settings or through API.
34
+
35
+ Always set the Remote Control Lock to `enable` after the deployment.
36
+ :::
37
+
38
+ ```javascript
39
+ await sos.management.remoteControl.enable(); // Returns void
40
+ // or await sos.management.remoteControl.unlock();
41
+ ```
42
+
43
+ <div class="row d-flex align-content-stretch force-padding-20">
44
+ <div class="col-12 d-flex">
45
+ <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/remote/">
46
+ <div>
47
+ <div class="wide-box__image d-flex align-items-center">
48
+ <i class="fab fa-github svg-black"></i>
49
+ </div>
50
+ <div>
51
+ <h3 class="wide-box__title wide-box__title__small pl-85">Enable remote control on device</h3>
52
+ <div class="wide-box__description">Working example on our Github</div>
53
+ </div>
54
+ </div>
55
+ </a>
56
+ </div>
57
+ </div>
58
+
59
+ ## disable()
60
+ Method `disable()` allows for a simple off state of remote control on your device.
61
+
62
+ ```javascript
63
+ await sos.management.remoteControl.disable(); // Returns void
64
+ // or await sos.management.remoteControl.lock();
65
+ ```
66
+
67
+ ## isEnabled()
68
+ Method `isEnabled()` allows to check whether the remote control is turned on or off.
69
+
70
+ ```javascript
71
+ await sos.management.remoteControl.isEnabled(); // Returns boolean
72
+ // or await sos.management.remoteControl.isLocked();
73
+ ```
@@ -0,0 +1,94 @@
1
+ ---
2
+ title: Power
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] POWER allows you to reboot the system, restart the application and set timer."
12
+ ---
13
+
14
+ # Power
15
+ Management API power allows you to reboot the system, restart the application and set timer.
16
+
17
+ ## All methods
18
+
19
+ ::: table-responsive
20
+ | Methods | Description | Supported since |
21
+ | ------ | ------ | ------------- |
22
+ | `systemReboot()` | Safely reboot device | 3.0.0 |
23
+ | `appRestart()` | Restart Core App | 3.0.0 |
24
+ | `setTimer()` | Timer - when the device turns on and off based on the days in a week | 3.0.0 |
25
+ :::
26
+
27
+ ## systemReboot()
28
+ Method `systemReboot()` will reboot a targeted device.
29
+
30
+ ```javascript
31
+ await sos.management.power.systemReboot(); // Returns void
32
+ ```
33
+
34
+ <div class="row d-flex align-content-stretch force-padding-20">
35
+ <div class="col-12 d-flex">
36
+ <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/system-reboot/">
37
+ <div>
38
+ <div class="wide-box__image d-flex align-items-center">
39
+ <i class="fab fa-github svg-black"></i>
40
+ </div>
41
+ <div>
42
+ <h3 class="wide-box__title wide-box__title__small pl-85">Management System Reboot</h3>
43
+ <div class="wide-box__description">Working example on our Github</div>
44
+ </div>
45
+ </div>
46
+ </a>
47
+ </div>
48
+ </div>
49
+
50
+ ## appRestart()
51
+ Method `appRestart()` will restart the application on a targeted device.
52
+
53
+ ```javascript
54
+ await sos.management.power.appRestart(); // Returns void
55
+ ```
56
+
57
+ ## setTimer()
58
+ Method `setTimer()` will set the time of the timer.
59
+
60
+ ::: table-responsive
61
+ | Param | Type | Required |Description |
62
+ | -------------- | ----------------------| :-------: | ---------------------------- |
63
+ | `type` | TimerType | <div class="red">Yes</div> | 7 slots for your timers |
64
+ |^^|^^|^^| `TIMER_1`, `TIMER_2`, `TIMER_3`, `TIMER_4`, `TIMER_5`, `TIMER_6`, `TIMER_7` |
65
+ | `timeOn` | String or null | <div class="red">Yes</div> | When the device/display should be turned on |
66
+ |^^|^^|^^| `00:00:00` - `23:59:00` |
67
+ | `timeOff` | String or null | <div class="red">Yes</div> | When the device/display should be turned off |
68
+ |^^|^^|^^| `00:00:00` - `23:59:00` |
69
+ | `weekdays` | TimerWeekday[] | <div class="red">Yes</div> | Weekdays when timer is applied |
70
+ |^^|^^|^^| `sun`, `mon`, `tue`, `wed`, `thu`, `fri`, `sat` |
71
+ | `volume` | Number | <div class="red">Yes</div> | Volume level set when the device/display is turned on |
72
+ |^^|^^|^^| `0` - `100` |
73
+ :::
74
+
75
+ ### Javascript example
76
+ ```javascript
77
+ await sos.management.power.setTimer("TIMER_1", "09:00:00", "23:00:05", ["mon"], 10);
78
+ ```
79
+
80
+ <div class="row d-flex align-content-stretch force-padding-20">
81
+ <div class="col-12 d-flex">
82
+ <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/timer/">
83
+ <div>
84
+ <div class="wide-box__image d-flex align-items-center">
85
+ <i class="fab fa-github svg-black"></i>
86
+ </div>
87
+ <div>
88
+ <h3 class="wide-box__title wide-box__title__small pl-85">How to use timer in Applet</h3>
89
+ <div class="wide-box__description">Working example on our Github</div>
90
+ </div>
91
+ </div>
92
+ </a>
93
+ </div>
94
+ </div>
@@ -0,0 +1,263 @@
1
+ ---
2
+ title: Screen
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 screen allows for manipulation with screen resolution, orientation, content, set displays brightness, retrieve current brightness of your display and manipulate with the power mode. It enables you to turn display on, off and check whether the display is on/off."
12
+ ---
13
+
14
+ # Screen
15
+ Management API screen allows for manipulation with screen resolution, orientation, content, set displays brightness, retrieve current brightness of your display and manipulate with the power mode. It enables you to turn display on, off and check whether the display is on/off.
16
+
17
+ ::: alert alert--warning
18
+ This method turns on/off only display/backlight. It will **not** set any power-safe mode. We strongly recommend to
19
+ reboot any device once a day.
20
+ :::
21
+
22
+ ## All methods
23
+
24
+ ::: table-responsive
25
+ | Method | Description | Supported since |
26
+ | ------ | ------ | -------- | :-------------: |
27
+ | `resize()` | Set screen settings like resolution, orientation and video orientation | 3.0.0 |
28
+ | `getOrientation()` | Get screen orientation | 4.7.0 |
29
+ | `setBrightness()` | Set screen brightness | 3.0.0 |
30
+ | `getBrightness()` | Get current brightness value | 3.0.0 |
31
+ | `powerOn()` | Turn `ON` the display (only the display) | 3.0.0 |
32
+ | `powerOff()` | Turn `OFF` the display (only the display) | 3.0.0 |
33
+ | `isPoweredOn()` | Check the display status | 3.0.0 |
34
+ | `takeAndUploadScreenshot()` | Takes screenshot from the device and upload it to server | 3.0.0 |
35
+ :::
36
+
37
+
38
+ ## resize()
39
+ Method `resize()` helps you manipulate with several aspects of your displays screen settings.
40
+
41
+ ::: table-responsive
42
+ | Param |Type | Required | Description |
43
+ | -------------- | -------------------| :----------: | -------------------- |
44
+ | `baseUrl` | String | <div class="red">Yes</div> | SSSP & Tizen devices requires to install a orientation-specific Core App if you want to switch orientation to portrait or landscape. |
45
+ |^^|^^|^^| `https://cdn.your-cms.com/tizen/1.0.4` |
46
+ | `orientation` | Orientation | <div class="red">Yes</div> | Screen orientation |
47
+ |^^|^^|^^| `PORTRAIT`, `LANDSCAPE`, `PORTRAIT_FLIPED`, `LANDSCAPE_FLIPPED`, `AUTO` |
48
+ | `resolution` | Resolution | <div class="red">Yes</div> | Where it applies (mainly SSSP 2/3) |
49
+ |^^|^^|^^| `FULL_HD`, `HD_READY` |
50
+ | `currentVersion` | String | <div class="red">Yes</div> | Core App version |
51
+ |^^|^^|^^| `1.0.4` |
52
+ | `videoOrientation` | VideoOrientation | <div class="red">Yes</div> | If the video has different orientation than the HTML5 content |
53
+ |^^|^^|^^| `LANDSCAPE`, `PORTRAIT` |
54
+ :::
55
+
56
+ ::: alert alert--info
57
+ For Tizen, you have to provide `baseUrl` which points to your server where you uploaded previously built Core App for Tizen with your buiult-in Applet. [Read more how to upload your Core Apps here.](https://docs.signageos.io/knowledge-base/open-standalone-signageos-provisioning#tizen-specific-installation-url).
58
+ :::
59
+
60
+ ### Javascript example
61
+ ```javascript
62
+ // for Tizen
63
+ await sos.management.screen.resize(
64
+ "https://cdn.your-cms.com/tizen/1.0.4",
65
+ "PORTRAIT",
66
+ "FULL_READY",
67
+ "1.0.4"
68
+ );
69
+
70
+ //for all other supported device
71
+ await sos.management.screen.resize(
72
+ "",
73
+ "PORTRAIT",
74
+ "HD_READY",
75
+ ""
76
+ );
77
+ ```
78
+
79
+ <div class="row d-flex align-content-stretch force-padding-20">
80
+ <div class="col-12 d-flex">
81
+ <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/resize/">
82
+ <div>
83
+ <div class="wide-box__image d-flex align-items-center">
84
+ <i class="fab fa-github svg-black"></i>
85
+ </div>
86
+ <div>
87
+ <h3 class="wide-box__title wide-box__title__small pl-85">How to resize screen on device</h3>
88
+ <div class="wide-box__description">Working example on our Github</div>
89
+ </div>
90
+ </div>
91
+ </a>
92
+ </div>
93
+ </div>
94
+
95
+ ## getOrientation()
96
+ Method `getOrientation()` lets you check current orientation of the screen. Possible values are listed in the table above.
97
+
98
+ ### Javascript example
99
+ ```javascript
100
+ await sos.management.screen.getOrientation();
101
+ ```
102
+
103
+ ## setBrightness()
104
+ Function `setBrightness()` lets you control the power of brightness emmited by your device and even set different brightness during the day.
105
+
106
+ ::: table-responsive
107
+ | Param |Type | Required | Description |
108
+ | -------------- | ---------------------| :--------: | --------------------- |
109
+ | `timeFrom1` | String | <div class="red">Yes</div> | Day time since `brightness1` value will be applied (eg. 06:00, 24hour values) |
110
+ |^^|^^|^^| Example: `00:00` - `23:59` |
111
+ | `brightness1` | Number | <div class="red">Yes</div> | Brightness level `0-100` |
112
+ |^^|^^|^^| Example: `0` - `100` |
113
+ | `timeFrom2` | String | <div class="red">Yes</div> | Day time since `brightness2` value will be applied (eg. 22:00, 24hour values) |
114
+ |^^|^^|^^| Example: `00:00` - `23:59` |
115
+ | `brightness2` | Number | <div class="red">Yes</div> | Brightness level `0-100` |
116
+ |^^|^^|^^| Example: `0` - `100` |
117
+ :::
118
+
119
+ ### Javascript example
120
+ ```javascript
121
+ await sos.management.screen.setBrightness(
122
+ '00:00',
123
+ '10',
124
+ '17:00',
125
+ '30'
126
+ );
127
+ ```
128
+
129
+ <div class="row d-flex align-content-stretch force-padding-20">
130
+ <div class="col-12 d-flex">
131
+ <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/brightness/">
132
+ <div>
133
+ <div class="wide-box__image d-flex align-items-center">
134
+ <i class="fab fa-github svg-black"></i>
135
+ </div>
136
+ <div>
137
+ <h3 class="wide-box__title wide-box__title__small pl-85">How change brightness on device</h3>
138
+ <div class="wide-box__description">Working example on our Github</div>
139
+ </div>
140
+ </div>
141
+ </a>
142
+ </div>
143
+ </div>
144
+
145
+ ## getBrightness()
146
+ Method `getBrightness()` lets you check the power of brightness emitted by your device.
147
+
148
+ ### Javascript example
149
+ ```javascript
150
+ await sos.management.screen.getBrightness();
151
+ ```
152
+
153
+ ### Example of response
154
+ ```json
155
+ {
156
+ "timeFrom1": "06:00:00",
157
+ "brightness1": 80,
158
+ "timeFrom2": "22:00:00",
159
+ "brightness2": 40
160
+ }
161
+ ```
162
+
163
+ ## powerOn()
164
+ Method `powerOn()` turns on the targeted display.
165
+
166
+ ```javascript
167
+ await sos.management.screen.powerOn(); // Returns void
168
+ ```
169
+
170
+ <div class="row d-flex align-content-stretch force-padding-20">
171
+ <div class="col-12 d-flex">
172
+ <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/display/">
173
+ <div>
174
+ <div class="wide-box__image d-flex align-items-center">
175
+ <i class="fab fa-github svg-black"></i>
176
+ </div>
177
+ <div>
178
+ <h3 class="wide-box__title wide-box__title__small pl-85">Management Display</h3>
179
+ <div class="wide-box__description">Working example on our Github</div>
180
+ </div>
181
+ </div>
182
+ </a>
183
+ </div>
184
+ </div>
185
+
186
+ ## powerOff()
187
+ Method `powerOff()` turns off the targeted display.
188
+
189
+ ```javascript
190
+ await sos.management.screen.powerOff(); // Returns void
191
+ ```
192
+
193
+ ## isPoweredOn()
194
+ Method `isPoweredOn()` lets you check whether the display is turned on or off.
195
+
196
+ ```javascript
197
+ await sos.management.screen.isPoweredOn(); // Returns boolean
198
+ ```
199
+
200
+ ## takeAndUploadScreenshot()
201
+ Method `takeAndUploadScreenshot()` will upload a screenshot directly to the device.
202
+
203
+ ::: table-responsive
204
+ | Param |Type | Required | Description |
205
+ | -------------- | ----------------------------- | :------: | ---------------------- |
206
+ | `uploadBaseUrl` | String | <div class="red">Yes</div>| Location of your Upload server for screenshots |
207
+ |^^|^^|^^| Example: `https://upload-screenshot.your-cms.com` |
208
+ :::
209
+
210
+ ### Javascript example
211
+ ```javascript
212
+ await sos.management.screen.takeAndUploadScreenshot(
213
+ 'https://upload-screenshot.your-cms.com'
214
+ );
215
+ ```
216
+
217
+ <div class="row d-flex align-content-stretch force-padding-20">
218
+ <div class="col-12 d-flex">
219
+ <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/screenshot-upload/">
220
+ <div>
221
+ <div class="wide-box__image d-flex align-items-center">
222
+ <i class="fab fa-github svg-black"></i>
223
+ </div>
224
+ <div>
225
+ <h3 class="wide-box__title wide-box__title__small pl-85">Management Screenshot Upload</h3>
226
+ <div class="wide-box__description">Working example on our Github</div>
227
+ </div>
228
+ </div>
229
+ </a>
230
+ </div>
231
+ </div>
232
+
233
+ <br>
234
+
235
+ ::: alert alert--warning
236
+ Open users (who is using screenshot capturing on device using JS API) have to run their own server for uploading screenshots. It differs for every platform! So it's not easy to achieve the unified output (screenshots url upload).
237
+ There are 2 options how to manage this:
238
+
239
+ **Option 1.**
240
+ Specify the signageOS upload URL which is available for every our partner. However it's not granted SLA on this server for open users. The URL is https://upload.signageos.io
241
+
242
+ Cons:
243
+ - internet required (no local instances in local networks).
244
+ - SLA is not granted, dependency on signageos infrastructure for open users.
245
+
246
+ Pros:
247
+ - it's easy to use
248
+ - zero configuration, zero programming work needed
249
+
250
+ **Option 2.**
251
+ There is available standalone server for uploading screenshots with all available methods of uploading for every platform (Tizen, Webos, Linux etc.). It's created in node.js and open users have to host it on the own infrastructure.
252
+
253
+ Cons:
254
+ - The screenshot traffic needed to be paid/covered.
255
+ - The upload server needs to be configured and managed by our customer who is running it.
256
+
257
+ Pros:
258
+ - it's signageOS independent
259
+ - it can be run in local, close networks without internet access (or firewalls)
260
+ - zero programming work and cost needed
261
+
262
+ **The standalone server is available on request via the support ticketing system: [create new support ticket](https://docs.signageos.io/tickets/create)**
263
+ :::
@@ -0,0 +1,166 @@
1
+ ---
2
+ title: Time
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 time allows you to check your devices current time with a timezone and set current time with a timezone."
12
+ ---
13
+
14
+ # Time
15
+ Management API time allows you to check your devices current time with a timezone and set current time with a timezone.
16
+
17
+ ## All methods
18
+
19
+ ::: table-responsive
20
+ | Method | Description | Supported since |
21
+ | ----------- | ------------------------------------------------- | :---------------: |
22
+ | `get()` | Get current time settings | 4.0.0 |
23
+ | `setManual()` | Set manual datetime and timezone | 4.0.0 |
24
+ | `setNTP()` | Configure NTP server and timezone | 4.0.0 |
25
+ | `set()` | Set manual datetime and timezone (**DEPRECATED**) | 4.0.0 |
26
+ :::
27
+
28
+ ## get()
29
+ Method `get()` lets you check for current time with time zone.
30
+
31
+ ### Javascript example
32
+ ```javascript
33
+ const time = await sos.management.time.get();
34
+ ```
35
+
36
+ <div class="row d-flex align-content-stretch force-padding-20">
37
+ <div class="col-12 d-flex">
38
+ <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/time/">
39
+ <div>
40
+ <div class="wide-box__image d-flex align-items-center">
41
+ <i class="fab fa-github svg-black"></i>
42
+ </div>
43
+ <div>
44
+ <h3 class="wide-box__title wide-box__title__small pl-85">How to manage time on device</h3>
45
+ <div class="wide-box__description">Working example on our Github</div>
46
+ </div>
47
+ </div>
48
+ </a>
49
+ </div>
50
+ </div>
51
+
52
+ <br>
53
+
54
+ ### Example of response
55
+
56
+ When NTP is set:
57
+
58
+ ```json
59
+ {
60
+ "currentDate": Date("2019-04-01T01:11:11.111Z"),
61
+ "timezone": "Asia/Tokyo",
62
+ "ntpServer": "pool.ntp.org"
63
+ }
64
+ ```
65
+
66
+ When NTP is not set:
67
+
68
+ ```json
69
+ {
70
+ "currentDate": Date("2019-04-01T01:11:11.111Z"),
71
+ "timezone": "Asia/Tokyo"
72
+ }
73
+ ```
74
+
75
+ ## set()
76
+ Method `set()` lets you set manual time and timezone of the device.
77
+
78
+ ::: alert alert--warning
79
+ This method is deprecated. Use `setManual()` instead.
80
+ :::
81
+
82
+ ::: alert alert--info
83
+ Calling `set()` will disable NTP server settings.
84
+ :::
85
+
86
+ ::: table-responsive
87
+ | Param |Type | Required | Description |
88
+ | -------------- | ---------- | :---------: | ------------------- |
89
+ | `currentDate` | Date | <div class="red">Yes</div> | Datetime to set |
90
+ | `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). |
91
+ :::
92
+
93
+ ### Javascript example
94
+ ```javascript
95
+ const currentDate = new Date();
96
+ const timezone = "Europe/Amsterdam";
97
+ await sos.management.time.set(currentDate, timezone);
98
+ ```
99
+
100
+ ::: alert alert--warning
101
+ Setting time and timezone has side effects:
102
+
103
+ | Platform | Side effect |
104
+ | ----------- | -------------------------------------------- |
105
+ | Tizen | After calling this API, display **Reboots**! |
106
+ | webOS | After calling this API, display **Reboots**! |
107
+ | 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. |
108
+ :::
109
+
110
+ ## setManual()
111
+ Method `setManual()` lets you set manual time and timezone of the device.
112
+
113
+ ::: alert alert--info
114
+ Calling `setManual()` will disable NTP server settings.
115
+ :::
116
+
117
+ ::: table-responsive
118
+ | Param |Type | Required | Description |
119
+ | -------------- | ---------- | :---------: | ------------------- |
120
+ | `currentDate` | Date | <div class="red">Yes</div> | Datetime to set |
121
+ | `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). |
122
+ :::
123
+
124
+ ### Javascript example
125
+ ```javascript
126
+ const currentDate = new Date();
127
+ const timezone = "Europe/Amsterdam";
128
+ await sos.management.time.setManual(currentDate, timezone);
129
+ ```
130
+
131
+
132
+ ::: alert alert--warning
133
+ Setting time and timezone has side effects:
134
+
135
+ | Platform | Side effect |
136
+ | ----------- | -------------------------------------------- |
137
+ | Tizen | After calling this API, display **Reboots**! |
138
+ | webOS | After calling this API, display **Reboots**! |
139
+ | 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. |
140
+ :::
141
+
142
+ ## setNTP()
143
+ Method `setNTP()` lets you configure NTP server and timezone.
144
+
145
+ ::: table-responsive
146
+ | Param |Type | Required | Description |
147
+ | -------------- | ---------- | :----------: | ------------------ |
148
+ | `ntpServer` | string | <div class="red">Yes</div> | Address of the NTP server |
149
+ | `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). |
150
+ :::
151
+
152
+ ### Javascript example
153
+ ```javascript
154
+ const ntpServer = "pool.ntp.org";
155
+ const timezone = "Europe/Amsterdam";
156
+ await sos.management.time.setNTP(ntpServer, timezone);
157
+ ```
158
+
159
+ ::: alert alert--warning
160
+ Setting NTP server and timezone has side effects:
161
+
162
+ | Platform | Side effect |
163
+ | ----------- | -------------------------------------------- |
164
+ | Tizen | After calling this API, display **Reboots**!<br/><br/> Tizen has [**limited set of available timezones**. Read more here.](knowledge-base/debugging-guides-tizen-timezones) |
165
+ | 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. |
166
+ :::