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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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 +279 -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 +294 -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,174 +1,145 @@
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
- import { SwitchBotPlatform } from '../platform.js';
4
+ import { Devices } from '../settings.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
+
7
+ import type { SwitchBotPlatform } from '../platform.js';
8
+ import type { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
9
+ import type { device, devicesConfig, deviceStatus, serviceData } from '../settings.js';
10
+
11
+ export class Lock extends deviceBase {
14
12
  // 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;
13
+ private LockMechanism: {
14
+ Name: CharacteristicValue;
15
+ Service: Service;
16
+ LockTargetState: CharacteristicValue;
17
+ LockCurrentState: CharacteristicValue;
18
+ };
19
+
20
+ private Battery: {
21
+ Name: CharacteristicValue;
22
+ Service: Service;
23
+ BatteryLevel: CharacteristicValue;
24
+ StatusLowBattery: CharacteristicValue;
25
+ };
26
+
27
+ private ContactSensor?: {
28
+ Name: CharacteristicValue;
29
+ Service: Service;
30
+ ContactSensorState: CharacteristicValue;
31
+ };
32
+
33
+ private Switch?: {
34
+ Name: CharacteristicValue;
35
+ Service: Service;
36
+ On: CharacteristicValue;
37
+ };
47
38
 
48
39
  // Updates
49
40
  lockUpdateInProgress!: boolean;
50
41
  doLockUpdate!: Subject<void>;
51
42
 
52
- // Connection
53
- private readonly OpenAPI: boolean;
54
- private readonly BLE: boolean;
55
-
56
43
  constructor(
57
- private readonly platform: SwitchBotPlatform,
58
- private accessory: PlatformAccessory,
59
- public device: device & devicesConfig,
44
+ readonly platform: SwitchBotPlatform,
45
+ accessory: PlatformAccessory,
46
+ device: device & devicesConfig,
60
47
  ) {
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
-
48
+ super(platform, accessory, device);
75
49
  // this is subject we use to track when we need to POST changes to the SwitchBot API
76
50
  this.doLockUpdate = new Subject();
77
51
  this.lockUpdateInProgress = false;
78
52
 
79
- // Retrieve initial values and updateHomekit
80
- this.refreshStatus();
81
-
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
- // get the LockMechanism service if it exists, otherwise create a new LockMechanism service
91
- // 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
- }
100
-
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));
107
-
108
-
109
- // Latch Button Service
110
- if (device.lock?.activate_latchbutton === false) { // remove the service when this variable is false
111
- 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');
123
-
124
- this.latchButtonService.setCharacteristic(this.hap.Characteristic.Name, latchServiceName);
125
-
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
- }
53
+ // Initialize LockMechanism Service
54
+ this.LockMechanism = {
55
+ Name: accessory.context.LockMechanismName ?? accessory.displayName,
56
+ Service: accessory.getService(this.hap.Service.LockMechanism) ?? accessory.addService(this.hap.Service.LockMechanism) as Service,
57
+ LockTargetState: accessory.context.LockTargetState ?? this.hap.Characteristic.LockTargetState.SECURED,
58
+ LockCurrentState: accessory.context.LockCurrentState ?? this.hap.Characteristic.LockCurrentState.SECURED,
59
+ };
60
+
61
+ // Initialize LockMechanism Characteristics
62
+ this.LockMechanism.Service
63
+ .setCharacteristic(this.hap.Characteristic.Name, this.LockMechanism.Name)
64
+ .getCharacteristic(this.hap.Characteristic.LockTargetState)
65
+ .onGet(() => {
66
+ return this.LockMechanism.LockTargetState;
67
+ })
68
+ .onSet(this.LockTargetStateSet.bind(this));
69
+ accessory.context.LockMechanismName = this.LockMechanism.Name;
70
+
71
+ // Initialize Battery property
72
+ this.Battery = {
73
+ Name: accessory.context.BatteryName ?? `${accessory.displayName} Battery`,
74
+ Service: accessory.getService(this.hap.Service.Battery) ?? accessory.addService(this.hap.Service.Battery) as Service,
75
+ BatteryLevel: accessory.context.BatteryLevel ?? 100,
76
+ StatusLowBattery: accessory.context.StatusLowBattery ?? this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL,
77
+ };
78
+
79
+ // Initialize Battery Characteristics
80
+ this.Battery.Service
81
+ .setCharacteristic(this.hap.Characteristic.Name, this.Battery.Name)
82
+ .setCharacteristic(this.hap.Characteristic.ChargingState, this.hap.Characteristic.ChargingState.NOT_CHARGEABLE)
83
+ .getCharacteristic(this.hap.Characteristic.BatteryLevel)
84
+ .onGet(() => {
85
+ return this.Battery.BatteryLevel;
86
+ });
141
87
 
88
+ this.Battery.Service
89
+ .getCharacteristic(this.hap.Characteristic.StatusLowBattery)
90
+ .onGet(() => {
91
+ return this.Battery.StatusLowBattery;
92
+ });
93
+ accessory.context.BatteryName = this.Battery.Name;
142
94
 
143
95
  // Contact Sensor Service
144
96
  if (device.lock?.hide_contactsensor) {
145
97
  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) {
149
- 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;
153
-
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
- }
98
+ this.ContactSensor!.Service = this.accessory.getService(this.hap.Service.ContactSensor) as Service;
99
+ accessory.removeService(this.ContactSensor!.Service);
158
100
  } else {
159
- this.debugLog(`${this.device.deviceType}: ${accessory.displayName} Contact Sensor Service Not Added`);
101
+ this.ContactSensor = {
102
+ Name: accessory.context.ContactSensorName ?? `${accessory.displayName} Contact Sensor`,
103
+ Service: accessory.getService(this.hap.Service.ContactSensor) ?? this.accessory.addService(this.hap.Service.ContactSensor) as Service,
104
+ ContactSensorState: accessory.context.ContactSensorState ?? this.hap.Characteristic.ContactSensorState.CONTACT_DETECTED,
105
+ };
106
+
107
+ // Initialize Contact Sensor Characteristics
108
+ this.ContactSensor.Service
109
+ .setCharacteristic(this.hap.Characteristic.Name, this.ContactSensor.Name)
110
+ .setCharacteristic(this.hap.Characteristic.StatusActive, true)
111
+ .getCharacteristic(this.hap.Characteristic.ContactSensorState)
112
+ .onGet(() => {
113
+ return this.ContactSensor!.ContactSensorState;
114
+ });
115
+ accessory.context.ContactSensorName = this.ContactSensor.Name;
160
116
  }
161
117
 
162
- // 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;
118
+ // Initialize Latch Button Service
119
+ if (device.lock?.activate_latchbutton === false) { // remove the service when this variable is false
120
+ this.debugLog(`${this.device.deviceType}: ${accessory.displayName} Removing Latch Button Service`);
121
+ this.Switch!.Service = accessory.getService(this.hap.Service.Switch) as Service;
122
+ accessory.removeService(this.Switch!.Service);
123
+ } else {
124
+ this.Switch = {
125
+ Name: accessory.context.SwitchName ?? `${accessory.displayName} Latch`,
126
+ Service: accessory.getService(this.hap.Service.Switch) ?? accessory.addService(this.hap.Service.Switch) as Service,
127
+ On: accessory.context.On ?? false,
128
+ };
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`);
130
+ // Initialize Latch Button Characteristics
131
+ this.Switch.Service
132
+ .setCharacteristic(this.hap.Characteristic.Name, this.Switch.Name)
133
+ .getCharacteristic(this.hap.Characteristic.On)
134
+ .onGet(() => {
135
+ return this.Switch!.On;
136
+ })
137
+ .onSet(this.OnSet.bind(this));
138
+ accessory.context.SwitchName = this.Switch.Name;
170
139
  }
171
- this.batteryService.setCharacteristic(this.hap.Characteristic.ChargingState, this.hap.Characteristic.ChargingState.NOT_CHARGEABLE);
140
+
141
+ // Retrieve initial values and updateHomekit
142
+ this.refreshStatus();
172
143
 
173
144
  // Update Homekit
174
145
  this.updateHomeKitCharacteristics();
@@ -181,18 +152,18 @@ export class Lock {
181
152
  });
182
153
 
183
154
  //regisiter webhook event handler
184
- if (this.device.webhook) {
185
- this.infoLog(`${this.device.deviceType}: ${this.accessory.displayName} is listening webhook.`);
155
+ if (device.webhook) {
156
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} is listening webhook.`);
186
157
  this.platform.webhookEventHandler[this.device.deviceId] = async (context) => {
187
158
  try {
188
159
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} received Webhook: ${JSON.stringify(context)}`);
189
160
  const { lockState } = context;
190
- const { LockCurrentState } = this;
161
+ const { LockCurrentState } = this.LockMechanism;
191
162
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ` +
192
163
  '(lockState) = ' +
193
164
  `Webhook:(${lockState}), ` +
194
165
  `current:(${LockCurrentState})`);
195
- this.LockCurrentState = lockState === 'LOCKED' ? 1 : 0;
166
+ this.LockMechanism.LockCurrentState = lockState === 'LOCKED' ? 1 : 0;
196
167
  this.updateHomeKitCharacteristics();
197
168
  } catch (e: any) {
198
169
  this.errorLog(`${this.device.deviceType}: ${this.accessory.displayName} `
@@ -224,134 +195,88 @@ export class Lock {
224
195
  });
225
196
  }
226
197
 
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> {
198
+ async BLEparseStatus(serviceData: serviceData): Promise<void> {
199
+ // BLE Status
289
200
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BLEparseStatus`);
290
- switch (this.BLE_LockCurrentState) {
201
+ switch (serviceData.status) {
291
202
  case 'locked':
292
- this.LockCurrentState = this.hap.Characteristic.LockCurrentState.SECURED;
293
- this.LockTargetState = this.hap.Characteristic.LockTargetState.SECURED;
203
+ this.LockMechanism.LockCurrentState = this.hap.Characteristic.LockCurrentState.SECURED;
204
+ this.LockMechanism.LockTargetState = this.hap.Characteristic.LockTargetState.SECURED;
294
205
  break;
295
206
  default:
296
- this.LockCurrentState = this.hap.Characteristic.LockCurrentState.UNSECURED;
297
- this.LockTargetState = this.hap.Characteristic.LockTargetState.UNSECURED;
207
+ this.LockMechanism.LockCurrentState = this.hap.Characteristic.LockCurrentState.UNSECURED;
208
+ this.LockMechanism.LockTargetState = this.hap.Characteristic.LockTargetState.UNSECURED;
298
209
  }
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;
210
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName}`
211
+ + ` LockTargetState: ${this.LockMechanism.LockTargetState}, LockCurrentState: ${this.LockMechanism.LockCurrentState}`);
212
+
213
+ // Contact Sensor
214
+ if (!this.device.lock?.hide_contactsensor) {
215
+ switch (serviceData.door_open) {
216
+ case 'opened':
217
+ this.ContactSensor!.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED;
218
+ break;
219
+ default:
220
+ this.ContactSensor!.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_DETECTED;
221
+ }
222
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ContactSensorState: ${this.ContactSensor!.ContactSensorState}`);
223
+
305
224
  }
306
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.LockTargetState}`);
307
225
  // Battery
308
- this.BatteryLevel = Number(this.BLE_BatteryLevel);
309
- if (this.BatteryLevel < 10) {
310
- this.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW;
226
+ this.Battery.BatteryLevel = Number(serviceData.battery);
227
+ if (this.Battery.BatteryLevel < 10) {
228
+ this.Battery.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW;
311
229
  } else {
312
- this.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
230
+ this.Battery.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
313
231
  }
314
- this.debugLog(
315
- `${this.device.deviceType}: ${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel},` + ` StatusLowBattery: ${this.StatusLowBattery}`,
316
- );
232
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName}`
233
+ + ` BatteryLevel: ${this.Battery.BatteryLevel}, StatusLowBattery: ${this.Battery.StatusLowBattery}`);
317
234
  }
318
235
 
319
- async openAPIparseStatus(): Promise<void> {
236
+ async openAPIparseStatus(deviceStatus: deviceStatus): Promise<void> {
320
237
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} openAPIparseStatus`);
321
- switch (this.OpenAPI_LockCurrentState) {
238
+ switch (deviceStatus.body.lockState) {
322
239
  case 'locked':
323
- this.LockCurrentState = this.hap.Characteristic.LockCurrentState.SECURED;
324
- this.LockTargetState = this.hap.Characteristic.LockTargetState.SECURED;
240
+ this.LockMechanism.LockCurrentState = this.hap.Characteristic.LockCurrentState.SECURED;
241
+ this.LockMechanism.LockTargetState = this.hap.Characteristic.LockTargetState.SECURED;
325
242
  break;
326
243
  default:
327
- this.LockCurrentState = this.hap.Characteristic.LockCurrentState.UNSECURED;
328
- this.LockTargetState = this.hap.Characteristic.LockTargetState.UNSECURED;
244
+ this.LockMechanism.LockCurrentState = this.hap.Characteristic.LockCurrentState.UNSECURED;
245
+ this.LockMechanism.LockTargetState = this.hap.Characteristic.LockTargetState.UNSECURED;
329
246
  }
330
- switch (this.OpenAPI_ContactSensorState) {
247
+ switch (deviceStatus.body.doorState) {
331
248
  case 'opened':
332
- this.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED;
249
+ this.ContactSensor!.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED;
333
250
  break;
334
251
  default:
335
- this.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_DETECTED;
252
+ this.ContactSensor!.ContactSensorState = this.hap.Characteristic.ContactSensorState.CONTACT_DETECTED;
336
253
  }
337
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.LockTargetState}`);
254
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} On: ${this.LockMechanism.LockTargetState}`);
338
255
 
339
256
  // Battery
340
- this.BatteryLevel = Number(this.OpenAPI_BatteryLevel);
341
- if (this.BatteryLevel < 10) {
342
- this.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW;
257
+ this.Battery.BatteryLevel = Number(deviceStatus.body.battery);
258
+ if (this.Battery.BatteryLevel < 10) {
259
+ this.Battery.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW;
343
260
  } else {
344
- this.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
261
+ this.Battery.StatusLowBattery = this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
345
262
  }
346
- if (Number.isNaN(this.BatteryLevel)) {
347
- this.BatteryLevel = 100;
263
+ if (Number.isNaN(this.Battery.BatteryLevel)) {
264
+ this.Battery.BatteryLevel = 100;
348
265
  }
349
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel},`
350
- + ` StatusLowBattery: ${this.StatusLowBattery}`);
266
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BatteryLevel: ${this.Battery.BatteryLevel},`
267
+ + ` StatusLowBattery: ${this.Battery.StatusLowBattery}`);
351
268
 
352
- // FirmwareRevision
353
- this.FirmwareRevision = this.OpenAPI_FirmwareRevision!;
354
- this.accessory.context.FirmwareRevision = this.FirmwareRevision;
269
+ // Firmware Version
270
+ const version = deviceStatus.body.version?.toString();
271
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Firmware Version: ${version?.replace(/^V|-.*$/g, '')}`);
272
+ if (deviceStatus.body.version) {
273
+ this.accessory.context.version = version?.replace(/^V|-.*$/g, '');
274
+ this.accessory
275
+ .getService(this.hap.Service.AccessoryInformation)!
276
+ .setCharacteristic(this.hap.Characteristic.FirmwareRevision, this.accessory.context.version)
277
+ .getCharacteristic(this.hap.Characteristic.FirmwareRevision)
278
+ .updateValue(this.accessory.context.version);
279
+ }
355
280
  }
356
281
 
357
282
  /**
@@ -386,103 +311,43 @@ export class Lock {
386
311
  // Start to monitor advertisement packets
387
312
  (async () => {
388
313
  // Start to monitor advertisement packets
389
- await switchbot.startScan({
390
- model: 'o',
391
- id: this.device.bleMac,
392
- });
314
+ await switchbot.startScan({ model: this.device.bleModel, id: this.device.bleMac });
393
315
  // Set an event handler
394
316
  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') {
317
+ if (this.device.bleMac === ad.address && ad.model === this.device.bleModel) {
318
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ${JSON.stringify(ad, null, ' ')}`);
319
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} address: ${ad.address}, model: ${ad.model}`);
398
320
  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
321
  } else {
404
322
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} serviceData: ${JSON.stringify(ad.serviceData)}`);
405
323
  }
406
324
  };
407
- // Wait 1 seconds
325
+ // Wait 10 seconds
408
326
  await switchbot.wait(this.scanDuration * 1000);
409
327
  // Stop to monitor
410
328
  await switchbot.stopScan();
411
329
  // Update HomeKit
412
- await this.BLEparseStatus();
330
+ await this.BLEparseStatus(switchbot.onadvertisement.serviceData);
413
331
  await this.updateHomeKitCharacteristics();
414
332
  })();
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 {
333
+ if (switchbot === undefined) {
464
334
  await this.BLERefreshConnection(switchbot);
465
- }*/
335
+ }
466
336
  }
467
337
 
468
338
  async openAPIRefreshStatus(): Promise<void> {
469
339
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} openAPIRefreshStatus`);
470
340
  try {
471
- const { body, statusCode } = await request(`${Devices}/${this.device.deviceId}/status`, {
472
- headers: this.platform.generateHeaders(),
473
- });
341
+ const { body, statusCode } = await this.platform.retryRequest(this.deviceMaxRetries, this.deviceDelayBetweenRetries,
342
+ `${Devices}/${this.device.deviceId}/status`, { headers: this.platform.generateHeaders() });
474
343
  this.debugWarnLog(`${this.device.deviceType}: ${this.accessory.displayName} statusCode: ${statusCode}`);
475
344
  const deviceStatus: any = await body.json();
476
345
  this.debugWarnLog(`${this.device.deviceType}: ${this.accessory.displayName} deviceStatus: ${JSON.stringify(deviceStatus)}`);
477
346
  this.debugWarnLog(`${this.device.deviceType}: ${this.accessory.displayName} deviceStatus statusCode: ${deviceStatus.statusCode}`);
478
347
  if ((statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)) {
479
- this.debugErrorLog(`${this.device.deviceType}: ${this.accessory.displayName} `
348
+ this.debugSuccessLog(`${this.device.deviceType}: ${this.accessory.displayName} `
480
349
  + `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();
350
+ this.openAPIparseStatus(deviceStatus);
486
351
  this.updateHomeKitCharacteristics();
487
352
  } else {
488
353
  this.statusCode(statusCode);
@@ -527,9 +392,9 @@ export class Lock {
527
392
 
528
393
  async BLEpushChanges(): Promise<void> {
529
394
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BLEpushChanges`);
530
- if (this.LockTargetState !== this.accessory.context.LockTargetState) {
395
+ if (this.LockMechanism.LockTargetState !== this.accessory.context.LockTargetState) {
531
396
  this.debugLog(
532
- `${this.device.deviceType}: ${this.accessory.displayName} BLEpushChanges LockTargetState: ${this.LockTargetState}` +
397
+ `${this.device.deviceType}: ${this.accessory.displayName} BLEpushChanges LockTargetState: ${this.LockMechanism.LockTargetState}` +
533
398
  ` LockTargetStateCached: ${this.accessory.context.LockTargetState}`,
534
399
  );
535
400
  const switchbot = await this.platform.connectBLE();
@@ -546,7 +411,9 @@ export class Lock {
546
411
  })
547
412
  .then(() => {
548
413
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Done.`);
549
- this.LockTargetState = this.hap.Characteristic.LockTargetState.SECURED;
414
+ this.successLog(`${this.device.deviceType}: ${this.accessory.displayName} `
415
+ + `LockTargetState: ${this.LockMechanism.LockTargetState} sent over BLE, sent successfully`);
416
+ this.LockMechanism.LockTargetState = this.hap.Characteristic.LockTargetState.SECURED;
550
417
  })
551
418
  .catch(async (e: any) => {
552
419
  this.apiError(e);
@@ -559,7 +426,7 @@ export class Lock {
559
426
  } else {
560
427
  this.debugLog(
561
428
  `${this.device.deviceType}: ${this.accessory.displayName} No BLEpushChanges.` +
562
- `LockTargetState: ${this.LockTargetState}, ` +
429
+ `LockTargetState: ${this.LockMechanism.LockTargetState}, ` +
563
430
  `LockTargetStateCached: ${this.accessory.context.LockTargetState}`,
564
431
  );
565
432
  }
@@ -568,13 +435,13 @@ export class Lock {
568
435
  async openAPIpushChanges(LatchUnlock?): Promise<void> {
569
436
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} openAPIpushChanges`);
570
437
 
571
- if ((this.LockTargetState !== this.accessory.context.LockTargetState) || LatchUnlock) {
438
+ if ((this.LockMechanism.LockTargetState !== this.accessory.context.LockTargetState) || LatchUnlock) {
572
439
  // Determine the command based on the LockTargetState or the forceUnlock parameter
573
440
  let command = '';
574
441
  if (LatchUnlock) {
575
442
  command = 'unlock';
576
443
  } else {
577
- command = this.LockTargetState ? 'lock' : 'unlock';
444
+ command = this.LockMechanism.LockTargetState ? 'lock' : 'unlock';
578
445
  }
579
446
  const bodyChange = JSON.stringify({
580
447
  command: `${command}`,
@@ -596,6 +463,8 @@ export class Lock {
596
463
  if ((statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)) {
597
464
  this.debugErrorLog(`${this.device.deviceType}: ${this.accessory.displayName} `
598
465
  + `statusCode: ${statusCode} & deviceStatus StatusCode: ${deviceStatus.statusCode}`);
466
+ this.successLog(`${this.device.deviceType}: ${this.accessory.displayName} `
467
+ + `request to SwitchBot API, body: ${JSON.stringify(deviceStatus)} sent successfully`);
599
468
  } else {
600
469
  this.statusCode(statusCode);
601
470
  this.statusCode(deviceStatus.statusCode);
@@ -610,7 +479,7 @@ export class Lock {
610
479
  } else {
611
480
  this.debugLog(
612
481
  `${this.device.deviceType}: ${this.accessory.displayName} No openAPIpushChanges.` +
613
- `LockTargetState: ${this.LockTargetState}, ` +
482
+ `LockTargetState: ${this.LockMechanism.LockTargetState}, ` +
614
483
  `LockTargetStateCached: ${this.accessory.context.LockTargetState}`,
615
484
  );
616
485
  }
@@ -620,81 +489,97 @@ export class Lock {
620
489
  * Handle requests to set the value of the "On" characteristic
621
490
  */
622
491
  async LockTargetStateSet(value: CharacteristicValue): Promise<void> {
623
- if (this.LockTargetState === this.accessory.context.LockTargetState) {
492
+ if (this.LockMechanism.LockTargetState === this.accessory.context.LockTargetState) {
624
493
  this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} No Changes, Set LockTargetState: ${value}`);
625
494
  } else {
626
495
  this.infoLog(`${this.device.deviceType}: ${this.accessory.displayName} Set LockTargetState: ${value}`);
627
496
  }
628
497
 
629
- this.LockTargetState = value;
498
+ this.LockMechanism.LockTargetState = value;
499
+ this.doLockUpdate.next();
500
+ }
501
+
502
+ /**
503
+ * Handle requests to set the value of the "On" characteristic
504
+ */
505
+ async OnSet(value: CharacteristicValue): Promise<void> {
506
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Latch Button Set On: ${value}`);
507
+ if (value) {
508
+ this.debugLog('Attempting to open the latch');
509
+
510
+ this.openAPIpushChanges(value).then(() => {
511
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Latch opened successfully`);
512
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName}`
513
+ + ` SwitchService is: ${this.Switch!.Service ? 'available' : 'not available'}`);
514
+
515
+ // simulate button press to turn the switch back off
516
+ if (this.Switch!.Service) {
517
+ const SwitchService = this.Switch!.Service;
518
+ // Simulate a button press by waiting a short period before turning the switch off
519
+ setTimeout(() => {
520
+ SwitchService.getCharacteristic(this.hap.Characteristic.On).updateValue(false);
521
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Latch button switched off automatically.`);
522
+ }, 500); // 500 ms delay
523
+ }
524
+ }).catch((e: any) => {
525
+ // Log the error if the operation failed
526
+ this.debugLog(`Error opening latch: ${e}`);
527
+ // Ensure we turn the switch back off even in case of an error
528
+ if (this.Switch!.Service) {
529
+ this.Switch!.Service.getCharacteristic(this.hap.Characteristic.On).updateValue(false);
530
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Latch button switched off after an error.`);
531
+ }
532
+ });
533
+ } else {
534
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} Switch is off, nothing to do`);
535
+ }
536
+
537
+ this.Switch!.On = value;
630
538
  this.doLockUpdate.next();
631
539
  }
632
540
 
633
541
  async updateHomeKitCharacteristics(): Promise<void> {
634
542
  if (!this.device.lock?.hide_contactsensor) {
635
- if (this.ContactSensorState === undefined) {
636
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ContactSensorState: ${this.ContactSensorState}`);
543
+ if (this.ContactSensor!.ContactSensorState === undefined) {
544
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} ContactSensorState: ${this.ContactSensor!.ContactSensorState}`);
637
545
  } 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}`);
546
+ this.accessory.context.ContactSensorState = this.ContactSensor!.ContactSensorState;
547
+ this.ContactSensor!.Service.updateCharacteristic(this.hap.Characteristic.ContactSensorState, this.ContactSensor!.ContactSensorState);
548
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic`
549
+ + ` ContactSensorState: ${this.ContactSensor!.ContactSensorState}`);
641
550
  }
642
551
  }
643
- if (this.LockTargetState === undefined) {
644
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} LockTargetState: ${this.LockTargetState}`);
552
+ if (this.LockMechanism.LockTargetState === undefined) {
553
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} LockTargetState: ${this.LockMechanism.LockTargetState}`);
645
554
  } 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}`);
555
+ this.accessory.context.LockTargetState = this.LockMechanism.LockTargetState;
556
+ this.LockMechanism.Service.updateCharacteristic(this.hap.Characteristic.LockTargetState, this.LockMechanism.LockTargetState);
557
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic`
558
+ + ` LockTargetState: ${this.LockMechanism.LockTargetState}`);
649
559
  }
650
- if (this.LockCurrentState === undefined) {
651
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} LockCurrentState: ${this.LockCurrentState}`);
560
+ if (this.LockMechanism.LockCurrentState === undefined) {
561
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} LockCurrentState: ${this.LockMechanism.LockCurrentState}`);
652
562
  } 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}`);
563
+ this.accessory.context.LockCurrentState = this.LockMechanism.LockCurrentState;
564
+ this.LockMechanism.Service.updateCharacteristic(this.hap.Characteristic.LockCurrentState, this.LockMechanism.LockCurrentState);
565
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic`
566
+ + ` LockCurrentState: ${this.LockMechanism.LockCurrentState}`);
656
567
  }
657
- if (this.BatteryLevel === undefined) {
658
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel}`);
568
+ if (this.Battery.BatteryLevel === undefined) {
569
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} BatteryLevel: ${this.Battery.BatteryLevel}`);
659
570
  } 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}`);
571
+ this.accessory.context.BatteryLevel = this.Battery.BatteryLevel;
572
+ this.Battery.Service.updateCharacteristic(this.hap.Characteristic.BatteryLevel, this.Battery.BatteryLevel);
573
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic`
574
+ + ` BatteryLevel: ${this.Battery.BatteryLevel}`);
663
575
  }
664
- if (this.StatusLowBattery === undefined) {
665
- this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} StatusLowBattery: ${this.StatusLowBattery}`);
576
+ if (this.Battery.StatusLowBattery === undefined) {
577
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} StatusLowBattery: ${this.Battery.StatusLowBattery}`);
666
578
  } 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
- })();
579
+ this.accessory.context.StatusLowBattery = this.Battery.StatusLowBattery;
580
+ this.Battery.Service.updateCharacteristic(this.hap.Characteristic.StatusLowBattery, this.Battery.StatusLowBattery);
581
+ this.debugLog(`${this.device.deviceType}: ${this.accessory.displayName} updateCharacteristic`
582
+ + ` StatusLowBattery: ${this.Battery.StatusLowBattery}`);
698
583
  }
699
584
  }
700
585
 
@@ -714,227 +599,22 @@ export class Lock {
714
599
  }
715
600
  }
716
601
 
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
602
  async offlineOff(): Promise<void> {
810
603
  if (this.device.offline) {
811
- await this.deviceContext();
812
- await this.updateHomeKitCharacteristics();
604
+ if (!this.device.lock?.hide_contactsensor) {
605
+ this.ContactSensor!.Service.updateCharacteristic(this.hap.Characteristic.ContactSensorState,
606
+ this.hap.Characteristic.ContactSensorState.CONTACT_DETECTED);
607
+ }
608
+ this.LockMechanism.Service.updateCharacteristic(this.hap.Characteristic.LockTargetState, this.hap.Characteristic.LockTargetState.SECURED);
609
+ this.LockMechanism.Service.updateCharacteristic(this.hap.Characteristic.LockCurrentState, this.hap.Characteristic.LockCurrentState.SECURED);
813
610
  }
814
611
  }
815
612
 
816
613
  async apiError(e: any): Promise<void> {
817
614
  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;
853
- }
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}`);
615
+ this.ContactSensor!.Service.updateCharacteristic(this.hap.Characteristic.ContactSensorState, e);
887
616
  }
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';
617
+ this.LockMechanism.Service.updateCharacteristic(this.hap.Characteristic.LockTargetState, e);
618
+ this.LockMechanism.Service.updateCharacteristic(this.hap.Characteristic.LockCurrentState, e);
939
619
  }
940
620
  }