@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,727 +0,0 @@
1
- /* Copyright(C) 2021-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
2
- *
3
- * bot.ts: @switchbot/homebridge-switchbot.
4
- */
5
- import type { CharacteristicValue, PlatformAccessory, Service } from 'homebridge'
6
- import type { bodyChange, device, relaySwitch1Context, relaySwitch1PMContext, relaySwitch1PMServiceData, relaySwitch1PMStatus, relaySwitch1ServiceData, relaySwitch1Status, SwitchBotBLE, SwitchbotDevice, WoRelaySwitch1, WoRelaySwitch1PM } from 'node-switchbot'
7
-
8
- import type { SwitchBotHAPPlatform } from '../platform-hap.js'
9
- import type { devicesConfig, relaySwitch1Config, relaySwitch1PMConfig } from '../settings.js'
10
-
11
- /*
12
- * For Testing Locally:
13
- * import { SwitchBotBLEModel, SwitchBotBLEModelName } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
14
- */
15
- import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot'
16
- import { debounceTime, interval, skipWhile, Subject, take, tap } from 'rxjs'
17
-
18
- import { formatDeviceIdAsMac } from '../utils.js'
19
- import { deviceBase } from './device.js'
20
-
21
- /**
22
- * Platform Accessory
23
- * An instance of this class is created for each accessory your platform registers
24
- * Each accessory may expose multiple services of different service types.
25
- */
26
- export class RelaySwitch extends deviceBase {
27
- // Services
28
- private Switch?: {
29
- Name: CharacteristicValue
30
- Service: Service
31
- }
32
-
33
- private GarageDoor?: {
34
- Name: CharacteristicValue
35
- Service: Service
36
- }
37
-
38
- private Door?: {
39
- Name: CharacteristicValue
40
- Service: Service
41
- }
42
-
43
- private Window?: {
44
- Name: CharacteristicValue
45
- Service: Service
46
- }
47
-
48
- private WindowCovering?: {
49
- Name: CharacteristicValue
50
- Service: Service
51
- }
52
-
53
- private LockMechanism?: {
54
- Name: CharacteristicValue
55
- Service: Service
56
- }
57
-
58
- private Faucet?: {
59
- Name: CharacteristicValue
60
- Service: Service
61
- }
62
-
63
- private Fan?: {
64
- Name: CharacteristicValue
65
- Service: Service
66
- }
67
-
68
- private StatefulProgrammableSwitch?: {
69
- Name: CharacteristicValue
70
- Service: Service
71
- }
72
-
73
- private Outlet?: {
74
- Name: CharacteristicValue
75
- Service: Service
76
- }
77
-
78
- On!: boolean
79
-
80
- // OpenAPI
81
- deviceStatus!: relaySwitch1Status | relaySwitch1PMStatus
82
-
83
- // Webhook
84
- webhookContext!: relaySwitch1Context | relaySwitch1PMContext
85
-
86
- // BLE
87
- serviceData!: relaySwitch1ServiceData | relaySwitch1PMServiceData
88
-
89
- // Config
90
- allowPush?: boolean
91
- relaySwitchDeviceType!: string
92
-
93
- // Updates
94
- relaySwitchUpdateInProgress!: boolean
95
- doRelaySwitchUpdate!: Subject<void>
96
-
97
- /**
98
- * Constructs a new instance of the RelaySwitch device.
99
- *
100
- * @param {SwitchBotPlatform} platform - The platform instance.
101
- * @param {PlatformAccessory} accessory - The platform accessory.
102
- * @param {device & devicesConfig} device - The device configuration.
103
- *
104
- * Initializes the RelaySwitch device, sets up the battery service, maps the device type to the appropriate HomeKit service,
105
- * removes unnecessary services, retrieves initial values, registers event handlers, and starts update intervals.
106
- *
107
- * @constructor
108
- */
109
- constructor(
110
- readonly platform: SwitchBotHAPPlatform,
111
- accessory: PlatformAccessory,
112
- device: device & devicesConfig,
113
- ) {
114
- super(platform, accessory, device)
115
-
116
- this.getRelaySwitchConfigSettings(device)
117
-
118
- // this is subject we use to track when we need to POST changes to the SwitchBot API
119
- this.doRelaySwitchUpdate = new Subject()
120
- this.relaySwitchUpdateInProgress = false
121
-
122
- /**
123
- * A mapping of device types to their corresponding HomeKit categories, services, and characteristics.
124
- *
125
- * Each key represents a device type and maps to an object containing:
126
- * - `category`: The HomeKit category for the device.
127
- * - `service`: The HomeKit service associated with the device.
128
- * - `characteristic`: The HomeKit characteristic for the device.
129
- */
130
- const deviceTypeMap: { [key: string]: { category: number, service: any, characteristic: any } } = {
131
- switch: { category: this.hap.Categories.SWITCH, service: this.hap.Service.Switch, characteristic: this.hap.Characteristic.On },
132
- garagedoor: { category: this.hap.Categories.GARAGE_DOOR_OPENER, service: this.hap.Service.GarageDoorOpener, characteristic: this.hap.Characteristic.TargetDoorState },
133
- door: { category: this.hap.Categories.DOOR, service: this.hap.Service.Door, characteristic: this.hap.Characteristic.TargetPosition },
134
- window: { category: this.hap.Categories.WINDOW, service: this.hap.Service.Window, characteristic: this.hap.Characteristic.TargetPosition },
135
- windowcovering: { category: this.hap.Categories.WINDOW_COVERING, service: this.hap.Service.WindowCovering, characteristic: this.hap.Characteristic.TargetPosition },
136
- lock: { category: this.hap.Categories.DOOR_LOCK, service: this.hap.Service.LockMechanism, characteristic: this.hap.Characteristic.LockTargetState },
137
- faucet: { category: this.hap.Categories.FAUCET, service: this.hap.Service.Faucet, characteristic: this.hap.Characteristic.Active },
138
- fan: { category: this.hap.Categories.FAN, service: this.hap.Service.Fanv2, characteristic: this.hap.Characteristic.Active },
139
- stateful: { category: this.hap.Categories.PROGRAMMABLE_SWITCH, service: this.hap.Service.StatefulProgrammableSwitch, characteristic: this.hap.Characteristic.ProgrammableSwitchOutputState },
140
- outlet: { category: this.hap.Categories.OUTLET, service: this.hap.Service.Outlet, characteristic: this.hap.Characteristic.On },
141
- }
142
-
143
- /**
144
- * The type of the device, determined by mapping the relaySwitchDeviceType to a value in the deviceTypeMap.
145
- */
146
- const deviceType = deviceTypeMap[this.relaySwitchDeviceType]
147
-
148
- if (deviceType) {
149
- // Set category
150
- accessory.category = deviceType.category
151
- // Initialize Service
152
- const contextKey = this.relaySwitchDeviceType.charAt(0).toUpperCase() + this.relaySwitchDeviceType.slice(1)
153
- accessory.context[contextKey] = accessory.context[contextKey] ?? {}
154
- this[this.relaySwitchDeviceType.charAt(0).toUpperCase() + this.relaySwitchDeviceType.slice(1)] = {
155
- Name: accessory.displayName,
156
- Service: accessory.getService(deviceType.service) ?? accessory.addService(deviceType.service) as Service,
157
- }
158
- accessory.context[contextKey] = this[this.relaySwitchDeviceType.charAt(0).toUpperCase() + this.relaySwitchDeviceType.slice(1)] as object
159
- this.debugLog(`Displaying as ${contextKey}`)
160
- // Initialize Characteristics
161
- 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))
162
- } else {
163
- this.errorLog('Device Type not set')
164
- }
165
-
166
- /**
167
- * An array of service removal functions that should be executed based on the current state of the device.
168
- * Each element in the array is a function that removes a specific service if the corresponding condition is met.
169
- */
170
- const servicesToRemove = [
171
- !this.StatefulProgrammableSwitch && this.removeStatefulProgrammableSwitchService,
172
- !this.Outlet && this.removeOutletService,
173
- !this.Window && this.removeWindowService,
174
- !this.GarageDoor && this.removeGarageDoorService,
175
- this.WindowCovering && this.removeWindowCoveringService,
176
- !this.Switch && this.removeSwitchService,
177
- !this.Faucet && this.removeFaucetService,
178
- !this.Door && this.removeDoorService,
179
- !this.LockMechanism && this.removeLockService,
180
- !this.Fan && this.removeFanService,
181
- ].filter(Boolean)
182
-
183
- for (const removeService of servicesToRemove) {
184
- if (typeof removeService === 'function') {
185
- removeService.call(this, accessory)
186
- }
187
- }
188
-
189
- // Retrieve initial values and updateHomekit
190
- try {
191
- this.debugLog('Retrieve initial values and update Homekit')
192
- this.refreshStatus()
193
- } catch (e: any) {
194
- this.errorLog(`failed to retrieve initial values and update Homekit, Error: ${e.message ?? e}`)
195
- }
196
-
197
- // regisiter webhook event handler if enabled
198
- try {
199
- this.debugLog('Registering Webhook Event Handler')
200
- this.registerWebhook()
201
- } catch (e: any) {
202
- this.errorLog(`failed to registerWebhook, Error: ${e.message ?? e}`)
203
- }
204
-
205
- // regisiter platform BLE event handler if enabled
206
- try {
207
- this.debugLog('Registering Platform BLE Event Handler')
208
- this.registerPlatformBLE()
209
- } catch (e: any) {
210
- this.errorLog(`failed to registerPlatformBLE, Error: ${e.message ?? e}`)
211
- }
212
-
213
- // Start an update interval
214
- interval(this.deviceRefreshRate * 1000)
215
- .pipe(skipWhile(() => this.relaySwitchUpdateInProgress))
216
- .subscribe(async () => {
217
- await this.refreshStatus()
218
- })
219
-
220
- // Watch for RelaySwitch change events
221
- // We put in a debounce of 1000ms so we don't make duplicate calls
222
- this.doRelaySwitchUpdate
223
- .pipe(
224
- tap(() => {
225
- this.relaySwitchUpdateInProgress = true
226
- }),
227
- debounceTime(this.devicePushRate * 1000),
228
- )
229
- .subscribe(async () => {
230
- try {
231
- await this.pushChanges()
232
- } catch (e: any) {
233
- await this.apiError(e)
234
- this.errorLog(`failed pushChanges with ${device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
235
- }
236
- this.relaySwitchUpdateInProgress = false
237
- })
238
- }
239
-
240
- /**
241
- * Parse the device status from the SwitchBotBLE API
242
- */
243
- async BLEparseStatus(): Promise<void> {
244
- this.debugLog('BLEparseStatus')
245
- this.debugLog(`(power, battery, deviceMode) = BLE:(${this.serviceData.state}), current:(${this.accessory.context.On})`)
246
-
247
- // BLEmode (true if Switch Mode) | (false if Press Mode)
248
- this.On = this.serviceData.mode ? this.serviceData.state : false
249
- const mode = this.serviceData.mode ? 'Switch' : 'Press'
250
- this.debugLog(`${mode} Mode, On: ${this.On}`)
251
- this.accessory.context.On = this.On
252
- }
253
-
254
- /**
255
- * Parse the device status from the SwitchBot OpenAPI
256
- */
257
- async openAPIparseStatus(): Promise<void> {
258
- this.debugLog('openAPIparseStatus')
259
- this.debugLog(`(power, battery, deviceMode) = API:(${this.deviceStatus.switchStatus}), current:(${this.accessory.context.On})`)
260
-
261
- // On
262
- this.On = this.deviceStatus.switchStatus !== 0
263
- this.debugLog(`On: ${this.On}`)
264
- this.accessory.context.On = this.On
265
-
266
- // Firmware Version
267
- if (this.deviceStatus.version) {
268
- const version = this.deviceStatus.version as string
269
- this.debugLog(`Firmware Version: ${version.replace(/^V|-.*$/g, '')}`)
270
- const deviceVersion = version.replace(/^V|-.*$/g, '') ?? '0.0.0'
271
- this.accessory
272
- .getService(this.hap.Service.AccessoryInformation)!
273
- .setCharacteristic(this.hap.Characteristic.HardwareRevision, deviceVersion)
274
- .setCharacteristic(this.hap.Characteristic.FirmwareRevision, deviceVersion)
275
- .getCharacteristic(this.hap.Characteristic.FirmwareRevision)
276
- .updateValue(deviceVersion)
277
- this.accessory.context.version = deviceVersion
278
- this.debugLog(`version: ${deviceVersion}`)
279
- }
280
- }
281
-
282
- async parseStatusWebhook(): Promise<void> {
283
- this.debugLog('parseStatusWebhook')
284
- this.debugLog(`(power, battery, deviceMode) = Webhook:(${this.webhookContext.switchStatus}), current:(${this.On})`)
285
-
286
- // On
287
- this.On = this.webhookContext.switchStatus !== 0
288
- this.debugLog(`On: ${this.On}`)
289
- }
290
-
291
- /**
292
- * Asks the SwitchBot API for the latest device information
293
- */
294
- async refreshStatus(): Promise<void> {
295
- if (this.BLE) {
296
- await this.BLERefreshStatus()
297
- } else if (this.OpenAPI && this.platform.config.credentials?.token) {
298
- await this.openAPIRefreshStatus()
299
- } else {
300
- await this.offlineOff()
301
- this.debugWarnLog(`Connection Type: ${this.device.connectionType}, refreshStatus will not happen.`)
302
- }
303
- }
304
-
305
- async BLERefreshStatus(): Promise<void> {
306
- this.debugLog('BLERefreshStatus')
307
- const switchBotBLE = await this.switchbotBLE()
308
- if (switchBotBLE === undefined) {
309
- await this.BLERefreshConnection(switchBotBLE)
310
- } else {
311
- // Start to monitor advertisement packets
312
- (async () => {
313
- // Start to monitor advertisement packets
314
- const serviceData = await this.monitorAdvertisementPackets(switchBotBLE) as relaySwitch1ServiceData | relaySwitch1PMServiceData
315
- // Update HomeKit
316
- if ((serviceData.model === SwitchBotBLEModel.RelaySwitch1PM && serviceData.modelName === SwitchBotBLEModelName.RelaySwitch1PM) ?? (serviceData.model === SwitchBotBLEModel.RelaySwitch1 && serviceData.modelName === SwitchBotBLEModelName.RelaySwitch1)) {
317
- this.serviceData = serviceData
318
- if (serviceData !== undefined || serviceData !== null) {
319
- await this.BLEparseStatus()
320
- await this.updateHomeKitCharacteristics()
321
- } else {
322
- this.errorLog(`serviceData is either undefined or null, serviceData: ${JSON.stringify(serviceData)}`)
323
- await this.BLERefreshConnection(switchBotBLE)
324
- }
325
- } else {
326
- this.errorLog(`failed to get serviceData, serviceData: ${JSON.stringify(serviceData)}`)
327
- await this.BLERefreshConnection(switchBotBLE)
328
- }
329
- })()
330
- }
331
- }
332
-
333
- async registerPlatformBLE(): Promise<void> {
334
- this.debugLog('registerPlatformBLE')
335
- if (this.config.options?.BLE && !this.device.disablePlatformBLE) {
336
- this.debugLog('is listening to Platform BLE.')
337
- try {
338
- const formattedDeviceId = formatDeviceIdAsMac(this.device.deviceId)
339
- this.device.bleMac = formattedDeviceId
340
- this.debugLog(`bleMac: ${this.device.bleMac}`)
341
- this.platform.bleEventHandler[this.device.bleMac] = async (context: relaySwitch1ServiceData | relaySwitch1PMServiceData) => {
342
- try {
343
- this.serviceData = context
344
- if (context !== undefined || context !== null) {
345
- this.debugLog(`received BLE: ${JSON.stringify(context)}`)
346
- await this.BLEparseStatus()
347
- await this.updateHomeKitCharacteristics()
348
- } else {
349
- this.errorLog(`context is either undefined or null, context: ${JSON.stringify(context)}`)
350
- await this.BLERefreshConnection(context)
351
- }
352
- } catch (e: any) {
353
- this.errorLog(`failed to handle BLE. Received: ${JSON.stringify(context)} Error: ${e.message ?? e}`)
354
- }
355
- }
356
- } catch (error) {
357
- this.errorLog(`failed to format device ID as MAC, Error: ${error}`)
358
- }
359
- } else {
360
- this.debugLog('is not listening to Platform BLE')
361
- }
362
- }
363
-
364
- async openAPIRefreshStatus(): Promise<void> {
365
- this.debugLog('openAPIRefreshStatus')
366
- try {
367
- const deviceStatus = await this.deviceRefreshStatus<relaySwitch1Status | relaySwitch1PMStatus>()
368
- this.debugLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`)
369
- if (await this.successfulStatusCodes(deviceStatus)) {
370
- this.debugSuccessLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`)
371
- this.deviceStatus = deviceStatus.body
372
- await this.openAPIparseStatus()
373
- await this.updateHomeKitCharacteristics()
374
- } else {
375
- this.debugWarnLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`)
376
- }
377
- } catch (e: any) {
378
- await this.apiError(e)
379
- this.errorLog(`failed openAPIRefreshStatus with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
380
- }
381
- }
382
-
383
- async registerWebhook() {
384
- if (this.device.webhook) {
385
- this.debugLog('is listening webhook.')
386
- this.platform.webhookEventHandler[this.device.deviceId] = async (context: relaySwitch1Context | relaySwitch1PMContext) => {
387
- try {
388
- this.webhookContext = context
389
- if (context !== undefined || context !== null) {
390
- this.debugLog(`received Webhook: ${JSON.stringify(context)}`)
391
- await this.parseStatusWebhook()
392
- await this.updateHomeKitCharacteristics()
393
- } else {
394
- this.errorLog(`context is either undefined or null, context: ${JSON.stringify(context)}`)
395
- }
396
- } catch (e: any) {
397
- this.errorLog(`failed to handle webhook. Received: ${JSON.stringify(context)} Error: ${e.message ?? e}`)
398
- }
399
- }
400
- } else {
401
- this.debugLog('is not listening webhook.')
402
- }
403
- }
404
-
405
- /**
406
- * Pushes the requested changes to the SwitchBot API
407
- * deviceType commandType Command command parameter Description
408
- * RelaySwitch "command" "turnOff" "default" = set to OFF state
409
- * RelaySwitch "command" "turnOn" "default" = set to ON state
410
- */
411
- async pushChanges(): Promise<void> {
412
- if (this.BLE) {
413
- await this.BLEpushChanges()
414
- } else if (this.OpenAPI && this.platform.config.credentials?.token) {
415
- await this.openAPIpushChanges()
416
- } else {
417
- await this.offlineOff()
418
- this.debugWarnLog(`Connection Type: ${this.device.connectionType}, pushChanges will not happen.`)
419
- }
420
- // Refresh the status from the API
421
- interval(15000)
422
- .pipe(skipWhile(() => this.relaySwitchUpdateInProgress))
423
- .pipe(take(1))
424
- .subscribe(async () => {
425
- await this.refreshStatus()
426
- })
427
- }
428
-
429
- async BLEpushChanges(): Promise<void> {
430
- this.debugLog('BLEpushChanges')
431
- if ((this.On !== this.accessory.context.On) || this.allowPush) {
432
- this.debugLog(`BLEpushChanges On: ${this.On} OnCached: ${this.accessory.context.On}`)
433
- const switchBotBLE = this.platform.switchBotBLE
434
- try {
435
- const formattedDeviceId = formatDeviceIdAsMac(this.device.deviceId)
436
- this.device.bleMac = formattedDeviceId
437
- this.debugLog(`bleMac: ${this.device.bleMac}`)
438
- switchBotBLE
439
- .discover({ model: this.device.bleModel, quick: true, id: this.device.bleMac })
440
- .then(async (device_list: SwitchbotDevice[]) => {
441
- const deviceList = device_list as WoRelaySwitch1[] | WoRelaySwitch1PM[]
442
- this.infoLog(`On: ${this.On}`)
443
- this.warnLog(`device_list: ${JSON.stringify(device_list)}`)
444
- return await this.retryBLE({
445
- max: this.maxRetryBLE(),
446
- fn: async () => {
447
- if (deviceList.length > 0) {
448
- if (this.On) {
449
- return await deviceList[0].turnOn()
450
- } else {
451
- return await deviceList[0].turnOff()
452
- }
453
- } else {
454
- throw new Error('No device found')
455
- }
456
- },
457
- })
458
- })
459
- .then(async () => {
460
- this.successLog(`On: ${this.On} sent over SwitchBot BLE, sent successfully`)
461
- await this.updateHomeKitCharacteristics()
462
- })
463
- .catch(async (e: any) => {
464
- await this.apiError(e)
465
- this.errorLog(`failed BLEpushChanges with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
466
- await this.BLEPushConnection()
467
- })
468
- } catch (error) {
469
- this.errorLog(`failed to format device ID as MAC, Error: ${error}`)
470
- }
471
- } else {
472
- this.debugLog(`No Changes (BLEpushChanges), On: ${this.On} OnCached: ${this.accessory.context.On}`)
473
- }
474
- }
475
-
476
- async openAPIpushChanges(): Promise<void> {
477
- this.debugLog('openAPIpushChanges')
478
- if ((this.On !== this.accessory.context.On) || this.allowPush) {
479
- const bodyChange: bodyChange = {
480
- command: this.On ? 'turnOn' : 'turnOff',
481
- parameter: 'default',
482
- commandType: 'command',
483
- }
484
- this.debugLog(`SwitchBot OpenAPI bodyChange: ${JSON.stringify(bodyChange)}`)
485
- try {
486
- const deviceStatus = await this.pushChangeRequest(bodyChange)
487
- this.debugLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`)
488
- if (await this.successfulStatusCodes(deviceStatus)) {
489
- this.debugSuccessLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`)
490
- await this.updateHomeKitCharacteristics()
491
- } else {
492
- await this.statusCode(deviceStatus.statusCode)
493
- }
494
- } catch (e: any) {
495
- await this.apiError(e)
496
- this.errorLog(`failed openAPIpushChanges with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
497
- }
498
- } else {
499
- this.debugLog(`No Changes (openAPIpushChanges), On: ${this.On} OnCached: ${this.accessory.context.On}`)
500
- }
501
- }
502
-
503
- /**
504
- * Handle requests to set the "On" characteristic
505
- */
506
- async OnSet(value: CharacteristicValue): Promise<void> {
507
- this.debugLog(`value: ${value}`)
508
- const deviceTypeActions: { [key: string]: () => void } = {
509
- switch: () => this.On = value !== false,
510
- garagedoor: () => this.On = value !== this.hap.Characteristic.TargetDoorState.CLOSED,
511
- door: () => this.On = value !== 0,
512
- window: () => this.On = value !== 0,
513
- windowcovering: () => this.On = value !== 0,
514
- lock: () => this.On = value !== this.hap.Characteristic.LockTargetState.SECURED,
515
- faucet: () => this.On = value !== this.hap.Characteristic.Active.INACTIVE,
516
- fan: () => this.On = value !== 0,
517
- stateful: () => this.On = value !== 0,
518
- default: () => this.On = value !== false,
519
- }
520
- const action = deviceTypeActions[this.relaySwitchDeviceType] || deviceTypeActions.default
521
- action()
522
- this.doRelaySwitchUpdate.next()
523
- }
524
-
525
- /**
526
- * Updates the status for each of the HomeKit Characteristics
527
- */
528
- async updateHomeKitCharacteristics(): Promise<void> {
529
- this.debugLog('updateHomeKitCharacteristics')
530
- // State
531
- const updateCharacteristic = async (service: Service, characteristic: any, value: any, logMessage: string) => {
532
- service.updateCharacteristic(characteristic, value)
533
- this.debugLog(logMessage)
534
- }
535
-
536
- const stateActions: { [key: string]: () => Promise<void> } = {
537
- switch: async () => this.Switch && await updateCharacteristic(this.Switch.Service, this.hap.Characteristic.On, this.On, `updateCharacteristic On: ${this.On}`),
538
- garagedoor: async () => {
539
- if (this.GarageDoor) {
540
- const targetState = this.On ? this.hap.Characteristic.TargetDoorState.OPEN : this.hap.Characteristic.TargetDoorState.CLOSED
541
- const currentState = this.On ? this.hap.Characteristic.CurrentDoorState.OPEN : this.hap.Characteristic.CurrentDoorState.CLOSED
542
- await updateCharacteristic(this.GarageDoor.Service, this.hap.Characteristic.TargetDoorState, targetState, `updateCharacteristic TargetDoorState: ${targetState}, CurrentDoorState: ${currentState} (${this.On})`)
543
- await updateCharacteristic(this.GarageDoor.Service, this.hap.Characteristic.CurrentDoorState, currentState, '')
544
- }
545
- },
546
- door: async () => {
547
- if (this.Door) {
548
- const position = this.On ? 100 : 0
549
- await updateCharacteristic(this.Door.Service, this.hap.Characteristic.TargetPosition, position, `updateCharacteristic TargetPosition: ${position}, CurrentPosition: ${position} (${this.On})`)
550
- await updateCharacteristic(this.Door.Service, this.hap.Characteristic.CurrentPosition, position, '')
551
- await updateCharacteristic(this.Door.Service, this.hap.Characteristic.PositionState, this.hap.Characteristic.PositionState.STOPPED, '')
552
- }
553
- },
554
- window: async () => {
555
- if (this.Window) {
556
- const position = this.On ? 100 : 0
557
- await updateCharacteristic(this.Window.Service, this.hap.Characteristic.TargetPosition, position, `updateCharacteristic TargetPosition: ${position}, CurrentPosition: ${position} (${this.On})`)
558
- await updateCharacteristic(this.Window.Service, this.hap.Characteristic.CurrentPosition, position, '')
559
- await updateCharacteristic(this.Window.Service, this.hap.Characteristic.PositionState, this.hap.Characteristic.PositionState.STOPPED, '')
560
- }
561
- },
562
- windowcovering: async () => {
563
- if (this.WindowCovering) {
564
- const position = this.On ? 100 : 0
565
- await updateCharacteristic(this.WindowCovering.Service, this.hap.Characteristic.TargetPosition, position, `updateCharacteristic TargetPosition: ${position}, CurrentPosition: ${position} (${this.On})`)
566
- await updateCharacteristic(this.WindowCovering.Service, this.hap.Characteristic.CurrentPosition, position, '')
567
- await updateCharacteristic(this.WindowCovering.Service, this.hap.Characteristic.PositionState, this.hap.Characteristic.PositionState.STOPPED, '')
568
- }
569
- },
570
- lock: async () => {
571
- if (this.LockMechanism) {
572
- const targetState = this.On ? this.hap.Characteristic.LockTargetState.UNSECURED : this.hap.Characteristic.LockTargetState.SECURED
573
- const currentState = this.On ? this.hap.Characteristic.LockCurrentState.UNSECURED : this.hap.Characteristic.LockCurrentState.SECURED
574
- await updateCharacteristic(this.LockMechanism.Service, this.hap.Characteristic.LockTargetState, targetState, `updateCharacteristic LockTargetState: ${targetState}, LockCurrentState: ${currentState} (${this.On})`)
575
- await updateCharacteristic(this.LockMechanism.Service, this.hap.Characteristic.LockCurrentState, currentState, '')
576
- }
577
- },
578
- 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}`),
579
- 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}`),
580
- stateful: async () => {
581
- if (this.StatefulProgrammableSwitch) {
582
- await updateCharacteristic(this.StatefulProgrammableSwitch.Service, this.hap.Characteristic.ProgrammableSwitchEvent, this.hap.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS, `updateCharacteristic ProgrammableSwitchEvent: SINGLE_PRESS (${this.On})`)
583
- await updateCharacteristic(this.StatefulProgrammableSwitch.Service, this.hap.Characteristic.ProgrammableSwitchOutputState, this.On ? 1 : 0, `updateCharacteristic ProgrammableSwitchOutputState: ${this.On ? 1 : 0}`)
584
- }
585
- },
586
- outlet: async () => this.Outlet && await updateCharacteristic(this.Outlet.Service, this.hap.Characteristic.On, this.On, `updateCharacteristic On: ${this.On}`),
587
- default: async () => this.errorLog(`relaySwitchDeviceType: ${this.relaySwitchDeviceType}, On: ${this.On}`),
588
- }
589
-
590
- const action = stateActions[this.relaySwitchDeviceType] || stateActions.default
591
- await action()
592
- }
593
-
594
- async removeService(accessory: PlatformAccessory, serviceType: string, serviceName: string): Promise<void> {
595
- const contextKey = serviceName.charAt(0).toUpperCase() + serviceName.slice(1)
596
- accessory.context[contextKey] = accessory.context[contextKey] ?? {}
597
- this[contextKey] = {
598
- Name: accessory.context[contextKey].Name ?? accessory.displayName,
599
- Service: accessory.getService(this.hap.Service[serviceType]) as Service,
600
- }
601
- accessory.context[contextKey] = this[contextKey] as object
602
- this.debugWarnLog(`Removing any leftover ${contextKey} Service`)
603
- accessory.removeService(this[contextKey].Service)
604
- }
605
-
606
- async removeOutletService(accessory: PlatformAccessory): Promise<void> {
607
- await this.removeService(accessory, 'Outlet', 'outlet')
608
- }
609
-
610
- async removeGarageDoorService(accessory: PlatformAccessory): Promise<void> {
611
- await this.removeService(accessory, 'GarageDoorOpener', 'garageDoor')
612
- }
613
-
614
- async removeDoorService(accessory: PlatformAccessory): Promise<void> {
615
- await this.removeService(accessory, 'Door', 'door')
616
- }
617
-
618
- async removeLockService(accessory: PlatformAccessory): Promise<void> {
619
- await this.removeService(accessory, 'LockMechanism', 'lockMechanism')
620
- }
621
-
622
- async removeFaucetService(accessory: PlatformAccessory): Promise<void> {
623
- await this.removeService(accessory, 'Valve', 'faucet')
624
- }
625
-
626
- async removeFanService(accessory: PlatformAccessory): Promise<void> {
627
- await this.removeService(accessory, 'Fan', 'fan')
628
- }
629
-
630
- async removeWindowService(accessory: PlatformAccessory): Promise<void> {
631
- await this.removeService(accessory, 'Window', 'window')
632
- }
633
-
634
- async removeWindowCoveringService(accessory: PlatformAccessory): Promise<void> {
635
- await this.removeService(accessory, 'WindowCovering', 'windowCovering')
636
- }
637
-
638
- async removeStatefulProgrammableSwitchService(accessory: PlatformAccessory): Promise<void> {
639
- await this.removeService(accessory, 'StatefulProgrammableSwitch', 'statefulProgrammableSwitch')
640
- }
641
-
642
- async removeSwitchService(accessory: PlatformAccessory): Promise<void> {
643
- await this.removeService(accessory, 'Switch', 'switch')
644
- }
645
-
646
- async getRelaySwitchConfigSettings(device: device & devicesConfig) {
647
- // RelaySwitch Device Type
648
- this.relaySwitchDeviceType = (device as relaySwitch1Config | relaySwitch1PMConfig).type ?? 'Outlet'
649
- const relaySwitchDeviceType = (device as relaySwitch1Config | relaySwitch1PMConfig).type ? 'Device Config' : 'Default'
650
- this.debugWarnLog(`Use ${relaySwitchDeviceType} Device Type: ${this.relaySwitchDeviceType}`)
651
- // RelaySwitch Allow Push
652
- this.allowPush = (device as relaySwitch1Config | relaySwitch1PMConfig).allowPush ?? false
653
- const allowPush = (device as relaySwitch1Config | relaySwitch1PMConfig).allowPush
654
- ? `Using Allow Push: ${this.allowPush}`
655
- : `No Allow Push Set, Using default Allow Push: ${this.allowPush}`
656
- this.debugWarnLog(allowPush)
657
- }
658
-
659
- async BLEPushConnection() {
660
- if (this.platform.config.credentials?.token && this.device.connectionType === 'BLE/OpenAPI') {
661
- this.warnLog('Using OpenAPI Connection to Push Changes')
662
- await this.openAPIpushChanges()
663
- }
664
- }
665
-
666
- async BLERefreshConnection(switchbot: SwitchBotBLE): Promise<void> {
667
- this.errorLog(`wasn't able to establish BLE Connection, node-switchbot: ${switchbot}`)
668
- if (this.platform.config.credentials?.token && this.device.connectionType === 'BLE/OpenAPI') {
669
- this.warnLog('Using OpenAPI Connection to Refresh Status')
670
- await this.openAPIRefreshStatus()
671
- }
672
- }
673
-
674
- async offlineOff(): Promise<void> {
675
- if (this.device.offline) {
676
- const updateCharacteristics = (service: Service, characteristics: { [key: string]: any }) => {
677
- for (const [characteristic, value] of Object.entries(characteristics)) {
678
- service.updateCharacteristic(this.hap.Characteristic[characteristic], value)
679
- }
680
- }
681
-
682
- const characteristicsMap: { [key: string]: { [key: string]: any } } = {
683
- garagedoor: { TargetDoorState: 'CLOSED', CurrentDoorState: 'CLOSED', ObstructionDetected: false },
684
- door: { TargetPosition: 0, CurrentPosition: 0, PositionState: 'STOPPED' },
685
- window: { TargetPosition: 0, CurrentPosition: 0, PositionState: 'STOPPED' },
686
- windowcovering: { TargetPosition: 0, CurrentPosition: 0, PositionState: 'STOPPED' },
687
- lock: { LockTargetState: 'SECURED', LockCurrentState: 'SECURED' },
688
- faucet: { Active: 'INACTIVE' },
689
- fan: { On: false },
690
- stateful: { ProgrammableSwitchEvent: 'SINGLE_PRESS', ProgrammableSwitchOutputState: 0 },
691
- switch: { On: false },
692
- outlet: { On: false },
693
- }
694
-
695
- const service = this[this.relaySwitchDeviceType.charAt(0).toUpperCase() + this.relaySwitchDeviceType.slice(1)]?.Service
696
- if (service) {
697
- updateCharacteristics(service, characteristicsMap[this.relaySwitchDeviceType])
698
- }
699
- }
700
- }
701
-
702
- async apiError(e: any): Promise<void> {
703
- const updateCharacteristics = (service: Service, characteristics: { [key: string]: any }) => {
704
- for (const [characteristic] of Object.entries(characteristics)) {
705
- service.updateCharacteristic(this.hap.Characteristic[characteristic], e)
706
- }
707
- }
708
-
709
- const characteristicsMap: { [key: string]: { [key: string]: any } } = {
710
- garagedoor: { TargetDoorState: e, CurrentDoorState: e, ObstructionDetected: e },
711
- door: { TargetPosition: e, CurrentPosition: e, PositionState: e },
712
- window: { TargetPosition: e, CurrentPosition: e, PositionState: e },
713
- windowcovering: { TargetPosition: e, CurrentPosition: e, PositionState: e },
714
- lock: { LockTargetState: e, LockCurrentState: e },
715
- faucet: { Active: e },
716
- fan: { On: e },
717
- stateful: { ProgrammableSwitchEvent: e, ProgrammableSwitchOutputState: e },
718
- switch: { On: e },
719
- outlet: { On: e },
720
- }
721
-
722
- const service = this[this.relaySwitchDeviceType.charAt(0).toUpperCase() + this.relaySwitchDeviceType.slice(1)]?.Service
723
- if (service) {
724
- updateCharacteristics(service, characteristicsMap[this.relaySwitchDeviceType])
725
- }
726
- }
727
- }