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