@switchbot/homebridge-switchbot 5.0.0-beta.70 → 5.0.0-beta.71

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 (534) hide show
  1. package/.github/ISSUE_TEMPLATE/e2e-verification.md +36 -0
  2. package/.github/workflows/ci.yml +61 -0
  3. package/.github/workflows/manual-e2e.yml +103 -0
  4. package/CHANGELOG.md +20 -0
  5. package/E2E-VERIFICATION.md +121 -0
  6. package/MIGRATION.md +44 -0
  7. package/README.md +11 -0
  8. package/config.schema.json +99 -1940
  9. package/dist/deviceFactory.d.ts +13 -0
  10. package/dist/deviceFactory.d.ts.map +1 -0
  11. package/dist/deviceFactory.js +81 -0
  12. package/dist/deviceFactory.js.map +1 -0
  13. package/dist/devices/deviceBase.d.ts +50 -0
  14. package/dist/devices/deviceBase.d.ts.map +1 -0
  15. package/dist/devices/deviceBase.js +119 -0
  16. package/dist/devices/deviceBase.js.map +1 -0
  17. package/dist/devices/genericDevice.d.ts +283 -0
  18. package/dist/devices/genericDevice.d.ts.map +1 -0
  19. package/dist/devices/genericDevice.js +1035 -0
  20. package/dist/devices/genericDevice.js.map +1 -0
  21. package/dist/homebridge-ui/public/index.html +72 -440
  22. package/dist/homebridge-ui/server.d.ts +3 -1
  23. package/dist/homebridge-ui/server.d.ts.map +1 -1
  24. package/dist/homebridge-ui/server.js +47 -10
  25. package/dist/homebridge-ui/server.js.map +1 -1
  26. package/dist/index.d.ts.map +1 -1
  27. package/dist/index.js +3 -5
  28. package/dist/index.js.map +1 -1
  29. package/dist/platform.d.ts +27 -0
  30. package/dist/platform.d.ts.map +1 -0
  31. package/dist/platform.js +404 -0
  32. package/dist/platform.js.map +1 -0
  33. package/dist/settings.d.ts +10 -317
  34. package/dist/settings.d.ts.map +1 -1
  35. package/dist/settings.js +5 -30
  36. package/dist/settings.js.map +1 -1
  37. package/dist/switchbotClient.d.ts +32 -0
  38. package/dist/switchbotClient.d.ts.map +1 -0
  39. package/dist/switchbotClient.js +259 -0
  40. package/dist/switchbotClient.js.map +1 -0
  41. package/dist/utils.d.ts +36 -248
  42. package/dist/utils.d.ts.map +1 -1
  43. package/dist/utils.js +38 -1367
  44. package/dist/utils.js.map +1 -1
  45. package/docs/assets/icons.js +1 -1
  46. package/docs/assets/icons.svg +1 -1
  47. package/docs/assets/style.css +3 -3
  48. package/docs/index.html +50 -15
  49. package/docs/variables/default.html +1 -1
  50. package/package.json +19 -18
  51. package/scripts/e2e/README.md +25 -0
  52. package/scripts/e2e/curtain-e2e.sh +70 -0
  53. package/scripts/e2e/fan-e2e.sh +75 -0
  54. package/scripts/e2e/light-advanced-e2e.sh +97 -0
  55. package/scripts/e2e/light-e2e.sh +75 -0
  56. package/scripts/e2e/list-accessories.sh +19 -0
  57. package/scripts/e2e/lock-e2e.sh +65 -0
  58. package/scripts/generate-matter-maps.js +60 -0
  59. package/scripts/run-e2e-local.sh +14 -0
  60. package/src/deviceFactory.ts +122 -0
  61. package/src/devices/deviceBase.ts +141 -0
  62. package/src/devices/genericDevice.ts +965 -0
  63. package/src/homebridge-ui/public/index.html +72 -440
  64. package/src/homebridge-ui/server.ts +52 -10
  65. package/src/index.ts +3 -5
  66. package/src/platform.ts +395 -0
  67. package/src/settings.ts +12 -352
  68. package/src/switchbotClient.ts +266 -0
  69. package/src/utils.ts +47 -1456
  70. package/test/accessory-restore.spec.ts +73 -0
  71. package/test/device-mapping.spec.ts +37 -0
  72. package/test/deviceFactory.spec.ts +18 -0
  73. package/test/e2e/run-e2e.spec.ts +50 -0
  74. package/test/fan-swing.spec.ts +29 -0
  75. package/test/helpers/matter-harness.ts +53 -0
  76. package/test/lock-users.spec.ts +44 -0
  77. package/test/matter-childbridge.spec.ts +55 -0
  78. package/test/matter-descriptors.spec.ts +97 -0
  79. package/test/matter-device-state.spec.ts +101 -0
  80. package/test/matter-integration.spec.ts +70 -0
  81. package/test/platform.integration.spec.ts +55 -0
  82. package/test/switchbot-client-debounce.spec.ts +131 -0
  83. package/test/switchbot-client-openapi.spec.ts +56 -0
  84. package/test/switchbotClient.spec.ts +10 -0
  85. package/test/utils.spec.ts +20 -0
  86. package/vitest.config.ts +7 -0
  87. package/coverage/base.css +0 -224
  88. package/coverage/block-navigation.js +0 -87
  89. package/coverage/clover.xml +0 -15847
  90. package/coverage/coverage-final.json +0 -42
  91. package/coverage/docs/assets/dmt/dmt-component-data.js.html +0 -85
  92. package/coverage/docs/assets/dmt/dmt-components.js.html +0 -286
  93. package/coverage/docs/assets/dmt/index.html +0 -131
  94. package/coverage/docs/assets/hierarchy.js.html +0 -85
  95. package/coverage/docs/assets/icons.js.html +0 -136
  96. package/coverage/docs/assets/index.html +0 -146
  97. package/coverage/docs/assets/main.js.html +0 -265
  98. package/coverage/favicon.png +0 -0
  99. package/coverage/index.html +0 -191
  100. package/coverage/prettify.css +0 -1
  101. package/coverage/prettify.js +0 -2
  102. package/coverage/sort-arrow-sprite.png +0 -0
  103. package/coverage/sorter.js +0 -196
  104. package/coverage/src/device/blindtilt.ts.html +0 -3238
  105. package/coverage/src/device/bot.ts.html +0 -2803
  106. package/coverage/src/device/ceilinglight.ts.html +0 -2338
  107. package/coverage/src/device/colorbulb.ts.html +0 -2824
  108. package/coverage/src/device/contact.ts.html +0 -1465
  109. package/coverage/src/device/curtain.ts.html +0 -2869
  110. package/coverage/src/device/device.ts.html +0 -2500
  111. package/coverage/src/device/fan.ts.html +0 -2242
  112. package/coverage/src/device/hub.ts.html +0 -1408
  113. package/coverage/src/device/humidifier.ts.html +0 -2116
  114. package/coverage/src/device/index.html +0 -416
  115. package/coverage/src/device/iosensor.ts.html +0 -1375
  116. package/coverage/src/device/lightstrip.ts.html +0 -2617
  117. package/coverage/src/device/lock.ts.html +0 -1963
  118. package/coverage/src/device/meter.ts.html +0 -1372
  119. package/coverage/src/device/meterplus.ts.html +0 -1384
  120. package/coverage/src/device/meterpro.ts.html +0 -1618
  121. package/coverage/src/device/motion.ts.html +0 -1264
  122. package/coverage/src/device/plug.ts.html +0 -1372
  123. package/coverage/src/device/relayswitch.ts.html +0 -2284
  124. package/coverage/src/device/robotvacuumcleaner.ts.html +0 -1810
  125. package/coverage/src/device/waterdetector.ts.html +0 -1294
  126. package/coverage/src/homebridge-ui/index.html +0 -116
  127. package/coverage/src/homebridge-ui/server.ts.html +0 -229
  128. package/coverage/src/index.html +0 -161
  129. package/coverage/src/index.ts.html +0 -124
  130. package/coverage/src/irdevice/airconditioner.ts.html +0 -1687
  131. package/coverage/src/irdevice/airpurifier.ts.html +0 -844
  132. package/coverage/src/irdevice/camera.ts.html +0 -475
  133. package/coverage/src/irdevice/fan.ts.html +0 -766
  134. package/coverage/src/irdevice/index.html +0 -251
  135. package/coverage/src/irdevice/irdevice.ts.html +0 -1117
  136. package/coverage/src/irdevice/light.ts.html +0 -826
  137. package/coverage/src/irdevice/other.ts.html +0 -2458
  138. package/coverage/src/irdevice/tv.ts.html +0 -1222
  139. package/coverage/src/irdevice/vacuumcleaner.ts.html +0 -466
  140. package/coverage/src/irdevice/waterheater.ts.html +0 -469
  141. package/coverage/src/platform.ts.html +0 -8776
  142. package/coverage/src/settings.ts.html +0 -934
  143. package/coverage/src/utils.ts.html +0 -2092
  144. package/dist/devices-hap/airpurifier.d.ts +0 -54
  145. package/dist/devices-hap/airpurifier.d.ts.map +0 -1
  146. package/dist/devices-hap/airpurifier.js +0 -533
  147. package/dist/devices-hap/airpurifier.js.map +0 -1
  148. package/dist/devices-hap/blindtilt.d.ts +0 -90
  149. package/dist/devices-hap/blindtilt.d.ts.map +0 -1
  150. package/dist/devices-hap/blindtilt.js +0 -974
  151. package/dist/devices-hap/blindtilt.js.map +0 -1
  152. package/dist/devices-hap/bot.d.ts +0 -102
  153. package/dist/devices-hap/bot.d.ts.map +0 -1
  154. package/dist/devices-hap/bot.js +0 -822
  155. package/dist/devices-hap/bot.js.map +0 -1
  156. package/dist/devices-hap/ceilinglight.d.ts +0 -85
  157. package/dist/devices-hap/ceilinglight.d.ts.map +0 -1
  158. package/dist/devices-hap/ceilinglight.js +0 -707
  159. package/dist/devices-hap/ceilinglight.js.map +0 -1
  160. package/dist/devices-hap/colorbulb.d.ts +0 -88
  161. package/dist/devices-hap/colorbulb.d.ts.map +0 -1
  162. package/dist/devices-hap/colorbulb.js +0 -921
  163. package/dist/devices-hap/colorbulb.js.map +0 -1
  164. package/dist/devices-hap/contact.d.ts +0 -44
  165. package/dist/devices-hap/contact.d.ts.map +0 -1
  166. package/dist/devices-hap/contact.js +0 -409
  167. package/dist/devices-hap/contact.js.map +0 -1
  168. package/dist/devices-hap/curtain.d.ts +0 -73
  169. package/dist/devices-hap/curtain.d.ts.map +0 -1
  170. package/dist/devices-hap/curtain.js +0 -869
  171. package/dist/devices-hap/curtain.js.map +0 -1
  172. package/dist/devices-hap/device.d.ts +0 -108
  173. package/dist/devices-hap/device.d.ts.map +0 -1
  174. package/dist/devices-hap/device.js +0 -821
  175. package/dist/devices-hap/device.js.map +0 -1
  176. package/dist/devices-hap/fan.d.ts +0 -69
  177. package/dist/devices-hap/fan.d.ts.map +0 -1
  178. package/dist/devices-hap/fan.js +0 -655
  179. package/dist/devices-hap/fan.js.map +0 -1
  180. package/dist/devices-hap/hub.d.ts +0 -37
  181. package/dist/devices-hap/hub.d.ts.map +0 -1
  182. package/dist/devices-hap/hub.js +0 -393
  183. package/dist/devices-hap/hub.js.map +0 -1
  184. package/dist/devices-hap/humidifier.d.ts +0 -73
  185. package/dist/devices-hap/humidifier.d.ts.map +0 -1
  186. package/dist/devices-hap/humidifier.js +0 -716
  187. package/dist/devices-hap/humidifier.js.map +0 -1
  188. package/dist/devices-hap/iosensor.d.ts +0 -42
  189. package/dist/devices-hap/iosensor.d.ts.map +0 -1
  190. package/dist/devices-hap/iosensor.js +0 -397
  191. package/dist/devices-hap/iosensor.js.map +0 -1
  192. package/dist/devices-hap/lightstrip.d.ts +0 -79
  193. package/dist/devices-hap/lightstrip.d.ts.map +0 -1
  194. package/dist/devices-hap/lightstrip.js +0 -827
  195. package/dist/devices-hap/lightstrip.js.map +0 -1
  196. package/dist/devices-hap/lock.d.ts +0 -53
  197. package/dist/devices-hap/lock.d.ts.map +0 -1
  198. package/dist/devices-hap/lock.js +0 -569
  199. package/dist/devices-hap/lock.js.map +0 -1
  200. package/dist/devices-hap/meter.d.ts +0 -37
  201. package/dist/devices-hap/meter.d.ts.map +0 -1
  202. package/dist/devices-hap/meter.js +0 -380
  203. package/dist/devices-hap/meter.js.map +0 -1
  204. package/dist/devices-hap/meterplus.d.ts +0 -42
  205. package/dist/devices-hap/meterplus.d.ts.map +0 -1
  206. package/dist/devices-hap/meterplus.js +0 -385
  207. package/dist/devices-hap/meterplus.js.map +0 -1
  208. package/dist/devices-hap/meterpro.d.ts +0 -43
  209. package/dist/devices-hap/meterpro.d.ts.map +0 -1
  210. package/dist/devices-hap/meterpro.js +0 -469
  211. package/dist/devices-hap/meterpro.js.map +0 -1
  212. package/dist/devices-hap/motion.d.ts +0 -42
  213. package/dist/devices-hap/motion.d.ts.map +0 -1
  214. package/dist/devices-hap/motion.js +0 -345
  215. package/dist/devices-hap/motion.js.map +0 -1
  216. package/dist/devices-hap/plug.d.ts +0 -49
  217. package/dist/devices-hap/plug.d.ts.map +0 -1
  218. package/dist/devices-hap/plug.js +0 -400
  219. package/dist/devices-hap/plug.js.map +0 -1
  220. package/dist/devices-hap/relayswitch.d.ts +0 -96
  221. package/dist/devices-hap/relayswitch.d.ts.map +0 -1
  222. package/dist/devices-hap/relayswitch.js +0 -642
  223. package/dist/devices-hap/relayswitch.js.map +0 -1
  224. package/dist/devices-hap/robotvacuumcleaner.d.ts +0 -54
  225. package/dist/devices-hap/robotvacuumcleaner.d.ts.map +0 -1
  226. package/dist/devices-hap/robotvacuumcleaner.js +0 -530
  227. package/dist/devices-hap/robotvacuumcleaner.js.map +0 -1
  228. package/dist/devices-hap/waterdetector.d.ts +0 -41
  229. package/dist/devices-hap/waterdetector.d.ts.map +0 -1
  230. package/dist/devices-hap/waterdetector.js +0 -356
  231. package/dist/devices-hap/waterdetector.js.map +0 -1
  232. package/dist/devices-matter/BaseMatterAccessory.d.ts +0 -90
  233. package/dist/devices-matter/BaseMatterAccessory.d.ts.map +0 -1
  234. package/dist/devices-matter/BaseMatterAccessory.js +0 -264
  235. package/dist/devices-matter/BaseMatterAccessory.js.map +0 -1
  236. package/dist/devices-matter/ColorLightAccessory.d.ts +0 -20
  237. package/dist/devices-matter/ColorLightAccessory.d.ts.map +0 -1
  238. package/dist/devices-matter/ColorLightAccessory.js +0 -95
  239. package/dist/devices-matter/ColorLightAccessory.js.map +0 -1
  240. package/dist/devices-matter/ColorTemperatureLightAccessory.d.ts +0 -18
  241. package/dist/devices-matter/ColorTemperatureLightAccessory.d.ts.map +0 -1
  242. package/dist/devices-matter/ColorTemperatureLightAccessory.js +0 -76
  243. package/dist/devices-matter/ColorTemperatureLightAccessory.js.map +0 -1
  244. package/dist/devices-matter/ContactSensorAccessory.d.ts +0 -12
  245. package/dist/devices-matter/ContactSensorAccessory.d.ts.map +0 -1
  246. package/dist/devices-matter/ContactSensorAccessory.js +0 -34
  247. package/dist/devices-matter/ContactSensorAccessory.js.map +0 -1
  248. package/dist/devices-matter/DimmableLightAccessory.d.ts +0 -58
  249. package/dist/devices-matter/DimmableLightAccessory.d.ts.map +0 -1
  250. package/dist/devices-matter/DimmableLightAccessory.js +0 -167
  251. package/dist/devices-matter/DimmableLightAccessory.js.map +0 -1
  252. package/dist/devices-matter/DoorLockAccessory.d.ts +0 -14
  253. package/dist/devices-matter/DoorLockAccessory.d.ts.map +0 -1
  254. package/dist/devices-matter/DoorLockAccessory.js +0 -50
  255. package/dist/devices-matter/DoorLockAccessory.js.map +0 -1
  256. package/dist/devices-matter/ExtendedColorLightAccessory.d.ts +0 -21
  257. package/dist/devices-matter/ExtendedColorLightAccessory.d.ts.map +0 -1
  258. package/dist/devices-matter/ExtendedColorLightAccessory.js +0 -106
  259. package/dist/devices-matter/ExtendedColorLightAccessory.js.map +0 -1
  260. package/dist/devices-matter/FanAccessory.d.ts +0 -16
  261. package/dist/devices-matter/FanAccessory.d.ts.map +0 -1
  262. package/dist/devices-matter/FanAccessory.js +0 -81
  263. package/dist/devices-matter/FanAccessory.js.map +0 -1
  264. package/dist/devices-matter/HumiditySensorAccessory.d.ts +0 -12
  265. package/dist/devices-matter/HumiditySensorAccessory.d.ts.map +0 -1
  266. package/dist/devices-matter/HumiditySensorAccessory.js +0 -34
  267. package/dist/devices-matter/HumiditySensorAccessory.js.map +0 -1
  268. package/dist/devices-matter/LeakSensorAccessory.d.ts +0 -12
  269. package/dist/devices-matter/LeakSensorAccessory.d.ts.map +0 -1
  270. package/dist/devices-matter/LeakSensorAccessory.js +0 -33
  271. package/dist/devices-matter/LeakSensorAccessory.js.map +0 -1
  272. package/dist/devices-matter/LightSensorAccessory.d.ts +0 -12
  273. package/dist/devices-matter/LightSensorAccessory.d.ts.map +0 -1
  274. package/dist/devices-matter/LightSensorAccessory.js +0 -34
  275. package/dist/devices-matter/LightSensorAccessory.js.map +0 -1
  276. package/dist/devices-matter/OccupancySensorAccessory.d.ts +0 -12
  277. package/dist/devices-matter/OccupancySensorAccessory.d.ts.map +0 -1
  278. package/dist/devices-matter/OccupancySensorAccessory.js +0 -39
  279. package/dist/devices-matter/OccupancySensorAccessory.js.map +0 -1
  280. package/dist/devices-matter/OnOffLightAccessory.d.ts +0 -38
  281. package/dist/devices-matter/OnOffLightAccessory.d.ts.map +0 -1
  282. package/dist/devices-matter/OnOffLightAccessory.js +0 -110
  283. package/dist/devices-matter/OnOffLightAccessory.js.map +0 -1
  284. package/dist/devices-matter/OnOffOutletAccessory.d.ts +0 -14
  285. package/dist/devices-matter/OnOffOutletAccessory.d.ts.map +0 -1
  286. package/dist/devices-matter/OnOffOutletAccessory.js +0 -43
  287. package/dist/devices-matter/OnOffOutletAccessory.js.map +0 -1
  288. package/dist/devices-matter/OnOffSwitchAccessory.d.ts +0 -14
  289. package/dist/devices-matter/OnOffSwitchAccessory.d.ts.map +0 -1
  290. package/dist/devices-matter/OnOffSwitchAccessory.js +0 -42
  291. package/dist/devices-matter/OnOffSwitchAccessory.js.map +0 -1
  292. package/dist/devices-matter/RoboticVacuumAccessory.d.ts +0 -61
  293. package/dist/devices-matter/RoboticVacuumAccessory.d.ts.map +0 -1
  294. package/dist/devices-matter/RoboticVacuumAccessory.js +0 -544
  295. package/dist/devices-matter/RoboticVacuumAccessory.js.map +0 -1
  296. package/dist/devices-matter/SmokeCOAlarmAccessory.d.ts +0 -11
  297. package/dist/devices-matter/SmokeCOAlarmAccessory.d.ts.map +0 -1
  298. package/dist/devices-matter/SmokeCOAlarmAccessory.js +0 -49
  299. package/dist/devices-matter/SmokeCOAlarmAccessory.js.map +0 -1
  300. package/dist/devices-matter/TemperatureSensorAccessory.d.ts +0 -12
  301. package/dist/devices-matter/TemperatureSensorAccessory.d.ts.map +0 -1
  302. package/dist/devices-matter/TemperatureSensorAccessory.js +0 -36
  303. package/dist/devices-matter/TemperatureSensorAccessory.js.map +0 -1
  304. package/dist/devices-matter/ThermostatAccessory.d.ts +0 -19
  305. package/dist/devices-matter/ThermostatAccessory.d.ts.map +0 -1
  306. package/dist/devices-matter/ThermostatAccessory.js +0 -95
  307. package/dist/devices-matter/ThermostatAccessory.js.map +0 -1
  308. package/dist/devices-matter/VenetianBlindAccessory.d.ts +0 -19
  309. package/dist/devices-matter/VenetianBlindAccessory.d.ts.map +0 -1
  310. package/dist/devices-matter/VenetianBlindAccessory.js +0 -99
  311. package/dist/devices-matter/VenetianBlindAccessory.js.map +0 -1
  312. package/dist/devices-matter/WindowBlindAccessory.d.ts +0 -17
  313. package/dist/devices-matter/WindowBlindAccessory.d.ts.map +0 -1
  314. package/dist/devices-matter/WindowBlindAccessory.js +0 -131
  315. package/dist/devices-matter/WindowBlindAccessory.js.map +0 -1
  316. package/dist/devices-matter/custom/PowerStripAccessory.d.ts +0 -97
  317. package/dist/devices-matter/custom/PowerStripAccessory.d.ts.map +0 -1
  318. package/dist/devices-matter/custom/PowerStripAccessory.js +0 -265
  319. package/dist/devices-matter/custom/PowerStripAccessory.js.map +0 -1
  320. package/dist/devices-matter/custom/index.d.ts +0 -8
  321. package/dist/devices-matter/custom/index.d.ts.map +0 -1
  322. package/dist/devices-matter/custom/index.js +0 -8
  323. package/dist/devices-matter/custom/index.js.map +0 -1
  324. package/dist/devices-matter/index.d.ts +0 -29
  325. package/dist/devices-matter/index.d.ts.map +0 -1
  326. package/dist/devices-matter/index.js +0 -28
  327. package/dist/devices-matter/index.js.map +0 -1
  328. package/dist/irdevice/airconditioner.d.ts +0 -61
  329. package/dist/irdevice/airconditioner.d.ts.map +0 -1
  330. package/dist/irdevice/airconditioner.js +0 -472
  331. package/dist/irdevice/airconditioner.js.map +0 -1
  332. package/dist/irdevice/airpurifier.d.ts +0 -50
  333. package/dist/irdevice/airpurifier.d.ts.map +0 -1
  334. package/dist/irdevice/airpurifier.js +0 -213
  335. package/dist/irdevice/airpurifier.js.map +0 -1
  336. package/dist/irdevice/camera.d.ts +0 -32
  337. package/dist/irdevice/camera.d.ts.map +0 -1
  338. package/dist/irdevice/camera.js +0 -107
  339. package/dist/irdevice/camera.js.map +0 -1
  340. package/dist/irdevice/fan.d.ts +0 -36
  341. package/dist/irdevice/fan.d.ts.map +0 -1
  342. package/dist/irdevice/fan.js +0 -200
  343. package/dist/irdevice/fan.js.map +0 -1
  344. package/dist/irdevice/irdevice.d.ts +0 -69
  345. package/dist/irdevice/irdevice.d.ts.map +0 -1
  346. package/dist/irdevice/irdevice.js +0 -339
  347. package/dist/irdevice/irdevice.js.map +0 -1
  348. package/dist/irdevice/light.d.ts +0 -36
  349. package/dist/irdevice/light.d.ts.map +0 -1
  350. package/dist/irdevice/light.js +0 -206
  351. package/dist/irdevice/light.js.map +0 -1
  352. package/dist/irdevice/other.d.ts +0 -57
  353. package/dist/irdevice/other.d.ts.map +0 -1
  354. package/dist/irdevice/other.js +0 -778
  355. package/dist/irdevice/other.js.map +0 -1
  356. package/dist/irdevice/tv.d.ts +0 -45
  357. package/dist/irdevice/tv.d.ts.map +0 -1
  358. package/dist/irdevice/tv.js +0 -327
  359. package/dist/irdevice/tv.js.map +0 -1
  360. package/dist/irdevice/vacuumcleaner.d.ts +0 -28
  361. package/dist/irdevice/vacuumcleaner.d.ts.map +0 -1
  362. package/dist/irdevice/vacuumcleaner.js +0 -104
  363. package/dist/irdevice/vacuumcleaner.js.map +0 -1
  364. package/dist/irdevice/waterheater.d.ts +0 -30
  365. package/dist/irdevice/waterheater.d.ts.map +0 -1
  366. package/dist/irdevice/waterheater.js +0 -105
  367. package/dist/irdevice/waterheater.js.map +0 -1
  368. package/dist/platform-hap.d.ts +0 -160
  369. package/dist/platform-hap.d.ts.map +0 -1
  370. package/dist/platform-hap.js +0 -3041
  371. package/dist/platform-hap.js.map +0 -1
  372. package/dist/platform-matter.d.ts +0 -188
  373. package/dist/platform-matter.d.ts.map +0 -1
  374. package/dist/platform-matter.js +0 -2545
  375. package/dist/platform-matter.js.map +0 -1
  376. package/dist/test/apiRequestTracker.test.d.ts +0 -2
  377. package/dist/test/apiRequestTracker.test.d.ts.map +0 -1
  378. package/dist/test/apiRequestTracker.test.js +0 -392
  379. package/dist/test/apiRequestTracker.test.js.map +0 -1
  380. package/dist/test/hap/device-webhook-context.test.d.ts +0 -2
  381. package/dist/test/hap/device-webhook-context.test.d.ts.map +0 -1
  382. package/dist/test/hap/device-webhook-context.test.js +0 -128
  383. package/dist/test/hap/device-webhook-context.test.js.map +0 -1
  384. package/dist/test/hap/platform-hap.logging.test.d.ts +0 -2
  385. package/dist/test/hap/platform-hap.logging.test.d.ts.map +0 -1
  386. package/dist/test/hap/platform-hap.logging.test.js +0 -33
  387. package/dist/test/hap/platform-hap.logging.test.js.map +0 -1
  388. package/dist/test/hap/platform-hap.test.d.ts +0 -2
  389. package/dist/test/hap/platform-hap.test.d.ts.map +0 -1
  390. package/dist/test/hap/platform-hap.test.js +0 -62
  391. package/dist/test/hap/platform-hap.test.js.map +0 -1
  392. package/dist/test/helpers/platform-fixtures.d.ts +0 -9
  393. package/dist/test/helpers/platform-fixtures.d.ts.map +0 -1
  394. package/dist/test/helpers/platform-fixtures.js +0 -30
  395. package/dist/test/helpers/platform-fixtures.js.map +0 -1
  396. package/dist/test/homebridge-ui/server.test.d.ts +0 -2
  397. package/dist/test/homebridge-ui/server.test.d.ts.map +0 -1
  398. package/dist/test/homebridge-ui/server.test.js +0 -445
  399. package/dist/test/homebridge-ui/server.test.js.map +0 -1
  400. package/dist/test/index.test.d.ts +0 -2
  401. package/dist/test/index.test.d.ts.map +0 -1
  402. package/dist/test/index.test.js +0 -19
  403. package/dist/test/index.test.js.map +0 -1
  404. package/dist/test/matter/devices-matter/baseMatterAccessory.test.d.ts +0 -2
  405. package/dist/test/matter/devices-matter/baseMatterAccessory.test.d.ts.map +0 -1
  406. package/dist/test/matter/devices-matter/baseMatterAccessory.test.js +0 -71
  407. package/dist/test/matter/devices-matter/baseMatterAccessory.test.js.map +0 -1
  408. package/dist/test/matter/platform-matter.additional.test.d.ts +0 -2
  409. package/dist/test/matter/platform-matter.additional.test.d.ts.map +0 -1
  410. package/dist/test/matter/platform-matter.additional.test.js +0 -35
  411. package/dist/test/matter/platform-matter.additional.test.js.map +0 -1
  412. package/dist/test/matter/platform-matter.bleparse.test.d.ts +0 -2
  413. package/dist/test/matter/platform-matter.bleparse.test.d.ts.map +0 -1
  414. package/dist/test/matter/platform-matter.bleparse.test.js +0 -43
  415. package/dist/test/matter/platform-matter.bleparse.test.js.map +0 -1
  416. package/dist/test/matter/platform-matter.cleanup.test.d.ts +0 -2
  417. package/dist/test/matter/platform-matter.cleanup.test.d.ts.map +0 -1
  418. package/dist/test/matter/platform-matter.cleanup.test.js +0 -70
  419. package/dist/test/matter/platform-matter.cleanup.test.js.map +0 -1
  420. package/dist/test/matter/platform-matter.keepstale.test.d.ts +0 -2
  421. package/dist/test/matter/platform-matter.keepstale.test.d.ts.map +0 -1
  422. package/dist/test/matter/platform-matter.keepstale.test.js +0 -27
  423. package/dist/test/matter/platform-matter.keepstale.test.js.map +0 -1
  424. package/dist/test/matter/platform-matter.logging.test.d.ts +0 -2
  425. package/dist/test/matter/platform-matter.logging.test.d.ts.map +0 -1
  426. package/dist/test/matter/platform-matter.logging.test.js +0 -29
  427. package/dist/test/matter/platform-matter.logging.test.js.map +0 -1
  428. package/dist/test/matter/platform-matter.mapping.test.d.ts +0 -2
  429. package/dist/test/matter/platform-matter.mapping.test.d.ts.map +0 -1
  430. package/dist/test/matter/platform-matter.mapping.test.js +0 -43
  431. package/dist/test/matter/platform-matter.mapping.test.js.map +0 -1
  432. package/dist/test/matter/platform-matter.openapi-mapping.test.d.ts +0 -2
  433. package/dist/test/matter/platform-matter.openapi-mapping.test.d.ts.map +0 -1
  434. package/dist/test/matter/platform-matter.openapi-mapping.test.js +0 -84
  435. package/dist/test/matter/platform-matter.openapi-mapping.test.js.map +0 -1
  436. package/dist/test/matter/platform-matter.test.d.ts +0 -2
  437. package/dist/test/matter/platform-matter.test.d.ts.map +0 -1
  438. package/dist/test/matter/platform-matter.test.js +0 -117
  439. package/dist/test/matter/platform-matter.test.js.map +0 -1
  440. package/dist/test/matter/platform-matter.unregister.test.d.ts +0 -2
  441. package/dist/test/matter/platform-matter.unregister.test.d.ts.map +0 -1
  442. package/dist/test/matter/platform-matter.unregister.test.js +0 -30
  443. package/dist/test/matter/platform-matter.unregister.test.js.map +0 -1
  444. package/dist/test/matter/platform-matter.webhook.test.d.ts +0 -2
  445. package/dist/test/matter/platform-matter.webhook.test.d.ts.map +0 -1
  446. package/dist/test/matter/platform-matter.webhook.test.js +0 -46
  447. package/dist/test/matter/platform-matter.webhook.test.js.map +0 -1
  448. package/dist/test/utils.test.d.ts +0 -2
  449. package/dist/test/utils.test.d.ts.map +0 -1
  450. package/dist/test/utils.test.js +0 -95
  451. package/dist/test/utils.test.js.map +0 -1
  452. package/dist/test/verifyconfig.test.d.ts +0 -2
  453. package/dist/test/verifyconfig.test.d.ts.map +0 -1
  454. package/dist/test/verifyconfig.test.js +0 -167
  455. package/dist/test/verifyconfig.test.js.map +0 -1
  456. package/src/custom.d.ts +0 -7
  457. package/src/devices-hap/airpurifier.ts +0 -568
  458. package/src/devices-hap/blindtilt.ts +0 -1049
  459. package/src/devices-hap/bot.ts +0 -910
  460. package/src/devices-hap/ceilinglight.ts +0 -747
  461. package/src/devices-hap/colorbulb.ts +0 -940
  462. package/src/devices-hap/contact.ts +0 -457
  463. package/src/devices-hap/curtain.ts +0 -944
  464. package/src/devices-hap/device.ts +0 -890
  465. package/src/devices-hap/fan.ts +0 -716
  466. package/src/devices-hap/hub.ts +0 -440
  467. package/src/devices-hap/humidifier.ts +0 -762
  468. package/src/devices-hap/iosensor.ts +0 -442
  469. package/src/devices-hap/lightstrip.ts +0 -863
  470. package/src/devices-hap/lock.ts +0 -627
  471. package/src/devices-hap/meter.ts +0 -427
  472. package/src/devices-hap/meterplus.ts +0 -431
  473. package/src/devices-hap/meterpro.ts +0 -523
  474. package/src/devices-hap/motion.ts +0 -390
  475. package/src/devices-hap/plug.ts +0 -427
  476. package/src/devices-hap/relayswitch.ts +0 -727
  477. package/src/devices-hap/robotvacuumcleaner.ts +0 -574
  478. package/src/devices-hap/waterdetector.ts +0 -400
  479. package/src/devices-matter/BaseMatterAccessory.ts +0 -302
  480. package/src/devices-matter/ColorLightAccessory.ts +0 -110
  481. package/src/devices-matter/ColorTemperatureLightAccessory.ts +0 -90
  482. package/src/devices-matter/ContactSensorAccessory.ts +0 -41
  483. package/src/devices-matter/DimmableLightAccessory.ts +0 -192
  484. package/src/devices-matter/DoorLockAccessory.ts +0 -60
  485. package/src/devices-matter/ExtendedColorLightAccessory.ts +0 -122
  486. package/src/devices-matter/FanAccessory.ts +0 -95
  487. package/src/devices-matter/HumiditySensorAccessory.ts +0 -41
  488. package/src/devices-matter/LeakSensorAccessory.ts +0 -40
  489. package/src/devices-matter/LightSensorAccessory.ts +0 -41
  490. package/src/devices-matter/OccupancySensorAccessory.ts +0 -48
  491. package/src/devices-matter/OnOffLightAccessory.ts +0 -125
  492. package/src/devices-matter/OnOffOutletAccessory.ts +0 -51
  493. package/src/devices-matter/OnOffSwitchAccessory.ts +0 -51
  494. package/src/devices-matter/RoboticVacuumAccessory.ts +0 -621
  495. package/src/devices-matter/SmokeCOAlarmAccessory.ts +0 -59
  496. package/src/devices-matter/TemperatureSensorAccessory.ts +0 -43
  497. package/src/devices-matter/ThermostatAccessory.ts +0 -110
  498. package/src/devices-matter/VenetianBlindAccessory.ts +0 -115
  499. package/src/devices-matter/WindowBlindAccessory.ts +0 -135
  500. package/src/devices-matter/custom/PowerStripAccessory.ts +0 -309
  501. package/src/devices-matter/custom/index.ts +0 -8
  502. package/src/devices-matter/index.ts +0 -29
  503. package/src/irdevice/airconditioner.ts +0 -533
  504. package/src/irdevice/airpurifier.ts +0 -252
  505. package/src/irdevice/camera.ts +0 -129
  506. package/src/irdevice/fan.ts +0 -226
  507. package/src/irdevice/irdevice.ts +0 -383
  508. package/src/irdevice/light.ts +0 -246
  509. package/src/irdevice/other.ts +0 -790
  510. package/src/irdevice/tv.ts +0 -378
  511. package/src/irdevice/vacuumcleaner.ts +0 -126
  512. package/src/irdevice/waterheater.ts +0 -127
  513. package/src/platform-hap.ts +0 -3193
  514. package/src/platform-matter.ts +0 -2703
  515. package/src/test/apiRequestTracker.test.ts +0 -417
  516. package/src/test/hap/device-webhook-context.test.ts +0 -136
  517. package/src/test/hap/platform-hap.logging.test.ts +0 -36
  518. package/src/test/hap/platform-hap.test.ts +0 -70
  519. package/src/test/helpers/platform-fixtures.ts +0 -33
  520. package/src/test/homebridge-ui/server.test.ts +0 -486
  521. package/src/test/index.test.ts +0 -24
  522. package/src/test/matter/devices-matter/baseMatterAccessory.test.ts +0 -88
  523. package/src/test/matter/platform-matter.additional.test.ts +0 -44
  524. package/src/test/matter/platform-matter.bleparse.test.ts +0 -47
  525. package/src/test/matter/platform-matter.cleanup.test.ts +0 -86
  526. package/src/test/matter/platform-matter.keepstale.test.ts +0 -37
  527. package/src/test/matter/platform-matter.logging.test.ts +0 -33
  528. package/src/test/matter/platform-matter.mapping.test.ts +0 -57
  529. package/src/test/matter/platform-matter.openapi-mapping.test.ts +0 -109
  530. package/src/test/matter/platform-matter.test.ts +0 -144
  531. package/src/test/matter/platform-matter.unregister.test.ts +0 -39
  532. package/src/test/matter/platform-matter.webhook.test.ts +0 -54
  533. package/src/test/utils.test.ts +0 -96
  534. package/src/test/verifyconfig.test.ts +0 -198
@@ -1,642 +0,0 @@
1
- /*
2
- * For Testing Locally:
3
- * import { SwitchBotBLEModel, SwitchBotBLEModelName } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
4
- */
5
- import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot';
6
- import { debounceTime, interval, skipWhile, Subject, take, tap } from 'rxjs';
7
- import { formatDeviceIdAsMac } from '../utils.js';
8
- import { deviceBase } from './device.js';
9
- /**
10
- * Platform Accessory
11
- * An instance of this class is created for each accessory your platform registers
12
- * Each accessory may expose multiple services of different service types.
13
- */
14
- export class RelaySwitch extends deviceBase {
15
- platform;
16
- // Services
17
- Switch;
18
- GarageDoor;
19
- Door;
20
- Window;
21
- WindowCovering;
22
- LockMechanism;
23
- Faucet;
24
- Fan;
25
- StatefulProgrammableSwitch;
26
- Outlet;
27
- On;
28
- // OpenAPI
29
- deviceStatus;
30
- // Webhook
31
- webhookContext;
32
- // BLE
33
- serviceData;
34
- // Config
35
- allowPush;
36
- relaySwitchDeviceType;
37
- // Updates
38
- relaySwitchUpdateInProgress;
39
- doRelaySwitchUpdate;
40
- /**
41
- * Constructs a new instance of the RelaySwitch device.
42
- *
43
- * @param {SwitchBotPlatform} platform - The platform instance.
44
- * @param {PlatformAccessory} accessory - The platform accessory.
45
- * @param {device & devicesConfig} device - The device configuration.
46
- *
47
- * Initializes the RelaySwitch device, sets up the battery service, maps the device type to the appropriate HomeKit service,
48
- * removes unnecessary services, retrieves initial values, registers event handlers, and starts update intervals.
49
- *
50
- * @constructor
51
- */
52
- constructor(platform, accessory, device) {
53
- super(platform, accessory, device);
54
- this.platform = platform;
55
- this.getRelaySwitchConfigSettings(device);
56
- // this is subject we use to track when we need to POST changes to the SwitchBot API
57
- this.doRelaySwitchUpdate = new Subject();
58
- this.relaySwitchUpdateInProgress = false;
59
- /**
60
- * A mapping of device types to their corresponding HomeKit categories, services, and characteristics.
61
- *
62
- * Each key represents a device type and maps to an object containing:
63
- * - `category`: The HomeKit category for the device.
64
- * - `service`: The HomeKit service associated with the device.
65
- * - `characteristic`: The HomeKit characteristic for the device.
66
- */
67
- const deviceTypeMap = {
68
- switch: { category: 8 /* this.hap.Categories.SWITCH */, service: this.hap.Service.Switch, characteristic: this.hap.Characteristic.On },
69
- garagedoor: { category: 4 /* this.hap.Categories.GARAGE_DOOR_OPENER */, service: this.hap.Service.GarageDoorOpener, characteristic: this.hap.Characteristic.TargetDoorState },
70
- door: { category: 12 /* this.hap.Categories.DOOR */, service: this.hap.Service.Door, characteristic: this.hap.Characteristic.TargetPosition },
71
- window: { category: 13 /* this.hap.Categories.WINDOW */, service: this.hap.Service.Window, characteristic: this.hap.Characteristic.TargetPosition },
72
- windowcovering: { category: 14 /* this.hap.Categories.WINDOW_COVERING */, service: this.hap.Service.WindowCovering, characteristic: this.hap.Characteristic.TargetPosition },
73
- lock: { category: 6 /* this.hap.Categories.DOOR_LOCK */, service: this.hap.Service.LockMechanism, characteristic: this.hap.Characteristic.LockTargetState },
74
- faucet: { category: 29 /* this.hap.Categories.FAUCET */, service: this.hap.Service.Faucet, characteristic: this.hap.Characteristic.Active },
75
- fan: { category: 3 /* this.hap.Categories.FAN */, service: this.hap.Service.Fanv2, characteristic: this.hap.Characteristic.Active },
76
- stateful: { category: 15 /* this.hap.Categories.PROGRAMMABLE_SWITCH */, service: this.hap.Service.StatefulProgrammableSwitch, characteristic: this.hap.Characteristic.ProgrammableSwitchOutputState },
77
- outlet: { category: 7 /* this.hap.Categories.OUTLET */, service: this.hap.Service.Outlet, characteristic: this.hap.Characteristic.On },
78
- };
79
- /**
80
- * The type of the device, determined by mapping the relaySwitchDeviceType to a value in the deviceTypeMap.
81
- */
82
- const deviceType = deviceTypeMap[this.relaySwitchDeviceType];
83
- if (deviceType) {
84
- // Set category
85
- accessory.category = deviceType.category;
86
- // Initialize Service
87
- const contextKey = this.relaySwitchDeviceType.charAt(0).toUpperCase() + this.relaySwitchDeviceType.slice(1);
88
- accessory.context[contextKey] = accessory.context[contextKey] ?? {};
89
- this[this.relaySwitchDeviceType.charAt(0).toUpperCase() + this.relaySwitchDeviceType.slice(1)] = {
90
- Name: accessory.displayName,
91
- Service: accessory.getService(deviceType.service) ?? accessory.addService(deviceType.service),
92
- };
93
- accessory.context[contextKey] = this[this.relaySwitchDeviceType.charAt(0).toUpperCase() + this.relaySwitchDeviceType.slice(1)];
94
- this.debugLog(`Displaying as ${contextKey}`);
95
- // Initialize Characteristics
96
- this[this.relaySwitchDeviceType.charAt(0).toUpperCase() + this.relaySwitchDeviceType.slice(1)].Service.setCharacteristic(this.hap.Characteristic.Name, this[this.relaySwitchDeviceType.charAt(0).toUpperCase() + this.relaySwitchDeviceType.slice(1)].Name).getCharacteristic(deviceType.characteristic).onSet(this.OnSet.bind(this));
97
- }
98
- else {
99
- this.errorLog('Device Type not set');
100
- }
101
- /**
102
- * An array of service removal functions that should be executed based on the current state of the device.
103
- * Each element in the array is a function that removes a specific service if the corresponding condition is met.
104
- */
105
- const servicesToRemove = [
106
- !this.StatefulProgrammableSwitch && this.removeStatefulProgrammableSwitchService,
107
- !this.Outlet && this.removeOutletService,
108
- !this.Window && this.removeWindowService,
109
- !this.GarageDoor && this.removeGarageDoorService,
110
- this.WindowCovering && this.removeWindowCoveringService,
111
- !this.Switch && this.removeSwitchService,
112
- !this.Faucet && this.removeFaucetService,
113
- !this.Door && this.removeDoorService,
114
- !this.LockMechanism && this.removeLockService,
115
- !this.Fan && this.removeFanService,
116
- ].filter(Boolean);
117
- for (const removeService of servicesToRemove) {
118
- if (typeof removeService === 'function') {
119
- removeService.call(this, accessory);
120
- }
121
- }
122
- // Retrieve initial values and updateHomekit
123
- try {
124
- this.debugLog('Retrieve initial values and update Homekit');
125
- this.refreshStatus();
126
- }
127
- catch (e) {
128
- this.errorLog(`failed to retrieve initial values and update Homekit, Error: ${e.message ?? e}`);
129
- }
130
- // regisiter webhook event handler if enabled
131
- try {
132
- this.debugLog('Registering Webhook Event Handler');
133
- this.registerWebhook();
134
- }
135
- catch (e) {
136
- this.errorLog(`failed to registerWebhook, Error: ${e.message ?? e}`);
137
- }
138
- // regisiter platform BLE event handler if enabled
139
- try {
140
- this.debugLog('Registering Platform BLE Event Handler');
141
- this.registerPlatformBLE();
142
- }
143
- catch (e) {
144
- this.errorLog(`failed to registerPlatformBLE, Error: ${e.message ?? e}`);
145
- }
146
- // Start an update interval
147
- interval(this.deviceRefreshRate * 1000)
148
- .pipe(skipWhile(() => this.relaySwitchUpdateInProgress))
149
- .subscribe(async () => {
150
- await this.refreshStatus();
151
- });
152
- // Watch for RelaySwitch change events
153
- // We put in a debounce of 1000ms so we don't make duplicate calls
154
- this.doRelaySwitchUpdate
155
- .pipe(tap(() => {
156
- this.relaySwitchUpdateInProgress = true;
157
- }), debounceTime(this.devicePushRate * 1000))
158
- .subscribe(async () => {
159
- try {
160
- await this.pushChanges();
161
- }
162
- catch (e) {
163
- await this.apiError(e);
164
- this.errorLog(`failed pushChanges with ${device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`);
165
- }
166
- this.relaySwitchUpdateInProgress = false;
167
- });
168
- }
169
- /**
170
- * Parse the device status from the SwitchBotBLE API
171
- */
172
- async BLEparseStatus() {
173
- this.debugLog('BLEparseStatus');
174
- this.debugLog(`(power, battery, deviceMode) = BLE:(${this.serviceData.state}), current:(${this.accessory.context.On})`);
175
- // BLEmode (true if Switch Mode) | (false if Press Mode)
176
- this.On = this.serviceData.mode ? this.serviceData.state : false;
177
- const mode = this.serviceData.mode ? 'Switch' : 'Press';
178
- this.debugLog(`${mode} Mode, On: ${this.On}`);
179
- this.accessory.context.On = this.On;
180
- }
181
- /**
182
- * Parse the device status from the SwitchBot OpenAPI
183
- */
184
- async openAPIparseStatus() {
185
- this.debugLog('openAPIparseStatus');
186
- this.debugLog(`(power, battery, deviceMode) = API:(${this.deviceStatus.switchStatus}), current:(${this.accessory.context.On})`);
187
- // On
188
- this.On = this.deviceStatus.switchStatus !== 0;
189
- this.debugLog(`On: ${this.On}`);
190
- this.accessory.context.On = this.On;
191
- // Firmware Version
192
- if (this.deviceStatus.version) {
193
- const version = this.deviceStatus.version;
194
- this.debugLog(`Firmware Version: ${version.replace(/^V|-.*$/g, '')}`);
195
- const deviceVersion = version.replace(/^V|-.*$/g, '') ?? '0.0.0';
196
- this.accessory
197
- .getService(this.hap.Service.AccessoryInformation)
198
- .setCharacteristic(this.hap.Characteristic.HardwareRevision, deviceVersion)
199
- .setCharacteristic(this.hap.Characteristic.FirmwareRevision, deviceVersion)
200
- .getCharacteristic(this.hap.Characteristic.FirmwareRevision)
201
- .updateValue(deviceVersion);
202
- this.accessory.context.version = deviceVersion;
203
- this.debugLog(`version: ${deviceVersion}`);
204
- }
205
- }
206
- async parseStatusWebhook() {
207
- this.debugLog('parseStatusWebhook');
208
- this.debugLog(`(power, battery, deviceMode) = Webhook:(${this.webhookContext.switchStatus}), current:(${this.On})`);
209
- // On
210
- this.On = this.webhookContext.switchStatus !== 0;
211
- this.debugLog(`On: ${this.On}`);
212
- }
213
- /**
214
- * Asks the SwitchBot API for the latest device information
215
- */
216
- async refreshStatus() {
217
- if (this.BLE) {
218
- await this.BLERefreshStatus();
219
- }
220
- else if (this.OpenAPI && this.platform.config.credentials?.token) {
221
- await this.openAPIRefreshStatus();
222
- }
223
- else {
224
- await this.offlineOff();
225
- this.debugWarnLog(`Connection Type: ${this.device.connectionType}, refreshStatus will not happen.`);
226
- }
227
- }
228
- async BLERefreshStatus() {
229
- this.debugLog('BLERefreshStatus');
230
- const switchBotBLE = await this.switchbotBLE();
231
- if (switchBotBLE === undefined) {
232
- await this.BLERefreshConnection(switchBotBLE);
233
- }
234
- else {
235
- // Start to monitor advertisement packets
236
- (async () => {
237
- // Start to monitor advertisement packets
238
- const serviceData = await this.monitorAdvertisementPackets(switchBotBLE);
239
- // Update HomeKit
240
- if ((serviceData.model === SwitchBotBLEModel.RelaySwitch1PM && serviceData.modelName === SwitchBotBLEModelName.RelaySwitch1PM) ?? (serviceData.model === SwitchBotBLEModel.RelaySwitch1 && serviceData.modelName === SwitchBotBLEModelName.RelaySwitch1)) {
241
- this.serviceData = serviceData;
242
- if (serviceData !== undefined && serviceData !== null) {
243
- await this.BLEparseStatus();
244
- await this.updateHomeKitCharacteristics();
245
- }
246
- else {
247
- this.errorLog(`serviceData is either undefined or null, serviceData: ${JSON.stringify(serviceData)}`);
248
- await this.BLERefreshConnection(switchBotBLE);
249
- }
250
- }
251
- else {
252
- this.errorLog(`failed to get serviceData, serviceData: ${JSON.stringify(serviceData)}`);
253
- await this.BLERefreshConnection(switchBotBLE);
254
- }
255
- })();
256
- }
257
- }
258
- async registerPlatformBLE() {
259
- this.debugLog('registerPlatformBLE');
260
- if (this.config.options?.BLE && !this.device.disablePlatformBLE) {
261
- this.debugLog('is listening to Platform BLE.');
262
- try {
263
- const formattedDeviceId = formatDeviceIdAsMac(this.device.deviceId);
264
- this.device.bleMac = formattedDeviceId;
265
- this.debugLog(`bleMac: ${this.device.bleMac}`);
266
- this.platform.bleEventHandler[this.device.bleMac] = async (context) => {
267
- try {
268
- this.serviceData = context;
269
- if (context !== undefined && context !== null) {
270
- this.debugLog(`received BLE: ${JSON.stringify(context)}`);
271
- await this.BLEparseStatus();
272
- await this.updateHomeKitCharacteristics();
273
- }
274
- else {
275
- this.errorLog(`context is either undefined or null, context: ${JSON.stringify(context)}`);
276
- await this.BLERefreshConnection(context);
277
- }
278
- }
279
- catch (e) {
280
- this.errorLog(`failed to handle BLE. Received: ${JSON.stringify(context)} Error: ${e.message ?? e}`);
281
- }
282
- };
283
- }
284
- catch (error) {
285
- this.errorLog(`failed to format device ID as MAC, Error: ${error}`);
286
- }
287
- }
288
- else {
289
- this.debugLog('is not listening to Platform BLE');
290
- }
291
- }
292
- async openAPIRefreshStatus() {
293
- this.debugLog('openAPIRefreshStatus');
294
- try {
295
- const deviceStatus = await this.deviceRefreshStatus();
296
- this.debugLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`);
297
- if (await this.successfulStatusCodes(deviceStatus)) {
298
- this.debugSuccessLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`);
299
- this.deviceStatus = deviceStatus.body;
300
- await this.openAPIparseStatus();
301
- await this.updateHomeKitCharacteristics();
302
- }
303
- else {
304
- this.debugWarnLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`);
305
- }
306
- }
307
- catch (e) {
308
- await this.apiError(e);
309
- this.errorLog(`failed openAPIRefreshStatus with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`);
310
- }
311
- }
312
- async registerWebhook() {
313
- if (this.device.webhook) {
314
- this.debugLog('is listening webhook.');
315
- this.platform.webhookEventHandler[this.device.deviceId] = async (context) => {
316
- try {
317
- this.webhookContext = context;
318
- if (context !== undefined && context !== null) {
319
- this.debugLog(`received Webhook: ${JSON.stringify(context)}`);
320
- await this.parseStatusWebhook();
321
- await this.updateHomeKitCharacteristics();
322
- }
323
- else {
324
- this.errorLog(`context is either undefined or null, context: ${JSON.stringify(context)}`);
325
- }
326
- }
327
- catch (e) {
328
- this.errorLog(`failed to handle webhook. Received: ${JSON.stringify(context)} Error: ${e.message ?? e}`);
329
- }
330
- };
331
- }
332
- else {
333
- this.debugLog('is not listening webhook.');
334
- }
335
- }
336
- /**
337
- * Pushes the requested changes to the SwitchBot API
338
- * deviceType commandType Command command parameter Description
339
- * RelaySwitch "command" "turnOff" "default" = set to OFF state
340
- * RelaySwitch "command" "turnOn" "default" = set to ON state
341
- */
342
- async pushChanges() {
343
- if (this.BLE) {
344
- await this.BLEpushChanges();
345
- }
346
- else if (this.OpenAPI && this.platform.config.credentials?.token) {
347
- await this.openAPIpushChanges();
348
- }
349
- else {
350
- await this.offlineOff();
351
- this.debugWarnLog(`Connection Type: ${this.device.connectionType}, pushChanges will not happen.`);
352
- }
353
- // Refresh the status from the API
354
- interval(15000)
355
- .pipe(skipWhile(() => this.relaySwitchUpdateInProgress))
356
- .pipe(take(1))
357
- .subscribe(async () => {
358
- await this.refreshStatus();
359
- });
360
- }
361
- async BLEpushChanges() {
362
- this.debugLog('BLEpushChanges');
363
- if ((this.On !== this.accessory.context.On) || this.allowPush) {
364
- this.debugLog(`BLEpushChanges On: ${this.On} OnCached: ${this.accessory.context.On}`);
365
- const switchBotBLE = this.platform.switchBotBLE;
366
- try {
367
- const formattedDeviceId = formatDeviceIdAsMac(this.device.deviceId);
368
- this.device.bleMac = formattedDeviceId;
369
- this.debugLog(`bleMac: ${this.device.bleMac}`);
370
- switchBotBLE
371
- .discover({ model: this.device.bleModel, quick: true, id: this.device.bleMac })
372
- .then(async (device_list) => {
373
- const deviceList = device_list;
374
- this.infoLog(`On: ${this.On}`);
375
- this.warnLog(`device_list: ${JSON.stringify(device_list)}`);
376
- return await this.retryBLE({
377
- max: this.maxRetryBLE(),
378
- fn: async () => {
379
- if (deviceList.length > 0) {
380
- if (this.On) {
381
- return await deviceList[0].turnOn();
382
- }
383
- else {
384
- return await deviceList[0].turnOff();
385
- }
386
- }
387
- else {
388
- throw new Error('No device found');
389
- }
390
- },
391
- });
392
- })
393
- .then(async () => {
394
- this.successLog(`On: ${this.On} sent over SwitchBot BLE, sent successfully`);
395
- await this.updateHomeKitCharacteristics();
396
- })
397
- .catch(async (e) => {
398
- await this.apiError(e);
399
- this.errorLog(`failed BLEpushChanges with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`);
400
- await this.BLEPushConnection();
401
- });
402
- }
403
- catch (error) {
404
- this.errorLog(`failed to format device ID as MAC, Error: ${error}`);
405
- }
406
- }
407
- else {
408
- this.debugLog(`No Changes (BLEpushChanges), On: ${this.On} OnCached: ${this.accessory.context.On}`);
409
- }
410
- }
411
- async openAPIpushChanges() {
412
- this.debugLog('openAPIpushChanges');
413
- if ((this.On !== this.accessory.context.On) || this.allowPush) {
414
- const bodyChange = {
415
- command: this.On ? 'turnOn' : 'turnOff',
416
- parameter: 'default',
417
- commandType: 'command',
418
- };
419
- this.debugLog(`SwitchBot OpenAPI bodyChange: ${JSON.stringify(bodyChange)}`);
420
- try {
421
- const deviceStatus = await this.pushChangeRequest(bodyChange);
422
- this.debugLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`);
423
- if (await this.successfulStatusCodes(deviceStatus)) {
424
- this.debugSuccessLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`);
425
- await this.updateHomeKitCharacteristics();
426
- }
427
- else {
428
- await this.statusCode(deviceStatus.statusCode);
429
- }
430
- }
431
- catch (e) {
432
- await this.apiError(e);
433
- this.errorLog(`failed openAPIpushChanges with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`);
434
- }
435
- }
436
- else {
437
- this.debugLog(`No Changes (openAPIpushChanges), On: ${this.On} OnCached: ${this.accessory.context.On}`);
438
- }
439
- }
440
- /**
441
- * Handle requests to set the "On" characteristic
442
- */
443
- async OnSet(value) {
444
- this.debugLog(`value: ${value}`);
445
- const deviceTypeActions = {
446
- switch: () => this.On = value !== false,
447
- garagedoor: () => this.On = value !== this.hap.Characteristic.TargetDoorState.CLOSED,
448
- door: () => this.On = value !== 0,
449
- window: () => this.On = value !== 0,
450
- windowcovering: () => this.On = value !== 0,
451
- lock: () => this.On = value !== this.hap.Characteristic.LockTargetState.SECURED,
452
- faucet: () => this.On = value !== this.hap.Characteristic.Active.INACTIVE,
453
- fan: () => this.On = value !== 0,
454
- stateful: () => this.On = value !== 0,
455
- default: () => this.On = value !== false,
456
- };
457
- const action = deviceTypeActions[this.relaySwitchDeviceType] || deviceTypeActions.default;
458
- action();
459
- this.doRelaySwitchUpdate.next();
460
- }
461
- /**
462
- * Updates the status for each of the HomeKit Characteristics
463
- */
464
- async updateHomeKitCharacteristics() {
465
- this.debugLog('updateHomeKitCharacteristics');
466
- // State
467
- const updateCharacteristic = async (service, characteristic, value, logMessage) => {
468
- service.updateCharacteristic(characteristic, value);
469
- this.debugLog(logMessage);
470
- };
471
- const stateActions = {
472
- switch: async () => this.Switch && await updateCharacteristic(this.Switch.Service, this.hap.Characteristic.On, this.On, `updateCharacteristic On: ${this.On}`),
473
- garagedoor: async () => {
474
- if (this.GarageDoor) {
475
- const targetState = this.On ? this.hap.Characteristic.TargetDoorState.OPEN : this.hap.Characteristic.TargetDoorState.CLOSED;
476
- const currentState = this.On ? this.hap.Characteristic.CurrentDoorState.OPEN : this.hap.Characteristic.CurrentDoorState.CLOSED;
477
- await updateCharacteristic(this.GarageDoor.Service, this.hap.Characteristic.TargetDoorState, targetState, `updateCharacteristic TargetDoorState: ${targetState}, CurrentDoorState: ${currentState} (${this.On})`);
478
- await updateCharacteristic(this.GarageDoor.Service, this.hap.Characteristic.CurrentDoorState, currentState, '');
479
- }
480
- },
481
- door: async () => {
482
- if (this.Door) {
483
- const position = this.On ? 100 : 0;
484
- await updateCharacteristic(this.Door.Service, this.hap.Characteristic.TargetPosition, position, `updateCharacteristic TargetPosition: ${position}, CurrentPosition: ${position} (${this.On})`);
485
- await updateCharacteristic(this.Door.Service, this.hap.Characteristic.CurrentPosition, position, '');
486
- await updateCharacteristic(this.Door.Service, this.hap.Characteristic.PositionState, this.hap.Characteristic.PositionState.STOPPED, '');
487
- }
488
- },
489
- window: async () => {
490
- if (this.Window) {
491
- const position = this.On ? 100 : 0;
492
- await updateCharacteristic(this.Window.Service, this.hap.Characteristic.TargetPosition, position, `updateCharacteristic TargetPosition: ${position}, CurrentPosition: ${position} (${this.On})`);
493
- await updateCharacteristic(this.Window.Service, this.hap.Characteristic.CurrentPosition, position, '');
494
- await updateCharacteristic(this.Window.Service, this.hap.Characteristic.PositionState, this.hap.Characteristic.PositionState.STOPPED, '');
495
- }
496
- },
497
- windowcovering: async () => {
498
- if (this.WindowCovering) {
499
- const position = this.On ? 100 : 0;
500
- await updateCharacteristic(this.WindowCovering.Service, this.hap.Characteristic.TargetPosition, position, `updateCharacteristic TargetPosition: ${position}, CurrentPosition: ${position} (${this.On})`);
501
- await updateCharacteristic(this.WindowCovering.Service, this.hap.Characteristic.CurrentPosition, position, '');
502
- await updateCharacteristic(this.WindowCovering.Service, this.hap.Characteristic.PositionState, this.hap.Characteristic.PositionState.STOPPED, '');
503
- }
504
- },
505
- lock: async () => {
506
- if (this.LockMechanism) {
507
- const targetState = this.On ? this.hap.Characteristic.LockTargetState.UNSECURED : this.hap.Characteristic.LockTargetState.SECURED;
508
- const currentState = this.On ? this.hap.Characteristic.LockCurrentState.UNSECURED : this.hap.Characteristic.LockCurrentState.SECURED;
509
- await updateCharacteristic(this.LockMechanism.Service, this.hap.Characteristic.LockTargetState, targetState, `updateCharacteristic LockTargetState: ${targetState}, LockCurrentState: ${currentState} (${this.On})`);
510
- await updateCharacteristic(this.LockMechanism.Service, this.hap.Characteristic.LockCurrentState, currentState, '');
511
- }
512
- },
513
- faucet: async () => this.Faucet && await updateCharacteristic(this.Faucet.Service, this.hap.Characteristic.Active, this.On ? this.hap.Characteristic.Active.ACTIVE : this.hap.Characteristic.Active.INACTIVE, `updateCharacteristic Active: ${this.On}`),
514
- fan: async () => this.Fan && await updateCharacteristic(this.Fan.Service, this.hap.Characteristic.Active, this.On ? this.hap.Characteristic.Active.ACTIVE : this.hap.Characteristic.Active.INACTIVE, `updateCharacteristic Active: ${this.On}`),
515
- stateful: async () => {
516
- if (this.StatefulProgrammableSwitch) {
517
- await updateCharacteristic(this.StatefulProgrammableSwitch.Service, this.hap.Characteristic.ProgrammableSwitchEvent, this.hap.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS, `updateCharacteristic ProgrammableSwitchEvent: SINGLE_PRESS (${this.On})`);
518
- await updateCharacteristic(this.StatefulProgrammableSwitch.Service, this.hap.Characteristic.ProgrammableSwitchOutputState, this.On ? 1 : 0, `updateCharacteristic ProgrammableSwitchOutputState: ${this.On ? 1 : 0}`);
519
- }
520
- },
521
- outlet: async () => this.Outlet && await updateCharacteristic(this.Outlet.Service, this.hap.Characteristic.On, this.On, `updateCharacteristic On: ${this.On}`),
522
- default: async () => this.errorLog(`relaySwitchDeviceType: ${this.relaySwitchDeviceType}, On: ${this.On}`),
523
- };
524
- const action = stateActions[this.relaySwitchDeviceType] || stateActions.default;
525
- await action();
526
- }
527
- async removeService(accessory, serviceType, serviceName) {
528
- const contextKey = serviceName.charAt(0).toUpperCase() + serviceName.slice(1);
529
- accessory.context[contextKey] = accessory.context[contextKey] ?? {};
530
- this[contextKey] = {
531
- Name: accessory.context[contextKey].Name ?? accessory.displayName,
532
- Service: accessory.getService(this.hap.Service[serviceType]),
533
- };
534
- accessory.context[contextKey] = this[contextKey];
535
- this.debugWarnLog(`Removing any leftover ${contextKey} Service`);
536
- accessory.removeService(this[contextKey].Service);
537
- }
538
- async removeOutletService(accessory) {
539
- await this.removeService(accessory, 'Outlet', 'outlet');
540
- }
541
- async removeGarageDoorService(accessory) {
542
- await this.removeService(accessory, 'GarageDoorOpener', 'garageDoor');
543
- }
544
- async removeDoorService(accessory) {
545
- await this.removeService(accessory, 'Door', 'door');
546
- }
547
- async removeLockService(accessory) {
548
- await this.removeService(accessory, 'LockMechanism', 'lockMechanism');
549
- }
550
- async removeFaucetService(accessory) {
551
- await this.removeService(accessory, 'Valve', 'faucet');
552
- }
553
- async removeFanService(accessory) {
554
- await this.removeService(accessory, 'Fan', 'fan');
555
- }
556
- async removeWindowService(accessory) {
557
- await this.removeService(accessory, 'Window', 'window');
558
- }
559
- async removeWindowCoveringService(accessory) {
560
- await this.removeService(accessory, 'WindowCovering', 'windowCovering');
561
- }
562
- async removeStatefulProgrammableSwitchService(accessory) {
563
- await this.removeService(accessory, 'StatefulProgrammableSwitch', 'statefulProgrammableSwitch');
564
- }
565
- async removeSwitchService(accessory) {
566
- await this.removeService(accessory, 'Switch', 'switch');
567
- }
568
- async getRelaySwitchConfigSettings(device) {
569
- // RelaySwitch Device Type
570
- this.relaySwitchDeviceType = device.type ?? 'Outlet';
571
- const relaySwitchDeviceType = device.type ? 'Device Config' : 'Default';
572
- this.debugWarnLog(`Use ${relaySwitchDeviceType} Device Type: ${this.relaySwitchDeviceType}`);
573
- // RelaySwitch Allow Push
574
- this.allowPush = device.allowPush ?? false;
575
- const allowPush = device.allowPush
576
- ? `Using Allow Push: ${this.allowPush}`
577
- : `No Allow Push Set, Using default Allow Push: ${this.allowPush}`;
578
- this.debugWarnLog(allowPush);
579
- }
580
- async BLEPushConnection() {
581
- if (this.platform.config.credentials?.token && this.device.connectionType === 'BLE/OpenAPI') {
582
- this.warnLog('Using OpenAPI Connection to Push Changes');
583
- await this.openAPIpushChanges();
584
- }
585
- }
586
- async BLERefreshConnection(switchbot) {
587
- this.errorLog(`wasn't able to establish BLE Connection, node-switchbot: ${switchbot}`);
588
- if (this.platform.config.credentials?.token && this.device.connectionType === 'BLE/OpenAPI') {
589
- this.warnLog('Using OpenAPI Connection to Refresh Status');
590
- await this.openAPIRefreshStatus();
591
- }
592
- }
593
- async offlineOff() {
594
- if (this.device.offline) {
595
- const updateCharacteristics = (service, characteristics) => {
596
- for (const [characteristic, value] of Object.entries(characteristics)) {
597
- service.updateCharacteristic(this.hap.Characteristic[characteristic], value);
598
- }
599
- };
600
- const characteristicsMap = {
601
- garagedoor: { TargetDoorState: 'CLOSED', CurrentDoorState: 'CLOSED', ObstructionDetected: false },
602
- door: { TargetPosition: 0, CurrentPosition: 0, PositionState: 'STOPPED' },
603
- window: { TargetPosition: 0, CurrentPosition: 0, PositionState: 'STOPPED' },
604
- windowcovering: { TargetPosition: 0, CurrentPosition: 0, PositionState: 'STOPPED' },
605
- lock: { LockTargetState: 'SECURED', LockCurrentState: 'SECURED' },
606
- faucet: { Active: 'INACTIVE' },
607
- fan: { On: false },
608
- stateful: { ProgrammableSwitchEvent: 'SINGLE_PRESS', ProgrammableSwitchOutputState: 0 },
609
- switch: { On: false },
610
- outlet: { On: false },
611
- };
612
- const service = this[this.relaySwitchDeviceType.charAt(0).toUpperCase() + this.relaySwitchDeviceType.slice(1)]?.Service;
613
- if (service) {
614
- updateCharacteristics(service, characteristicsMap[this.relaySwitchDeviceType]);
615
- }
616
- }
617
- }
618
- async apiError(e) {
619
- const updateCharacteristics = (service, characteristics) => {
620
- for (const [characteristic] of Object.entries(characteristics)) {
621
- service.updateCharacteristic(this.hap.Characteristic[characteristic], e);
622
- }
623
- };
624
- const characteristicsMap = {
625
- garagedoor: { TargetDoorState: e, CurrentDoorState: e, ObstructionDetected: e },
626
- door: { TargetPosition: e, CurrentPosition: e, PositionState: e },
627
- window: { TargetPosition: e, CurrentPosition: e, PositionState: e },
628
- windowcovering: { TargetPosition: e, CurrentPosition: e, PositionState: e },
629
- lock: { LockTargetState: e, LockCurrentState: e },
630
- faucet: { Active: e },
631
- fan: { On: e },
632
- stateful: { ProgrammableSwitchEvent: e, ProgrammableSwitchOutputState: e },
633
- switch: { On: e },
634
- outlet: { On: e },
635
- };
636
- const service = this[this.relaySwitchDeviceType.charAt(0).toUpperCase() + this.relaySwitchDeviceType.slice(1)]?.Service;
637
- if (service) {
638
- updateCharacteristics(service, characteristicsMap[this.relaySwitchDeviceType]);
639
- }
640
- }
641
- }
642
- //# sourceMappingURL=relayswitch.js.map