@switchbot/homebridge-switchbot 3.5.0-beta.5 → 3.5.0-beta.51

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 (169) hide show
  1. package/CHANGELOG.md +2 -0
  2. package/config.schema.json +120 -17
  3. package/dist/device/blindtilt.d.ts +21 -94
  4. package/dist/device/blindtilt.d.ts.map +1 -1
  5. package/dist/device/blindtilt.js +352 -757
  6. package/dist/device/blindtilt.js.map +1 -1
  7. package/dist/device/bot.d.ts +25 -71
  8. package/dist/device/bot.d.ts.map +1 -1
  9. package/dist/device/bot.js +588 -761
  10. package/dist/device/bot.js.map +1 -1
  11. package/dist/device/ceilinglight.d.ts +13 -67
  12. package/dist/device/ceilinglight.d.ts.map +1 -1
  13. package/dist/device/ceilinglight.js +214 -588
  14. package/dist/device/ceilinglight.js.map +1 -1
  15. package/dist/device/colorbulb.d.ts +13 -74
  16. package/dist/device/colorbulb.d.ts.map +1 -1
  17. package/dist/device/colorbulb.js +256 -634
  18. package/dist/device/colorbulb.js.map +1 -1
  19. package/dist/device/contact.d.ts +14 -65
  20. package/dist/device/contact.d.ts.map +1 -1
  21. package/dist/device/contact.js +209 -532
  22. package/dist/device/contact.js.map +1 -1
  23. package/dist/device/curtain.d.ts +17 -86
  24. package/dist/device/curtain.d.ts.map +1 -1
  25. package/dist/device/curtain.js +340 -787
  26. package/dist/device/curtain.js.map +1 -1
  27. package/dist/device/device.d.ts +59 -0
  28. package/dist/device/device.d.ts.map +1 -0
  29. package/dist/device/device.js +682 -0
  30. package/dist/device/device.js.map +1 -0
  31. package/dist/device/fan.d.ts +51 -0
  32. package/dist/device/fan.d.ts.map +1 -0
  33. package/dist/device/fan.js +505 -0
  34. package/dist/device/fan.js.map +1 -0
  35. package/dist/device/hub.d.ts +15 -59
  36. package/dist/device/hub.d.ts.map +1 -1
  37. package/dist/device/hub.js +247 -597
  38. package/dist/device/hub.js.map +1 -1
  39. package/dist/device/humidifier.d.ts +10 -65
  40. package/dist/device/humidifier.d.ts.map +1 -1
  41. package/dist/device/humidifier.js +218 -579
  42. package/dist/device/humidifier.js.map +1 -1
  43. package/dist/device/iosensor.d.ts +11 -64
  44. package/dist/device/iosensor.d.ts.map +1 -1
  45. package/dist/device/iosensor.js +179 -585
  46. package/dist/device/iosensor.js.map +1 -1
  47. package/dist/device/lightstrip.d.ts +10 -68
  48. package/dist/device/lightstrip.d.ts.map +1 -1
  49. package/dist/device/lightstrip.js +257 -569
  50. package/dist/device/lightstrip.js.map +1 -1
  51. package/dist/device/lock.d.ts +15 -62
  52. package/dist/device/lock.d.ts.map +1 -1
  53. package/dist/device/lock.js +215 -543
  54. package/dist/device/lock.js.map +1 -1
  55. package/dist/device/meter.d.ts +13 -63
  56. package/dist/device/meter.d.ts.map +1 -1
  57. package/dist/device/meter.js +175 -578
  58. package/dist/device/meter.js.map +1 -1
  59. package/dist/device/meterplus.d.ts +13 -64
  60. package/dist/device/meterplus.d.ts.map +1 -1
  61. package/dist/device/meterplus.js +164 -578
  62. package/dist/device/meterplus.js.map +1 -1
  63. package/dist/device/motion.d.ts +13 -69
  64. package/dist/device/motion.d.ts.map +1 -1
  65. package/dist/device/motion.js +142 -520
  66. package/dist/device/motion.js.map +1 -1
  67. package/dist/device/plug.d.ts +9 -57
  68. package/dist/device/plug.d.ts.map +1 -1
  69. package/dist/device/plug.js +87 -453
  70. package/dist/device/plug.js.map +1 -1
  71. package/dist/device/robotvacuumcleaner.d.ts +11 -62
  72. package/dist/device/robotvacuumcleaner.d.ts.map +1 -1
  73. package/dist/device/robotvacuumcleaner.js +145 -452
  74. package/dist/device/robotvacuumcleaner.js.map +1 -1
  75. package/dist/device/waterdetector.d.ts +9 -70
  76. package/dist/device/waterdetector.d.ts.map +1 -1
  77. package/dist/device/waterdetector.js +126 -665
  78. package/dist/device/waterdetector.js.map +1 -1
  79. package/dist/homebridge-ui/public/index.html +2 -2
  80. package/dist/index.js +1 -1
  81. package/dist/irdevice/airconditioner.d.ts +8 -48
  82. package/dist/irdevice/airconditioner.d.ts.map +1 -1
  83. package/dist/irdevice/airconditioner.js +309 -419
  84. package/dist/irdevice/airconditioner.js.map +1 -1
  85. package/dist/irdevice/airpurifier.d.ts +7 -38
  86. package/dist/irdevice/airpurifier.d.ts.map +1 -1
  87. package/dist/irdevice/airpurifier.js +72 -304
  88. package/dist/irdevice/airpurifier.js.map +1 -1
  89. package/dist/irdevice/camera.d.ts +6 -35
  90. package/dist/irdevice/camera.d.ts.map +1 -1
  91. package/dist/irdevice/camera.js +34 -278
  92. package/dist/irdevice/camera.js.map +1 -1
  93. package/dist/irdevice/fan.d.ts +6 -39
  94. package/dist/irdevice/fan.d.ts.map +1 -1
  95. package/dist/irdevice/fan.js +67 -311
  96. package/dist/irdevice/fan.js.map +1 -1
  97. package/dist/irdevice/irdevice.d.ts +40 -0
  98. package/dist/irdevice/irdevice.d.ts.map +1 -0
  99. package/dist/irdevice/irdevice.js +512 -0
  100. package/dist/irdevice/irdevice.js.map +1 -0
  101. package/dist/irdevice/light.d.ts +6 -34
  102. package/dist/irdevice/light.d.ts.map +1 -1
  103. package/dist/irdevice/light.js +23 -272
  104. package/dist/irdevice/light.js.map +1 -1
  105. package/dist/irdevice/other.d.ts +18 -47
  106. package/dist/irdevice/other.d.ts.map +1 -1
  107. package/dist/irdevice/other.js +352 -546
  108. package/dist/irdevice/other.js.map +1 -1
  109. package/dist/irdevice/tv.d.ts +7 -39
  110. package/dist/irdevice/tv.d.ts.map +1 -1
  111. package/dist/irdevice/tv.js +82 -321
  112. package/dist/irdevice/tv.js.map +1 -1
  113. package/dist/irdevice/vacuumcleaner.d.ts +6 -35
  114. package/dist/irdevice/vacuumcleaner.d.ts.map +1 -1
  115. package/dist/irdevice/vacuumcleaner.js +41 -284
  116. package/dist/irdevice/vacuumcleaner.js.map +1 -1
  117. package/dist/irdevice/waterheater.d.ts +6 -35
  118. package/dist/irdevice/waterheater.d.ts.map +1 -1
  119. package/dist/irdevice/waterheater.js +42 -287
  120. package/dist/irdevice/waterheater.js.map +1 -1
  121. package/dist/platform.d.ts +14 -1
  122. package/dist/platform.d.ts.map +1 -1
  123. package/dist/platform.js +291 -147
  124. package/dist/platform.js.map +1 -1
  125. package/dist/settings.d.ts +41 -11
  126. package/dist/settings.d.ts.map +1 -1
  127. package/dist/settings.js +0 -552
  128. package/dist/settings.js.map +1 -1
  129. package/dist/utils.d.ts +77 -0
  130. package/dist/utils.d.ts.map +1 -1
  131. package/dist/utils.js +638 -1
  132. package/dist/utils.js.map +1 -1
  133. package/eslint.config.js +87 -0
  134. package/package.json +16 -15
  135. package/src/custom.d.ts +2 -1
  136. package/src/device/blindtilt.ts +378 -783
  137. package/src/device/bot.ts +621 -845
  138. package/src/device/ceilinglight.ts +227 -608
  139. package/src/device/colorbulb.ts +269 -657
  140. package/src/device/contact.ts +235 -555
  141. package/src/device/curtain.ts +360 -811
  142. package/src/device/device.ts +710 -0
  143. package/src/device/fan.ts +554 -0
  144. package/src/device/hub.ts +274 -625
  145. package/src/device/humidifier.ts +246 -624
  146. package/src/device/iosensor.ts +205 -611
  147. package/src/device/lightstrip.ts +278 -597
  148. package/src/device/lock.ts +252 -583
  149. package/src/device/meter.ts +200 -601
  150. package/src/device/meterplus.ts +189 -603
  151. package/src/device/motion.ts +161 -542
  152. package/src/device/plug.ts +97 -481
  153. package/src/device/robotvacuumcleaner.ts +166 -478
  154. package/src/device/waterdetector.ts +143 -689
  155. package/src/homebridge-ui/public/index.html +2 -2
  156. package/src/index.ts +1 -1
  157. package/src/irdevice/airconditioner.ts +330 -446
  158. package/src/irdevice/airpurifier.ts +89 -321
  159. package/src/irdevice/camera.ts +42 -293
  160. package/src/irdevice/fan.ts +78 -327
  161. package/src/irdevice/irdevice.ts +528 -0
  162. package/src/irdevice/light.ts +32 -287
  163. package/src/irdevice/other.ts +396 -615
  164. package/src/irdevice/tv.ts +100 -339
  165. package/src/irdevice/vacuumcleaner.ts +49 -305
  166. package/src/irdevice/waterheater.ts +50 -310
  167. package/src/platform.ts +301 -155
  168. package/src/settings.ts +57 -566
  169. package/src/utils.ts +642 -1
@@ -1,174 +1,134 @@
1
1
  import { request } from 'undici';
2
- import { sleep } from '../utils.js';
2
+ import { deviceBase } from './device.js';
3
3
  import { interval, Subject } from 'rxjs';
4
4
  import { SwitchBotPlatform } from '../platform.js';
5
5
  import { debounceTime, skipWhile, take, tap } from 'rxjs/operators';
6
- import { Service, PlatformAccessory, CharacteristicValue, API, Logging, HAP } from 'homebridge';
7
- import { device, devicesConfig, deviceStatus, Devices, serviceData, SwitchBotPlatformConfig } from '../settings.js';
8
-
9
- export class Lock {
10
- public readonly api: API;
11
- public readonly log: Logging;
12
- public readonly config!: SwitchBotPlatformConfig;
13
- protected readonly hap: HAP;
6
+ import { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
7
+ import { device, devicesConfig, deviceStatus, Devices, serviceData } from '../settings.js';
8
+
9
+ export class Lock extends deviceBase {
14
10
  // Services
15
- lockService: Service;
16
- batteryService: Service;
17
- contactSensorService?: Service;
18
- latchButtonService?: Service;
19
-
20
- // Characteristic Values
21
- BatteryLevel!: CharacteristicValue;
22
- LockTargetState!: CharacteristicValue;
23
- LockCurrentState!: CharacteristicValue;
24
- FirmwareRevision!: CharacteristicValue;
25
- StatusLowBattery!: CharacteristicValue;
26
- ContactSensorState!: CharacteristicValue;
27
-
28
- // OpenAPI Status
29
- OpenAPI_BatteryLevel: deviceStatus['battery'];
30
- OpenAPI_FirmwareRevision: deviceStatus['version'];
31
- OpenAPI_LockCurrentState!: deviceStatus['lockState'];
32
- OpenAPI_ContactSensorState!: deviceStatus['doorState'];
33
-
34
- // BLE Status
35
- BLE_BatteryLevel: serviceData['battery'];
36
- BLE_LockCurrentState: serviceData['state'];
37
- BLE_Calibration: serviceData['calibration'];
38
- BLE_ContactSensorState: serviceData['door_open'];
39
-
40
- // BLE Others
41
- BLE_IsConnected?: boolean;
42
-
43
- // Config
44
- scanDuration!: number;
45
- deviceLogging!: string;
46
- deviceRefreshRate!: number;
11
+ private LockMechanism: {
12
+ Service: Service;
13
+ LockTargetState: CharacteristicValue;
14
+ LockCurrentState: CharacteristicValue;
15
+ };
16
+
17
+ private Battery: {
18
+ Service: Service;
19
+ BatteryLevel: CharacteristicValue;
20
+ StatusLowBattery: CharacteristicValue;
21
+ };
22
+
23
+ private ContactSensor?: {
24
+ Service: Service;
25
+ ContactSensorState: CharacteristicValue;
26
+ };
27
+
28
+ private Switch?: {
29
+ Service: Service;
30
+ On: CharacteristicValue;
31
+ };
47
32
 
48
33
  // Updates
49
34
  lockUpdateInProgress!: boolean;
50
35
  doLockUpdate!: Subject<void>;
51
36
 
52
- // Connection
53
- private readonly OpenAPI: boolean;
54
- private readonly BLE: boolean;
55
-
56
37
  constructor(
57
- private readonly platform: SwitchBotPlatform,
58
- private accessory: PlatformAccessory,
59
- public device: device & devicesConfig,
38
+ readonly platform: SwitchBotPlatform,
39
+ accessory: PlatformAccessory,
40
+ device: device & devicesConfig,
60
41
  ) {
61
- this.api = this.platform.api;
62
- this.log = this.platform.log;
63
- this.config = this.platform.config;
64
- this.hap = this.api.hap;
65
- // Connection
66
- this.BLE = this.device.connectionType === 'BLE' || this.device.connectionType === 'BLE/OpenAPI';
67
- this.OpenAPI = this.device.connectionType === 'OpenAPI' || this.device.connectionType === 'BLE/OpenAPI';
68
- // default placeholders
69
- this.deviceLogs(device);
70
- this.scan(device);
71
- this.refreshRate(device);
72
- this.deviceContext();
73
- this.deviceConfig(device);
74
-
42
+ super(platform, accessory, device);
75
43
  // this is subject we use to track when we need to POST changes to the SwitchBot API
76
44
  this.doLockUpdate = new Subject();
77
45
  this.lockUpdateInProgress = false;
78
46
 
47
+ // Initialize LockMechanism property
48
+ this.LockMechanism = {
49
+ Service: accessory.getService(this.hap.Service.LockMechanism)!,
50
+ LockTargetState: accessory.context.LockTargetState || this.hap.Characteristic.LockTargetState.SECURED,
51
+ LockCurrentState: accessory.context.LockCurrentState || this.hap.Characteristic.LockCurrentState.SECURED,
52
+ };
53
+
54
+ // Initialize Battery property
55
+ this.Battery = {
56
+ Service: accessory.getService(this.hap.Service.Battery)!,
57
+ BatteryLevel: accessory.context.BatteryLevel || 100,
58
+ StatusLowBattery: accessory.context.StatusLowBattery || this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL,
59
+ };
60
+
61
+ // Initialize ContactSensor property
62
+ if (!this.device.lock?.hide_contactsensor) {
63
+ this.ContactSensor = {
64
+ Service: accessory.getService(this.hap.Service.ContactSensor)!,
65
+ ContactSensorState: accessory.context.ContactSensorState || this.hap.Characteristic.ContactSensorState.CONTACT_DETECTED,
66
+ };
67
+ }
68
+
69
+ // Initialize Latch Button Service
70
+ if (device.lock?.activate_latchbutton) {
71
+ this.Switch = {
72
+ Service: accessory.getService(this.hap.Service.Switch)!,
73
+ On: accessory.context.On || false,
74
+ };
75
+ }
76
+
79
77
  // Retrieve initial values and updateHomekit
80
78
  this.refreshStatus();
81
79
 
82
- // set accessory information
83
- accessory
84
- .getService(this.hap.Service.AccessoryInformation)!
85
- .setCharacteristic(this.hap.Characteristic.Manufacturer, 'SwitchBot')
86
- .setCharacteristic(this.hap.Characteristic.Model, 'W1601700')
87
- .setCharacteristic(this.hap.Characteristic.SerialNumber, device.deviceId)
88
- .setCharacteristic(this.hap.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision);
89
-
90
80
  // get the LockMechanism service if it exists, otherwise create a new LockMechanism service
91
81
  // you can create multiple services for each accessory
92
- const lockService = `${accessory.displayName} ${device.deviceType}`;
93
- (this.lockService = accessory.getService(this.hap.Service.LockMechanism)
94
- || accessory.addService(this.hap.Service.LockMechanism)), lockService;
95
-
96
- this.lockService.setCharacteristic(this.hap.Characteristic.Name, accessory.displayName);
97
- if (!this.lockService.testCharacteristic(this.hap.Characteristic.ConfiguredName)) {
98
- this.lockService.addCharacteristic(this.hap.Characteristic.ConfiguredName, accessory.displayName);
99
- }
82
+ const LockMechanismService = `${accessory.displayName} ${device.deviceType}`;
83
+ (this.LockMechanism.Service = accessory.getService(this.hap.Service.LockMechanism)
84
+ || accessory.addService(this.hap.Service.LockMechanism)), LockMechanismService;
100
85
 
101
- // each service must implement at-minimum the "required characteristics" for the given service type
102
- // see https://developers.homebridge.io/#/service/LockMechanism
103
-
104
-
105
- // create handlers for required characteristics
106
- this.lockService.getCharacteristic(this.hap.Characteristic.LockTargetState).onSet(this.LockTargetStateSet.bind(this));
86
+ this.LockMechanism.Service.setCharacteristic(this.hap.Characteristic.Name, accessory.displayName);
107
87
 
88
+ this.LockMechanism.Service.getCharacteristic(this.hap.Characteristic.LockTargetState).onSet(this.LockTargetStateSet.bind(this));
108
89
 
109
90
  // Latch Button Service
110
91
  if (device.lock?.activate_latchbutton === false) { // remove the service when this variable is false
111
92
  this.debugLog(`${this.device.deviceType}: ${accessory.displayName} Removing Latch Button Service`);
112
- this.latchButtonService = accessory.getService(this.hap.Service.Switch);
113
- if (this.latchButtonService) {
114
- accessory.removeService(this.latchButtonService);
115
- this.latchButtonService = undefined; // Reset the service variable to undefined
116
- }
117
- } else
118
- if (!this.latchButtonService) {
119
- this.debugLog(`${this.device.deviceType}: ${accessory.displayName} Adding Latch Button Service`);
120
- const latchServiceName = `${accessory.displayName} Latch`;
121
- this.latchButtonService = accessory.getService(this.hap.Service.Switch)
122
- || accessory.addService(this.hap.Service.Switch, latchServiceName, 'LatchButtonServiceIdentifier');
93
+ this.Switch!.Service = accessory.getService(this.hap.Service.Switch) as Service;
94
+ accessory.removeService(this.Switch!.Service);
95
+ } else if (!this.Switch!.Service && device.lock?.activate_latchbutton === true) {
96
+ this.debugLog(`${this.device.deviceType}: ${accessory.displayName} Adding Latch Button Service`);
97
+ const latchServiceName = `${accessory.displayName} Latch`;
98
+ this.Switch!.Service = accessory.getService(this.hap.Service.Switch)
99
+ || accessory.addService(this.hap.Service.Switch, latchServiceName, 'Switch.ServiceIdentifier');
123
100
 
124
- this.latchButtonService.setCharacteristic(this.hap.Characteristic.Name, latchServiceName);
101
+ this.Switch!.Service.setCharacteristic(this.hap.Characteristic.Name, latchServiceName);
125
102
 
126
- if (!this.latchButtonService.testCharacteristic(this.hap.Characteristic.On)) {
127
- this.latchButtonService.addCharacteristic(this.hap.Characteristic.On);
128
- }
129
-
130
- this.latchButtonService.getCharacteristic(this.hap.Characteristic.On)
131
- .on('set', (value, callback) => {
132
- if (typeof value === 'boolean') {
133
- this.handleLatchCharacteristic(value, callback);
134
- } else {
135
- callback(new Error('Wrong characteristic value type'));
136
- }
137
- });
138
- } else {
139
- this.debugLog(`${this.device.deviceType}: ${accessory.displayName} Latch Button Service already exists`);
140
- }
103
+ this.Switch!.Service.getCharacteristic(this.hap.Characteristic.On).onSet(this.OnSet.bind(this));
104
+ } else {
105
+ this.debugLog(`${this.device.deviceType}: ${accessory.displayName} Latch Button Service Not Added`);
106
+ }
141
107
 
142
108
 
143
109
  // Contact Sensor Service
144
110
  if (device.lock?.hide_contactsensor) {
145
111
  this.debugLog(`${this.device.deviceType}: ${accessory.displayName} Removing Contact Sensor Service`);
146
- this.contactSensorService = this.accessory.getService(this.hap.Service.ContactSensor);
147
- accessory.removeService(this.contactSensorService!);
148
- } else if (!this.contactSensorService) {
112
+ this.ContactSensor!.Service = this.accessory.getService(this.hap.Service.ContactSensor) as Service;
113
+ accessory.removeService(this.ContactSensor!.Service);
114
+ } else if (!this.ContactSensor?.Service) {
149
115
  this.debugLog(`${this.device.deviceType}: ${accessory.displayName} Add Contact Sensor Service`);
150
- const contactSensorService = `${accessory.displayName} Contact Sensor`;
151
- (this.contactSensorService = this.accessory.getService(this.hap.Service.ContactSensor)
152
- || this.accessory.addService(this.hap.Service.ContactSensor)), contactSensorService;
116
+ const ContactSensorService = `${accessory.displayName} Contact Sensor`;
117
+ (this.ContactSensor!.Service = this.accessory.getService(this.hap.Service.ContactSensor)
118
+ || this.accessory.addService(this.hap.Service.ContactSensor)), ContactSensorService;
153
119
 
154
- this.contactSensorService.setCharacteristic(this.hap.Characteristic.Name, `${accessory.displayName} Contact Sensor`);
155
- if (!this.contactSensorService.testCharacteristic(this.hap.Characteristic.ConfiguredName)) {
156
- this.contactSensorService.addCharacteristic(this.hap.Characteristic.ConfiguredName, `${accessory.displayName} Contact Sensor`);
157
- }
120
+ this.ContactSensor!.Service.setCharacteristic(this.hap.Characteristic.Name, ContactSensorService);
158
121
  } else {
159
122
  this.debugLog(`${this.device.deviceType}: ${accessory.displayName} Contact Sensor Service Not Added`);
160
123
  }
161
124
 
162
125
  // Battery Service
163
- const batteryService = `${accessory.displayName} Battery`;
164
- (this.batteryService = this.accessory.getService(this.hap.Service.Battery)
165
- || accessory.addService(this.hap.Service.Battery)), batteryService;
126
+ const BatteryService = `${accessory.displayName} Battery`;
127
+ (this.Battery.Service = this.accessory.getService(this.hap.Service.Battery)
128
+ || accessory.addService(this.hap.Service.Battery)), BatteryService;
166
129
 
167
- this.batteryService.setCharacteristic(this.hap.Characteristic.Name, `${accessory.displayName} Battery`);
168
- if (!this.batteryService.testCharacteristic(this.hap.Characteristic.ConfiguredName)) {
169
- this.batteryService.addCharacteristic(this.hap.Characteristic.ConfiguredName, `${accessory.displayName} Battery`);
170
- }
171
- this.batteryService.setCharacteristic(this.hap.Characteristic.ChargingState, this.hap.Characteristic.ChargingState.NOT_CHARGEABLE);
130
+ this.Battery.Service.setCharacteristic(this.hap.Characteristic.Name, BatteryService);
131
+ this.Battery.Service.setCharacteristic(this.hap.Characteristic.ChargingState, this.hap.Characteristic.ChargingState.NOT_CHARGEABLE);
172
132
 
173
133
  // Update Homekit
174
134
  this.updateHomeKitCharacteristics();
@@ -181,18 +141,18 @@ export class Lock {
181
141
  });
182
142
 
183
143
  //regisiter webhook event handler
184
- if (this.device.webhook) {
185
- this.infoLog(`${this.device.deviceType}: ${this.accessory.displayName} is listening webhook.`);
144
+ if (device.webhook) {
145
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} is listening webhook.`);
186
146
  this.platform.webhookEventHandler[this.device.deviceId] = async (context) => {
187
147
  try {
188
148
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} received Webhook: ${JSON.stringify(context)}`);
189
149
  const { lockState } = context;
190
- const { LockCurrentState } = this;
150
+ const { LockCurrentState } = this.LockMechanism;
191
151
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ` +
192
152
  '(lockState) = ' +
193
153
  `Webhook:(${lockState}), ` +
194
154
  `current:(${LockCurrentState})`);
195
- this.LockCurrentState = lockState === 'LOCKED' ? 1 : 0;
155
+ this.LockMechanism.LockCurrentState = lockState === 'LOCKED' ? 1 : 0;
196
156
  this.updateHomeKitCharacteristics();
197
157
  } catch (e: any) {
198
158
  this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} `
@@ -224,134 +184,88 @@ export class Lock {
224
184
  });
225
185
  }
226
186
 
227
- /**
228
- * Method for handling the LatchCharacteristic
229
- */
230
- async handleLatchCharacteristic(value: boolean, callback) {
231
- this.debugLog(`handleLatchCharacteristic called with value: ${value}`);
232
-
233
- if (value) {
234
- this.debugLog('Attempting to open the latch');
235
-
236
- this.openAPIpushChanges(value).then(() => {
237
- this.debugLog('Latch opened successfully');
238
- this.debugLog(`LatchButtonService is: ${this.latchButtonService ? 'available' : 'not available'}`);
239
-
240
- // simulate button press to turn the switch back off
241
- if (this.latchButtonService) {
242
- const latchButtonService = this.latchButtonService;
243
- // Simulate a button press by waiting a short period before turning the switch off
244
- setTimeout(() => {
245
- latchButtonService.getCharacteristic(this.hap.Characteristic.On).updateValue(false);
246
- this.debugLog('Latch button switched off automatically.');
247
- }, 500); // 500 ms delay
248
- }
249
- callback(null);
250
- }).catch((error) => {
251
- // Log the error if the operation failed
252
- this.debugLog(`Error opening latch: ${error}`);
253
-
254
- // Ensure we turn the switch back off even in case of an error
255
- if (this.latchButtonService) {
256
- this.latchButtonService.getCharacteristic(this.hap.Characteristic.On).updateValue(false);
257
- this.debugLog('Latch button switched off after an error.');
258
- }
259
-
260
- callback(error);
261
- });
262
-
263
- } else {
264
- this.debugLog('Switch is off, nothing to do');
265
- callback(null);
266
- }
267
- }
268
-
269
-
270
- /**
271
- * Parse the device status from the SwitchBot api
272
- */
273
- async parseStatus(): Promise<void> {
274
- if (!this.device.enableCloudService && this.OpenAPI) {
275
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} parseStatus enableCloudService: ${this.device.enableCloudService}`);
276
- /* } else if (this.BLE) {
277
- await this.BLEparseStatus();*/
278
- } else if (this.OpenAPI && this.platform.config.credentials?.token) {
279
- await this.openAPIparseStatus();
280
- } else {
281
- await this.offlineOff();
282
- this.debugWarnLog(
283
- `${this.device.deviceType}: ${this.accessory.displayName} Connection Type:` + ` ${this.device.connectionType}, parseStatus will not happen.`,
284
- );
285
- }
286
- }
287
-
288
- async BLEparseStatus(): Promise<void> {
187
+ async BLEparseStatus(serviceData: serviceData): Promise<void> {
188
+ // BLE Status
289
189
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BLEparseStatus`);
290
- switch (this.BLE_LockCurrentState) {
190
+ switch (serviceData.status) {
291
191
  case 'locked':
292
- this.LockCurrentState = this.hap.Characteristic.LockCurrentState.SECURED;
293
- this.LockTargetState = this.hap.Characteristic.LockTargetState.SECURED;
192
+ this.LockMechanism.LockCurrentState = this.hap.Characteristic.LockCurrentState.SECURED;
193
+ this.LockMechanism.LockTargetState = this.hap.Characteristic.LockTargetState.SECURED;
294
194
  break;
295
195
  default:
296
- this.LockCurrentState = this.hap.Characteristic.LockCurrentState.UNSECURED;
297
- this.LockTargetState = this.hap.Characteristic.LockTargetState.UNSECURED;
196
+ this.LockMechanism.LockCurrentState = this.hap.Characteristic.LockCurrentState.UNSECURED;
197
+ this.LockMechanism.LockTargetState = this.hap.Characteristic.LockTargetState.UNSECURED;
298
198
  }
299
- switch (this.BLE_ContactSensorState) {
300
- case 'opened':
301
- this.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED;
302
- break;
303
- default:
304
- this.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_DETECTED;
199
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName}`
200
+ + ` LockTargetState: ${this.LockMechanism.LockTargetState}, LockCurrentState: ${this.LockMechanism.LockCurrentState}`);
201
+
202
+ // Contact Sensor
203
+ if (!this.device.lock?.hide_contactsensor) {
204
+ switch (serviceData.door_open) {
205
+ case 'opened':
206
+ this.ContactSensor!.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED;
207
+ break;
208
+ default:
209
+ this.ContactSensor!.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_DETECTED;
210
+ }
211
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ContactSensorState: ${this.ContactSensor!.ContactSensorState}`);
212
+
305
213
  }
306
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.LockTargetState}`);
307
214
  // Battery
308
- this.BatteryLevel = Number(this.BLE_BatteryLevel);
309
- if (this.BatteryLevel < 10) {
310
- this.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW;
215
+ this.Battery.BatteryLevel = Number(serviceData.battery);
216
+ if (this.Battery.BatteryLevel < 10) {
217
+ this.Battery.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW;
311
218
  } else {
312
- this.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
219
+ this.Battery.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
313
220
  }
314
- this.debugLog(
315
- `${this.device.deviceType}: ${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel},` + ` StatusLowBattery: ${this.StatusLowBattery}`,
316
- );
221
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName}`
222
+ + ` BatteryLevel: ${this.Battery.BatteryLevel}, StatusLowBattery: ${this.Battery.StatusLowBattery}`);
317
223
  }
318
224
 
319
- async openAPIparseStatus(): Promise<void> {
225
+ async openAPIparseStatus(deviceStatus: deviceStatus): Promise<void> {
320
226
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} openAPIparseStatus`);
321
- switch (this.OpenAPI_LockCurrentState) {
227
+ switch (deviceStatus.body.lockState) {
322
228
  case 'locked':
323
- this.LockCurrentState = this.hap.Characteristic.LockCurrentState.SECURED;
324
- this.LockTargetState = this.hap.Characteristic.LockTargetState.SECURED;
229
+ this.LockMechanism.LockCurrentState = this.hap.Characteristic.LockCurrentState.SECURED;
230
+ this.LockMechanism.LockTargetState = this.hap.Characteristic.LockTargetState.SECURED;
325
231
  break;
326
232
  default:
327
- this.LockCurrentState = this.hap.Characteristic.LockCurrentState.UNSECURED;
328
- this.LockTargetState = this.hap.Characteristic.LockTargetState.UNSECURED;
233
+ this.LockMechanism.LockCurrentState = this.hap.Characteristic.LockCurrentState.UNSECURED;
234
+ this.LockMechanism.LockTargetState = this.hap.Characteristic.LockTargetState.UNSECURED;
329
235
  }
330
- switch (this.OpenAPI_ContactSensorState) {
236
+ switch (deviceStatus.body.doorState) {
331
237
  case 'opened':
332
- this.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED;
238
+ this.ContactSensor!.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED;
333
239
  break;
334
240
  default:
335
- this.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_DETECTED;
241
+ this.ContactSensor!.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_DETECTED;
336
242
  }
337
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.LockTargetState}`);
243
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.LockMechanism.LockTargetState}`);
338
244
 
339
245
  // Battery
340
- this.BatteryLevel = Number(this.OpenAPI_BatteryLevel);
341
- if (this.BatteryLevel < 10) {
342
- this.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW;
246
+ this.Battery.BatteryLevel = Number(deviceStatus.body.battery);
247
+ if (this.Battery.BatteryLevel < 10) {
248
+ this.Battery.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW;
343
249
  } else {
344
- this.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
250
+ this.Battery.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
345
251
  }
346
- if (Number.isNaN(this.BatteryLevel)) {
347
- this.BatteryLevel = 100;
252
+ if (Number.isNaN(this.Battery.BatteryLevel)) {
253
+ this.Battery.BatteryLevel = 100;
348
254
  }
349
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel},`
350
- + ` StatusLowBattery: ${this.StatusLowBattery}`);
255
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BatteryLevel: ${this.Battery.BatteryLevel},`
256
+ + ` StatusLowBattery: ${this.Battery.StatusLowBattery}`);
351
257
 
352
- // FirmwareRevision
353
- this.FirmwareRevision = this.OpenAPI_FirmwareRevision!;
354
- this.accessory.context.FirmwareRevision = this.FirmwareRevision;
258
+ // Firmware Version
259
+ const version = deviceStatus.body.version?.toString();
260
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Firmware Version: ${version?.replace(/^V|-.*$/g, '')}`);
261
+ if (deviceStatus.body.version) {
262
+ this.accessory.context.version = version?.replace(/^V|-.*$/g, '');
263
+ this.accessory
264
+ .getService(this.hap.Service.AccessoryInformation)!
265
+ .setCharacteristic(this.hap.Characteristic.FirmwareRevision, this.accessory.context.version)
266
+ .getCharacteristic(this.hap.Characteristic.FirmwareRevision)
267
+ .updateValue(this.accessory.context.version);
268
+ }
355
269
  }
356
270
 
357
271
  /**
@@ -386,103 +300,43 @@ export class Lock {
386
300
  // Start to monitor advertisement packets
387
301
  (async () => {
388
302
  // Start to monitor advertisement packets
389
- await switchbot.startScan({
390
- model: 'o',
391
- id: this.device.bleMac,
392
- });
303
+ await switchbot.startScan({ model: this.device.bleModel, id: this.device.bleMac });
393
304
  // Set an event handler
394
305
  switchbot.onadvertisement = (ad: any) => {
395
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ${JSON.stringify(ad, null, ' ')}`);
396
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} address: ${ad.address}, model: ${ad.serviceData.model}`);
397
- if (this.device.bleMac === ad.address && ad.serviceData.model === 'o') {
306
+ if (this.device.bleMac === ad.address && ad.model === this.device.bleModel) {
307
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ${JSON.stringify(ad, null, ' ')}`);
308
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} address: ${ad.address}, model: ${ad.model}`);
398
309
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} serviceData: ${JSON.stringify(ad.serviceData)}`);
399
- this.BLE_BatteryLevel = ad.serviceData.battery;
400
- this.BLE_Calibration = ad.serviceData.calibration;
401
- this.BLE_LockCurrentState = ad.serviceData.status;
402
- this.BLE_ContactSensorState = ad.serviceData.door_open;
403
310
  } else {
404
311
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} serviceData: ${JSON.stringify(ad.serviceData)}`);
405
312
  }
406
313
  };
407
- // Wait 1 seconds
314
+ // Wait 10 seconds
408
315
  await switchbot.wait(this.scanDuration * 1000);
409
316
  // Stop to monitor
410
317
  await switchbot.stopScan();
411
318
  // Update HomeKit
412
- await this.BLEparseStatus();
319
+ await this.BLEparseStatus(switchbot.onadvertisement.serviceData);
413
320
  await this.updateHomeKitCharacteristics();
414
321
  })();
415
- /*if (switchbot !== false) {
416
- switchbot
417
- .startScan({
418
- model: 'o',
419
- id: this.device.bleMac,
420
- })
421
- .then(async () => {
422
- // Set an event handler
423
- switchbot.onadvertisement = async (ad: ad) => {
424
- this.debugLog(
425
- `${this.device.deviceType}: ${this.accessory.displayName} Config BLE Address: ${this.device.bleMac},` +
426
- ` BLE Address Found: ${ad.address}`,
427
- );
428
- this.BLE_BatteryLevel = ad.serviceData.battery;
429
- this.BLE_Calibration = ad.serviceData.calibration;
430
- this.BLE_LockCurrentState = ad.serviceData.status;
431
- this.BLE_ContactSensorState = ad.serviceData.door_open;
432
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} serviceData: ${JSON.stringify(ad.serviceData)}`);
433
- this.debugLog(
434
- `${this.device.deviceType}: ${this.accessory.displayName} battery: ${ad.serviceData.battery}, ` +
435
- `calibration: ${ad.serviceData.calibration}, status: ${ad.serviceData.status}, battery: ${ad.serviceData.battery}, ` +
436
- `door_open: ${ad.serviceData.door_open}`,
437
- );
438
-
439
- if (ad.serviceData) {
440
- this.BLE_IsConnected = true;
441
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} connected: ${this.BLE_IsConnected}`);
442
- await this.stopScanning(switchbot);
443
- } else {
444
- this.BLE_IsConnected = false;
445
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} connected: ${this.BLE_IsConnected}`);
446
- }
447
- };
448
- // Wait
449
- return await sleep(this.scanDuration * 1000);
450
- })
451
- .then(async () => {
452
- // Stop to monitor
453
- await this.stopScanning(switchbot);
454
- })
455
- .catch(async (e: any) => {
456
- this.apiError(e);
457
- this.errorLog(
458
- `${this.device.deviceType}: ${this.accessory.displayName} failed BLERefreshStatus with ${this.device.connectionType}` +
459
- ` Connection, Error Message: ${JSON.stringify(e.message)}`,
460
- );
461
- await this.BLERefreshConnection(switchbot);
462
- });
463
- } else {
322
+ if (switchbot === undefined) {
464
323
  await this.BLERefreshConnection(switchbot);
465
- }*/
324
+ }
466
325
  }
467
326
 
468
327
  async openAPIRefreshStatus(): Promise<void> {
469
328
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} openAPIRefreshStatus`);
470
329
  try {
471
- const { body, statusCode } = await request(`${Devices}/${this.device.deviceId}/status`, {
472
- headers: this.platform.generateHeaders(),
473
- });
330
+ const { body, statusCode } = await this.platform.retryRequest(this.deviceMaxRetries, this.deviceDelayBetweenRetries,
331
+ `${Devices}/${this.device.deviceId}/status`, { headers: this.platform.generateHeaders() });
474
332
  this.debugWarnLog(`${this.device.deviceType}: ${this.accessory.displayName} statusCode: ${statusCode}`);
475
333
  const deviceStatus: any = await body.json();
476
334
  this.debugWarnLog(`${this.device.deviceType}: ${this.accessory.displayName} deviceStatus: ${JSON.stringify(deviceStatus)}`);
477
335
  this.debugWarnLog(`${this.device.deviceType}: ${this.accessory.displayName} deviceStatus statusCode: ${deviceStatus.statusCode}`);
478
336
  if ((statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)) {
479
- this.debugErrorLog(`${this.device.deviceType}: ${this.accessory.displayName} `
337
+ this.debugSuccessLog(`${this.device.deviceType}: ${this.accessory.displayName} `
480
338
  + `statusCode: ${statusCode} & deviceStatus StatusCode: ${deviceStatus.statusCode}`);
481
- this.OpenAPI_LockCurrentState = deviceStatus.body.lockState;
482
- this.OpenAPI_ContactSensorState = deviceStatus.body.doorState;
483
- this.OpenAPI_BatteryLevel = deviceStatus.body.battery;
484
- this.OpenAPI_FirmwareRevision = deviceStatus.body.version;
485
- this.openAPIparseStatus();
339
+ this.openAPIparseStatus(deviceStatus);
486
340
  this.updateHomeKitCharacteristics();
487
341
  } else {
488
342
  this.statusCode(statusCode);
@@ -527,9 +381,9 @@ export class Lock {
527
381
 
528
382
  async BLEpushChanges(): Promise<void> {
529
383
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BLEpushChanges`);
530
- if (this.LockTargetState !== this.accessory.context.LockTargetState) {
384
+ if (this.LockMechanism.LockTargetState !== this.accessory.context.LockTargetState) {
531
385
  this.debugLog(
532
- `${this.device.deviceType}: ${this.accessory.displayName} BLEpushChanges LockTargetState: ${this.LockTargetState}` +
386
+ `${this.device.deviceType}: ${this.accessory.displayName} BLEpushChanges LockTargetState: ${this.LockMechanism.LockTargetState}` +
533
387
  ` LockTargetStateCached: ${this.accessory.context.LockTargetState}`,
534
388
  );
535
389
  const switchbot = await this.platform.connectBLE();
@@ -546,7 +400,9 @@ export class Lock {
546
400
  })
547
401
  .then(() => {
548
402
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Done.`);
549
- this.LockTargetState = this.hap.Characteristic.LockTargetState.SECURED;
403
+ this.successLog(`${this.device.deviceType}: ${this.accessory.displayName} `
404
+ + `LockTargetState: ${this.LockMechanism.LockTargetState} sent over BLE, sent successfully`);
405
+ this.LockMechanism.LockTargetState = this.hap.Characteristic.LockTargetState.SECURED;
550
406
  })
551
407
  .catch(async (e: any) => {
552
408
  this.apiError(e);
@@ -559,7 +415,7 @@ export class Lock {
559
415
  } else {
560
416
  this.debugLog(
561
417
  `${this.device.deviceType}: ${this.accessory.displayName} No BLEpushChanges.` +
562
- `LockTargetState: ${this.LockTargetState}, ` +
418
+ `LockTargetState: ${this.LockMechanism.LockTargetState}, ` +
563
419
  `LockTargetStateCached: ${this.accessory.context.LockTargetState}`,
564
420
  );
565
421
  }
@@ -568,13 +424,13 @@ export class Lock {
568
424
  async openAPIpushChanges(LatchUnlock?): Promise<void> {
569
425
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} openAPIpushChanges`);
570
426
 
571
- if ((this.LockTargetState !== this.accessory.context.LockTargetState) || LatchUnlock) {
427
+ if ((this.LockMechanism.LockTargetState !== this.accessory.context.LockTargetState) || LatchUnlock) {
572
428
  // Determine the command based on the LockTargetState or the forceUnlock parameter
573
429
  let command = '';
574
430
  if (LatchUnlock) {
575
431
  command = 'unlock';
576
432
  } else {
577
- command = this.LockTargetState ? 'lock' : 'unlock';
433
+ command = this.LockMechanism.LockTargetState ? 'lock' : 'unlock';
578
434
  }
579
435
  const bodyChange = JSON.stringify({
580
436
  command: `${command}`,
@@ -596,6 +452,8 @@ export class Lock {
596
452
  if ((statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)) {
597
453
  this.debugErrorLog(`${this.device.deviceType}: ${this.accessory.displayName} `
598
454
  + `statusCode: ${statusCode} & deviceStatus StatusCode: ${deviceStatus.statusCode}`);
455
+ this.successLog(`${this.device.deviceType}: ${this.accessory.displayName} `
456
+ + `request to SwitchBot API, body: ${JSON.stringify(deviceStatus)} sent successfully`);
599
457
  } else {
600
458
  this.statusCode(statusCode);
601
459
  this.statusCode(deviceStatus.statusCode);
@@ -610,7 +468,7 @@ export class Lock {
610
468
  } else {
611
469
  this.debugLog(
612
470
  `${this.device.deviceType}: ${this.accessory.displayName} No openAPIpushChanges.` +
613
- `LockTargetState: ${this.LockTargetState}, ` +
471
+ `LockTargetState: ${this.LockMechanism.LockTargetState}, ` +
614
472
  `LockTargetStateCached: ${this.accessory.context.LockTargetState}`,
615
473
  );
616
474
  }
@@ -620,81 +478,97 @@ export class Lock {
620
478
  * Handle requests to set the value of the "On" characteristic
621
479
  */
622
480
  async LockTargetStateSet(value: CharacteristicValue): Promise<void> {
623
- if (this.LockTargetState === this.accessory.context.LockTargetState) {
481
+ if (this.LockMechanism.LockTargetState === this.accessory.context.LockTargetState) {
624
482
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} No Changes, Set LockTargetState: ${value}`);
625
483
  } else {
626
484
  this.infoLog(`${this.device.deviceType}: ${this.accessory.displayName} Set LockTargetState: ${value}`);
627
485
  }
628
486
 
629
- this.LockTargetState = value;
487
+ this.LockMechanism.LockTargetState = value;
488
+ this.doLockUpdate.next();
489
+ }
490
+
491
+ /**
492
+ * Handle requests to set the value of the "On" characteristic
493
+ */
494
+ async OnSet(value: CharacteristicValue): Promise<void> {
495
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Latch Button Set On: ${value}`);
496
+ if (value) {
497
+ this.debugLog('Attempting to open the latch');
498
+
499
+ this.openAPIpushChanges(value).then(() => {
500
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Latch opened successfully`);
501
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName}`
502
+ + ` SwitchService is: ${this.Switch!.Service ? 'available' : 'not available'}`);
503
+
504
+ // simulate button press to turn the switch back off
505
+ if (this.Switch!.Service) {
506
+ const SwitchService = this.Switch!.Service;
507
+ // Simulate a button press by waiting a short period before turning the switch off
508
+ setTimeout(() => {
509
+ SwitchService.getCharacteristic(this.hap.Characteristic.On).updateValue(false);
510
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Latch button switched off automatically.`);
511
+ }, 500); // 500 ms delay
512
+ }
513
+ }).catch((e: any) => {
514
+ // Log the error if the operation failed
515
+ this.debugLog(`Error opening latch: ${e}`);
516
+ // Ensure we turn the switch back off even in case of an error
517
+ if (this.Switch!.Service) {
518
+ this.Switch!.Service.getCharacteristic(this.hap.Characteristic.On).updateValue(false);
519
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Latch button switched off after an error.`);
520
+ }
521
+ });
522
+ } else {
523
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Switch is off, nothing to do`);
524
+ }
525
+
526
+ this.Switch!.On = value;
630
527
  this.doLockUpdate.next();
631
528
  }
632
529
 
633
530
  async updateHomeKitCharacteristics(): Promise<void> {
634
531
  if (!this.device.lock?.hide_contactsensor) {
635
- if (this.ContactSensorState === undefined) {
636
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ContactSensorState: ${this.ContactSensorState}`);
532
+ if (this.ContactSensor!.ContactSensorState === undefined) {
533
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ContactSensorState: ${this.ContactSensor!.ContactSensorState}`);
637
534
  } else {
638
- this.accessory.context.ContactSensorState = this.ContactSensorState;
639
- this.contactSensorService?.updateCharacteristic(this.hap.Characteristic.ContactSensorState, this.ContactSensorState);
640
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic ContactSensorState: ${this.ContactSensorState}`);
535
+ this.accessory.context.ContactSensorState = this.ContactSensor!.ContactSensorState;
536
+ this.ContactSensor!.Service.updateCharacteristic(this.hap.Characteristic.ContactSensorState, this.ContactSensor!.ContactSensorState);
537
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic`
538
+ + ` ContactSensorState: ${this.ContactSensor!.ContactSensorState}`);
641
539
  }
642
540
  }
643
- if (this.LockTargetState === undefined) {
644
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} LockTargetState: ${this.LockTargetState}`);
541
+ if (this.LockMechanism.LockTargetState === undefined) {
542
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} LockTargetState: ${this.LockMechanism.LockTargetState}`);
645
543
  } else {
646
- this.accessory.context.LockTargetState = this.LockTargetState;
647
- this.lockService.updateCharacteristic(this.hap.Characteristic.LockTargetState, this.LockTargetState);
648
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic LockTargetState: ${this.LockTargetState}`);
544
+ this.accessory.context.LockTargetState = this.LockMechanism.LockTargetState;
545
+ this.LockMechanism.Service.updateCharacteristic(this.hap.Characteristic.LockTargetState, this.LockMechanism.LockTargetState);
546
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic`
547
+ + ` LockTargetState: ${this.LockMechanism.LockTargetState}`);
649
548
  }
650
- if (this.LockCurrentState === undefined) {
651
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} LockCurrentState: ${this.LockCurrentState}`);
549
+ if (this.LockMechanism.LockCurrentState === undefined) {
550
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} LockCurrentState: ${this.LockMechanism.LockCurrentState}`);
652
551
  } else {
653
- this.accessory.context.LockCurrentState = this.LockCurrentState;
654
- this.lockService.updateCharacteristic(this.hap.Characteristic.LockCurrentState, this.LockCurrentState);
655
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic LockCurrentState: ${this.LockCurrentState}`);
552
+ this.accessory.context.LockCurrentState = this.LockMechanism.LockCurrentState;
553
+ this.LockMechanism.Service.updateCharacteristic(this.hap.Characteristic.LockCurrentState, this.LockMechanism.LockCurrentState);
554
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic`
555
+ + ` LockCurrentState: ${this.LockMechanism.LockCurrentState}`);
656
556
  }
657
- if (this.BatteryLevel === undefined) {
658
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel}`);
557
+ if (this.Battery.BatteryLevel === undefined) {
558
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BatteryLevel: ${this.Battery.BatteryLevel}`);
659
559
  } else {
660
- this.accessory.context.BatteryLevel = this.BatteryLevel;
661
- this.batteryService?.updateCharacteristic(this.hap.Characteristic.BatteryLevel, this.BatteryLevel);
662
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic BatteryLevel: ${this.BatteryLevel}`);
560
+ this.accessory.context.BatteryLevel = this.Battery.BatteryLevel;
561
+ this.Battery.Service.updateCharacteristic(this.hap.Characteristic.BatteryLevel, this.Battery.BatteryLevel);
562
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic`
563
+ + ` BatteryLevel: ${this.Battery.BatteryLevel}`);
663
564
  }
664
- if (this.StatusLowBattery === undefined) {
665
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} StatusLowBattery: ${this.StatusLowBattery}`);
565
+ if (this.Battery.StatusLowBattery === undefined) {
566
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} StatusLowBattery: ${this.Battery.StatusLowBattery}`);
666
567
  } else {
667
- this.accessory.context.StatusLowBattery = this.StatusLowBattery;
668
- this.batteryService?.updateCharacteristic(this.hap.Characteristic.StatusLowBattery, this.StatusLowBattery);
669
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic StatusLowBattery: ${this.StatusLowBattery}`);
670
- }
671
- }
672
-
673
- async stopScanning(switchbot: any) {
674
- switchbot.stopScan();
675
- if (this.BLE_IsConnected) {
676
- await this.BLEparseStatus();
677
- await this.updateHomeKitCharacteristics();
678
- } else {
679
- await this.BLERefreshConnection(switchbot);
680
- }
681
- }
682
-
683
- async getCustomBLEAddress(switchbot: any) {
684
- if (this.device.customBLEaddress && this.deviceLogging.includes('debug')) {
685
- (async () => {
686
- // Start to monitor advertisement packets
687
- await switchbot.startScan({
688
- model: 'c',
689
- });
690
- // Set an event handler
691
- switchbot.onadvertisement = (ad: any) => {
692
- this.warnLog(`${this.device.deviceType}: ${this.accessory.displayName} ad: ${JSON.stringify(ad, null, ' ')}`);
693
- };
694
- await sleep(10000);
695
- // Stop to monitor
696
- switchbot.stopScan();
697
- })();
568
+ this.accessory.context.StatusLowBattery = this.Battery.StatusLowBattery;
569
+ this.Battery.Service.updateCharacteristic(this.hap.Characteristic.StatusLowBattery, this.Battery.StatusLowBattery);
570
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic`
571
+ + ` StatusLowBattery: ${this.Battery.StatusLowBattery}`);
698
572
  }
699
573
  }
700
574
 
@@ -714,227 +588,22 @@ export class Lock {
714
588
  }
715
589
  }
716
590
 
717
- async scan(device: device & devicesConfig): Promise<void> {
718
- if (device.scanDuration) {
719
- this.scanDuration = this.accessory.context.scanDuration = device.scanDuration;
720
- if (this.BLE) {
721
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Device Config scanDuration: ${this.scanDuration}`);
722
- }
723
- } else {
724
- this.scanDuration = this.accessory.context.scanDuration = 1;
725
- if (this.BLE) {
726
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Default scanDuration: ${this.scanDuration}`);
727
- }
728
- }
729
- }
730
-
731
- async statusCode(statusCode: number): Promise<void> {
732
- switch (statusCode) {
733
- case 151:
734
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Command not supported by this deviceType, statusCode: ${statusCode}`);
735
- break;
736
- case 152:
737
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Device not found, statusCode: ${statusCode}`);
738
- break;
739
- case 160:
740
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Command is not supported, statusCode: ${statusCode}`);
741
- break;
742
- case 161:
743
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Device is offline, statusCode: ${statusCode}`);
744
- this.offlineOff();
745
- break;
746
- case 171:
747
- this.errorLog(
748
- `${this.device.deviceType}: ${this.accessory.displayName} Hub Device is offline, statusCode: ${statusCode}. ` +
749
- `Hub: ${this.device.hubDeviceId}`,
750
- );
751
- this.offlineOff();
752
- break;
753
- case 190:
754
- this.errorLog(
755
- `${this.device.deviceType}: ${this.accessory.displayName} Device internal error due to device states not synchronized with server,` +
756
- ` Or command format is invalid, statusCode: ${statusCode}`,
757
- );
758
- break;
759
- case 100:
760
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Command successfully sent, statusCode: ${statusCode}`);
761
- break;
762
- case 200:
763
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Request successful, statusCode: ${statusCode}`);
764
- break;
765
- case 400:
766
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Bad Request, The client has issued an invalid request. `
767
- + `This is commonly used to specify validation errors in a request payload, statusCode: ${statusCode}`);
768
- break;
769
- case 401:
770
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Unauthorized, Authorization for the API is required, `
771
- + `but the request has not been authenticated, statusCode: ${statusCode}`);
772
- break;
773
- case 403:
774
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Forbidden, The request has been authenticated but does not `
775
- + `have appropriate permissions, or a requested resource is not found, statusCode: ${statusCode}`);
776
- break;
777
- case 404:
778
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Not Found, Specifies the requested path does not exist, `
779
- + `statusCode: ${statusCode}`);
780
- break;
781
- case 406:
782
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Not Acceptable, The client has requested a MIME type via `
783
- + `the Accept header for a value not supported by the server, statusCode: ${statusCode}`);
784
- break;
785
- case 415:
786
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Unsupported Media Type, The client has defined a contentType `
787
- + `header that is not supported by the server, statusCode: ${statusCode}`);
788
- break;
789
- case 422:
790
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Unprocessable Entity, The client has made a valid request, `
791
- + `but the server cannot process it. This is often used for APIs for which certain limits have been exceeded, statusCode: ${statusCode}`);
792
- break;
793
- case 429:
794
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Too Many Requests, The client has exceeded the number of `
795
- + `requests allowed for a given time window, statusCode: ${statusCode}`);
796
- break;
797
- case 500:
798
- this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} Internal Server Error, An unexpected error on the SmartThings `
799
- + `servers has occurred. These errors should be rare, statusCode: ${statusCode}`);
800
- break;
801
- default:
802
- this.infoLog(
803
- `${this.device.deviceType}: ${this.accessory.displayName} Unknown statusCode: ` +
804
- `${statusCode}, Submit Bugs Here: ' + 'https://tinyurl.com/SwitchBotBug`,
805
- );
806
- }
807
- }
808
-
809
591
  async offlineOff(): Promise<void> {
810
592
  if (this.device.offline) {
811
- await this.deviceContext();
812
- await this.updateHomeKitCharacteristics();
593
+ if (!this.device.lock?.hide_contactsensor) {
594
+ this.ContactSensor!.Service.updateCharacteristic(this.hap.Characteristic.ContactSensorState,
595
+ this.hap.Characteristic.ContactSensorState.CONTACT_DETECTED);
596
+ }
597
+ this.LockMechanism.Service.updateCharacteristic(this.hap.Characteristic.LockTargetState, this.hap.Characteristic.LockTargetState.SECURED);
598
+ this.LockMechanism.Service.updateCharacteristic(this.hap.Characteristic.LockCurrentState, this.hap.Characteristic.LockCurrentState.SECURED);
813
599
  }
814
600
  }
815
601
 
816
602
  async apiError(e: any): Promise<void> {
817
603
  if (!this.device.lock?.hide_contactsensor) {
818
- this.contactSensorService?.updateCharacteristic(this.hap.Characteristic.ContactSensorState, e);
819
- }
820
- this.lockService.updateCharacteristic(this.hap.Characteristic.LockTargetState, e);
821
- this.lockService.updateCharacteristic(this.hap.Characteristic.LockCurrentState, e);
822
- }
823
-
824
- async deviceContext() {
825
- if (this.LockTargetState === undefined) {
826
- this.LockTargetState = false;
827
- } else {
828
- this.LockTargetState = this.accessory.context.On;
829
- }
830
- if (this.FirmwareRevision === undefined) {
831
- this.FirmwareRevision = this.platform.version;
832
- this.accessory.context.FirmwareRevision = this.FirmwareRevision;
833
- }
834
- }
835
-
836
- async refreshRate(device: device & devicesConfig): Promise<void> {
837
- if (device.refreshRate) {
838
- this.deviceRefreshRate = this.accessory.context.refreshRate = device.refreshRate;
839
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Device Config refreshRate: ${this.deviceRefreshRate}`);
840
- } else if (this.platform.config.options!.refreshRate) {
841
- this.deviceRefreshRate = this.accessory.context.refreshRate = this.platform.config.options!.refreshRate;
842
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Platform Config refreshRate: ${this.deviceRefreshRate}`);
843
- }
844
- }
845
-
846
- async deviceConfig(device: device & devicesConfig): Promise<void> {
847
- let config = {};
848
- if (device.lock) {
849
- config = device.lock;
850
- }
851
- if (device.connectionType !== undefined) {
852
- config['connectionType'] = device.connectionType;
604
+ this.ContactSensor!.Service.updateCharacteristic(this.hap.Characteristic.ContactSensorState, e);
853
605
  }
854
- if (device.external !== undefined) {
855
- config['external'] = device.external;
856
- }
857
- if (device.logging !== undefined) {
858
- config['logging'] = device.logging;
859
- }
860
- if (device.refreshRate !== undefined) {
861
- config['refreshRate'] = device.refreshRate;
862
- }
863
- if (device.scanDuration !== undefined) {
864
- config['scanDuration'] = device.scanDuration;
865
- }
866
- if (device.webhook !== undefined) {
867
- config['webhook'] = device.webhook;
868
- }
869
- if (Object.entries(config).length !== 0) {
870
- this.debugWarnLog(`${this.device.deviceType}: ${this.accessory.displayName} Config: ${JSON.stringify(config)}`);
871
- }
872
- }
873
-
874
- async deviceLogs(device: device & devicesConfig): Promise<void> {
875
- if (this.platform.debugMode) {
876
- this.deviceLogging = this.accessory.context.logging = 'debugMode';
877
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Debug Mode Logging: ${this.deviceLogging}`);
878
- } else if (device.logging) {
879
- this.deviceLogging = this.accessory.context.logging = device.logging;
880
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Device Config Logging: ${this.deviceLogging}`);
881
- } else if (this.platform.config.options?.logging) {
882
- this.deviceLogging = this.accessory.context.logging = this.platform.config.options?.logging;
883
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Using Platform Config Logging: ${this.deviceLogging}`);
884
- } else {
885
- this.deviceLogging = this.accessory.context.logging = 'standard';
886
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Logging Not Set, Using: ${this.deviceLogging}`);
887
- }
888
- }
889
-
890
- /**
891
- * Logging for Device
892
- */
893
- infoLog(...log: any[]): void {
894
- if (this.enablingDeviceLogging()) {
895
- this.platform.log.info(String(...log));
896
- }
897
- }
898
-
899
- warnLog(...log: any[]): void {
900
- if (this.enablingDeviceLogging()) {
901
- this.platform.log.warn(String(...log));
902
- }
903
- }
904
-
905
- debugWarnLog(...log: any[]): void {
906
- if (this.enablingDeviceLogging()) {
907
- if (this.deviceLogging?.includes('debug')) {
908
- this.platform.log.warn('[DEBUG]', String(...log));
909
- }
910
- }
911
- }
912
-
913
- errorLog(...log: any[]): void {
914
- if (this.enablingDeviceLogging()) {
915
- this.platform.log.error(String(...log));
916
- }
917
- }
918
-
919
- debugErrorLog(...log: any[]): void {
920
- if (this.enablingDeviceLogging()) {
921
- if (this.deviceLogging?.includes('debug')) {
922
- this.platform.log.error('[DEBUG]', String(...log));
923
- }
924
- }
925
- }
926
-
927
- debugLog(...log: any[]): void {
928
- if (this.enablingDeviceLogging()) {
929
- if (this.deviceLogging === 'debug') {
930
- this.platform.log.info('[DEBUG]', String(...log));
931
- } else {
932
- this.platform.log.debug(String(...log));
933
- }
934
- }
935
- }
936
-
937
- enablingDeviceLogging(): boolean {
938
- return this.deviceLogging.includes('debug') || this.deviceLogging === 'standard';
606
+ this.LockMechanism.Service.updateCharacteristic(this.hap.Characteristic.LockTargetState, e);
607
+ this.LockMechanism.Service.updateCharacteristic(this.hap.Characteristic.LockCurrentState, e);
939
608
  }
940
609
  }