@switchbot/homebridge-switchbot 3.6.0 → 3.6.1-beta.1

package/package.json

@@ -1,7 +1,7 @@
 {
   "displayName": "SwitchBot",
   "name": "@switchbot/homebridge-switchbot",
-  "version": "3.6.0",
+  "version": "3.6.1-beta.1",
   "description": "The SwitchBot plugin allows you to access your SwitchBot device(s) from HomeKit.",
   "author": {
     "name": "SwitchBot",
@@ -26,7 +26,7 @@
   },
   "engineStrict": true,
   "engines": {
-    "homebridge": "^1.8.3",
+    "homebridge": "^1.8.4-beta.21",
     "node": "^18 || ^20 || ^22"
   },
   "main": "dist/index.js",
@@ -94,13 +94,13 @@
     "@types/node": "^20.14.10",
     "eslint": "^9.6.0",
     "globals": "^15.8.0",
-    "homebridge": "^1.8.3",
+    "homebridge": "^1.8.4-beta.21",
     "homebridge-config-ui-x": "4.56.4",
     "nodemon": "^3.1.4",
     "npm-check-updates": "^16.14.20",
-    "rimraf": "^5.0.8",
+    "rimraf": "^6.0.0",
     "ts-node": "^10.9.2",
     "typescript": "^5.5.3",
-    "typescript-eslint": "^8.0.0-alpha.39"
+    "typescript-eslint": "^8.0.0-alpha.41"
   }
 }

package/src/device/blindtilt.ts

@@ -381,7 +381,7 @@ export class BlindTilt extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/device/bot.ts

@@ -551,6 +551,7 @@ export class Bot extends deviceBase {
 
     // BLEmode (true if Switch Mode) | (false if Press Mode)
     if (this.serviceData.mode) {
+      await this.setOn(this.serviceData.state);
       this.accessory.context.On = await this.getOn();
       if (this.getOn() === undefined) {
         this.setOn(Boolean(this.serviceData.state));
@@ -586,6 +587,7 @@ export class Bot extends deviceBase {
       this.setOn(false);
       this.accessory.context.On = await this.getOn();
     } else {
+      this.setOn(this.deviceStatus.power === 'on' ? true : false);
       this.accessory.context.On = await this.getOn();
       if (this.getOn() === undefined) {
         this.setOn(false);

package/src/device/ceilinglight.ts

@@ -276,7 +276,7 @@ export class CeilingLight extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/device/colorbulb.ts

@@ -297,7 +297,7 @@ export class ColorBulb extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/device/contact.ts

@@ -287,7 +287,7 @@ export class Contact extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/device/curtain.ts

@@ -425,7 +425,7 @@ export class Curtain extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();
@@ -437,26 +437,41 @@ export class Curtain extends deviceBase {
 
   async BLERefreshStatus(): Promise<void> {
     await this.debugLog('BLERefreshStatus');
-    const switchbot = await this.switchbotBLE();
-
-    if (switchbot === undefined) {
-      await this.BLERefreshConnection(switchbot);
-    } else {
-    // Start to monitor advertisement packets
-      (async () => {
-      // Start to monitor advertisement packets
-        const serviceData = await this.monitorAdvertisementPackets(switchbot) as curtainServiceData | curtain3ServiceData;
-        // Update HomeKit
-        if ((serviceData.model === SwitchBotBLEModel.Curtain || SwitchBotBLEModel.Curtain3)
-          && (serviceData.modelName === SwitchBotBLEModelName.Curtain || SwitchBotBLEModelName.Curtain3)) {
-          this.serviceData = serviceData;
-          await this.BLEparseStatus();
+    if (this.config.options?.BLE) {
+      await this.debugLog('is listening to BLE.');
+      this.platform.bleEventHandler[this.device.deviceId] = async (context: curtainServiceData | curtain3ServiceData) => {
+        try {
+          await this.debugLog(`received Webhook: ${JSON.stringify(context)}`);
+          this.serviceData = context;
+          await this.parseStatusWebhook();
           await this.updateHomeKitCharacteristics();
-        } else {
-          await this.errorLog(`failed to get serviceData, serviceData: ${serviceData}`);
-          await this.BLERefreshConnection(switchbot);
+        } catch (e: any) {
+          await this.errorLog(`failed to handle BLE. Received: ${JSON.stringify(context)} Error: ${e}`);
         }
-      })();
+      };
+    } else {
+      await this.debugLog('is not listening to BLE.');
+      const switchbot = await this.switchbotBLE();
+
+      if (switchbot === undefined) {
+        await this.BLERefreshConnection(switchbot);
+      } else {
+        // Start to monitor advertisement packets
+        (async () => {
+          // Start to monitor advertisement packets
+          const serviceData = await this.monitorAdvertisementPackets(switchbot) as curtainServiceData | curtain3ServiceData;
+          // Update HomeKit
+          if ((serviceData.model === SwitchBotBLEModel.Curtain || SwitchBotBLEModel.Curtain3)
+          && (serviceData.modelName === SwitchBotBLEModelName.Curtain || SwitchBotBLEModelName.Curtain3)) {
+            this.serviceData = serviceData;
+            await this.BLEparseStatus();
+            await this.updateHomeKitCharacteristics();
+          } else {
+            await this.errorLog(`failed to get serviceData, serviceData: ${serviceData}`);
+            await this.BLERefreshConnection(switchbot);
+          }
+        })();
+      }
     }
   }
 

package/src/device/device.ts

@@ -355,16 +355,15 @@ export abstract class deviceBase {
       .deviceId!.match(/.{1,2}/g)!
       .join(':')
       .toLowerCase();
-    this.debugLog(`BLE Address: ${this.device.bleMac}`);
+    await this.debugLog(`BLE Address: ${this.device.bleMac}`);
   }
 
   async monitorAdvertisementPackets(switchbot: any) {
-    this.debugLog(`Scanning for ${this.device.bleModelName} devices...`);
+    await this.debugLog(`Scanning for ${this.device.bleModelName} devices...`);
     await switchbot.startScan({ model: this.device.bleModel, id: this.device.bleMac });
     // Set an event handler
     let serviceData = { model: this.device.bleModel, modelName: this.device.bleModelName } as ad['serviceData'];
     switchbot.onadvertisement = async (ad: ad) => {
-      this.warnLog(`ad: ${JSON.stringify(ad, null, '  ')}`);
       if (this.device.bleMac === ad.address && ad.serviceData.model === this.device.bleModel) {
         this.debugLog(`${JSON.stringify(ad, null, '  ')}`);
         this.debugLog(`address: ${ad.address}, model: ${ad.serviceData.model}`);
@@ -830,4 +829,4 @@ export abstract class deviceBase {
   async enablingDeviceLogging(): Promise<boolean> {
     return this.deviceLogging.includes('debug') || this.deviceLogging === 'standard';
   }
-}
+}

package/src/device/fan.ts

@@ -314,7 +314,7 @@ export class Fan extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/device/hub.ts

@@ -278,7 +278,7 @@ export class Hub extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/device/humidifier.ts

@@ -318,7 +318,7 @@ export class Humidifier extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/device/iosensor.ts

@@ -271,7 +271,7 @@ export class IOSensor extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/device/lightstrip.ts

@@ -301,7 +301,7 @@ export class StripLight extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/device/lock.ts

@@ -297,7 +297,7 @@ export class Lock extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/device/meter.ts

@@ -265,7 +265,7 @@ export class Meter extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/device/meterplus.ts

@@ -266,7 +266,7 @@ export class MeterPlus extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/device/motion.ts

@@ -237,7 +237,7 @@ export class Motion extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/device/plug.ts

@@ -148,7 +148,7 @@ export class Plug extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/device/robotvacuumcleaner.ts

@@ -249,7 +249,7 @@ export class RobotVacuumCleaner extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/device/waterdetector.ts

@@ -234,7 +234,7 @@ export class WaterDetector extends deviceBase {
   async refreshStatus(): Promise<void> {
     if (!this.device.enableCloudService && this.OpenAPI) {
       await this.errorLog(`refreshStatus enableCloudService: ${this.device.enableCloudService}`);
-    } else if (this.BLE) {
+    } else if (this.BLE || this.config.options?.BLE) {
       await this.BLERefreshStatus();
     } else if (this.OpenAPI && this.platform.config.credentials?.token) {
       await this.openAPIRefreshStatus();

package/src/platform.ts

@@ -78,6 +78,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
   public readonly eve: any;
   public readonly fakegatoAPI: any;
   public readonly webhookEventHandler: { [x: string]: (context: any) => void } = {};
+  public readonly bleEventHandler: { [x: string]: (context: any) => void } = {};
 
   constructor(
     log: Logging,
@@ -148,6 +149,7 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
 
     this.setupMqtt();
     this.setupwebhook();
+    this.setupBlE();
   }
 
   async setupMqtt(): Promise<void> {
@@ -312,6 +314,34 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
     }
   }
 
+  async setupBlE() {
+    if (this.config.options?.BLE) {
+      await this.debugLog('setupBLE');
+      const SwitchBot = (await import('node-switchbot')).SwitchBot;
+      const switchbot = new SwitchBot();
+      if (switchbot === undefined) {
+        await this.errorLog(`wasn't able to establish BLE Connection, node-switchbot: ${switchbot}`);
+      } else {
+        // Start to monitor advertisement packets
+        (async () => {
+          // Start to monitor advertisement packets
+          await this.debugLog('Scanning for BLE SwitchBot devices...');
+          await switchbot.startScan();
+          // Set an event handler to monitor advertisement packets
+          switchbot.onadvertisement = async (ad: any) => {
+            try {
+              this.bleEventHandler[ad.id]?.(ad);
+            } catch (e: any) {
+              this.errorLog(`Failed to handle BLE event. Error:${e}`);
+            }
+          };
+        })();
+      }
+    } else {
+      await this.debugLog('Platform BLE is not enabled');
+    }
+  }
+
   /**
    * This function is invoked when homebridge restores cached accessories from disk at startup.
    * It should be used to setup event handlers for characteristics and update respective values.

package/src/settings.ts

@@ -61,6 +61,7 @@ interface options {
   mqttURL?: string;
   mqttOptions?: IClientOptions;
   mqttPubOptions?: IClientOptions;
+  BLE?: boolean;
   webhookURL?: string;
   maxRetries?: number;
   delayBetweenRetries?: number;