@switchbot/homebridge-switchbot 3.5.0-beta.26 → 3.5.0-beta.28

package/src/irdevice/light.ts

@@ -15,7 +15,11 @@ import { CharacteristicValue, PlatformAccessory, Service } from 'homebridge';
  */
 export class Light extends irdeviceBase {
   // Services
-  lightBulbService?: Service;
+  private LightBulb!: {
+    Service: Service;
+    On: CharacteristicValue;
+  };
+
   ProgrammableSwitchServiceOn?: Service;
   ProgrammableSwitchServiceOff?: Service;
 
@@ -33,25 +37,23 @@ export class Light extends irdeviceBase {
   ) {
     super(platform, accessory, device);
 
-    // default placeholders
-    if (this.On === undefined) {
-      this.On = false;
-    } else {
-      this.On = accessory.context.On;
-    }
-
     if (!device.irlight?.stateless) {
+      // Initialize LightBulb property
+      this.LightBulb = {
+        Service: accessory.getService(this.hap.Service.Lightbulb)!,
+        On: accessory.context.On || false,
+      };
       // get the Light service if it exists, otherwise create a new Light service
       // you can create multiple services for each accessory
-      const lightBulbService = `${accessory.displayName} ${device.remoteType}`;
-      (this.lightBulbService = accessory.getService(this.hap.Service.Lightbulb)
-        || accessory.addService(this.hap.Service.Lightbulb)), lightBulbService;
+      const LightBulbService = `${accessory.displayName} ${device.remoteType}`;
+      (this.LightBulb.Service = accessory.getService(this.hap.Service.Lightbulb)
+        || accessory.addService(this.hap.Service.Lightbulb)), LightBulbService;
 
 
-      this.lightBulbService.setCharacteristic(this.hap.Characteristic.Name, accessory.displayName);
+      this.LightBulb.Service.setCharacteristic(this.hap.Characteristic.Name, accessory.displayName);
 
       // handle on / off events using the On characteristic
-      this.lightBulbService.getCharacteristic(this.hap.Characteristic.On).onSet(this.OnSet.bind(this));
+      this.LightBulb.Service.getCharacteristic(this.hap.Characteristic.On).onSet(this.OnSet.bind(this));
     } else {
 
       // create a new Stateful Programmable Switch On service
@@ -221,7 +223,7 @@ export class Light extends irdeviceBase {
         this.debugWarnLog(`${this.device.remoteType}: ${this.accessory.displayName} deviceStatus: ${JSON.stringify(deviceStatus)}`);
         this.debugWarnLog(`${this.device.remoteType}: ${this.accessory.displayName} deviceStatus statusCode: ${deviceStatus.statusCode}`);
         if ((statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)) {
-          this.debugErrorLog(`${this.device.remoteType}: ${this.accessory.displayName} `
+          this.debugSuccessLog(`${this.device.remoteType}: ${this.accessory.displayName} `
             + `statusCode: ${statusCode} & deviceStatus StatusCode: ${deviceStatus.statusCode}`);
           this.successLog(`${this.device.remoteType}: ${this.accessory.displayName} request to SwitchBot API, body: ${bodyChange} sent successfully`);
           this.accessory.context.On = this.On;
@@ -252,7 +254,7 @@ export class Light extends irdeviceBase {
         this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} On: ${this.On}`);
       } else {
         this.accessory.context.On = this.On;
-        this.lightBulbService?.updateCharacteristic(this.hap.Characteristic.On, this.On);
+        this.LightBulb.Service?.updateCharacteristic(this.hap.Characteristic.On, this.On);
         this.debugLog(`${this.device.remoteType}: ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
       }
     } else {
@@ -283,7 +285,7 @@ export class Light extends irdeviceBase {
 
   async apiError(e: any): Promise<void> {
     if (this.device.irlight?.stateless) {
-      this.lightBulbService?.updateCharacteristic(this.hap.Characteristic.On, e);
+      this.LightBulb.Service?.updateCharacteristic(this.hap.Characteristic.On, e);
     } else {
       this.ProgrammableSwitchServiceOn?.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchEvent, e);
       this.ProgrammableSwitchServiceOn?.updateCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState, e);

package/src/irdevice/other.ts

@@ -14,7 +14,7 @@ import { CharacteristicValue, PlatformAccessory, Service } from 'homebridge';
  * Each accessory may expose multiple services of different service types.
  */
 export class Others extends irdeviceBase {
-
+  // Services
   private Switch?: {
     Service: Service;
     On: CharacteristicValue;
@@ -82,8 +82,8 @@ export class Others extends irdeviceBase {
     if (this.otherDeviceType === 'switch') {
       // Initialize Switch property
       this.Switch = {
-        Service: accessory.addService(this.hap.Service.Switch),
-        On: accessory.context.On || true,
+        Service: accessory.getService(this.hap.Service.Switch)!,
+        On: accessory.context.On || false,
       };
       this.removeFanService(accessory);
       this.removeLockService(accessory);
@@ -106,8 +106,8 @@ export class Others extends irdeviceBase {
     } else if (this.otherDeviceType === 'garagedoor') {
       // Initialize Garage Door property
       this.GarageDoor = {
-        Service: accessory.addService(this.hap.Service.GarageDoorOpener),
-        On: accessory.context.On || true,
+        Service: accessory.getService(this.hap.Service.GarageDoorOpener)!,
+        On: accessory.context.On || false,
       };
       this.removeFanService(accessory);
       this.removeLockService(accessory);
@@ -131,8 +131,8 @@ export class Others extends irdeviceBase {
     } else if (this.otherDeviceType === 'door') {
       // Initialize Door property
       this.Door = {
-        Service: accessory.addService(this.hap.Service.Door),
-        On: accessory.context.On || true,
+        Service: accessory.getService(this.hap.Service.Door)!,
+        On: accessory.context.On || false,
       };
       this.removeFanService(accessory);
       this.removeLockService(accessory);
@@ -164,8 +164,8 @@ export class Others extends irdeviceBase {
     } else if (this.otherDeviceType === 'window') {
       // Initialize Window property
       this.Window = {
-        Service: accessory.addService(this.hap.Service.Window),
-        On: accessory.context.On || true,
+        Service: accessory.getService(this.hap.Service.Window)!,
+        On: accessory.context.On || false,
       };
       this.removeFanService(accessory);
       this.removeLockService(accessory);
@@ -197,8 +197,8 @@ export class Others extends irdeviceBase {
     } else if (this.otherDeviceType === 'windowcovering') {
       // Initialize WindowCovering property
       this.WindowCovering = {
-        Service: accessory.addService(this.hap.Service.WindowCovering),
-        On: accessory.context.On || true,
+        Service: accessory.getService(this.hap.Service.WindowCovering)!,
+        On: accessory.context.On || false,
       };
       this.removeFanService(accessory);
       this.removeLockService(accessory);
@@ -230,8 +230,8 @@ export class Others extends irdeviceBase {
     } else if (this.otherDeviceType === 'lock') {
       // Initialize Lock property
       this.Lock = {
-        Service: accessory.addService(this.hap.Service.LockMechanism),
-        On: accessory.context.On || true,
+        Service: accessory.getService(this.hap.Service.LockMechanism)!,
+        On: accessory.context.On || false,
       };
       this.removeFanService(accessory);
       this.removeDoorService(accessory);
@@ -254,8 +254,8 @@ export class Others extends irdeviceBase {
     } else if (this.otherDeviceType === 'faucet') {
       // Initialize Faucet property
       this.Faucet = {
-        Service: accessory.addService(this.hap.Service.Faucet),
-        On: accessory.context.On || true,
+        Service: accessory.getService(this.hap.Service.Faucet)!,
+        On: accessory.context.On || false,
       };
       this.removeFanService(accessory);
       this.removeLockService(accessory);
@@ -278,8 +278,8 @@ export class Others extends irdeviceBase {
     } else if (this.otherDeviceType === 'fan') {
       // Initialize Fan property
       this.Fan = {
-        Service: accessory.addService(this.hap.Service.Fanv2),
-        On: accessory.context.On || true,
+        Service: accessory.getService(this.hap.Service.Fanv2)!,
+        On: accessory.context.On || false,
       };
       this.removeLockService(accessory);
       this.removeDoorService(accessory);
@@ -302,8 +302,8 @@ export class Others extends irdeviceBase {
     } else if (this.otherDeviceType === 'stateful') {
       // Initialize StatefulProgrammableSwitch property
       this.StatefulProgrammableSwitch = {
-        Service: accessory.addService(this.hap.Service.StatefulProgrammableSwitch),
-        On: accessory.context.On || true,
+        Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch)!,
+        On: accessory.context.On || false,
       };
       this.removeFanService(accessory);
       this.removeLockService(accessory);
@@ -328,8 +328,8 @@ export class Others extends irdeviceBase {
     } else {
       // Initialize Outlet property
       this.Outlet = {
-        Service: accessory.addService(this.hap.Service.Outlet),
-        On: accessory.context.On || true,
+        Service: accessory.getService(this.hap.Service.Outlet)!,
+        On: accessory.context.On || false,
       };
       this.removeFanService(accessory);
       this.removeLockService(accessory);
@@ -491,7 +491,7 @@ export class Others extends irdeviceBase {
         this.debugWarnLog(`${this.device.remoteType}: ${this.accessory.displayName} deviceStatus: ${JSON.stringify(deviceStatus)}`);
         this.debugWarnLog(`${this.device.remoteType}: ${this.accessory.displayName} deviceStatus statusCode: ${deviceStatus.statusCode}`);
         if ((statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)) {
-          this.debugErrorLog(`${this.device.remoteType}: ${this.accessory.displayName} `
+          this.debugSuccessLog(`${this.device.remoteType}: ${this.accessory.displayName} `
             + `statusCode: ${statusCode} & deviceStatus StatusCode: ${deviceStatus.statusCode}`);
           this.successLog(`${this.device.remoteType}: ${this.accessory.displayName} request to SwitchBot API, body: ${bodyChange} sent successfully`);
           this.updateHomeKitCharacteristics();
@@ -700,92 +700,92 @@ export class Others extends irdeviceBase {
 
   async removeOutletService(accessory: PlatformAccessory): Promise<void> {
     // If Outlet.Service still present, then remove first
+    if (this.Outlet?.Service) {
     this.Outlet!.Service = this.accessory.getService(this.hap.Service.Outlet) as Service;
-    if (this.Outlet!.Service) {
-      this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Outlet Service`);
-    }
+    this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Outlet Service`);
     accessory.removeService(this.Outlet!.Service);
+    }
   }
 
   async removeGarageDoorService(accessory: PlatformAccessory): Promise<void> {
     // If GarageDoor.Service still present, then remove first
+    if (this.GarageDoor?.Service) {
     this.GarageDoor!.Service = this.accessory.getService(this.hap.Service.GarageDoorOpener) as Service;
-    if (this.GarageDoor!.Service) {
-      this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Garage Door Service`);
-    }
+    this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Garage Door Service`);
     accessory.removeService(this.GarageDoor!.Service);
+    }
   }
 
   async removeDoorService(accessory: PlatformAccessory): Promise<void> {
     // If Door.Service still present, then remove first
+    if (this.Door?.Service) {
     this.Door!.Service = this.accessory.getService(this.hap.Service.Door) as Service;
-    if (this.Door!.Service) {
-      this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Door Service`);
-    }
+    this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Door Service`);
     accessory.removeService(this.Door!.Service);
+    }
   }
 
   async removeLockService(accessory: PlatformAccessory): Promise<void> {
     // If Lock.Service still present, then remove first
+    if (this.Lock?.Service) {
     this.Lock!.Service = this.accessory.getService(this.hap.Service.LockMechanism) as Service;
-    if (this.Lock!.Service) {
-      this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Lock Service`);
-    }
+    this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Lock Service`);
     accessory.removeService(this.Lock!.Service);
+    }
   }
 
   async removeFaucetService(accessory: PlatformAccessory): Promise<void> {
     // If Faucet.Service still present, then remove first
+    if (this.Faucet?.Service) {
     this.Faucet!.Service = this.accessory.getService(this.hap.Service.Faucet) as Service;
-    if (this.Faucet!.Service) {
-      this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Faucet Service`);
-    }
+    this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Faucet Service`);
     accessory.removeService(this.Faucet!.Service);
+    }
   }
 
   async removeFanService(accessory: PlatformAccessory): Promise<void> {
     // If Fan Service still present, then remove first
+    if (this.Fan?.Service) {
     this.Fan!.Service = this.accessory.getService(this.hap.Service.Fan) as Service;
-    if (this.Fan!.Service) {
-      this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Fan Service`);
-    }
+    this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Fan Service`);
     accessory.removeService(this.Fan!.Service);
+    }
   }
 
   async removeWindowService(accessory: PlatformAccessory): Promise<void> {
     // If Window.Service still present, then remove first
+    if (this.Window?.Service) {
     this.Window!.Service = this.accessory.getService(this.hap.Service.Window) as Service;
-    if (this.Window!.Service) {
-      this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Window Service`);
-    }
+    this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Window Service`);
     accessory.removeService(this.Window!.Service);
+    }
   }
 
   async removeWindowCoveringService(accessory: PlatformAccessory): Promise<void> {
     // If WindowCovering.Service still present, then remove first
+    if (this.WindowCovering?.Service) {
     this.WindowCovering!.Service = this.accessory.getService(this.hap.Service.WindowCovering) as Service;
-    if (this.WindowCovering!.Service) {
-      this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Window Covering Service`);
-    }
+    this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Window Covering Service`);
     accessory.removeService(this.WindowCovering!.Service);
+    }
   }
 
   async removeStatefulProgrammableSwitchService(accessory: PlatformAccessory): Promise<void> {
     // If StatefulProgrammableSwitch.Service still present, then remove first
+    if (this.StatefulProgrammableSwitch?.Service) {
     this.StatefulProgrammableSwitch!.Service = this.accessory.getService(this.hap.Service.StatefulProgrammableSwitch) as Service;
-    if (this.StatefulProgrammableSwitch!.Service) {
-      this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Stateful Programmable Switch Service`);
-    }
+    this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Stateful Programmable Switch Service`);
     accessory.removeService(this.StatefulProgrammableSwitch!.Service);
+    }
   }
 
   async removeSwitchService(accessory: PlatformAccessory): Promise<void> {
     // If Switch.Service still present, then remove first
+    if (this.Switch?.Service) {
     this.Switch!.Service = this.accessory.getService(this.hap.Service.Switch) as Service;
-    if (this.Switch!.Service) {
-      this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Switch Service`);
-    }
+    this.warnLog(`${this.device.remoteType}: ${accessory.displayName} Removing Leftover Switch Service`);
     accessory.removeService(this.Switch!.Service);
+    }
   }
 
   async getOtherConfigSettings(device: irdevice & irDevicesConfig): Promise<void> {

package/src/irdevice/tv.ts

@@ -41,7 +41,7 @@ export class TV extends irdeviceBase {
 
     // Initialize Television property
     this.Television = {
-      Service: accessory.addService(this.hap.Service.Television),
+      Service: accessory.getService(this.hap.Service.Television)!,
       Active: accessory.context.Active || this.hap.Characteristic.Active.INACTIVE,
       ActiveIdentifier: accessory.context.ActiveIdentifier || 1,
       SleepDiscoveryMode: accessory.context.SleepDiscoveryMode || this.hap.Characteristic.SleepDiscoveryMode.ALWAYS_DISCOVERABLE,
@@ -50,7 +50,7 @@ export class TV extends irdeviceBase {
 
     // Initialize TelevisionSpeaker property
     this.TelevisionSpeaker = {
-      Service: accessory.addService(this.hap.Service.TelevisionSpeaker),
+      Service: accessory.getService(this.hap.Service.TelevisionSpeaker)!,
       Active: accessory.context.Active || false,
       VolumeControlType: accessory.context.VolumeControlType || this.hap.Characteristic.VolumeControlType.ABSOLUTE,
       VolumeSelector: accessory.context.VolumeSelector || this.hap.Characteristic.VolumeSelector.INCREMENT,
@@ -388,7 +388,7 @@ export class TV extends irdeviceBase {
         this.debugWarnLog(`${this.device.remoteType}: ${this.accessory.displayName} deviceStatus: ${JSON.stringify(deviceStatus)}`);
         this.debugWarnLog(`${this.device.remoteType}: ${this.accessory.displayName} deviceStatus statusCode: ${deviceStatus.statusCode}`);
         if ((statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)) {
-          this.debugErrorLog(`${this.device.remoteType}: ${this.accessory.displayName} `
+          this.debugSuccessLog(`${this.device.remoteType}: ${this.accessory.displayName} `
             + `statusCode: ${statusCode} & deviceStatus StatusCode: ${deviceStatus.statusCode}`);
           this.successLog(`${this.device.remoteType}: ${this.accessory.displayName} request to SwitchBot API, body: ${bodyChange} sent successfully`);
           this.updateHomeKitCharacteristics();

package/src/irdevice/vacuumcleaner.ts

@@ -29,7 +29,7 @@ export class VacuumCleaner extends irdeviceBase {
 
     // Initialize Switch property
     this.Switch = {
-      Service: accessory.addService(this.hap.Service.Switch),
+      Service: accessory.getService(this.hap.Service.Switch)!,
       On: accessory.context.On || false,
     };
 
@@ -107,7 +107,7 @@ export class VacuumCleaner extends irdeviceBase {
         this.debugWarnLog(`${this.device.remoteType}: ${this.accessory.displayName} deviceStatus: ${JSON.stringify(deviceStatus)}`);
         this.debugWarnLog(`${this.device.remoteType}: ${this.accessory.displayName} deviceStatus statusCode: ${deviceStatus.statusCode}`);
         if ((statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)) {
-          this.debugErrorLog(`${this.device.remoteType}: ${this.accessory.displayName} `
+          this.debugSuccessLog(`${this.device.remoteType}: ${this.accessory.displayName} `
             + `statusCode: ${statusCode} & deviceStatus StatusCode: ${deviceStatus.statusCode}`);
           this.successLog(`${this.device.remoteType}: ${this.accessory.displayName} request to SwitchBot API, body: ${bodyChange} sent successfully`);
           this.updateHomeKitCharacteristics();

package/src/irdevice/waterheater.ts

@@ -29,7 +29,7 @@ export class WaterHeater extends irdeviceBase {
 
     // Initialize Valve property
     this.Valve = {
-      Service: accessory.addService(this.hap.Service.Valve),
+      Service: accessory.getService(this.hap.Service.Valve)!,
       Active: accessory.context.Active || this.hap.Characteristic.Active.INACTIVE,
     };
 
@@ -112,7 +112,7 @@ export class WaterHeater extends irdeviceBase {
         this.debugWarnLog(`${this.device.remoteType}: ${this.accessory.displayName} deviceStatus: ${JSON.stringify(deviceStatus)}`);
         this.debugWarnLog(`${this.device.remoteType}: ${this.accessory.displayName} deviceStatus statusCode: ${deviceStatus.statusCode}`);
         if ((statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)) {
-          this.debugErrorLog(`${this.device.remoteType}: ${this.accessory.displayName} `
+          this.debugSuccessLog(`${this.device.remoteType}: ${this.accessory.displayName} `
             + `statusCode: ${statusCode} & deviceStatus StatusCode: ${deviceStatus.statusCode}`);
           this.successLog(`${this.device.remoteType}: ${this.accessory.displayName} request to SwitchBot API, body: ${bodyChange} sent successfully`);
           this.updateHomeKitCharacteristics();

package/src/platform.ts

@@ -39,12 +39,10 @@ import fakegato from 'fakegato-history';
 import asyncmqtt from 'async-mqtt';
 import crypto, { randomUUID } from 'crypto';
 import { readFileSync, writeFileSync } from 'fs';
-import { EveHomeKitTypes } from 'homebridge-lib';
+import { EveHomeKitTypes } from 'homebridge-lib/EveHomeKitTypes';
 import { UrlObject } from 'url';
 import { sleep } from './utils.js';
 
-
-
 /**
  * HomebridgePlatform
  * This class is the main constructor for your plugin, this is where you should
@@ -387,7 +385,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
     }
 
     if (!this.config.options.maxRetries) {
-      this.config.options!.maxRetries! = 5;
+      this.config.options.maxRetries = 5;
       this.debugWarnLog('Using Default Max Retries.');
     } else {
       this.maxRetries = this.config.options.maxRetries;
@@ -513,6 +511,9 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       let retryCount = 0;
       const maxRetries = this.maxRetries; // Maximum number of retries
       const delayBetweenRetries = this.delayBetweenRetries; // Delay between retries in milliseconds
+      this.debugWarnLog(`Retry Count: ${retryCount}`);
+      this.debugWarnLog(`Max Retries: ${maxRetries}`);
+      this.debugWarnLog(`Delay Between Retries: ${delayBetweenRetries}`);
       while (retryCount < maxRetries) {
         try {
           const { body, statusCode } = await request(Devices, {
@@ -2718,6 +2719,22 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
       if (this.config.options.pushRate) {
         platformConfig.pushRate = this.config.options.pushRate;
       }
+      if (this.config.options.maxRetries) {
+        this.maxRetries = this.config.options.maxRetries;
+        platformConfig.maxRetries = this.config.options.maxRetries;
+      } else {
+        this.maxRetries = 3;
+        this.debugWarnLog('Using Default Max Retries');
+        platformConfig.maxRetries = this.maxRetries;
+      }
+      if (this.config.options.delayBetweenRetries) {
+        this.delayBetweenRetries = this.config.options.delayBetweenRetries * 1000;
+        platformConfig.delayBetweenRetries = this.config.options.delayBetweenRetries;
+      } else {
+        this.delayBetweenRetries = 3000;
+        this.debugWarnLog('Using Default Delay Between Retries');
+        platformConfig.delayBetweenRetries = this.delayBetweenRetries / 1000;
+      }
       if (Object.entries(platformConfig).length !== 0) {
         this.debugLog(`Platform Config: ${JSON.stringify(platformConfig)}`);
       }