@switchbot/homebridge-switchbot 5.0.0-beta.8 → 5.0.0-beta.81

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 (447) 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 +83 -14807
  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 +580 -246
  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 +286 -35
  25. package/dist/homebridge-ui/server.js.map +1 -1
  26. package/dist/index.d.ts.map +1 -1
  27. package/dist/index.js +4 -11
  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 +411 -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 +194 -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/eslint.config.js +2 -8
  53. package/package.json +21 -28
  54. package/scripts/e2e/README.md +25 -0
  55. package/scripts/e2e/curtain-e2e.sh +70 -0
  56. package/scripts/e2e/fan-e2e.sh +75 -0
  57. package/scripts/e2e/light-advanced-e2e.sh +97 -0
  58. package/scripts/e2e/light-e2e.sh +75 -0
  59. package/scripts/e2e/list-accessories.sh +19 -0
  60. package/scripts/e2e/lock-e2e.sh +65 -0
  61. package/scripts/generate-matter-maps.js +60 -0
  62. package/scripts/run-e2e-local.sh +14 -0
  63. package/src/deviceFactory.ts +122 -0
  64. package/src/devices/deviceBase.ts +141 -0
  65. package/src/devices/genericDevice.ts +965 -0
  66. package/src/homebridge-ui/public/index.html +580 -246
  67. package/src/homebridge-ui/server.ts +340 -40
  68. package/src/index.ts +4 -12
  69. package/src/platform.ts +407 -0
  70. package/src/settings.ts +12 -277
  71. package/src/switchbotClient.ts +203 -0
  72. package/src/utils.ts +45 -713
  73. package/test/accessory-restore.spec.ts +73 -0
  74. package/test/device-mapping.spec.ts +37 -0
  75. package/test/deviceFactory.spec.ts +18 -0
  76. package/test/e2e/run-e2e.spec.ts +50 -0
  77. package/test/fan-swing.spec.ts +29 -0
  78. package/test/helpers/matter-harness.ts +53 -0
  79. package/test/lock-users.spec.ts +44 -0
  80. package/test/matter-childbridge.spec.ts +55 -0
  81. package/test/matter-descriptors.spec.ts +97 -0
  82. package/test/matter-device-state.spec.ts +101 -0
  83. package/test/matter-integration.spec.ts +70 -0
  84. package/test/platform.integration.spec.ts +55 -0
  85. package/test/switchbot-client-debounce.spec.ts +131 -0
  86. package/test/switchbot-client-openapi.spec.ts +56 -0
  87. package/test/switchbotClient.spec.ts +10 -0
  88. package/test/utils.spec.ts +20 -0
  89. package/vitest.config.ts +7 -0
  90. package/coverage/base.css +0 -224
  91. package/coverage/block-navigation.js +0 -87
  92. package/coverage/clover.xml +0 -15847
  93. package/coverage/coverage-final.json +0 -42
  94. package/coverage/docs/assets/dmt/dmt-component-data.js.html +0 -85
  95. package/coverage/docs/assets/dmt/dmt-components.js.html +0 -286
  96. package/coverage/docs/assets/dmt/index.html +0 -131
  97. package/coverage/docs/assets/hierarchy.js.html +0 -85
  98. package/coverage/docs/assets/icons.js.html +0 -136
  99. package/coverage/docs/assets/index.html +0 -146
  100. package/coverage/docs/assets/main.js.html +0 -265
  101. package/coverage/favicon.png +0 -0
  102. package/coverage/index.html +0 -191
  103. package/coverage/prettify.css +0 -1
  104. package/coverage/prettify.js +0 -2
  105. package/coverage/sort-arrow-sprite.png +0 -0
  106. package/coverage/sorter.js +0 -196
  107. package/coverage/src/device/blindtilt.ts.html +0 -3238
  108. package/coverage/src/device/bot.ts.html +0 -2803
  109. package/coverage/src/device/ceilinglight.ts.html +0 -2338
  110. package/coverage/src/device/colorbulb.ts.html +0 -2824
  111. package/coverage/src/device/contact.ts.html +0 -1465
  112. package/coverage/src/device/curtain.ts.html +0 -2869
  113. package/coverage/src/device/device.ts.html +0 -2500
  114. package/coverage/src/device/fan.ts.html +0 -2242
  115. package/coverage/src/device/hub.ts.html +0 -1408
  116. package/coverage/src/device/humidifier.ts.html +0 -2116
  117. package/coverage/src/device/index.html +0 -416
  118. package/coverage/src/device/iosensor.ts.html +0 -1375
  119. package/coverage/src/device/lightstrip.ts.html +0 -2617
  120. package/coverage/src/device/lock.ts.html +0 -1963
  121. package/coverage/src/device/meter.ts.html +0 -1372
  122. package/coverage/src/device/meterplus.ts.html +0 -1384
  123. package/coverage/src/device/meterpro.ts.html +0 -1618
  124. package/coverage/src/device/motion.ts.html +0 -1264
  125. package/coverage/src/device/plug.ts.html +0 -1372
  126. package/coverage/src/device/relayswitch.ts.html +0 -2284
  127. package/coverage/src/device/robotvacuumcleaner.ts.html +0 -1810
  128. package/coverage/src/device/waterdetector.ts.html +0 -1294
  129. package/coverage/src/homebridge-ui/index.html +0 -116
  130. package/coverage/src/homebridge-ui/server.ts.html +0 -229
  131. package/coverage/src/index.html +0 -161
  132. package/coverage/src/index.ts.html +0 -124
  133. package/coverage/src/irdevice/airconditioner.ts.html +0 -1687
  134. package/coverage/src/irdevice/airpurifier.ts.html +0 -844
  135. package/coverage/src/irdevice/camera.ts.html +0 -475
  136. package/coverage/src/irdevice/fan.ts.html +0 -766
  137. package/coverage/src/irdevice/index.html +0 -251
  138. package/coverage/src/irdevice/irdevice.ts.html +0 -1117
  139. package/coverage/src/irdevice/light.ts.html +0 -826
  140. package/coverage/src/irdevice/other.ts.html +0 -2458
  141. package/coverage/src/irdevice/tv.ts.html +0 -1222
  142. package/coverage/src/irdevice/vacuumcleaner.ts.html +0 -466
  143. package/coverage/src/irdevice/waterheater.ts.html +0 -469
  144. package/coverage/src/platform.ts.html +0 -8776
  145. package/coverage/src/settings.ts.html +0 -934
  146. package/coverage/src/utils.ts.html +0 -2092
  147. package/dist/devices-hap/airpurifier.d.ts +0 -54
  148. package/dist/devices-hap/airpurifier.d.ts.map +0 -1
  149. package/dist/devices-hap/airpurifier.js +0 -527
  150. package/dist/devices-hap/airpurifier.js.map +0 -1
  151. package/dist/devices-hap/blindtilt.d.ts +0 -90
  152. package/dist/devices-hap/blindtilt.d.ts.map +0 -1
  153. package/dist/devices-hap/blindtilt.js +0 -974
  154. package/dist/devices-hap/blindtilt.js.map +0 -1
  155. package/dist/devices-hap/bot.d.ts +0 -102
  156. package/dist/devices-hap/bot.d.ts.map +0 -1
  157. package/dist/devices-hap/bot.js +0 -811
  158. package/dist/devices-hap/bot.js.map +0 -1
  159. package/dist/devices-hap/ceilinglight.d.ts +0 -85
  160. package/dist/devices-hap/ceilinglight.d.ts.map +0 -1
  161. package/dist/devices-hap/ceilinglight.js +0 -701
  162. package/dist/devices-hap/ceilinglight.js.map +0 -1
  163. package/dist/devices-hap/colorbulb.d.ts +0 -88
  164. package/dist/devices-hap/colorbulb.d.ts.map +0 -1
  165. package/dist/devices-hap/colorbulb.js +0 -881
  166. package/dist/devices-hap/colorbulb.js.map +0 -1
  167. package/dist/devices-hap/contact.d.ts +0 -44
  168. package/dist/devices-hap/contact.d.ts.map +0 -1
  169. package/dist/devices-hap/contact.js +0 -409
  170. package/dist/devices-hap/contact.js.map +0 -1
  171. package/dist/devices-hap/curtain.d.ts +0 -73
  172. package/dist/devices-hap/curtain.d.ts.map +0 -1
  173. package/dist/devices-hap/curtain.js +0 -869
  174. package/dist/devices-hap/curtain.js.map +0 -1
  175. package/dist/devices-hap/device.d.ts +0 -98
  176. package/dist/devices-hap/device.d.ts.map +0 -1
  177. package/dist/devices-hap/device.js +0 -749
  178. package/dist/devices-hap/device.js.map +0 -1
  179. package/dist/devices-hap/fan.d.ts +0 -69
  180. package/dist/devices-hap/fan.d.ts.map +0 -1
  181. package/dist/devices-hap/fan.js +0 -649
  182. package/dist/devices-hap/fan.js.map +0 -1
  183. package/dist/devices-hap/hub.d.ts +0 -37
  184. package/dist/devices-hap/hub.d.ts.map +0 -1
  185. package/dist/devices-hap/hub.js +0 -392
  186. package/dist/devices-hap/hub.js.map +0 -1
  187. package/dist/devices-hap/humidifier.d.ts +0 -68
  188. package/dist/devices-hap/humidifier.d.ts.map +0 -1
  189. package/dist/devices-hap/humidifier.js +0 -628
  190. package/dist/devices-hap/humidifier.js.map +0 -1
  191. package/dist/devices-hap/iosensor.d.ts +0 -42
  192. package/dist/devices-hap/iosensor.d.ts.map +0 -1
  193. package/dist/devices-hap/iosensor.js +0 -382
  194. package/dist/devices-hap/iosensor.js.map +0 -1
  195. package/dist/devices-hap/lightstrip.d.ts +0 -79
  196. package/dist/devices-hap/lightstrip.d.ts.map +0 -1
  197. package/dist/devices-hap/lightstrip.js +0 -797
  198. package/dist/devices-hap/lightstrip.js.map +0 -1
  199. package/dist/devices-hap/lock.d.ts +0 -53
  200. package/dist/devices-hap/lock.d.ts.map +0 -1
  201. package/dist/devices-hap/lock.js +0 -561
  202. package/dist/devices-hap/lock.js.map +0 -1
  203. package/dist/devices-hap/meter.d.ts +0 -37
  204. package/dist/devices-hap/meter.d.ts.map +0 -1
  205. package/dist/devices-hap/meter.js +0 -379
  206. package/dist/devices-hap/meter.js.map +0 -1
  207. package/dist/devices-hap/meterplus.d.ts +0 -42
  208. package/dist/devices-hap/meterplus.d.ts.map +0 -1
  209. package/dist/devices-hap/meterplus.js +0 -384
  210. package/dist/devices-hap/meterplus.js.map +0 -1
  211. package/dist/devices-hap/meterpro.d.ts +0 -43
  212. package/dist/devices-hap/meterpro.d.ts.map +0 -1
  213. package/dist/devices-hap/meterpro.js +0 -468
  214. package/dist/devices-hap/meterpro.js.map +0 -1
  215. package/dist/devices-hap/motion.d.ts +0 -42
  216. package/dist/devices-hap/motion.d.ts.map +0 -1
  217. package/dist/devices-hap/motion.js +0 -345
  218. package/dist/devices-hap/motion.js.map +0 -1
  219. package/dist/devices-hap/plug.d.ts +0 -49
  220. package/dist/devices-hap/plug.d.ts.map +0 -1
  221. package/dist/devices-hap/plug.js +0 -395
  222. package/dist/devices-hap/plug.js.map +0 -1
  223. package/dist/devices-hap/relayswitch.d.ts +0 -96
  224. package/dist/devices-hap/relayswitch.d.ts.map +0 -1
  225. package/dist/devices-hap/relayswitch.js +0 -642
  226. package/dist/devices-hap/relayswitch.js.map +0 -1
  227. package/dist/devices-hap/robotvacuumcleaner.d.ts +0 -54
  228. package/dist/devices-hap/robotvacuumcleaner.d.ts.map +0 -1
  229. package/dist/devices-hap/robotvacuumcleaner.js +0 -523
  230. package/dist/devices-hap/robotvacuumcleaner.js.map +0 -1
  231. package/dist/devices-hap/waterdetector.d.ts +0 -41
  232. package/dist/devices-hap/waterdetector.d.ts.map +0 -1
  233. package/dist/devices-hap/waterdetector.js +0 -356
  234. package/dist/devices-hap/waterdetector.js.map +0 -1
  235. package/dist/devices-matter/BaseMatterAccessory.d.ts +0 -63
  236. package/dist/devices-matter/BaseMatterAccessory.d.ts.map +0 -1
  237. package/dist/devices-matter/BaseMatterAccessory.js +0 -100
  238. package/dist/devices-matter/BaseMatterAccessory.js.map +0 -1
  239. package/dist/devices-matter/ColorLightAccessory.d.ts +0 -20
  240. package/dist/devices-matter/ColorLightAccessory.d.ts.map +0 -1
  241. package/dist/devices-matter/ColorLightAccessory.js +0 -95
  242. package/dist/devices-matter/ColorLightAccessory.js.map +0 -1
  243. package/dist/devices-matter/ColorTemperatureLightAccessory.d.ts +0 -18
  244. package/dist/devices-matter/ColorTemperatureLightAccessory.d.ts.map +0 -1
  245. package/dist/devices-matter/ColorTemperatureLightAccessory.js +0 -78
  246. package/dist/devices-matter/ColorTemperatureLightAccessory.js.map +0 -1
  247. package/dist/devices-matter/ContactSensorAccessory.d.ts +0 -12
  248. package/dist/devices-matter/ContactSensorAccessory.d.ts.map +0 -1
  249. package/dist/devices-matter/ContactSensorAccessory.js +0 -34
  250. package/dist/devices-matter/ContactSensorAccessory.js.map +0 -1
  251. package/dist/devices-matter/DimmableLightAccessory.d.ts +0 -58
  252. package/dist/devices-matter/DimmableLightAccessory.d.ts.map +0 -1
  253. package/dist/devices-matter/DimmableLightAccessory.js +0 -167
  254. package/dist/devices-matter/DimmableLightAccessory.js.map +0 -1
  255. package/dist/devices-matter/DoorLockAccessory.d.ts +0 -14
  256. package/dist/devices-matter/DoorLockAccessory.d.ts.map +0 -1
  257. package/dist/devices-matter/DoorLockAccessory.js +0 -50
  258. package/dist/devices-matter/DoorLockAccessory.js.map +0 -1
  259. package/dist/devices-matter/ExtendedColorLightAccessory.d.ts +0 -21
  260. package/dist/devices-matter/ExtendedColorLightAccessory.d.ts.map +0 -1
  261. package/dist/devices-matter/ExtendedColorLightAccessory.js +0 -107
  262. package/dist/devices-matter/ExtendedColorLightAccessory.js.map +0 -1
  263. package/dist/devices-matter/FanAccessory.d.ts +0 -16
  264. package/dist/devices-matter/FanAccessory.d.ts.map +0 -1
  265. package/dist/devices-matter/FanAccessory.js +0 -81
  266. package/dist/devices-matter/FanAccessory.js.map +0 -1
  267. package/dist/devices-matter/HumiditySensorAccessory.d.ts +0 -12
  268. package/dist/devices-matter/HumiditySensorAccessory.d.ts.map +0 -1
  269. package/dist/devices-matter/HumiditySensorAccessory.js +0 -34
  270. package/dist/devices-matter/HumiditySensorAccessory.js.map +0 -1
  271. package/dist/devices-matter/LeakSensorAccessory.d.ts +0 -12
  272. package/dist/devices-matter/LeakSensorAccessory.d.ts.map +0 -1
  273. package/dist/devices-matter/LeakSensorAccessory.js +0 -33
  274. package/dist/devices-matter/LeakSensorAccessory.js.map +0 -1
  275. package/dist/devices-matter/LightSensorAccessory.d.ts +0 -12
  276. package/dist/devices-matter/LightSensorAccessory.d.ts.map +0 -1
  277. package/dist/devices-matter/LightSensorAccessory.js +0 -34
  278. package/dist/devices-matter/LightSensorAccessory.js.map +0 -1
  279. package/dist/devices-matter/OccupancySensorAccessory.d.ts +0 -12
  280. package/dist/devices-matter/OccupancySensorAccessory.d.ts.map +0 -1
  281. package/dist/devices-matter/OccupancySensorAccessory.js +0 -39
  282. package/dist/devices-matter/OccupancySensorAccessory.js.map +0 -1
  283. package/dist/devices-matter/OnOffLightAccessory.d.ts +0 -38
  284. package/dist/devices-matter/OnOffLightAccessory.d.ts.map +0 -1
  285. package/dist/devices-matter/OnOffLightAccessory.js +0 -118
  286. package/dist/devices-matter/OnOffLightAccessory.js.map +0 -1
  287. package/dist/devices-matter/OnOffOutletAccessory.d.ts +0 -12
  288. package/dist/devices-matter/OnOffOutletAccessory.d.ts.map +0 -1
  289. package/dist/devices-matter/OnOffOutletAccessory.js +0 -40
  290. package/dist/devices-matter/OnOffOutletAccessory.js.map +0 -1
  291. package/dist/devices-matter/OnOffSwitchAccessory.d.ts +0 -14
  292. package/dist/devices-matter/OnOffSwitchAccessory.d.ts.map +0 -1
  293. package/dist/devices-matter/OnOffSwitchAccessory.js +0 -42
  294. package/dist/devices-matter/OnOffSwitchAccessory.js.map +0 -1
  295. package/dist/devices-matter/RoboticVacuumAccessory.d.ts +0 -68
  296. package/dist/devices-matter/RoboticVacuumAccessory.d.ts.map +0 -1
  297. package/dist/devices-matter/RoboticVacuumAccessory.js +0 -334
  298. package/dist/devices-matter/RoboticVacuumAccessory.js.map +0 -1
  299. package/dist/devices-matter/SmokeCOAlarmAccessory.d.ts +0 -11
  300. package/dist/devices-matter/SmokeCOAlarmAccessory.d.ts.map +0 -1
  301. package/dist/devices-matter/SmokeCOAlarmAccessory.js +0 -49
  302. package/dist/devices-matter/SmokeCOAlarmAccessory.js.map +0 -1
  303. package/dist/devices-matter/TemperatureSensorAccessory.d.ts +0 -12
  304. package/dist/devices-matter/TemperatureSensorAccessory.d.ts.map +0 -1
  305. package/dist/devices-matter/TemperatureSensorAccessory.js +0 -36
  306. package/dist/devices-matter/TemperatureSensorAccessory.js.map +0 -1
  307. package/dist/devices-matter/ThermostatAccessory.d.ts +0 -19
  308. package/dist/devices-matter/ThermostatAccessory.d.ts.map +0 -1
  309. package/dist/devices-matter/ThermostatAccessory.js +0 -95
  310. package/dist/devices-matter/ThermostatAccessory.js.map +0 -1
  311. package/dist/devices-matter/VenetianBlindAccessory.d.ts +0 -19
  312. package/dist/devices-matter/VenetianBlindAccessory.d.ts.map +0 -1
  313. package/dist/devices-matter/VenetianBlindAccessory.js +0 -99
  314. package/dist/devices-matter/VenetianBlindAccessory.js.map +0 -1
  315. package/dist/devices-matter/WindowBlindAccessory.d.ts +0 -17
  316. package/dist/devices-matter/WindowBlindAccessory.d.ts.map +0 -1
  317. package/dist/devices-matter/WindowBlindAccessory.js +0 -80
  318. package/dist/devices-matter/WindowBlindAccessory.js.map +0 -1
  319. package/dist/devices-matter/custom/PowerStripAccessory.d.ts +0 -97
  320. package/dist/devices-matter/custom/PowerStripAccessory.d.ts.map +0 -1
  321. package/dist/devices-matter/custom/PowerStripAccessory.js +0 -265
  322. package/dist/devices-matter/custom/PowerStripAccessory.js.map +0 -1
  323. package/dist/devices-matter/custom/index.d.ts +0 -8
  324. package/dist/devices-matter/custom/index.d.ts.map +0 -1
  325. package/dist/devices-matter/custom/index.js +0 -8
  326. package/dist/devices-matter/custom/index.js.map +0 -1
  327. package/dist/devices-matter/index.d.ts +0 -29
  328. package/dist/devices-matter/index.d.ts.map +0 -1
  329. package/dist/devices-matter/index.js +0 -28
  330. package/dist/devices-matter/index.js.map +0 -1
  331. package/dist/index.test.d.ts +0 -2
  332. package/dist/index.test.d.ts.map +0 -1
  333. package/dist/index.test.js +0 -14
  334. package/dist/index.test.js.map +0 -1
  335. package/dist/irdevice/airconditioner.d.ts +0 -61
  336. package/dist/irdevice/airconditioner.d.ts.map +0 -1
  337. package/dist/irdevice/airconditioner.js +0 -472
  338. package/dist/irdevice/airconditioner.js.map +0 -1
  339. package/dist/irdevice/airpurifier.d.ts +0 -50
  340. package/dist/irdevice/airpurifier.d.ts.map +0 -1
  341. package/dist/irdevice/airpurifier.js +0 -213
  342. package/dist/irdevice/airpurifier.js.map +0 -1
  343. package/dist/irdevice/camera.d.ts +0 -32
  344. package/dist/irdevice/camera.d.ts.map +0 -1
  345. package/dist/irdevice/camera.js +0 -107
  346. package/dist/irdevice/camera.js.map +0 -1
  347. package/dist/irdevice/fan.d.ts +0 -36
  348. package/dist/irdevice/fan.d.ts.map +0 -1
  349. package/dist/irdevice/fan.js +0 -200
  350. package/dist/irdevice/fan.js.map +0 -1
  351. package/dist/irdevice/irdevice.d.ts +0 -68
  352. package/dist/irdevice/irdevice.d.ts.map +0 -1
  353. package/dist/irdevice/irdevice.js +0 -298
  354. package/dist/irdevice/irdevice.js.map +0 -1
  355. package/dist/irdevice/light.d.ts +0 -36
  356. package/dist/irdevice/light.d.ts.map +0 -1
  357. package/dist/irdevice/light.js +0 -206
  358. package/dist/irdevice/light.js.map +0 -1
  359. package/dist/irdevice/other.d.ts +0 -57
  360. package/dist/irdevice/other.d.ts.map +0 -1
  361. package/dist/irdevice/other.js +0 -778
  362. package/dist/irdevice/other.js.map +0 -1
  363. package/dist/irdevice/tv.d.ts +0 -45
  364. package/dist/irdevice/tv.d.ts.map +0 -1
  365. package/dist/irdevice/tv.js +0 -327
  366. package/dist/irdevice/tv.js.map +0 -1
  367. package/dist/irdevice/vacuumcleaner.d.ts +0 -28
  368. package/dist/irdevice/vacuumcleaner.d.ts.map +0 -1
  369. package/dist/irdevice/vacuumcleaner.js +0 -104
  370. package/dist/irdevice/vacuumcleaner.js.map +0 -1
  371. package/dist/irdevice/waterheater.d.ts +0 -30
  372. package/dist/irdevice/waterheater.d.ts.map +0 -1
  373. package/dist/irdevice/waterheater.js +0 -105
  374. package/dist/irdevice/waterheater.js.map +0 -1
  375. package/dist/platform-hap.d.ts +0 -149
  376. package/dist/platform-hap.d.ts.map +0 -1
  377. package/dist/platform-hap.js +0 -2861
  378. package/dist/platform-hap.js.map +0 -1
  379. package/dist/platform-matter.d.ts +0 -120
  380. package/dist/platform-matter.d.ts.map +0 -1
  381. package/dist/platform-matter.js +0 -966
  382. package/dist/platform-matter.js.map +0 -1
  383. package/dist/verifyconfig.test.d.ts +0 -2
  384. package/dist/verifyconfig.test.d.ts.map +0 -1
  385. package/dist/verifyconfig.test.js +0 -167
  386. package/dist/verifyconfig.test.js.map +0 -1
  387. package/src/custom.d.ts +0 -7
  388. package/src/devices-hap/airpurifier.ts +0 -563
  389. package/src/devices-hap/blindtilt.ts +0 -1049
  390. package/src/devices-hap/bot.ts +0 -900
  391. package/src/devices-hap/ceilinglight.ts +0 -742
  392. package/src/devices-hap/colorbulb.ts +0 -904
  393. package/src/devices-hap/contact.ts +0 -457
  394. package/src/devices-hap/curtain.ts +0 -944
  395. package/src/devices-hap/device.ts +0 -811
  396. package/src/devices-hap/fan.ts +0 -711
  397. package/src/devices-hap/hub.ts +0 -439
  398. package/src/devices-hap/humidifier.ts +0 -669
  399. package/src/devices-hap/iosensor.ts +0 -427
  400. package/src/devices-hap/lightstrip.ts +0 -836
  401. package/src/devices-hap/lock.ts +0 -620
  402. package/src/devices-hap/meter.ts +0 -426
  403. package/src/devices-hap/meterplus.ts +0 -430
  404. package/src/devices-hap/meterpro.ts +0 -522
  405. package/src/devices-hap/motion.ts +0 -390
  406. package/src/devices-hap/plug.ts +0 -423
  407. package/src/devices-hap/relayswitch.ts +0 -727
  408. package/src/devices-hap/robotvacuumcleaner.ts +0 -568
  409. package/src/devices-hap/waterdetector.ts +0 -400
  410. package/src/devices-matter/BaseMatterAccessory.ts +0 -131
  411. package/src/devices-matter/ColorLightAccessory.ts +0 -110
  412. package/src/devices-matter/ColorTemperatureLightAccessory.ts +0 -92
  413. package/src/devices-matter/ContactSensorAccessory.ts +0 -41
  414. package/src/devices-matter/DimmableLightAccessory.ts +0 -192
  415. package/src/devices-matter/DoorLockAccessory.ts +0 -60
  416. package/src/devices-matter/ExtendedColorLightAccessory.ts +0 -123
  417. package/src/devices-matter/FanAccessory.ts +0 -95
  418. package/src/devices-matter/HumiditySensorAccessory.ts +0 -41
  419. package/src/devices-matter/LeakSensorAccessory.ts +0 -40
  420. package/src/devices-matter/LightSensorAccessory.ts +0 -41
  421. package/src/devices-matter/OccupancySensorAccessory.ts +0 -48
  422. package/src/devices-matter/OnOffLightAccessory.ts +0 -133
  423. package/src/devices-matter/OnOffOutletAccessory.ts +0 -46
  424. package/src/devices-matter/OnOffSwitchAccessory.ts +0 -51
  425. package/src/devices-matter/RoboticVacuumAccessory.ts +0 -407
  426. package/src/devices-matter/SmokeCOAlarmAccessory.ts +0 -59
  427. package/src/devices-matter/TemperatureSensorAccessory.ts +0 -43
  428. package/src/devices-matter/ThermostatAccessory.ts +0 -110
  429. package/src/devices-matter/VenetianBlindAccessory.ts +0 -115
  430. package/src/devices-matter/WindowBlindAccessory.ts +0 -92
  431. package/src/devices-matter/custom/PowerStripAccessory.ts +0 -309
  432. package/src/devices-matter/custom/index.ts +0 -8
  433. package/src/devices-matter/index.ts +0 -29
  434. package/src/index.test.ts +0 -19
  435. package/src/irdevice/airconditioner.ts +0 -533
  436. package/src/irdevice/airpurifier.ts +0 -252
  437. package/src/irdevice/camera.ts +0 -129
  438. package/src/irdevice/fan.ts +0 -226
  439. package/src/irdevice/irdevice.ts +0 -344
  440. package/src/irdevice/light.ts +0 -246
  441. package/src/irdevice/other.ts +0 -790
  442. package/src/irdevice/tv.ts +0 -378
  443. package/src/irdevice/vacuumcleaner.ts +0 -126
  444. package/src/irdevice/waterheater.ts +0 -127
  445. package/src/platform-hap.ts +0 -2997
  446. package/src/platform-matter.ts +0 -1092
  447. package/src/verifyconfig.test.ts +0 -197
@@ -1,749 +0,0 @@
1
- /* Copyright(C) 2021-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
2
- *
3
- * device.ts: @switchbot/homebridge-switchbot.
4
- */
5
- import { hostname } from 'node:os';
6
- import { SwitchBotBLEModel, SwitchBotBLEModelFriendlyName, SwitchBotBLEModelName, SwitchBotModel } from 'node-switchbot';
7
- import { formatDeviceIdAsMac, safeStringify, sleep } from '../utils.js';
8
- export class deviceBase {
9
- platform;
10
- accessory;
11
- device;
12
- api;
13
- log;
14
- config;
15
- hap;
16
- // Config
17
- deviceLogging;
18
- deviceRefreshRate;
19
- deviceUpdateRate;
20
- devicePushRate;
21
- deviceMaxRetries;
22
- deviceDelayBetweenRetries;
23
- // Connection
24
- BLE;
25
- OpenAPI;
26
- // Accsrroy Information
27
- deviceModel;
28
- deviceBLEModel;
29
- // MQTT
30
- deviceMqttURL;
31
- deviceMqttOptions;
32
- deviceMqttPubOptions;
33
- // BLE
34
- scanDuration;
35
- // EVE history service handler
36
- historyService = null;
37
- // MQTT stuff
38
- mqttClient = null;
39
- constructor(platform, accessory, device) {
40
- this.platform = platform;
41
- this.accessory = accessory;
42
- this.device = device;
43
- this.api = this.platform.api;
44
- this.log = this.platform.log;
45
- this.config = this.platform.config;
46
- this.hap = this.api.hap;
47
- // Connection
48
- this.BLE = this.device.connectionType === 'BLE' || this.device.connectionType === 'BLE/OpenAPI';
49
- this.OpenAPI = this.device.connectionType === 'OpenAPI' || this.device.connectionType === 'BLE/OpenAPI';
50
- this.getDeviceLogSettings(device);
51
- this.getDeviceRateSettings(device);
52
- this.getDeviceConfigSettings(device);
53
- this.getDeviceContext(accessory, device);
54
- this.getMqttSettings(device);
55
- // Set accessory information
56
- accessory
57
- .getService(this.hap.Service.AccessoryInformation)
58
- .setCharacteristic(this.hap.Characteristic.Manufacturer, 'SwitchBot')
59
- .setCharacteristic(this.hap.Characteristic.AppMatchingIdentifier, 'id1087374760')
60
- .setCharacteristic(this.hap.Characteristic.Name, accessory.displayName)
61
- .setCharacteristic(this.hap.Characteristic.ConfiguredName, accessory.displayName)
62
- .setCharacteristic(this.hap.Characteristic.Model, device.model)
63
- .setCharacteristic(this.hap.Characteristic.ProductData, device.deviceId)
64
- .setCharacteristic(this.hap.Characteristic.SerialNumber, device.deviceId);
65
- }
66
- async getDeviceLogSettings(device) {
67
- this.deviceLogging = this.platform.debugMode ? 'debugMode' : device.logging ?? this.platform.platformLogging ?? 'standard';
68
- const logging = this.platform.debugMode ? 'Debug Mode' : device.logging ? 'Device Config' : this.platform.platformLogging ? 'Platform Config' : 'Default';
69
- this.debugLog(`Using ${logging} Logging: ${this.deviceLogging}`);
70
- }
71
- async getDeviceRateSettings(device) {
72
- // refreshRate
73
- this.deviceRefreshRate = device.refreshRate ?? this.platform.platformRefreshRate ?? 300;
74
- const refreshRate = device.refreshRate ? 'Device Config' : this.platform.platformRefreshRate ? 'Platform Config' : 'Default';
75
- this.accessory.context.refreshRate = this.deviceRefreshRate;
76
- // updateRate
77
- this.deviceUpdateRate = device.updateRate ?? this.platform.platformUpdateRate ?? 5;
78
- const updateRate = device.updateRate ? 'Device Config' : this.platform.platformUpdateRate ? 'Platform Config' : 'Default';
79
- this.accessory.context.updateRate = this.deviceUpdateRate;
80
- // pushRate
81
- this.devicePushRate = device.pushRate ?? this.platform.platformPushRate ?? 0.1;
82
- const pushRate = device.pushRate ? 'Device Config' : this.platform.platformPushRate ? 'Platform Config' : 'Default';
83
- this.accessory.context.pushRate = this.devicePushRate;
84
- this.debugLog(`Using ${refreshRate} refreshRate: ${this.deviceRefreshRate}, ${updateRate} updateRate: ${this.deviceUpdateRate}, ${pushRate} pushRate: ${this.devicePushRate}`);
85
- // maxRetries
86
- this.deviceMaxRetries = device.maxRetries ?? this.platform.platformMaxRetries ?? 2;
87
- const maxRetries = device.maxRetries ? 'Device' : this.platform.platformMaxRetries ? 'Platform' : 'Default';
88
- this.debugLog(`Using ${maxRetries} Max Retries: ${this.deviceMaxRetries}`);
89
- // delayBetweenRetries
90
- this.deviceDelayBetweenRetries = device.delayBetweenRetries ? (device.delayBetweenRetries * 1000) : this.platform.platformDelayBetweenRetries ?? 3000;
91
- const delayBetweenRetries = device.delayBetweenRetries ? 'Device' : this.platform.platformDelayBetweenRetries ? 'Platform' : 'Default';
92
- this.debugLog(`Using ${delayBetweenRetries} Delay Between Retries: ${this.deviceDelayBetweenRetries}`);
93
- // scanDuration
94
- this.scanDuration = Math.max(device.scanDuration ?? 1, this.deviceUpdateRate > 1 ? this.deviceUpdateRate : 1);
95
- if (this.BLE) {
96
- this.debugLog(`Using ${device.scanDuration ? 'Device Config' : 'Default'} scanDuration: ${this.scanDuration}`);
97
- if (device.scanDuration && this.deviceUpdateRate > device.scanDuration) {
98
- this.warnLog('scanDuration is less than updateRate, overriding scanDuration with updateRate');
99
- }
100
- }
101
- }
102
- async retryBLE({ max, fn }) {
103
- return fn().catch(async (e) => {
104
- if (max === 0) {
105
- throw e;
106
- }
107
- this.warnLog(e);
108
- this.infoLog('Retrying');
109
- await sleep(1000);
110
- return this.retryBLE({ max: max - 1, fn });
111
- });
112
- }
113
- maxRetryBLE() {
114
- return this.device.maxRetry !== undefined ? this.device.maxRetry : 5;
115
- }
116
- async getDeviceConfigSettings(device) {
117
- const deviceConfig = Object.assign({}, device.logging !== 'standard' && { logging: device.logging }, device.refreshRate !== 0 && { refreshRate: device.refreshRate }, device.updateRate !== 0 && { updateRate: device.updateRate }, device.scanDuration !== 0 && { scanDuration: device.scanDuration }, device.offline === true && { offline: device.offline }, device.maxRetry !== 0 && { maxRetry: device.maxRetry }, device.webhook === true && { webhook: device.webhook }, device.connectionType !== '' && { connectionType: device.connectionType }, device.disablePlatformBLE !== false && { disablePlatformBLE: device.disablePlatformBLE }, device.external === true && { external: device.external }, device.mqttURL !== '' && { mqttURL: device.mqttURL }, device.mqttOptions && { mqttOptions: device.mqttOptions }, device.mqttPubOptions && { mqttPubOptions: device.mqttPubOptions }, device.maxRetries !== 0 && { maxRetries: device.maxRetries }, device.delayBetweenRetries !== 0 && { delayBetweenRetries: device.delayBetweenRetries });
118
- let deviceSpecificConfig = {};
119
- switch (device.configDeviceType) {
120
- case 'Bot':
121
- deviceSpecificConfig = device;
122
- break;
123
- case 'Relay Switch 1':
124
- deviceSpecificConfig = device;
125
- break;
126
- case 'Relay Switch 1PM':
127
- deviceSpecificConfig = device;
128
- break;
129
- case 'Meter':
130
- case 'MeterPlus':
131
- deviceSpecificConfig = device;
132
- break;
133
- case 'WoIOSensor':
134
- deviceSpecificConfig = device;
135
- break;
136
- case 'Humidifier':
137
- case 'Humidifier2':
138
- deviceSpecificConfig = device;
139
- break;
140
- case 'Curtain':
141
- case 'Curtain3':
142
- deviceSpecificConfig = device;
143
- break;
144
- case 'Blind Tilt':
145
- deviceSpecificConfig = device;
146
- break;
147
- case 'Contact Sensor':
148
- deviceSpecificConfig = device;
149
- break;
150
- case 'Motion Sensor':
151
- deviceSpecificConfig = device;
152
- break;
153
- case 'Water Detector':
154
- deviceSpecificConfig = device;
155
- break;
156
- case 'Plug':
157
- case 'Plug Mini (US)':
158
- case 'Plug Mini (JP)':
159
- deviceSpecificConfig = device;
160
- break;
161
- case 'Color Bulb':
162
- deviceSpecificConfig = device;
163
- break;
164
- case 'Strip Light':
165
- deviceSpecificConfig = device;
166
- break;
167
- case 'Ceiling Light':
168
- case 'Ceiling Light Pro':
169
- deviceSpecificConfig = device;
170
- break;
171
- case 'Smart Lock':
172
- case 'Smart Lock Pro':
173
- deviceSpecificConfig = device;
174
- break;
175
- case 'Hub 2':
176
- deviceSpecificConfig = device;
177
- break;
178
- default:
179
- }
180
- const config = Object.assign({}, deviceConfig, deviceSpecificConfig);
181
- if (Object.keys(config).length !== 0) {
182
- this.debugSuccessLog(`Config: ${JSON.stringify(config)}`);
183
- }
184
- }
185
- /**
186
- * Get the current ambient light level based on the light level, set_minLux, set_maxLux, and spaceBetweenLevels.
187
- * @param lightLevel number
188
- * @param set_minLux number
189
- * @param set_maxLux number
190
- * @param spaceBetweenLevels number
191
- * @returns CurrentAmbientLightLevel
192
- */
193
- getLightLevel(lightLevel, set_minLux, set_maxLux, spaceBetweenLevels) {
194
- const numberOfLevels = spaceBetweenLevels + 1;
195
- this.debugLog(`LightLevel: ${lightLevel}, set_minLux: ${set_minLux}, set_maxLux: ${set_maxLux}, spaceBetweenLevels: ${spaceBetweenLevels}, numberOfLevels: ${numberOfLevels}`);
196
- const CurrentAmbientLightLevel = lightLevel === 1
197
- ? set_minLux
198
- : lightLevel === numberOfLevels
199
- ? set_maxLux
200
- : ((set_maxLux - set_minLux) / spaceBetweenLevels) * (Number(lightLevel) - 1);
201
- this.debugLog(`CurrentAmbientLightLevel: ${CurrentAmbientLightLevel}, LightLevel: ${lightLevel}, set_minLux: ${set_minLux}, set_maxLux: ${set_maxLux}`);
202
- return CurrentAmbientLightLevel;
203
- }
204
- /*
205
- * Publish MQTT message for topics of
206
- * 'homebridge-switchbot/${this.device.deviceType}/xx:xx:xx:xx:xx:xx'
207
- */
208
- async mqttPublish(message, topic) {
209
- const mac = this.device.deviceId?.toLowerCase().match(/[\s\S]{1,2}/g)?.join(':');
210
- const options = this.deviceMqttPubOptions ?? {};
211
- const mqttTopic = topic ? `/${topic}` : '';
212
- const mqttMessageTopic = topic ? `${topic}/` : '';
213
- this.mqttClient?.publish(`homebridge-switchbot/${this.device.deviceType}/${mac}${mqttTopic}`, `${message}`, options);
214
- this.debugLog(`MQTT message: ${mqttMessageTopic}${message} options:${JSON.stringify(options)}`);
215
- }
216
- /*
217
- * MQTT Settings
218
- */
219
- async getMqttSettings(device) {
220
- // mqttURL
221
- this.deviceMqttURL = device.mqttURL ?? this.config.options?.mqttURL ?? '';
222
- const mqttURL = device.mqttURL ? 'Device Config' : this.config.options?.mqttURL ? 'Platform Config' : 'Default';
223
- // mqttOptions
224
- this.deviceMqttOptions = device.mqttOptions ?? this.config.options?.mqttOptions ?? {};
225
- const mqttOptions = device.mqttOptions ? 'Device Config' : this.config.options?.mqttOptions ? 'Platform Config' : 'Default';
226
- // mqttPubOptions
227
- this.deviceMqttPubOptions = device.mqttPubOptions ?? this.config.options?.mqttPubOptions ?? {};
228
- const mqttPubOptions = device.mqttPubOptions ? 'Device Config' : this.config.options?.mqttPubOptions ? 'Platform Config' : 'Default';
229
- this.debugLog(`Using ${mqttURL} MQTT URL: ${this.deviceMqttURL}, ${mqttOptions} mqttOptions: ${JSON.stringify(this.deviceMqttOptions)}, ${mqttPubOptions} mqttPubOptions: ${JSON.stringify(this.deviceMqttPubOptions)}`);
230
- }
231
- /*
232
- * Setup EVE history graph feature if enabled.
233
- */
234
- async setupHistoryService(accessory, device) {
235
- try {
236
- const formattedDeviceId = formatDeviceIdAsMac(this.device.deviceId);
237
- this.device.bleMac = formattedDeviceId;
238
- this.debugLog(`bleMac: ${this.device.bleMac}`);
239
- this.historyService = device.history
240
- ? new this.platform.fakegatoAPI('room', accessory, {
241
- log: this.platform.log,
242
- storage: 'fs',
243
- filename: `${hostname().split('.')[0]}_${this.device.bleMac}_persist.json`,
244
- })
245
- : null;
246
- }
247
- catch (error) {
248
- this.errorLog(`failed to format device ID as MAC, Error: ${error}`);
249
- }
250
- }
251
- async switchbotBLE() {
252
- const switchBotBLE = await this.platform.connectBLE(this.accessory, this.device);
253
- // Convert to BLE Address
254
- try {
255
- const formattedDeviceId = formatDeviceIdAsMac(this.device.deviceId);
256
- this.device.bleMac = formattedDeviceId;
257
- await this.getCustomBLEAddress(switchBotBLE);
258
- this.debugLog(`bleMac: ${this.device.bleMac}`);
259
- return switchBotBLE;
260
- }
261
- catch (error) {
262
- this.errorLog(`failed to format device ID as MAC, Error: ${error}`);
263
- }
264
- }
265
- async monitorAdvertisementPackets(switchbot) {
266
- this.debugLog(`Scanning for deviceID: ${this.device.bleMac} Model: ${this.device.bleModel} ModelName: ${this.device.bleModelName}...`);
267
- try {
268
- await switchbot.startScan({ model: this.device.bleModel, id: this.device.bleMac });
269
- }
270
- catch (e) {
271
- this.errorLog(`Failed to start BLE scanning. Error: ${e.message ?? e}`);
272
- }
273
- // Set an event handler
274
- let serviceData = { model: this.device.bleModel, modelName: this.device.bleModelName };
275
- switchbot.onadvertisement = (ad) => {
276
- if (ad.address === this.device.bleMac && ad.serviceData.model === this.device.bleModel) {
277
- this.debugLog(`ad: ${safeStringify(ad)}`);
278
- this.debugLog(`${JSON.stringify(ad, null, ' ')}`);
279
- this.debugLog(`address: ${ad.address}, model: ${ad.serviceData.model}`);
280
- this.debugLog(`serviceData: ${JSON.stringify(ad.serviceData)}`);
281
- serviceData = ad.serviceData;
282
- }
283
- };
284
- // Wait
285
- await switchbot.wait(this.scanDuration * 1000);
286
- // Stop to monitor
287
- try {
288
- await switchbot.stopScan();
289
- }
290
- catch (e) {
291
- this.errorLog(`Failed to stop BLE scanning. Error: ${e.message ?? e}`);
292
- }
293
- return serviceData;
294
- }
295
- async getCustomBLEAddress(switchbot) {
296
- if (this.device.customBLEaddress && this.deviceLogging.includes('debug')) {
297
- this.debugLog(`customBLEaddress: ${this.device.customBLEaddress}`);
298
- (async () => {
299
- // Start to monitor advertisement packets
300
- try {
301
- await switchbot.startScan({ model: this.device.bleModel });
302
- }
303
- catch (e) {
304
- this.errorLog(`Failed to start BLE scanning. Error: ${e.message ?? e}`);
305
- }
306
- // Set an event handler
307
- switchbot.onadvertisement = (ad) => {
308
- this.warnLog(`ad: ${JSON.stringify(ad, null, ' ')}`);
309
- };
310
- await sleep(10000);
311
- // Stop to monitor
312
- try {
313
- switchbot.stopScan();
314
- }
315
- catch (e) {
316
- this.errorLog(`Failed to stop BLE scanning. Error: ${e.message ?? e}`);
317
- }
318
- })();
319
- }
320
- }
321
- async pushChangeRequest(bodyChange) {
322
- const { response, statusCode } = await this.platform.retryCommand(this.device, bodyChange, this.deviceMaxRetries, this.deviceDelayBetweenRetries);
323
- return { body: response, statusCode };
324
- }
325
- async deviceRefreshStatus() {
326
- const { response, statusCode } = await this.platform.retryRequest(this.device, this.deviceMaxRetries, this.deviceDelayBetweenRetries);
327
- return { body: response, statusCode };
328
- }
329
- async successfulStatusCodes(deviceStatus) {
330
- return (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100);
331
- }
332
- /**
333
- * Update the characteristic value and log the change.
334
- *
335
- * @param Service Service
336
- * @param Characteristic Characteristic
337
- * @param CharacteristicValue CharacteristicValue | undefined
338
- * @param CharacteristicName string
339
- * @param history object
340
- * @return: void
341
- *
342
- */
343
- async updateCharacteristic(Service, Characteristic, CharacteristicValue, CharacteristicName, history) {
344
- if (CharacteristicValue === undefined || CharacteristicValue === null) {
345
- this.debugLog(`${CharacteristicName}: ${CharacteristicValue}`);
346
- }
347
- else {
348
- await this.mqtt(CharacteristicName, CharacteristicValue);
349
- if (this.device.history) {
350
- this.historyService?.addEntry(history);
351
- }
352
- Service.updateCharacteristic(Characteristic, CharacteristicValue);
353
- this.debugLog(`updateCharacteristic ${CharacteristicName}: ${CharacteristicValue}`);
354
- this.debugWarnLog(`${CharacteristicName} context before: ${this.accessory.context[CharacteristicName]}`);
355
- this.accessory.context[CharacteristicName] = CharacteristicValue;
356
- this.debugWarnLog(`${CharacteristicName} context after: ${this.accessory.context[CharacteristicName]}`);
357
- }
358
- }
359
- async mqtt(CharacteristicName, CharacteristicValue) {
360
- if (this.device.mqttURL) {
361
- this.mqttPublish(CharacteristicName, CharacteristicValue.toString());
362
- }
363
- }
364
- async getDeviceContext(accessory, device) {
365
- const deviceMapping = {
366
- 'Humidifier': {
367
- model: SwitchBotModel.Humidifier,
368
- bleModel: SwitchBotBLEModel.Humidifier,
369
- bleModelName: SwitchBotBLEModelName.Humidifier,
370
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Humidifier,
371
- },
372
- 'Humidifier2': {
373
- model: SwitchBotModel.Humidifier2,
374
- bleModel: SwitchBotBLEModel.Humidifier2,
375
- bleModelName: SwitchBotBLEModelName.Humidifier2,
376
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Humidifier2,
377
- },
378
- 'Hub Mini': {
379
- model: SwitchBotModel.HubMini,
380
- bleModel: SwitchBotBLEModel.Unknown,
381
- bleModelName: SwitchBotBLEModelName.Unknown,
382
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
383
- },
384
- 'Hub Plus': {
385
- model: SwitchBotModel.HubPlus,
386
- bleModel: SwitchBotBLEModel.Unknown,
387
- bleModelName: SwitchBotBLEModelName.Unknown,
388
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
389
- },
390
- 'Hub 2': {
391
- model: SwitchBotModel.Hub2,
392
- bleModel: SwitchBotBLEModel.Hub2,
393
- bleModelName: SwitchBotBLEModelName.Hub2,
394
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Hub2,
395
- },
396
- 'Hub 3': {
397
- model: SwitchBotModel.Hub3,
398
- bleModel: SwitchBotBLEModel.Hub3,
399
- bleModelName: SwitchBotBLEModelName.Hub3,
400
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Hub3,
401
- },
402
- 'Bot': {
403
- model: SwitchBotModel.Bot,
404
- bleModel: SwitchBotBLEModel.Bot,
405
- bleModelName: SwitchBotBLEModelName.Bot,
406
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Bot,
407
- },
408
- 'Relay Switch 1': {
409
- model: SwitchBotModel.RelaySwitch1,
410
- bleModel: SwitchBotBLEModel.RelaySwitch1,
411
- bleModelName: SwitchBotBLEModelName.RelaySwitch1,
412
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.RelaySwitch1,
413
- },
414
- 'Relay Switch 1PM': {
415
- model: SwitchBotModel.RelaySwitch1PM,
416
- bleModel: SwitchBotBLEModel.RelaySwitch1PM,
417
- bleModelName: SwitchBotBLEModelName.RelaySwitch1PM,
418
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.RelaySwitch1PM,
419
- },
420
- 'Meter': {
421
- model: SwitchBotModel.Meter,
422
- bleModel: SwitchBotBLEModel.Meter,
423
- bleModelName: SwitchBotBLEModelName.Meter,
424
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Meter,
425
- },
426
- 'MeterPlus': {
427
- model: SwitchBotModel.MeterPlusUS,
428
- bleModel: SwitchBotBLEModel.MeterPlus,
429
- bleModelName: SwitchBotBLEModelName.MeterPlus,
430
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.MeterPlus,
431
- },
432
- 'Meter Plus (JP)': {
433
- model: SwitchBotModel.MeterPlusJP,
434
- bleModel: SwitchBotBLEModel.MeterPlus,
435
- bleModelName: SwitchBotBLEModelName.MeterPlus,
436
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.MeterPlus,
437
- },
438
- 'MeterPro': {
439
- model: SwitchBotModel.MeterPro,
440
- bleModel: SwitchBotBLEModel.MeterPro,
441
- bleModelName: SwitchBotBLEModelName.MeterPro,
442
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.MeterPro,
443
- },
444
- 'MeterPro(CO2)': {
445
- model: SwitchBotModel.MeterProCO2,
446
- bleModel: SwitchBotBLEModel.MeterProCO2,
447
- bleModelName: SwitchBotBLEModelName.MeterProCO2,
448
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.MeterProCO2,
449
- },
450
- 'WoIOSensor': {
451
- model: SwitchBotModel.OutdoorMeter,
452
- bleModel: SwitchBotBLEModel.OutdoorMeter,
453
- bleModelName: SwitchBotBLEModelName.OutdoorMeter,
454
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.OutdoorMeter,
455
- },
456
- 'Water Detector': {
457
- model: SwitchBotModel.WaterDetector,
458
- bleModel: SwitchBotBLEModel.Leak,
459
- bleModelName: SwitchBotBLEModelName.Leak,
460
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Leak,
461
- },
462
- 'Motion Sensor': {
463
- model: SwitchBotModel.MotionSensor,
464
- bleModel: SwitchBotBLEModel.MotionSensor,
465
- bleModelName: SwitchBotBLEModelName.MotionSensor,
466
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.MotionSensor,
467
- },
468
- 'Contact Sensor': {
469
- model: SwitchBotModel.ContactSensor,
470
- bleModel: SwitchBotBLEModel.ContactSensor,
471
- bleModelName: SwitchBotBLEModelName.ContactSensor,
472
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.ContactSensor,
473
- },
474
- 'Curtain': {
475
- model: SwitchBotModel.Curtain,
476
- bleModel: SwitchBotBLEModel.Curtain,
477
- bleModelName: SwitchBotBLEModelName.Curtain,
478
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Curtain,
479
- },
480
- 'Curtain3': {
481
- model: SwitchBotModel.Curtain3,
482
- bleModel: SwitchBotBLEModel.Curtain3,
483
- bleModelName: SwitchBotBLEModelName.Curtain3,
484
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Curtain3,
485
- },
486
- 'WoRollerShade': {
487
- model: SwitchBotModel.Curtain3,
488
- bleModel: SwitchBotBLEModel.Curtain3,
489
- bleModelName: SwitchBotBLEModelName.Curtain3,
490
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Curtain3,
491
- },
492
- 'Roller Shade': {
493
- model: SwitchBotModel.Curtain3,
494
- bleModel: SwitchBotBLEModel.Curtain3,
495
- bleModelName: SwitchBotBLEModelName.Curtain3,
496
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Curtain3,
497
- },
498
- 'Blind Tilt': {
499
- model: SwitchBotModel.BlindTilt,
500
- bleModel: SwitchBotBLEModel.BlindTilt,
501
- bleModelName: SwitchBotBLEModelName.BlindTilt,
502
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.BlindTilt,
503
- },
504
- 'Plug': {
505
- model: SwitchBotModel.Plug,
506
- bleModel: SwitchBotBLEModel.PlugMiniUS,
507
- bleModelName: SwitchBotBLEModelName.PlugMini,
508
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.PlugMini,
509
- },
510
- 'Plug Mini (US)': {
511
- model: SwitchBotModel.PlugMiniUS,
512
- bleModel: SwitchBotBLEModel.PlugMiniUS,
513
- bleModelName: SwitchBotBLEModelName.PlugMini,
514
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.PlugMini,
515
- },
516
- 'Plug Mini (JP)': {
517
- model: SwitchBotModel.PlugMiniJP,
518
- bleModel: SwitchBotBLEModel.PlugMiniJP,
519
- bleModelName: SwitchBotBLEModelName.PlugMini,
520
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.PlugMini,
521
- },
522
- 'Smart Lock': {
523
- model: SwitchBotModel.Lock,
524
- bleModel: SwitchBotBLEModel.Lock,
525
- bleModelName: SwitchBotBLEModelName.Lock,
526
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Lock,
527
- },
528
- 'Smart Lock Pro': {
529
- model: SwitchBotModel.LockPro,
530
- bleModel: SwitchBotBLEModel.LockPro,
531
- bleModelName: SwitchBotBLEModelName.LockPro,
532
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.LockPro,
533
- },
534
- 'Color Bulb': {
535
- model: SwitchBotModel.ColorBulb,
536
- bleModel: SwitchBotBLEModel.ColorBulb,
537
- bleModelName: SwitchBotBLEModelName.ColorBulb,
538
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.ColorBulb,
539
- },
540
- 'K10+': {
541
- model: SwitchBotModel.K10,
542
- bleModel: SwitchBotBLEModel.Unknown,
543
- bleModelName: SwitchBotBLEModelName.Unknown,
544
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
545
- },
546
- 'K10+ Pro': {
547
- model: SwitchBotModel.K10Pro,
548
- bleModel: SwitchBotBLEModel.Unknown,
549
- bleModelName: SwitchBotBLEModelName.Unknown,
550
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
551
- },
552
- 'WoSweeper': {
553
- model: SwitchBotModel.WoSweeper,
554
- bleModel: SwitchBotBLEModel.Unknown,
555
- bleModelName: SwitchBotBLEModelName.Unknown,
556
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
557
- },
558
- 'WoSweeperMini': {
559
- model: SwitchBotModel.WoSweeperMini,
560
- bleModel: SwitchBotBLEModel.Unknown,
561
- bleModelName: SwitchBotBLEModelName.Unknown,
562
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
563
- },
564
- 'Robot Vacuum Cleaner S1': {
565
- model: SwitchBotModel.RobotVacuumCleanerS1,
566
- bleModel: SwitchBotBLEModel.Unknown,
567
- bleModelName: SwitchBotBLEModelName.Unknown,
568
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
569
- },
570
- 'Robot Vacuum Cleaner S1 Plus': {
571
- model: SwitchBotModel.RobotVacuumCleanerS1Plus,
572
- bleModel: SwitchBotBLEModel.Unknown,
573
- bleModelName: SwitchBotBLEModelName.Unknown,
574
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
575
- },
576
- 'Robot Vacuum Cleaner S10': {
577
- model: SwitchBotModel.RobotVacuumCleanerS10,
578
- bleModel: SwitchBotBLEModel.Unknown,
579
- bleModelName: SwitchBotBLEModelName.Unknown,
580
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
581
- },
582
- 'Ceiling Light': {
583
- model: SwitchBotModel.CeilingLight,
584
- bleModel: SwitchBotBLEModel.CeilingLight,
585
- bleModelName: SwitchBotBLEModelName.CeilingLight,
586
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.CeilingLight,
587
- },
588
- 'Ceiling Light Pro': {
589
- model: SwitchBotModel.CeilingLightPro,
590
- bleModel: SwitchBotBLEModel.CeilingLightPro,
591
- bleModelName: SwitchBotBLEModelName.CeilingLightPro,
592
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.CeilingLightPro,
593
- },
594
- 'Strip Light': {
595
- model: SwitchBotModel.StripLight,
596
- bleModel: SwitchBotBLEModel.StripLight,
597
- bleModelName: SwitchBotBLEModelName.StripLight,
598
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.StripLight,
599
- },
600
- 'Indoor Cam': {
601
- model: SwitchBotModel.IndoorCam,
602
- bleModel: SwitchBotBLEModel.Unknown,
603
- bleModelName: SwitchBotBLEModelName.Unknown,
604
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
605
- },
606
- 'Remote': {
607
- model: SwitchBotModel.Remote,
608
- bleModel: SwitchBotBLEModel.Unknown,
609
- bleModelName: SwitchBotBLEModelName.Unknown,
610
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
611
- },
612
- 'remote with screen+': {
613
- model: SwitchBotModel.UniversalRemote,
614
- bleModel: SwitchBotBLEModel.Unknown,
615
- bleModelName: SwitchBotBLEModelName.Unknown,
616
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
617
- },
618
- 'Battery Circulator Fan': {
619
- model: SwitchBotModel.BatteryCirculatorFan,
620
- bleModel: SwitchBotBLEModel.Unknown,
621
- bleModelName: SwitchBotBLEModelName.Unknown,
622
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
623
- },
624
- };
625
- const defaultDevice = {
626
- model: SwitchBotModel.Unknown,
627
- bleModel: SwitchBotBLEModel.Unknown,
628
- bleModelName: SwitchBotBLEModelName.Unknown,
629
- bleModelFriendlyName: SwitchBotBLEModelFriendlyName.Unknown,
630
- };
631
- const deviceConfig = deviceMapping[device.deviceType] || defaultDevice;
632
- device.model = deviceConfig.model;
633
- device.bleModel = deviceConfig.bleModel;
634
- device.bleModelName = deviceConfig.bleModelName;
635
- device.bleModelFriednlyName = deviceConfig.bleModelFriednlyName;
636
- this.debugLog(`Model: ${device.model}, BLE Model: ${device.bleModel}, BLE Model Name: ${device.bleModelName}, BLE Model Friendly Name: ${device.bleModelFriednlyName}`);
637
- const deviceFirmwareVersion = device.firmware ?? device.version ?? accessory.context.version ?? this.platform.version ?? '0.0.0';
638
- const version = deviceFirmwareVersion.toString();
639
- this.debugLog(`Firmware Version: ${version.replace(/^V|-.*$/g, '')}`);
640
- let deviceVersion;
641
- if (version?.includes('.') === false) {
642
- const replace = version?.replace(/^V|-.*$/g, '');
643
- const match = replace?.match(/./g);
644
- const validVersion = match?.join('.');
645
- deviceVersion = validVersion ?? '0.0.0';
646
- }
647
- else {
648
- deviceVersion = version.replace(/^V|-.*$/g, '') ?? '0.0.0';
649
- }
650
- accessory
651
- .getService(this.hap.Service.AccessoryInformation)
652
- .setCharacteristic(this.hap.Characteristic.HardwareRevision, deviceVersion)
653
- .setCharacteristic(this.hap.Characteristic.SoftwareRevision, deviceVersion)
654
- .setCharacteristic(this.hap.Characteristic.FirmwareRevision, deviceVersion)
655
- .getCharacteristic(this.hap.Characteristic.FirmwareRevision)
656
- .updateValue(deviceVersion);
657
- accessory.context.version = deviceVersion;
658
- this.debugSuccessLog(`version: ${accessory.context.version}`);
659
- }
660
- async statusCode(statusCode) {
661
- const statusMessages = {
662
- 151: 'Command not supported by this deviceType',
663
- 152: 'Device not found',
664
- 160: 'Command is not supported',
665
- 161: 'Device is offline',
666
- 171: `Hub Device is offline. Hub: ${this.device.hubDeviceId}`,
667
- 190: 'Device internal error due to device states not synchronized with server, or command format is invalid',
668
- 100: 'Command successfully sent',
669
- 200: 'Request successful',
670
- 400: 'Bad Request, an invalid payload request',
671
- 401: 'Unauthorized, Authorization for the API is required, but the request has not been authenticated',
672
- 403: 'Forbidden, The request has been authenticated but does not have appropriate permissions, or a requested resource is not found',
673
- 404: 'Not Found, Specifies the requested path does not exist',
674
- 406: 'Not Acceptable, a MIME type has been requested via the Accept header for a value not supported by the server',
675
- 415: 'Unsupported Media Type, a contentType header has been defined that is not supported by the server',
676
- 422: 'Unprocessable Entity: The server cannot process the request, often due to exceeded API limits.',
677
- 429: 'Too Many Requests, exceeded the number of requests allowed for a given time window',
678
- 500: 'Internal Server Error, An unexpected error occurred. These errors should be rare',
679
- };
680
- if (statusCode === 171 && (this.device.hubDeviceId === this.device.deviceId || this.device.hubDeviceId === '000000000000')) {
681
- this.debugErrorLog(`statusCode 171 changed to 161: hubDeviceId ${this.device.hubDeviceId} matches deviceId ${this.device.deviceId}, device is its own hub.`);
682
- statusCode = 161;
683
- }
684
- const logMessage = statusMessages[statusCode] || `Unknown statusCode: ${statusCode}, Submit Bugs Here: https://tinyurl.com/SwitchBotBug`;
685
- const logMethod = [100, 200].includes(statusCode) ? 'debugLog' : statusMessages[statusCode] ? 'errorLog' : 'infoLog';
686
- this[logMethod](`${logMessage}, statusCode: ${statusCode}`);
687
- }
688
- /**
689
- * Logging for Device
690
- */
691
- infoLog(...log) {
692
- if (this.enablingDeviceLogging()) {
693
- this.log.info(`${this.device.deviceType}: ${this.accessory.displayName}`, String(...log));
694
- }
695
- }
696
- successLog(...log) {
697
- if (this.enablingDeviceLogging()) {
698
- this.log.success(`${this.device.deviceType}: ${this.accessory.displayName}`, String(...log));
699
- }
700
- }
701
- debugSuccessLog(...log) {
702
- if (this.enablingDeviceLogging()) {
703
- if (this.loggingIsDebug()) {
704
- this.log.success(`[DEBUG] ${this.device.deviceType}: ${this.accessory.displayName}`, String(...log));
705
- }
706
- }
707
- }
708
- warnLog(...log) {
709
- if (this.enablingDeviceLogging()) {
710
- this.log.warn(`${this.device.deviceType}: ${this.accessory.displayName}`, String(...log));
711
- }
712
- }
713
- debugWarnLog(...log) {
714
- if (this.enablingDeviceLogging()) {
715
- if (this.loggingIsDebug()) {
716
- this.log.warn(`[DEBUG] ${this.device.deviceType}: ${this.accessory.displayName}`, String(...log));
717
- }
718
- }
719
- }
720
- errorLog(...log) {
721
- if (this.enablingDeviceLogging()) {
722
- this.log.error(`${this.device.deviceType}: ${this.accessory.displayName}`, String(...log));
723
- }
724
- }
725
- debugErrorLog(...log) {
726
- if (this.enablingDeviceLogging()) {
727
- if (this.loggingIsDebug()) {
728
- this.log.error(`[DEBUG] ${this.device.deviceType}: ${this.accessory.displayName}`, String(...log));
729
- }
730
- }
731
- }
732
- debugLog(...log) {
733
- if (this.enablingDeviceLogging()) {
734
- if (this.deviceLogging === 'debug') {
735
- this.log.info(`[DEBUG] ${this.device.deviceType}: ${this.accessory.displayName}`, String(...log));
736
- }
737
- else if (this.deviceLogging === 'debugMode') {
738
- this.log.debug(`${this.device.deviceType}: ${this.accessory.displayName}`, String(...log));
739
- }
740
- }
741
- }
742
- loggingIsDebug() {
743
- return this.deviceLogging === 'debugMode' || this.deviceLogging === 'debug';
744
- }
745
- enablingDeviceLogging() {
746
- return this.deviceLogging === 'debugMode' || this.deviceLogging === 'debug' || this.deviceLogging === 'standard';
747
- }
748
- }
749
- //# sourceMappingURL=device.js.map