@switchbot/homebridge-switchbot 4.3.2-beta.8 → 4.3.2

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 (222) hide show
  1. package/.github/copilot-instructions.md +328 -0
  2. package/.github/scripts/npm-version-script-esm-auto.js +207 -0
  3. package/.github/workflows/beta-release.yml +8 -12
  4. package/.github/workflows/release.yml +54 -22
  5. package/CHANGELOG.md +1 -1
  6. package/README.md +13 -10
  7. package/config.schema.json +2 -2
  8. package/coverage/base.css +224 -0
  9. package/coverage/block-navigation.js +87 -0
  10. package/coverage/clover.xml +15847 -0
  11. package/coverage/coverage-final.json +42 -0
  12. package/coverage/docs/assets/dmt/dmt-component-data.js.html +85 -0
  13. package/coverage/docs/assets/dmt/dmt-components.js.html +286 -0
  14. package/coverage/docs/assets/dmt/index.html +131 -0
  15. package/coverage/docs/assets/hierarchy.js.html +85 -0
  16. package/coverage/docs/assets/icons.js.html +136 -0
  17. package/coverage/docs/assets/index.html +146 -0
  18. package/coverage/docs/assets/main.js.html +265 -0
  19. package/coverage/favicon.png +0 -0
  20. package/coverage/index.html +191 -0
  21. package/coverage/prettify.css +1 -0
  22. package/coverage/prettify.js +2 -0
  23. package/coverage/sort-arrow-sprite.png +0 -0
  24. package/coverage/sorter.js +196 -0
  25. package/coverage/src/device/blindtilt.ts.html +3238 -0
  26. package/coverage/src/device/bot.ts.html +2803 -0
  27. package/coverage/src/device/ceilinglight.ts.html +2338 -0
  28. package/coverage/src/device/colorbulb.ts.html +2824 -0
  29. package/coverage/src/device/contact.ts.html +1465 -0
  30. package/coverage/src/device/curtain.ts.html +2869 -0
  31. package/coverage/src/device/device.ts.html +2500 -0
  32. package/coverage/src/device/fan.ts.html +2242 -0
  33. package/coverage/src/device/hub.ts.html +1408 -0
  34. package/coverage/src/device/humidifier.ts.html +2116 -0
  35. package/coverage/src/device/index.html +416 -0
  36. package/coverage/src/device/iosensor.ts.html +1375 -0
  37. package/coverage/src/device/lightstrip.ts.html +2617 -0
  38. package/coverage/src/device/lock.ts.html +1963 -0
  39. package/coverage/src/device/meter.ts.html +1372 -0
  40. package/coverage/src/device/meterplus.ts.html +1384 -0
  41. package/coverage/src/device/meterpro.ts.html +1618 -0
  42. package/coverage/src/device/motion.ts.html +1264 -0
  43. package/coverage/src/device/plug.ts.html +1372 -0
  44. package/coverage/src/device/relayswitch.ts.html +2284 -0
  45. package/coverage/src/device/robotvacuumcleaner.ts.html +1810 -0
  46. package/coverage/src/device/waterdetector.ts.html +1294 -0
  47. package/coverage/src/homebridge-ui/index.html +116 -0
  48. package/coverage/src/homebridge-ui/server.ts.html +229 -0
  49. package/coverage/src/index.html +161 -0
  50. package/coverage/src/index.ts.html +124 -0
  51. package/coverage/src/irdevice/airconditioner.ts.html +1687 -0
  52. package/coverage/src/irdevice/airpurifier.ts.html +844 -0
  53. package/coverage/src/irdevice/camera.ts.html +475 -0
  54. package/coverage/src/irdevice/fan.ts.html +766 -0
  55. package/coverage/src/irdevice/index.html +251 -0
  56. package/coverage/src/irdevice/irdevice.ts.html +1117 -0
  57. package/coverage/src/irdevice/light.ts.html +826 -0
  58. package/coverage/src/irdevice/other.ts.html +2458 -0
  59. package/coverage/src/irdevice/tv.ts.html +1222 -0
  60. package/coverage/src/irdevice/vacuumcleaner.ts.html +466 -0
  61. package/coverage/src/irdevice/waterheater.ts.html +469 -0
  62. package/coverage/src/platform.ts.html +8776 -0
  63. package/coverage/src/settings.ts.html +934 -0
  64. package/coverage/src/utils.ts.html +2092 -0
  65. package/dist/device/blindtilt.d.ts.map +1 -1
  66. package/dist/device/blindtilt.js +12 -4
  67. package/dist/device/blindtilt.js.map +1 -1
  68. package/dist/device/bot.d.ts.map +1 -1
  69. package/dist/device/bot.js +12 -4
  70. package/dist/device/bot.js.map +1 -1
  71. package/dist/device/ceilinglight.d.ts.map +1 -1
  72. package/dist/device/ceilinglight.js +18 -7
  73. package/dist/device/ceilinglight.js.map +1 -1
  74. package/dist/device/colorbulb.d.ts.map +1 -1
  75. package/dist/device/colorbulb.js +18 -7
  76. package/dist/device/colorbulb.js.map +1 -1
  77. package/dist/device/contact.d.ts.map +1 -1
  78. package/dist/device/contact.js +6 -2
  79. package/dist/device/contact.js.map +1 -1
  80. package/dist/device/curtain.d.ts.map +1 -1
  81. package/dist/device/curtain.js +12 -4
  82. package/dist/device/curtain.js.map +1 -1
  83. package/dist/device/device.d.ts +5 -7
  84. package/dist/device/device.d.ts.map +1 -1
  85. package/dist/device/device.js +11 -5
  86. package/dist/device/device.js.map +1 -1
  87. package/dist/device/fan.d.ts.map +1 -1
  88. package/dist/device/fan.js +16 -6
  89. package/dist/device/fan.js.map +1 -1
  90. package/dist/device/hub.d.ts +2 -2
  91. package/dist/device/hub.d.ts.map +1 -1
  92. package/dist/device/hub.js +8 -3
  93. package/dist/device/hub.js.map +1 -1
  94. package/dist/device/humidifier.d.ts.map +1 -1
  95. package/dist/device/humidifier.js +16 -6
  96. package/dist/device/humidifier.js.map +1 -1
  97. package/dist/device/iosensor.d.ts.map +1 -1
  98. package/dist/device/iosensor.js +6 -2
  99. package/dist/device/iosensor.js.map +1 -1
  100. package/dist/device/lightstrip.d.ts.map +1 -1
  101. package/dist/device/lightstrip.js +16 -6
  102. package/dist/device/lightstrip.js.map +1 -1
  103. package/dist/device/lock.d.ts.map +1 -1
  104. package/dist/device/lock.js +12 -4
  105. package/dist/device/lock.js.map +1 -1
  106. package/dist/device/meter.d.ts.map +1 -1
  107. package/dist/device/meter.js +6 -2
  108. package/dist/device/meter.js.map +1 -1
  109. package/dist/device/meterplus.d.ts.map +1 -1
  110. package/dist/device/meterplus.js +6 -2
  111. package/dist/device/meterplus.js.map +1 -1
  112. package/dist/device/meterpro.d.ts.map +1 -1
  113. package/dist/device/meterpro.js +7 -4
  114. package/dist/device/meterpro.js.map +1 -1
  115. package/dist/device/motion.d.ts.map +1 -1
  116. package/dist/device/motion.js +6 -2
  117. package/dist/device/motion.js.map +1 -1
  118. package/dist/device/occupancy.d.ts +42 -0
  119. package/dist/device/occupancy.d.ts.map +1 -0
  120. package/dist/device/occupancy.js +349 -0
  121. package/dist/device/occupancy.js.map +1 -0
  122. package/dist/device/plug.d.ts.map +1 -1
  123. package/dist/device/plug.js +12 -4
  124. package/dist/device/plug.js.map +1 -1
  125. package/dist/device/relayswitch.d.ts.map +1 -1
  126. package/dist/device/relayswitch.js +12 -4
  127. package/dist/device/relayswitch.js.map +1 -1
  128. package/dist/device/robotvacuumcleaner.d.ts.map +1 -1
  129. package/dist/device/robotvacuumcleaner.js +14 -5
  130. package/dist/device/robotvacuumcleaner.js.map +1 -1
  131. package/dist/device/waterdetector.d.ts.map +1 -1
  132. package/dist/device/waterdetector.js +6 -2
  133. package/dist/device/waterdetector.js.map +1 -1
  134. package/dist/homebridge-ui/public/index.html +1 -1
  135. package/dist/irdevice/airconditioner.d.ts.map +1 -1
  136. package/dist/irdevice/airconditioner.js +2 -1
  137. package/dist/irdevice/airconditioner.js.map +1 -1
  138. package/dist/irdevice/airpurifier.d.ts +1 -1
  139. package/dist/irdevice/airpurifier.d.ts.map +1 -1
  140. package/dist/irdevice/airpurifier.js +6 -5
  141. package/dist/irdevice/airpurifier.js.map +1 -1
  142. package/dist/irdevice/camera.d.ts.map +1 -1
  143. package/dist/irdevice/camera.js +2 -1
  144. package/dist/irdevice/camera.js.map +1 -1
  145. package/dist/irdevice/fan.d.ts.map +1 -1
  146. package/dist/irdevice/fan.js +2 -1
  147. package/dist/irdevice/fan.js.map +1 -1
  148. package/dist/irdevice/irdevice.d.ts +2 -6
  149. package/dist/irdevice/irdevice.d.ts.map +1 -1
  150. package/dist/irdevice/irdevice.js.map +1 -1
  151. package/dist/irdevice/light.d.ts.map +1 -1
  152. package/dist/irdevice/light.js +2 -1
  153. package/dist/irdevice/light.js.map +1 -1
  154. package/dist/irdevice/other.d.ts.map +1 -1
  155. package/dist/irdevice/other.js +2 -1
  156. package/dist/irdevice/other.js.map +1 -1
  157. package/dist/irdevice/tv.d.ts.map +1 -1
  158. package/dist/irdevice/tv.js +2 -1
  159. package/dist/irdevice/tv.js.map +1 -1
  160. package/dist/irdevice/vacuumcleaner.d.ts.map +1 -1
  161. package/dist/irdevice/vacuumcleaner.js +2 -1
  162. package/dist/irdevice/vacuumcleaner.js.map +1 -1
  163. package/dist/irdevice/waterheater.d.ts.map +1 -1
  164. package/dist/irdevice/waterheater.js +2 -1
  165. package/dist/irdevice/waterheater.js.map +1 -1
  166. package/dist/platform.d.ts +2 -2
  167. package/dist/platform.d.ts.map +1 -1
  168. package/dist/platform.js +77 -78
  169. package/dist/platform.js.map +1 -1
  170. package/dist/settings.d.ts +6 -0
  171. package/dist/settings.d.ts.map +1 -1
  172. package/dist/settings.js +1 -0
  173. package/dist/settings.js.map +1 -1
  174. package/docs/index.html +20 -11
  175. package/docs/variables/default.html +1 -1
  176. package/eslint.config.js +0 -1
  177. package/package.json +7 -8
  178. package/src/device/blindtilt.ts +10 -4
  179. package/src/device/bot.ts +10 -4
  180. package/src/device/ceilinglight.ts +16 -7
  181. package/src/device/colorbulb.ts +16 -7
  182. package/src/device/contact.ts +5 -2
  183. package/src/device/curtain.ts +12 -6
  184. package/src/device/device.ts +14 -8
  185. package/src/device/fan.ts +14 -6
  186. package/src/device/hub.ts +10 -6
  187. package/src/device/humidifier.ts +14 -6
  188. package/src/device/iosensor.ts +5 -2
  189. package/src/device/lightstrip.ts +14 -6
  190. package/src/device/lock.ts +10 -4
  191. package/src/device/meter.ts +6 -3
  192. package/src/device/meterplus.ts +5 -2
  193. package/src/device/meterpro.ts +7 -5
  194. package/src/device/motion.ts +5 -2
  195. package/src/device/occupancy.ts +393 -0
  196. package/src/device/plug.ts +10 -4
  197. package/src/device/relayswitch.ts +10 -4
  198. package/src/device/robotvacuumcleaner.ts +12 -5
  199. package/src/device/waterdetector.ts +5 -2
  200. package/src/homebridge-ui/public/index.html +1 -1
  201. package/src/irdevice/airconditioner.ts +2 -1
  202. package/src/irdevice/airpurifier.ts +6 -5
  203. package/src/irdevice/camera.ts +2 -1
  204. package/src/irdevice/fan.ts +2 -1
  205. package/src/irdevice/irdevice.ts +2 -2
  206. package/src/irdevice/light.ts +2 -1
  207. package/src/irdevice/other.ts +2 -1
  208. package/src/irdevice/tv.ts +2 -1
  209. package/src/irdevice/vacuumcleaner.ts +2 -1
  210. package/src/irdevice/waterheater.ts +2 -1
  211. package/src/platform.ts +80 -88
  212. package/src/settings.ts +7 -0
  213. package/.github/npm-version-script-esm.js +0 -97
  214. package/.github/workflows/build.yml +0 -18
  215. package/.github/workflows/changerelease.yml +0 -11
  216. package/.github/workflows/labeler.yml +0 -16
  217. package/.github/workflows/release-drafter.yml +0 -14
  218. package/dist/device/airpurifier.d.ts +0 -54
  219. package/dist/device/airpurifier.d.ts.map +0 -1
  220. package/dist/device/airpurifier.js +0 -527
  221. package/dist/device/airpurifier.js.map +0 -1
  222. package/src/device/airpurifier.ts +0 -563
@@ -1,563 +0,0 @@
1
- /* Copyright(C) 2021-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
2
- *
3
- * plug.ts: @switchbot/homebridge-switchbot.
4
- */
5
- import type { CharacteristicValue, PlatformAccessory, Service } from 'homebridge'
6
- import type { airPurifierServiceData, airPurifierStatus, airPurifierTableServiceData, airPurifierTableStatus, airPurifierTableWebhookContext, airPurifierWebhookContext, bodyChange, device, SwitchBotBLE, SwitchbotDevice } from 'node-switchbot'
7
-
8
- import type { SwitchBotPlatform } from '../platform.js'
9
- import type { devicesConfig } from '../settings.js'
10
-
11
- /*
12
- * For Testing Locally:
13
- * import { SwitchBotBLEModel, SwitchBotBLEModelName } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
14
- */
15
- import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot'
16
- import { debounceTime, interval, skipWhile, Subject, take, tap } from 'rxjs'
17
-
18
- import { formatDeviceIdAsMac } from '../utils.js'
19
- import { deviceBase } from './device.js'
20
-
21
- export class AirPurifier extends deviceBase {
22
- // Services
23
- private AirPurifier: {
24
- Name: CharacteristicValue
25
- Service: Service
26
- Active: CharacteristicValue
27
- RotationSpeed: CharacteristicValue
28
- CurrentAirPurifierState: CharacteristicValue
29
- TargetAirPurifierState: CharacteristicValue
30
- CurrentHeaterCoolerState: CharacteristicValue
31
- }
32
-
33
- // OpenAPI
34
- deviceStatus!: airPurifierStatus | airPurifierTableStatus
35
-
36
- // Webhook
37
- webhookContext!: airPurifierWebhookContext | airPurifierTableWebhookContext
38
-
39
- // BLE
40
- serviceData!: airPurifierServiceData | airPurifierTableServiceData
41
-
42
- // Updates
43
- airPurifierUpdateInProgress!: boolean
44
- doAirPurifierUpdate!: Subject<void>
45
-
46
- constructor(
47
- readonly platform: SwitchBotPlatform,
48
- accessory: PlatformAccessory,
49
- device: device & devicesConfig,
50
- ) {
51
- super(platform, accessory, device)
52
- // Set category
53
- accessory.category = this.hap.Categories.AIR_PURIFIER
54
-
55
- // this is subject we use to track when we need to POST changes to the SwitchBot API
56
- this.doAirPurifierUpdate = new Subject()
57
- this.airPurifierUpdateInProgress = false
58
-
59
- // Initialize AirPurifier Service
60
- accessory.context.AirPurifier = accessory.context.AirPurifier ?? {}
61
- this.AirPurifier = {
62
- Name: accessory.displayName,
63
- Service: accessory.getService(this.hap.Service.AirPurifier) ?? accessory.addService(this.hap.Service.AirPurifier) as Service,
64
- Active: accessory.context.Active ?? this.hap.Characteristic.Active.INACTIVE,
65
- RotationSpeed: accessory.context.RotationSpeed ?? 0,
66
- CurrentAirPurifierState: accessory.context.CurrentAirPurifierState ?? this.hap.Characteristic.CurrentAirPurifierState.INACTIVE,
67
- TargetAirPurifierState: accessory.context.TargetAirPurifierState ?? this.hap.Characteristic.TargetAirPurifierState.AUTO,
68
- CurrentHeaterCoolerState: accessory.context.CurrentHeaterCoolerState ?? this.hap.Characteristic.CurrentHeaterCoolerState.INACTIVE,
69
- }
70
- accessory.context.AirPurifier = this.AirPurifier as object
71
-
72
- // Initialize AirPurifier Service
73
- this.AirPurifier.Service.setCharacteristic(this.hap.Characteristic.Name, this.AirPurifier.Name).getCharacteristic(this.hap.Characteristic.Active).onGet(() => {
74
- return this.AirPurifier.Active
75
- }).onSet(this.ActiveSet.bind(this))
76
-
77
- // Initialize Fan RotationSpeed Characteristic
78
- this.AirPurifier.Service.getCharacteristic(this.hap.Characteristic.RotationSpeed).onGet(() => {
79
- return this.AirPurifier.RotationSpeed
80
- }).onSet(this.RotationSpeedSet.bind(this))
81
-
82
- // Retrieve initial values and updateHomekit
83
- try {
84
- this.debugLog('Retrieve initial values and update Homekit')
85
- this.refreshStatus()
86
- } catch (e: any) {
87
- this.errorLog(`failed to retrieve initial values and update Homekit, Error: ${e.message ?? e}`)
88
- }
89
-
90
- // regisiter webhook event handler if enabled
91
- try {
92
- this.debugLog('Registering Webhook Event Handler')
93
- this.registerWebhook()
94
- } catch (e: any) {
95
- this.errorLog(`failed to registerWebhook, Error: ${e.message ?? e}`)
96
- }
97
-
98
- // regisiter platform BLE event handler if enabled
99
- try {
100
- this.debugLog('Registering Platform BLE Event Handler')
101
- this.registerPlatformBLE()
102
- } catch (e: any) {
103
- this.errorLog(`failed to registerPlatformBLE, Error: ${e.message ?? e}`)
104
- }
105
-
106
- // Start an update interval
107
- interval(this.deviceRefreshRate * 1000)
108
- .pipe(skipWhile(() => this.airPurifierUpdateInProgress))
109
- .subscribe(async () => {
110
- await this.refreshStatus()
111
- })
112
-
113
- // Watch for Plug change events
114
- // We put in a debounce of 100ms so we don't make duplicate calls
115
- this.doAirPurifierUpdate
116
- .pipe(
117
- tap(() => {
118
- this.airPurifierUpdateInProgress = true
119
- }),
120
- debounceTime(this.devicePushRate * 1000),
121
- )
122
- .subscribe(async () => {
123
- try {
124
- await this.pushChanges()
125
- } catch (e: any) {
126
- await this.apiError(e)
127
- this.errorLog(`failed pushChanges with ${device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
128
- }
129
- this.airPurifierUpdateInProgress = false
130
- })
131
- }
132
-
133
- async BLEparseStatus(): Promise<void> {
134
- this.debugLog('BLEparseStatus')
135
- this.debugLog(`(powerState, fanSpeed) = BLE:(${this.serviceData.isOn}, ${this.serviceData.speed}), current:(${this.AirPurifier.Active}, ${this.AirPurifier.RotationSpeed})`)
136
-
137
- // Active
138
- this.AirPurifier.Active = this.serviceData.isOn ? this.hap.Characteristic.Active.ACTIVE : this.hap.Characteristic.Active.INACTIVE
139
- this.debugLog(`Active: ${this.AirPurifier.Active}`)
140
-
141
- // RotationSpeed
142
- this.AirPurifier.RotationSpeed = this.serviceData.speed
143
- this.debugLog(`RotationSpeed: ${this.AirPurifier.RotationSpeed}`)
144
- }
145
-
146
- async openAPIparseStatus() {
147
- this.debugLog('openAPIparseStatus')
148
- this.debugLog(`(version, power, mode, childLock) = OpenAPI:(${this.deviceStatus.version}, ${this.deviceStatus.power}, ${this.deviceStatus.mode}, ${this.deviceStatus.childLock}), current:(${this.accessory.context.version}, ${this.AirPurifier.Active}, ${this.AirPurifier.TargetAirPurifierState})`)
149
-
150
- // Active - handle both "ON"/"on" and "OFF"/"off"
151
- this.AirPurifier.Active = (this.deviceStatus.power === 'ON' || this.deviceStatus.power === 'on')
152
- ? this.hap.Characteristic.Active.ACTIVE
153
- : this.hap.Characteristic.Active.INACTIVE
154
- this.debugLog(`Active: ${this.AirPurifier.Active}`)
155
-
156
- // Map mode to TargetAirPurifierState
157
- if (this.deviceStatus.mode !== undefined) {
158
- switch (this.deviceStatus.mode) {
159
- case 1: // normal/fan mode
160
- this.AirPurifier.TargetAirPurifierState = this.hap.Characteristic.TargetAirPurifierState.MANUAL
161
- break
162
- case 2: // auto mode
163
- this.AirPurifier.TargetAirPurifierState = this.hap.Characteristic.TargetAirPurifierState.AUTO
164
- break
165
- case 3: // sleep mode
166
- case 4: // pet mode
167
- this.AirPurifier.TargetAirPurifierState = this.hap.Characteristic.TargetAirPurifierState.MANUAL
168
- break
169
- default:
170
- this.AirPurifier.TargetAirPurifierState = this.hap.Characteristic.TargetAirPurifierState.AUTO
171
- }
172
- this.debugLog(`TargetAirPurifierState (mode ${this.deviceStatus.mode}): ${this.AirPurifier.TargetAirPurifierState}`)
173
- }
174
-
175
- // CurrentAirPurifierState based on power
176
- this.AirPurifier.CurrentAirPurifierState = this.AirPurifier.Active
177
- ? this.hap.Characteristic.CurrentAirPurifierState.PURIFYING_AIR
178
- : this.hap.Characteristic.CurrentAirPurifierState.INACTIVE
179
- this.debugLog(`CurrentAirPurifierState: ${this.AirPurifier.CurrentAirPurifierState}`)
180
-
181
- // Firmware Version
182
- if (this.deviceStatus.version) {
183
- const version = this.deviceStatus.version as string
184
- this.debugLog(`Firmware Version: ${version.replace(/^V|-.*$/g, '')}`)
185
- const deviceVersion = version.replace(/^V|-.*$/g, '') ?? '0.0.0'
186
- this.accessory
187
- .getService(this.hap.Service.AccessoryInformation)!
188
- .setCharacteristic(this.hap.Characteristic.HardwareRevision, deviceVersion)
189
- .setCharacteristic(this.hap.Characteristic.FirmwareRevision, deviceVersion)
190
- .getCharacteristic(this.hap.Characteristic.FirmwareRevision)
191
- .updateValue(deviceVersion)
192
- this.accessory.context.version = deviceVersion
193
- this.debugSuccessLog(`version: ${this.accessory.context.version}`)
194
- }
195
- }
196
-
197
- async parseStatusWebhook(): Promise<void> {
198
- this.debugLog('parseStatusWebhook')
199
- this.debugLog(`(power, mode, childLock) = Webhook:(${this.webhookContext.power}, ${this.webhookContext.mode}, ${this.webhookContext.childLock}), current:(${this.AirPurifier.Active}, ${this.AirPurifier.TargetAirPurifierState})`)
200
-
201
- // Active - handle webhook power state
202
- this.AirPurifier.Active = (this.webhookContext.power === 'ON' || this.webhookContext.power === 'on')
203
- ? this.hap.Characteristic.Active.ACTIVE
204
- : this.hap.Characteristic.Active.INACTIVE
205
- this.debugLog(`Active: ${this.AirPurifier.Active}`)
206
-
207
- // Handle mode from webhook if available
208
- if (this.webhookContext.mode !== undefined) {
209
- switch (this.webhookContext.mode) {
210
- case 1:
211
- this.AirPurifier.TargetAirPurifierState = this.hap.Characteristic.TargetAirPurifierState.MANUAL
212
- break
213
- case 2:
214
- this.AirPurifier.TargetAirPurifierState = this.hap.Characteristic.TargetAirPurifierState.AUTO
215
- break
216
- case 3:
217
- case 4:
218
- this.AirPurifier.TargetAirPurifierState = this.hap.Characteristic.TargetAirPurifierState.MANUAL
219
- break
220
- default:
221
- this.AirPurifier.TargetAirPurifierState = this.hap.Characteristic.TargetAirPurifierState.AUTO
222
- }
223
- this.debugLog(`TargetAirPurifierState: ${this.AirPurifier.TargetAirPurifierState}`)
224
- }
225
-
226
- // FirmwareVersion
227
- /* if (this.webhookContext.version) {
228
- const deviceVersion = this.webhookContext.version.replace(/^V|-.*$/g, '') ?? '0.0.0'
229
- this.accessory
230
- .getService(this.hap.Service.AccessoryInformation)!
231
- .setCharacteristic(this.hap.Characteristic.HardwareRevision, deviceVersion)
232
- .setCharacteristic(this.hap.Characteristic.FirmwareRevision, deviceVersion)
233
- .getCharacteristic(this.hap.Characteristic.FirmwareRevision)
234
- .updateValue(deviceVersion)
235
- this.accessory.context.version = deviceVersion
236
- this.debugSuccessLog(`version: ${this.accessory.context.version}`)
237
- } */
238
- }
239
-
240
- /**
241
- * Asks the SwitchBot API for the latest device information
242
- */
243
- async refreshStatus(): Promise<void> {
244
- if (this.BLE) {
245
- await this.BLERefreshStatus()
246
- } else if (this.OpenAPI && this.platform.config.credentials?.token) {
247
- await this.openAPIRefreshStatus()
248
- } else {
249
- await this.offlineOff()
250
- this.debugWarnLog(`Connection Type: ${this.device.connectionType}, refreshStatus will not happen.`)
251
- }
252
- }
253
-
254
- async BLERefreshStatus(): Promise<void> {
255
- this.debugLog('BLERefreshStatus')
256
- const switchBotBLE = await this.switchbotBLE()
257
- if (switchBotBLE === undefined) {
258
- await this.BLERefreshConnection(switchBotBLE)
259
- } else {
260
- // Start to monitor advertisement packets
261
- (async () => {
262
- // Start to monitor advertisement packets
263
- const serviceData = await this.monitorAdvertisementPackets(switchBotBLE) as unknown as airPurifierServiceData | airPurifierTableServiceData
264
- // Update HomeKit
265
- if ((serviceData.model === SwitchBotBLEModel.AirPurifier && SwitchBotBLEModelName.AirPurifier) ?? (serviceData.model === SwitchBotBLEModel.AirPurifierTable && SwitchBotBLEModelName.AirPurifierTable)) {
266
- this.serviceData = serviceData
267
- if (serviceData !== undefined || serviceData !== null) {
268
- await this.BLEparseStatus()
269
- await this.updateHomeKitCharacteristics()
270
- } else {
271
- this.errorLog(`serviceData is either undefined or null, serviceData: ${JSON.stringify(serviceData)}`)
272
- await this.BLERefreshConnection(switchBotBLE)
273
- }
274
- } else {
275
- this.errorLog(`failed to get serviceData, serviceData: ${JSON.stringify(serviceData)}`)
276
- await this.BLERefreshConnection(switchBotBLE)
277
- }
278
- })()
279
- }
280
- }
281
-
282
- async registerPlatformBLE(): Promise<void> {
283
- this.debugLog('registerPlatformBLE')
284
- if (this.config.options?.BLE && !this.device.disablePlatformBLE) {
285
- this.debugLog('is listening to Platform BLE.')
286
- try {
287
- const formattedDeviceId = formatDeviceIdAsMac(this.device.deviceId)
288
- this.device.bleMac = formattedDeviceId
289
- this.debugLog(`bleMac: ${this.device.bleMac}`)
290
- this.platform.bleEventHandler[this.device.bleMac] = async (context: airPurifierServiceData | airPurifierTableServiceData) => {
291
- try {
292
- this.serviceData = context
293
- if (context !== undefined || context !== null) {
294
- this.debugLog(`received BLE: ${JSON.stringify(context)}`)
295
- await this.BLEparseStatus()
296
- await this.updateHomeKitCharacteristics()
297
- } else {
298
- this.errorLog(`context is either undefined or null, context: ${JSON.stringify(context)}`)
299
- await this.BLERefreshConnection(context)
300
- }
301
- } catch (e: any) {
302
- this.errorLog(`failed to handle BLE. Received: ${JSON.stringify(context)} Error: ${e.message ?? e}`)
303
- }
304
- }
305
- } catch (error) {
306
- this.errorLog(`failed to format device ID as MAC, Error: ${error}`)
307
- }
308
- } else {
309
- this.debugLog('is not listening to Platform BLE')
310
- }
311
- }
312
-
313
- async openAPIRefreshStatus(): Promise<void> {
314
- this.debugLog('openAPIRefreshStatus')
315
- try {
316
- const deviceStatus = await this.deviceRefreshStatus<airPurifierStatus>()
317
- this.debugLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`)
318
- if (await this.successfulStatusCodes(deviceStatus)) {
319
- this.debugSuccessLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`)
320
- this.deviceStatus = deviceStatus.body
321
- await this.openAPIparseStatus()
322
- await this.updateHomeKitCharacteristics()
323
- } else {
324
- this.debugWarnLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`)
325
- }
326
- } catch (e: any) {
327
- await this.apiError(e)
328
- this.errorLog(`failed openAPIRefreshStatus with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
329
- }
330
- }
331
-
332
- async registerWebhook() {
333
- if (this.device.webhook) {
334
- this.debugLog('is listening webhook.')
335
- this.platform.webhookEventHandler[this.device.deviceId] = async (context: airPurifierWebhookContext | airPurifierTableWebhookContext) => {
336
- try {
337
- this.webhookContext = context
338
- if (context !== undefined || context !== null) {
339
- this.debugLog(`received Webhook: ${JSON.stringify(context)}`)
340
- await this.parseStatusWebhook()
341
- await this.updateHomeKitCharacteristics()
342
- } else {
343
- this.errorLog(`context is either undefined or null, context: ${JSON.stringify(context)}`)
344
- }
345
- } catch (e: any) {
346
- this.errorLog(`failed to handle webhook. Received: ${JSON.stringify(context)} Error: ${e.message ?? e}`)
347
- }
348
- }
349
- } else {
350
- this.debugLog('is not listening webhook.')
351
- }
352
- }
353
-
354
- /**
355
- * Pushes the requested changes to the SwitchBot API
356
- * commandType command parameter Description
357
- * "command" "turnOff" "default" = set to OFF state
358
- * "command" "turnOn" "default" = set to ON state
359
- * "command" "setNightLightMode" "off, 1, or 2" = off, turn off nightlight, (1, bright) (2, dim)
360
- * "command" "setWindMode" "direct, natural, sleep, or baby" = Set fan mode
361
- * "command" "setWindSpeed" "{1-100} e.g. 10" = Set fan speed 1~100
362
- */
363
-
364
- async pushChanges(): Promise<void> {
365
- if (this.BLE) {
366
- await this.BLEpushChanges()
367
- } else if (this.OpenAPI && this.platform.config.credentials?.token) {
368
- await this.openAPIpushChanges()
369
- if (this.AirPurifier.Active) {
370
- this.debugLog(`Active: ${this.AirPurifier.Active}`)
371
- // Push RotationSpeed Update
372
- this.debugLog(`RotationSpeed: ${this.AirPurifier.RotationSpeed}`)
373
- await this.pushRotationSpeedChanges()
374
- } else {
375
- this.debugLog('BLE (RotationSpeed) & (SwingMode) changes will not happen, as the device is Off.')
376
- }
377
- } else {
378
- await this.offlineOff()
379
- this.debugWarnLog(`Connection Type: ${this.device.connectionType}, pushChanges will not happen.`)
380
- }
381
- // Refresh the status from the API
382
- interval(15000)
383
- .pipe(skipWhile(() => this.airPurifierUpdateInProgress))
384
- .pipe(take(1))
385
- .subscribe(async () => {
386
- await this.refreshStatus()
387
- })
388
- }
389
-
390
- async BLEpushChanges(): Promise<void> {
391
- this.debugLog('BLEpushChanges')
392
- if (this.AirPurifier.Active !== this.accessory.context.Active) {
393
- this.debugLog(`BLEpushChanges On: ${this.AirPurifier.Active} OnCached: ${this.accessory.context.Active}`)
394
- const switchBotBLE = await this.platform.connectBLE(this.accessory, this.device)
395
- try {
396
- const formattedDeviceId = formatDeviceIdAsMac(this.device.deviceId)
397
- this.device.bleMac = formattedDeviceId
398
- this.debugLog(`bleMac: ${this.device.bleMac}`)
399
- if (switchBotBLE !== false) {
400
- switchBotBLE
401
- .discover({ model: this.device.bleModel, id: this.device.bleMac })
402
- .then(async (device_list: SwitchbotDevice[]) => {
403
- return await this.retryBLE({
404
- max: this.maxRetryBLE(),
405
- fn: async () => {
406
- if (this.AirPurifier.Active) {
407
- return await (device_list[0] as any).turnOn()
408
- } else {
409
- return await (device_list[0] as any).turnOff()
410
- }
411
- },
412
- })
413
- })
414
- .then(async () => {
415
- this.successLog(`Active: ${this.AirPurifier.Active} sent over SwitchBot BLE, sent successfully`)
416
- await this.updateHomeKitCharacteristics()
417
- })
418
- .catch(async (e: any) => {
419
- await this.apiError(e)
420
- this.errorLog(`failed BLEpushChanges with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
421
- await this.BLEPushConnection()
422
- })
423
- } else {
424
- this.errorLog(`wasn't able to establish BLE Connection, node-switchbot: ${JSON.stringify(switchBotBLE)}`)
425
- await this.BLEPushConnection()
426
- }
427
- } catch (error) {
428
- this.errorLog(`failed to format device ID as MAC, Error: ${error}`)
429
- }
430
- } else {
431
- this.debugLog(`No change (BLEpushChanges), Active: ${this.AirPurifier.Active}, ActiveCached: ${this.accessory.context.Active}`)
432
- }
433
- }
434
-
435
- async openAPIpushChanges() {
436
- this.debugLog('openAPIpushChanges')
437
- if (this.AirPurifier.Active !== this.accessory.context.Active) {
438
- const command = this.AirPurifier.Active ? 'turnOn' : 'turnOff'
439
- const bodyChange: bodyChange = {
440
- command: `${command}`,
441
- parameter: 'default',
442
- commandType: 'command',
443
- }
444
- this.debugLog(`SwitchBot OpenAPI bodyChange: ${JSON.stringify(bodyChange)}`)
445
- try {
446
- const deviceStatus = await this.pushChangeRequest(bodyChange)
447
- this.debugLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`)
448
- if (await this.successfulStatusCodes(deviceStatus)) {
449
- this.debugSuccessLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`)
450
- await this.updateHomeKitCharacteristics()
451
- } else {
452
- await this.statusCode(deviceStatus.statusCode)
453
- }
454
- } catch (e: any) {
455
- await this.apiError(e)
456
- this.errorLog(`failed openAPIpushChanges with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
457
- }
458
- } else {
459
- this.debugLog(`No changes (openAPIpushChanges), Active: ${this.AirPurifier.Active}, ActiveCached: ${this.accessory.context.Active}`)
460
- }
461
- }
462
-
463
- async pushRotationSpeedChanges(): Promise<void> {
464
- this.debugLog('pushRotationSpeedChanges')
465
- if (this.AirPurifier.RotationSpeed !== this.accessory.context.RotationSpeed) {
466
- const bodyChange: bodyChange = {
467
- command: 'setWindSpeed',
468
- parameter: `${this.AirPurifier.RotationSpeed}`,
469
- commandType: 'command',
470
- }
471
- this.debugLog(`SwitchBot OpenAPI bodyChange: ${JSON.stringify(bodyChange)}`)
472
- try {
473
- const deviceStatus = await this.pushChangeRequest(bodyChange)
474
- this.debugLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`)
475
- if (await this.successfulStatusCodes(deviceStatus)) {
476
- this.debugSuccessLog(`statusCode: ${deviceStatus.statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`)
477
- await this.updateHomeKitCharacteristics()
478
- } else {
479
- await this.statusCode(deviceStatus.statusCode)
480
- }
481
- } catch (e: any) {
482
- await this.apiError(e)
483
- this.errorLog(`failed pushRotationSpeedChanges with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
484
- }
485
- } else {
486
- this.debugLog(`No changes (pushRotationSpeedChanges), RotationSpeed: ${this.AirPurifier.RotationSpeed}, RotationSpeedCached: ${this.accessory.context.RotationSpeed}`)
487
- }
488
- }
489
-
490
- /**
491
- * Handle requests to set the value of the "On" characteristic
492
- */
493
- async ActiveSet(value: CharacteristicValue): Promise<void> {
494
- if (this.AirPurifier.Active !== this.accessory.context.Active) {
495
- this.infoLog(`Set Active: ${value}`)
496
- } else {
497
- this.debugLog(`No Changes, Active: ${value}`)
498
- }
499
-
500
- this.AirPurifier.Active = value
501
- this.doAirPurifierUpdate.next()
502
- }
503
-
504
- /**
505
- * Handle requests to set the value of the "On" characteristic
506
- */
507
- async RotationSpeedSet(value: CharacteristicValue): Promise<void> {
508
- if (this.AirPurifier.RotationSpeed !== this.accessory.context.RotationSpeed) {
509
- this.infoLog(`Set RotationSpeed ${value}`)
510
- } else {
511
- this.debugLog(`No Changes, RotationSpeed: ${value}`)
512
- }
513
-
514
- this.AirPurifier.RotationSpeed = value
515
- this.doAirPurifierUpdate.next()
516
- }
517
-
518
- async updateHomeKitCharacteristics(): Promise<void> {
519
- // Active
520
- await this.updateCharacteristic(this.AirPurifier.Service, this.hap.Characteristic.Active, this.AirPurifier.Active, 'Active')
521
- // RotationSpeed
522
- await this.updateCharacteristic(this.AirPurifier.Service, this.hap.Characteristic.RotationSpeed, this.AirPurifier.RotationSpeed, 'RotationSpeed')
523
- // CurrentAirPurifierState
524
- await this.updateCharacteristic(this.AirPurifier.Service, this.hap.Characteristic.CurrentAirPurifierState, this.AirPurifier.CurrentAirPurifierState, 'CurrentAirPurifierState')
525
- // TargetAirPurifierState
526
- await this.updateCharacteristic(this.AirPurifier.Service, this.hap.Characteristic.TargetAirPurifierState, this.AirPurifier.TargetAirPurifierState, 'TargetAirPurifierState')
527
- // CurrentHeaterCoolerState
528
- await this.updateCharacteristic(this.AirPurifier.Service, this.hap.Characteristic.CurrentHeaterCoolerState, this.AirPurifier.CurrentHeaterCoolerState, 'CurrentHeaterCoolerState')
529
- }
530
-
531
- async BLEPushConnection() {
532
- if (this.platform.config.credentials?.token && this.device.connectionType === 'BLE/OpenAPI') {
533
- this.warnLog('Using OpenAPI Connection to Push Changes')
534
- await this.openAPIpushChanges()
535
- }
536
- }
537
-
538
- async BLERefreshConnection(switchbot: SwitchBotBLE): Promise<void> {
539
- this.errorLog(`wasn't able to establish BLE Connection, node-switchbot: ${switchbot}`)
540
- if (this.platform.config.credentials?.token && this.device.connectionType === 'BLE/OpenAPI') {
541
- this.warnLog('Using OpenAPI Connection to Refresh Status')
542
- await this.openAPIRefreshStatus()
543
- }
544
- }
545
-
546
- async offlineOff(): Promise<void> {
547
- if (this.device.offline) {
548
- this.AirPurifier.Service.updateCharacteristic(this.hap.Characteristic.Active, this.hap.Characteristic.Active.INACTIVE)
549
- this.AirPurifier.Service.updateCharacteristic(this.hap.Characteristic.RotationSpeed, 0)
550
- this.AirPurifier.Service.updateCharacteristic(this.hap.Characteristic.CurrentAirPurifierState, this.hap.Characteristic.CurrentAirPurifierState.INACTIVE)
551
- this.AirPurifier.Service.updateCharacteristic(this.hap.Characteristic.TargetAirPurifierState, this.hap.Characteristic.TargetAirPurifierState.AUTO)
552
- this.AirPurifier.Service.updateCharacteristic(this.hap.Characteristic.CurrentHeaterCoolerState, this.hap.Characteristic.CurrentHeaterCoolerState.INACTIVE)
553
- }
554
- }
555
-
556
- async apiError(e: any): Promise<void> {
557
- this.AirPurifier.Service.updateCharacteristic(this.hap.Characteristic.Active, e)
558
- this.AirPurifier.Service.updateCharacteristic(this.hap.Characteristic.RotationSpeed, e)
559
- this.AirPurifier.Service.updateCharacteristic(this.hap.Characteristic.CurrentAirPurifierState, e)
560
- this.AirPurifier.Service.updateCharacteristic(this.hap.Characteristic.TargetAirPurifierState, e)
561
- this.AirPurifier.Service.updateCharacteristic(this.hap.Characteristic.CurrentHeaterCoolerState, e)
562
- }
563
- }