@signageos/front-applet 7.2.0 → 8.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (421) hide show
  1. package/dist/bundle.js +8 -4
  2. package/dist/bundle.js.map +1 -1
  3. package/docs/fpath/index.md +316 -0
  4. package/docs/index.md +19 -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 +91 -39
  43. package/es6/FrontApplet/Browser/Browser.js.map +1 -1
  44. package/es6/FrontApplet/Browser/events.js +2 -2
  45. package/es6/FrontApplet/Browser/events.js.map +1 -1
  46. package/es6/FrontApplet/Command/Command.d.ts +37 -3
  47. package/es6/FrontApplet/Command/Command.js +49 -20
  48. package/es6/FrontApplet/Command/Command.js.map +1 -1
  49. package/es6/FrontApplet/Command/ICommandEvent.d.ts +6 -2
  50. package/es6/FrontApplet/Connect/Connect.d.ts +3 -0
  51. package/es6/FrontApplet/Connect/Connect.js +55 -7
  52. package/es6/FrontApplet/Connect/Connect.js.map +1 -1
  53. package/es6/FrontApplet/Connect/IConnectMessage.d.ts +1 -1
  54. package/es6/FrontApplet/Debug/Debug.d.ts +15 -1
  55. package/es6/FrontApplet/Debug/Debug.js +27 -17
  56. package/es6/FrontApplet/Debug/Debug.js.map +1 -1
  57. package/es6/FrontApplet/Debug/debugDecorator.d.ts +3 -3
  58. package/es6/FrontApplet/Debug/debugDecorator.js +13 -7
  59. package/es6/FrontApplet/Debug/debugDecorator.js.map +1 -1
  60. package/es6/FrontApplet/DeviceInfo/DeviceInfo.d.ts +23 -0
  61. package/es6/FrontApplet/DeviceInfo/DeviceInfo.js +36 -27
  62. package/es6/FrontApplet/DeviceInfo/DeviceInfo.js.map +1 -1
  63. package/es6/FrontApplet/Dimensions/coordinationsHelper.js +1 -2
  64. package/es6/FrontApplet/Dimensions/coordinationsHelper.js.map +1 -1
  65. package/es6/FrontApplet/Display/Display.d.ts +25 -3
  66. package/es6/FrontApplet/Display/Display.js +35 -19
  67. package/es6/FrontApplet/Display/Display.js.map +1 -1
  68. package/es6/FrontApplet/Display/IDisplay.d.ts +3 -1
  69. package/es6/FrontApplet/Error/AppletCommandError.js +12 -3
  70. package/es6/FrontApplet/Error/AppletCommandError.js.map +1 -1
  71. package/es6/FrontApplet/Error/AppletError.js +10 -2
  72. package/es6/FrontApplet/Error/AppletError.js.map +1 -1
  73. package/es6/FrontApplet/Error/AppletHardwareError.js +12 -3
  74. package/es6/FrontApplet/Error/AppletHardwareError.js.map +1 -1
  75. package/es6/FrontApplet/Error/AppletOfflineCacheError.js +10 -2
  76. package/es6/FrontApplet/Error/AppletOfflineCacheError.js.map +1 -1
  77. package/es6/FrontApplet/Error/AppletResourcesError.js +12 -3
  78. package/es6/FrontApplet/Error/AppletResourcesError.js.map +1 -1
  79. package/es6/FrontApplet/Error/AppletSecurityError.js +12 -3
  80. package/es6/FrontApplet/Error/AppletSecurityError.js.map +1 -1
  81. package/es6/FrontApplet/Error/AppletStreamError.js +10 -2
  82. package/es6/FrontApplet/Error/AppletStreamError.js.map +1 -1
  83. package/es6/FrontApplet/Error/AppletVideoError.js +12 -3
  84. package/es6/FrontApplet/Error/AppletVideoError.js.map +1 -1
  85. package/es6/FrontApplet/Error/ErrorCodesMessages.js +4 -1
  86. package/es6/FrontApplet/Error/ErrorCodesMessages.js.map +1 -1
  87. package/es6/FrontApplet/Error/ErrorSuggestions.js +1 -0
  88. package/es6/FrontApplet/Error/ErrorSuggestions.js.map +1 -1
  89. package/es6/FrontApplet/Error/FileNotFoundError.js +10 -2
  90. package/es6/FrontApplet/Error/FileNotFoundError.js.map +1 -1
  91. package/es6/FrontApplet/Error/SosError.js +4 -0
  92. package/es6/FrontApplet/Error/SosError.js.map +1 -1
  93. package/es6/FrontApplet/Error/errorHelper.js +5 -6
  94. package/es6/FrontApplet/Error/errorHelper.js.map +1 -1
  95. package/es6/FrontApplet/Exchange/Exchange.js +7 -14
  96. package/es6/FrontApplet/Exchange/Exchange.js.map +1 -1
  97. package/es6/FrontApplet/FileSystem/FileSystem.d.ts +156 -1
  98. package/es6/FrontApplet/FileSystem/FileSystem.js +316 -193
  99. package/es6/FrontApplet/FileSystem/FileSystem.js.map +1 -1
  100. package/es6/FrontApplet/FileSystem/HashAlgorithm.d.ts +2 -0
  101. package/es6/FrontApplet/{Stream/streamListeners.js → FileSystem/HashAlgorithm.js} +1 -1
  102. package/es6/FrontApplet/FileSystem/HashAlgorithm.js.map +1 -0
  103. package/es6/FrontApplet/Font/fontFaceGenerator.js.map +1 -1
  104. package/es6/FrontApplet/FrontApplet.d.ts +55 -4
  105. package/es6/FrontApplet/FrontApplet.js +124 -47
  106. package/es6/FrontApplet/FrontApplet.js.map +1 -1
  107. package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.d.ts +2 -0
  108. package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.js +35 -54
  109. package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.js.map +1 -1
  110. package/es6/FrontApplet/Hardware/Hardware.d.ts +16 -2
  111. package/es6/FrontApplet/Hardware/Hardware.js +31 -19
  112. package/es6/FrontApplet/Hardware/Hardware.js.map +1 -1
  113. package/es6/FrontApplet/Hardware/IHardware.d.ts +2 -2
  114. package/es6/FrontApplet/Hardware/ISerialPort.d.ts +16 -0
  115. package/es6/FrontApplet/Hardware/ISerialPortOptions.js +1 -1
  116. package/es6/FrontApplet/Hardware/ISerialPortOptions.js.map +1 -1
  117. package/es6/FrontApplet/Hardware/Led/Led.d.ts +8 -0
  118. package/es6/FrontApplet/Hardware/Led/Led.js +20 -18
  119. package/es6/FrontApplet/Hardware/Led/Led.js.map +1 -1
  120. package/es6/FrontApplet/Hardware/SerialPort.d.ts +1 -1
  121. package/es6/FrontApplet/Hardware/SerialPort.js +15 -23
  122. package/es6/FrontApplet/Hardware/SerialPort.js.map +1 -1
  123. package/es6/FrontApplet/Hash/generator.js +1 -2
  124. package/es6/FrontApplet/Hash/generator.js.map +1 -1
  125. package/es6/FrontApplet/Iframe/Iframe.d.ts +9 -8
  126. package/es6/FrontApplet/Iframe/Iframe.js +10 -0
  127. package/es6/FrontApplet/Iframe/Iframe.js.map +1 -1
  128. package/es6/FrontApplet/Input/IInput.d.ts +1 -2
  129. package/es6/FrontApplet/Input/IKeyUpEvent.d.ts +32 -2
  130. package/es6/FrontApplet/Input/IKeyUpEvent.js +32 -0
  131. package/es6/FrontApplet/Input/IKeyUpEvent.js.map +1 -1
  132. package/es6/FrontApplet/Input/Input.d.ts +19 -3
  133. package/es6/FrontApplet/Input/Input.js +43 -22
  134. package/es6/FrontApplet/Input/Input.js.map +1 -1
  135. package/es6/FrontApplet/Management/App/App.d.ts +48 -10
  136. package/es6/FrontApplet/Management/App/App.js +45 -30
  137. package/es6/FrontApplet/Management/App/App.js.map +1 -1
  138. package/es6/FrontApplet/Management/App/IApp.d.ts +3 -1
  139. package/es6/FrontApplet/Management/Audio/Audio.d.ts +16 -0
  140. package/es6/FrontApplet/Management/Audio/Audio.js +30 -22
  141. package/es6/FrontApplet/Management/Audio/Audio.js.map +1 -1
  142. package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.d.ts +4 -0
  143. package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.js +15 -22
  144. package/es6/FrontApplet/Management/AutoRecovery/AutoRecovery.js.map +1 -1
  145. package/es6/FrontApplet/Management/AutoRecovery/IAutoRecovery.js +4 -1
  146. package/es6/FrontApplet/Management/AutoRecovery/IAutoRecovery.js.map +1 -1
  147. package/es6/FrontApplet/Management/Debug/Debug.d.ts +19 -0
  148. package/es6/FrontApplet/Management/Debug/Debug.js +37 -30
  149. package/es6/FrontApplet/Management/Debug/Debug.js.map +1 -1
  150. package/es6/FrontApplet/Management/Firmware/Firmware.d.ts +37 -10
  151. package/es6/FrontApplet/Management/Firmware/Firmware.js +34 -30
  152. package/es6/FrontApplet/Management/Firmware/Firmware.js.map +1 -1
  153. package/es6/FrontApplet/Management/Firmware/IFirmware.d.ts +1 -2
  154. package/es6/FrontApplet/Management/IManagement.d.ts +3 -1
  155. package/es6/FrontApplet/Management/Management.d.ts +106 -15
  156. package/es6/FrontApplet/Management/Management.js +191 -113
  157. package/es6/FrontApplet/Management/Management.js.map +1 -1
  158. package/es6/FrontApplet/Management/Network/INetworkInfo.d.ts +1 -1
  159. package/es6/FrontApplet/Management/Network/Network.d.ts +56 -8
  160. package/es6/FrontApplet/Management/Network/Network.js +85 -67
  161. package/es6/FrontApplet/Management/Network/Network.js.map +1 -1
  162. package/es6/FrontApplet/Management/OS/OS.d.ts +20 -0
  163. package/es6/FrontApplet/Management/OS/OS.js +34 -27
  164. package/es6/FrontApplet/Management/OS/OS.js.map +1 -1
  165. package/es6/FrontApplet/Management/Package/Package.d.ts +20 -0
  166. package/es6/FrontApplet/Management/Package/Package.js +37 -22
  167. package/es6/FrontApplet/Management/Package/Package.js.map +1 -1
  168. package/es6/FrontApplet/Management/PeerRecovery/IPeerRecovery.js +4 -1
  169. package/es6/FrontApplet/Management/PeerRecovery/IPeerRecovery.js.map +1 -1
  170. package/es6/FrontApplet/Management/PeerRecovery/PeerRecovery.d.ts +4 -0
  171. package/es6/FrontApplet/Management/PeerRecovery/PeerRecovery.js +15 -22
  172. package/es6/FrontApplet/Management/PeerRecovery/PeerRecovery.js.map +1 -1
  173. package/es6/FrontApplet/Management/Power/Power.d.ts +64 -0
  174. package/es6/FrontApplet/Management/Power/Power.js +160 -115
  175. package/es6/FrontApplet/Management/Power/Power.js.map +1 -1
  176. package/es6/FrontApplet/Management/Proxy/Proxy.d.ts +21 -0
  177. package/es6/FrontApplet/Management/Proxy/Proxy.js +41 -35
  178. package/es6/FrontApplet/Management/Proxy/Proxy.js.map +1 -1
  179. package/es6/FrontApplet/Management/RemoteControl/RemoteControl.d.ts +43 -0
  180. package/es6/FrontApplet/Management/RemoteControl/RemoteControl.js +63 -39
  181. package/es6/FrontApplet/Management/RemoteControl/RemoteControl.js.map +1 -1
  182. package/es6/FrontApplet/Management/Screen/Screen.d.ts +127 -0
  183. package/es6/FrontApplet/Management/Screen/Screen.js +197 -89
  184. package/es6/FrontApplet/Management/Screen/Screen.js.map +1 -1
  185. package/es6/FrontApplet/Management/Security/Security.d.ts +20 -5
  186. package/es6/FrontApplet/Management/Security/Security.js +33 -31
  187. package/es6/FrontApplet/Management/Security/Security.js.map +1 -1
  188. package/es6/FrontApplet/Management/Time/Time.d.ts +31 -5
  189. package/es6/FrontApplet/Management/Time/Time.js +49 -40
  190. package/es6/FrontApplet/Management/Time/Time.js.map +1 -1
  191. package/es6/FrontApplet/Management/Wifi/IWifiEvent.d.ts +18 -0
  192. package/es6/FrontApplet/Management/Wifi/IWifiEvent.js +19 -1
  193. package/es6/FrontApplet/Management/Wifi/IWifiEvent.js.map +1 -1
  194. package/es6/FrontApplet/Management/Wifi/Wifi.d.ts +108 -7
  195. package/es6/FrontApplet/Management/Wifi/Wifi.js +162 -86
  196. package/es6/FrontApplet/Management/Wifi/Wifi.js.map +1 -1
  197. package/es6/FrontApplet/Management/helpers/DeviceHelper.js +2 -2
  198. package/es6/FrontApplet/Management/helpers/DeviceHelper.js.map +1 -1
  199. package/es6/FrontApplet/Management/helpers/SecurityHelper.js +8 -6
  200. package/es6/FrontApplet/Management/helpers/SecurityHelper.js.map +1 -1
  201. package/es6/FrontApplet/Management/helpers/TimerHelper.js +2 -2
  202. package/es6/FrontApplet/Management/helpers/TimerHelper.js.map +1 -1
  203. package/es6/FrontApplet/Management/helpers/UpgradeHelper.js +35 -3
  204. package/es6/FrontApplet/Management/helpers/UpgradeHelper.js.map +1 -1
  205. package/es6/FrontApplet/Management/helpers/VideoHelper.js +1 -1
  206. package/es6/FrontApplet/Management/helpers/VideoHelper.js.map +1 -1
  207. package/es6/FrontApplet/Monitors/Monitors.d.ts +9 -0
  208. package/es6/FrontApplet/Monitors/Monitors.js +16 -16
  209. package/es6/FrontApplet/Monitors/Monitors.js.map +1 -1
  210. package/es6/FrontApplet/NativeCommands/MDC/CodesMDC.js +1 -1
  211. package/es6/FrontApplet/NativeCommands/MDC/CodesMDC.js.map +1 -1
  212. package/es6/FrontApplet/NativeCommands/MDC/Mdc.d.ts +51 -2
  213. package/es6/FrontApplet/NativeCommands/MDC/Mdc.js +79 -38
  214. package/es6/FrontApplet/NativeCommands/MDC/Mdc.js.map +1 -1
  215. package/es6/FrontApplet/NativeCommands/NativeCommands.d.ts +4 -0
  216. package/es6/FrontApplet/NativeCommands/NativeCommands.js +12 -2
  217. package/es6/FrontApplet/NativeCommands/NativeCommands.js.map +1 -1
  218. package/es6/FrontApplet/OSD/OSD.d.ts +9 -0
  219. package/es6/FrontApplet/OSD/OSD.js +15 -15
  220. package/es6/FrontApplet/OSD/OSD.js.map +1 -1
  221. package/es6/FrontApplet/Offline/Cache/Cache.d.ts +91 -2
  222. package/es6/FrontApplet/Offline/Cache/Cache.js +192 -130
  223. package/es6/FrontApplet/Offline/Cache/Cache.js.map +1 -1
  224. package/es6/FrontApplet/Offline/Flags/AppendFlagController.d.ts +1 -1
  225. package/es6/FrontApplet/Offline/Flags/AppendFlagController.js +17 -25
  226. package/es6/FrontApplet/Offline/Flags/AppendFlagController.js.map +1 -1
  227. package/es6/FrontApplet/Offline/Flags/IFlags.d.ts +4 -4
  228. package/es6/FrontApplet/Offline/IAddFont.d.ts +3 -1
  229. package/es6/FrontApplet/Offline/IAddFont.js.map +1 -1
  230. package/es6/FrontApplet/Offline/ISaveFile.js +5 -2
  231. package/es6/FrontApplet/Offline/ISaveFile.js.map +1 -1
  232. package/es6/FrontApplet/Offline/LoadFile/CssLoadFileController.js +2 -1
  233. package/es6/FrontApplet/Offline/LoadFile/CssLoadFileController.js.map +1 -1
  234. package/es6/FrontApplet/Offline/LoadFile/JavascriptLoadFileController.js +2 -1
  235. package/es6/FrontApplet/Offline/LoadFile/JavascriptLoadFileController.js.map +1 -1
  236. package/es6/FrontApplet/Offline/Offline.d.ts +75 -4
  237. package/es6/FrontApplet/Offline/Offline.js +116 -56
  238. package/es6/FrontApplet/Offline/Offline.js.map +1 -1
  239. package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.d.ts +19 -1
  240. package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.js +41 -29
  241. package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.js.map +1 -1
  242. package/es6/FrontApplet/Sensors/Proximity.d.ts +4 -3
  243. package/es6/FrontApplet/Sensors/Proximity.js +12 -4
  244. package/es6/FrontApplet/Sensors/Proximity.js.map +1 -1
  245. package/es6/FrontApplet/Sensors/Sensors.d.ts +2 -0
  246. package/es6/FrontApplet/Sensors/Sensors.js +9 -2
  247. package/es6/FrontApplet/Sensors/Sensors.js.map +1 -1
  248. package/es6/FrontApplet/Stream/IStream.d.ts +10 -10
  249. package/es6/FrontApplet/Stream/Stream.d.ts +130 -15
  250. package/es6/FrontApplet/Stream/Stream.js +229 -130
  251. package/es6/FrontApplet/Stream/Stream.js.map +1 -1
  252. package/es6/FrontApplet/Stream/StreamProtocol.js.map +1 -1
  253. package/es6/FrontApplet/Sync/Sync.d.ts +152 -6
  254. package/es6/FrontApplet/Sync/Sync.js +196 -112
  255. package/es6/FrontApplet/Sync/Sync.js.map +1 -1
  256. package/es6/FrontApplet/Sync/syncEvents.d.ts +3 -1
  257. package/es6/FrontApplet/Sync/syncMessages.js +1 -1
  258. package/es6/FrontApplet/Sync/syncMessages.js.map +1 -1
  259. package/es6/FrontApplet/Timing/Timing.d.ts +1 -0
  260. package/es6/FrontApplet/Timing/Timing.js +9 -2
  261. package/es6/FrontApplet/Timing/Timing.js.map +1 -1
  262. package/es6/FrontApplet/Timing/Triggers/ITimingTriggersMessage.d.ts +1 -1
  263. package/es6/FrontApplet/Timing/Triggers/Triggers.d.ts +9 -0
  264. package/es6/FrontApplet/Timing/Triggers/Triggers.js +16 -18
  265. package/es6/FrontApplet/Timing/Triggers/Triggers.js.map +1 -1
  266. package/es6/FrontApplet/Touch/Touch.d.ts +3 -0
  267. package/es6/FrontApplet/Touch/Touch.js +13 -3
  268. package/es6/FrontApplet/Touch/Touch.js.map +1 -1
  269. package/es6/FrontApplet/Validate/Validate.js +14 -11
  270. package/es6/FrontApplet/Validate/Validate.js.map +1 -1
  271. package/es6/FrontApplet/Validate/ValidateObjectInterface.js +7 -2
  272. package/es6/FrontApplet/Validate/ValidateObjectInterface.js.map +1 -1
  273. package/es6/FrontApplet/Video/IOptions.d.ts +8 -1
  274. package/es6/FrontApplet/Video/IVideo.d.ts +8 -8
  275. package/es6/FrontApplet/Video/IVideoEvent.js +3 -3
  276. package/es6/FrontApplet/Video/IVideoEvent.js.map +1 -1
  277. package/es6/FrontApplet/Video/Video.d.ts +84 -12
  278. package/es6/FrontApplet/Video/Video.js +161 -102
  279. package/es6/FrontApplet/Video/Video.js.map +1 -1
  280. package/es6/FrontApplet/createFrontApplet.js +5 -2
  281. package/es6/FrontApplet/createFrontApplet.js.map +1 -1
  282. package/es6/Monitoring/Display/handleDisplayRequests.d.ts +2 -2
  283. package/es6/Monitoring/Display/handleDisplayRequests.js +5 -15
  284. package/es6/Monitoring/Display/handleDisplayRequests.js.map +1 -1
  285. package/es6/Monitoring/FileSystem/fileSystemCommands.d.ts +10 -1
  286. package/es6/Monitoring/FileSystem/fileSystemCommands.js +3 -1
  287. package/es6/Monitoring/FileSystem/fileSystemCommands.js.map +1 -1
  288. package/es6/Monitoring/FileSystem/handleFileSystemRequests.d.ts +2 -2
  289. package/es6/Monitoring/FileSystem/handleFileSystemRequests.js +41 -45
  290. package/es6/Monitoring/FileSystem/handleFileSystemRequests.js.map +1 -1
  291. package/es6/Monitoring/Html/handleHtmlSnapshotTakingRequests.d.ts +2 -2
  292. package/es6/Monitoring/Html/handleHtmlSnapshotTakingRequests.js +4 -14
  293. package/es6/Monitoring/Html/handleHtmlSnapshotTakingRequests.js.map +1 -1
  294. package/es6/Monitoring/Management/App/handleApplicationRequests.d.ts +2 -2
  295. package/es6/Monitoring/Management/App/handleApplicationRequests.js +9 -19
  296. package/es6/Monitoring/Management/App/handleApplicationRequests.js.map +1 -1
  297. package/es6/Monitoring/Management/Audio/handleAudioRequests.d.ts +2 -2
  298. package/es6/Monitoring/Management/Audio/handleAudioRequests.js +7 -17
  299. package/es6/Monitoring/Management/Audio/handleAudioRequests.js.map +1 -1
  300. package/es6/Monitoring/Management/AutoRecovery/handleAutoRecoveryRequests.d.ts +2 -2
  301. package/es6/Monitoring/Management/AutoRecovery/handleAutoRecoveryRequests.js +7 -17
  302. package/es6/Monitoring/Management/AutoRecovery/handleAutoRecoveryRequests.js.map +1 -1
  303. package/es6/Monitoring/Management/Debug/handleDebugRequests.d.ts +2 -2
  304. package/es6/Monitoring/Management/Debug/handleDebugRequests.js +9 -19
  305. package/es6/Monitoring/Management/Debug/handleDebugRequests.js.map +1 -1
  306. package/es6/Monitoring/Management/Network/handleManagementNetworkRequests.d.ts +2 -2
  307. package/es6/Monitoring/Management/Network/handleManagementNetworkRequests.js +11 -21
  308. package/es6/Monitoring/Management/Network/handleManagementNetworkRequests.js.map +1 -1
  309. package/es6/Monitoring/Management/Os/managementOsRequests.d.ts +2 -2
  310. package/es6/Monitoring/Management/Os/managementOsRequests.js +9 -19
  311. package/es6/Monitoring/Management/Os/managementOsRequests.js.map +1 -1
  312. package/es6/Monitoring/Management/PeerRecovery/handlePeerRecoveryRequests.d.ts +2 -2
  313. package/es6/Monitoring/Management/PeerRecovery/handlePeerRecoveryRequests.js +7 -17
  314. package/es6/Monitoring/Management/PeerRecovery/handlePeerRecoveryRequests.js.map +1 -1
  315. package/es6/Monitoring/Management/Power/handlePowerRequests.d.ts +2 -2
  316. package/es6/Monitoring/Management/Power/handlePowerRequests.js +19 -29
  317. package/es6/Monitoring/Management/Power/handlePowerRequests.js.map +1 -1
  318. package/es6/Monitoring/Management/RemoteControl/handleRemoteControlRequests.d.ts +2 -2
  319. package/es6/Monitoring/Management/RemoteControl/handleRemoteControlRequests.js +15 -25
  320. package/es6/Monitoring/Management/RemoteControl/handleRemoteControlRequests.js.map +1 -1
  321. package/es6/Monitoring/Management/Screen/handleScreenRequests.d.ts +2 -2
  322. package/es6/Monitoring/Management/Screen/handleScreenRequests.js +19 -29
  323. package/es6/Monitoring/Management/Screen/handleScreenRequests.js.map +1 -1
  324. package/es6/Monitoring/Management/Security/handleSecurityCommands.d.ts +2 -2
  325. package/es6/Monitoring/Management/Security/handleSecurityCommands.js +9 -19
  326. package/es6/Monitoring/Management/Security/handleSecurityCommands.js.map +1 -1
  327. package/es6/Monitoring/Management/Time/handleTimeCommands.d.ts +2 -2
  328. package/es6/Monitoring/Management/Time/handleTimeCommands.js +9 -19
  329. package/es6/Monitoring/Management/Time/handleTimeCommands.js.map +1 -1
  330. package/es6/Monitoring/Management/handleManagementRequests.d.ts +2 -2
  331. package/es6/Monitoring/Management/handleManagementRequests.js +23 -33
  332. package/es6/Monitoring/Management/handleManagementRequests.js.map +1 -1
  333. package/es6/Monitoring/{Montoring.d.ts → Monitoring.d.ts} +1 -0
  334. package/es6/Monitoring/{Montoring.js → Monitoring.js} +12 -23
  335. package/es6/Monitoring/Monitoring.js.map +1 -0
  336. package/es6/Monitoring/NativeCommands/handleNativeCommands.d.ts +2 -2
  337. package/es6/Monitoring/NativeCommands/handleNativeCommands.js +5 -15
  338. package/es6/Monitoring/NativeCommands/handleNativeCommands.js.map +1 -1
  339. package/es6/Monitoring/OSD/handleOsdRequests.d.ts +2 -2
  340. package/es6/Monitoring/OSD/handleOsdRequests.js +5 -15
  341. package/es6/Monitoring/OSD/handleOsdRequests.js.map +1 -1
  342. package/es6/Monitoring/Offline/Cache/handleOfflineCacheRequests.d.ts +2 -2
  343. package/es6/Monitoring/Offline/Cache/handleOfflineCacheRequests.js +23 -33
  344. package/es6/Monitoring/Offline/Cache/handleOfflineCacheRequests.js.map +1 -1
  345. package/es6/Monitoring/Video/handleVideoRequests.d.ts +2 -2
  346. package/es6/Monitoring/Video/handleVideoRequests.js +36 -9
  347. package/es6/Monitoring/Video/handleVideoRequests.js.map +1 -1
  348. package/es6/Monitoring/handleMonitoringRequests.d.ts +2 -2
  349. package/es6/Monitoring/handleMonitoringRequests.js +6 -16
  350. package/es6/Monitoring/handleMonitoringRequests.js.map +1 -1
  351. package/es6/Sensors/IButton.js +1 -1
  352. package/es6/Sensors/IButton.js.map +1 -1
  353. package/es6/Sensors/IRfidAntenna.js +1 -1
  354. package/es6/Sensors/IRfidAntenna.js.map +1 -1
  355. package/es6/Util/Console/enhancer.js +1 -2
  356. package/es6/Util/Console/enhancer.js.map +1 -1
  357. package/es6/bundle.d.ts +1 -1
  358. package/es6/bundle.js +6 -3
  359. package/es6/bundle.js.map +1 -1
  360. package/es6/fpath.js +34 -1
  361. package/es6/fpath.js.map +1 -1
  362. package/es6/utils/types.d.ts +1 -0
  363. package/es6/{FrontApplet/Input/IKeyUpEventListener.js → utils/types.js} +1 -1
  364. package/es6/utils/types.js.map +1 -0
  365. package/package.json +27 -25
  366. package/CHANGELOG.md +0 -484
  367. package/docs/README.md +0 -5
  368. package/docs/applet-basics.md +0 -272
  369. package/docs/content/js-applet-resources.md +0 -154
  370. package/docs/content/js-browser.md +0 -163
  371. package/docs/content/js-command.md +0 -154
  372. package/docs/content/js-debug.md +0 -36
  373. package/docs/content/js-device-info.md +0 -56
  374. package/docs/content/js-display.md +0 -56
  375. package/docs/content/js-file-system.md +0 -670
  376. package/docs/content/js-fonts.md +0 -115
  377. package/docs/content/js-hardware.md +0 -55
  378. package/docs/content/js-iframes.md +0 -66
  379. package/docs/content/js-input.md +0 -71
  380. package/docs/content/js-offline-cache-media-files.md +0 -257
  381. package/docs/content/js-offline-cache-simple-data.md +0 -129
  382. package/docs/content/js-osd.md +0 -32
  383. package/docs/content/js-proof-of-play.md +0 -60
  384. package/docs/content/js-sensors.md +0 -70
  385. package/docs/content/js-serial.md +0 -165
  386. package/docs/content/js-sync-playback.md +0 -384
  387. package/docs/content/js-video-inputs-internal-ports.md +0 -131
  388. package/docs/content/js-video-stream.md +0 -618
  389. package/docs/content/js-video.md +0 -232
  390. package/docs/management/js-management-application.md +0 -107
  391. package/docs/management/js-management-audio.md +0 -44
  392. package/docs/management/js-management-debug.md +0 -40
  393. package/docs/management/js-management-firmware.md +0 -93
  394. package/docs/management/js-management-management.md +0 -178
  395. package/docs/management/js-management-monitoring-commands.md +0 -107
  396. package/docs/management/js-management-monitors.md +0 -55
  397. package/docs/management/js-management-native-commands-mdc.md +0 -90
  398. package/docs/management/js-management-network.md +0 -223
  399. package/docs/management/js-management-os.md +0 -62
  400. package/docs/management/js-management-package.md +0 -48
  401. package/docs/management/js-management-power.md +0 -175
  402. package/docs/management/js-management-proxy.md +0 -81
  403. package/docs/management/js-management-remote-control.md +0 -58
  404. package/docs/management/js-management-screen.md +0 -225
  405. package/docs/management/js-management-security.md +0 -71
  406. package/docs/management/js-management-time.md +0 -161
  407. package/docs/management/js-management-wifi.md +0 -341
  408. package/es6/FrontApplet/Command/ICommandEventListener.d.ts +0 -6
  409. package/es6/FrontApplet/Command/ICommandEventListener.js +0 -3
  410. package/es6/FrontApplet/Command/ICommandEventListener.js.map +0 -1
  411. package/es6/FrontApplet/Input/IKeyUpEventListener.d.ts +0 -5
  412. package/es6/FrontApplet/Input/IKeyUpEventListener.js.map +0 -1
  413. package/es6/FrontApplet/Management/Firmware/FirmwareType.d.ts +0 -4
  414. package/es6/FrontApplet/Management/Firmware/FirmwareType.js +0 -9
  415. package/es6/FrontApplet/Management/Firmware/FirmwareType.js.map +0 -1
  416. package/es6/FrontApplet/Stream/streamListeners.d.ts +0 -10
  417. package/es6/FrontApplet/Stream/streamListeners.js.map +0 -1
  418. package/es6/FrontApplet/Video/IVideoEventListener.d.ts +0 -5
  419. package/es6/FrontApplet/Video/IVideoEventListener.js +0 -3
  420. package/es6/FrontApplet/Video/IVideoEventListener.js.map +0 -1
  421. package/es6/Monitoring/Montoring.js.map +0 -1
@@ -1,161 +0,0 @@
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
-
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
- ## get()
28
- Method `get()` lets you check for current time with time zone.
29
-
30
- ### Javascript example
31
- ```javascript
32
- const time = await sos.management.time.get();
33
- ```
34
-
35
- :::note[GitHub Example]
36
- [How to manage time on device](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/time)
37
- :::
38
-
39
- ### Example of response
40
-
41
- When NTP is set:
42
-
43
- ```json
44
- {
45
- "currentDate": Date("2019-04-01T01:11:11.111Z"),
46
- "timezone": "Asia/Tokyo",
47
- "ntpServer": "pool.ntp.org"
48
- }
49
- ```
50
-
51
- When NTP is not set:
52
-
53
- ```json
54
- {
55
- "currentDate": Date("2019-04-01T01:11:11.111Z"),
56
- "timezone": "Asia/Tokyo"
57
- }
58
- ```
59
-
60
- ## set()
61
- Method `set()` lets you set manual time and timezone of the device.
62
-
63
- :::warning
64
- This method is deprecated. Use `setManual()` instead.
65
- :::
66
-
67
- :::info
68
- Calling `set()` will disable NTP server settings.
69
- :::
70
-
71
-
72
- | Param |Type | Required | Description |
73
- | -------------- | ---------- | :---------: | ------------------- |
74
- | `currentDate` | Date | <div class="red">Yes</div> | Datetime to set |
75
- | `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).
76
-
77
- ### Javascript example
78
- ```javascript
79
- const currentDate = new Date();
80
- const timezone = "Europe/Amsterdam";
81
- await sos.management.time.set(currentDate, timezone);
82
- ```
83
-
84
- :::warning
85
- Setting time and timezone has side effects:
86
-
87
- | Platform | Side effect |
88
- | ----------- | -------------------------------------------- |
89
- | Tizen | After calling this API, display **Reboots**! |
90
- | webOS | After calling this API, display **Reboots**! |
91
- | 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.
92
-
93
- ## setManual()
94
- Method `setManual()` lets you set manual time and timezone of the device.
95
-
96
- :::info
97
- Calling `setManual()` will disable NTP server settings.
98
- :::
99
-
100
-
101
- | Param |Type | Required | Description |
102
- | -------------- | ---------- | :---------: | ------------------- |
103
- | `currentDate` | Date \| object | <div class="red">Yes</div> | Datetime to set |
104
- | `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).
105
-
106
- ### Javascript example
107
- ```javascript
108
- const datetimeObj = {
109
- year: 2021,
110
- month: 12,
111
- day: 15,
112
- hour: 9,
113
- minute: 30,
114
- seconds: 0,
115
- };
116
- const timezone = "Europe/Amsterdam";
117
- await sos.management.time.setManual(datetimeObj, timezone);
118
-
119
- // Using Date is deprecated. Use the example above.
120
- const currentDate = new Date();
121
- const timezone = "Europe/Amsterdam";
122
- await sos.management.time.setManual(currentDate, timezone);
123
- ```
124
-
125
- :::warning
126
- Calling this method with currentDate as Date is deprecated.
127
- You should call it with datetime object instead. See example code.
128
- :::
129
-
130
- :::warning
131
- Setting time and timezone has side effects:
132
-
133
- | Platform | Side effect |
134
- | ----------- | -------------------------------------------- |
135
- | Tizen | After calling this API, display **Reboots**! |
136
- | webOS | After calling this API, display **Reboots**! |
137
- | 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.
138
-
139
- ## setNTP()
140
- Method `setNTP()` lets you configure NTP server and timezone.
141
-
142
-
143
- | Param |Type | Required | Description |
144
- | -------------- | ---------- | :----------: | ------------------ |
145
- | `ntpServer` | string | <div class="red">Yes</div> | Address of the NTP server |
146
- | `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).
147
-
148
- ### Javascript example
149
- ```javascript
150
- const ntpServer = "pool.ntp.org";
151
- const timezone = "Europe/Amsterdam";
152
- await sos.management.time.setNTP(ntpServer, timezone);
153
- ```
154
-
155
- :::warning
156
- Setting NTP server and timezone has side effects:
157
-
158
- | Platform | Side effect |
159
- | ----------- | -------------------------------------------- |
160
- | Tizen | After calling this API, display **Reboots**!<br/><br/> Tizen has [**limited set of available timezones**. Read more here.](https://docs.signageos.io/hc/en-us/articles/4405381271314) |
161
- | 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.
@@ -1,341 +0,0 @@
1
- ---
2
- title: Wi-Fi
3
- author: Michal Artazov
4
- date: 1.9.2020
5
- type: js-management-api
6
- tags:
7
- - applet
8
- - applet_api
9
- - api
10
- - js_management_api
11
- description: "[Management JS API] Wi-Fi API allows you to configure Wi-Fi, if the device supports it."
12
- ---
13
-
14
- # Wi-Fi
15
-
16
- Wi-Fi API allows you to configure Wi-Fi, if the device supports it.
17
-
18
- :::warning
19
- * Before using this API, ensure that the device supports Wi-Fi via `sos.management.supports("WIFI")`.
20
- * More info about how to check it, you can find [**THERE**](js-management-management#supports)
21
- :::
22
-
23
- ## State management
24
- Wi-Fi can be in several states. Depending on which state it is in, its behavior will vary. The 3 possible states are:
25
-
26
- * DISABLED
27
- * CLIENT
28
- * AP
29
-
30
- :::info
31
- It is only allowed to switch to another state when in the DISABLED state. It is not allowed to go directly from CLIENT to AP or vice versa.
32
- :::
33
-
34
- ### DISABLED
35
-
36
- Wi-Fi is disabled. The DISABLED state is persistent between reboots.
37
-
38
- ### CLIENT
39
-
40
- Wi-Fi is in the client state, i.e. it is capable of connecting to a network, similarly to a phone or laptop.
41
- CLIENT state is persistent between reboots with all of its configuration.
42
-
43
- ### AP
44
-
45
- Wi-Fi is in access point state, i.e. it itself becomes a Wi-Fi network that others can connect to.
46
- AP state is not persistent and on reboot the device will be in DISABLED state.
47
-
48
- ## Country settings
49
-
50
- Different regulations apply to Wi-Fi communication in different countries.
51
- Under normal circumstances, everything should work with default settings.
52
- However, if you experience any problems, you might want to try changing Wi-Fi country configuration to your country.
53
- See [`getCountry()`](js-management-wifi#getcountry) and [`setCountry()`](js-management-wifi#setcountry) methods.
54
-
55
- ## All methods
56
-
57
-
58
- | Methods | Description | Supported since |
59
- | -------------------- | ------------------------------------------------------------------ | :---------------: |
60
- | `isClientEnabled()` | Is in CLIENT state? | 4.3.0 |
61
- | `enableClient()` | Switch to CLIENT state | 4.3.0 |
62
- | `isAPEnabled()` | Is in AP state? | 4.3.0 |
63
- | `enableAP()` | Switch to AP state | 4.3.0 |
64
- | `disable()` | Switch to DISABLED state | 4.3.0 |
65
- | `getConnectedTo()` | When in CLIENT state, return which network it is connected to | 4.3.0 |
66
- | `connect()` | When in CLIENT state, connect to a network | 4.3.0 |
67
- | `disconnect()` | When in CLIENT state, disconnect from a network | 4.3.0 |
68
- | `getCountry()` | Get which country Wi-Fi is configured for | 4.3.0 |
69
- | `setCountry()` | Configure Wi-Fi for a specific country | 4.3.0 |
70
- | `scanDevices()` | When in CLIENT or AP states, scan available networks | 4.3.0 |
71
- | `on()` | Call listener anytime an event is emitted | 4.3.0 |
72
- | `once()` | Call listener the first time an event is emitted | 4.3.0 |
73
- | `removeListener()` | Remove a listener previously registered via on() or once() methods | 4.3.0 |
74
- | `removeAllListeners()` | Remove all listeners | 4.3.0
75
-
76
- ## Events
77
-
78
-
79
- | Event | Description |
80
- | ------------------- | -------------------------------------------------------- |
81
- | `client_enabled` | Wi-Fi was set to CLIENT state |
82
- | `client_connected` | Wi-Fi is in CLIENT state and connected to a network |
83
- | `client_disconnected` | Wi-Fi is in CLIENT state and disconnected from a network |
84
- | `ap_enabled` | Wi-Fi was set to AP state |
85
- | `disabled` | Wi-Fi was set to DISABLED state
86
-
87
- ## Examples
88
-
89
- :::note[GitHub Example]
90
- [Applet with Wi-Fi Access Point](https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/wifi-access-point/)
91
- :::
92
-
93
- ## isClientEnabled()
94
- Returns true, if Wi-Fi is in CLIENT state. Otherwise, returns false.
95
-
96
- ### Javascript example
97
- ```javascript
98
- const isClientEnabled = await sos.management.wifi.isClientEnabled();
99
- if (isClientEnabled) {
100
- // do something
101
- }
102
- ```
103
-
104
- ## enableClient()
105
- Sets Wi-Fi to CLIENT state, meaning it has the ability to connect to a Wi-Fi network or scan available networks in the area.
106
-
107
- :::info
108
- It is not allowed to call this method, when in AP state. You must first switch to **DISABLED** state.
109
- :::
110
-
111
- ### Javascript example
112
- ```javascript
113
- await sos.management.wifi.enableClient();
114
- ```
115
-
116
- ## isAPEnabled()
117
- Returns true, if Wi-Fi is in AP state. Otherwise, returns false.
118
-
119
- ### Javascript example
120
- ```javascript
121
- const isAPEnabled = await sos.management.wifi.isAPEnabled();
122
- if (isAPEnabled) {
123
- // do something
124
- }
125
- ```
126
-
127
- ## enableAP()
128
- Sets Wi-Fi to AP state, meaning the device will become a Wi-Fi network that other devices can connect to.
129
- It will run in WPA-Personal mode. As such, it requires an SSID (network name) and password that other devices will use to connect.
130
-
131
- :::info
132
- * It is not allowed to call this method when in CLIENT state. You must first switch to **DISABLED** state.
133
- * Before calling this method, make sure the device supports Wi-Fi AP via `sos.management.supports("WIFI_AP")`
134
- :::
135
-
136
-
137
- | Param | Type | Required | Description |
138
- | -------- | ------ | :----------: | ---------------------------------------------------------------------------------------------- |
139
- | `ssid` | String | <div class="red">Yes</div> | Device will be visible as a Wi-Fi network with this name. Max. allowed length is 32 characters. |
140
- | `password` | String | <div class="red">Yes</div> | Devices that wish to connect to this network will use this password. Must be between 8 and 32 characters.
141
-
142
- ### Javascript example
143
- ```javascript
144
- await sos.management.wifi.enableAP("my_network", "secretPassword123#");
145
- ```
146
-
147
- ## disable()
148
- Sets Wi-Fi to **DISABLED** state. All previously configured networks will be forgotten.
149
-
150
- ### Javascript example
151
- ```javascript
152
- await sos.management.wifi.disable();
153
- ```
154
-
155
- ## getConnectedTo()
156
- If connected to a Wi-Fi network, returns the name of the network. Otherwise, returns null.
157
-
158
- :::info
159
- It is only allowed to call this method in CLIENT state.
160
- :::
161
-
162
- ### Javascript example
163
-
164
- ```javascript
165
- const connectedTo = await sos.management.wifi.getConnectedTo();
166
- ```
167
-
168
- ## connect()
169
- Connect to a network.
170
-
171
- :::info
172
- It is only allowed to call this method in the **CLIENT** state.
173
- :::
174
-
175
-
176
- | Param | Type | Required | Description |
177
- | ------------------- | ------ | :---------: | ---------------------------------- |
178
- | `ssid` | String | <div class="red">Yes</div> | Name of the network you want to connect to. |
179
- | `password` | String | <div class="yellow">No</div> | Network's password. |
180
- | `options` | Object | <div class="yellow">No</div> | Additional options.
181
-
182
- ### Javascript example
183
- ```javascript
184
- // network without password
185
- await sos.management.wifi.connect('network1');
186
-
187
- // or network with password
188
- await sos.management.wifi.connect('network2', 'password123');
189
-
190
- // connect to a hidden network
191
- await sos.management.wifi.connect('network3', 'password123', { hidden: true });
192
- ```
193
-
194
- ## disconnect()
195
- Disconnect from the network, if connected to one.
196
-
197
- :::info
198
- It is only allowed to call this method in the **CLIENT** state.
199
- :::
200
-
201
- ### Javascript example
202
-
203
- ```javascript
204
- await sos.management.wifi.disconnect();
205
- ```
206
-
207
- ## getCountry()
208
- Get currently configured country code.
209
-
210
- :::info
211
- It is not allowed to call this method in the **DISABLED** state.
212
- :::
213
-
214
- ### Javascript example
215
- ```javascript
216
- const countryCode = await sos.management.wifi.getCountry();
217
- ```
218
-
219
- ## setCountry()
220
- Configure Wi-Fi for country-specific regulations.
221
-
222
- :::info
223
- It is not allowed to call this method in the **DISABLED** state.
224
- :::
225
-
226
-
227
- | Param | Type | Required | Description |
228
- | ----------- | ------ | :-----------: | -------------------------------------------------------------------------------------------- |
229
- | `countryCode` | String | <div class="red">Yes</div> |2-letter country code. See this [list of countries and their codes](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
230
-
231
- ### Javascript example
232
- ```javascript
233
- await sos.management.wifi.setCountry('ES');
234
- ```
235
-
236
- ## scanDevices()
237
- Get list of available Wi-Fi networks in the area.
238
-
239
- :::info
240
- * It is only allowed to call this method in the **CLIENT** state.
241
- * Before calling this method, make sure the device supports scanning via `sos.management.supports("WIFI_SCAN")`
242
- :::
243
-
244
- ### Javascript example
245
- ```javascript
246
- const devices = await sos.management.wifi.scanDevices();
247
- ```
248
-
249
- ## on()
250
- Call a callback everytime an event is emitted.
251
-
252
-
253
- | Param | Type | Required | Description |
254
- | -------- | -------- | :--------------: | --------------------------------------------------- |
255
- | `event` | String | <div class="red">Yes</div> | Event name. See [events](js-management-wifi#events) for valid event names. |
256
- | `listener` | Method | <div class="red">Yes</div> | Callback that will be called everytime the given event is emitted
257
-
258
- ### Javascript example
259
- ```javascript
260
- sos.management.wifi.on('client_connected', () => {
261
- console.log('Wi-Fi is connected');
262
- });
263
- sos.management.wifi.on('client_disconnected', () => {
264
- console.log('Wi-Fi is disconnected');
265
- });
266
- ```
267
-
268
- ## once()
269
- Call a callback the first time an event is emitted.
270
-
271
-
272
- | Param | Type | Required | Description |
273
- | -------- | -------- | :------------: | ----------------------------------------------------- |
274
- | `event` | String | <div class="red">Yes</div> | Event name. See [events](js-management-wifi#events) for valid event names. |
275
- | `listener` | Method | <div class="red">Yes</div> | Callback that will be called everytime the given event is emitted
276
-
277
- ### Javascript example
278
- ```javascript
279
- sos.management.wifi.once('client_connected', () => {
280
- console.log('Wi-Fi is connected');
281
- });
282
- sos.management.wifi.once('client_disconnected', () => {
283
- console.log('Wi-Fi is disconnected');
284
- });
285
- ```
286
-
287
- ## removeListener()
288
- Remove an event listener previously registered via [`on`](js-management-wifi#on) or [`once`](js-management-wifi#once).
289
-
290
-
291
- | Param | Type | Required | Description |
292
- | -------- | -------- | :----------: | ------------------------------------------------------- |
293
- | `event` | String | <div class="red">Yes</div> | Event name. See [events](js-management-wifi#events) for valid event names. |
294
- | `listener` | Method | <div class="red">Yes</div> | Callback that was previously registered
295
-
296
- ### Javascript example
297
- ```javascript
298
- // first register a listener
299
- const listener = () => {
300
- console.log('Wi-Fi is connected');
301
- };
302
- sos.management.wifi.on('client_connected', listener);
303
-
304
- // then remove it
305
- sos.management.wifi.removeListener('client_connected', listener);
306
-
307
- // now if client_connected is emitted, the listener callback wouldn't be called anymore
308
- ```
309
-
310
- ## removeAllListeners()
311
- Remove all listeners previously registered via [`on`](js-management-wifi#on) or [`once`](js-management-wifi#once), either for a specific event or for all events.
312
-
313
-
314
- | Param | Type | Required | Description |
315
- | ---------------- | ------ | :--------: | -------------------------------------------------------- |
316
- | `event` | String | <div class="yellow">No</div> | Event name. See [events](js-management-wifi#events) for valid event names.
317
-
318
- ### Javascript example
319
- ```javascript
320
- // first register a listener
321
- sos.management.wifi.on('client_connected', () => {
322
- console.log('Wi-Fi is connected');
323
- });
324
-
325
- // then remove it
326
- sos.management.wifi.removeAllListeners('client_connected');
327
- // now if client_connected is emitted, the listener callback wouldn't be called anymore
328
-
329
- // next remove all listeners
330
- sos.management.wifi.removeAllListeners();
331
- // now if any event is emitted, no listener callbacks would be called
332
- ```
333
-
334
- ### FAQ
335
- - Do I need to reboot my RPi for the Wi-Fi changes to take place?<br/>
336
- No, the device will automatically adapt to any saved changes
337
-
338
- - How can I tell if the device has successfuly connected to the network?<br/>
339
- Once the device starts the connecting process and sucessfully connects, 2 events will be emmited:<br/>
340
- 1. client_enabled
341
- 1. client_connected
@@ -1,6 +0,0 @@
1
- import ICommandEvent from './ICommandEvent';
2
- import ICommand from './ICommand';
3
- interface ICommandEventListener<TCommand extends ICommand> {
4
- (event: ICommandEvent<TCommand>): void;
5
- }
6
- export default ICommandEventListener;
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=ICommandEventListener.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ICommandEventListener.js","sourceRoot":"","sources":["../../../src/FrontApplet/Command/ICommandEventListener.ts"],"names":[],"mappings":""}
@@ -1,5 +0,0 @@
1
- import IKeyUpEvent from './IKeyUpEvent';
2
- interface IKeyUpEventListener {
3
- (event: IKeyUpEvent): void;
4
- }
5
- export default IKeyUpEventListener;
@@ -1 +0,0 @@
1
- {"version":3,"file":"IKeyUpEventListener.js","sourceRoot":"","sources":["../../../src/FrontApplet/Input/IKeyUpEventListener.ts"],"names":[],"mappings":""}
@@ -1,4 +0,0 @@
1
- export declare enum FirmwareType {
2
- RPI3 = "rpi",
3
- RPI4 = "rpi4"
4
- }
@@ -1,9 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.FirmwareType = void 0;
4
- var FirmwareType;
5
- (function (FirmwareType) {
6
- FirmwareType["RPI3"] = "rpi";
7
- FirmwareType["RPI4"] = "rpi4";
8
- })(FirmwareType = exports.FirmwareType || (exports.FirmwareType = {}));
9
- //# sourceMappingURL=FirmwareType.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"FirmwareType.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Firmware/FirmwareType.ts"],"names":[],"mappings":";;;AAAA,IAAY,YAGX;AAHD,WAAY,YAAY;IACvB,4BAAY,CAAA;IACZ,6BAAa,CAAA;AACd,CAAC,EAHW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAGvB"}
@@ -1,10 +0,0 @@
1
- import { IStreamErrorEvent, IStreamEvent, IStreamTracksChangedEvent, StreamEventType } from './streamEvents';
2
- export interface IStreamEventListener<T extends StreamEventType> {
3
- (event: IStreamEvent<T>): void;
4
- }
5
- export interface IStreamErrorEventListener extends IStreamEventListener<'error'> {
6
- (event: IStreamErrorEvent): void;
7
- }
8
- export interface IStreamTracksChangedEventListener extends IStreamEventListener<'tracks_changed'> {
9
- (event: IStreamTracksChangedEvent): void;
10
- }
@@ -1 +0,0 @@
1
- {"version":3,"file":"streamListeners.js","sourceRoot":"","sources":["../../../src/FrontApplet/Stream/streamListeners.ts"],"names":[],"mappings":""}
@@ -1,5 +0,0 @@
1
- import IVideoEvent from './IVideoEvent';
2
- interface IVideoEventListener {
3
- (event: IVideoEvent): void;
4
- }
5
- export default IVideoEventListener;
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=IVideoEventListener.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"IVideoEventListener.js","sourceRoot":"","sources":["../../../src/FrontApplet/Video/IVideoEventListener.ts"],"names":[],"mappings":""}
@@ -1 +0,0 @@
1
- {"version":3,"file":"Montoring.js","sourceRoot":"","sources":["../../src/Monitoring/Montoring.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,4DAAuD;AAIvD,oFAAiF;AACjF,8FAA2F;AAC3F,2FAAwF;AACxF,qEAAkE;AAClE,+DAA4D;AAC5D,0FAAiG;AACjG,gFAAuF;AACvF,2EAAwE;AACxE,+DAA0D;AAC1D,oFAAiF;AACjF,mFAA0F;AAC1F,yFAAgG;AAChG,gFAAuF;AACvF,wGAA+G;AAC/G,gFAAuF;AACvF,+EAAkF;AAClF,yEAAsE;AACtE,6EAAoF;AACpF,gFAAkG;AAClG,0GAAuG;AACvG,qGAA4G;AAC5G,qGAA4G;AAC5G,uDAAyE;AAEzE,MAAqB,UAAU;IAC9B,YAAoB,WAAwB;QAAxB,gBAAW,GAAX,WAAW,CAAa;QAC3C,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAC/B,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1B,IAAA,mDAAwB,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChG,IAAA,mEAAgC,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACxG,IAAA,uDAA0B,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClG,IAAA,yCAAmB,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC3F,IAAA,mDAAwB,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChG,IAAA,qCAAiB,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACzF,IAAA,+DAAmC,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC3G,IAAA,mDAA6B,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACrG,IAAA,6CAAqB,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC7F,IAAA,mDAAwB,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChG,IAAA,qDAA8B,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACtG,IAAA,yDAAgC,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACxG,IAAA,mDAA6B,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACrG,IAAA,mEAAqC,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC7G,IAAA,mDAA6B,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACrG,IAAA,iDAA0B,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClG,IAAA,iDAA4B,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACpG,IAAA,gEAAyC,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACjH,IAAA,iEAA+B,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACvG,IAAA,iEAAoC,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5G,IAAA,iEAAoC,EAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC7G,CAAC;IAEO,SAAS,CAA4B,QAAyC;QACrF,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,OAAgC,EAAE,EAAE;YACvE,IAAI,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,aAAa,EAAE;gBACzF,QAAQ,CAAC,OAAO,CAAC,CAAC;aAClB;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAEa,QAAQ,CAA4B,OAAiB;;YAClE,IAAI,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,KAAK,QAAQ,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,aAAa,EAAE;gBACzF,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,CAAW,OAAO,CAAC,CAAC;aAC3D;QACF,CAAC;KAAA;IAEa,kBAAkB;;YAC/B,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;YACjC,MAAM,IAAI,CAAC,QAAQ,CAAe,EAAE,IAAI,EAAE,6BAAY,EAAE,CAAC,CAAC;QAC3D,CAAC;KAAA;IAEO,uBAAuB;QAC9B,IAAA,wCAA6B,EAAC,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,EAAE;YAC/C,IAAI,CAAC,QAAQ,CAAgB;gBAC5B,IAAI,EAAE,+BAAa;gBACnB,KAAK,EAAE,IAAI;gBACX,QAAQ,EAAE,IAAI;aACd,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;CACD;AAvDD,6BAuDC"}