@switchbot/homebridge-switchbot 3.5.0-beta.6 → 3.5.0-beta.61

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 (177) hide show
  1. package/.vscode/settings.json +4 -1
  2. package/CHANGELOG.md +4 -1
  3. package/config.schema.json +120 -17
  4. package/dist/device/blindtilt.d.ts +23 -96
  5. package/dist/device/blindtilt.d.ts.map +1 -1
  6. package/dist/device/blindtilt.js +408 -779
  7. package/dist/device/blindtilt.js.map +1 -1
  8. package/dist/device/bot.d.ts +26 -72
  9. package/dist/device/bot.d.ts.map +1 -1
  10. package/dist/device/bot.js +696 -822
  11. package/dist/device/bot.js.map +1 -1
  12. package/dist/device/ceilinglight.d.ts +14 -68
  13. package/dist/device/ceilinglight.d.ts.map +1 -1
  14. package/dist/device/ceilinglight.js +237 -606
  15. package/dist/device/ceilinglight.js.map +1 -1
  16. package/dist/device/colorbulb.d.ts +14 -75
  17. package/dist/device/colorbulb.d.ts.map +1 -1
  18. package/dist/device/colorbulb.js +280 -658
  19. package/dist/device/colorbulb.js.map +1 -1
  20. package/dist/device/contact.d.ts +15 -66
  21. package/dist/device/contact.d.ts.map +1 -1
  22. package/dist/device/contact.js +242 -544
  23. package/dist/device/contact.js.map +1 -1
  24. package/dist/device/curtain.d.ts +19 -88
  25. package/dist/device/curtain.d.ts.map +1 -1
  26. package/dist/device/curtain.js +402 -805
  27. package/dist/device/curtain.js.map +1 -1
  28. package/dist/device/device.d.ts +59 -0
  29. package/dist/device/device.d.ts.map +1 -0
  30. package/dist/device/device.js +684 -0
  31. package/dist/device/device.js.map +1 -0
  32. package/dist/device/fan.d.ts +51 -0
  33. package/dist/device/fan.d.ts.map +1 -0
  34. package/dist/device/fan.js +535 -0
  35. package/dist/device/fan.js.map +1 -0
  36. package/dist/device/hub.d.ts +16 -60
  37. package/dist/device/hub.d.ts.map +1 -1
  38. package/dist/device/hub.js +246 -613
  39. package/dist/device/hub.js.map +1 -1
  40. package/dist/device/humidifier.d.ts +11 -66
  41. package/dist/device/humidifier.d.ts.map +1 -1
  42. package/dist/device/humidifier.js +232 -593
  43. package/dist/device/humidifier.js.map +1 -1
  44. package/dist/device/iosensor.d.ts +11 -64
  45. package/dist/device/iosensor.d.ts.map +1 -1
  46. package/dist/device/iosensor.js +185 -600
  47. package/dist/device/iosensor.js.map +1 -1
  48. package/dist/device/lightstrip.d.ts +11 -69
  49. package/dist/device/lightstrip.d.ts.map +1 -1
  50. package/dist/device/lightstrip.js +277 -586
  51. package/dist/device/lightstrip.js.map +1 -1
  52. package/dist/device/lock.d.ts +16 -63
  53. package/dist/device/lock.d.ts.map +1 -1
  54. package/dist/device/lock.js +241 -560
  55. package/dist/device/lock.js.map +1 -1
  56. package/dist/device/meter.d.ts +14 -64
  57. package/dist/device/meter.d.ts.map +1 -1
  58. package/dist/device/meter.js +181 -593
  59. package/dist/device/meter.js.map +1 -1
  60. package/dist/device/meterplus.d.ts +14 -65
  61. package/dist/device/meterplus.d.ts.map +1 -1
  62. package/dist/device/meterplus.js +170 -593
  63. package/dist/device/meterplus.js.map +1 -1
  64. package/dist/device/motion.d.ts +13 -69
  65. package/dist/device/motion.d.ts.map +1 -1
  66. package/dist/device/motion.js +178 -531
  67. package/dist/device/motion.js.map +1 -1
  68. package/dist/device/plug.d.ts +9 -57
  69. package/dist/device/plug.d.ts.map +1 -1
  70. package/dist/device/plug.js +92 -458
  71. package/dist/device/plug.js.map +1 -1
  72. package/dist/device/robotvacuumcleaner.d.ts +12 -63
  73. package/dist/device/robotvacuumcleaner.d.ts.map +1 -1
  74. package/dist/device/robotvacuumcleaner.js +197 -521
  75. package/dist/device/robotvacuumcleaner.js.map +1 -1
  76. package/dist/device/waterdetector.d.ts +10 -65
  77. package/dist/device/waterdetector.d.ts.map +1 -1
  78. package/dist/device/waterdetector.js +139 -495
  79. package/dist/device/waterdetector.js.map +1 -1
  80. package/dist/homebridge-ui/public/index.html +22 -16
  81. package/dist/homebridge-ui/server.js +1 -1
  82. package/dist/homebridge-ui/server.js.map +1 -1
  83. package/dist/index.d.ts +1 -1
  84. package/dist/index.d.ts.map +1 -1
  85. package/dist/index.js +2 -2
  86. package/dist/index.js.map +1 -1
  87. package/dist/irdevice/airconditioner.d.ts +9 -49
  88. package/dist/irdevice/airconditioner.d.ts.map +1 -1
  89. package/dist/irdevice/airconditioner.js +309 -419
  90. package/dist/irdevice/airconditioner.js.map +1 -1
  91. package/dist/irdevice/airpurifier.d.ts +8 -39
  92. package/dist/irdevice/airpurifier.d.ts.map +1 -1
  93. package/dist/irdevice/airpurifier.js +72 -304
  94. package/dist/irdevice/airpurifier.js.map +1 -1
  95. package/dist/irdevice/camera.d.ts +7 -36
  96. package/dist/irdevice/camera.d.ts.map +1 -1
  97. package/dist/irdevice/camera.js +34 -278
  98. package/dist/irdevice/camera.js.map +1 -1
  99. package/dist/irdevice/fan.d.ts +10 -43
  100. package/dist/irdevice/fan.d.ts.map +1 -1
  101. package/dist/irdevice/fan.js +100 -338
  102. package/dist/irdevice/fan.js.map +1 -1
  103. package/dist/irdevice/irdevice.d.ts +40 -0
  104. package/dist/irdevice/irdevice.d.ts.map +1 -0
  105. package/dist/irdevice/irdevice.js +330 -0
  106. package/dist/irdevice/irdevice.js.map +1 -0
  107. package/dist/irdevice/light.d.ts +12 -45
  108. package/dist/irdevice/light.d.ts.map +1 -1
  109. package/dist/irdevice/light.js +87 -357
  110. package/dist/irdevice/light.js.map +1 -1
  111. package/dist/irdevice/other.d.ts +19 -48
  112. package/dist/irdevice/other.d.ts.map +1 -1
  113. package/dist/irdevice/other.js +352 -546
  114. package/dist/irdevice/other.js.map +1 -1
  115. package/dist/irdevice/tv.d.ts +8 -40
  116. package/dist/irdevice/tv.d.ts.map +1 -1
  117. package/dist/irdevice/tv.js +82 -321
  118. package/dist/irdevice/tv.js.map +1 -1
  119. package/dist/irdevice/vacuumcleaner.d.ts +7 -36
  120. package/dist/irdevice/vacuumcleaner.d.ts.map +1 -1
  121. package/dist/irdevice/vacuumcleaner.js +41 -284
  122. package/dist/irdevice/vacuumcleaner.js.map +1 -1
  123. package/dist/irdevice/waterheater.d.ts +7 -36
  124. package/dist/irdevice/waterheater.d.ts.map +1 -1
  125. package/dist/irdevice/waterheater.js +42 -287
  126. package/dist/irdevice/waterheater.js.map +1 -1
  127. package/dist/platform.d.ts +19 -6
  128. package/dist/platform.d.ts.map +1 -1
  129. package/dist/platform.js +310 -169
  130. package/dist/platform.js.map +1 -1
  131. package/dist/settings.d.ts +62 -19
  132. package/dist/settings.d.ts.map +1 -1
  133. package/dist/settings.js +16 -552
  134. package/dist/settings.js.map +1 -1
  135. package/dist/utils.d.ts +77 -0
  136. package/dist/utils.d.ts.map +1 -1
  137. package/dist/utils.js +638 -1
  138. package/dist/utils.js.map +1 -1
  139. package/eslint.config.js +96 -0
  140. package/package.json +19 -15
  141. package/src/custom.d.ts +2 -1
  142. package/src/device/blindtilt.ts +442 -814
  143. package/src/device/bot.ts +754 -915
  144. package/src/device/ceilinglight.ts +255 -633
  145. package/src/device/colorbulb.ts +295 -685
  146. package/src/device/contact.ts +277 -571
  147. package/src/device/curtain.ts +431 -835
  148. package/src/device/device.ts +709 -0
  149. package/src/device/fan.ts +591 -0
  150. package/src/device/hub.ts +286 -644
  151. package/src/device/humidifier.ts +266 -646
  152. package/src/device/iosensor.ts +220 -625
  153. package/src/device/lightstrip.ts +305 -620
  154. package/src/device/lock.ts +280 -600
  155. package/src/device/meter.ts +216 -617
  156. package/src/device/meterplus.ts +205 -619
  157. package/src/device/motion.ts +206 -556
  158. package/src/device/plug.ts +107 -490
  159. package/src/device/robotvacuumcleaner.ts +223 -550
  160. package/src/device/waterdetector.ts +160 -519
  161. package/src/homebridge-ui/public/index.html +22 -16
  162. package/src/homebridge-ui/server.ts +1 -1
  163. package/src/index.ts +4 -3
  164. package/src/irdevice/airconditioner.ts +333 -447
  165. package/src/irdevice/airpurifier.ts +92 -322
  166. package/src/irdevice/camera.ts +45 -294
  167. package/src/irdevice/fan.ts +115 -353
  168. package/src/irdevice/irdevice.ts +346 -0
  169. package/src/irdevice/light.ts +110 -385
  170. package/src/irdevice/other.ts +399 -616
  171. package/src/irdevice/tv.ts +103 -340
  172. package/src/irdevice/vacuumcleaner.ts +52 -306
  173. package/src/irdevice/waterheater.ts +53 -311
  174. package/src/platform.ts +355 -216
  175. package/src/settings.ts +116 -611
  176. package/src/utils.ts +642 -1
  177. package/src/device/waterdetector.json +0 -11
@@ -1,79 +1,41 @@
1
+ /* Copyright(C) 2021-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
2
+ *
3
+ * plug.ts: @switchbot/homebridge-switchbot.
4
+ */
1
5
  import { request } from 'undici';
2
- import { sleep } from '../utils.js';
3
- import { interval, Subject } from 'rxjs';
4
- import { debounceTime, skipWhile, take, tap } from 'rxjs/operators';
5
6
  import { Devices } from '../settings.js';
6
- export class Plug {
7
+ import { deviceBase } from './device.js';
8
+ import { Subject, debounceTime, interval, skipWhile, take, tap } from 'rxjs';
9
+ export class Plug extends deviceBase {
7
10
  platform;
8
- accessory;
9
- device;
10
- api;
11
- log;
12
- config;
13
- hap;
14
11
  // Services
15
- outletService;
16
- // Characteristic Values
17
- On;
18
- FirmwareRevision;
19
- // OpenAPI Others
20
- OpenAPI_On;
21
- OpenAPI_FirmwareRevision;
22
- // BLE Others
23
- BLE_IsConnected;
24
- BLE_On;
25
- // Config
26
- scanDuration;
27
- deviceLogging;
28
- deviceRefreshRate;
12
+ Outlet;
29
13
  // Updates
30
14
  plugUpdateInProgress;
31
15
  doPlugUpdate;
32
- // Connection
33
- OpenAPI;
34
- BLE;
35
16
  constructor(platform, accessory, device) {
17
+ super(platform, accessory, device);
36
18
  this.platform = platform;
37
- this.accessory = accessory;
38
- this.device = device;
39
- this.api = this.platform.api;
40
- this.log = this.platform.log;
41
- this.config = this.platform.config;
42
- this.hap = this.api.hap;
43
- // Connection
44
- this.BLE = this.device.connectionType === 'BLE' || this.device.connectionType === 'BLE/OpenAPI';
45
- this.OpenAPI = this.device.connectionType === 'OpenAPI' || this.device.connectionType === 'BLE/OpenAPI';
46
- // default placeholders
47
- this.deviceLogs(device);
48
- this.scan(device);
49
- this.refreshRate(device);
50
- this.deviceContext();
51
- this.deviceConfig(device);
52
19
  // this is subject we use to track when we need to POST changes to the SwitchBot API
53
20
  this.doPlugUpdate = new Subject();
54
21
  this.plugUpdateInProgress = false;
22
+ // Initialize Outlet Service
23
+ this.Outlet = {
24
+ Name: accessory.context.OutletName ?? accessory.displayName,
25
+ Service: accessory.getService(this.hap.Service.Outlet) ?? accessory.addService(this.hap.Service.Outlet),
26
+ On: accessory.context.On || false,
27
+ };
28
+ // Initialize Outlet Characteristics
29
+ this.Outlet.Service
30
+ .setCharacteristic(this.hap.Characteristic.Name, accessory.displayName)
31
+ .getCharacteristic(this.hap.Characteristic.On)
32
+ .onGet(() => {
33
+ return this.Outlet.On;
34
+ })
35
+ .onSet(this.OnSet.bind(this));
36
+ accessory.context.OutletName = this.Outlet.Name;
55
37
  // Retrieve initial values and updateHomekit
56
38
  this.refreshStatus();
57
- // set accessory information
58
- accessory
59
- .getService(this.hap.Service.AccessoryInformation)
60
- .setCharacteristic(this.hap.Characteristic.Manufacturer, 'SwitchBot')
61
- .setCharacteristic(this.hap.Characteristic.Model, this.model(device))
62
- .setCharacteristic(this.hap.Characteristic.SerialNumber, device.deviceId)
63
- .setCharacteristic(this.hap.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision);
64
- // get the Outlet service if it exists, otherwise create a new Outlet service
65
- // you can create multiple services for each accessory
66
- const outletService = `${accessory.displayName} ${device.deviceType}`;
67
- (this.outletService = accessory.getService(this.hap.Service.Outlet)
68
- || accessory.addService(this.hap.Service.Outlet)), outletService;
69
- this.outletService.setCharacteristic(this.hap.Characteristic.Name, accessory.displayName);
70
- if (!this.outletService.testCharacteristic(this.hap.Characteristic.ConfiguredName)) {
71
- this.outletService.addCharacteristic(this.hap.Characteristic.ConfiguredName, accessory.displayName);
72
- }
73
- // each service must implement at-minimum the "required characteristics" for the given service type
74
- // see https://developers.homebridge.io/#/service/Outlet
75
- // create handlers for required characteristics
76
- this.outletService.getCharacteristic(this.hap.Characteristic.On).onSet(this.OnSet.bind(this));
77
39
  // Update Homekit
78
40
  this.updateHomeKitCharacteristics();
79
41
  // Start an update interval
@@ -83,18 +45,18 @@ export class Plug {
83
45
  await this.refreshStatus();
84
46
  });
85
47
  //regisiter webhook event handler
86
- if (this.device.webhook) {
87
- this.infoLog(`${this.device.deviceType}: ${this.accessory.displayName} is listening webhook.`);
48
+ if (device.webhook) {
49
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} is listening webhook.`);
88
50
  this.platform.webhookEventHandler[this.device.deviceId] = async (context) => {
89
51
  try {
90
52
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} received Webhook: ${JSON.stringify(context)}`);
91
53
  const { powerState } = context;
92
- const { On } = this;
54
+ const { On } = this.Outlet;
93
55
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ` +
94
56
  '(powerState) = ' +
95
57
  `Webhook:(${powerState}), ` +
96
58
  `current:(${On})`);
97
- this.On = powerState === 'ON' ? true : false;
59
+ this.Outlet.On = powerState === 'ON' ? true : false;
98
60
  this.updateHomeKitCharacteristics();
99
61
  }
100
62
  catch (e) {
@@ -121,49 +83,39 @@ export class Plug {
121
83
  this.plugUpdateInProgress = false;
122
84
  });
123
85
  }
124
- /**
125
- * Parse the device status from the SwitchBot api
126
- */
127
- async parseStatus() {
128
- if (!this.device.enableCloudService && this.OpenAPI) {
129
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} parseStatus enableCloudService: ${this.device.enableCloudService}`);
130
- }
131
- else if (this.BLE) {
132
- await this.BLEparseStatus();
133
- }
134
- else if (this.OpenAPI && this.platform.config.credentials?.token) {
135
- await this.openAPIparseStatus();
136
- }
137
- else {
138
- await this.offlineOff();
139
- this.debugWarnLog(`${this.device.deviceType}: ${this.accessory.displayName} Connection Type:` + ` ${this.device.connectionType}, parseStatus will not happen.`);
140
- }
141
- }
142
- async BLEparseStatus() {
86
+ async BLEparseStatus(serviceData) {
143
87
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BLEparseStatus`);
144
88
  // State
145
- switch (this.BLE_On) {
89
+ switch (serviceData.state) {
146
90
  case 'on':
147
- this.On = true;
91
+ this.Outlet.On = true;
148
92
  break;
149
93
  default:
150
- this.On = false;
94
+ this.Outlet.On = false;
151
95
  }
152
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.On}`);
96
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.Outlet.On}`);
153
97
  }
154
- async openAPIparseStatus() {
98
+ async openAPIparseStatus(deviceStatus) {
155
99
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} openAPIparseStatus`);
156
- switch (this.OpenAPI_On) {
100
+ switch (deviceStatus.body.power) {
157
101
  case 'on':
158
- this.On = true;
102
+ this.Outlet.On = true;
159
103
  break;
160
104
  default:
161
- this.On = false;
105
+ this.Outlet.On = false;
106
+ }
107
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.Outlet.On}`);
108
+ // Firmware Version
109
+ const version = deviceStatus.body.version?.toString();
110
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Firmware Version: ${version?.replace(/^V|-.*$/g, '')}`);
111
+ if (deviceStatus.body.version) {
112
+ this.accessory.context.version = version?.replace(/^V|-.*$/g, '');
113
+ this.accessory
114
+ .getService(this.hap.Service.AccessoryInformation)
115
+ .setCharacteristic(this.hap.Characteristic.FirmwareRevision, this.accessory.context.version)
116
+ .getCharacteristic(this.hap.Characteristic.FirmwareRevision)
117
+ .updateValue(this.accessory.context.version);
162
118
  }
163
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.On}`);
164
- // FirmwareRevision
165
- this.FirmwareRevision = this.OpenAPI_FirmwareRevision;
166
- this.accessory.context.FirmwareRevision = this.FirmwareRevision;
167
119
  }
168
120
  /**
169
121
  * Asks the SwitchBot API for the latest device information
@@ -196,94 +148,43 @@ export class Plug {
196
148
  this.getCustomBLEAddress(switchbot);
197
149
  // Start to monitor advertisement packets
198
150
  (async () => {
199
- await switchbot.startScan({
200
- model: this.BLEmodel(),
201
- id: this.device.bleMac,
202
- });
151
+ // Start to monitor advertisement packets
152
+ await switchbot.startScan({ model: this.device.bleModel, id: this.device.bleMac });
203
153
  // Set an event handler
204
154
  switchbot.onadvertisement = (ad) => {
205
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ${JSON.stringify(ad, null, ' ')}`);
206
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} address: ${ad.address}, model: ${ad.serviceData.model}`);
207
- if (this.device.bleMac === ad.address && ad.serviceData.model === this.BLEmodel()) {
155
+ if (this.device.bleMac === ad.address && ad.model === this.device.bleModel) {
156
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ${JSON.stringify(ad, null, ' ')}`);
157
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} address: ${ad.address}, model: ${ad.model}`);
208
158
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} serviceData: ${JSON.stringify(ad.serviceData)}`);
209
- this.BLE_On = ad.serviceData.state;
210
159
  }
211
160
  else {
212
161
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} serviceData: ${JSON.stringify(ad.serviceData)}`);
213
162
  }
214
163
  };
215
- // Wait 1 seconds
164
+ // Wait 10 seconds
216
165
  await switchbot.wait(this.scanDuration * 1000);
217
166
  // Stop to monitor
218
167
  await switchbot.stopScan();
219
168
  // Update HomeKit
220
- await this.BLEparseStatus();
169
+ await this.BLEparseStatus(switchbot.onadvertisement.serviceData);
221
170
  await this.updateHomeKitCharacteristics();
222
171
  })();
223
- /*if (switchbot !== false) {
224
- switchbot
225
- .startScan({
226
- model: this.BLEmodel(),
227
- id: this.device.bleMac,
228
- })
229
- .then(async () => {
230
- // Set an event handler
231
- switchbot.onadvertisement = async (ad: ad) => {
232
- this.debugLog(
233
- `${this.device.deviceType}: ${this.accessory.displayName} Config BLE Address: ${this.device.bleMac},` +
234
- ` BLE Address Found: ${ad.address}`,
235
- );
236
- this.BLE_On = ad.serviceData.state;
237
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} serviceData: ${JSON.stringify(ad.serviceData)}`);
238
- this.debugLog(
239
- `${this.device.deviceType}: ${this.accessory.displayName} state: ${ad.serviceData.state}, ` +
240
- `delay: ${ad.serviceData.delay}, timer: ${ad.serviceData.timer}, syncUtcTime: ${ad.serviceData.syncUtcTime} ` +
241
- `wifiRssi: ${ad.serviceData.wifiRssi}, overload: ${ad.serviceData.overload}, currentPower: ${ad.serviceData.currentPower}`,
242
- );
243
-
244
- if (ad.serviceData) {
245
- this.BLE_IsConnected = true;
246
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} connected: ${this.BLE_IsConnected}`);
247
- await this.stopScanning(switchbot);
248
- } else {
249
- this.BLE_IsConnected = false;
250
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} connected: ${this.BLE_IsConnected}`);
251
- }
252
- };
253
- // Wait
254
- return await sleep(this.scanDuration * 1000);
255
- })
256
- .then(async () => {
257
- // Stop to monitor
258
- await this.stopScanning(switchbot);
259
- })
260
- .catch(async (e: any) => {
261
- this.apiError(e);
262
- this.errorLog(
263
- `${this.device.deviceType}: ${this.accessory.displayName} failed BLERefreshStatus with ${this.device.connectionType}` +
264
- ` Connection, Error Message: ${JSON.stringify(e.message)}`,
265
- );
266
- await this.BLERefreshConnection(switchbot);
267
- });
268
- } else {
269
- await this.BLERefreshConnection(switchbot);
270
- }*/
172
+ if (switchbot === undefined) {
173
+ await this.BLERefreshConnection(switchbot);
174
+ }
271
175
  }
272
176
  async openAPIRefreshStatus() {
273
177
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} openAPIRefreshStatus`);
274
178
  try {
275
- const { body, statusCode } = await request(`${Devices}/${this.device.deviceId}/status`, {
276
- headers: this.platform.generateHeaders(),
277
- });
179
+ const { body, statusCode } = await this.platform.retryRequest(this.deviceMaxRetries, this.deviceDelayBetweenRetries, `${Devices}/${this.device.deviceId}/status`, { headers: this.platform.generateHeaders() });
278
180
  this.debugWarnLog(`${this.device.deviceType}: ${this.accessory.displayName} statusCode: ${statusCode}`);
279
181
  const deviceStatus = await body.json();
280
182
  this.debugWarnLog(`${this.device.deviceType}: ${this.accessory.displayName} deviceStatus: ${JSON.stringify(deviceStatus)}`);
281
183
  this.debugWarnLog(`${this.device.deviceType}: ${this.accessory.displayName} deviceStatus statusCode: ${deviceStatus.statusCode}`);
282
184
  if ((statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)) {
283
- this.debugErrorLog(`${this.device.deviceType}: ${this.accessory.displayName} `
185
+ this.debugSuccessLog(`${this.device.deviceType}: ${this.accessory.displayName} `
284
186
  + `statusCode: ${statusCode} & deviceStatus StatusCode: ${deviceStatus.statusCode}`);
285
- this.OpenAPI_On = deviceStatus.body.power;
286
- this.openAPIparseStatus();
187
+ this.openAPIparseStatus(deviceStatus);
287
188
  this.updateHomeKitCharacteristics();
288
189
  }
289
190
  else {
@@ -330,8 +231,9 @@ export class Plug {
330
231
  }
331
232
  async BLEpushChanges() {
332
233
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BLEpushChanges`);
333
- if (this.On !== this.accessory.context.On) {
334
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BLEpushChanges On: ${this.On} OnCached: ${this.accessory.context.On}`);
234
+ if (this.Outlet.On !== this.accessory.context.On) {
235
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BLEpushChanges`
236
+ + ` On: ${this.Outlet.On} OnCached: ${this.accessory.context.On}`);
335
237
  const switchbot = await this.platform.connectBLE();
336
238
  // Convert to BLE Address
337
239
  this.device.bleMac = this.device
@@ -341,15 +243,15 @@ export class Plug {
341
243
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
342
244
  switchbot
343
245
  .discover({
344
- model: this.BLEmodel(),
246
+ model: this.device.bleModel,
345
247
  id: this.device.bleMac,
346
248
  })
347
249
  .then(async (device_list) => {
348
- this.infoLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.On}`);
349
- return await this.retry({
350
- max: this.maxRetry(),
250
+ this.infoLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.Outlet.On}`);
251
+ return await this.retryBLE({
252
+ max: await this.maxRetryBLE(),
351
253
  fn: async () => {
352
- if (this.On) {
254
+ if (this.Outlet.On) {
353
255
  return await device_list[0].turnOn({ id: this.device.bleMac });
354
256
  }
355
257
  else {
@@ -360,7 +262,9 @@ export class Plug {
360
262
  })
361
263
  .then(() => {
362
264
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Done.`);
363
- this.On = false;
265
+ this.successLog(`${this.device.deviceType}: ${this.accessory.displayName} `
266
+ + `On: ${this.Outlet.On} sent over BLE, sent successfully`);
267
+ this.Outlet.On = false;
364
268
  })
365
269
  .catch(async (e) => {
366
270
  this.apiError(e);
@@ -370,14 +274,15 @@ export class Plug {
370
274
  });
371
275
  }
372
276
  else {
373
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} No BLEpushChanges.` + `On: ${this.On}, ` + `OnCached: ${this.accessory.context.On}`);
277
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} No BLEpushChanges,`
278
+ + ` On: ${this.Outlet.On}, OnCached: ${this.accessory.context.On}`);
374
279
  }
375
280
  }
376
281
  async openAPIpushChanges() {
377
282
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} openAPIpushChanges`);
378
- if (this.On !== this.accessory.context.On) {
283
+ if (this.Outlet.On !== this.accessory.context.On) {
379
284
  let command = '';
380
- if (this.On) {
285
+ if (this.Outlet.On) {
381
286
  command = 'turnOn';
382
287
  }
383
288
  else {
@@ -403,6 +308,8 @@ export class Plug {
403
308
  if ((statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)) {
404
309
  this.debugErrorLog(`${this.device.deviceType}: ${this.accessory.displayName} `
405
310
  + `statusCode: ${statusCode} & deviceStatus StatusCode: ${deviceStatus.statusCode}`);
311
+ this.successLog(`${this.device.deviceType}: ${this.accessory.displayName} `
312
+ + `request to SwitchBot API, body: ${JSON.stringify(deviceStatus)} sent successfully`);
406
313
  }
407
314
  else {
408
315
  this.statusCode(statusCode);
@@ -411,73 +318,37 @@ export class Plug {
411
318
  }
412
319
  catch (e) {
413
320
  this.apiError(e);
414
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} failed openAPIpushChanges with ${this.device.connectionType}` +
415
- ` Connection, Error Message: ${JSON.stringify(e.message)}`);
321
+ this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} failed openAPIpushChanges with ${this.device.connectionType}`
322
+ + ` Connection, Error Message: ${JSON.stringify(e.message)}`);
416
323
  }
417
324
  }
418
325
  else {
419
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} No openAPIpushChanges.` +
420
- `On: ${this.On}, ` +
421
- `OnCached: ${this.accessory.context.On}`);
326
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} No openAPIpushChanges.`
327
+ + `On: ${this.Outlet.On}, OnCached: ${this.accessory.context.On}`);
422
328
  }
423
329
  }
424
330
  /**
425
331
  * Handle requests to set the value of the "On" characteristic
426
332
  */
427
333
  async OnSet(value) {
428
- if (this.On === this.accessory.context.On) {
334
+ if (this.Outlet.On === this.accessory.context.On) {
429
335
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} No Changes, Set On: ${value}`);
430
336
  }
431
337
  else {
432
338
  this.infoLog(`${this.device.deviceType}: ${this.accessory.displayName} Set On: ${value}`);
433
339
  }
434
- this.On = value;
340
+ this.Outlet.On = value;
435
341
  this.doPlugUpdate.next();
436
342
  }
437
343
  async updateHomeKitCharacteristics() {
438
344
  // On
439
- if (this.On === undefined) {
440
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.On}`);
345
+ if (this.Outlet.On === undefined) {
346
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.Outlet.On}`);
441
347
  }
442
348
  else {
443
- this.accessory.context.On = this.On;
444
- this.outletService.updateCharacteristic(this.hap.Characteristic.On, this.On);
445
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
446
- }
447
- }
448
- async stopScanning(switchbot) {
449
- switchbot.stopScan();
450
- if (this.BLE_IsConnected) {
451
- await this.BLEparseStatus();
452
- await this.updateHomeKitCharacteristics();
453
- }
454
- else {
455
- await this.BLERefreshConnection(switchbot);
456
- }
457
- }
458
- BLEmodel() {
459
- if (this.device.deviceType === 'Plug Mini (US)' || this.device.configDeviceType === 'Plug Mini (US)') {
460
- return 'g';
461
- }
462
- else {
463
- return 'j';
464
- }
465
- }
466
- async getCustomBLEAddress(switchbot) {
467
- if (this.device.customBLEaddress && this.deviceLogging.includes('debug')) {
468
- (async () => {
469
- // Start to monitor advertisement packets
470
- await switchbot.startScan({
471
- model: this.BLEmodel(),
472
- });
473
- // Set an event handler
474
- switchbot.onadvertisement = (ad) => {
475
- this.warnLog(`${this.device.deviceType}: ${this.accessory.displayName} ad: ${JSON.stringify(ad, null, ' ')}`);
476
- };
477
- await sleep(10000);
478
- // Stop to monitor
479
- switchbot.stopScan();
480
- })();
349
+ this.accessory.context.On = this.Outlet.On;
350
+ this.Outlet.Service.updateCharacteristic(this.hap.Characteristic.On, this.Outlet.On);
351
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic On: ${this.Outlet.On}`);
481
352
  }
482
353
  }
483
354
  async BLEPushConnection() {
@@ -494,250 +365,13 @@ export class Plug {
494
365
  await this.openAPIRefreshStatus();
495
366
  }
496
367
  }
497
- async retry({ max, fn }) {
498
- return fn().catch(async (e) => {
499
- if (max === 0) {
500
- throw e;
501
- }
502
- this.infoLog(e);
503
- this.infoLog(`${this.device.deviceType}: ${this.accessory.displayName} Retrying`);
504
- await sleep(1000);
505
- return this.retry({ max: max - 1, fn });
506
- });
507
- }
508
- maxRetry() {
509
- if (this.device.maxRetry) {
510
- return this.device.maxRetry;
511
- }
512
- else {
513
- return 5;
514
- }
515
- }
516
- model(device) {
517
- let model;
518
- if (device.deviceType === 'Plug Mini (US)') {
519
- model = 'W1901400';
520
- model = 'W1901401';
521
- }
522
- else if (device.deviceType === 'Plug Mini (JP)') {
523
- model = 'W2001400';
524
- }
525
- else {
526
- model = 'SP11';
527
- }
528
- return model;
529
- }
530
- async scan(device) {
531
- if (device.scanDuration) {
532
- this.scanDuration = this.accessory.context.scanDuration = device.scanDuration;
533
- if (this.BLE) {
534
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Device Config scanDuration: ${this.scanDuration}`);
535
- }
536
- }
537
- else {
538
- this.scanDuration = this.accessory.context.scanDuration = 1;
539
- if (this.BLE) {
540
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Default scanDuration: ${this.scanDuration}`);
541
- }
542
- }
543
- }
544
- async statusCode(statusCode) {
545
- switch (statusCode) {
546
- case 151:
547
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Command not supported by this deviceType, statusCode: ${statusCode}`);
548
- break;
549
- case 152:
550
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Device not found, statusCode: ${statusCode}`);
551
- break;
552
- case 160:
553
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Command is not supported, statusCode: ${statusCode}`);
554
- break;
555
- case 161:
556
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Device is offline, statusCode: ${statusCode}`);
557
- this.offlineOff();
558
- break;
559
- case 171:
560
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Hub Device is offline, statusCode: ${statusCode}. ` +
561
- `Hub: ${this.device.hubDeviceId}`);
562
- this.offlineOff();
563
- break;
564
- case 190:
565
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Device internal error due to device states not synchronized with server,` +
566
- ` Or command format is invalid, statusCode: ${statusCode}`);
567
- break;
568
- case 100:
569
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Command successfully sent, statusCode: ${statusCode}`);
570
- break;
571
- case 200:
572
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Request successful, statusCode: ${statusCode}`);
573
- break;
574
- case 400:
575
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Bad Request, The client has issued an invalid request. `
576
- + `This is commonly used to specify validation errors in a request payload, statusCode: ${statusCode}`);
577
- break;
578
- case 401:
579
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Unauthorized, Authorization for the API is required, `
580
- + `but the request has not been authenticated, statusCode: ${statusCode}`);
581
- break;
582
- case 403:
583
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Forbidden, The request has been authenticated but does not `
584
- + `have appropriate permissions, or a requested resource is not found, statusCode: ${statusCode}`);
585
- break;
586
- case 404:
587
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Not Found, Specifies the requested path does not exist, `
588
- + `statusCode: ${statusCode}`);
589
- break;
590
- case 406:
591
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Not Acceptable, The client has requested a MIME type via `
592
- + `the Accept header for a value not supported by the server, statusCode: ${statusCode}`);
593
- break;
594
- case 415:
595
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Unsupported Media Type, The client has defined a contentType `
596
- + `header that is not supported by the server, statusCode: ${statusCode}`);
597
- break;
598
- case 422:
599
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Unprocessable Entity, The client has made a valid request, `
600
- + `but the server cannot process it. This is often used for APIs for which certain limits have been exceeded, statusCode: ${statusCode}`);
601
- break;
602
- case 429:
603
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Too Many Requests, The client has exceeded the number of `
604
- + `requests allowed for a given time window, statusCode: ${statusCode}`);
605
- break;
606
- case 500:
607
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Internal Server Error, An unexpected error on the SmartThings `
608
- + `servers has occurred. These errors should be rare, statusCode: ${statusCode}`);
609
- break;
610
- default:
611
- this.infoLog(`${this.device.deviceType}: ${this.accessory.displayName} Unknown statusCode: ` +
612
- `${statusCode}, Submit Bugs Here: ' + 'https://tinyurl.com/SwitchBotBug`);
613
- }
614
- }
615
368
  async offlineOff() {
616
369
  if (this.device.offline) {
617
- await this.deviceContext();
618
- await this.updateHomeKitCharacteristics();
370
+ this.Outlet.Service.updateCharacteristic(this.hap.Characteristic.On, false);
619
371
  }
620
372
  }
621
373
  async apiError(e) {
622
- this.outletService.updateCharacteristic(this.hap.Characteristic.On, e);
623
- }
624
- async deviceContext() {
625
- if (this.On === undefined) {
626
- this.On = false;
627
- }
628
- else {
629
- this.On = this.accessory.context.On;
630
- }
631
- if (this.FirmwareRevision === undefined) {
632
- this.FirmwareRevision = this.platform.version;
633
- this.accessory.context.FirmwareRevision = this.FirmwareRevision;
634
- }
635
- }
636
- async refreshRate(device) {
637
- if (device.refreshRate) {
638
- this.deviceRefreshRate = this.accessory.context.refreshRate = device.refreshRate;
639
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Device Config refreshRate: ${this.deviceRefreshRate}`);
640
- }
641
- else if (this.platform.config.options.refreshRate) {
642
- this.deviceRefreshRate = this.accessory.context.refreshRate = this.platform.config.options.refreshRate;
643
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Platform Config refreshRate: ${this.deviceRefreshRate}`);
644
- }
645
- }
646
- async deviceConfig(device) {
647
- let config = {};
648
- if (device.plug) {
649
- config = device.plug;
650
- }
651
- if (device.connectionType !== undefined) {
652
- config['connectionType'] = device.connectionType;
653
- }
654
- if (device.external !== undefined) {
655
- config['external'] = device.external;
656
- }
657
- if (device.logging !== undefined) {
658
- config['logging'] = device.logging;
659
- }
660
- if (device.refreshRate !== undefined) {
661
- config['refreshRate'] = device.refreshRate;
662
- }
663
- if (device.scanDuration !== undefined) {
664
- config['scanDuration'] = device.scanDuration;
665
- }
666
- if (device.offline !== undefined) {
667
- config['offline'] = device.offline;
668
- }
669
- if (device.maxRetry !== undefined) {
670
- config['maxRetry'] = device.maxRetry;
671
- }
672
- if (device.webhook !== undefined) {
673
- config['webhook'] = device.webhook;
674
- }
675
- if (Object.entries(config).length !== 0) {
676
- this.debugWarnLog(`${this.device.deviceType}: ${this.accessory.displayName} Config: ${JSON.stringify(config)}`);
677
- }
678
- }
679
- async deviceLogs(device) {
680
- if (this.platform.debugMode) {
681
- this.deviceLogging = this.accessory.context.logging = 'debugMode';
682
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Debug Mode Logging: ${this.deviceLogging}`);
683
- }
684
- else if (device.logging) {
685
- this.deviceLogging = this.accessory.context.logging = device.logging;
686
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Device Config Logging: ${this.deviceLogging}`);
687
- }
688
- else if (this.platform.config.options?.logging) {
689
- this.deviceLogging = this.accessory.context.logging = this.platform.config.options?.logging;
690
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Platform Config Logging: ${this.deviceLogging}`);
691
- }
692
- else {
693
- this.deviceLogging = this.accessory.context.logging = 'standard';
694
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Logging Not Set, Using: ${this.deviceLogging}`);
695
- }
696
- }
697
- /**
698
- * Logging for Device
699
- */
700
- infoLog(...log) {
701
- if (this.enablingDeviceLogging()) {
702
- this.platform.log.info(String(...log));
703
- }
704
- }
705
- warnLog(...log) {
706
- if (this.enablingDeviceLogging()) {
707
- this.platform.log.warn(String(...log));
708
- }
709
- }
710
- debugWarnLog(...log) {
711
- if (this.enablingDeviceLogging()) {
712
- if (this.deviceLogging?.includes('debug')) {
713
- this.platform.log.warn('[DEBUG]', String(...log));
714
- }
715
- }
716
- }
717
- errorLog(...log) {
718
- if (this.enablingDeviceLogging()) {
719
- this.platform.log.error(String(...log));
720
- }
721
- }
722
- debugErrorLog(...log) {
723
- if (this.enablingDeviceLogging()) {
724
- if (this.deviceLogging?.includes('debug')) {
725
- this.platform.log.error('[DEBUG]', String(...log));
726
- }
727
- }
728
- }
729
- debugLog(...log) {
730
- if (this.enablingDeviceLogging()) {
731
- if (this.deviceLogging === 'debug') {
732
- this.platform.log.info('[DEBUG]', String(...log));
733
- }
734
- else {
735
- this.platform.log.debug(String(...log));
736
- }
737
- }
738
- }
739
- enablingDeviceLogging() {
740
- return this.deviceLogging.includes('debug') || this.deviceLogging === 'standard';
374
+ this.Outlet.Service.updateCharacteristic(this.hap.Characteristic.On, e);
741
375
  }
742
376
  }
743
377
  //# sourceMappingURL=plug.js.map