@switchbot/homebridge-switchbot 5.0.0-beta.4 → 5.0.0-beta.40

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 (162) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/README.md +23 -3
  3. package/config.schema.json +722 -13684
  4. package/dist/devices-hap/device.d.ts +18 -8
  5. package/dist/devices-hap/device.d.ts.map +1 -1
  6. package/dist/devices-hap/device.js +121 -68
  7. package/dist/devices-hap/device.js.map +1 -1
  8. package/dist/devices-matter/BaseMatterAccessory.d.ts +27 -0
  9. package/dist/devices-matter/BaseMatterAccessory.d.ts.map +1 -1
  10. package/dist/devices-matter/BaseMatterAccessory.js +169 -5
  11. package/dist/devices-matter/BaseMatterAccessory.js.map +1 -1
  12. package/dist/devices-matter/ColorLightAccessory.d.ts.map +1 -1
  13. package/dist/devices-matter/ColorLightAccessory.js +12 -12
  14. package/dist/devices-matter/ColorLightAccessory.js.map +1 -1
  15. package/dist/devices-matter/ColorTemperatureLightAccessory.d.ts.map +1 -1
  16. package/dist/devices-matter/ColorTemperatureLightAccessory.js +5 -7
  17. package/dist/devices-matter/ColorTemperatureLightAccessory.js.map +1 -1
  18. package/dist/devices-matter/DimmableLightAccessory.js +9 -9
  19. package/dist/devices-matter/DimmableLightAccessory.js.map +1 -1
  20. package/dist/devices-matter/ExtendedColorLightAccessory.d.ts.map +1 -1
  21. package/dist/devices-matter/ExtendedColorLightAccessory.js +14 -15
  22. package/dist/devices-matter/ExtendedColorLightAccessory.js.map +1 -1
  23. package/dist/devices-matter/OnOffLightAccessory.d.ts.map +1 -1
  24. package/dist/devices-matter/OnOffLightAccessory.js +8 -16
  25. package/dist/devices-matter/OnOffLightAccessory.js.map +1 -1
  26. package/dist/devices-matter/OnOffOutletAccessory.d.ts +2 -0
  27. package/dist/devices-matter/OnOffOutletAccessory.d.ts.map +1 -1
  28. package/dist/devices-matter/OnOffOutletAccessory.js +10 -7
  29. package/dist/devices-matter/OnOffOutletAccessory.js.map +1 -1
  30. package/dist/devices-matter/OnOffSwitchAccessory.js +2 -2
  31. package/dist/devices-matter/OnOffSwitchAccessory.js.map +1 -1
  32. package/dist/homebridge-ui/public/index.html +48 -1
  33. package/dist/homebridge-ui/server.js +53 -8
  34. package/dist/homebridge-ui/server.js.map +1 -1
  35. package/dist/index.d.ts.map +1 -1
  36. package/dist/index.js +4 -7
  37. package/dist/index.js.map +1 -1
  38. package/dist/irdevice/irdevice.d.ts +11 -10
  39. package/dist/irdevice/irdevice.d.ts.map +1 -1
  40. package/dist/irdevice/irdevice.js +76 -35
  41. package/dist/irdevice/irdevice.js.map +1 -1
  42. package/dist/platform-hap.d.ts +21 -15
  43. package/dist/platform-hap.d.ts.map +1 -1
  44. package/dist/platform-hap.js +246 -147
  45. package/dist/platform-hap.js.map +1 -1
  46. package/dist/platform-matter.d.ts +88 -6
  47. package/dist/platform-matter.d.ts.map +1 -1
  48. package/dist/platform-matter.js +1726 -243
  49. package/dist/platform-matter.js.map +1 -1
  50. package/dist/settings.d.ts +41 -6
  51. package/dist/settings.d.ts.map +1 -1
  52. package/dist/settings.js.map +1 -1
  53. package/dist/test/hap/platform-hap.logging.test.d.ts +2 -0
  54. package/dist/test/hap/platform-hap.logging.test.d.ts.map +1 -0
  55. package/dist/test/hap/platform-hap.logging.test.js +33 -0
  56. package/dist/test/hap/platform-hap.logging.test.js.map +1 -0
  57. package/dist/test/hap/platform-hap.test.d.ts +2 -0
  58. package/dist/test/hap/platform-hap.test.d.ts.map +1 -0
  59. package/dist/test/hap/platform-hap.test.js +62 -0
  60. package/dist/test/hap/platform-hap.test.js.map +1 -0
  61. package/dist/test/helpers/platform-fixtures.d.ts +9 -0
  62. package/dist/test/helpers/platform-fixtures.d.ts.map +1 -0
  63. package/dist/test/helpers/platform-fixtures.js +30 -0
  64. package/dist/test/helpers/platform-fixtures.js.map +1 -0
  65. package/dist/{index.test.d.ts.map → test/index.test.d.ts.map} +1 -1
  66. package/dist/test/index.test.js +19 -0
  67. package/dist/test/index.test.js.map +1 -0
  68. package/dist/test/matter/devices-matter/baseMatterAccessory.test.d.ts +2 -0
  69. package/dist/test/matter/devices-matter/baseMatterAccessory.test.d.ts.map +1 -0
  70. package/dist/test/matter/devices-matter/baseMatterAccessory.test.js +71 -0
  71. package/dist/test/matter/devices-matter/baseMatterAccessory.test.js.map +1 -0
  72. package/dist/test/matter/platform-matter.additional.test.d.ts +2 -0
  73. package/dist/test/matter/platform-matter.additional.test.d.ts.map +1 -0
  74. package/dist/test/matter/platform-matter.additional.test.js +35 -0
  75. package/dist/test/matter/platform-matter.additional.test.js.map +1 -0
  76. package/dist/test/matter/platform-matter.bleparse.test.d.ts +2 -0
  77. package/dist/test/matter/platform-matter.bleparse.test.d.ts.map +1 -0
  78. package/dist/test/matter/platform-matter.bleparse.test.js +43 -0
  79. package/dist/test/matter/platform-matter.bleparse.test.js.map +1 -0
  80. package/dist/test/matter/platform-matter.cleanup.test.d.ts +2 -0
  81. package/dist/test/matter/platform-matter.cleanup.test.d.ts.map +1 -0
  82. package/dist/test/matter/platform-matter.cleanup.test.js +70 -0
  83. package/dist/test/matter/platform-matter.cleanup.test.js.map +1 -0
  84. package/dist/test/matter/platform-matter.keepstale.test.d.ts +2 -0
  85. package/dist/test/matter/platform-matter.keepstale.test.d.ts.map +1 -0
  86. package/dist/test/matter/platform-matter.keepstale.test.js +27 -0
  87. package/dist/test/matter/platform-matter.keepstale.test.js.map +1 -0
  88. package/dist/test/matter/platform-matter.logging.test.d.ts +2 -0
  89. package/dist/test/matter/platform-matter.logging.test.d.ts.map +1 -0
  90. package/dist/test/matter/platform-matter.logging.test.js +29 -0
  91. package/dist/test/matter/platform-matter.logging.test.js.map +1 -0
  92. package/dist/test/matter/platform-matter.mapping.test.d.ts +2 -0
  93. package/dist/test/matter/platform-matter.mapping.test.d.ts.map +1 -0
  94. package/dist/test/matter/platform-matter.mapping.test.js +43 -0
  95. package/dist/test/matter/platform-matter.mapping.test.js.map +1 -0
  96. package/dist/test/matter/platform-matter.openapi-mapping.test.d.ts +2 -0
  97. package/dist/test/matter/platform-matter.openapi-mapping.test.d.ts.map +1 -0
  98. package/dist/test/matter/platform-matter.openapi-mapping.test.js +84 -0
  99. package/dist/test/matter/platform-matter.openapi-mapping.test.js.map +1 -0
  100. package/dist/test/matter/platform-matter.test.d.ts +2 -0
  101. package/dist/test/matter/platform-matter.test.d.ts.map +1 -0
  102. package/dist/test/matter/platform-matter.test.js +117 -0
  103. package/dist/test/matter/platform-matter.test.js.map +1 -0
  104. package/dist/test/matter/platform-matter.unregister.test.d.ts +2 -0
  105. package/dist/test/matter/platform-matter.unregister.test.d.ts.map +1 -0
  106. package/dist/test/matter/platform-matter.unregister.test.js +30 -0
  107. package/dist/test/matter/platform-matter.unregister.test.js.map +1 -0
  108. package/dist/test/utils.test.d.ts +2 -0
  109. package/dist/test/utils.test.d.ts.map +1 -0
  110. package/dist/test/utils.test.js +95 -0
  111. package/dist/test/utils.test.js.map +1 -0
  112. package/dist/test/verifyconfig.test.d.ts.map +1 -0
  113. package/dist/{verifyconfig.test.js → test/verifyconfig.test.js} +2 -2
  114. package/dist/test/verifyconfig.test.js.map +1 -0
  115. package/dist/utils.d.ts +196 -3
  116. package/dist/utils.d.ts.map +1 -1
  117. package/dist/utils.js +656 -30
  118. package/dist/utils.js.map +1 -1
  119. package/docs/assets/main.js +2 -2
  120. package/docs/index.html +20 -2
  121. package/docs/variables/default.html +1 -1
  122. package/package.json +14 -14
  123. package/src/devices-hap/device.ts +129 -69
  124. package/src/devices-matter/BaseMatterAccessory.ts +176 -5
  125. package/src/devices-matter/ColorLightAccessory.ts +12 -12
  126. package/src/devices-matter/ColorTemperatureLightAccessory.ts +5 -7
  127. package/src/devices-matter/DimmableLightAccessory.ts +9 -9
  128. package/src/devices-matter/ExtendedColorLightAccessory.ts +14 -15
  129. package/src/devices-matter/OnOffLightAccessory.ts +8 -16
  130. package/src/devices-matter/OnOffOutletAccessory.ts +12 -7
  131. package/src/devices-matter/OnOffSwitchAccessory.ts +2 -2
  132. package/src/homebridge-ui/public/index.html +48 -1
  133. package/src/homebridge-ui/server.ts +55 -8
  134. package/src/index.ts +4 -7
  135. package/src/irdevice/irdevice.ts +74 -35
  136. package/src/platform-hap.ts +270 -160
  137. package/src/platform-matter.ts +1768 -240
  138. package/src/settings.ts +45 -2
  139. package/src/test/hap/platform-hap.logging.test.ts +36 -0
  140. package/src/test/hap/platform-hap.test.ts +70 -0
  141. package/src/test/helpers/platform-fixtures.ts +33 -0
  142. package/src/test/index.test.ts +24 -0
  143. package/src/test/matter/devices-matter/baseMatterAccessory.test.ts +88 -0
  144. package/src/test/matter/platform-matter.additional.test.ts +44 -0
  145. package/src/test/matter/platform-matter.bleparse.test.ts +47 -0
  146. package/src/test/matter/platform-matter.cleanup.test.ts +86 -0
  147. package/src/test/matter/platform-matter.keepstale.test.ts +37 -0
  148. package/src/test/matter/platform-matter.logging.test.ts +33 -0
  149. package/src/test/matter/platform-matter.mapping.test.ts +57 -0
  150. package/src/test/matter/platform-matter.openapi-mapping.test.ts +109 -0
  151. package/src/test/matter/platform-matter.test.ts +144 -0
  152. package/src/test/matter/platform-matter.unregister.test.ts +39 -0
  153. package/src/test/utils.test.ts +96 -0
  154. package/src/{verifyconfig.test.ts → test/verifyconfig.test.ts} +12 -11
  155. package/src/utils.ts +714 -32
  156. package/dist/index.test.js +0 -14
  157. package/dist/index.test.js.map +0 -1
  158. package/dist/verifyconfig.test.d.ts.map +0 -1
  159. package/dist/verifyconfig.test.js.map +0 -1
  160. package/src/index.test.ts +0 -19
  161. /package/dist/{index.test.d.ts → test/index.test.d.ts} +0 -0
  162. /package/dist/{verifyconfig.test.d.ts → test/verifyconfig.test.d.ts} +0 -0
package/src/settings.ts CHANGED
@@ -32,10 +32,18 @@ interface credentials {
32
32
 
33
33
  export interface options {
34
34
  devices?: devicesConfig[]
35
- deviceConfig?: { [deviceType: string]: devicesConfig }
36
35
  irdevices?: irDevicesConfig[]
37
- irdeviceConfig?: { [remoteType: string]: irDevicesConfig }
38
36
  allowInvalidCharacters?: boolean
37
+ // When true, devices declared in config.options.devices that are not
38
+ // discovered via the SwitchBot OpenAPI will still be included (config-only
39
+ // devices). Default: false.
40
+ allowConfigOnlyDevices?: boolean
41
+ /**
42
+ * When true, previously-registered accessories for devices that are no
43
+ * longer discovered or configured will be kept on the bridge. Default: false.
44
+ * When false (default), stale accessories are removed automatically.
45
+ */
46
+ keepStaleAccessories?: boolean
39
47
  mqttURL?: string
40
48
  mqttOptions?: IClientOptions
41
49
  mqttPubOptions?: IClientOptions
@@ -51,6 +59,29 @@ export interface options {
51
59
  updateRate?: number
52
60
  pushRate?: number
53
61
  logging?: string
62
+ /**
63
+ * Maximum number of SwitchBot OpenAPI requests allowed per day.
64
+ * Defaults to 10,000 if not specified.
65
+ */
66
+ dailyApiLimit?: number
67
+ /**
68
+ * Number of daily API requests reserved for user-initiated commands.
69
+ * When remaining budget falls below this reserve, background polling and discovery
70
+ * are paused until the daily counter resets. Defaults to 1,000.
71
+ */
72
+ dailyApiReserveForCommands?: number
73
+ /**
74
+ * When true, the plugin will completely stop background polling/discovery
75
+ * once the remaining daily budget reaches the reserve (webhook-only mode).
76
+ * When false, polling continues until the hard daily limit is reached.
77
+ * Default: false.
78
+ */
79
+ webhookOnlyOnReserve?: boolean
80
+ // Matter platform batch refresh options
81
+ matterBatchRefreshRate?: number
82
+ matterBatchConcurrency?: number
83
+ matterBatchEnabled?: boolean
84
+ matterBatchJitter?: number
54
85
  };
55
86
 
56
87
  export type devicesConfig = botConfig | relaySwitch1Config | relaySwitch1PMConfig | meterConfig | meterProConfig | indoorOutdoorSensorConfig | humidifierConfig | curtainConfig | blindTiltConfig | contactConfig | motionConfig | waterDetectorConfig | plugConfig | colorBulbConfig | stripLightConfig | ceilingLightConfig | lockConfig | hubConfig
@@ -85,6 +116,12 @@ export interface BaseDeviceConfig extends device {
85
116
  mqttPubOptions?: IClientOptions
86
117
  history?: boolean
87
118
  webhook?: boolean
119
+ /**
120
+ * When true, applies this device's configuration to all other devices
121
+ * of the same deviceType/configDeviceType (e.g., all Humidifiers).
122
+ * Specific per-device settings will override these template settings.
123
+ */
124
+ applyToAllDevicesOfType?: boolean
88
125
  }
89
126
 
90
127
  export interface botConfig extends BaseDeviceConfig {
@@ -244,6 +281,12 @@ export interface irBaseDeviceConfig extends irdevice {
244
281
  logging?: string
245
282
  customOn?: string
246
283
  customOff?: string
284
+ /**
285
+ * When true, applies this IR device's configuration to all other IR devices
286
+ * of the same remoteType/configRemoteType (e.g., all IR Fans).
287
+ * Specific per-device settings will override these template settings.
288
+ */
289
+ applyToAllDevicesOfType?: boolean
247
290
  customize?: boolean
248
291
  commandType?: string
249
292
  disablePushOn?: boolean
@@ -0,0 +1,36 @@
1
+ /* eslint-disable import/first */
2
+ import { describe, expect, it, vi } from 'vitest'
3
+ // Mock modules used by the HAP platform constructor to avoid requiring a real Homebridge API
4
+ vi.mock('fakegato-history', () => ({ default: () => ({}) }))
5
+ vi.mock('homebridge-lib/EveHomeKitTypes', () => ({ EveHomeKitTypes: class { constructor() {} } }))
6
+
7
+ import { SwitchBotHAPPlatform } from '../../platform-hap.js'
8
+ import { makeLogStub } from '../helpers/platform-fixtures.js'
9
+
10
+ /**
11
+ * Verifies that HAP platform debug logger includes the accessory displayName
12
+ * when loading an accessory from the cache.
13
+ */
14
+ describe('platform-hap logging', () => {
15
+ it('prints accessory name when loading HAP cached accessory', async () => {
16
+ const api: any = { on: vi.fn() }
17
+ const log: any = makeLogStub()
18
+
19
+ const platform = new SwitchBotHAPPlatform(log as any, {
20
+ name: 'SwitchBot',
21
+ credentials: {},
22
+ options: { logging: 'debug' },
23
+ devices: [],
24
+ } as any, api)
25
+
26
+ const accessory: any = { displayName: 'Test HAP Device' }
27
+ await (platform as any).configureAccessory(accessory)
28
+
29
+ // Allow async logger to flush
30
+ await new Promise(resolve => setTimeout(resolve, 0))
31
+
32
+ const calls = (log.info as any).mock.calls as Array<string[]>
33
+ const hasLine = calls.some(args => String(args[0]).includes('Loading accessory from cache: Test HAP Device'))
34
+ expect(hasLine).toBe(true)
35
+ })
36
+ })
@@ -0,0 +1,70 @@
1
+ /* eslint-disable import/first */
2
+ import { describe, expect, it, vi } from 'vitest'
3
+ // Mock modules used by the HAP platform constructor to avoid requiring a real Homebridge API
4
+ vi.mock('fakegato-history', () => ({ default: () => ({}) }))
5
+ vi.mock('homebridge-lib/EveHomeKitTypes', () => ({ EveHomeKitTypes: class { constructor() {} } }))
6
+
7
+ import { SwitchBotHAPPlatform } from '../../platform-hap.js'
8
+ import { makeLogStub } from '../helpers/platform-fixtures.js'
9
+
10
+ /**
11
+ * High-level smoke tests for the HAP platform to ensure it initializes,
12
+ * subscribes to lifecycle events, and handles cached accessories.
13
+ */
14
+ describe('platform-hap (smoke)', () => {
15
+ it('initializes and subscribes to didFinishLaunching', async () => {
16
+ const api: any = { on: vi.fn() }
17
+ const log: any = makeLogStub()
18
+
19
+ // Enable debug so debug* logs print via our shared logger
20
+ // Construct the platform (smoke)
21
+ new SwitchBotHAPPlatform(log as any, {
22
+ name: 'SwitchBot',
23
+ credentials: {},
24
+ options: { logging: 'debug' },
25
+ devices: [],
26
+ } as any, api)
27
+
28
+ // Should register didFinishLaunching handler
29
+ expect(api.on).toHaveBeenCalled()
30
+ const calledWithDL = (api.on as any).mock.calls.some((args: any[]) => args[0] === 'didFinishLaunching' && typeof args[1] === 'function')
31
+ expect(calledWithDL).toBe(true)
32
+
33
+ // Should log effective platform logging at startup
34
+ const debugCalls = (log.debug as any).mock.calls as Array<string[]>
35
+ const hasStartupLine = debugCalls.some(args => String(args[0]).includes('[SwitchBot HAP] effective platformLogging='))
36
+ expect(hasStartupLine).toBe(true)
37
+
38
+ // Missing credentials results in a debug error log
39
+ // Allow async platform logger to flush
40
+ await new Promise(resolve => setTimeout(resolve, 0))
41
+ const errorCalls = (log.error as any).mock.calls as Array<string[]>
42
+ const hasMissingCreds = errorCalls.some(args => String(args[0]).includes('Missing SwitchBot API credentials'))
43
+ expect(hasMissingCreds).toBe(true)
44
+ })
45
+
46
+ it('adds cached accessories via configureAccessory', async () => {
47
+ const api: any = { on: vi.fn() }
48
+ const log: any = makeLogStub()
49
+
50
+ const platform = new SwitchBotHAPPlatform(log as any, {
51
+ name: 'SwitchBot',
52
+ credentials: {},
53
+ options: { logging: 'debug' },
54
+ devices: [],
55
+ } as any, api)
56
+
57
+ const accessory: any = { displayName: 'Cached Device' }
58
+ await (platform as any).configureAccessory(accessory)
59
+
60
+ // Should be stored in platform.accessories
61
+ expect(Array.isArray((platform as any).accessories)).toBe(true)
62
+ expect((platform as any).accessories.length).toBe(1)
63
+
64
+ // And should log the cache load message including device name
65
+ await new Promise(resolve => setTimeout(resolve, 0))
66
+ const infoCalls = (log.info as any).mock.calls as Array<string[]>
67
+ const hasLine = infoCalls.some(args => String(args[0]).includes('Loading accessory from cache: Cached Device'))
68
+ expect(hasLine).toBe(true)
69
+ })
70
+ })
@@ -0,0 +1,33 @@
1
+ import { vi } from 'vitest'
2
+
3
+ // Shared test helpers for platform-matter tests
4
+ export function makeApiStub(matterProps: Record<string, any> = {}) {
5
+ const handlers: Record<string, (...args: any[]) => any> = {}
6
+
7
+ const api: any = {
8
+ matter: {
9
+ uuid: { generate: (s: string) => `uuid-${s}` },
10
+ registerPlatformAccessories: matterProps.registerPlatformAccessories ?? vi.fn(),
11
+ unregisterPlatformAccessories: matterProps.unregisterPlatformAccessories ?? vi.fn(),
12
+ updateAccessoryState: matterProps.updateAccessoryState ?? vi.fn(),
13
+ clusterNames: matterProps.clusterNames ?? {},
14
+ deviceTypes: matterProps.deviceTypes ?? {},
15
+ },
16
+ isMatterAvailable: matterProps.isMatterAvailable ?? (() => true),
17
+ isMatterEnabled: matterProps.isMatterEnabled ?? (() => true),
18
+ on: (ev: string, fn: (...args: any[]) => any) => { handlers[ev] = fn },
19
+ _handlers: handlers,
20
+ }
21
+
22
+ return api
23
+ }
24
+
25
+ export function makeLogStub() {
26
+ return {
27
+ info: vi.fn(),
28
+ warn: vi.fn(),
29
+ debug: vi.fn(),
30
+ error: vi.fn(),
31
+ success: vi.fn(),
32
+ }
33
+ }
@@ -0,0 +1,24 @@
1
+ import type { API } from 'homebridge'
2
+
3
+ import { describe, expect, it, vi } from 'vitest'
4
+
5
+ import registerPlatform from '../index.js'
6
+ import { PLATFORM_NAME, PLUGIN_NAME } from '../settings.js'
7
+
8
+ describe('index.ts', () => {
9
+ it('should register the platform with homebridge', () => {
10
+ const api = {
11
+ registerPlatform: vi.fn(),
12
+ } as unknown as API
13
+
14
+ registerPlatform(api)
15
+
16
+ // The platform registration now uses a runtime proxy/delegate constructor so
17
+ // assert the call happened and the third argument is a constructor function.
18
+ expect(api.registerPlatform).toHaveBeenCalled()
19
+ const callArgs = (api.registerPlatform as any).mock.calls[0]
20
+ expect(callArgs[0]).toBe(PLUGIN_NAME)
21
+ expect(callArgs[1]).toBe(PLATFORM_NAME)
22
+ expect(typeof callArgs[2]).toBe('function')
23
+ })
24
+ })
@@ -0,0 +1,88 @@
1
+ import { describe, expect, it, vi } from 'vitest'
2
+
3
+ import { BaseMatterAccessory } from '../../../devices-matter/BaseMatterAccessory.js'
4
+
5
+ // Minimal concrete subclass for testing
6
+ class TestAccessory extends BaseMatterAccessory {
7
+ constructor(api: any, log: any, opts?: any) {
8
+ super(api, log, {
9
+ uuid: opts?.uuid ?? api.matter.uuid.generate('test'),
10
+ displayName: opts?.displayName ?? 'Test',
11
+ deviceType: opts?.deviceType ?? ('OnOffLight' as any),
12
+ serialNumber: opts?.serialNumber ?? 'TEST-1',
13
+ manufacturer: opts?.manufacturer ?? 'TestCo',
14
+ model: opts?.model ?? 'T-1',
15
+ firmwareRevision: opts?.firmwareRevision ?? '1.0',
16
+ hardwareRevision: opts?.hardwareRevision ?? '1.0',
17
+ context: opts?.context ?? {},
18
+ clusters: opts?.clusters,
19
+ handlers: opts?.handlers,
20
+ })
21
+ }
22
+ }
23
+
24
+ describe('baseMatterAccessory helpers', () => {
25
+ it('sendOnCommand uses OpenAPI helper and updates state', async () => {
26
+ const update = vi.fn()
27
+ const sendOpenAPI = vi.fn(async () => ({ response: {}, statusCode: 200 }))
28
+ const api: any = { matter: { clusterNames: { OnOff: 'onOff', LevelControl: 'level', ColorControl: 'color' }, uuid: { generate: () => 'uuid-1' }, updateAccessoryState: update } }
29
+ const log: any = { info: vi.fn(), debug: vi.fn(), error: vi.fn(), warn: vi.fn() }
30
+
31
+ const ctx = { deviceId: 'DEV-1', sendOpenAPI, connectionType: 'OpenAPI' }
32
+ const acc = new TestAccessory(api, log, { context: ctx })
33
+
34
+ await acc.sendOnCommand()
35
+
36
+ expect(sendOpenAPI).toHaveBeenCalledWith('turnOn', 'default')
37
+ expect(update).toHaveBeenCalledWith(acc.uuid, 'onOff', { onOff: true })
38
+ })
39
+
40
+ it('sendOnCommand uses BLE helper when connectionType is BLE', async () => {
41
+ const update = vi.fn()
42
+ const sendBLE = vi.fn(async () => true)
43
+ const api: any = { matter: { clusterNames: { OnOff: 'onOff', LevelControl: 'level', ColorControl: 'color' }, uuid: { generate: () => 'uuid-2' }, updateAccessoryState: update } }
44
+ const log: any = { info: vi.fn(), debug: vi.fn(), error: vi.fn(), warn: vi.fn() }
45
+
46
+ const ctx = { deviceId: 'DEV-2', sendBLE, connectionType: 'BLE' }
47
+ const acc = new TestAccessory(api, log, { context: ctx })
48
+
49
+ await acc.sendOnCommand()
50
+
51
+ expect(sendBLE).toHaveBeenCalledWith('turnOn')
52
+ expect(update).toHaveBeenCalledWith(acc.uuid, 'onOff', { onOff: true })
53
+ })
54
+
55
+ it('sendSetBrightness sends percent and updates LevelControl', async () => {
56
+ const update = vi.fn()
57
+ const sendOpenAPI = vi.fn(async () => ({ response: {}, statusCode: 200 }))
58
+ const api: any = { matter: { clusterNames: { OnOff: 'onOff', LevelControl: 'level', ColorControl: 'color' }, uuid: { generate: () => 'uuid-3' }, updateAccessoryState: update } }
59
+ const log: any = { info: vi.fn(), debug: vi.fn(), error: vi.fn(), warn: vi.fn() }
60
+
61
+ const ctx = { deviceId: 'DEV-3', sendOpenAPI, connectionType: 'OpenAPI' }
62
+ const acc = new TestAccessory(api, log, { context: ctx })
63
+
64
+ await acc.sendSetBrightness(50)
65
+
66
+ expect(sendOpenAPI).toHaveBeenCalledWith('setBrightness', '50')
67
+ const expectedLevel = Math.round((50 / 100) * 254)
68
+ expect(update).toHaveBeenCalledWith(acc.uuid, 'level', { currentLevel: expectedLevel })
69
+ })
70
+
71
+ it('sendSetColor sends RGB and updates ColorControl', async () => {
72
+ const update = vi.fn()
73
+ const sendOpenAPI = vi.fn(async () => ({ response: {}, statusCode: 200 }))
74
+ const api: any = { matter: { clusterNames: { OnOff: 'onOff', LevelControl: 'level', ColorControl: 'color' }, uuid: { generate: () => 'uuid-4' }, updateAccessoryState: update } }
75
+ const log: any = { info: vi.fn(), debug: vi.fn(), error: vi.fn(), warn: vi.fn() }
76
+
77
+ const ctx = { deviceId: 'DEV-4', sendOpenAPI, connectionType: 'OpenAPI' }
78
+ const acc = new TestAccessory(api, log, { context: ctx })
79
+
80
+ await acc.sendSetColor(255, 128, 0)
81
+
82
+ expect(sendOpenAPI).toHaveBeenCalledWith('setColor', '255:128:0')
83
+ expect(update).toHaveBeenCalled()
84
+ // Ensure we updated ColorControl cluster with numeric attributes
85
+ const calledWith = (update.mock.calls[0] || update.mock.calls[1])
86
+ expect(calledWith[1] === 'color' || calledWith[1] === api.matter.clusterNames.ColorControl).toBeTruthy()
87
+ })
88
+ })
@@ -0,0 +1,44 @@
1
+ import { describe, expect, it, vi } from 'vitest'
2
+
3
+ import { SwitchBotMatterPlatform } from '../../platform-matter.js'
4
+ import { makeApiStub, makeLogStub } from '../helpers/platform-fixtures.js'
5
+
6
+ describe('additional platform-matter mapping tests', () => {
7
+ it('parses OpenAPI color strings and triggers an update', async () => {
8
+ const updateAccessoryState = vi.fn()
9
+ const api: any = makeApiStub({ updateAccessoryState })
10
+ const log = makeLogStub()
11
+ const platform = new SwitchBotMatterPlatform(log as any, {} as any, api)
12
+
13
+ // Some OpenAPI statuses provide color as comma/colon separated or hex
14
+ await (platform as any).applyStatusToAccessory('uuid-col', { deviceId: 'DEV-COL' } as any, { color: '255:128:64' })
15
+ await (platform as any).applyStatusToAccessory('uuid-col', { deviceId: 'DEV-COL' } as any, { color: '255,128,64' })
16
+ await (platform as any).applyStatusToAccessory('uuid-col', { deviceId: 'DEV-COL' } as any, { color: '#FF8040' })
17
+
18
+ expect(updateAccessoryState).toHaveBeenCalled()
19
+ })
20
+
21
+ it('maps MeterPro CO2 values to Matter updates', async () => {
22
+ const updateAccessoryState = vi.fn()
23
+ const api: any = makeApiStub({ updateAccessoryState })
24
+ const log = makeLogStub()
25
+ const platform = new SwitchBotMatterPlatform(log as any, {} as any, api)
26
+
27
+ await (platform as any).applyStatusToAccessory('uuid-co2', { deviceId: 'DEV-METERPRO' } as any, { co2: 420 })
28
+
29
+ expect(updateAccessoryState).toHaveBeenCalled()
30
+ })
31
+
32
+ it('handles curtain position synonyms (position / slidePosition)', async () => {
33
+ const updateAccessoryState = vi.fn()
34
+ const api: any = makeApiStub({ updateAccessoryState })
35
+ const log = makeLogStub()
36
+ const platform = new SwitchBotMatterPlatform(log as any, {} as any, api)
37
+
38
+ // Provide status with position and slidePosition synonyms
39
+ await (platform as any).applyStatusToAccessory('uuid-cur', { deviceId: 'DEV-CUR', deviceType: 'Curtain' } as any, { position: 30 })
40
+ await (platform as any).applyStatusToAccessory('uuid-cur', { deviceId: 'DEV-CUR', deviceType: 'Curtain' } as any, { slidePosition: 70 })
41
+
42
+ expect(updateAccessoryState).toHaveBeenCalled()
43
+ })
44
+ })
@@ -0,0 +1,47 @@
1
+ import { describe, expect, it, vi } from 'vitest'
2
+
3
+ import { SwitchBotMatterPlatform } from '../../platform-matter.js'
4
+ import { makeApiStub, makeLogStub } from '../helpers/platform-fixtures.js'
5
+
6
+ describe('platform-matter BLE advertisement parser', () => {
7
+ it('parses extended serviceData fields correctly', () => {
8
+ const updateAccessoryState = vi.fn()
9
+ const api: any = makeApiStub({ updateAccessoryState })
10
+
11
+ const log: any = makeLogStub()
12
+ const platform = new SwitchBotMatterPlatform(log as any, {} as any, api)
13
+
14
+ const dev: any = { deviceId: 'DEV-TEST' }
15
+ const sd = {
16
+ temp: 22.3,
17
+ humid: 45,
18
+ pm25: 12,
19
+ pm10: 34,
20
+ voc: 120,
21
+ co2: 420,
22
+ motion: 1,
23
+ open: 0,
24
+ leak: 0,
25
+ position: 30,
26
+ fanSpeed: 75,
27
+ battery: 88,
28
+ rgb: '255:128:64',
29
+ }
30
+
31
+ const parsed = (platform as any).parseAdvertisementForDevice(dev, sd)
32
+ expect(parsed).toBeTruthy()
33
+ expect(parsed.temperature).toBeCloseTo(22.3)
34
+ expect(parsed.humidity).toBe(45)
35
+ expect(parsed.pm25).toBe(12)
36
+ expect(parsed.pm10).toBe(34)
37
+ expect(parsed.voc).toBe(120)
38
+ expect(parsed.co2).toBe(420)
39
+ expect(parsed.motion).toBeTruthy()
40
+ expect(parsed.contact).toBeDefined()
41
+ expect(parsed.leak).toBeFalsy()
42
+ expect(parsed.position).toBe(30)
43
+ expect(parsed.fanSpeed).toBe(75)
44
+ expect(parsed.battery).toBe(88)
45
+ expect(parsed.color).toEqual({ r: 255, g: 128, b: 64 })
46
+ })
47
+ })
@@ -0,0 +1,86 @@
1
+ import { describe, expect, it, vi } from 'vitest'
2
+
3
+ import { SwitchBotMatterPlatform } from '../../platform-matter.js'
4
+ import { formatDeviceIdAsMac } from '../../utils.js'
5
+ import { makeApiStub, makeLogStub } from '../helpers/platform-fixtures.js'
6
+
7
+ describe('platform-matter lifecycle cleanup', () => {
8
+ it('clearDeviceResources removes timers, instances and BLE handler entries', async () => {
9
+ // Setup stubbed API and logs
10
+ const handlers: Record<string, (...args: any[]) => any> = {}
11
+ const api: any = makeApiStub({ registerPlatformAccessories: vi.fn(), unregisterPlatformAccessories: vi.fn(), clusterNames: { OnOff: 'OnOff' } })
12
+ api._handlers = handlers
13
+ // keep api.on as a single-statement arrow to satisfy lint
14
+ api.on = (ev: string, fn: (...args: any[]) => any) => (handlers[ev] = fn)
15
+
16
+ const log = makeLogStub()
17
+
18
+ const platform = new SwitchBotMatterPlatform(log as any, {} as any, api)
19
+
20
+ // Insert a fake timer, accessory instance, and BLE handler
21
+ const deviceId = 'AA:BB:CC:11:22:33'
22
+ const nid = (platform as any).normalizeDeviceId(deviceId)
23
+
24
+ const timer = setInterval(() => {}, 100000)
25
+ ;(platform as any).refreshTimers.set(nid, timer)
26
+ ;(platform as any).accessoryInstances.set(nid, { dummy: true })
27
+ ;(platform as any).bleEventHandler[deviceId.toLowerCase()] = () => {}
28
+
29
+ // Ensure they exist prior
30
+ expect((platform as any).refreshTimers.get(nid)).toBeDefined()
31
+ expect((platform as any).accessoryInstances.get(nid)).toBeDefined()
32
+ expect((platform as any).bleEventHandler[deviceId.toLowerCase()]).toBeDefined()
33
+
34
+ // Call the private helper
35
+ ;(platform as any).clearDeviceResources(deviceId)
36
+
37
+ // Now they should be removed
38
+ expect((platform as any).refreshTimers.get(nid)).toBeUndefined()
39
+ expect((platform as any).accessoryInstances.get(nid)).toBeUndefined()
40
+ expect((platform as any).bleEventHandler[deviceId.toLowerCase()]).toBeUndefined()
41
+ })
42
+
43
+ it('shutdown handler clears all timers and handlers when invoked', async () => {
44
+ // Setup stubbed API and logs
45
+ const handlers: Record<string, (...args: any[]) => any> = {}
46
+ const api: any = makeApiStub({ registerPlatformAccessories: vi.fn(), unregisterPlatformAccessories: vi.fn(), clusterNames: { OnOff: 'OnOff' } })
47
+ api._handlers = handlers
48
+ // keep api.on as a single-statement arrow to satisfy lint
49
+ api.on = (ev: string, fn: (...args: any[]) => any) => (handlers[ev] = fn)
50
+
51
+ const log = makeLogStub()
52
+
53
+ const platform = new SwitchBotMatterPlatform(log as any, {} as any, api)
54
+
55
+ // Add two timers to the platform (using normalized ids)
56
+ const ids = ['devA', 'devB']
57
+ for (const id of ids) {
58
+ const nid = (platform as any).normalizeDeviceId(id)
59
+ const t = setInterval(() => {}, 100000)
60
+ ;(platform as any).refreshTimers.set(nid, t)
61
+ ;(platform as any).accessoryInstances.set(nid, { dummy: true })
62
+ try {
63
+ const mac = formatDeviceIdAsMac(id).toLowerCase()
64
+ ;(platform as any).bleEventHandler[mac] = () => {}
65
+ } catch {
66
+ // ignore formatting errors in this test
67
+ }
68
+ }
69
+
70
+ // Invoke didFinishLaunching to ensure the platform registered its shutdown handler
71
+ await Promise.resolve(api._handlers.didFinishLaunching?.())
72
+
73
+ // Shutdown handler should now be registered on api._handlers.shutdown
74
+ expect(typeof api._handlers.shutdown).toBe('function')
75
+
76
+ // Call the shutdown handler
77
+ await Promise.resolve(api._handlers.shutdown())
78
+
79
+ // All refresh timers should be cleared
80
+ for (const id of ids) {
81
+ const nid = (platform as any).normalizeDeviceId(id)
82
+ expect((platform as any).refreshTimers.get(nid)).toBeUndefined()
83
+ expect((platform as any).accessoryInstances.get(nid)).toBeUndefined()
84
+ }
85
+ })
86
+ })
@@ -0,0 +1,37 @@
1
+ import { describe, expect, it, vi } from 'vitest'
2
+
3
+ import { SwitchBotMatterPlatform } from '../../platform-matter.js'
4
+ import { makeApiStub, makeLogStub } from '../helpers/platform-fixtures.js'
5
+
6
+ describe('keepStaleAccessories config flag behavior', () => {
7
+ it('keeps previously-registered accessories when options.keepStaleAccessories=true', async () => {
8
+ const unregister = vi.fn()
9
+ const register = vi.fn()
10
+ const api: any = makeApiStub({ unregisterPlatformAccessories: unregister, registerPlatformAccessories: register })
11
+
12
+ const log: any = makeLogStub()
13
+
14
+ // Create platform with keepStaleAccessories = true
15
+ const platform = new SwitchBotMatterPlatform(log as any, { options: { keepStaleAccessories: true } } as any, api)
16
+
17
+ // Seed discovered devices (one device)
18
+ ;(platform as any).discoveredDevices = [{ deviceId: 'DEV1', deviceType: 'Plug', deviceName: 'Device 1' }]
19
+
20
+ // Insert a stale accessory into matterAccessories
21
+ const staleUuid = api.matter.uuid.generate('stale-device')
22
+ const staleAcc: any = { uuid: staleUuid, displayName: 'Stale', context: { deviceId: 'STALE_DEVICE' } }
23
+ ;(platform as any).matterAccessories.set(staleUuid, staleAcc)
24
+
25
+ // Mock createAccessoryFromDevice to return a simple accessory for DEV1
26
+ vi.spyOn(platform as any, 'createAccessoryFromDevice').mockResolvedValue({ displayName: 'Device 1', uuid: 'uuid-DEV1', context: { deviceId: 'DEV1' } } as any)
27
+
28
+ // Run registration which includes stale-removal logic
29
+ await (platform as any).registerMatterAccessories()
30
+
31
+ // Expect unregister NOT called (we kept stale accessory)
32
+ expect(unregister).not.toHaveBeenCalled()
33
+
34
+ // Stale accessory should still be present in matterAccessories
35
+ expect((platform as any).matterAccessories.get(staleUuid)).toBeDefined()
36
+ })
37
+ })
@@ -0,0 +1,33 @@
1
+ import { describe, expect, it } from 'vitest'
2
+
3
+ import { SwitchBotMatterPlatform } from '../../platform-matter.js'
4
+ import { makeApiStub, makeLogStub } from '../helpers/platform-fixtures.js'
5
+
6
+ /**
7
+ * Verifies that debug logger formats arguments so that accessory displayName
8
+ * appears in the output for cached accessory load logs.
9
+ */
10
+ describe('platform-matter logging', () => {
11
+ it('prints accessory name when loading cached Matter accessory', async () => {
12
+ const api: any = makeApiStub()
13
+ const log: any = makeLogStub()
14
+
15
+ const platform = new SwitchBotMatterPlatform(log as any, {
16
+ name: 'SwitchBot',
17
+ credentials: {},
18
+ options: { logging: 'debug' },
19
+ } as any, api)
20
+
21
+ // Simulate Homebridge restoring a cached Matter accessory
22
+ const acc: any = { uuid: 'uuid-TEST', displayName: 'Test Device', context: { deviceId: 'DEV1' } }
23
+ ;(platform as any).configureMatterAccessory(acc)
24
+ // debugLog is async and gated; yield to allow the logger to run
25
+ await new Promise(resolve => setTimeout(resolve, 0))
26
+
27
+ // In 'debug' mode, debugLog uses log.info with a [DEBUG] prefix
28
+ // Ensure one of the info calls contains the message with the device name
29
+ const calls = (log.info as any).mock.calls as Array<string[]>
30
+ const hasLine = calls.some(args => String(args[0]).includes('Loading cached Matter accessory: Test Device'))
31
+ expect(hasLine).toBe(true)
32
+ })
33
+ })
@@ -0,0 +1,57 @@
1
+ import { describe, expect, it, vi } from 'vitest'
2
+
3
+ import { SwitchBotMatterPlatform } from '../../platform-matter.js'
4
+ import { makeApiStub, makeLogStub } from '../helpers/platform-fixtures.js'
5
+
6
+ describe('platform-matter mapping helper', () => {
7
+ it('prefers accessory instance update methods for battery and falls back to api.matter.updateAccessoryState', async () => {
8
+ const updateAccessoryState = vi.fn()
9
+ const api: any = makeApiStub({ updateAccessoryState, clusterNames: { OnOff: 'OnOff', LevelControl: 'LevelControl', ColorControl: 'ColorControl', PowerSource: 'powerSource' } })
10
+
11
+ const log: any = makeLogStub()
12
+ const platform = new SwitchBotMatterPlatform(log as any, {} as any, api)
13
+
14
+ // Create a fake accessory instance with updateBatteryPercentage
15
+ const deviceId = 'DEV123'
16
+ const nid = (platform as any).normalizeDeviceId(deviceId)
17
+ const fakeInstance = { updateBatteryPercentage: vi.fn() }
18
+ ;(platform as any).accessoryInstances.set(nid, fakeInstance)
19
+
20
+ // Call the private helper with different battery field names
21
+ await (platform as any).applyStatusToAccessory('uuid-test', { deviceId } as any, { batteryPercentage: 55 })
22
+ expect(fakeInstance.updateBatteryPercentage).toHaveBeenCalled()
23
+
24
+ // Remove instance to force fallback
25
+ ;(platform as any).accessoryInstances.delete(nid)
26
+ await (platform as any).applyStatusToAccessory('uuid-test', { deviceId } as any, { battery: 30 })
27
+ expect(updateAccessoryState).toHaveBeenCalled()
28
+ })
29
+
30
+ it('handles temperature and humidity synonyms', async () => {
31
+ const updateAccessoryState = vi.fn()
32
+ const api: any = makeApiStub({ updateAccessoryState })
33
+
34
+ const log: any = makeLogStub()
35
+ const platform = new SwitchBotMatterPlatform(log as any, {} as any, api)
36
+
37
+ const deviceId = 'DEV-TEMP'
38
+ await (platform as any).applyStatusToAccessory('uuid-temp', { deviceId } as any, { temp: 21.5, humid: 48 })
39
+
40
+ // Expect updateAccessoryState to have been called for temperature and humidity
41
+ expect(updateAccessoryState).toHaveBeenCalled()
42
+ })
43
+
44
+ it('applies VOC and PM10 mappings when present', async () => {
45
+ const updateAccessoryState = vi.fn()
46
+ const api: any = makeApiStub({ updateAccessoryState })
47
+
48
+ const log: any = makeLogStub()
49
+ const platform = new SwitchBotMatterPlatform(log as any, {} as any, api)
50
+
51
+ const deviceId = 'DEV-AQ'
52
+ await (platform as any).applyStatusToAccessory('uuid-aq', { deviceId } as any, { voc: 123, pm10: 56 })
53
+
54
+ // Expect updateAccessoryState (or safeUpdate fallback) to have been called for voc and pm10
55
+ expect(updateAccessoryState).toHaveBeenCalled()
56
+ })
57
+ })