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

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 (178) hide show
  1. package/.vscode/settings.json +4 -1
  2. package/CHANGELOG.md +4 -1
  3. package/config.schema.json +170 -26
  4. package/dist/device/blindtilt.d.ts +21 -96
  5. package/dist/device/blindtilt.d.ts.map +1 -1
  6. package/dist/device/blindtilt.js +439 -817
  7. package/dist/device/blindtilt.js.map +1 -1
  8. package/dist/device/bot.d.ts +27 -72
  9. package/dist/device/bot.d.ts.map +1 -1
  10. package/dist/device/bot.js +835 -865
  11. package/dist/device/bot.js.map +1 -1
  12. package/dist/device/ceilinglight.d.ts +15 -69
  13. package/dist/device/ceilinglight.d.ts.map +1 -1
  14. package/dist/device/ceilinglight.js +287 -653
  15. package/dist/device/ceilinglight.js.map +1 -1
  16. package/dist/device/colorbulb.d.ts +15 -76
  17. package/dist/device/colorbulb.d.ts.map +1 -1
  18. package/dist/device/colorbulb.js +354 -732
  19. package/dist/device/colorbulb.js.map +1 -1
  20. package/dist/device/contact.d.ts +14 -66
  21. package/dist/device/contact.d.ts.map +1 -1
  22. package/dist/device/contact.js +268 -576
  23. package/dist/device/contact.js.map +1 -1
  24. package/dist/device/curtain.d.ts +18 -89
  25. package/dist/device/curtain.d.ts.map +1 -1
  26. package/dist/device/curtain.js +431 -851
  27. package/dist/device/curtain.js.map +1 -1
  28. package/dist/device/device.d.ts +60 -0
  29. package/dist/device/device.d.ts.map +1 -0
  30. package/dist/device/device.js +739 -0
  31. package/dist/device/device.js.map +1 -0
  32. package/dist/device/fan.d.ts +63 -0
  33. package/dist/device/fan.d.ts.map +1 -0
  34. package/dist/device/fan.js +698 -0
  35. package/dist/device/fan.js.map +1 -0
  36. package/dist/device/hub.d.ts +15 -60
  37. package/dist/device/hub.d.ts.map +1 -1
  38. package/dist/device/hub.js +257 -631
  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 +266 -629
  43. package/dist/device/humidifier.js.map +1 -1
  44. package/dist/device/iosensor.d.ts +12 -64
  45. package/dist/device/iosensor.d.ts.map +1 -1
  46. package/dist/device/iosensor.js +215 -615
  47. package/dist/device/iosensor.js.map +1 -1
  48. package/dist/device/lightstrip.d.ts +12 -70
  49. package/dist/device/lightstrip.d.ts.map +1 -1
  50. package/dist/device/lightstrip.js +336 -645
  51. package/dist/device/lightstrip.js.map +1 -1
  52. package/dist/device/lock.d.ts +17 -63
  53. package/dist/device/lock.d.ts.map +1 -1
  54. package/dist/device/lock.js +290 -595
  55. package/dist/device/lock.js.map +1 -1
  56. package/dist/device/meter.d.ts +15 -64
  57. package/dist/device/meter.d.ts.map +1 -1
  58. package/dist/device/meter.js +211 -608
  59. package/dist/device/meter.js.map +1 -1
  60. package/dist/device/meterplus.d.ts +15 -65
  61. package/dist/device/meterplus.d.ts.map +1 -1
  62. package/dist/device/meterplus.js +205 -615
  63. package/dist/device/meterplus.js.map +1 -1
  64. package/dist/device/motion.d.ts +12 -69
  65. package/dist/device/motion.d.ts.map +1 -1
  66. package/dist/device/motion.js +202 -563
  67. package/dist/device/motion.js.map +1 -1
  68. package/dist/device/plug.d.ts +10 -57
  69. package/dist/device/plug.d.ts.map +1 -1
  70. package/dist/device/plug.js +125 -484
  71. package/dist/device/plug.js.map +1 -1
  72. package/dist/device/robotvacuumcleaner.d.ts +13 -63
  73. package/dist/device/robotvacuumcleaner.d.ts.map +1 -1
  74. package/dist/device/robotvacuumcleaner.js +233 -549
  75. package/dist/device/robotvacuumcleaner.js.map +1 -1
  76. package/dist/device/waterdetector.d.ts +11 -63
  77. package/dist/device/waterdetector.d.ts.map +1 -1
  78. package/dist/device/waterdetector.js +170 -493
  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 +10 -50
  88. package/dist/irdevice/airconditioner.d.ts.map +1 -1
  89. package/dist/irdevice/airconditioner.js +340 -468
  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 +105 -319
  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 +44 -285
  98. package/dist/irdevice/camera.js.map +1 -1
  99. package/dist/irdevice/fan.d.ts +7 -43
  100. package/dist/irdevice/fan.d.ts.map +1 -1
  101. package/dist/irdevice/fan.js +92 -350
  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 +369 -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 +118 -362
  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 +438 -570
  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 +91 -339
  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 +45 -285
  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 +47 -291
  126. package/dist/irdevice/waterheater.js.map +1 -1
  127. package/dist/platform.d.ts +22 -8
  128. package/dist/platform.d.ts.map +1 -1
  129. package/dist/platform.js +342 -191
  130. package/dist/platform.js.map +1 -1
  131. package/dist/settings.d.ts +64 -17
  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 +20 -16
  141. package/src/custom.d.ts +2 -1
  142. package/src/device/blindtilt.ts +472 -888
  143. package/src/device/bot.ts +893 -968
  144. package/src/device/ceilinglight.ts +304 -709
  145. package/src/device/colorbulb.ts +370 -803
  146. package/src/device/contact.ts +301 -611
  147. package/src/device/curtain.ts +460 -908
  148. package/src/device/device.ts +755 -0
  149. package/src/device/fan.ts +749 -0
  150. package/src/device/hub.ts +294 -664
  151. package/src/device/humidifier.ts +299 -696
  152. package/src/device/iosensor.ts +251 -644
  153. package/src/device/lightstrip.ts +362 -712
  154. package/src/device/lock.ts +328 -653
  155. package/src/device/meter.ts +247 -637
  156. package/src/device/meterplus.ts +240 -644
  157. package/src/device/motion.ts +230 -598
  158. package/src/device/plug.ts +139 -525
  159. package/src/device/robotvacuumcleaner.ts +258 -593
  160. package/src/device/waterdetector.ts +191 -522
  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 +370 -527
  165. package/src/irdevice/airpurifier.ts +132 -356
  166. package/src/irdevice/camera.ts +58 -311
  167. package/src/irdevice/fan.ts +109 -379
  168. package/src/irdevice/irdevice.ts +382 -0
  169. package/src/irdevice/light.ts +157 -412
  170. package/src/irdevice/other.ts +507 -648
  171. package/src/irdevice/tv.ts +121 -375
  172. package/src/irdevice/vacuumcleaner.ts +59 -311
  173. package/src/irdevice/waterheater.ts +61 -320
  174. package/src/platform.ts +395 -259
  175. package/src/settings.ts +118 -609
  176. package/src/utils.ts +642 -1
  177. package/.github/npm-version-script.cjs +0 -81
  178. package/src/device/waterdetector.json +0 -11
@@ -1,125 +1,127 @@
1
- import { CharacteristicValue, PlatformAccessory, Service, API, Logging, HAP } from 'homebridge';
1
+ /* Copyright(C) 2021-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
2
+ *
3
+ * light.ts: @switchbot/homebridge-switchbot.
4
+ */
2
5
  import { request } from 'undici';
3
- import { SwitchBotPlatform } from '../platform.js';
4
- import { Devices, irDevicesConfig, irdevice, SwitchBotPlatformConfig } from '../settings.js';
6
+ import { Devices } from '../settings.js';
7
+ import { irdeviceBase } from './irdevice.js';
8
+
9
+ import type { SwitchBotPlatform } from '../platform.js';
10
+ import type { irDevicesConfig, irdevice } from '../settings.js';
11
+ import type { CharacteristicValue, PlatformAccessory, Service } from 'homebridge';
5
12
 
6
13
  /**
7
14
  * Platform Accessory
8
15
  * An instance of this class is created for each accessory your platform registers
9
16
  * Each accessory may expose multiple services of different service types.
10
17
  */
11
- export class Light {
12
- public readonly api: API;
13
- public readonly log: Logging;
14
- public readonly config!: SwitchBotPlatformConfig;
15
- protected readonly hap: HAP;
18
+ export class Light extends irdeviceBase {
16
19
  // Services
17
- lightBulbService?: Service;
18
- ProgrammableSwitchServiceOn?: Service;
19
- ProgrammableSwitchServiceOff?: Service;
20
-
21
- // Characteristic Values
22
- On!: CharacteristicValue;
23
- ProgrammableSwitchEventOn?: CharacteristicValue;
24
- ProgrammableSwitchOutputStateOn?: CharacteristicValue;
25
- ProgrammableSwitchEventOff?: CharacteristicValue;
26
- ProgrammableSwitchOutputStateOff?: CharacteristicValue;
27
- FirmwareRevision!: CharacteristicValue;
28
-
29
- // Config
30
- deviceLogging!: string;
31
- disablePushOn?: boolean;
32
- disablePushOff?: boolean;
20
+ private LightBulb?: {
21
+ Name: CharacteristicValue;
22
+ Service: Service;
23
+ On: CharacteristicValue;
24
+ };
25
+
26
+ private ProgrammableSwitchOn?: {
27
+ Name: CharacteristicValue;
28
+ Service: Service;
29
+ ProgrammableSwitchEvent: CharacteristicValue;
30
+ ProgrammableSwitchOutputState: CharacteristicValue;
31
+ };
32
+
33
+ private ProgrammableSwitchOff?: {
34
+ Name: CharacteristicValue;
35
+ Service: Service;
36
+ ProgrammableSwitchEvent: CharacteristicValue;
37
+ ProgrammableSwitchOutputState: CharacteristicValue;
38
+ };
33
39
 
34
40
  constructor(
35
- private readonly platform: SwitchBotPlatform,
36
- private accessory: PlatformAccessory,
37
- public device: irdevice & irDevicesConfig,
41
+ readonly platform: SwitchBotPlatform,
42
+ accessory: PlatformAccessory,
43
+ device: irdevice & irDevicesConfig,
38
44
  ) {
39
- this.api = this.platform.api;
40
- this.log = this.platform.log;
41
- this.config = this.platform.config;
42
- this.hap = this.api.hap;
43
- // default placeholders
44
- this.deviceLogs(device);
45
- this.deviceContext();
46
- this.disablePushOnChanges(device);
47
- this.disablePushOffChanges(device);
48
- this.deviceConfig(device);
49
-
50
- // set accessory information
51
- accessory
52
- .getService(this.hap.Service.AccessoryInformation)!
53
- .setCharacteristic(this.hap.Characteristic.Manufacturer, 'SwitchBot')
54
- .setCharacteristic(this.hap.Characteristic.Model, device.remoteType)
55
- .setCharacteristic(this.hap.Characteristic.SerialNumber, device.deviceId)
56
- .setCharacteristic(this.hap.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision);
45
+ super(platform, accessory, device);
57
46
 
58
47
  if (!device.irlight?.stateless) {
59
- // get the Light service if it exists, otherwise create a new Light service
60
- // you can create multiple services for each accessory
61
- const lightBulbService = `${accessory.displayName} ${device.remoteType}`;
62
- (this.lightBulbService = accessory.getService(this.hap.Service.Lightbulb)
63
- || accessory.addService(this.hap.Service.Lightbulb)), lightBulbService;
64
-
65
-
66
- this.lightBulbService.setCharacteristic(this.hap.Characteristic.Name, accessory.displayName);
67
- if (!this.lightBulbService.testCharacteristic(this.hap.Characteristic.ConfiguredName)) {
68
- this.lightBulbService.addCharacteristic(this.hap.Characteristic.ConfiguredName, accessory.displayName);
69
- }
70
-
71
- // handle on / off events using the On characteristic
72
- this.lightBulbService.getCharacteristic(this.hap.Characteristic.On).onSet(this.OnSet.bind(this));
48
+ // Initialize LightBulb Service
49
+ accessory.context.LightBulb = accessory.context.LightBulb ?? {};
50
+ this.LightBulb = {
51
+ Name: accessory.context.LightBulb.Name ?? `${accessory.displayName} ${device.remoteType}`,
52
+ Service: accessory.getService(this.hap.Service.Lightbulb) ?? accessory.addService(this.hap.Service.Lightbulb) as Service,
53
+ On: accessory.context.On || false,
54
+ };
55
+ accessory.context.LightBulb = this.LightBulb as object;
56
+
57
+ this.LightBulb.Service
58
+ .setCharacteristic(this.hap.Characteristic.Name, this.LightBulb.Name)
59
+ .getCharacteristic(this.hap.Characteristic.On)
60
+ .onGet(() => {
61
+ return this.LightBulb!.On;
62
+ })
63
+ .onSet(this.OnSet.bind(this));
73
64
  } else {
74
-
75
- // create a new Stateful Programmable Switch On service
76
- const ProgrammableSwitchServiceOn = `${accessory.displayName} ${device.remoteType} On`;
77
- (this.ProgrammableSwitchServiceOn = accessory.getService(this.hap.Service.StatefulProgrammableSwitch)
78
- || accessory.addService(this.hap.Service.StatefulProgrammableSwitch)), ProgrammableSwitchServiceOn;
79
-
80
-
81
- this.ProgrammableSwitchServiceOn.setCharacteristic(this.hap.Characteristic.Name, `${accessory.displayName} On`);
82
- if (!this.ProgrammableSwitchServiceOn.testCharacteristic(this.hap.Characteristic.ConfiguredName)) {
83
- this.ProgrammableSwitchServiceOn.addCharacteristic(this.hap.Characteristic.ConfiguredName, `${accessory.displayName} On`);
84
- }
85
-
86
- this.ProgrammableSwitchServiceOn.getCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent).setProps({
87
- validValueRanges: [0, 0],
88
- minValue: 0,
89
- maxValue: 0,
90
- validValues: [0],
91
- })
65
+ // Initialize ProgrammableSwitchOn Service
66
+ accessory.context.ProgrammableSwitchOn = accessory.context.ProgrammableSwitchOn ?? {};
67
+ this.ProgrammableSwitchOn = {
68
+ Name: accessory.context.ProgrammableSwitchOn.Name ?? `${accessory.displayName} ${device.remoteType} On`,
69
+ Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch)
70
+ ?? accessory.addService(this.hap.Service.StatefulProgrammableSwitch) as Service,
71
+ ProgrammableSwitchEvent: accessory.context.ProgrammableSwitchEvent ?? this.hap.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS,
72
+ ProgrammableSwitchOutputState: accessory.context.ProgrammableSwitchOutputState ?? 0,
73
+ };
74
+ accessory.context.ProgrammableSwitchOn = this.ProgrammableSwitchOn as object;
75
+
76
+ // Initialize ProgrammableSwitchOn Characteristics
77
+ this.ProgrammableSwitchOn?.Service
78
+ .setCharacteristic(this.hap.Characteristic.Name, this.ProgrammableSwitchOn.Name)
79
+ .getCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent).setProps({
80
+ validValueRanges: [0, 0],
81
+ minValue: 0,
82
+ maxValue: 0,
83
+ validValues: [0],
84
+ })
92
85
  .onGet(() => {
93
- return this.ProgrammableSwitchEventOn!;
86
+ return this.ProgrammableSwitchOn!.ProgrammableSwitchEvent;
94
87
  });
95
88
 
96
- this.ProgrammableSwitchServiceOn.getCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState)
89
+ this.ProgrammableSwitchOn?.Service
90
+ .getCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState)
91
+ .onGet(() => {
92
+ return this.ProgrammableSwitchOn!.ProgrammableSwitchOutputState;
93
+ })
97
94
  .onSet(this.ProgrammableSwitchOutputStateSetOn.bind(this));
98
95
 
99
-
100
-
101
- // create a new Stateful Programmable Switch Off service
102
- const ProgrammableSwitchServiceOff = `${accessory.displayName} ${device.remoteType} Off`;
103
- (this.ProgrammableSwitchServiceOff = accessory.getService(this.hap.Service.StatefulProgrammableSwitch)
104
- || accessory.addService(this.hap.Service.StatefulProgrammableSwitch)), ProgrammableSwitchServiceOff;
105
-
106
-
107
- this.ProgrammableSwitchServiceOff.setCharacteristic(this.hap.Characteristic.Name, `${accessory.displayName} Off`);
108
- if (!this.ProgrammableSwitchServiceOff.testCharacteristic(this.hap.Characteristic.ConfiguredName)) {
109
- this.ProgrammableSwitchServiceOff.addCharacteristic(this.hap.Characteristic.ConfiguredName, `${accessory.displayName} Off`);
110
- }
111
-
112
- this.ProgrammableSwitchServiceOff.getCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent).setProps({
113
- validValueRanges: [0, 0],
114
- minValue: 0,
115
- maxValue: 0,
116
- validValues: [0],
117
- })
96
+ // Initialize ProgrammableSwitchOff Service
97
+ accessory.context.ProgrammableSwitchOff = accessory.context.ProgrammableSwitchOff ?? {};
98
+ this.ProgrammableSwitchOff = {
99
+ Name: accessory.context.ProgrammableSwitchOff.Name ?? `${accessory.displayName} ${device.remoteType} Off`,
100
+ Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch)
101
+ ?? accessory.addService(this.hap.Service.StatefulProgrammableSwitch) as Service,
102
+ ProgrammableSwitchEvent: accessory.context.ProgrammableSwitchEvent ?? this.hap.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS,
103
+ ProgrammableSwitchOutputState: accessory.context.ProgrammableSwitchOutputState ?? 0,
104
+ };
105
+ accessory.context.ProgrammableSwitchOff = this.ProgrammableSwitchOff as object;
106
+
107
+ // Initialize ProgrammableSwitchOff Characteristics
108
+ this.ProgrammableSwitchOff?.Service
109
+ .setCharacteristic(this.hap.Characteristic.Name, this.ProgrammableSwitchOff.Name)
110
+ .getCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent).setProps({
111
+ validValueRanges: [0, 0],
112
+ minValue: 0,
113
+ maxValue: 0,
114
+ validValues: [0],
115
+ })
118
116
  .onGet(() => {
119
- return this.ProgrammableSwitchEventOff!;
117
+ return this.ProgrammableSwitchOff!.ProgrammableSwitchEvent;
120
118
  });
121
119
 
122
- this.ProgrammableSwitchServiceOff.getCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState)
120
+ this.ProgrammableSwitchOff?.Service
121
+ .getCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState)
122
+ .onGet(() => {
123
+ return this.ProgrammableSwitchOff!.ProgrammableSwitchOutputState;
124
+ })
123
125
  .onSet(this.ProgrammableSwitchOutputStateSetOff.bind(this));
124
126
  }
125
127
 
@@ -128,11 +130,13 @@ export class Light {
128
130
  async OnSet(value: CharacteristicValue): Promise<void> {
129
131
  this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} On: ${value}`);
130
132
 
131
- this.On = value;
132
- if (this.On) {
133
- await this.pushLightOnChanges();
133
+ this.LightBulb!.On = value;
134
+ if (this.LightBulb?.On) {
135
+ const On = true;
136
+ await this.pushLightOnChanges(On);
134
137
  } else {
135
- await this.pushLightOffChanges();
138
+ const On = false;
139
+ await this.pushLightOffChanges(On);
136
140
  }
137
141
  /**
138
142
  * pushLightOnChanges and pushLightOffChanges above assume they are measuring the state of the accessory BEFORE
@@ -143,10 +147,10 @@ export class Light {
143
147
  async ProgrammableSwitchOutputStateSetOn(value: CharacteristicValue): Promise<void> {
144
148
  this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} On: ${value}`);
145
149
 
146
- this.ProgrammableSwitchOutputStateOn = value;
147
- if (this.ProgrammableSwitchOutputStateOn === 1) {
148
- this.On = true;
149
- await this.pushLightOnChanges();
150
+ this.ProgrammableSwitchOn!.ProgrammableSwitchOutputState = value;
151
+ if (this.ProgrammableSwitchOn?.ProgrammableSwitchOutputState === 1) {
152
+ const On = true;
153
+ await this.pushLightOnChanges(On);
150
154
  }
151
155
  /**
152
156
  * pushLightOnChanges and pushLightOffChanges above assume they are measuring the state of the accessory BEFORE
@@ -157,10 +161,10 @@ export class Light {
157
161
  async ProgrammableSwitchOutputStateSetOff(value: CharacteristicValue): Promise<void> {
158
162
  this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} On: ${value}`);
159
163
 
160
- this.ProgrammableSwitchOutputStateOff = value;
161
- if (this.ProgrammableSwitchOutputStateOff === 1) {
162
- this.On = false;
163
- await this.pushLightOffChanges();
164
+ this.ProgrammableSwitchOff!.ProgrammableSwitchOutputState = value;
165
+ if (this.ProgrammableSwitchOff?.ProgrammableSwitchOutputState === 1) {
166
+ const On = false;
167
+ await this.pushLightOffChanges(On);
164
168
  }
165
169
  /**
166
170
  * pushLightOnChanges and pushLightOffChanges above assume they are measuring the state of the accessory BEFORE
@@ -180,11 +184,9 @@ export class Light {
180
184
  * Light - "command" "channelAdd" "default" = next channel
181
185
  * Light - "command" "channelSub" "default" = previous channel
182
186
  */
183
- async pushLightOnChanges(): Promise<void> {
184
- this.debugLog(
185
- `${this.device.remoteType}: ${this.accessory.displayName} pushLightOnChanges On: ${this.On},` + ` disablePushOn: ${this.disablePushOn}`,
186
- );
187
- if (this.On && !this.disablePushOn) {
187
+ async pushLightOnChanges(On: boolean): Promise<void> {
188
+ this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushLightOnChanges On: ${On}, disablePushOn: ${this.disablePushOn}`);
189
+ if (On === true && this.disablePushOn === false) {
188
190
  const commandType: string = await this.commandType();
189
191
  const command: string = await this.commandOn();
190
192
  const bodyChange = JSON.stringify({
@@ -192,15 +194,13 @@ export class Light {
192
194
  parameter: 'default',
193
195
  commandType: commandType,
194
196
  });
195
- await this.pushChanges(bodyChange);
197
+ await this.pushChanges(bodyChange, On);
196
198
  }
197
199
  }
198
200
 
199
- async pushLightOffChanges(): Promise<void> {
200
- this.debugLog(
201
- `${this.device.remoteType}: ${this.accessory.displayName} pushLightOffChanges On: ${this.On},` + ` disablePushOff: ${this.disablePushOff}`,
202
- );
203
- if (!this.On && !this.disablePushOff) {
201
+ async pushLightOffChanges(On: boolean): Promise<void> {
202
+ this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushLightOffChanges On: ${On}, disablePushOff: ${this.disablePushOff}`);
203
+ if (On === false && this.disablePushOff === false) {
204
204
  const commandType: string = await this.commandType();
205
205
  const command: string = await this.commandOff();
206
206
  const bodyChange = JSON.stringify({
@@ -208,29 +208,11 @@ export class Light {
208
208
  parameter: 'default',
209
209
  commandType: commandType,
210
210
  });
211
- await this.pushChanges(bodyChange);
211
+ await this.pushChanges(bodyChange, On);
212
212
  }
213
213
  }
214
214
 
215
- /*async pushLightBrightnessUpChanges(): Promise<void> {
216
- const bodyChange = JSON.stringify({
217
- command: 'brightnessUp',
218
- parameter: 'default',
219
- commandType: 'command',
220
- });
221
- await this.pushChanges(bodyChange);
222
- }
223
-
224
- async pushLightBrightnessDownChanges(): Promise<void> {
225
- const bodyChange = JSON.stringify({
226
- command: 'brightnessDown',
227
- parameter: 'default',
228
- commandType: 'command',
229
- });
230
- await this.pushChanges(bodyChange);
231
- }*/
232
-
233
- async pushChanges(bodyChange: any): Promise<void> {
215
+ async pushChanges(bodyChange: any, On: boolean): Promise<void> {
234
216
  this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} pushChanges`);
235
217
  if (this.device.connectionType === 'OpenAPI') {
236
218
  this.infoLog(`${this.device.remoteType}: ${this.accessory.displayName} Sending request to SwitchBot API, body: ${bodyChange},`);
@@ -245,9 +227,11 @@ export class Light {
245
227
  this.debugWarnLog(`${this.device.remoteType}: ${this.accessory.displayName} deviceStatus: ${JSON.stringify(deviceStatus)}`);
246
228
  this.debugWarnLog(`${this.device.remoteType}: ${this.accessory.displayName} deviceStatus statusCode: ${deviceStatus.statusCode}`);
247
229
  if ((statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)) {
248
- this.debugErrorLog(`${this.device.remoteType}: ${this.accessory.displayName} `
230
+ this.debugSuccessLog(`${this.device.remoteType}: ${this.accessory.displayName} `
249
231
  + `statusCode: ${statusCode} & deviceStatus StatusCode: ${deviceStatus.statusCode}`);
250
- this.accessory.context.On = this.On;
232
+ this.successLog(`${this.device.remoteType}: ${this.accessory.displayName}`
233
+ + ` request to SwitchBot API, body: ${JSON.stringify(JSON.parse(bodyChange))} sent successfully`);
234
+ this.accessory.context.On = On;
251
235
  this.updateHomeKitCharacteristics();
252
236
  } else {
253
237
  this.statusCode(statusCode);
@@ -255,298 +239,59 @@ export class Light {
255
239
  }
256
240
  } catch (e: any) {
257
241
  this.apiError(e);
258
- this.errorLog(
259
- `${this.device.remoteType}: ${this.accessory.displayName} failed pushChanges with ${this.device.connectionType}` +
260
- ` Connection, Error Message: ${JSON.stringify(e.message)}`,
261
- );
242
+ this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} failed pushChanges with ${this.device.connectionType}`
243
+ + ` Connection, Error Message: ${JSON.stringify(e.message)}`);
262
244
  }
263
245
  } else {
264
- this.warnLog(
265
- `${this.device.remoteType}: ${this.accessory.displayName}` +
266
- ` Connection Type: ${this.device.connectionType}, commands will not be sent to OpenAPI`,
267
- );
246
+ this.warnLog(`${this.device.remoteType}: ${this.accessory.displayName} Connection Type: `
247
+ + `${this.device.connectionType}, commands will not be sent to OpenAPI`);
268
248
  }
269
249
  }
270
250
 
271
251
  async updateHomeKitCharacteristics(): Promise<void> {
272
- if (this.device.irlight?.stateless) {
252
+ if (!this.device.irlight?.stateless) {
273
253
  // On
274
- if (this.On === undefined) {
275
- this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} On: ${this.On}`);
254
+ if (this.LightBulb?.On === undefined) {
255
+ this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} On: ${this.LightBulb?.On}`);
276
256
  } else {
277
- this.accessory.context.On = this.On;
278
- this.lightBulbService?.updateCharacteristic(this.hap.Characteristic.On, this.On);
279
- this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
257
+ this.accessory.context.On = this.LightBulb.On;
258
+ this.LightBulb?.Service.updateCharacteristic(this.hap.Characteristic.On, this.LightBulb.On);
259
+ this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} updateCharacteristic On: ${this.LightBulb.On}`);
280
260
  }
281
261
  } else {
282
262
  // On Stateful Programmable Switch
283
- if (this.ProgrammableSwitchOutputStateOn === undefined) {
263
+ if (this.ProgrammableSwitchOn?.ProgrammableSwitchOutputState === undefined) {
284
264
  this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName}`
285
- + ` ProgrammableSwitchOutputStateOn: ${this.ProgrammableSwitchOutputStateOn}`);
265
+ + ` ProgrammableSwitchOutputStateOn: ${this.ProgrammableSwitchOn?.ProgrammableSwitchOutputState}`);
286
266
  } else {
287
- this.accessory.context.ProgrammableSwitchOutputStateOn = this.ProgrammableSwitchOutputStateOn;
288
- this.ProgrammableSwitchServiceOn?.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState,
289
- this.ProgrammableSwitchOutputStateOn);
267
+ this.accessory.context.ProgrammableSwitchOutputStateOn = this.ProgrammableSwitchOn.ProgrammableSwitchOutputState;
268
+ this.ProgrammableSwitchOn?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState,
269
+ this.ProgrammableSwitchOn.ProgrammableSwitchOutputState);
290
270
  this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} updateCharacteristic`
291
- + ` ProgrammableSwitchOutputStateOn: ${this.ProgrammableSwitchOutputStateOn}`);
271
+ + ` ProgrammableSwitchOutputStateOn: ${this.ProgrammableSwitchOn.ProgrammableSwitchOutputState}`);
292
272
  }
293
273
  // Off Stateful Programmable Switch
294
- if (this.ProgrammableSwitchOutputStateOff === undefined) {
274
+ if (this.ProgrammableSwitchOff?.ProgrammableSwitchOutputState === undefined) {
295
275
  this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName}`
296
- + ` ProgrammableSwitchOutputStateOff: ${this.ProgrammableSwitchOutputStateOff}`);
276
+ + ` ProgrammableSwitchOutputStateOff: ${this.ProgrammableSwitchOff?.ProgrammableSwitchOutputState}`);
297
277
  } else {
298
- this.accessory.context.ProgrammableSwitchOutputStateOff = this.ProgrammableSwitchOutputStateOff;
299
- this.ProgrammableSwitchServiceOff?.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState,
300
- this.ProgrammableSwitchOutputStateOff);
278
+ this.accessory.context.ProgrammableSwitchOutputStateOff = this.ProgrammableSwitchOff.ProgrammableSwitchOutputState;
279
+ this.ProgrammableSwitchOff.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState,
280
+ this.ProgrammableSwitchOff.ProgrammableSwitchOutputState);
301
281
  this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} updateCharacteristic`
302
- + ` ProgrammableSwitchOutputStateOff: ${this.ProgrammableSwitchOutputStateOff}`);
282
+ + ` ProgrammableSwitchOutputStateOff: ${this.ProgrammableSwitchOff?.ProgrammableSwitchOutputState}`);
303
283
  }
304
284
  }
305
285
  }
306
286
 
307
- async disablePushOnChanges(device: irdevice & irDevicesConfig): Promise<void> {
308
- if (device.disablePushOn === undefined) {
309
- this.disablePushOn = false;
310
- } else {
311
- this.disablePushOn = device.disablePushOn;
312
- }
313
- }
314
-
315
- async disablePushOffChanges(device: irdevice & irDevicesConfig): Promise<void> {
316
- if (device.disablePushOff === undefined) {
317
- this.disablePushOff = false;
318
- } else {
319
- this.disablePushOff = device.disablePushOff;
320
- }
321
- }
322
-
323
- async commandType(): Promise<string> {
324
- let commandType: string;
325
- if (this.device.customize) {
326
- commandType = 'customize';
327
- } else {
328
- commandType = 'command';
329
- }
330
- return commandType;
331
- }
332
-
333
- async commandOn(): Promise<string> {
334
- let command: string;
335
- if (this.device.customize && this.device.customOn) {
336
- command = this.device.customOn;
337
- } else {
338
- command = 'turnOn';
339
- }
340
- return command;
341
- }
342
-
343
- async commandOff(): Promise<string> {
344
- let command: string;
345
- if (this.device.customize && this.device.customOff) {
346
- command = this.device.customOff;
347
- } else {
348
- command = 'turnOff';
349
- }
350
- return command;
351
- }
352
-
353
- async statusCode(statusCode: number): Promise<void> {
354
- switch (statusCode) {
355
- case 151:
356
- this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Command not supported by this deviceType, statusCode: ${statusCode}`);
357
- break;
358
- case 152:
359
- this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Device not found, statusCode: ${statusCode}`);
360
- break;
361
- case 160:
362
- this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Command is not supported, statusCode: ${statusCode}`);
363
- break;
364
- case 161:
365
- this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Device is offline, statusCode: ${statusCode}`);
366
- break;
367
- case 171:
368
- this.errorLog(
369
- `${this.device.remoteType}: ${this.accessory.displayName} Hub Device is offline, statusCode: ${statusCode}. ` +
370
- `Hub: ${this.device.hubDeviceId}`,
371
- );
372
- break;
373
- case 190:
374
- this.errorLog(
375
- `${this.device.remoteType}: ${this.accessory.displayName} Device internal error due to device states not synchronized with server,` +
376
- ` Or command format is invalid, statusCode: ${statusCode}`,
377
- );
378
- break;
379
- case 100:
380
- this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Command successfully sent, statusCode: ${statusCode}`);
381
- break;
382
- case 200:
383
- this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Request successful, statusCode: ${statusCode}`);
384
- break;
385
- case 400:
386
- this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Bad Request, The client has issued an invalid request. `
387
- + `This is commonly used to specify validation errors in a request payload, statusCode: ${statusCode}`);
388
- break;
389
- case 401:
390
- this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Unauthorized, Authorization for the API is required, `
391
- + `but the request has not been authenticated, statusCode: ${statusCode}`);
392
- break;
393
- case 403:
394
- this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Forbidden, The request has been authenticated but does not `
395
- + `have appropriate permissions, or a requested resource is not found, statusCode: ${statusCode}`);
396
- break;
397
- case 404:
398
- this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Not Found, Specifies the requested path does not exist, `
399
- + `statusCode: ${statusCode}`);
400
- break;
401
- case 406:
402
- this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Not Acceptable, The client has requested a MIME type via `
403
- + `the Accept header for a value not supported by the server, statusCode: ${statusCode}`);
404
- break;
405
- case 415:
406
- this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Unsupported Media Type, The client has defined a contentType `
407
- + `header that is not supported by the server, statusCode: ${statusCode}`);
408
- break;
409
- case 422:
410
- this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Unprocessable Entity, The client has made a valid request, but `
411
- + `the server cannot process it. This is often used for APIs for which certain limits have been exceeded, statusCode: ${statusCode}`);
412
- break;
413
- case 429:
414
- this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Too Many Requests, The client has exceeded the number of `
415
- + `requests allowed for a given time window, statusCode: ${statusCode}`);
416
- break;
417
- case 500:
418
- this.errorLog(`${this.device.remoteType}: ${this.accessory.displayName} Internal Server Error, An unexpected error on the SmartThings `
419
- + `servers has occurred. These errors should be rare, statusCode: ${statusCode}`);
420
- break;
421
- default:
422
- this.infoLog(
423
- `${this.device.remoteType}: ${this.accessory.displayName} Unknown statusCode: ` +
424
- `${statusCode}, Submit Bugs Here: ' + 'https://tinyurl.com/SwitchBotBug`,
425
- );
426
- }
427
- }
428
-
429
287
  async apiError(e: any): Promise<void> {
430
- if (this.device.irlight?.stateless) {
431
- this.lightBulbService?.updateCharacteristic(this.hap.Characteristic.On, e);
432
- } else {
433
- this.ProgrammableSwitchServiceOn?.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent, e);
434
- this.ProgrammableSwitchServiceOn?.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState, e);
435
- this.ProgrammableSwitchServiceOff?.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent, e);
436
- this.ProgrammableSwitchServiceOff?.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState, e);
437
- }
438
- }
439
-
440
- async deviceContext() {
441
- if (this.On === undefined) {
442
- this.On = false;
443
- } else {
444
- this.On = this.accessory.context.On;
445
- }
446
- if (this.FirmwareRevision === undefined) {
447
- this.FirmwareRevision = this.platform.version;
448
- this.accessory.context.FirmwareRevision = this.FirmwareRevision;
449
- }
450
- }
451
-
452
- async deviceConfig(device: irdevice & irDevicesConfig): Promise<void> {
453
- let config = {};
454
- if (device.irlight) {
455
- config = device.irlight;
456
- }
457
- if (device.logging !== undefined) {
458
- config['logging'] = device.logging;
459
- }
460
- if (device.connectionType !== undefined) {
461
- config['connectionType'] = device.connectionType;
462
- }
463
- if (device.external !== undefined) {
464
- config['external'] = device.external;
465
- }
466
- if (device.customOn !== undefined) {
467
- config['customOn'] = device.customOn;
468
- }
469
- if (device.customOff !== undefined) {
470
- config['customOff'] = device.customOff;
471
- }
472
- if (device.customize !== undefined) {
473
- config['customize'] = device.customize;
474
- }
475
- if (device.disablePushOn !== undefined) {
476
- config['disablePushOn'] = device.disablePushOn;
477
- }
478
- if (device.disablePushOff !== undefined) {
479
- config['disablePushOff'] = device.disablePushOff;
480
- }
481
- if (Object.entries(config).length !== 0) {
482
- this.debugWarnLog(`${this.device.remoteType}: ${this.accessory.displayName} Config: ${JSON.stringify(config)}`);
483
- }
484
- }
485
-
486
- async deviceLogs(device: irdevice & irDevicesConfig): Promise<void> {
487
- if (this.platform.debugMode) {
488
- this.deviceLogging = this.accessory.context.logging = 'debugMode';
489
- this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Using Debug Mode Logging: ${this.deviceLogging}`);
490
- } else if (device.logging) {
491
- this.deviceLogging = this.accessory.context.logging = device.logging;
492
- this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Using Device Config Logging: ${this.deviceLogging}`);
493
- } else if (this.platform.config.options?.logging) {
494
- this.deviceLogging = this.accessory.context.logging = this.platform.config.options?.logging;
495
- this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Using Platform Config Logging: ${this.deviceLogging}`);
288
+ if (!this.device.irlight?.stateless) {
289
+ this.LightBulb?.Service.updateCharacteristic(this.hap.Characteristic.On, e);
496
290
  } else {
497
- this.deviceLogging = this.accessory.context.logging = 'standard';
498
- this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} Logging Not Set, Using: ${this.deviceLogging}`);
499
- }
500
- }
501
-
502
- /**
503
- * Logging for Device
504
- */
505
- infoLog(...log: any[]): void {
506
- if (this.enablingDeviceLogging()) {
507
- this.platform.log.info(String(...log));
508
- }
509
- }
510
-
511
- warnLog(...log: any[]): void {
512
- if (this.enablingDeviceLogging()) {
513
- this.platform.log.warn(String(...log));
514
- }
515
- }
516
-
517
- debugWarnLog(...log: any[]): void {
518
- if (this.enablingDeviceLogging()) {
519
- if (this.deviceLogging?.includes('debug')) {
520
- this.platform.log.warn('[DEBUG]', String(...log));
521
- }
522
- }
523
- }
524
-
525
- errorLog(...log: any[]): void {
526
- if (this.enablingDeviceLogging()) {
527
- this.platform.log.error(String(...log));
528
- }
529
- }
530
-
531
- debugErrorLog(...log: any[]): void {
532
- if (this.enablingDeviceLogging()) {
533
- if (this.deviceLogging?.includes('debug')) {
534
- this.platform.log.error('[DEBUG]', String(...log));
535
- }
536
- }
537
- }
538
-
539
- debugLog(...log: any[]): void {
540
- if (this.enablingDeviceLogging()) {
541
- if (this.deviceLogging === 'debug') {
542
- this.platform.log.info('[DEBUG]', String(...log));
543
- } else {
544
- this.platform.log.debug(String(...log));
545
- }
291
+ this.ProgrammableSwitchOn?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent, e);
292
+ this.ProgrammableSwitchOn?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState, e);
293
+ this.ProgrammableSwitchOff?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent, e);
294
+ this.ProgrammableSwitchOff?.Service.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState, e);
546
295
  }
547
296
  }
548
-
549
- enablingDeviceLogging(): boolean {
550
- return this.deviceLogging.includes('debug') || this.deviceLogging === 'standard';
551
- }
552
297
  }