@switchbot/homebridge-switchbot 5.0.0-beta.6 → 5.0.0-beta.60
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.
- package/CHANGELOG.md +15 -0
- package/README.md +45 -3
- package/config.schema.json +866 -13754
- package/dist/devices-hap/airpurifier.d.ts.map +1 -1
- package/dist/devices-hap/airpurifier.js +12 -6
- package/dist/devices-hap/airpurifier.js.map +1 -1
- package/dist/devices-hap/blindtilt.js +3 -3
- package/dist/devices-hap/bot.d.ts.map +1 -1
- package/dist/devices-hap/bot.js +16 -5
- package/dist/devices-hap/bot.js.map +1 -1
- package/dist/devices-hap/ceilinglight.d.ts.map +1 -1
- package/dist/devices-hap/ceilinglight.js +13 -7
- package/dist/devices-hap/ceilinglight.js.map +1 -1
- package/dist/devices-hap/colorbulb.d.ts.map +1 -1
- package/dist/devices-hap/colorbulb.js +49 -9
- package/dist/devices-hap/colorbulb.js.map +1 -1
- package/dist/devices-hap/contact.js +3 -3
- package/dist/devices-hap/curtain.js +2 -2
- package/dist/devices-hap/curtain.js.map +1 -1
- package/dist/devices-hap/device.d.ts +18 -8
- package/dist/devices-hap/device.d.ts.map +1 -1
- package/dist/devices-hap/device.js +141 -69
- package/dist/devices-hap/device.js.map +1 -1
- package/dist/devices-hap/fan.d.ts.map +1 -1
- package/dist/devices-hap/fan.js +12 -6
- package/dist/devices-hap/fan.js.map +1 -1
- package/dist/devices-hap/hub.d.ts.map +1 -1
- package/dist/devices-hap/hub.js +6 -5
- package/dist/devices-hap/hub.js.map +1 -1
- package/dist/devices-hap/humidifier.d.ts +5 -0
- package/dist/devices-hap/humidifier.d.ts.map +1 -1
- package/dist/devices-hap/humidifier.js +92 -4
- package/dist/devices-hap/humidifier.js.map +1 -1
- package/dist/devices-hap/iosensor.d.ts.map +1 -1
- package/dist/devices-hap/iosensor.js +36 -21
- package/dist/devices-hap/iosensor.js.map +1 -1
- package/dist/devices-hap/lightstrip.d.ts.map +1 -1
- package/dist/devices-hap/lightstrip.js +38 -8
- package/dist/devices-hap/lightstrip.js.map +1 -1
- package/dist/devices-hap/lock.d.ts.map +1 -1
- package/dist/devices-hap/lock.js +14 -6
- package/dist/devices-hap/lock.js.map +1 -1
- package/dist/devices-hap/meter.d.ts.map +1 -1
- package/dist/devices-hap/meter.js +6 -5
- package/dist/devices-hap/meter.js.map +1 -1
- package/dist/devices-hap/meterplus.d.ts.map +1 -1
- package/dist/devices-hap/meterplus.js +6 -5
- package/dist/devices-hap/meterplus.js.map +1 -1
- package/dist/devices-hap/meterpro.d.ts.map +1 -1
- package/dist/devices-hap/meterpro.js +7 -6
- package/dist/devices-hap/meterpro.js.map +1 -1
- package/dist/devices-hap/motion.js +3 -3
- package/dist/devices-hap/plug.d.ts.map +1 -1
- package/dist/devices-hap/plug.js +11 -6
- package/dist/devices-hap/plug.js.map +1 -1
- package/dist/devices-hap/relayswitch.js +3 -3
- package/dist/devices-hap/robotvacuumcleaner.d.ts.map +1 -1
- package/dist/devices-hap/robotvacuumcleaner.js +13 -6
- package/dist/devices-hap/robotvacuumcleaner.js.map +1 -1
- package/dist/devices-hap/waterdetector.js +3 -3
- package/dist/devices-matter/BaseMatterAccessory.d.ts +27 -0
- package/dist/devices-matter/BaseMatterAccessory.d.ts.map +1 -1
- package/dist/devices-matter/BaseMatterAccessory.js +169 -5
- package/dist/devices-matter/BaseMatterAccessory.js.map +1 -1
- package/dist/devices-matter/ColorLightAccessory.d.ts.map +1 -1
- package/dist/devices-matter/ColorLightAccessory.js +12 -12
- package/dist/devices-matter/ColorLightAccessory.js.map +1 -1
- package/dist/devices-matter/ColorTemperatureLightAccessory.d.ts.map +1 -1
- package/dist/devices-matter/ColorTemperatureLightAccessory.js +5 -7
- package/dist/devices-matter/ColorTemperatureLightAccessory.js.map +1 -1
- package/dist/devices-matter/DimmableLightAccessory.js +9 -9
- package/dist/devices-matter/DimmableLightAccessory.js.map +1 -1
- package/dist/devices-matter/ExtendedColorLightAccessory.d.ts.map +1 -1
- package/dist/devices-matter/ExtendedColorLightAccessory.js +14 -15
- package/dist/devices-matter/ExtendedColorLightAccessory.js.map +1 -1
- package/dist/devices-matter/OnOffLightAccessory.d.ts.map +1 -1
- package/dist/devices-matter/OnOffLightAccessory.js +8 -16
- package/dist/devices-matter/OnOffLightAccessory.js.map +1 -1
- package/dist/devices-matter/OnOffOutletAccessory.d.ts +2 -0
- package/dist/devices-matter/OnOffOutletAccessory.d.ts.map +1 -1
- package/dist/devices-matter/OnOffOutletAccessory.js +10 -7
- package/dist/devices-matter/OnOffOutletAccessory.js.map +1 -1
- package/dist/devices-matter/OnOffSwitchAccessory.js +2 -2
- package/dist/devices-matter/OnOffSwitchAccessory.js.map +1 -1
- package/dist/devices-matter/RoboticVacuumAccessory.d.ts +29 -43
- package/dist/devices-matter/RoboticVacuumAccessory.d.ts.map +1 -1
- package/dist/devices-matter/RoboticVacuumAccessory.js +287 -262
- package/dist/devices-matter/RoboticVacuumAccessory.js.map +1 -1
- package/dist/homebridge-ui/public/index.html +200 -18
- package/dist/homebridge-ui/server.js +82 -9
- package/dist/homebridge-ui/server.js.map +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +4 -7
- package/dist/index.js.map +1 -1
- package/dist/irdevice/irdevice.d.ts +11 -10
- package/dist/irdevice/irdevice.d.ts.map +1 -1
- package/dist/irdevice/irdevice.js +76 -35
- package/dist/irdevice/irdevice.js.map +1 -1
- package/dist/platform-hap.d.ts +26 -15
- package/dist/platform-hap.d.ts.map +1 -1
- package/dist/platform-hap.js +333 -153
- package/dist/platform-hap.js.map +1 -1
- package/dist/platform-matter.d.ts +93 -6
- package/dist/platform-matter.d.ts.map +1 -1
- package/dist/platform-matter.js +1822 -224
- package/dist/platform-matter.js.map +1 -1
- package/dist/settings.d.ts +58 -7
- package/dist/settings.d.ts.map +1 -1
- package/dist/settings.js.map +1 -1
- package/dist/test/apiRequestTracker.test.d.ts +2 -0
- package/dist/test/apiRequestTracker.test.d.ts.map +1 -0
- package/dist/test/apiRequestTracker.test.js +392 -0
- package/dist/test/apiRequestTracker.test.js.map +1 -0
- package/dist/test/hap/device-webhook-context.test.d.ts +2 -0
- package/dist/test/hap/device-webhook-context.test.d.ts.map +1 -0
- package/dist/test/hap/device-webhook-context.test.js +128 -0
- package/dist/test/hap/device-webhook-context.test.js.map +1 -0
- package/dist/test/hap/platform-hap.logging.test.d.ts +2 -0
- package/dist/test/hap/platform-hap.logging.test.d.ts.map +1 -0
- package/dist/test/hap/platform-hap.logging.test.js +33 -0
- package/dist/test/hap/platform-hap.logging.test.js.map +1 -0
- package/dist/test/hap/platform-hap.test.d.ts +2 -0
- package/dist/test/hap/platform-hap.test.d.ts.map +1 -0
- package/dist/test/hap/platform-hap.test.js +62 -0
- package/dist/test/hap/platform-hap.test.js.map +1 -0
- package/dist/test/helpers/platform-fixtures.d.ts +9 -0
- package/dist/test/helpers/platform-fixtures.d.ts.map +1 -0
- package/dist/test/helpers/platform-fixtures.js +30 -0
- package/dist/test/helpers/platform-fixtures.js.map +1 -0
- package/dist/test/homebridge-ui/server.test.d.ts +2 -0
- package/dist/test/homebridge-ui/server.test.d.ts.map +1 -0
- package/dist/test/homebridge-ui/server.test.js +445 -0
- package/dist/test/homebridge-ui/server.test.js.map +1 -0
- package/dist/{index.test.d.ts.map → test/index.test.d.ts.map} +1 -1
- package/dist/test/index.test.js +19 -0
- package/dist/test/index.test.js.map +1 -0
- package/dist/test/matter/devices-matter/baseMatterAccessory.test.d.ts +2 -0
- package/dist/test/matter/devices-matter/baseMatterAccessory.test.d.ts.map +1 -0
- package/dist/test/matter/devices-matter/baseMatterAccessory.test.js +71 -0
- package/dist/test/matter/devices-matter/baseMatterAccessory.test.js.map +1 -0
- package/dist/test/matter/devices-matter/roboticVacuumAccessory.test.d.ts +2 -0
- package/dist/test/matter/devices-matter/roboticVacuumAccessory.test.d.ts.map +1 -0
- package/dist/test/matter/devices-matter/roboticVacuumAccessory.test.js +366 -0
- package/dist/test/matter/devices-matter/roboticVacuumAccessory.test.js.map +1 -0
- package/dist/test/matter/platform-matter.additional.test.d.ts +2 -0
- package/dist/test/matter/platform-matter.additional.test.d.ts.map +1 -0
- package/dist/test/matter/platform-matter.additional.test.js +35 -0
- package/dist/test/matter/platform-matter.additional.test.js.map +1 -0
- package/dist/test/matter/platform-matter.bleparse.test.d.ts +2 -0
- package/dist/test/matter/platform-matter.bleparse.test.d.ts.map +1 -0
- package/dist/test/matter/platform-matter.bleparse.test.js +43 -0
- package/dist/test/matter/platform-matter.bleparse.test.js.map +1 -0
- package/dist/test/matter/platform-matter.cleanup.test.d.ts +2 -0
- package/dist/test/matter/platform-matter.cleanup.test.d.ts.map +1 -0
- package/dist/test/matter/platform-matter.cleanup.test.js +70 -0
- package/dist/test/matter/platform-matter.cleanup.test.js.map +1 -0
- package/dist/test/matter/platform-matter.keepstale.test.d.ts +2 -0
- package/dist/test/matter/platform-matter.keepstale.test.d.ts.map +1 -0
- package/dist/test/matter/platform-matter.keepstale.test.js +27 -0
- package/dist/test/matter/platform-matter.keepstale.test.js.map +1 -0
- package/dist/test/matter/platform-matter.logging.test.d.ts +2 -0
- package/dist/test/matter/platform-matter.logging.test.d.ts.map +1 -0
- package/dist/test/matter/platform-matter.logging.test.js +29 -0
- package/dist/test/matter/platform-matter.logging.test.js.map +1 -0
- package/dist/test/matter/platform-matter.mapping.test.d.ts +2 -0
- package/dist/test/matter/platform-matter.mapping.test.d.ts.map +1 -0
- package/dist/test/matter/platform-matter.mapping.test.js +43 -0
- package/dist/test/matter/platform-matter.mapping.test.js.map +1 -0
- package/dist/test/matter/platform-matter.openapi-mapping.test.d.ts +2 -0
- package/dist/test/matter/platform-matter.openapi-mapping.test.d.ts.map +1 -0
- package/dist/test/matter/platform-matter.openapi-mapping.test.js +84 -0
- package/dist/test/matter/platform-matter.openapi-mapping.test.js.map +1 -0
- package/dist/test/matter/platform-matter.test.d.ts +2 -0
- package/dist/test/matter/platform-matter.test.d.ts.map +1 -0
- package/dist/test/matter/platform-matter.test.js +117 -0
- package/dist/test/matter/platform-matter.test.js.map +1 -0
- package/dist/test/matter/platform-matter.unregister.test.d.ts +2 -0
- package/dist/test/matter/platform-matter.unregister.test.d.ts.map +1 -0
- package/dist/test/matter/platform-matter.unregister.test.js +30 -0
- package/dist/test/matter/platform-matter.unregister.test.js.map +1 -0
- package/dist/test/matter/platform-matter.webhook.test.d.ts +2 -0
- package/dist/test/matter/platform-matter.webhook.test.d.ts.map +1 -0
- package/dist/test/matter/platform-matter.webhook.test.js +46 -0
- package/dist/test/matter/platform-matter.webhook.test.js.map +1 -0
- package/dist/test/utils.test.d.ts +2 -0
- package/dist/test/utils.test.d.ts.map +1 -0
- package/dist/test/utils.test.js +95 -0
- package/dist/test/utils.test.js.map +1 -0
- package/dist/test/verifyconfig.test.d.ts.map +1 -0
- package/dist/{verifyconfig.test.js → test/verifyconfig.test.js} +2 -2
- package/dist/test/verifyconfig.test.js.map +1 -0
- package/dist/utils.d.ts +204 -3
- package/dist/utils.d.ts.map +1 -1
- package/dist/utils.js +713 -33
- package/dist/utils.js.map +1 -1
- package/docs/assets/highlight.css +14 -0
- package/docs/assets/main.js +2 -2
- package/docs/index.html +31 -2
- package/docs/variables/default.html +1 -1
- package/package.json +15 -15
- package/src/devices-hap/airpurifier.ts +11 -6
- package/src/devices-hap/blindtilt.ts +3 -3
- package/src/devices-hap/bot.ts +15 -5
- package/src/devices-hap/ceilinglight.ts +12 -7
- package/src/devices-hap/colorbulb.ts +46 -10
- package/src/devices-hap/contact.ts +3 -3
- package/src/devices-hap/curtain.ts +2 -2
- package/src/devices-hap/device.ts +149 -70
- package/src/devices-hap/fan.ts +11 -6
- package/src/devices-hap/hub.ts +6 -5
- package/src/devices-hap/humidifier.ts +97 -4
- package/src/devices-hap/iosensor.ts +36 -21
- package/src/devices-hap/lightstrip.ts +35 -8
- package/src/devices-hap/lock.ts +13 -6
- package/src/devices-hap/meter.ts +6 -5
- package/src/devices-hap/meterplus.ts +6 -5
- package/src/devices-hap/meterpro.ts +7 -6
- package/src/devices-hap/motion.ts +3 -3
- package/src/devices-hap/plug.ts +10 -6
- package/src/devices-hap/relayswitch.ts +3 -3
- package/src/devices-hap/robotvacuumcleaner.ts +12 -6
- package/src/devices-hap/waterdetector.ts +3 -3
- package/src/devices-matter/BaseMatterAccessory.ts +176 -5
- package/src/devices-matter/ColorLightAccessory.ts +12 -12
- package/src/devices-matter/ColorTemperatureLightAccessory.ts +5 -7
- package/src/devices-matter/DimmableLightAccessory.ts +9 -9
- package/src/devices-matter/ExtendedColorLightAccessory.ts +14 -15
- package/src/devices-matter/OnOffLightAccessory.ts +8 -16
- package/src/devices-matter/OnOffOutletAccessory.ts +12 -7
- package/src/devices-matter/OnOffSwitchAccessory.ts +2 -2
- package/src/devices-matter/RoboticVacuumAccessory.ts +340 -313
- package/src/homebridge-ui/public/index.html +200 -18
- package/src/homebridge-ui/server.ts +85 -9
- package/src/index.ts +4 -7
- package/src/irdevice/irdevice.ts +74 -35
- package/src/platform-hap.ts +365 -169
- package/src/platform-matter.ts +1872 -229
- package/src/settings.ts +62 -3
- package/src/test/apiRequestTracker.test.ts +417 -0
- package/src/test/hap/device-webhook-context.test.ts +136 -0
- package/src/test/hap/platform-hap.logging.test.ts +36 -0
- package/src/test/hap/platform-hap.test.ts +70 -0
- package/src/test/helpers/platform-fixtures.ts +33 -0
- package/src/test/homebridge-ui/server.test.ts +486 -0
- package/src/test/index.test.ts +24 -0
- package/src/test/matter/devices-matter/baseMatterAccessory.test.ts +88 -0
- package/src/test/matter/devices-matter/roboticVacuumAccessory.test.ts +453 -0
- package/src/test/matter/platform-matter.additional.test.ts +44 -0
- package/src/test/matter/platform-matter.bleparse.test.ts +47 -0
- package/src/test/matter/platform-matter.cleanup.test.ts +86 -0
- package/src/test/matter/platform-matter.keepstale.test.ts +37 -0
- package/src/test/matter/platform-matter.logging.test.ts +33 -0
- package/src/test/matter/platform-matter.mapping.test.ts +57 -0
- package/src/test/matter/platform-matter.openapi-mapping.test.ts +109 -0
- package/src/test/matter/platform-matter.test.ts +144 -0
- package/src/test/matter/platform-matter.unregister.test.ts +39 -0
- package/src/test/matter/platform-matter.webhook.test.ts +54 -0
- package/src/test/utils.test.ts +96 -0
- package/src/{verifyconfig.test.ts → test/verifyconfig.test.ts} +12 -11
- package/src/utils.ts +777 -36
- package/dist/index.test.js +0 -14
- package/dist/index.test.js.map +0 -1
- package/dist/verifyconfig.test.d.ts.map +0 -1
- package/dist/verifyconfig.test.js.map +0 -1
- package/src/index.test.ts +0 -19
- /package/dist/{index.test.d.ts → test/index.test.d.ts} +0 -0
- /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
|
|
@@ -45,12 +53,46 @@ export interface options {
|
|
|
45
53
|
disableLogsforOpenAPI?: boolean
|
|
46
54
|
hostname?: string
|
|
47
55
|
webhookURL?: string
|
|
56
|
+
/**
|
|
57
|
+
* When true, enables webhook support for all devices by default.
|
|
58
|
+
* Individual devices can override this with their own webhook setting.
|
|
59
|
+
* Requires webhookURL to be configured.
|
|
60
|
+
*/
|
|
61
|
+
webhook?: boolean
|
|
48
62
|
maxRetries?: number
|
|
49
63
|
delayBetweenRetries?: number
|
|
50
64
|
refreshRate?: number
|
|
51
65
|
updateRate?: number
|
|
52
66
|
pushRate?: number
|
|
53
67
|
logging?: string
|
|
68
|
+
/**
|
|
69
|
+
* Maximum number of SwitchBot OpenAPI requests allowed per day.
|
|
70
|
+
* Defaults to 10,000 if not specified.
|
|
71
|
+
*/
|
|
72
|
+
dailyApiLimit?: number
|
|
73
|
+
/**
|
|
74
|
+
* Number of daily API requests reserved for user-initiated commands.
|
|
75
|
+
* When remaining budget falls below this reserve, background polling and discovery
|
|
76
|
+
* are paused until the daily counter resets. Defaults to 1,000.
|
|
77
|
+
*/
|
|
78
|
+
dailyApiReserveForCommands?: number
|
|
79
|
+
/**
|
|
80
|
+
* When true, the plugin will completely stop background polling/discovery
|
|
81
|
+
* once the remaining daily budget reaches the reserve (webhook-only mode).
|
|
82
|
+
* When false, polling continues until the hard daily limit is reached.
|
|
83
|
+
* Default: false.
|
|
84
|
+
*/
|
|
85
|
+
webhookOnlyOnReserve?: boolean
|
|
86
|
+
/**
|
|
87
|
+
* When true, reset the daily API request counter at LOCAL midnight (system timezone).
|
|
88
|
+
* When false (default), reset at UTC midnight. Default: false.
|
|
89
|
+
*/
|
|
90
|
+
dailyApiResetAtLocalMidnight?: boolean
|
|
91
|
+
// Matter platform batch refresh options
|
|
92
|
+
matterBatchRefreshRate?: number
|
|
93
|
+
matterBatchConcurrency?: number
|
|
94
|
+
matterBatchEnabled?: boolean
|
|
95
|
+
matterBatchJitter?: number
|
|
54
96
|
};
|
|
55
97
|
|
|
56
98
|
export type devicesConfig = botConfig | relaySwitch1Config | relaySwitch1PMConfig | meterConfig | meterProConfig | indoorOutdoorSensorConfig | humidifierConfig | curtainConfig | blindTiltConfig | contactConfig | motionConfig | waterDetectorConfig | plugConfig | colorBulbConfig | stripLightConfig | ceilingLightConfig | lockConfig | hubConfig
|
|
@@ -85,6 +127,12 @@ export interface BaseDeviceConfig extends device {
|
|
|
85
127
|
mqttPubOptions?: IClientOptions
|
|
86
128
|
history?: boolean
|
|
87
129
|
webhook?: boolean
|
|
130
|
+
/**
|
|
131
|
+
* When true, applies this device's configuration to all other devices
|
|
132
|
+
* of the same deviceType/configDeviceType (e.g., all Humidifiers).
|
|
133
|
+
* Specific per-device settings will override these template settings.
|
|
134
|
+
*/
|
|
135
|
+
applyToAllDevicesOfType?: boolean
|
|
88
136
|
}
|
|
89
137
|
|
|
90
138
|
export interface botConfig extends BaseDeviceConfig {
|
|
@@ -136,6 +184,11 @@ export interface humidifierConfig extends BaseDeviceConfig {
|
|
|
136
184
|
hide_temperature?: boolean
|
|
137
185
|
convertUnitTo?: string
|
|
138
186
|
set_minStep?: number
|
|
187
|
+
/**
|
|
188
|
+
* When true (Humidifier2 only), exposes a Switch service in HomeKit
|
|
189
|
+
* to trigger the built-in Drying Filter mode via OpenAPI (setMode 8).
|
|
190
|
+
*/
|
|
191
|
+
activate_dryingfilter?: boolean
|
|
139
192
|
};
|
|
140
193
|
|
|
141
194
|
export interface curtainConfig extends BaseDeviceConfig {
|
|
@@ -211,7 +264,7 @@ export interface ceilingLightConfig extends BaseDeviceConfig {
|
|
|
211
264
|
};
|
|
212
265
|
|
|
213
266
|
export interface lockConfig extends BaseDeviceConfig {
|
|
214
|
-
configDeviceType: 'Smart Lock' | 'Smart Lock Pro'
|
|
267
|
+
configDeviceType: 'Smart Lock' | 'Smart Lock Pro' | 'Smart Lock Ultra'
|
|
215
268
|
hide_contactsensor?: boolean
|
|
216
269
|
activate_latchbutton?: boolean
|
|
217
270
|
};
|
|
@@ -244,6 +297,12 @@ export interface irBaseDeviceConfig extends irdevice {
|
|
|
244
297
|
logging?: string
|
|
245
298
|
customOn?: string
|
|
246
299
|
customOff?: string
|
|
300
|
+
/**
|
|
301
|
+
* When true, applies this IR device's configuration to all other IR devices
|
|
302
|
+
* of the same remoteType/configRemoteType (e.g., all IR Fans).
|
|
303
|
+
* Specific per-device settings will override these template settings.
|
|
304
|
+
*/
|
|
305
|
+
applyToAllDevicesOfType?: boolean
|
|
247
306
|
customize?: boolean
|
|
248
307
|
commandType?: string
|
|
249
308
|
disablePushOn?: boolean
|
|
@@ -0,0 +1,417 @@
|
|
|
1
|
+
import type { API, Logging } from 'homebridge'
|
|
2
|
+
|
|
3
|
+
import { existsSync, mkdirSync, readdirSync, readFileSync, rmdirSync, unlinkSync } from 'node:fs'
|
|
4
|
+
import { tmpdir } from 'node:os'
|
|
5
|
+
import { join } from 'node:path'
|
|
6
|
+
|
|
7
|
+
import { describe, expect, it, vi } from 'vitest'
|
|
8
|
+
|
|
9
|
+
import { ApiRequestTracker } from '../utils.js'
|
|
10
|
+
|
|
11
|
+
// Helper to create isolated test environment for each test
|
|
12
|
+
function createTestEnvironment(pluginName = 'SwitchBotTest') {
|
|
13
|
+
const testId = Math.random().toString(36).substring(7)
|
|
14
|
+
const testDir = join(tmpdir(), `switchbot-test-${testId}`)
|
|
15
|
+
|
|
16
|
+
// Create test directory
|
|
17
|
+
if (!existsSync(testDir)) {
|
|
18
|
+
mkdirSync(testDir, { recursive: true })
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
const testStatsFile = join(testDir, `${pluginName.toLowerCase()}-api-stats.json`)
|
|
22
|
+
|
|
23
|
+
// Mock API with a unique storage path per test
|
|
24
|
+
const mockApi = {
|
|
25
|
+
user: {
|
|
26
|
+
storagePath: () => testDir,
|
|
27
|
+
},
|
|
28
|
+
} as unknown as API
|
|
29
|
+
|
|
30
|
+
// Mock logger
|
|
31
|
+
const mockLog = {
|
|
32
|
+
info: vi.fn(),
|
|
33
|
+
warn: vi.fn(),
|
|
34
|
+
error: vi.fn(),
|
|
35
|
+
debug: vi.fn(),
|
|
36
|
+
} as unknown as Logging
|
|
37
|
+
|
|
38
|
+
return { mockApi, mockLog, testStatsFile, testDir }
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
// Cleanup helper
|
|
42
|
+
function cleanup(testDir: string) {
|
|
43
|
+
try {
|
|
44
|
+
if (existsSync(testDir)) {
|
|
45
|
+
const files = readdirSync(testDir)
|
|
46
|
+
for (const file of files) {
|
|
47
|
+
try {
|
|
48
|
+
unlinkSync(join(testDir, file))
|
|
49
|
+
} catch {
|
|
50
|
+
// ignore
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
rmdirSync(testDir)
|
|
54
|
+
}
|
|
55
|
+
} catch {
|
|
56
|
+
// ignore
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
describe('apiRequestTracker', () => {
|
|
61
|
+
describe('initialization', () => {
|
|
62
|
+
it('should create a new tracker with default limits', () => {
|
|
63
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
64
|
+
try {
|
|
65
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest')
|
|
66
|
+
expect(tracker).toBeDefined()
|
|
67
|
+
expect(tracker.getCount()).toBe(0)
|
|
68
|
+
expect(tracker.getDate()).toBe(new Date().toISOString().split('T')[0])
|
|
69
|
+
} finally {
|
|
70
|
+
cleanup(testDir)
|
|
71
|
+
}
|
|
72
|
+
})
|
|
73
|
+
|
|
74
|
+
it('should respect custom daily limit', () => {
|
|
75
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
76
|
+
try {
|
|
77
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest', {
|
|
78
|
+
dailyLimit: 5000,
|
|
79
|
+
reserveForCommands: 500,
|
|
80
|
+
})
|
|
81
|
+
expect(tracker).toBeDefined()
|
|
82
|
+
} finally {
|
|
83
|
+
cleanup(testDir)
|
|
84
|
+
}
|
|
85
|
+
})
|
|
86
|
+
|
|
87
|
+
it('should load existing stats from file', () => {
|
|
88
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
89
|
+
try {
|
|
90
|
+
// Create a tracker, increment, and verify persistence
|
|
91
|
+
const tracker1 = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest')
|
|
92
|
+
tracker1.track()
|
|
93
|
+
tracker1.track()
|
|
94
|
+
expect(tracker1.getCount()).toBe(2)
|
|
95
|
+
|
|
96
|
+
// Create a new tracker instance and verify it loads the count
|
|
97
|
+
const tracker2 = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest')
|
|
98
|
+
expect(tracker2.getCount()).toBe(2)
|
|
99
|
+
} finally {
|
|
100
|
+
cleanup(testDir)
|
|
101
|
+
}
|
|
102
|
+
})
|
|
103
|
+
})
|
|
104
|
+
|
|
105
|
+
describe('track() - legacy method', () => {
|
|
106
|
+
it('should increment the counter', () => {
|
|
107
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
108
|
+
try {
|
|
109
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest')
|
|
110
|
+
expect(tracker.getCount()).toBe(0)
|
|
111
|
+
tracker.track()
|
|
112
|
+
expect(tracker.getCount()).toBe(1)
|
|
113
|
+
tracker.track()
|
|
114
|
+
expect(tracker.getCount()).toBe(2)
|
|
115
|
+
} finally {
|
|
116
|
+
cleanup(testDir)
|
|
117
|
+
}
|
|
118
|
+
})
|
|
119
|
+
|
|
120
|
+
it('should persist count to file', () => {
|
|
121
|
+
const { mockApi, mockLog, testStatsFile, testDir } = createTestEnvironment()
|
|
122
|
+
try {
|
|
123
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest')
|
|
124
|
+
tracker.track()
|
|
125
|
+
tracker.track()
|
|
126
|
+
tracker.track()
|
|
127
|
+
|
|
128
|
+
// Read the stats file directly
|
|
129
|
+
const statsContent = readFileSync(testStatsFile, 'utf8')
|
|
130
|
+
const stats = JSON.parse(statsContent)
|
|
131
|
+
expect(stats.count).toBe(3)
|
|
132
|
+
expect(stats.date).toBe(new Date().toISOString().split('T')[0])
|
|
133
|
+
} finally {
|
|
134
|
+
cleanup(testDir)
|
|
135
|
+
}
|
|
136
|
+
})
|
|
137
|
+
})
|
|
138
|
+
|
|
139
|
+
describe('trySpend() - budget enforcement', () => {
|
|
140
|
+
it('should allow commands when under soft cap', () => {
|
|
141
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
142
|
+
try {
|
|
143
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest', {
|
|
144
|
+
dailyLimit: 100,
|
|
145
|
+
reserveForCommands: 20,
|
|
146
|
+
})
|
|
147
|
+
// Use 50 requests (well under soft cap of 80)
|
|
148
|
+
for (let i = 0; i < 50; i++) {
|
|
149
|
+
expect(tracker.trySpend('command')).toBe(true)
|
|
150
|
+
}
|
|
151
|
+
expect(tracker.getCount()).toBe(50)
|
|
152
|
+
} finally {
|
|
153
|
+
cleanup(testDir)
|
|
154
|
+
}
|
|
155
|
+
})
|
|
156
|
+
|
|
157
|
+
it('should allow polling when under soft cap', () => {
|
|
158
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
159
|
+
try {
|
|
160
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest', {
|
|
161
|
+
dailyLimit: 100,
|
|
162
|
+
reserveForCommands: 20,
|
|
163
|
+
})
|
|
164
|
+
// Use 50 requests
|
|
165
|
+
for (let i = 0; i < 50; i++) {
|
|
166
|
+
expect(tracker.trySpend('poll')).toBe(true)
|
|
167
|
+
}
|
|
168
|
+
expect(tracker.getCount()).toBe(50)
|
|
169
|
+
} finally {
|
|
170
|
+
cleanup(testDir)
|
|
171
|
+
}
|
|
172
|
+
})
|
|
173
|
+
|
|
174
|
+
it('should block polling at soft cap when pausePollingAtReserve is true', () => {
|
|
175
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
176
|
+
try {
|
|
177
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest', {
|
|
178
|
+
dailyLimit: 100,
|
|
179
|
+
reserveForCommands: 20,
|
|
180
|
+
pausePollingAtReserve: true, // Enable soft cap blocking
|
|
181
|
+
})
|
|
182
|
+
// Use up to soft cap (80 requests)
|
|
183
|
+
for (let i = 0; i < 80; i++) {
|
|
184
|
+
tracker.track()
|
|
185
|
+
}
|
|
186
|
+
expect(tracker.getCount()).toBe(80)
|
|
187
|
+
|
|
188
|
+
// Polling should be blocked at soft cap
|
|
189
|
+
expect(tracker.trySpend('poll')).toBe(false)
|
|
190
|
+
expect(tracker.trySpend('discovery')).toBe(false)
|
|
191
|
+
|
|
192
|
+
// Commands should still work
|
|
193
|
+
expect(tracker.trySpend('command')).toBe(true)
|
|
194
|
+
expect(tracker.getCount()).toBe(81)
|
|
195
|
+
} finally {
|
|
196
|
+
cleanup(testDir)
|
|
197
|
+
}
|
|
198
|
+
})
|
|
199
|
+
|
|
200
|
+
it('should block all requests at hard cap', () => {
|
|
201
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
202
|
+
try {
|
|
203
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest', {
|
|
204
|
+
dailyLimit: 100,
|
|
205
|
+
reserveForCommands: 20,
|
|
206
|
+
})
|
|
207
|
+
// Use up to hard cap
|
|
208
|
+
for (let i = 0; i < 100; i++) {
|
|
209
|
+
tracker.track()
|
|
210
|
+
}
|
|
211
|
+
expect(tracker.getCount()).toBe(100)
|
|
212
|
+
|
|
213
|
+
// All request types should be blocked
|
|
214
|
+
expect(tracker.trySpend('poll')).toBe(false)
|
|
215
|
+
expect(tracker.trySpend('discovery')).toBe(false)
|
|
216
|
+
expect(tracker.trySpend('command')).toBe(false)
|
|
217
|
+
expect(tracker.getCount()).toBe(100)
|
|
218
|
+
} finally {
|
|
219
|
+
cleanup(testDir)
|
|
220
|
+
}
|
|
221
|
+
})
|
|
222
|
+
|
|
223
|
+
it('should support batch spending', () => {
|
|
224
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
225
|
+
try {
|
|
226
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest', {
|
|
227
|
+
dailyLimit: 100,
|
|
228
|
+
reserveForCommands: 20,
|
|
229
|
+
})
|
|
230
|
+
expect(tracker.trySpend('poll', 10)).toBe(true)
|
|
231
|
+
expect(tracker.getCount()).toBe(10)
|
|
232
|
+
|
|
233
|
+
expect(tracker.trySpend('command', 5)).toBe(true)
|
|
234
|
+
expect(tracker.getCount()).toBe(15)
|
|
235
|
+
} finally {
|
|
236
|
+
cleanup(testDir)
|
|
237
|
+
}
|
|
238
|
+
})
|
|
239
|
+
})
|
|
240
|
+
|
|
241
|
+
describe('webhookOnlyOnReserve mode', () => {
|
|
242
|
+
it('should continue polling beyond soft cap when pausePollingAtReserve is false', () => {
|
|
243
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
244
|
+
try {
|
|
245
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest', {
|
|
246
|
+
dailyLimit: 100,
|
|
247
|
+
reserveForCommands: 20,
|
|
248
|
+
pausePollingAtReserve: false,
|
|
249
|
+
})
|
|
250
|
+
// Use 85 requests (past soft cap)
|
|
251
|
+
for (let i = 0; i < 85; i++) {
|
|
252
|
+
tracker.track()
|
|
253
|
+
}
|
|
254
|
+
expect(tracker.getCount()).toBe(85)
|
|
255
|
+
|
|
256
|
+
// Polling should still work (not paused at reserve)
|
|
257
|
+
expect(tracker.trySpend('poll')).toBe(true)
|
|
258
|
+
expect(tracker.getCount()).toBe(86)
|
|
259
|
+
} finally {
|
|
260
|
+
cleanup(testDir)
|
|
261
|
+
}
|
|
262
|
+
})
|
|
263
|
+
|
|
264
|
+
it('should stop polling at soft cap when pausePollingAtReserve is true', () => {
|
|
265
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
266
|
+
try {
|
|
267
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest', {
|
|
268
|
+
dailyLimit: 100,
|
|
269
|
+
reserveForCommands: 20,
|
|
270
|
+
pausePollingAtReserve: true,
|
|
271
|
+
})
|
|
272
|
+
// Use up to soft cap
|
|
273
|
+
for (let i = 0; i < 80; i++) {
|
|
274
|
+
tracker.track()
|
|
275
|
+
}
|
|
276
|
+
expect(tracker.getCount()).toBe(80)
|
|
277
|
+
|
|
278
|
+
// Polling should be blocked
|
|
279
|
+
expect(tracker.trySpend('poll')).toBe(false)
|
|
280
|
+
expect(tracker.getCount()).toBe(80)
|
|
281
|
+
|
|
282
|
+
// Commands should still work
|
|
283
|
+
expect(tracker.trySpend('command')).toBe(true)
|
|
284
|
+
expect(tracker.getCount()).toBe(81)
|
|
285
|
+
} finally {
|
|
286
|
+
cleanup(testDir)
|
|
287
|
+
}
|
|
288
|
+
})
|
|
289
|
+
})
|
|
290
|
+
|
|
291
|
+
describe('warning logs', () => {
|
|
292
|
+
it('should log warning when reaching soft cap with pausePollingAtReserve enabled', () => {
|
|
293
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
294
|
+
try {
|
|
295
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest', {
|
|
296
|
+
dailyLimit: 100,
|
|
297
|
+
reserveForCommands: 20,
|
|
298
|
+
pausePollingAtReserve: true, // Enable soft cap warning
|
|
299
|
+
})
|
|
300
|
+
// Use up to soft cap
|
|
301
|
+
for (let i = 0; i < 80; i++) {
|
|
302
|
+
tracker.track()
|
|
303
|
+
}
|
|
304
|
+
|
|
305
|
+
// Trigger soft cap warning by attempting poll (will be blocked)
|
|
306
|
+
tracker.trySpend('poll')
|
|
307
|
+
expect(mockLog.warn).toHaveBeenCalledWith(
|
|
308
|
+
expect.stringContaining('Near daily limit'),
|
|
309
|
+
)
|
|
310
|
+
} finally {
|
|
311
|
+
cleanup(testDir)
|
|
312
|
+
}
|
|
313
|
+
})
|
|
314
|
+
|
|
315
|
+
it('should log error when reaching hard cap', () => {
|
|
316
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
317
|
+
try {
|
|
318
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest', {
|
|
319
|
+
dailyLimit: 100,
|
|
320
|
+
reserveForCommands: 20,
|
|
321
|
+
})
|
|
322
|
+
// Use up to hard cap
|
|
323
|
+
for (let i = 0; i < 100; i++) {
|
|
324
|
+
tracker.track()
|
|
325
|
+
}
|
|
326
|
+
|
|
327
|
+
// Trigger hard cap error
|
|
328
|
+
tracker.trySpend('command')
|
|
329
|
+
expect(mockLog.error).toHaveBeenCalledWith(
|
|
330
|
+
expect.stringContaining('Daily limit'),
|
|
331
|
+
)
|
|
332
|
+
} finally {
|
|
333
|
+
cleanup(testDir)
|
|
334
|
+
}
|
|
335
|
+
})
|
|
336
|
+
})
|
|
337
|
+
|
|
338
|
+
describe('hourly logging', () => {
|
|
339
|
+
it('should log immediately on startup', () => {
|
|
340
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
341
|
+
try {
|
|
342
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest')
|
|
343
|
+
tracker.startHourlyLogging()
|
|
344
|
+
tracker.stopHourlyLogging()
|
|
345
|
+
expect(mockLog.info).toHaveBeenCalledWith(
|
|
346
|
+
expect.stringContaining('[API Stats] Today'),
|
|
347
|
+
)
|
|
348
|
+
} finally {
|
|
349
|
+
cleanup(testDir)
|
|
350
|
+
}
|
|
351
|
+
})
|
|
352
|
+
|
|
353
|
+
it('should stop logging when stopHourlyLogging is called', () => {
|
|
354
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
355
|
+
try {
|
|
356
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest')
|
|
357
|
+
tracker.startHourlyLogging()
|
|
358
|
+
tracker.stopHourlyLogging()
|
|
359
|
+
// Should not throw
|
|
360
|
+
expect(true).toBe(true)
|
|
361
|
+
} finally {
|
|
362
|
+
cleanup(testDir)
|
|
363
|
+
}
|
|
364
|
+
})
|
|
365
|
+
})
|
|
366
|
+
|
|
367
|
+
describe('edge cases', () => {
|
|
368
|
+
it('should handle zero daily limit', () => {
|
|
369
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
370
|
+
try {
|
|
371
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest', {
|
|
372
|
+
dailyLimit: 0,
|
|
373
|
+
reserveForCommands: 0,
|
|
374
|
+
})
|
|
375
|
+
// All requests should be blocked immediately
|
|
376
|
+
expect(tracker.trySpend('poll')).toBe(false)
|
|
377
|
+
expect(tracker.trySpend('command')).toBe(false)
|
|
378
|
+
expect(tracker.getCount()).toBe(0)
|
|
379
|
+
} finally {
|
|
380
|
+
cleanup(testDir)
|
|
381
|
+
}
|
|
382
|
+
})
|
|
383
|
+
|
|
384
|
+
it('should handle reserve larger than limit', () => {
|
|
385
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
386
|
+
try {
|
|
387
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest', {
|
|
388
|
+
dailyLimit: 100,
|
|
389
|
+
reserveForCommands: 150,
|
|
390
|
+
pausePollingAtReserve: true, // Enable soft cap blocking
|
|
391
|
+
})
|
|
392
|
+
// Soft cap would be negative (100 - 150 = -50), clamped to 0
|
|
393
|
+
// With pausePollingAtReserve=true, polling should be blocked immediately
|
|
394
|
+
expect(tracker.trySpend('poll')).toBe(false)
|
|
395
|
+
// Commands up to hard cap should work
|
|
396
|
+
expect(tracker.trySpend('command')).toBe(true)
|
|
397
|
+
} finally {
|
|
398
|
+
cleanup(testDir)
|
|
399
|
+
}
|
|
400
|
+
})
|
|
401
|
+
|
|
402
|
+
it('should handle negative values in config', () => {
|
|
403
|
+
const { mockApi, mockLog, testDir } = createTestEnvironment()
|
|
404
|
+
try {
|
|
405
|
+
const tracker = new ApiRequestTracker(mockApi, mockLog, 'SwitchBotTest', {
|
|
406
|
+
dailyLimit: -100,
|
|
407
|
+
reserveForCommands: -50,
|
|
408
|
+
})
|
|
409
|
+
// Should be treated as 0
|
|
410
|
+
expect(tracker.trySpend('poll')).toBe(false)
|
|
411
|
+
expect(tracker.trySpend('command')).toBe(false)
|
|
412
|
+
} finally {
|
|
413
|
+
cleanup(testDir)
|
|
414
|
+
}
|
|
415
|
+
})
|
|
416
|
+
})
|
|
417
|
+
})
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
/* eslint-disable import/first */
|
|
2
|
+
import { describe, expect, it, vi } from 'vitest'
|
|
3
|
+
// Mock modules used by HAP device base occasionally via platform
|
|
4
|
+
vi.mock('fakegato-history', () => ({ default: () => ({}) }))
|
|
5
|
+
vi.mock('homebridge-lib/EveHomeKitTypes', () => ({ EveHomeKitTypes: class { constructor() {} } }))
|
|
6
|
+
|
|
7
|
+
import { deviceBase } from '../../devices-hap/device.js'
|
|
8
|
+
|
|
9
|
+
// Minimal HAP stub to satisfy deviceBase constructor operations
|
|
10
|
+
function makeHapStub() {
|
|
11
|
+
class Service {
|
|
12
|
+
private _chars: Record<string, any> = {}
|
|
13
|
+
setCharacteristic(k: any, v: any) {
|
|
14
|
+
this._chars[k] = v
|
|
15
|
+
return this
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
getCharacteristic(k: any) {
|
|
19
|
+
return {
|
|
20
|
+
updateValue: (v: any) => {
|
|
21
|
+
this._chars[k] = v
|
|
22
|
+
return this
|
|
23
|
+
},
|
|
24
|
+
} as any
|
|
25
|
+
}
|
|
26
|
+
}
|
|
27
|
+
const Characteristic: any = {
|
|
28
|
+
Manufacturer: 'Manufacturer',
|
|
29
|
+
AppMatchingIdentifier: 'AppMatchingIdentifier',
|
|
30
|
+
Name: 'Name',
|
|
31
|
+
ConfiguredName: 'ConfiguredName',
|
|
32
|
+
Model: 'Model',
|
|
33
|
+
ProductData: 'ProductData',
|
|
34
|
+
SerialNumber: 'SerialNumber',
|
|
35
|
+
HardwareRevision: 'HardwareRevision',
|
|
36
|
+
SoftwareRevision: 'SoftwareRevision',
|
|
37
|
+
FirmwareRevision: 'FirmwareRevision',
|
|
38
|
+
On: 'On',
|
|
39
|
+
}
|
|
40
|
+
;(Service as any).AccessoryInformation = class extends Service {}
|
|
41
|
+
;(Service as any).Outlet = class extends Service {}
|
|
42
|
+
return { Service, Characteristic, Categories: { OUTLET: 7 } }
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
// Minimal PlatformAccessory stub
|
|
46
|
+
function makeAccessoryStub(hap: any, name = 'Test Accessory') {
|
|
47
|
+
const services: any[] = []
|
|
48
|
+
return {
|
|
49
|
+
displayName: name,
|
|
50
|
+
category: 0,
|
|
51
|
+
context: {},
|
|
52
|
+
getService(cls: any) {
|
|
53
|
+
// find existing or create
|
|
54
|
+
const svc = services.find(s => s instanceof cls)
|
|
55
|
+
if (svc) {
|
|
56
|
+
return svc
|
|
57
|
+
}
|
|
58
|
+
const s = new cls()
|
|
59
|
+
services.push(s)
|
|
60
|
+
return s
|
|
61
|
+
},
|
|
62
|
+
addService(cls: any) {
|
|
63
|
+
const s = new cls()
|
|
64
|
+
services.push(s)
|
|
65
|
+
return s
|
|
66
|
+
},
|
|
67
|
+
}
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
// Minimal SwitchBotHAPPlatform-like stub with required surface
|
|
71
|
+
function makePlatformStub(options: any, hap: any) {
|
|
72
|
+
const log = { info: vi.fn(), warn: vi.fn(), debug: vi.fn(), error: vi.fn(), success: vi.fn() }
|
|
73
|
+
return {
|
|
74
|
+
api: { hap },
|
|
75
|
+
log,
|
|
76
|
+
config: { options, credentials: {} },
|
|
77
|
+
debugMode: false,
|
|
78
|
+
// logging helpers used by deviceBase
|
|
79
|
+
infoLog: () => {},
|
|
80
|
+
successLog: () => {},
|
|
81
|
+
debugSuccessLog: () => {},
|
|
82
|
+
warnLog: () => {},
|
|
83
|
+
debugWarnLog: () => {},
|
|
84
|
+
errorLog: () => {},
|
|
85
|
+
debugErrorLog: () => {},
|
|
86
|
+
debugLog: () => {},
|
|
87
|
+
loggingIsDebug: async () => false,
|
|
88
|
+
enablingPlatformLogging: async () => true,
|
|
89
|
+
connectBLE: vi.fn(),
|
|
90
|
+
bleEventHandler: {},
|
|
91
|
+
webhookEventHandler: {},
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
// Create a tiny concrete subclass to instantiate deviceBase
|
|
96
|
+
class TestHAPDevice extends deviceBase {
|
|
97
|
+
// Override any methods that may be invoked by tests if needed
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
describe('hap device base webhook context', () => {
|
|
101
|
+
it('sets accessory.context.webhook=true when global webhook is enabled and device.webhook is undefined', async () => {
|
|
102
|
+
const hap = makeHapStub()
|
|
103
|
+
const accessory: any = makeAccessoryStub(hap, 'Plug Device')
|
|
104
|
+
const platform: any = makePlatformStub({ webhook: true, logging: 'debug' }, hap)
|
|
105
|
+
|
|
106
|
+
const dev: any = {
|
|
107
|
+
deviceId: 'DEV-HAP-1',
|
|
108
|
+
deviceType: 'Plug',
|
|
109
|
+
connectionType: 'OpenAPI',
|
|
110
|
+
// webhook intentionally undefined
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
const d = new TestHAPDevice(platform, accessory, dev)
|
|
114
|
+
// Assert context
|
|
115
|
+
expect(accessory.context.webhook).toBe(true)
|
|
116
|
+
// ensure no unused var warning
|
|
117
|
+
expect(d).toBeDefined()
|
|
118
|
+
})
|
|
119
|
+
|
|
120
|
+
it('keeps accessory.context.webhook=false when device.webhook=false even if global is true', async () => {
|
|
121
|
+
const hap = makeHapStub()
|
|
122
|
+
const accessory: any = makeAccessoryStub(hap, 'Plug Device 2')
|
|
123
|
+
const platform: any = makePlatformStub({ webhook: true, logging: 'debug' }, hap)
|
|
124
|
+
|
|
125
|
+
const dev: any = {
|
|
126
|
+
deviceId: 'DEV-HAP-2',
|
|
127
|
+
deviceType: 'Plug',
|
|
128
|
+
connectionType: 'OpenAPI',
|
|
129
|
+
webhook: false,
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
const d = new TestHAPDevice(platform, accessory, dev)
|
|
133
|
+
expect(accessory.context.webhook).toBe(false)
|
|
134
|
+
expect(d).toBeDefined()
|
|
135
|
+
})
|
|
136
|
+
})
|
|
@@ -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
|
+
})
|