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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (534) hide show
  1. package/.github/ISSUE_TEMPLATE/e2e-verification.md +36 -0
  2. package/.github/workflows/ci.yml +61 -0
  3. package/.github/workflows/manual-e2e.yml +103 -0
  4. package/CHANGELOG.md +20 -0
  5. package/E2E-VERIFICATION.md +121 -0
  6. package/MIGRATION.md +44 -0
  7. package/README.md +11 -0
  8. package/config.schema.json +99 -1940
  9. package/dist/deviceFactory.d.ts +13 -0
  10. package/dist/deviceFactory.d.ts.map +1 -0
  11. package/dist/deviceFactory.js +81 -0
  12. package/dist/deviceFactory.js.map +1 -0
  13. package/dist/devices/deviceBase.d.ts +50 -0
  14. package/dist/devices/deviceBase.d.ts.map +1 -0
  15. package/dist/devices/deviceBase.js +119 -0
  16. package/dist/devices/deviceBase.js.map +1 -0
  17. package/dist/devices/genericDevice.d.ts +283 -0
  18. package/dist/devices/genericDevice.d.ts.map +1 -0
  19. package/dist/devices/genericDevice.js +1035 -0
  20. package/dist/devices/genericDevice.js.map +1 -0
  21. package/dist/homebridge-ui/public/index.html +72 -440
  22. package/dist/homebridge-ui/server.d.ts +3 -1
  23. package/dist/homebridge-ui/server.d.ts.map +1 -1
  24. package/dist/homebridge-ui/server.js +47 -10
  25. package/dist/homebridge-ui/server.js.map +1 -1
  26. package/dist/index.d.ts.map +1 -1
  27. package/dist/index.js +1 -3
  28. package/dist/index.js.map +1 -1
  29. package/dist/platform.d.ts +27 -0
  30. package/dist/platform.d.ts.map +1 -0
  31. package/dist/platform.js +404 -0
  32. package/dist/platform.js.map +1 -0
  33. package/dist/settings.d.ts +10 -317
  34. package/dist/settings.d.ts.map +1 -1
  35. package/dist/settings.js +5 -30
  36. package/dist/settings.js.map +1 -1
  37. package/dist/switchbotClient.d.ts +32 -0
  38. package/dist/switchbotClient.d.ts.map +1 -0
  39. package/dist/switchbotClient.js +259 -0
  40. package/dist/switchbotClient.js.map +1 -0
  41. package/dist/utils.d.ts +36 -248
  42. package/dist/utils.d.ts.map +1 -1
  43. package/dist/utils.js +38 -1367
  44. package/dist/utils.js.map +1 -1
  45. package/docs/assets/icons.js +1 -1
  46. package/docs/assets/icons.svg +1 -1
  47. package/docs/assets/style.css +3 -3
  48. package/docs/index.html +50 -15
  49. package/docs/variables/default.html +1 -1
  50. package/package.json +19 -18
  51. package/scripts/e2e/README.md +25 -0
  52. package/scripts/e2e/curtain-e2e.sh +70 -0
  53. package/scripts/e2e/fan-e2e.sh +75 -0
  54. package/scripts/e2e/light-advanced-e2e.sh +97 -0
  55. package/scripts/e2e/light-e2e.sh +75 -0
  56. package/scripts/e2e/list-accessories.sh +19 -0
  57. package/scripts/e2e/lock-e2e.sh +65 -0
  58. package/scripts/generate-matter-maps.js +60 -0
  59. package/scripts/run-e2e-local.sh +14 -0
  60. package/src/deviceFactory.ts +122 -0
  61. package/src/devices/deviceBase.ts +141 -0
  62. package/src/devices/genericDevice.ts +965 -0
  63. package/src/homebridge-ui/public/index.html +72 -440
  64. package/src/homebridge-ui/server.ts +52 -10
  65. package/src/index.ts +1 -3
  66. package/src/platform.ts +395 -0
  67. package/src/settings.ts +12 -352
  68. package/src/switchbotClient.ts +266 -0
  69. package/src/utils.ts +47 -1456
  70. package/test/accessory-restore.spec.ts +73 -0
  71. package/test/device-mapping.spec.ts +37 -0
  72. package/test/deviceFactory.spec.ts +18 -0
  73. package/test/e2e/run-e2e.spec.ts +50 -0
  74. package/test/fan-swing.spec.ts +29 -0
  75. package/test/helpers/matter-harness.ts +53 -0
  76. package/test/lock-users.spec.ts +44 -0
  77. package/test/matter-childbridge.spec.ts +55 -0
  78. package/test/matter-descriptors.spec.ts +97 -0
  79. package/test/matter-device-state.spec.ts +101 -0
  80. package/test/matter-integration.spec.ts +70 -0
  81. package/test/platform.integration.spec.ts +55 -0
  82. package/test/switchbot-client-debounce.spec.ts +131 -0
  83. package/test/switchbot-client-openapi.spec.ts +56 -0
  84. package/test/switchbotClient.spec.ts +10 -0
  85. package/test/utils.spec.ts +20 -0
  86. package/vitest.config.ts +7 -0
  87. package/coverage/base.css +0 -224
  88. package/coverage/block-navigation.js +0 -87
  89. package/coverage/clover.xml +0 -15847
  90. package/coverage/coverage-final.json +0 -42
  91. package/coverage/docs/assets/dmt/dmt-component-data.js.html +0 -85
  92. package/coverage/docs/assets/dmt/dmt-components.js.html +0 -286
  93. package/coverage/docs/assets/dmt/index.html +0 -131
  94. package/coverage/docs/assets/hierarchy.js.html +0 -85
  95. package/coverage/docs/assets/icons.js.html +0 -136
  96. package/coverage/docs/assets/index.html +0 -146
  97. package/coverage/docs/assets/main.js.html +0 -265
  98. package/coverage/favicon.png +0 -0
  99. package/coverage/index.html +0 -191
  100. package/coverage/prettify.css +0 -1
  101. package/coverage/prettify.js +0 -2
  102. package/coverage/sort-arrow-sprite.png +0 -0
  103. package/coverage/sorter.js +0 -196
  104. package/coverage/src/device/blindtilt.ts.html +0 -3238
  105. package/coverage/src/device/bot.ts.html +0 -2803
  106. package/coverage/src/device/ceilinglight.ts.html +0 -2338
  107. package/coverage/src/device/colorbulb.ts.html +0 -2824
  108. package/coverage/src/device/contact.ts.html +0 -1465
  109. package/coverage/src/device/curtain.ts.html +0 -2869
  110. package/coverage/src/device/device.ts.html +0 -2500
  111. package/coverage/src/device/fan.ts.html +0 -2242
  112. package/coverage/src/device/hub.ts.html +0 -1408
  113. package/coverage/src/device/humidifier.ts.html +0 -2116
  114. package/coverage/src/device/index.html +0 -416
  115. package/coverage/src/device/iosensor.ts.html +0 -1375
  116. package/coverage/src/device/lightstrip.ts.html +0 -2617
  117. package/coverage/src/device/lock.ts.html +0 -1963
  118. package/coverage/src/device/meter.ts.html +0 -1372
  119. package/coverage/src/device/meterplus.ts.html +0 -1384
  120. package/coverage/src/device/meterpro.ts.html +0 -1618
  121. package/coverage/src/device/motion.ts.html +0 -1264
  122. package/coverage/src/device/plug.ts.html +0 -1372
  123. package/coverage/src/device/relayswitch.ts.html +0 -2284
  124. package/coverage/src/device/robotvacuumcleaner.ts.html +0 -1810
  125. package/coverage/src/device/waterdetector.ts.html +0 -1294
  126. package/coverage/src/homebridge-ui/index.html +0 -116
  127. package/coverage/src/homebridge-ui/server.ts.html +0 -229
  128. package/coverage/src/index.html +0 -161
  129. package/coverage/src/index.ts.html +0 -124
  130. package/coverage/src/irdevice/airconditioner.ts.html +0 -1687
  131. package/coverage/src/irdevice/airpurifier.ts.html +0 -844
  132. package/coverage/src/irdevice/camera.ts.html +0 -475
  133. package/coverage/src/irdevice/fan.ts.html +0 -766
  134. package/coverage/src/irdevice/index.html +0 -251
  135. package/coverage/src/irdevice/irdevice.ts.html +0 -1117
  136. package/coverage/src/irdevice/light.ts.html +0 -826
  137. package/coverage/src/irdevice/other.ts.html +0 -2458
  138. package/coverage/src/irdevice/tv.ts.html +0 -1222
  139. package/coverage/src/irdevice/vacuumcleaner.ts.html +0 -466
  140. package/coverage/src/irdevice/waterheater.ts.html +0 -469
  141. package/coverage/src/platform.ts.html +0 -8776
  142. package/coverage/src/settings.ts.html +0 -934
  143. package/coverage/src/utils.ts.html +0 -2092
  144. package/dist/devices-hap/airpurifier.d.ts +0 -54
  145. package/dist/devices-hap/airpurifier.d.ts.map +0 -1
  146. package/dist/devices-hap/airpurifier.js +0 -533
  147. package/dist/devices-hap/airpurifier.js.map +0 -1
  148. package/dist/devices-hap/blindtilt.d.ts +0 -90
  149. package/dist/devices-hap/blindtilt.d.ts.map +0 -1
  150. package/dist/devices-hap/blindtilt.js +0 -974
  151. package/dist/devices-hap/blindtilt.js.map +0 -1
  152. package/dist/devices-hap/bot.d.ts +0 -102
  153. package/dist/devices-hap/bot.d.ts.map +0 -1
  154. package/dist/devices-hap/bot.js +0 -822
  155. package/dist/devices-hap/bot.js.map +0 -1
  156. package/dist/devices-hap/ceilinglight.d.ts +0 -85
  157. package/dist/devices-hap/ceilinglight.d.ts.map +0 -1
  158. package/dist/devices-hap/ceilinglight.js +0 -707
  159. package/dist/devices-hap/ceilinglight.js.map +0 -1
  160. package/dist/devices-hap/colorbulb.d.ts +0 -88
  161. package/dist/devices-hap/colorbulb.d.ts.map +0 -1
  162. package/dist/devices-hap/colorbulb.js +0 -921
  163. package/dist/devices-hap/colorbulb.js.map +0 -1
  164. package/dist/devices-hap/contact.d.ts +0 -44
  165. package/dist/devices-hap/contact.d.ts.map +0 -1
  166. package/dist/devices-hap/contact.js +0 -409
  167. package/dist/devices-hap/contact.js.map +0 -1
  168. package/dist/devices-hap/curtain.d.ts +0 -73
  169. package/dist/devices-hap/curtain.d.ts.map +0 -1
  170. package/dist/devices-hap/curtain.js +0 -869
  171. package/dist/devices-hap/curtain.js.map +0 -1
  172. package/dist/devices-hap/device.d.ts +0 -108
  173. package/dist/devices-hap/device.d.ts.map +0 -1
  174. package/dist/devices-hap/device.js +0 -821
  175. package/dist/devices-hap/device.js.map +0 -1
  176. package/dist/devices-hap/fan.d.ts +0 -69
  177. package/dist/devices-hap/fan.d.ts.map +0 -1
  178. package/dist/devices-hap/fan.js +0 -655
  179. package/dist/devices-hap/fan.js.map +0 -1
  180. package/dist/devices-hap/hub.d.ts +0 -37
  181. package/dist/devices-hap/hub.d.ts.map +0 -1
  182. package/dist/devices-hap/hub.js +0 -393
  183. package/dist/devices-hap/hub.js.map +0 -1
  184. package/dist/devices-hap/humidifier.d.ts +0 -73
  185. package/dist/devices-hap/humidifier.d.ts.map +0 -1
  186. package/dist/devices-hap/humidifier.js +0 -716
  187. package/dist/devices-hap/humidifier.js.map +0 -1
  188. package/dist/devices-hap/iosensor.d.ts +0 -42
  189. package/dist/devices-hap/iosensor.d.ts.map +0 -1
  190. package/dist/devices-hap/iosensor.js +0 -397
  191. package/dist/devices-hap/iosensor.js.map +0 -1
  192. package/dist/devices-hap/lightstrip.d.ts +0 -79
  193. package/dist/devices-hap/lightstrip.d.ts.map +0 -1
  194. package/dist/devices-hap/lightstrip.js +0 -827
  195. package/dist/devices-hap/lightstrip.js.map +0 -1
  196. package/dist/devices-hap/lock.d.ts +0 -53
  197. package/dist/devices-hap/lock.d.ts.map +0 -1
  198. package/dist/devices-hap/lock.js +0 -569
  199. package/dist/devices-hap/lock.js.map +0 -1
  200. package/dist/devices-hap/meter.d.ts +0 -37
  201. package/dist/devices-hap/meter.d.ts.map +0 -1
  202. package/dist/devices-hap/meter.js +0 -380
  203. package/dist/devices-hap/meter.js.map +0 -1
  204. package/dist/devices-hap/meterplus.d.ts +0 -42
  205. package/dist/devices-hap/meterplus.d.ts.map +0 -1
  206. package/dist/devices-hap/meterplus.js +0 -385
  207. package/dist/devices-hap/meterplus.js.map +0 -1
  208. package/dist/devices-hap/meterpro.d.ts +0 -43
  209. package/dist/devices-hap/meterpro.d.ts.map +0 -1
  210. package/dist/devices-hap/meterpro.js +0 -469
  211. package/dist/devices-hap/meterpro.js.map +0 -1
  212. package/dist/devices-hap/motion.d.ts +0 -42
  213. package/dist/devices-hap/motion.d.ts.map +0 -1
  214. package/dist/devices-hap/motion.js +0 -345
  215. package/dist/devices-hap/motion.js.map +0 -1
  216. package/dist/devices-hap/plug.d.ts +0 -49
  217. package/dist/devices-hap/plug.d.ts.map +0 -1
  218. package/dist/devices-hap/plug.js +0 -400
  219. package/dist/devices-hap/plug.js.map +0 -1
  220. package/dist/devices-hap/relayswitch.d.ts +0 -96
  221. package/dist/devices-hap/relayswitch.d.ts.map +0 -1
  222. package/dist/devices-hap/relayswitch.js +0 -642
  223. package/dist/devices-hap/relayswitch.js.map +0 -1
  224. package/dist/devices-hap/robotvacuumcleaner.d.ts +0 -54
  225. package/dist/devices-hap/robotvacuumcleaner.d.ts.map +0 -1
  226. package/dist/devices-hap/robotvacuumcleaner.js +0 -530
  227. package/dist/devices-hap/robotvacuumcleaner.js.map +0 -1
  228. package/dist/devices-hap/waterdetector.d.ts +0 -41
  229. package/dist/devices-hap/waterdetector.d.ts.map +0 -1
  230. package/dist/devices-hap/waterdetector.js +0 -356
  231. package/dist/devices-hap/waterdetector.js.map +0 -1
  232. package/dist/devices-matter/BaseMatterAccessory.d.ts +0 -90
  233. package/dist/devices-matter/BaseMatterAccessory.d.ts.map +0 -1
  234. package/dist/devices-matter/BaseMatterAccessory.js +0 -264
  235. package/dist/devices-matter/BaseMatterAccessory.js.map +0 -1
  236. package/dist/devices-matter/ColorLightAccessory.d.ts +0 -20
  237. package/dist/devices-matter/ColorLightAccessory.d.ts.map +0 -1
  238. package/dist/devices-matter/ColorLightAccessory.js +0 -95
  239. package/dist/devices-matter/ColorLightAccessory.js.map +0 -1
  240. package/dist/devices-matter/ColorTemperatureLightAccessory.d.ts +0 -18
  241. package/dist/devices-matter/ColorTemperatureLightAccessory.d.ts.map +0 -1
  242. package/dist/devices-matter/ColorTemperatureLightAccessory.js +0 -76
  243. package/dist/devices-matter/ColorTemperatureLightAccessory.js.map +0 -1
  244. package/dist/devices-matter/ContactSensorAccessory.d.ts +0 -12
  245. package/dist/devices-matter/ContactSensorAccessory.d.ts.map +0 -1
  246. package/dist/devices-matter/ContactSensorAccessory.js +0 -34
  247. package/dist/devices-matter/ContactSensorAccessory.js.map +0 -1
  248. package/dist/devices-matter/DimmableLightAccessory.d.ts +0 -58
  249. package/dist/devices-matter/DimmableLightAccessory.d.ts.map +0 -1
  250. package/dist/devices-matter/DimmableLightAccessory.js +0 -167
  251. package/dist/devices-matter/DimmableLightAccessory.js.map +0 -1
  252. package/dist/devices-matter/DoorLockAccessory.d.ts +0 -14
  253. package/dist/devices-matter/DoorLockAccessory.d.ts.map +0 -1
  254. package/dist/devices-matter/DoorLockAccessory.js +0 -50
  255. package/dist/devices-matter/DoorLockAccessory.js.map +0 -1
  256. package/dist/devices-matter/ExtendedColorLightAccessory.d.ts +0 -21
  257. package/dist/devices-matter/ExtendedColorLightAccessory.d.ts.map +0 -1
  258. package/dist/devices-matter/ExtendedColorLightAccessory.js +0 -106
  259. package/dist/devices-matter/ExtendedColorLightAccessory.js.map +0 -1
  260. package/dist/devices-matter/FanAccessory.d.ts +0 -16
  261. package/dist/devices-matter/FanAccessory.d.ts.map +0 -1
  262. package/dist/devices-matter/FanAccessory.js +0 -81
  263. package/dist/devices-matter/FanAccessory.js.map +0 -1
  264. package/dist/devices-matter/HumiditySensorAccessory.d.ts +0 -12
  265. package/dist/devices-matter/HumiditySensorAccessory.d.ts.map +0 -1
  266. package/dist/devices-matter/HumiditySensorAccessory.js +0 -34
  267. package/dist/devices-matter/HumiditySensorAccessory.js.map +0 -1
  268. package/dist/devices-matter/LeakSensorAccessory.d.ts +0 -12
  269. package/dist/devices-matter/LeakSensorAccessory.d.ts.map +0 -1
  270. package/dist/devices-matter/LeakSensorAccessory.js +0 -33
  271. package/dist/devices-matter/LeakSensorAccessory.js.map +0 -1
  272. package/dist/devices-matter/LightSensorAccessory.d.ts +0 -12
  273. package/dist/devices-matter/LightSensorAccessory.d.ts.map +0 -1
  274. package/dist/devices-matter/LightSensorAccessory.js +0 -34
  275. package/dist/devices-matter/LightSensorAccessory.js.map +0 -1
  276. package/dist/devices-matter/OccupancySensorAccessory.d.ts +0 -12
  277. package/dist/devices-matter/OccupancySensorAccessory.d.ts.map +0 -1
  278. package/dist/devices-matter/OccupancySensorAccessory.js +0 -39
  279. package/dist/devices-matter/OccupancySensorAccessory.js.map +0 -1
  280. package/dist/devices-matter/OnOffLightAccessory.d.ts +0 -38
  281. package/dist/devices-matter/OnOffLightAccessory.d.ts.map +0 -1
  282. package/dist/devices-matter/OnOffLightAccessory.js +0 -110
  283. package/dist/devices-matter/OnOffLightAccessory.js.map +0 -1
  284. package/dist/devices-matter/OnOffOutletAccessory.d.ts +0 -14
  285. package/dist/devices-matter/OnOffOutletAccessory.d.ts.map +0 -1
  286. package/dist/devices-matter/OnOffOutletAccessory.js +0 -43
  287. package/dist/devices-matter/OnOffOutletAccessory.js.map +0 -1
  288. package/dist/devices-matter/OnOffSwitchAccessory.d.ts +0 -14
  289. package/dist/devices-matter/OnOffSwitchAccessory.d.ts.map +0 -1
  290. package/dist/devices-matter/OnOffSwitchAccessory.js +0 -42
  291. package/dist/devices-matter/OnOffSwitchAccessory.js.map +0 -1
  292. package/dist/devices-matter/RoboticVacuumAccessory.d.ts +0 -61
  293. package/dist/devices-matter/RoboticVacuumAccessory.d.ts.map +0 -1
  294. package/dist/devices-matter/RoboticVacuumAccessory.js +0 -544
  295. package/dist/devices-matter/RoboticVacuumAccessory.js.map +0 -1
  296. package/dist/devices-matter/SmokeCOAlarmAccessory.d.ts +0 -11
  297. package/dist/devices-matter/SmokeCOAlarmAccessory.d.ts.map +0 -1
  298. package/dist/devices-matter/SmokeCOAlarmAccessory.js +0 -49
  299. package/dist/devices-matter/SmokeCOAlarmAccessory.js.map +0 -1
  300. package/dist/devices-matter/TemperatureSensorAccessory.d.ts +0 -12
  301. package/dist/devices-matter/TemperatureSensorAccessory.d.ts.map +0 -1
  302. package/dist/devices-matter/TemperatureSensorAccessory.js +0 -36
  303. package/dist/devices-matter/TemperatureSensorAccessory.js.map +0 -1
  304. package/dist/devices-matter/ThermostatAccessory.d.ts +0 -19
  305. package/dist/devices-matter/ThermostatAccessory.d.ts.map +0 -1
  306. package/dist/devices-matter/ThermostatAccessory.js +0 -95
  307. package/dist/devices-matter/ThermostatAccessory.js.map +0 -1
  308. package/dist/devices-matter/VenetianBlindAccessory.d.ts +0 -19
  309. package/dist/devices-matter/VenetianBlindAccessory.d.ts.map +0 -1
  310. package/dist/devices-matter/VenetianBlindAccessory.js +0 -99
  311. package/dist/devices-matter/VenetianBlindAccessory.js.map +0 -1
  312. package/dist/devices-matter/WindowBlindAccessory.d.ts +0 -17
  313. package/dist/devices-matter/WindowBlindAccessory.d.ts.map +0 -1
  314. package/dist/devices-matter/WindowBlindAccessory.js +0 -131
  315. package/dist/devices-matter/WindowBlindAccessory.js.map +0 -1
  316. package/dist/devices-matter/custom/PowerStripAccessory.d.ts +0 -97
  317. package/dist/devices-matter/custom/PowerStripAccessory.d.ts.map +0 -1
  318. package/dist/devices-matter/custom/PowerStripAccessory.js +0 -265
  319. package/dist/devices-matter/custom/PowerStripAccessory.js.map +0 -1
  320. package/dist/devices-matter/custom/index.d.ts +0 -8
  321. package/dist/devices-matter/custom/index.d.ts.map +0 -1
  322. package/dist/devices-matter/custom/index.js +0 -8
  323. package/dist/devices-matter/custom/index.js.map +0 -1
  324. package/dist/devices-matter/index.d.ts +0 -29
  325. package/dist/devices-matter/index.d.ts.map +0 -1
  326. package/dist/devices-matter/index.js +0 -28
  327. package/dist/devices-matter/index.js.map +0 -1
  328. package/dist/irdevice/airconditioner.d.ts +0 -61
  329. package/dist/irdevice/airconditioner.d.ts.map +0 -1
  330. package/dist/irdevice/airconditioner.js +0 -472
  331. package/dist/irdevice/airconditioner.js.map +0 -1
  332. package/dist/irdevice/airpurifier.d.ts +0 -50
  333. package/dist/irdevice/airpurifier.d.ts.map +0 -1
  334. package/dist/irdevice/airpurifier.js +0 -213
  335. package/dist/irdevice/airpurifier.js.map +0 -1
  336. package/dist/irdevice/camera.d.ts +0 -32
  337. package/dist/irdevice/camera.d.ts.map +0 -1
  338. package/dist/irdevice/camera.js +0 -107
  339. package/dist/irdevice/camera.js.map +0 -1
  340. package/dist/irdevice/fan.d.ts +0 -36
  341. package/dist/irdevice/fan.d.ts.map +0 -1
  342. package/dist/irdevice/fan.js +0 -200
  343. package/dist/irdevice/fan.js.map +0 -1
  344. package/dist/irdevice/irdevice.d.ts +0 -69
  345. package/dist/irdevice/irdevice.d.ts.map +0 -1
  346. package/dist/irdevice/irdevice.js +0 -339
  347. package/dist/irdevice/irdevice.js.map +0 -1
  348. package/dist/irdevice/light.d.ts +0 -36
  349. package/dist/irdevice/light.d.ts.map +0 -1
  350. package/dist/irdevice/light.js +0 -206
  351. package/dist/irdevice/light.js.map +0 -1
  352. package/dist/irdevice/other.d.ts +0 -57
  353. package/dist/irdevice/other.d.ts.map +0 -1
  354. package/dist/irdevice/other.js +0 -778
  355. package/dist/irdevice/other.js.map +0 -1
  356. package/dist/irdevice/tv.d.ts +0 -45
  357. package/dist/irdevice/tv.d.ts.map +0 -1
  358. package/dist/irdevice/tv.js +0 -327
  359. package/dist/irdevice/tv.js.map +0 -1
  360. package/dist/irdevice/vacuumcleaner.d.ts +0 -28
  361. package/dist/irdevice/vacuumcleaner.d.ts.map +0 -1
  362. package/dist/irdevice/vacuumcleaner.js +0 -104
  363. package/dist/irdevice/vacuumcleaner.js.map +0 -1
  364. package/dist/irdevice/waterheater.d.ts +0 -30
  365. package/dist/irdevice/waterheater.d.ts.map +0 -1
  366. package/dist/irdevice/waterheater.js +0 -105
  367. package/dist/irdevice/waterheater.js.map +0 -1
  368. package/dist/platform-hap.d.ts +0 -160
  369. package/dist/platform-hap.d.ts.map +0 -1
  370. package/dist/platform-hap.js +0 -3041
  371. package/dist/platform-hap.js.map +0 -1
  372. package/dist/platform-matter.d.ts +0 -188
  373. package/dist/platform-matter.d.ts.map +0 -1
  374. package/dist/platform-matter.js +0 -2545
  375. package/dist/platform-matter.js.map +0 -1
  376. package/dist/test/apiRequestTracker.test.d.ts +0 -2
  377. package/dist/test/apiRequestTracker.test.d.ts.map +0 -1
  378. package/dist/test/apiRequestTracker.test.js +0 -392
  379. package/dist/test/apiRequestTracker.test.js.map +0 -1
  380. package/dist/test/hap/device-webhook-context.test.d.ts +0 -2
  381. package/dist/test/hap/device-webhook-context.test.d.ts.map +0 -1
  382. package/dist/test/hap/device-webhook-context.test.js +0 -128
  383. package/dist/test/hap/device-webhook-context.test.js.map +0 -1
  384. package/dist/test/hap/platform-hap.logging.test.d.ts +0 -2
  385. package/dist/test/hap/platform-hap.logging.test.d.ts.map +0 -1
  386. package/dist/test/hap/platform-hap.logging.test.js +0 -33
  387. package/dist/test/hap/platform-hap.logging.test.js.map +0 -1
  388. package/dist/test/hap/platform-hap.test.d.ts +0 -2
  389. package/dist/test/hap/platform-hap.test.d.ts.map +0 -1
  390. package/dist/test/hap/platform-hap.test.js +0 -62
  391. package/dist/test/hap/platform-hap.test.js.map +0 -1
  392. package/dist/test/helpers/platform-fixtures.d.ts +0 -9
  393. package/dist/test/helpers/platform-fixtures.d.ts.map +0 -1
  394. package/dist/test/helpers/platform-fixtures.js +0 -30
  395. package/dist/test/helpers/platform-fixtures.js.map +0 -1
  396. package/dist/test/homebridge-ui/server.test.d.ts +0 -2
  397. package/dist/test/homebridge-ui/server.test.d.ts.map +0 -1
  398. package/dist/test/homebridge-ui/server.test.js +0 -445
  399. package/dist/test/homebridge-ui/server.test.js.map +0 -1
  400. package/dist/test/index.test.d.ts +0 -2
  401. package/dist/test/index.test.d.ts.map +0 -1
  402. package/dist/test/index.test.js +0 -19
  403. package/dist/test/index.test.js.map +0 -1
  404. package/dist/test/matter/devices-matter/baseMatterAccessory.test.d.ts +0 -2
  405. package/dist/test/matter/devices-matter/baseMatterAccessory.test.d.ts.map +0 -1
  406. package/dist/test/matter/devices-matter/baseMatterAccessory.test.js +0 -71
  407. package/dist/test/matter/devices-matter/baseMatterAccessory.test.js.map +0 -1
  408. package/dist/test/matter/platform-matter.additional.test.d.ts +0 -2
  409. package/dist/test/matter/platform-matter.additional.test.d.ts.map +0 -1
  410. package/dist/test/matter/platform-matter.additional.test.js +0 -35
  411. package/dist/test/matter/platform-matter.additional.test.js.map +0 -1
  412. package/dist/test/matter/platform-matter.bleparse.test.d.ts +0 -2
  413. package/dist/test/matter/platform-matter.bleparse.test.d.ts.map +0 -1
  414. package/dist/test/matter/platform-matter.bleparse.test.js +0 -43
  415. package/dist/test/matter/platform-matter.bleparse.test.js.map +0 -1
  416. package/dist/test/matter/platform-matter.cleanup.test.d.ts +0 -2
  417. package/dist/test/matter/platform-matter.cleanup.test.d.ts.map +0 -1
  418. package/dist/test/matter/platform-matter.cleanup.test.js +0 -70
  419. package/dist/test/matter/platform-matter.cleanup.test.js.map +0 -1
  420. package/dist/test/matter/platform-matter.keepstale.test.d.ts +0 -2
  421. package/dist/test/matter/platform-matter.keepstale.test.d.ts.map +0 -1
  422. package/dist/test/matter/platform-matter.keepstale.test.js +0 -27
  423. package/dist/test/matter/platform-matter.keepstale.test.js.map +0 -1
  424. package/dist/test/matter/platform-matter.logging.test.d.ts +0 -2
  425. package/dist/test/matter/platform-matter.logging.test.d.ts.map +0 -1
  426. package/dist/test/matter/platform-matter.logging.test.js +0 -29
  427. package/dist/test/matter/platform-matter.logging.test.js.map +0 -1
  428. package/dist/test/matter/platform-matter.mapping.test.d.ts +0 -2
  429. package/dist/test/matter/platform-matter.mapping.test.d.ts.map +0 -1
  430. package/dist/test/matter/platform-matter.mapping.test.js +0 -43
  431. package/dist/test/matter/platform-matter.mapping.test.js.map +0 -1
  432. package/dist/test/matter/platform-matter.openapi-mapping.test.d.ts +0 -2
  433. package/dist/test/matter/platform-matter.openapi-mapping.test.d.ts.map +0 -1
  434. package/dist/test/matter/platform-matter.openapi-mapping.test.js +0 -84
  435. package/dist/test/matter/platform-matter.openapi-mapping.test.js.map +0 -1
  436. package/dist/test/matter/platform-matter.test.d.ts +0 -2
  437. package/dist/test/matter/platform-matter.test.d.ts.map +0 -1
  438. package/dist/test/matter/platform-matter.test.js +0 -117
  439. package/dist/test/matter/platform-matter.test.js.map +0 -1
  440. package/dist/test/matter/platform-matter.unregister.test.d.ts +0 -2
  441. package/dist/test/matter/platform-matter.unregister.test.d.ts.map +0 -1
  442. package/dist/test/matter/platform-matter.unregister.test.js +0 -30
  443. package/dist/test/matter/platform-matter.unregister.test.js.map +0 -1
  444. package/dist/test/matter/platform-matter.webhook.test.d.ts +0 -2
  445. package/dist/test/matter/platform-matter.webhook.test.d.ts.map +0 -1
  446. package/dist/test/matter/platform-matter.webhook.test.js +0 -46
  447. package/dist/test/matter/platform-matter.webhook.test.js.map +0 -1
  448. package/dist/test/utils.test.d.ts +0 -2
  449. package/dist/test/utils.test.d.ts.map +0 -1
  450. package/dist/test/utils.test.js +0 -95
  451. package/dist/test/utils.test.js.map +0 -1
  452. package/dist/test/verifyconfig.test.d.ts +0 -2
  453. package/dist/test/verifyconfig.test.d.ts.map +0 -1
  454. package/dist/test/verifyconfig.test.js +0 -167
  455. package/dist/test/verifyconfig.test.js.map +0 -1
  456. package/src/custom.d.ts +0 -7
  457. package/src/devices-hap/airpurifier.ts +0 -568
  458. package/src/devices-hap/blindtilt.ts +0 -1049
  459. package/src/devices-hap/bot.ts +0 -910
  460. package/src/devices-hap/ceilinglight.ts +0 -747
  461. package/src/devices-hap/colorbulb.ts +0 -940
  462. package/src/devices-hap/contact.ts +0 -457
  463. package/src/devices-hap/curtain.ts +0 -944
  464. package/src/devices-hap/device.ts +0 -890
  465. package/src/devices-hap/fan.ts +0 -716
  466. package/src/devices-hap/hub.ts +0 -440
  467. package/src/devices-hap/humidifier.ts +0 -762
  468. package/src/devices-hap/iosensor.ts +0 -442
  469. package/src/devices-hap/lightstrip.ts +0 -863
  470. package/src/devices-hap/lock.ts +0 -627
  471. package/src/devices-hap/meter.ts +0 -427
  472. package/src/devices-hap/meterplus.ts +0 -431
  473. package/src/devices-hap/meterpro.ts +0 -523
  474. package/src/devices-hap/motion.ts +0 -390
  475. package/src/devices-hap/plug.ts +0 -427
  476. package/src/devices-hap/relayswitch.ts +0 -727
  477. package/src/devices-hap/robotvacuumcleaner.ts +0 -574
  478. package/src/devices-hap/waterdetector.ts +0 -400
  479. package/src/devices-matter/BaseMatterAccessory.ts +0 -302
  480. package/src/devices-matter/ColorLightAccessory.ts +0 -110
  481. package/src/devices-matter/ColorTemperatureLightAccessory.ts +0 -90
  482. package/src/devices-matter/ContactSensorAccessory.ts +0 -41
  483. package/src/devices-matter/DimmableLightAccessory.ts +0 -192
  484. package/src/devices-matter/DoorLockAccessory.ts +0 -60
  485. package/src/devices-matter/ExtendedColorLightAccessory.ts +0 -122
  486. package/src/devices-matter/FanAccessory.ts +0 -95
  487. package/src/devices-matter/HumiditySensorAccessory.ts +0 -41
  488. package/src/devices-matter/LeakSensorAccessory.ts +0 -40
  489. package/src/devices-matter/LightSensorAccessory.ts +0 -41
  490. package/src/devices-matter/OccupancySensorAccessory.ts +0 -48
  491. package/src/devices-matter/OnOffLightAccessory.ts +0 -125
  492. package/src/devices-matter/OnOffOutletAccessory.ts +0 -51
  493. package/src/devices-matter/OnOffSwitchAccessory.ts +0 -51
  494. package/src/devices-matter/RoboticVacuumAccessory.ts +0 -621
  495. package/src/devices-matter/SmokeCOAlarmAccessory.ts +0 -59
  496. package/src/devices-matter/TemperatureSensorAccessory.ts +0 -43
  497. package/src/devices-matter/ThermostatAccessory.ts +0 -110
  498. package/src/devices-matter/VenetianBlindAccessory.ts +0 -115
  499. package/src/devices-matter/WindowBlindAccessory.ts +0 -135
  500. package/src/devices-matter/custom/PowerStripAccessory.ts +0 -309
  501. package/src/devices-matter/custom/index.ts +0 -8
  502. package/src/devices-matter/index.ts +0 -29
  503. package/src/irdevice/airconditioner.ts +0 -533
  504. package/src/irdevice/airpurifier.ts +0 -252
  505. package/src/irdevice/camera.ts +0 -129
  506. package/src/irdevice/fan.ts +0 -226
  507. package/src/irdevice/irdevice.ts +0 -383
  508. package/src/irdevice/light.ts +0 -246
  509. package/src/irdevice/other.ts +0 -790
  510. package/src/irdevice/tv.ts +0 -378
  511. package/src/irdevice/vacuumcleaner.ts +0 -126
  512. package/src/irdevice/waterheater.ts +0 -127
  513. package/src/platform-hap.ts +0 -3193
  514. package/src/platform-matter.ts +0 -2703
  515. package/src/test/apiRequestTracker.test.ts +0 -417
  516. package/src/test/hap/device-webhook-context.test.ts +0 -136
  517. package/src/test/hap/platform-hap.logging.test.ts +0 -36
  518. package/src/test/hap/platform-hap.test.ts +0 -70
  519. package/src/test/helpers/platform-fixtures.ts +0 -33
  520. package/src/test/homebridge-ui/server.test.ts +0 -486
  521. package/src/test/index.test.ts +0 -24
  522. package/src/test/matter/devices-matter/baseMatterAccessory.test.ts +0 -88
  523. package/src/test/matter/platform-matter.additional.test.ts +0 -44
  524. package/src/test/matter/platform-matter.bleparse.test.ts +0 -47
  525. package/src/test/matter/platform-matter.cleanup.test.ts +0 -86
  526. package/src/test/matter/platform-matter.keepstale.test.ts +0 -37
  527. package/src/test/matter/platform-matter.logging.test.ts +0 -33
  528. package/src/test/matter/platform-matter.mapping.test.ts +0 -57
  529. package/src/test/matter/platform-matter.openapi-mapping.test.ts +0 -109
  530. package/src/test/matter/platform-matter.test.ts +0 -144
  531. package/src/test/matter/platform-matter.unregister.test.ts +0 -39
  532. package/src/test/matter/platform-matter.webhook.test.ts +0 -54
  533. package/src/test/utils.test.ts +0 -96
  534. package/src/test/verifyconfig.test.ts +0 -198
@@ -1,383 +0,0 @@
1
- /* Copyright(C) 2021-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
2
- *
3
- * irdevice.ts: @switchbot/homebridge-switchbot.
4
- */
5
- import type { API, CharacteristicValue, HAP, Logging, PlatformAccessory, Service } from 'homebridge'
6
- import type { bodyChange, irdevice } from 'node-switchbot'
7
-
8
- import type { SwitchBotHAPPlatform } from '../platform-hap.js'
9
- import type { irAirConfig, irDevicesConfig, irFanConfig, irLightConfig, irOtherConfig, SwitchBotPlatformConfig } from '../settings.js'
10
-
11
- export abstract class irdeviceBase {
12
- public readonly api: API
13
- public readonly log: Logging
14
- public readonly config!: SwitchBotPlatformConfig
15
- protected readonly hap: HAP
16
-
17
- // Config
18
- protected deviceLogging!: string
19
- protected deviceRefreshRate!: number
20
- protected deviceUpdateRate!: number
21
- protected devicePushRate!: number
22
- protected deviceMaxRetries!: number
23
- protected deviceDelayBetweenRetries!: number
24
- protected deviceDisablePushOn!: boolean
25
- protected deviceDisablePushOff!: boolean
26
- protected deviceDisablePushDetail?: boolean
27
-
28
- constructor(
29
- protected readonly platform: SwitchBotHAPPlatform,
30
- protected accessory: PlatformAccessory,
31
- protected device: irdevice & irDevicesConfig,
32
- ) {
33
- this.api = this.platform.api
34
- this.log = this.platform.log
35
- this.config = this.platform.config
36
- this.hap = this.api.hap
37
-
38
- this.getDeviceLogSettings(accessory, device)
39
- this.getDeviceRateSettings(device)
40
- this.getDeviceConfigSettings(device)
41
- this.getDeviceContext(accessory, device)
42
-
43
- // Set accessory information
44
- accessory
45
- .getService(this.hap.Service.AccessoryInformation)!
46
- .setCharacteristic(this.hap.Characteristic.Manufacturer, 'SwitchBot')
47
- .setCharacteristic(this.hap.Characteristic.AppMatchingIdentifier, 'id1087374760')
48
- .setCharacteristic(this.hap.Characteristic.Name, accessory.displayName)
49
- .setCharacteristic(this.hap.Characteristic.ConfiguredName, accessory.displayName)
50
- .setCharacteristic(this.hap.Characteristic.Model, accessory.context.model ?? 'Unknown')
51
- .setCharacteristic(this.hap.Characteristic.ProductData, device.deviceId)
52
- .setCharacteristic(this.hap.Characteristic.SerialNumber, device.deviceId)
53
- }
54
-
55
- async getDeviceLogSettings(accessory: PlatformAccessory, device: irdevice & irDevicesConfig): Promise<void> {
56
- this.deviceLogging = this.platform.debugMode ? 'debugMode' : device.logging ?? this.platform.platformLogging ?? 'standard'
57
- const logging = this.platform.debugMode ? 'Debug Mode' : device.logging ? 'Device Config' : this.platform.platformLogging ? 'Platform Config' : 'Default'
58
- accessory.context.deviceLogging = this.deviceLogging
59
- this.debugLog(`Using ${logging} Logging: ${this.deviceLogging}`)
60
- }
61
-
62
- async getDeviceRateSettings(device: irdevice & irDevicesConfig): Promise<void> {
63
- // refreshRate
64
- this.deviceRefreshRate = device.refreshRate ?? this.platform.platformRefreshRate ?? 300
65
- const refreshRate = device.refreshRate ? 'Device Config' : this.platform.platformRefreshRate ? 'Platform Config' : 'Default'
66
- this.accessory.context.refreshRate = this.deviceRefreshRate
67
- // updateRate
68
- this.deviceUpdateRate = device.updateRate ?? this.platform.platformUpdateRate ?? 5
69
- const updateRate = device.updateRate ? 'Device Config' : this.platform.platformUpdateRate ? 'Platform Config' : 'Default'
70
- this.accessory.context.updateRate = this.deviceUpdateRate
71
- // pushRate
72
- this.devicePushRate = device.pushRate ?? this.platform.platformPushRate ?? 0.1
73
- const pushRate = device.pushRate ? 'Device Config' : this.platform.platformPushRate ? 'Platform Config' : 'Default'
74
- this.accessory.context.pushRate = this.devicePushRate
75
- this.debugLog(`Using ${refreshRate} refreshRate: ${this.deviceRefreshRate}, ${updateRate} updateRate: ${this.deviceUpdateRate}, ${pushRate} pushRate: ${this.devicePushRate}`)
76
- // maxRetries
77
- this.deviceMaxRetries = device.maxRetries ?? this.platform.platformMaxRetries ?? 2
78
- const maxRetries = device.maxRetries ? 'Device' : this.platform.platformMaxRetries ? 'Platform' : 'Default'
79
- this.debugLog(`Using ${maxRetries} Max Retries: ${this.deviceMaxRetries}`)
80
- // delayBetweenRetries
81
- this.deviceDelayBetweenRetries = device.delayBetweenRetries ? (device.delayBetweenRetries * 1000) : this.platform.platformDelayBetweenRetries ?? 3000
82
- const delayBetweenRetries = device.delayBetweenRetries ? 'Device' : this.platform.platformDelayBetweenRetries ? 'Platform' : 'Default'
83
- this.debugLog(`Using ${delayBetweenRetries} Delay Between Retries: ${this.deviceDelayBetweenRetries}`)
84
-
85
- // disablePushOn
86
- this.deviceDisablePushOn = device.disablePushOn ?? false
87
- const disablePushOn = device.disablePushOn ? 'Device Config' : 'Default'
88
- // disablePushOff
89
- this.deviceDisablePushOff = device.disablePushOff ?? false
90
- const disablePushOff = device.disablePushOff ? 'Device Config' : 'Default'
91
- // disablePushDetail
92
- this.deviceDisablePushDetail = device.disablePushDetail ?? false
93
- const disablePushDetail = device.disablePushDetail ? 'Device Config' : 'Default'
94
- this.debugLog(`Using ${disablePushOn} Disable Push On: ${this.deviceDisablePushOn}, ${disablePushOff} Disable Push Off: ${this.deviceDisablePushOff}, ${disablePushDetail} Disable Push Detail: ${this.deviceDisablePushDetail}`)
95
- }
96
-
97
- async getDeviceConfigSettings(device: irdevice & irDevicesConfig): Promise<void> {
98
- const deviceConfig = Object.assign(
99
- {},
100
- device.logging !== 'standard' && { logging: device.logging },
101
- device.connectionType !== '' && { connectionType: device.connectionType },
102
- device.external === true && { external: device.external },
103
- device.customize === true && { customize: device.customize },
104
- device.commandType !== '' && { commandType: device.commandType },
105
- device.customOn !== '' && { customOn: device.customOn },
106
- device.customOff !== '' && { customOff: device.customOff },
107
- device.disablePushOn === true && { disablePushOn: device.disablePushOn },
108
- device.disablePushOff === true && { disablePushOff: device.disablePushOff },
109
- device.disablePushDetail === true && { disablePushDetail: device.disablePushDetail },
110
- )
111
- let deviceSpecificConfig = {}
112
- switch (device.configRemoteType) {
113
- case 'Fan':
114
- case 'DIY Fan':
115
- deviceSpecificConfig = device as irFanConfig
116
- break
117
- case 'Light':
118
- case 'DIY Light':
119
- deviceSpecificConfig = device as irLightConfig
120
- break
121
- case 'Air Conditioner':
122
- case 'DIY Air Conditioner':
123
- deviceSpecificConfig = device as irAirConfig
124
- break
125
- case 'Others':
126
- deviceSpecificConfig = device as irOtherConfig
127
- break
128
- default:
129
- break
130
- }
131
- const config = Object.assign(
132
- {},
133
- deviceConfig,
134
- deviceSpecificConfig,
135
- )
136
- if (Object.keys(config).length !== 0) {
137
- this.debugSuccessLog(`Config: ${JSON.stringify(config)}`)
138
- }
139
- }
140
-
141
- async getDeviceContext(accessory: PlatformAccessory, device: irdevice & irDevicesConfig): Promise<void> {
142
- accessory.context.name = device.deviceName
143
- accessory.context.model = device.remoteType
144
- accessory.context.deviceId = device.deviceId
145
- accessory.context.remoteType = device.remoteType
146
-
147
- const deviceFirmwareVersion = device.firmware ?? accessory.context.version ?? this.platform.version ?? '0.0.0'
148
- const version = deviceFirmwareVersion.toString()
149
- this.debugLog(`version: ${version?.replace(/^V|-.*$/g, '')}`)
150
- let deviceVersion: string
151
- if (version?.includes('.') === false) {
152
- const replace = version?.replace(/^V|-.*$/g, '')
153
- const match = replace?.match(/./g)
154
- const validVersion = match?.join('.')
155
- deviceVersion = validVersion ?? '0.0.0'
156
- } else {
157
- deviceVersion = version.replace(/^V|-.*$/g, '') ?? '0.0.0'
158
- }
159
- accessory
160
- .getService(this.hap.Service.AccessoryInformation)!
161
- .setCharacteristic(this.hap.Characteristic.HardwareRevision, deviceVersion)
162
- .setCharacteristic(this.hap.Characteristic.SoftwareRevision, deviceVersion)
163
- .setCharacteristic(this.hap.Characteristic.FirmwareRevision, deviceVersion)
164
- .getCharacteristic(this.hap.Characteristic.FirmwareRevision)
165
- .updateValue(deviceVersion)
166
- accessory.context.version = deviceVersion
167
- this.debugSuccessLog(`version: ${accessory.context.version}`)
168
- }
169
-
170
- async pushChangeRequest(bodyChange: bodyChange): Promise<{ body: any, statusCode: number }> {
171
- const { response, statusCode } = await this.platform.retryCommand(this.device, bodyChange, this.deviceMaxRetries, this.deviceDelayBetweenRetries)
172
- return { body: response, statusCode }
173
- }
174
-
175
- async successfulStatusCodes(deviceStatus: any) {
176
- return (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)
177
- }
178
-
179
- /**
180
- * Update the characteristic value and log the change.
181
- *
182
- * @param Service Service
183
- * @param Characteristic Characteristic
184
- * @param CharacteristicValue CharacteristicValue | undefined
185
- * @param CharacteristicName string
186
- * @return: void
187
- *
188
- */
189
- async updateCharacteristic(Service: Service, Characteristic: any, CharacteristicValue: CharacteristicValue | undefined, CharacteristicName: string): Promise<void> {
190
- if (CharacteristicValue === undefined) {
191
- this.debugLog(`${CharacteristicName}: ${CharacteristicValue}`)
192
- } else {
193
- Service.updateCharacteristic(Characteristic, CharacteristicValue)
194
- this.debugLog(`updateCharacteristic ${CharacteristicName}: ${CharacteristicValue}`)
195
- this.debugWarnLog(`${CharacteristicName} context before: ${this.accessory.context[CharacteristicName]}`)
196
- this.accessory.context[CharacteristicName] = CharacteristicValue
197
- this.debugWarnLog(`${CharacteristicName} context after: ${this.accessory.context[CharacteristicName]}`)
198
- }
199
- }
200
-
201
- async pushStatusCodes<T extends { statusCode: number }>(deviceStatus: T) {
202
- this.debugWarnLog(`deviceStatus: ${JSON.stringify(deviceStatus)}`)
203
- this.debugWarnLog(`deviceStatus statusCode: ${deviceStatus.statusCode}`)
204
- }
205
-
206
- async successfulPushChange<T extends { statusCode: number }>(deviceStatus: T, bodyChange: any) {
207
- this.debugSuccessLog(`deviceStatus StatusCode: ${deviceStatus.statusCode}`)
208
- this.successLog(`request to SwitchBot API, body: ${JSON.stringify(bodyChange)} sent successfully`)
209
- }
210
-
211
- async pushChangeError(e: Error) {
212
- this.errorLog(`failed pushChanges with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
213
- }
214
-
215
- async commandType(): Promise<string> {
216
- let commandType: string
217
- if (this.device.commandType && this.device.customize) {
218
- commandType = this.device.commandType
219
- } else if (this.device.customize) {
220
- commandType = 'customize'
221
- } else {
222
- commandType = 'command'
223
- }
224
- return commandType
225
- }
226
-
227
- async commandOn(): Promise<string> {
228
- let command: string
229
- if (this.device.customize && this.device.customOn) {
230
- command = this.device.customOn
231
- } else {
232
- command = 'turnOn'
233
- }
234
- return command
235
- }
236
-
237
- async commandOff(): Promise<string> {
238
- let command: string
239
- if (this.device.customize && this.device.customOff) {
240
- command = this.device.customOff
241
- } else {
242
- command = 'turnOff'
243
- }
244
- return command
245
- }
246
-
247
- async statusCode(statusCode: number): Promise<void> {
248
- const statusMessages = {
249
- 151: 'Command not supported by this deviceType',
250
- 152: 'Device not found',
251
- 160: 'Command is not supported',
252
- 161: 'Device is offline',
253
- 171: `Hub Device is offline. Hub: ${this.device.hubDeviceId}`,
254
- 190: 'Device internal error due to device states not synchronized with server, or command format is invalid',
255
- 100: 'Command successfully sent',
256
- 200: 'Request successful',
257
- 400: 'Bad Request, an invalid payload request',
258
- 401: 'Unauthorized, Authorization for the API is required, but the request has not been authenticated',
259
- 403: 'Forbidden, The request has been authenticated but does not have appropriate permissions, or a requested resource is not found',
260
- 404: 'Not Found, Specifies the requested path does not exist',
261
- 406: 'Not Acceptable, a MIME type has been requested via the Accept header for a value not supported by the server',
262
- 415: 'Unsupported Media Type, a contentType header has been defined that is not supported by the server',
263
- 422: 'Unprocessable Entity: The server cannot process the request, often due to exceeded API limits.',
264
- 429: 'Too Many Requests, exceeded the number of requests allowed for a given time window',
265
- 500: 'Internal Server Error, An unexpected error occurred. These errors should be rare',
266
- }
267
- if (statusCode === 171 && (this.device.hubDeviceId === this.device.deviceId || this.device.hubDeviceId === '000000000000')) {
268
- this.debugErrorLog(`statusCode 171 changed to 161: hubDeviceId ${this.device.hubDeviceId} matches deviceId ${this.device.deviceId}, device is its own hub.`)
269
- statusCode = 161
270
- }
271
- const logMessage = statusMessages[statusCode] || `Unknown statusCode: ${statusCode}, Submit Bugs Here: https://tinyurl.com/SwitchBotBug`
272
- const logMethod = [100, 200].includes(statusCode) ? 'debugLog' : statusMessages[statusCode] ? 'errorLog' : 'infoLog'
273
- this[logMethod](`${logMessage}, statusCode: ${statusCode}`)
274
- }
275
-
276
- /**
277
- * Logging for Device
278
- */
279
- infoLog(...log: any[]): void {
280
- if (!this.enablingDeviceLogging()) {
281
- return
282
- }
283
- // Delegate to a single helper that prefers platform-provided loggers.
284
- this.logWith('info', `${this.device.remoteType}: ${this.accessory.displayName}`, undefined, String(...log))
285
- }
286
-
287
- successLog(...log: any[]): void {
288
- if (!this.enablingDeviceLogging()) {
289
- return
290
- }
291
- this.logWith('success', `${this.device.remoteType}: ${this.accessory.displayName}`, undefined, String(...log))
292
- }
293
-
294
- debugSuccessLog(...log: any[]): void {
295
- if (!this.enablingDeviceLogging()) {
296
- return
297
- }
298
- if (!this.loggingIsDebug()) {
299
- return
300
- }
301
- this.logWith('success', `[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, 'debugSuccessLog', String(...log))
302
- }
303
-
304
- warnLog(...log: any[]): void {
305
- if (!this.enablingDeviceLogging()) {
306
- return
307
- }
308
- this.logWith('warn', `${this.device.remoteType}: ${this.accessory.displayName}`, undefined, String(...log))
309
- }
310
-
311
- debugWarnLog(...log: any[]): void {
312
- if (!this.enablingDeviceLogging() || !this.loggingIsDebug()) {
313
- return
314
- }
315
- this.logWith('warn', `[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, 'debugWarnLog', String(...log))
316
- }
317
-
318
- errorLog(...log: any[]): void {
319
- if (!this.enablingDeviceLogging()) {
320
- return
321
- }
322
- this.logWith('error', `${this.device.remoteType}: ${this.accessory.displayName}`, undefined, String(...log))
323
- }
324
-
325
- debugErrorLog(...log: any[]): void {
326
- if (!this.enablingDeviceLogging() || !this.loggingIsDebug()) {
327
- return
328
- }
329
- this.logWith('error', `[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, 'debugErrorLog', String(...log))
330
- }
331
-
332
- debugLog(...log: any[]): void {
333
- if (!this.enablingDeviceLogging()) {
334
- return
335
- }
336
- if (this.deviceLogging === 'debug') {
337
- this.logWith('debug', `[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, 'debugLog', String(...log))
338
- } else if (this.deviceLogging === 'debugMode') {
339
- this.logWith('debug', `${this.device.remoteType}: ${this.accessory.displayName}`, 'debugLog', String(...log))
340
- }
341
- }
342
-
343
- // Generic platform/local logger delegate
344
- protected logWith(level: string, message: string, platformMethodName?: string, payload?: string): void {
345
- const method = platformMethodName ?? `${level}Log`
346
- const pFn = (this.platform as any)?.[method]
347
- if (typeof pFn === 'function') {
348
- try {
349
- if (payload !== undefined) {
350
- pFn(message, payload)
351
- } else {
352
- pFn(message)
353
- }
354
- return
355
- } catch (_err) {
356
- // fallthrough to local logger
357
- }
358
- }
359
- const map: Record<string, string> = {
360
- info: 'info',
361
- success: 'success',
362
- debug: 'debug',
363
- warn: 'warn',
364
- error: 'error',
365
- }
366
- const local = (this.log as any)[map[level] ?? level]
367
- if (typeof local === 'function') {
368
- if (payload !== undefined) {
369
- local.call(this.log, message, payload)
370
- } else {
371
- local.call(this.log, message)
372
- }
373
- }
374
- }
375
-
376
- loggingIsDebug(): boolean {
377
- return this.deviceLogging === 'debugMode' || this.deviceLogging === 'debug'
378
- }
379
-
380
- enablingDeviceLogging(): boolean {
381
- return this.deviceLogging === 'debugMode' || this.deviceLogging === 'debug' || this.deviceLogging === 'standard'
382
- }
383
- }
@@ -1,246 +0,0 @@
1
- /* Copyright(C) 2021-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
2
- *
3
- * light.ts: @switchbot/homebridge-switchbot.
4
- */
5
- import type { CharacteristicValue, PlatformAccessory, Service } from 'homebridge'
6
- import type { bodyChange, irdevice } from 'node-switchbot'
7
-
8
- import type { SwitchBotHAPPlatform } from '../platform-hap.js'
9
- import type { irDevicesConfig, irLightConfig } from '../settings.js'
10
-
11
- import { irdeviceBase } from './irdevice.js'
12
-
13
- /**
14
- * Platform Accessory
15
- * An instance of this class is created for each accessory your platform registers
16
- * Each accessory may expose multiple services of different service types.
17
- */
18
- export class Light extends irdeviceBase {
19
- // Services
20
- private LightBulb?: {
21
- Name: CharacteristicValue
22
- Service: Service
23
- On: CharacteristicValue
24
- }
25
-
26
- private ProgrammableSwitchOn?: {
27
- Name: CharacteristicValue
28
- Service: Service
29
- ProgrammableSwitchEvent: CharacteristicValue
30
- ProgrammableSwitchOutputState: CharacteristicValue
31
- }
32
-
33
- private ProgrammableSwitchOff?: {
34
- Name: CharacteristicValue
35
- Service: Service
36
- ProgrammableSwitchEvent: CharacteristicValue
37
- ProgrammableSwitchOutputState: CharacteristicValue
38
- }
39
-
40
- constructor(
41
- readonly platform: SwitchBotHAPPlatform,
42
- accessory: PlatformAccessory,
43
- device: irdevice & irDevicesConfig,
44
- ) {
45
- super(platform, accessory, device)
46
- // Set category
47
- accessory.category = this.hap.Categories.LIGHTBULB
48
-
49
- if (!(device as irLightConfig).stateless) {
50
- // Initialize LightBulb Service
51
- accessory.context.LightBulb = accessory.context.LightBulb ?? {}
52
- this.LightBulb = {
53
- Name: accessory.displayName,
54
- Service: accessory.getService(this.hap.Service.Lightbulb) ?? accessory.addService(this.hap.Service.Lightbulb) as Service,
55
- On: accessory.context.On || false,
56
- }
57
- accessory.context.LightBulb = this.LightBulb as object
58
-
59
- this.LightBulb.Service.setCharacteristic(this.hap.Characteristic.Name, this.LightBulb.Name).getCharacteristic(this.hap.Characteristic.On).onGet(() => {
60
- return this.LightBulb!.On
61
- }).onSet(this.OnSet.bind(this))
62
- } else {
63
- // Initialize ProgrammableSwitchOn Service
64
- accessory.context.ProgrammableSwitchOn = accessory.context.ProgrammableSwitchOn ?? {}
65
- this.ProgrammableSwitchOn = {
66
- Name: `${accessory.displayName} On`,
67
- Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch) ?? accessory.addService(this.hap.Service.StatefulProgrammableSwitch) as Service,
68
- ProgrammableSwitchEvent: accessory.context.ProgrammableSwitchEvent ?? this.hap.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS,
69
- ProgrammableSwitchOutputState: accessory.context.ProgrammableSwitchOutputState ?? 0,
70
- }
71
- accessory.context.ProgrammableSwitchOn = this.ProgrammableSwitchOn as object
72
-
73
- // Initialize ProgrammableSwitchOn Characteristics
74
- this.ProgrammableSwitchOn?.Service.setCharacteristic(this.hap.Characteristic.Name, this.ProgrammableSwitchOn.Name).getCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent).setProps({
75
- validValueRanges: [0, 0],
76
- minValue: 0,
77
- maxValue: 0,
78
- validValues: [0],
79
- }).onGet(() => {
80
- return this.ProgrammableSwitchOn!.ProgrammableSwitchEvent
81
- })
82
-
83
- this.ProgrammableSwitchOn?.Service.getCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState).onGet(() => {
84
- return this.ProgrammableSwitchOn!.ProgrammableSwitchOutputState
85
- }).onSet(this.ProgrammableSwitchOutputStateSetOn.bind(this))
86
-
87
- // Initialize ProgrammableSwitchOff Service
88
- accessory.context.ProgrammableSwitchOff = accessory.context.ProgrammableSwitchOff ?? {}
89
- this.ProgrammableSwitchOff = {
90
- Name: `${accessory.displayName} Off`,
91
- Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch) ?? accessory.addService(this.hap.Service.StatefulProgrammableSwitch) as Service,
92
- ProgrammableSwitchEvent: accessory.context.ProgrammableSwitchEvent ?? this.hap.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS,
93
- ProgrammableSwitchOutputState: accessory.context.ProgrammableSwitchOutputState ?? 0,
94
- }
95
- accessory.context.ProgrammableSwitchOff = this.ProgrammableSwitchOff as object
96
-
97
- // Initialize ProgrammableSwitchOff Characteristics
98
- this.ProgrammableSwitchOff?.Service.setCharacteristic(this.hap.Characteristic.Name, this.ProgrammableSwitchOff.Name).getCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent).setProps({
99
- validValueRanges: [0, 0],
100
- minValue: 0,
101
- maxValue: 0,
102
- validValues: [0],
103
- }).onGet(() => {
104
- return this.ProgrammableSwitchOff!.ProgrammableSwitchEvent
105
- })
106
-
107
- this.ProgrammableSwitchOff?.Service.getCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState).onGet(() => {
108
- return this.ProgrammableSwitchOff!.ProgrammableSwitchOutputState
109
- }).onSet(this.ProgrammableSwitchOutputStateSetOff.bind(this))
110
- }
111
- }
112
-
113
- async OnSet(value: CharacteristicValue): Promise<void> {
114
- this.debugLog(`On: ${value}`)
115
-
116
- this.LightBulb!.On = value
117
- if (this.LightBulb?.On) {
118
- const On = true
119
- await this.pushLightOnChanges(On)
120
- } else {
121
- const On = false
122
- await this.pushLightOffChanges(On)
123
- }
124
- /**
125
- * pushLightOnChanges and pushLightOffChanges above assume they are measuring the state of the accessory BEFORE
126
- * they are updated, so we are only updating the accessory state after calling the above.
127
- */
128
- }
129
-
130
- async ProgrammableSwitchOutputStateSetOn(value: CharacteristicValue): Promise<void> {
131
- this.debugLog(`On: ${value}`)
132
-
133
- this.ProgrammableSwitchOn!.ProgrammableSwitchOutputState = value
134
- if (this.ProgrammableSwitchOn?.ProgrammableSwitchOutputState === 1) {
135
- const On = true
136
- await this.pushLightOnChanges(On)
137
- }
138
- /**
139
- * pushLightOnChanges and pushLightOffChanges above assume they are measuring the state of the accessory BEFORE
140
- * they are updated, so we are only updating the accessory state after calling the above.
141
- */
142
- }
143
-
144
- async ProgrammableSwitchOutputStateSetOff(value: CharacteristicValue): Promise<void> {
145
- this.debugLog(`On: ${value}`)
146
-
147
- this.ProgrammableSwitchOff!.ProgrammableSwitchOutputState = value
148
- if (this.ProgrammableSwitchOff?.ProgrammableSwitchOutputState === 1) {
149
- const On = false
150
- await this.pushLightOffChanges(On)
151
- }
152
- /**
153
- * pushLightOnChanges and pushLightOffChanges above assume they are measuring the state of the accessory BEFORE
154
- * they are updated, so we are only updating the accessory state after calling the above.
155
- */
156
- }
157
-
158
- /**
159
- * Pushes the requested changes to the SwitchBot API
160
- * deviceType commandType Command command parameter Description
161
- * Light - "command" "turnOff" "default" = set to OFF state
162
- * Light - "command" "turnOn" "default" = set to ON state
163
- * Light - "command" "volumeAdd" "default" = volume up
164
- * Light - "command" "volumeSub" "default" = volume down
165
- * Light - "command" "channelAdd" "default" = next channel
166
- * Light - "command" "channelSub" "default" = previous channel
167
- */
168
- async pushLightOnChanges(On: boolean): Promise<void> {
169
- this.debugLog(`pushLightOnChanges On: ${On}, disablePushOn: ${this.deviceDisablePushOn}`)
170
- if (On === true && this.deviceDisablePushOn === false) {
171
- const commandType: string = await this.commandType()
172
- const command: string = await this.commandOn()
173
- const bodyChange: bodyChange = {
174
- command,
175
- parameter: 'default',
176
- commandType,
177
- }
178
- await this.pushChanges(bodyChange, On)
179
- }
180
- }
181
-
182
- async pushLightOffChanges(On: boolean): Promise<void> {
183
- this.debugLog(`pushLightOffChanges On: ${On}, disablePushOff: ${this.deviceDisablePushOff}`)
184
- if (On === false && this.deviceDisablePushOff === false) {
185
- const commandType: string = await this.commandType()
186
- const command: string = await this.commandOff()
187
- const bodyChange: bodyChange = {
188
- command,
189
- parameter: 'default',
190
- commandType,
191
- }
192
- await this.pushChanges(bodyChange, On)
193
- }
194
- }
195
-
196
- async pushChanges(bodyChange: any, On: boolean): Promise<void> {
197
- this.debugLog('pushChanges')
198
- if (this.device.connectionType === 'OpenAPI') {
199
- this.infoLog(`Sending request to SwitchBot API, body: ${JSON.stringify(bodyChange)}`)
200
- try {
201
- const deviceStatus = await this.pushChangeRequest(bodyChange)
202
- await this.pushStatusCodes(deviceStatus)
203
- if (await this.successfulStatusCodes(deviceStatus)) {
204
- await this.successfulPushChange(deviceStatus, bodyChange)
205
- this.accessory.context.On = On
206
- await this.updateHomeKitCharacteristics()
207
- } else {
208
- await this.statusCode(deviceStatus.statusCode)
209
- }
210
- } catch (e: any) {
211
- await this.apiError(e)
212
- await this.pushChangeError(e)
213
- }
214
- } else {
215
- this.warnLog(`Connection Type: ${this.device.connectionType}, commands will not be sent to OpenAPI`)
216
- }
217
- }
218
-
219
- async updateHomeKitCharacteristics(): Promise<void> {
220
- this.debugLog('updateHomeKitCharacteristics')
221
- if (!(this.device as irLightConfig).stateless && this.LightBulb?.Service) {
222
- // On
223
- await this.updateCharacteristic(this.LightBulb.Service, this.hap.Characteristic.On, this.LightBulb.On, 'On')
224
- } else {
225
- if (this.ProgrammableSwitchOn?.Service) {
226
- // On Stateful Programmable Switch
227
- await this.updateCharacteristic(this.ProgrammableSwitchOn.Service, this.hap.Characteristic.ProgrammableSwitchOutputState, this.ProgrammableSwitchOn.ProgrammableSwitchOutputState, 'ProgrammableSwitchOutputState')
228
- }
229
- if (this.ProgrammableSwitchOff?.Service) {
230
- // Off Stateful Programmable Switch
231
- await this.updateCharacteristic(this.ProgrammableSwitchOff.Service, this.hap.Characteristic.ProgrammableSwitchOutputState, this.ProgrammableSwitchOff.ProgrammableSwitchOutputState, 'ProgrammableSwitchOutputState')
232
- }
233
- }
234
- }
235
-
236
- async apiError(e: any): Promise<void> {
237
- if (!(this.device as irLightConfig).stateless) {
238
- this.LightBulb?.Service.updateCharacteristic(this.hap.Characteristic.On, e)
239
- } else {
240
- this.ProgrammableSwitchOn?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent, e)
241
- this.ProgrammableSwitchOn?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState, e)
242
- this.ProgrammableSwitchOff?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent, e)
243
- this.ProgrammableSwitchOff?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState, e)
244
- }
245
- }
246
- }