@switchbot/homebridge-switchbot 5.0.0-beta.99 → 5.1.0-beta.0

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 (281) hide show
  1. package/.changeset/config.json +14 -0
  2. package/.github/copilot-instructions.md +39 -0
  3. package/.github/workflows/ci.yml +4 -1
  4. package/.github/workflows/manual-e2e.yml +6 -3
  5. package/.github/workflows/release.yml +64 -15
  6. package/.github/workflows/stale.yml +2 -4
  7. package/.husky/pre-push +15 -0
  8. package/CHANGELOG.md +140 -135
  9. package/MIGRATION.md +21 -6
  10. package/README.md +109 -3
  11. package/TODO.md +263 -0
  12. package/config.schema.json +240 -36
  13. package/dist/SwitchBotHAPPlatform.d.ts +133 -0
  14. package/dist/SwitchBotHAPPlatform.d.ts.map +1 -0
  15. package/dist/SwitchBotHAPPlatform.js +584 -0
  16. package/dist/SwitchBotHAPPlatform.js.map +1 -0
  17. package/dist/SwitchBotMatterPlatform.d.ts +142 -0
  18. package/dist/SwitchBotMatterPlatform.d.ts.map +1 -0
  19. package/dist/SwitchBotMatterPlatform.js +569 -0
  20. package/dist/SwitchBotMatterPlatform.js.map +1 -0
  21. package/dist/device-types.d.ts +31 -0
  22. package/dist/device-types.d.ts.map +1 -0
  23. package/dist/device-types.js +246 -0
  24. package/dist/device-types.js.map +1 -0
  25. package/dist/deviceCommandMapper.d.ts +10 -0
  26. package/dist/deviceCommandMapper.d.ts.map +1 -0
  27. package/dist/deviceCommandMapper.js +319 -0
  28. package/dist/deviceCommandMapper.js.map +1 -0
  29. package/dist/deviceFactory.d.ts +3 -2
  30. package/dist/deviceFactory.d.ts.map +1 -1
  31. package/dist/deviceFactory.js +107 -29
  32. package/dist/deviceFactory.js.map +1 -1
  33. package/dist/devices/genericDevice.d.ts +59 -37
  34. package/dist/devices/genericDevice.d.ts.map +1 -1
  35. package/dist/devices/genericDevice.js +376 -78
  36. package/dist/devices/genericDevice.js.map +1 -1
  37. package/dist/errors.d.ts +38 -0
  38. package/dist/errors.d.ts.map +1 -0
  39. package/dist/errors.js +32 -0
  40. package/dist/errors.js.map +1 -0
  41. package/dist/homebridge-ui/device-types.js +246 -0
  42. package/dist/homebridge-ui/device-types.js.map +1 -0
  43. package/dist/homebridge-ui/deviceCommandMapper.js +319 -0
  44. package/dist/homebridge-ui/deviceCommandMapper.js.map +1 -0
  45. package/dist/homebridge-ui/endpoints/config.d.ts +3 -0
  46. package/dist/homebridge-ui/endpoints/config.d.ts.map +1 -0
  47. package/dist/homebridge-ui/endpoints/config.js +90 -0
  48. package/dist/homebridge-ui/endpoints/config.js.map +1 -0
  49. package/dist/homebridge-ui/endpoints/devices.d.ts +6 -0
  50. package/dist/homebridge-ui/endpoints/devices.d.ts.map +1 -0
  51. package/dist/homebridge-ui/endpoints/devices.js +144 -0
  52. package/dist/homebridge-ui/endpoints/devices.js.map +1 -0
  53. package/dist/homebridge-ui/endpoints/discovery.d.ts +7 -0
  54. package/dist/homebridge-ui/endpoints/discovery.d.ts.map +1 -0
  55. package/dist/homebridge-ui/endpoints/discovery.js +219 -0
  56. package/dist/homebridge-ui/endpoints/discovery.js.map +1 -0
  57. package/dist/homebridge-ui/errors.js +32 -0
  58. package/dist/homebridge-ui/errors.js.map +1 -0
  59. package/dist/homebridge-ui/homebridge-ui/endpoints/config.js +90 -0
  60. package/dist/homebridge-ui/homebridge-ui/endpoints/config.js.map +1 -0
  61. package/dist/homebridge-ui/homebridge-ui/endpoints/devices.js +144 -0
  62. package/dist/homebridge-ui/homebridge-ui/endpoints/devices.js.map +1 -0
  63. package/dist/homebridge-ui/homebridge-ui/endpoints/discovery.js +219 -0
  64. package/dist/homebridge-ui/homebridge-ui/endpoints/discovery.js.map +1 -0
  65. package/dist/homebridge-ui/homebridge-ui/server.js +11 -0
  66. package/dist/homebridge-ui/homebridge-ui/server.js.map +1 -0
  67. package/dist/homebridge-ui/homebridge-ui/utils/config-parser.js +108 -0
  68. package/dist/homebridge-ui/homebridge-ui/utils/config-parser.js.map +1 -0
  69. package/dist/homebridge-ui/homebridge-ui/utils/device-migration.js +111 -0
  70. package/dist/homebridge-ui/homebridge-ui/utils/device-migration.js.map +1 -0
  71. package/dist/homebridge-ui/homebridge-ui/utils/logger.js +17 -0
  72. package/dist/homebridge-ui/homebridge-ui/utils/logger.js.map +1 -0
  73. package/dist/homebridge-ui/public/css/styles.css +483 -0
  74. package/dist/homebridge-ui/public/index.html +197 -621
  75. package/dist/homebridge-ui/public/js/advanced-settings.d.ts +3 -0
  76. package/dist/homebridge-ui/public/js/advanced-settings.d.ts.map +1 -0
  77. package/dist/homebridge-ui/public/js/advanced-settings.js +95 -0
  78. package/dist/homebridge-ui/public/js/advanced-settings.js.map +1 -0
  79. package/dist/homebridge-ui/public/js/advanced-settings.ts +94 -0
  80. package/dist/homebridge-ui/public/js/api.d.ts +72 -0
  81. package/dist/homebridge-ui/public/js/api.d.ts.map +1 -0
  82. package/dist/homebridge-ui/public/js/api.js +313 -0
  83. package/dist/homebridge-ui/public/js/api.js.map +1 -0
  84. package/dist/homebridge-ui/public/js/api.ts +385 -0
  85. package/dist/homebridge-ui/public/js/app.d.ts +2 -0
  86. package/dist/homebridge-ui/public/js/app.d.ts.map +1 -0
  87. package/dist/homebridge-ui/public/js/app.js +3798 -0
  88. package/dist/homebridge-ui/public/js/app.js.map +7 -0
  89. package/dist/homebridge-ui/public/js/app.ts +22 -0
  90. package/dist/homebridge-ui/public/js/constants.d.ts +2 -0
  91. package/dist/homebridge-ui/public/js/constants.d.ts.map +1 -0
  92. package/dist/homebridge-ui/public/js/constants.js +2 -0
  93. package/dist/homebridge-ui/public/js/constants.js.map +1 -0
  94. package/dist/homebridge-ui/public/js/constants.ts +1 -0
  95. package/dist/homebridge-ui/public/js/credentials.d.ts +3 -0
  96. package/dist/homebridge-ui/public/js/credentials.d.ts.map +1 -0
  97. package/dist/homebridge-ui/public/js/credentials.js +99 -0
  98. package/dist/homebridge-ui/public/js/credentials.js.map +1 -0
  99. package/dist/homebridge-ui/public/js/credentials.ts +105 -0
  100. package/dist/homebridge-ui/public/js/devices-delete.d.ts +3 -0
  101. package/dist/homebridge-ui/public/js/devices-delete.d.ts.map +1 -0
  102. package/dist/homebridge-ui/public/js/devices-delete.js +199 -0
  103. package/dist/homebridge-ui/public/js/devices-delete.js.map +1 -0
  104. package/dist/homebridge-ui/public/js/devices-delete.ts +227 -0
  105. package/dist/homebridge-ui/public/js/devices.d.ts +9 -0
  106. package/dist/homebridge-ui/public/js/devices.d.ts.map +1 -0
  107. package/dist/homebridge-ui/public/js/devices.js +104 -0
  108. package/dist/homebridge-ui/public/js/devices.js.map +1 -0
  109. package/dist/homebridge-ui/public/js/devices.ts +112 -0
  110. package/dist/homebridge-ui/public/js/discovery.d.ts +9 -0
  111. package/dist/homebridge-ui/public/js/discovery.d.ts.map +1 -0
  112. package/dist/homebridge-ui/public/js/discovery.js +1201 -0
  113. package/dist/homebridge-ui/public/js/discovery.js.map +1 -0
  114. package/dist/homebridge-ui/public/js/discovery.ts +1335 -0
  115. package/dist/homebridge-ui/public/js/logger.d.ts +7 -0
  116. package/dist/homebridge-ui/public/js/logger.d.ts.map +1 -0
  117. package/dist/homebridge-ui/public/js/logger.js +17 -0
  118. package/dist/homebridge-ui/public/js/logger.js.map +1 -0
  119. package/dist/homebridge-ui/public/js/logger.ts +17 -0
  120. package/dist/homebridge-ui/public/js/modal.d.ts +5 -0
  121. package/dist/homebridge-ui/public/js/modal.d.ts.map +1 -0
  122. package/dist/homebridge-ui/public/js/modal.js +35 -0
  123. package/dist/homebridge-ui/public/js/modal.js.map +1 -0
  124. package/dist/homebridge-ui/public/js/modal.ts +35 -0
  125. package/dist/homebridge-ui/public/js/modals.d.ts +16 -0
  126. package/dist/homebridge-ui/public/js/modals.d.ts.map +1 -0
  127. package/dist/homebridge-ui/public/js/modals.js +728 -0
  128. package/dist/homebridge-ui/public/js/modals.js.map +1 -0
  129. package/dist/homebridge-ui/public/js/modals.ts +823 -0
  130. package/dist/homebridge-ui/public/js/render.d.ts +71 -0
  131. package/dist/homebridge-ui/public/js/render.d.ts.map +1 -0
  132. package/dist/homebridge-ui/public/js/render.js +961 -0
  133. package/dist/homebridge-ui/public/js/render.js.map +1 -0
  134. package/dist/homebridge-ui/public/js/render.ts +1085 -0
  135. package/dist/homebridge-ui/public/js/toast.d.ts +6 -0
  136. package/dist/homebridge-ui/public/js/toast.d.ts.map +1 -0
  137. package/dist/homebridge-ui/public/js/toast.js +38 -0
  138. package/dist/homebridge-ui/public/js/toast.js.map +1 -0
  139. package/dist/homebridge-ui/public/js/toast.ts +44 -0
  140. package/dist/homebridge-ui/public/js/types.d.ts +23 -0
  141. package/dist/homebridge-ui/public/js/types.d.ts.map +1 -0
  142. package/dist/homebridge-ui/public/js/types.js +2 -0
  143. package/dist/homebridge-ui/public/js/types.js.map +1 -0
  144. package/dist/homebridge-ui/public/js/types.ts +26 -0
  145. package/dist/homebridge-ui/server.d.ts +1 -3
  146. package/dist/homebridge-ui/server.d.ts.map +1 -1
  147. package/dist/homebridge-ui/server.js +8 -471
  148. package/dist/homebridge-ui/server.js.map +1 -1
  149. package/dist/homebridge-ui/settings.js +8 -0
  150. package/dist/homebridge-ui/settings.js.map +1 -0
  151. package/dist/homebridge-ui/switchbotClient.js +247 -0
  152. package/dist/homebridge-ui/switchbotClient.js.map +1 -0
  153. package/dist/homebridge-ui/utils/config-parser.d.ts +39 -0
  154. package/dist/homebridge-ui/utils/config-parser.d.ts.map +1 -0
  155. package/dist/homebridge-ui/utils/config-parser.js +108 -0
  156. package/dist/homebridge-ui/utils/config-parser.js.map +1 -0
  157. package/dist/homebridge-ui/utils/device-migration.d.ts +35 -0
  158. package/dist/homebridge-ui/utils/device-migration.d.ts.map +1 -0
  159. package/dist/homebridge-ui/utils/device-migration.js +111 -0
  160. package/dist/homebridge-ui/utils/device-migration.js.map +1 -0
  161. package/dist/homebridge-ui/utils/logger.d.ts +7 -0
  162. package/dist/homebridge-ui/utils/logger.d.ts.map +1 -0
  163. package/dist/homebridge-ui/utils/logger.js +17 -0
  164. package/dist/homebridge-ui/utils/logger.js.map +1 -0
  165. package/dist/index.d.ts +10 -0
  166. package/dist/index.d.ts.map +1 -1
  167. package/dist/index.js +12 -2
  168. package/dist/index.js.map +1 -1
  169. package/dist/settings.d.ts +12 -0
  170. package/dist/settings.d.ts.map +1 -1
  171. package/dist/settings.js +1 -0
  172. package/dist/settings.js.map +1 -1
  173. package/dist/switchbotClient.d.ts +12 -10
  174. package/dist/switchbotClient.d.ts.map +1 -1
  175. package/dist/switchbotClient.js +156 -103
  176. package/dist/switchbotClient.js.map +1 -1
  177. package/dist/utils.d.ts +81 -1
  178. package/dist/utils.d.ts.map +1 -1
  179. package/dist/utils.js +1148 -4
  180. package/dist/utils.js.map +1 -1
  181. package/docs/assets/highlight.css +29 -15
  182. package/docs/assets/main.js +1 -1
  183. package/docs/index.html +100 -6
  184. package/docs/variables/default.html +3 -1
  185. package/eslint.config.js +9 -5
  186. package/nodemon.json +2 -2
  187. package/package.json +34 -21
  188. package/scripts/build-ui.js +37 -0
  189. package/scripts/free-dev-ports.mjs +105 -0
  190. package/scripts/generate-matter-maps.js +34 -17
  191. package/scripts/sync-device-types.mjs +31 -0
  192. package/src/SwitchBotHAPPlatform.ts +583 -0
  193. package/src/SwitchBotMatterPlatform.ts +566 -0
  194. package/src/device-types.js +246 -0
  195. package/src/device-types.js.map +1 -0
  196. package/src/device-types.ts +261 -0
  197. package/src/deviceCommandMapper.js +319 -0
  198. package/src/deviceCommandMapper.js.map +1 -0
  199. package/src/deviceCommandMapper.ts +333 -0
  200. package/src/deviceFactory.ts +125 -45
  201. package/src/devices/genericDevice.ts +411 -69
  202. package/src/errors.js +32 -0
  203. package/src/errors.js.map +1 -0
  204. package/src/errors.ts +35 -0
  205. package/src/homebridge-ui/endpoints/config.ts +110 -0
  206. package/src/homebridge-ui/endpoints/devices.ts +153 -0
  207. package/src/homebridge-ui/endpoints/discovery.ts +240 -0
  208. package/src/homebridge-ui/public/css/styles.css +483 -0
  209. package/src/homebridge-ui/public/index.html +197 -621
  210. package/src/homebridge-ui/public/js/advanced-settings.ts +94 -0
  211. package/src/homebridge-ui/public/js/api.ts +385 -0
  212. package/src/homebridge-ui/public/js/app.ts +22 -0
  213. package/src/homebridge-ui/public/js/constants.ts +1 -0
  214. package/src/homebridge-ui/public/js/credentials.ts +105 -0
  215. package/src/homebridge-ui/public/js/devices-delete.ts +227 -0
  216. package/src/homebridge-ui/public/js/devices.ts +112 -0
  217. package/src/homebridge-ui/public/js/discovery.ts +1335 -0
  218. package/src/homebridge-ui/public/js/logger.ts +17 -0
  219. package/src/homebridge-ui/public/js/modal.ts +35 -0
  220. package/src/homebridge-ui/public/js/modals.ts +823 -0
  221. package/src/homebridge-ui/public/js/render.ts +1085 -0
  222. package/src/homebridge-ui/public/js/toast.ts +44 -0
  223. package/src/homebridge-ui/public/js/types.ts +26 -0
  224. package/src/homebridge-ui/server.ts +9 -554
  225. package/src/homebridge-ui/utils/config-parser.ts +125 -0
  226. package/src/homebridge-ui/utils/device-migration.ts +144 -0
  227. package/src/homebridge-ui/utils/logger.ts +17 -0
  228. package/src/index.ts +12 -2
  229. package/src/settings.js +8 -0
  230. package/src/settings.js.map +1 -0
  231. package/src/settings.ts +14 -0
  232. package/src/switchbotClient.js +247 -0
  233. package/src/switchbotClient.js.map +1 -0
  234. package/src/switchbotClient.ts +177 -114
  235. package/src/utils.ts +1164 -5
  236. package/test/client/switchbot-client-debounce.spec.ts +35 -0
  237. package/test/client/switchbot-client-openapi.spec.ts +19 -0
  238. package/test/client/switchbotClient.spec.ts +64 -0
  239. package/test/device/device-mapping.spec.ts +23 -0
  240. package/test/device/deviceBase.spec.ts +26 -0
  241. package/test/device/deviceFactory-edge.spec.ts +15 -0
  242. package/test/device/deviceFactory.spec.ts +33 -0
  243. package/test/device/fan-swing.spec.ts +34 -0
  244. package/test/device/genericDevice-blepoll.spec.ts +47 -0
  245. package/test/device/irdevice.spec.ts +9 -0
  246. package/test/device/lock-users.spec.ts +35 -0
  247. package/test/device/matter-descriptors.spec.ts +22 -0
  248. package/test/device/matter-device-state.spec.ts +37 -0
  249. package/test/e2e/run-e2e.spec.ts +18 -19
  250. package/test/errors/errors.spec.ts +10 -0
  251. package/test/helpers/matter-harness.ts +20 -9
  252. package/test/homebridge-ui/server.spec.ts +9 -0
  253. package/test/platform/accessory-restore.spec.ts +37 -0
  254. package/test/platform/matter-childbridge.spec.ts +34 -0
  255. package/test/platform/matter-integration.spec.ts +33 -0
  256. package/test/platform/platform-edge.spec.ts +73 -0
  257. package/test/platform/platform.integration.spec.ts +34 -0
  258. package/test/utils/utils-extra.spec.ts +10 -0
  259. package/test/utils/utils.spec.ts +68 -0
  260. package/todo/TODO.md +80 -0
  261. package/tsconfig.ui.json +11 -0
  262. package/.github/workflows/beta-release.yml +0 -52
  263. package/dist/platform.d.ts +0 -35
  264. package/dist/platform.d.ts.map +0 -1
  265. package/dist/platform.js +0 -945
  266. package/dist/platform.js.map +0 -1
  267. package/src/platform.ts +0 -963
  268. package/test/accessory-restore.spec.ts +0 -73
  269. package/test/device-mapping.spec.ts +0 -37
  270. package/test/deviceFactory.spec.ts +0 -18
  271. package/test/fan-swing.spec.ts +0 -29
  272. package/test/lock-users.spec.ts +0 -44
  273. package/test/matter-childbridge.spec.ts +0 -55
  274. package/test/matter-descriptors.spec.ts +0 -97
  275. package/test/matter-device-state.spec.ts +0 -101
  276. package/test/matter-integration.spec.ts +0 -70
  277. package/test/platform.integration.spec.ts +0 -55
  278. package/test/switchbot-client-debounce.spec.ts +0 -131
  279. package/test/switchbot-client-openapi.spec.ts +0 -56
  280. package/test/switchbotClient.spec.ts +0 -10
  281. package/test/utils.spec.ts +0 -20
@@ -0,0 +1,566 @@
1
+ import type { SwitchBotPluginConfig } from './settings.js'
2
+ import type { API, Logger, PlatformConfig } from 'homebridge'
3
+
4
+ import { createDevice } from './deviceFactory.js'
5
+ import { PLATFORM_NAME, PLUGIN_NAME } from './settings.js'
6
+ import { SwitchBotClient } from './switchbotClient.js'
7
+ import { createMatterHandlers, DEVICE_MATTER_CLUSTERS, DEVICE_MATTER_SUPPORTED, normalizeTypeForMatter, resolveExternalPublishProtocol, resolveMatterDeviceType } from './utils.js'
8
+
9
+ /**
10
+ * Homebridge platform class for SwitchBot Matter integration.
11
+ * Handles device discovery, registration, polling, and accessory lifecycle for Matter-enabled SwitchBot devices.
12
+ *
13
+ * @class SwitchBotMatterPlatform
14
+ * @param {Logger} log - Homebridge logger instance
15
+ * @param {PlatformConfig} config - Platform configuration object
16
+ * @param {API} [api] - Optional Homebridge API instance
17
+ * @property {API | undefined} api - Homebridge API instance
18
+ * @property {Logger} log - Homebridge logger instance
19
+ * @property {SwitchBotPluginConfig} config - Parsed plugin config
20
+ * @property {any[]} devices - All created device instances
21
+ * @property {Map<string, any>} accessories - Map of accessory UUID to accessory object
22
+ * @property {string} lastConfigHash - Hash of last loaded config for change detection
23
+ * @property {NodeJS.Timeout | null} configReloadInterval - Interval for periodic config reload
24
+ * @property {Map<string, NodeJS.Timeout>} openApiPollTimers - Timers for per-device OpenAPI polling
25
+ * @property {NodeJS.Timeout | null} openApiBatchTimer - Timer for batched OpenAPI polling
26
+ * @property {number} openApiRequestsToday - Count of OpenAPI requests made today
27
+ * @property {number} openApiLastReset - Timestamp (ms) of last OpenAPI daily counter reset
28
+ */
29
+ export class SwitchBotMatterPlatform {
30
+ /** Homebridge API instance */
31
+ api: API | undefined
32
+ /** Homebridge logger instance */
33
+ log: Logger
34
+ /** Parsed plugin config */
35
+ config: SwitchBotPluginConfig
36
+ /** All created device instances */
37
+ devices: any[] = []
38
+ /** Map of accessory UUID to accessory object */
39
+ accessories: Map<string, any>
40
+ /** Hash of last loaded config for change detection */
41
+ private lastConfigHash: string = ''
42
+ /** Interval for periodic config reload */
43
+ private configReloadInterval: NodeJS.Timeout | null = null
44
+ /** Timers for per-device OpenAPI polling */
45
+ private openApiPollTimers: Map<string, NodeJS.Timeout> = new Map()
46
+ /** Timer for batched OpenAPI polling */
47
+ private openApiBatchTimer: NodeJS.Timeout | null = null
48
+ /** Count of OpenAPI requests made today */
49
+ private openApiRequestsToday = 0
50
+ /** Timestamp (ms) of last OpenAPI daily counter reset */
51
+ private openApiLastReset = 0
52
+
53
+ /**
54
+ * Construct the SwitchBot Matter platform.
55
+ * @param log Homebridge logger
56
+ * @param config Platform config
57
+ * @param api Homebridge API instance
58
+ */
59
+ constructor(log: Logger, config: PlatformConfig, api?: API) {
60
+ this.log = log
61
+ // Ensure both log and logger are set for downstream device constructors
62
+ this.config = { ...(config as any), log, logger: log }
63
+ this.api = api
64
+ this.accessories = new Map()
65
+ this.log.info('SwitchBot Matter platform initialized')
66
+
67
+ // Create/shared SwitchBot client and attach to config so child devices reuse it.
68
+ try {
69
+ const client = new SwitchBotClient(this.config)
70
+ void client.init();
71
+ (this.config as any)._client = client
72
+ } catch (e) {
73
+ this.log.debug('Failed to create shared SwitchBot client', e)
74
+ }
75
+
76
+ // Wait for Homebridge to finish launching to create/register accessories
77
+ if (this.api && typeof (this.api as any).on === 'function') {
78
+ (this.api as any).on('didFinishLaunching', async () => {
79
+ await this.loadDevices()
80
+ this._setupOpenApiPolling()
81
+ // Start periodic config reload to pick up UI changes
82
+ this.configReloadInterval = setInterval(() => {
83
+ void this.checkAndReloadDevices()
84
+ }, 10000) // Check every 10 seconds
85
+ // Listen for Homebridge shutdown to clear interval
86
+ if (typeof (this.api as any).on === 'function') {
87
+ (this.api as any).on('shutdown', () => {
88
+ this.shutdown()
89
+ })
90
+ }
91
+ })
92
+ } else {
93
+ void this.loadDevices()
94
+ this._setupOpenApiPolling()
95
+ // Start periodic config reload to pick up UI changes
96
+ this.configReloadInterval = setInterval(() => {
97
+ void this.checkAndReloadDevices()
98
+ }, 10000) // Check every 10 seconds
99
+ }
100
+ }
101
+
102
+ /**
103
+ * Discover and create all device instances from config.
104
+ * Populates this.devices and logs registration status for each device.
105
+ *
106
+ * @returns {Promise<void>} Resolves when all devices are loaded and registered
107
+ */
108
+ async loadDevices(): Promise<void> {
109
+ const newHash = this.getConfigHash()
110
+ if (newHash === this.lastConfigHash) {
111
+ this.log.debug('Config unchanged, skipping device reload')
112
+ return
113
+ }
114
+
115
+ const devices = (this.config as any)?.devices ?? []
116
+ const createdDevices: { created: any, d: any, type: string, useMatter: boolean, matterAvailable: boolean, externalPublishProtocol: 'none' | 'hap' | 'matter' }[] = []
117
+ for (const raw of devices) {
118
+ // Normalize config keys from UI schema to internal shape (for cross-platform consistency)
119
+ const d: any = {
120
+ id: raw.deviceId ?? raw.id,
121
+ name: raw.configDeviceName ?? raw.name,
122
+ type: raw.configDeviceType ?? raw.type ?? raw.deviceType ?? 'unknown',
123
+ encryptionKey: raw.encryptionKey,
124
+ keyId: raw.keyId,
125
+ _raw: raw,
126
+ }
127
+ const type: string = normalizeTypeForMatter(d.type)
128
+ const externalPublishProtocol = resolveExternalPublishProtocol(raw)
129
+ const deviceOpts: any = { id: d.id, type, name: d.name, encryptionKey: d.encryptionKey, keyId: d.keyId, log: this.log }
130
+ this.log.debug(`[Matter/Debug] Device options for ${d.name ?? d.id}:`, JSON.stringify(deviceOpts, null, 2))
131
+ const matterSupported = !!DEVICE_MATTER_SUPPORTED[(type || '').toLowerCase()]
132
+ const matterAvailable = !!(this.api?.isMatterAvailable?.() && this.api?.isMatterEnabled?.())
133
+ const matterEnabled = matterAvailable || !!this.config.enableMatter
134
+ const useMatter = matterEnabled && matterSupported
135
+ try {
136
+ const created = await createDevice(deviceOpts, this.config, useMatter)
137
+ this.devices.push(created)
138
+ createdDevices.push({ created, d, type, useMatter, matterAvailable, externalPublishProtocol })
139
+ if (useMatter) {
140
+ this.log.info(`Prepared Matter accessory for ${d.id} (${type})${matterAvailable ? ' (auto-detected)' : ' (manually enabled)'}`)
141
+ } else {
142
+ if (!matterEnabled) {
143
+ this.log.info(`Skipping Matter for ${d.id} (${type}) - Matter not available on this bridge`)
144
+ } else if (!matterSupported) {
145
+ this.log.info(`Skipping Matter for ${d.id} (${type}) - device type not supported`)
146
+ } else {
147
+ this.log.info(`Skipping Matter for ${d.id} (${type}) - not supported`)
148
+ }
149
+ }
150
+ } catch (e: any) {
151
+ this.log.error(`Failed to create Matter device ${d.id}:`, e instanceof Error ? e.stack || e.message : e)
152
+ }
153
+ }
154
+ // Register Matter accessories after device creation for symmetry with HAP platform
155
+ await this.registerMatterAccessories(createdDevices)
156
+ this.lastConfigHash = newHash
157
+ }
158
+
159
+ /**
160
+ * Registers all Matter accessories with the Homebridge Matter API.
161
+ *
162
+ * This method is called after all device instances have been created. It handles both new and restored
163
+ * accessories, updating their context, clusters, and other Matter-specific metadata as needed. Accessories
164
+ * are registered with Homebridge using the Matter API, and the internal accessory map is updated accordingly.
165
+ *
166
+ * @param {Array<{created: any, d: any, type: string, useMatter: boolean, matterAvailable: boolean}>} createdDevices - Array of device descriptors:
167
+ * - created: The created device instance
168
+ * - d: The normalized device config object
169
+ * - type: The normalized device type string
170
+ * - useMatter: Whether Matter is enabled for this device
171
+ * - matterAvailable: Whether Matter is available on this bridge
172
+ * @returns {Promise<void>} Resolves when registration is complete
173
+ *
174
+ * Differences from HAP registration:
175
+ * - Uses the Matter API (not HAP API) for accessory registration.
176
+ * - Adds Matter clusters and handlers to each accessory based on the device descriptor.
177
+ * - Only registers accessories where Matter is enabled and supported.
178
+ * - Accessory context and cluster wiring are Matter-specific.
179
+ *
180
+ * If the Homebridge Matter API is not available, registration is skipped and a log message is emitted.
181
+ * Accessories that are not enabled for Matter are ignored.
182
+ */
183
+ async registerMatterAccessories(createdDevices: { created: any, d: any, type: string, useMatter: boolean, matterAvailable: boolean, externalPublishProtocol: 'none' | 'hap' | 'matter' }[]): Promise<void> {
184
+ if (!this.api || !(this.api as any).matter || typeof (this.api as any).matter.registerPlatformAccessories !== 'function') {
185
+ this.log.info('Homebridge Matter API not available; skipping Matter accessory registration')
186
+ return
187
+ }
188
+ const matterApi = (this.api as any).matter
189
+ const accessoriesToRegister: any[] = []
190
+ const externalAccessoriesToPublish: any[] = []
191
+ for (const { created, d, type, useMatter, matterAvailable, externalPublishProtocol } of createdDevices) {
192
+ // Only register accessories where Matter is enabled and supported
193
+ if (!useMatter) {
194
+ // Log reason for skipping registration
195
+ if (!matterAvailable) {
196
+ this.log.info(`Skipping Matter registration for ${d.id} (${type}) - Matter API not available on this bridge`)
197
+ } else {
198
+ this.log.info(`Skipping Matter registration for ${d.id} (${type}) - device type not supported for Matter`)
199
+ }
200
+ continue
201
+ }
202
+ try {
203
+ // Prepare accessory descriptor from device
204
+ const createdDesc = await created.createAccessory(this.api)
205
+ const uuid = matterApi.uuid.generate(`${d.id}`)
206
+ // Reuse cached accessory if available by uuid
207
+ let accessory: any = this.accessories.get(uuid)
208
+ // Reuse cached accessory if available by uuid or deviceId
209
+ if (!accessory) {
210
+ for (const [, a] of this.accessories.entries()) {
211
+ try {
212
+ if (a && a.context && a.context.deviceId === d.id) {
213
+ accessory = a
214
+ break
215
+ }
216
+ } catch (e) {
217
+ // ignore
218
+ }
219
+ }
220
+ }
221
+ if (!accessory) {
222
+ // Create new accessory object for Matter
223
+ let clusters = DEVICE_MATTER_CLUSTERS[type.toLowerCase()]
224
+ if (!clusters) {
225
+ clusters = createdDesc.clusters || { onOff: { onOff: false } }
226
+ }
227
+ const deviceType = resolveMatterDeviceType(matterApi, type, createdDesc.deviceType, clusters)
228
+ accessory = {
229
+ UUID: uuid,
230
+ displayName: createdDesc.name || d.name || type,
231
+ deviceType,
232
+ manufacturer: createdDesc.manufacturer || 'SwitchBot',
233
+ model: createdDesc.model || type,
234
+ serialNumber: createdDesc.serialNumber || d.id,
235
+ reachable: createdDesc.reachable !== false,
236
+ firmwareRevision: createdDesc.firmwareRevision || '1.0.0',
237
+ hardwareRevision: createdDesc.hardwareRevision || '',
238
+ clusters,
239
+ handlers: createdDesc.handlers || createMatterHandlers(this.log, d.id, type, (this.config as any)?._client) || undefined,
240
+ context: { deviceId: d.id, type, created: true },
241
+ }
242
+ if (externalPublishProtocol === 'matter') {
243
+ externalAccessoriesToPublish.push(accessory)
244
+ } else {
245
+ accessoriesToRegister.push(accessory)
246
+ }
247
+ this.accessories.set(uuid, accessory)
248
+ } else {
249
+ // Ensure context and update properties for restored accessory
250
+ let clusters = DEVICE_MATTER_CLUSTERS[type.toLowerCase()]
251
+ if (!clusters) {
252
+ clusters = accessory.clusters || createdDesc.clusters || { onOff: { onOff: false } }
253
+ }
254
+ const deviceType = resolveMatterDeviceType(matterApi, type, accessory.deviceType || createdDesc.deviceType, clusters)
255
+ accessory.context = accessory.context || {}
256
+ accessory.context.deviceId = accessory.context.deviceId || d.id
257
+ accessory.context.type = accessory.context.type || type
258
+ accessory.deviceType = deviceType
259
+ accessory.manufacturer = accessory.manufacturer || createdDesc.manufacturer || 'SwitchBot'
260
+ accessory.model = accessory.model || createdDesc.model || type
261
+ accessory.serialNumber = accessory.serialNumber || createdDesc.serialNumber || d.id
262
+ accessory.reachable = accessory.reachable !== false
263
+ accessory.firmwareRevision = accessory.firmwareRevision || createdDesc.firmwareRevision || '1.0.0'
264
+ accessory.hardwareRevision = accessory.hardwareRevision || createdDesc.hardwareRevision || ''
265
+ accessory.clusters = clusters
266
+ accessory.handlers = createdDesc.handlers || createMatterHandlers(this.log, d.id, type, (this.config as any)?._client) || undefined
267
+ accessory.displayName = createdDesc.name || d.name || type
268
+ accessory.UUID = accessory.UUID || accessory.uuid || uuid
269
+ if (externalPublishProtocol === 'matter') {
270
+ externalAccessoriesToPublish.push(accessory)
271
+ } else {
272
+ accessoriesToRegister.push(accessory)
273
+ }
274
+ this.accessories.set(accessory.UUID || uuid, accessory)
275
+ }
276
+ this.log.info(`Created/updated Matter accessory ${d.id} (${type})`)
277
+ } catch (e) {
278
+ this.log.warn(`Matter accessory creation failed for ${d.id} (${type})`, e)
279
+ }
280
+ }
281
+ if (accessoriesToRegister.length > 0) {
282
+ try {
283
+ await matterApi.registerPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, accessoriesToRegister)
284
+ this.log.info(`Registered ${accessoriesToRegister.length} Matter accessory(ies) with Homebridge`)
285
+ } catch (e) {
286
+ this.log.warn('Failed to register Matter accessories', e)
287
+ }
288
+ } else {
289
+ this.log.info('No Matter accessories to register')
290
+ }
291
+ if (externalAccessoriesToPublish.length > 0) {
292
+ try {
293
+ if (typeof matterApi.publishExternalAccessories === 'function') {
294
+ await matterApi.publishExternalAccessories(PLUGIN_NAME, externalAccessoriesToPublish)
295
+ this.log.info(`Published ${externalAccessoriesToPublish.length} Matter external accessory(ies) with Homebridge`)
296
+ } else if (typeof matterApi.registerExternalAccessories === 'function') {
297
+ await matterApi.registerExternalAccessories(PLUGIN_NAME, PLATFORM_NAME, externalAccessoriesToPublish)
298
+ this.log.info(`Registered ${externalAccessoriesToPublish.length} Matter external accessory(ies) with Homebridge`)
299
+ } else {
300
+ this.log.warn('Matter external accessory publishing API not available; falling back to regular platform registration')
301
+ await matterApi.registerPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, externalAccessoriesToPublish)
302
+ this.log.info(`Registered ${externalAccessoriesToPublish.length} Matter accessory(ies) as fallback (external publishing unavailable)`)
303
+ }
304
+ } catch (e) {
305
+ this.log.warn('Failed to publish/register Matter external accessories', e)
306
+ }
307
+ }
308
+ }
309
+
310
+ /**
311
+ * Returns the timestamp (ms) of the last OpenAPI daily counter reset.
312
+ * @returns {number} Timestamp in ms
313
+ */
314
+ getOpenApiLastReset(): number {
315
+ return this.openApiLastReset
316
+ }
317
+
318
+ /**
319
+ * Logs the last OpenAPI reset time in a human-readable format.
320
+ * @returns {void}
321
+ */
322
+ logOpenApiLastReset(): void {
323
+ if (this.openApiLastReset) {
324
+ const date = new Date(this.openApiLastReset)
325
+ this.log.info(`[OpenAPI] Last daily counter reset: ${date.toLocaleString()}`)
326
+ } else {
327
+ this.log.info('[OpenAPI] Daily counter has not been reset yet.')
328
+ }
329
+ }
330
+
331
+ /**
332
+ * Compute a hash of the current device config for change detection.
333
+ * @returns {string} JSON string hash of device config
334
+ */
335
+ private getConfigHash(): string {
336
+ // Create a simple hash of current device config to detect changes
337
+ const devices = (this.config as any)?.devices ?? []
338
+ return JSON.stringify(devices.map((d: any) => ({
339
+ id: d.deviceId ?? d.id,
340
+ type: d.configDeviceType ?? d.type,
341
+ name: d.configDeviceName ?? d.name,
342
+ externalPublishProtocol: resolveExternalPublishProtocol(d),
343
+ })))
344
+ }
345
+
346
+ /**
347
+ * Reload devices if config has changed since last load.
348
+ * Unregisters accessories and removes devices no longer in config.
349
+ * Calls loadDevices to repopulate devices and accessories.
350
+ *
351
+ * @returns {Promise<void>} Resolves when reload is complete
352
+ */
353
+ private async checkAndReloadDevices(): Promise<void> {
354
+ const currentHash = this.getConfigHash()
355
+ if (currentHash !== this.lastConfigHash) {
356
+ this.log.info('[SwitchBot] Detected config changes, reloading devices...')
357
+ // Identify device IDs in new config
358
+ const devicesInConfig = new Set(((this.config as any)?.devices ?? []).map((d: any) => d.deviceId ?? d.id))
359
+ // Find accessories to remove (not in config)
360
+ const accessoriesToRemove: any[] = []
361
+ for (const [uuid, accessory] of this.accessories.entries()) {
362
+ const deviceId = accessory?.context?.deviceId
363
+ if (deviceId && !devicesInConfig.has(deviceId)) {
364
+ accessoriesToRemove.push({ accessory, uuid })
365
+ }
366
+ }
367
+ // Unregister removed accessories from Homebridge (Matter API)
368
+ if (accessoriesToRemove.length > 0 && this.api && (this.api as any).matter && (this.api as any).matter.unregisterPlatformAccessories) {
369
+ try {
370
+ (this.api as any).matter.unregisterPlatformAccessories(PLUGIN_NAME, PLATFORM_NAME, accessoriesToRemove.map(a => a.accessory))
371
+ this.log.info(`Unregistered ${accessoriesToRemove.length} Matter accessory(ies) removed from config`)
372
+ for (const { uuid } of accessoriesToRemove) {
373
+ this.accessories.delete(uuid)
374
+ }
375
+ } catch (e) {
376
+ this.log.warn('Failed to unregister removed Matter accessories', e)
377
+ }
378
+ }
379
+ // Remove devices from this.devices that are no longer in config
380
+ this.devices = this.devices.filter((dev: any) => devicesInConfig.has(dev?.id))
381
+ await this.loadDevices()
382
+ this.lastConfigHash = currentHash
383
+ }
384
+ }
385
+
386
+ /**
387
+ * Cleanup method to clear config reload interval on shutdown.
388
+ * Called by Homebridge on shutdown event.
389
+ * @returns {void}
390
+ */
391
+ shutdown(): void {
392
+ if (this.configReloadInterval) {
393
+ clearInterval(this.configReloadInterval)
394
+ this.configReloadInterval = null
395
+ this.log.info('Cleared config reload interval on shutdown')
396
+ }
397
+ }
398
+
399
+ /**
400
+ * Setup OpenAPI polling for all devices according to config (global, per-device, batch, rate limit).
401
+ * Handles daily request limits, per-device and batch polling, and resets.
402
+ *
403
+ * @returns {void}
404
+ */
405
+ private _setupOpenApiPolling(): void {
406
+ // Clear any existing timers
407
+ for (const t of this.openApiPollTimers.values()) clearInterval(t)
408
+ this.openApiPollTimers.clear()
409
+ if (this.openApiBatchTimer) {
410
+ clearInterval(this.openApiBatchTimer)
411
+ }
412
+ this.openApiBatchTimer = null
413
+
414
+ const cfg = this.config as any
415
+ const devices = cfg.devices ?? []
416
+ const globalRate = Math.max(Number(cfg.openApiRefreshRate) || 300, 30)
417
+ const batchEnabled = cfg.matterBatchEnabled !== false
418
+ const batchRate = Math.max(Number(cfg.matterBatchRefreshRate) || globalRate, 30)
419
+ const batchConcurrency = Math.max(Number(cfg.matterBatchConcurrency) || 5, 1)
420
+ const batchJitter = Math.max(Number(cfg.matterBatchJitter) || 0, 0)
421
+ const dailyLimit = Math.max(Number(cfg.dailyApiLimit) || 10000, 1000)
422
+ const dailyReserve = Math.max(Number(cfg.dailyApiReserveForCommands) || 1000, 0)
423
+ const resetAtLocalMidnight = !!cfg.dailyApiResetLocalMidnight
424
+ const webhookOnlyOnReserve = !!cfg.webhookOnlyOnReserve
425
+
426
+ // Helper to reset daily counter
427
+ const resetCounter = () => {
428
+ this.openApiRequestsToday = 0
429
+ this.openApiLastReset = Date.now()
430
+ this.log.info('[OpenAPI] Daily request counter reset')
431
+ }
432
+ // Schedule reset at midnight
433
+ const scheduleMidnightReset = () => {
434
+ const now = new Date()
435
+ let nextReset: Date
436
+ if (resetAtLocalMidnight) {
437
+ nextReset = new Date(now.getFullYear(), now.getMonth(), now.getDate() + 1, 0, 0, 1)
438
+ } else {
439
+ nextReset = new Date(now)
440
+ nextReset.setUTCHours(24, 0, 1, 0)
441
+ }
442
+ const ms = nextReset.getTime() - now.getTime()
443
+ setTimeout(() => {
444
+ resetCounter()
445
+ scheduleMidnightReset()
446
+ }, ms)
447
+ }
448
+ scheduleMidnightReset()
449
+
450
+ // Helper to check if polling is allowed
451
+ const canPoll = () => {
452
+ if (this.openApiRequestsToday + dailyReserve >= dailyLimit) {
453
+ if (!webhookOnlyOnReserve) {
454
+ this.log.warn('[OpenAPI] Daily request limit reached, pausing background polling')
455
+ }
456
+ return false
457
+ }
458
+ return true
459
+ }
460
+
461
+ // Per-device polling (devices with per-device refreshRate)
462
+ for (const dev of devices) {
463
+ const id = dev.deviceId ?? dev.id
464
+ const enabled = dev.enabled !== false
465
+ if (!id || !enabled) {
466
+ continue
467
+ }
468
+ const perDeviceRate = dev.refreshRate ? Math.max(Number(dev.refreshRate), 30) : null
469
+ if (perDeviceRate) {
470
+ // Individual polling interval for this device
471
+ const timer = setInterval(async () => {
472
+ if (!canPoll()) {
473
+ return
474
+ }
475
+ try {
476
+ const client = (this.config as any)._client
477
+ if (client && typeof client.getDevice === 'function') {
478
+ await client.getDevice(id)
479
+ this.openApiRequestsToday++
480
+ this.log.debug(`[OpenAPI] Polled device ${id} (per-device interval ${perDeviceRate}s) [${this.openApiRequestsToday}/${dailyLimit}]`)
481
+ }
482
+ } catch (e) {
483
+ this.log.debug(`[OpenAPI] Polling failed for device ${id}:`, (e as Error)?.message)
484
+ }
485
+ }, perDeviceRate * 1000)
486
+ this.openApiPollTimers.set(id, timer)
487
+ }
488
+ }
489
+
490
+ // Batched polling for all other devices
491
+ if (batchEnabled) {
492
+ // Devices not already polled individually
493
+ const batchDevices = devices.filter((dev: any) => {
494
+ const id = dev.deviceId ?? dev.id
495
+ const enabled = dev.enabled !== false
496
+ const perDeviceRate = dev.refreshRate ? Math.max(Number(dev.refreshRate), 30) : null
497
+ return id && enabled && !perDeviceRate
498
+ })
499
+ // Optional jitter before first batch
500
+ const startBatch = () => {
501
+ this.openApiBatchTimer = setInterval(async () => {
502
+ if (!canPoll()) {
503
+ return
504
+ }
505
+ const client = (this.config as any)._client
506
+ if (!client || typeof client.getDevice !== 'function') {
507
+ return
508
+ }
509
+ // Limit concurrency
510
+ const chunks: any[][] = []
511
+ for (let i = 0; i < batchDevices.length; i += batchConcurrency) {
512
+ chunks.push(batchDevices.slice(i, i + batchConcurrency))
513
+ }
514
+ for (const chunk of chunks) {
515
+ await Promise.all(chunk.map(async (dev: any) => {
516
+ try {
517
+ await client.getDevice(dev.deviceId ?? dev.id)
518
+ this.openApiRequestsToday++
519
+ this.log.debug(`[OpenAPI] Batched poll device ${dev.deviceId ?? dev.id} [${this.openApiRequestsToday}/${dailyLimit}]`)
520
+ } catch (e) {
521
+ this.log.debug(`[OpenAPI] Batched polling failed for device ${dev.deviceId ?? dev.id}:`, (e as Error)?.message)
522
+ }
523
+ }))
524
+ }
525
+ }, batchRate * 1000)
526
+ }
527
+ if (batchJitter > 0) {
528
+ setTimeout(startBatch, Math.floor(Math.random() * batchJitter * 1000))
529
+ } else {
530
+ startBatch()
531
+ }
532
+ }
533
+ }
534
+
535
+ /**
536
+ * Called by Homebridge to restore cached Matter accessories on startup.
537
+ * @param {any} accessory - The cached accessory object
538
+ * @returns {Promise<void>} Resolves when accessory is restored
539
+ */
540
+ async configureAccessory(accessory: any): Promise<void> {
541
+ try {
542
+ const uuid = accessory.UUID || accessory.UUID
543
+ this.accessories.set(uuid, accessory)
544
+ this.log.info(`Restored cached Matter accessory ${accessory.displayName || uuid}`)
545
+ } catch (e) {
546
+ this.log.warn('configureAccessory failed to restore Matter accessory', e)
547
+ }
548
+ }
549
+
550
+ /**
551
+ * Called by Homebridge to restore cached Matter accessories (alternate signature).
552
+ * @param {any} accessory - The cached accessory object
553
+ * @returns {void}
554
+ */
555
+ configureMatterAccessory(accessory: any): void {
556
+ try {
557
+ const uuid = accessory.uuid || accessory.UUID || accessory.uuid
558
+ this.accessories.set(uuid, accessory)
559
+ this.log.info(`Restored cached Matter accessory ${accessory.displayName || uuid}`)
560
+ } catch (e) {
561
+ this.log.warn('configureMatterAccessory failed to restore Matter accessory', e)
562
+ }
563
+ }
564
+ }
565
+
566
+ export default SwitchBotMatterPlatform