@switchbot/homebridge-switchbot 1.7.1-beta.1 → 1.7.1-beta.5

package/src/devices/curtains.ts

@@ -4,7 +4,7 @@ import { interval, Subject } from 'rxjs';
 import { SwitchBotPlatform } from '../platform';
 import { debounceTime, skipWhile, take, tap } from 'rxjs/operators';
 import { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
-import { DeviceURL, device, devicesConfig, serviceData, switchbot, deviceStatusResponse, payload } from '../settings';
+import { DeviceURL, device, devicesConfig, serviceData, switchbot, deviceStatusResponse, payload, deviceStatus } from '../settings';
 
 export class Curtain {
   // Services
@@ -22,16 +22,20 @@ export class Curtain {
 
   // OpenAPI Others
   deviceStatus!: deviceStatusResponse;
+  slidePosition: deviceStatus['slidePosition'];
+  moving: deviceStatus['moving'];
+  brightness: deviceStatus['brightness'];
 
   // BLE Others
   connected?: boolean;
   switchbot!: switchbot;
+  SwitchToOpenAPI?: boolean;
   serviceData!: serviceData;
+  spaceBetweenLevels!: number;
   calibration: serviceData['calibration'];
   battery: serviceData['battery'];
   position: serviceData['position'];
   lightLevel: serviceData['lightLevel'];
-  spaceBetweenLevels!: number;
 
   // Target
   setNewTarget!: boolean;
@@ -142,6 +146,23 @@ export class Curtain {
       this.debugLog(`Curtain: ${accessory.displayName} Light Sensor Service Not Added`);
     }
 
+    // Battery Service
+    if (!device.ble) {
+      this.debugLog(`Curtain: ${accessory.displayName} Removing Battery Service`);
+      this.batteryService = this.accessory.getService(this.platform.Service.Battery);
+      accessory.removeService(this.batteryService!);
+    } else if (!this.batteryService) {
+      this.debugLog(`Curtain: ${accessory.displayName} Add Battery Service`);
+      (this.batteryService =
+        this.accessory.getService(this.platform.Service.Battery) ||
+        this.accessory.addService(this.platform.Service.Battery)), `${accessory.displayName} Battery`;
+
+      this.batteryService.setCharacteristic(this.platform.Characteristic.Name, `${accessory.displayName} Battery`);
+
+    } else {
+      this.debugLog(`Curtain: ${accessory.displayName} Battery Service Not Added`);
+    }
+
 
     // Update Homekit
     this.updateHomeKitCharacteristics();
@@ -253,30 +274,6 @@ export class Curtain {
     }
   }
 
-  public async connectBLE() {
-    let switchbot: any;
-    try {
-      // eslint-disable-next-line @typescript-eslint/no-var-requires
-      const Switchbot = require('node-switchbot');
-      switchbot = new Switchbot();
-      // Convert to BLE Address
-      this.device.bleMac = ((this.device.deviceId!.match(/.{1,2}/g))!.join(':')).toLowerCase();
-      this.debugLog(`Curtain: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
-    } catch (e: any) {
-      switchbot = false;
-      this.errorLog(`Curtain: ${this.accessory.displayName} 'node-switchbot' found: ${switchbot}`);
-      if (this.deviceLogging === 'debug') {
-        this.errorLog(`Curtain: ${this.accessory.displayName} 'node-switchbot' found: ${switchbot},`
-          + ` Error Message: ${JSON.stringify(e.message)}`);
-      }
-      if (this.platform.debugMode) {
-        this.errorLog(`Curtain: ${this.accessory.displayName} 'node-switchbot' found: ${switchbot},`
-          + ` Error: ${JSON.stringify(e)}`);
-      }
-    }
-    return switchbot;
-  }
-
   private minStep(): number {
     if (this.device.curtain?.set_minStep) {
       this.set_minStep = this.device.curtain?.set_minStep;
@@ -304,16 +301,20 @@ export class Curtain {
     return this.set_maxLux;
   }
 
+  /**
+   * Parse the device status from the SwitchBot api
+   */
   async parseStatus() {
-    if (this.device.ble) {
-      await this.BLEparseStatus();
-    } else {
+    if (this.SwitchToOpenAPI || !this.device.ble) {
       await this.openAPIparseStatus();
+    } else {
+      await this.BLEparseStatus();
     }
   }
 
   private async BLEparseStatus() {
     this.debugLog(`Curtain: ${this.accessory.displayName} BLE parseStatus`);
+    // CurrentPosition
     this.setMinMax();
     this.CurrentPosition = 100 - Number(this.position);
     this.debugLog(`Curtain: ${this.accessory.displayName} CurrentPosition ${this.CurrentPosition}`);
@@ -339,6 +340,7 @@ export class Curtain {
         // If Curtain calibration distance is short, there will be an error between the current percentage and the target percentage.
         this.TargetPosition = this.CurrentPosition;
         this.PositionState = this.platform.Characteristic.PositionState.STOPPED;
+        this.infoLog(`Curtain: ${this.accessory.displayName} Stopped`);
       }
     }
     this.debugLog(`Curtain: ${this.accessory.displayName} CurrentPosition: ${this.CurrentPosition},`
@@ -407,17 +409,20 @@ export class Curtain {
   }
 
   private async openAPIparseStatus() {
+    if (this.device.ble) {
+      this.SwitchToOpenAPI = false;
+    }
     if (this.platform.config.credentials?.openToken) {
       this.debugLog(`Curtain: ${this.accessory.displayName} OpenAPI parseStatus`);
       // CurrentPosition
       this.setMinMax();
-      this.CurrentPosition = 100 - this.deviceStatus.body.slidePosition!;
+      this.CurrentPosition = 100 - Number(this.slidePosition);
       this.debugLog(`Curtain ${this.accessory.displayName} CurrentPosition: ${this.CurrentPosition}`);
       if (this.setNewTarget) {
-        this.infoLog(`Checking ${this.accessory.displayName} Status ...`);
+        this.infoLog(`Curtain: ${this.accessory.displayName} Checking Status ...`);
       }
 
-      if (this.deviceStatus.body.moving) {
+      if (this.setNewTarget && this.moving) {
         this.setMinMax();
         if (this.TargetPosition > this.CurrentPosition) {
           this.debugLog(`Curtain: ${this.accessory.displayName} Closing, CurrentPosition: ${this.CurrentPosition} `);
@@ -435,6 +440,7 @@ export class Curtain {
           /*If Curtain calibration distance is short, there will be an error between the current percentage and the target percentage.*/
           this.TargetPosition = this.CurrentPosition;
           this.PositionState = this.platform.Characteristic.PositionState.STOPPED;
+          this.infoLog(`Curtain: ${this.accessory.displayName} Stopped`);
         }
       }
       this.debugLog(`Curtain: ${this.accessory.displayName} CurrentPosition: ${this.CurrentPosition},`
@@ -444,7 +450,7 @@ export class Curtain {
         this.set_minLux = this.minLux();
         this.set_maxLux = this.maxLux();
         // Brightness
-        switch (this.deviceStatus.body.brightness) {
+        switch (this.brightness) {
           case 'dim':
             this.CurrentAmbientLightLevel = this.set_minLux;
             break;
@@ -468,7 +474,10 @@ export class Curtain {
   private async BLERefreshStatus() {
     this.debugLog(`Curtain: ${this.accessory.displayName} BLE refreshStatus`);
     // eslint-disable-next-line @typescript-eslint/no-var-requires
-    const switchbot = await this.connectBLE();
+    const switchbot = await this.platform.connectBLE();
+    // Convert to BLE Address
+    this.device.bleMac = ((this.device.deviceId!.match(/.{1,2}/g))!.join(':')).toLowerCase();
+    this.debugLog(`Curtain: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
     // Start to monitor advertisement packets
     if (switchbot !== false) {
       switchbot.startScan({
@@ -506,6 +515,7 @@ export class Curtain {
           this.errorLog(`Curtain: ${this.accessory.displayName} wasn't able to establish BLE Connection`);
           if (this.platform.config.credentials?.openToken) {
             this.warnLog(`Curtain: ${this.accessory.displayName} Using OpenAPI Connection`);
+            this.SwitchToOpenAPI = true;
             await this.openAPIRefreshStatus();
           }
         }
@@ -521,6 +531,7 @@ export class Curtain {
         }
         if (this.platform.config.credentials?.openToken) {
           this.warnLog(`Curtain: ${this.accessory.displayName} Using OpenAPI Connection`);
+          this.SwitchToOpenAPI = true;
           await this.openAPIRefreshStatus();
         }
         this.apiError(e);
@@ -534,6 +545,7 @@ export class Curtain {
     this.errorLog(`Curtain: ${this.accessory.displayName} wasn't able to establish BLE Connection, node-switchbot: ${switchbot}`);
     if (this.platform.config.credentials?.openToken) {
       this.warnLog(`Curtain: ${this.accessory.displayName} Using OpenAPI Connection`);
+      this.SwitchToOpenAPI = true;
       await this.openAPIRefreshStatus();
     }
   }
@@ -544,6 +556,9 @@ export class Curtain {
       try {
         this.deviceStatus = (await this.platform.axios.get(`${DeviceURL}/${this.device.deviceId}/status`)).data;
         this.debugLog(`Curtain: ${this.accessory.displayName} refreshStatus: ${JSON.stringify(this.deviceStatus)}`);
+        this.slidePosition = this.deviceStatus.body.slidePosition;
+        this.moving = this.deviceStatus.body.moving;
+        this.brightness = this.deviceStatus.body.brightness;
         this.parseStatus();
         this.updateHomeKitCharacteristics();
       } catch (e: any) {
@@ -578,7 +593,10 @@ export class Curtain {
   private async BLEpushChanges() {
     if (this.TargetPosition !== this.CurrentPosition) {
       this.debugLog(`Curtain: ${this.accessory.displayName} BLE pushChanges`);
-      const switchbot = await this.connectBLE();
+      const switchbot = await this.platform.connectBLE();
+      // Convert to BLE Address
+      this.device.bleMac = ((this.device.deviceId!.match(/.{1,2}/g))!.join(':')).toLowerCase();
+      this.debugLog(`Curtain: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
       if (switchbot !== false) {
         switchbot.discover({ model: 'c', quick: true, id: this.device.bleMac }).then((device_list) => {
           this.infoLog(`${this.accessory.displayName} Target Position: ${this.TargetPosition}`);

package/src/devices/meters.ts

@@ -33,6 +33,7 @@ export class Meter {
   // BLE Others
   connected?: boolean;
   switchbot!: switchbot;
+  SwitchToOpenAPI?: boolean;
   serviceData!: serviceData;
   temperature!: temperature['c'];
   battery!: serviceData['battery'];
@@ -232,10 +233,10 @@ export class Meter {
    * Parse the device status from the SwitchBot api
    */
   async parseStatus() {
-    if (this.device.ble) {
-      await this.BLEparseStatus();
-    } else {
+    if (this.SwitchToOpenAPI || !this.device.ble) {
       await this.openAPIparseStatus();
+    } else {
+      await this.BLEparseStatus();
     }
   }
 
@@ -266,6 +267,9 @@ export class Meter {
   }
 
   private async openAPIparseStatus() {
+    if (this.device.ble) {
+      this.SwitchToOpenAPI = false;
+    }
     if (this.platform.config.credentials?.openToken) {
       this.debugLog(`Meter: ${this.accessory.displayName} OpenAPI parseStatus`);
       if (this.deviceStatus.body) {
@@ -385,6 +389,7 @@ export class Meter {
         }
         if (this.platform.config.credentials?.openToken) {
           this.warnLog(`Meter: ${this.accessory.displayName} Using OpenAPI Connection`);
+          this.SwitchToOpenAPI = true;
           this.openAPIRefreshStatus();
         }
         this.apiError(e);
@@ -398,6 +403,7 @@ export class Meter {
     this.errorLog(`Meter: ${this.accessory.displayName} wasn't able to establish BLE Connection, node-switchbot: ${switchbot}`);
     if (this.platform.config.credentials?.openToken) {
       this.warnLog(`Meter: ${this.accessory.displayName} Using OpenAPI Connection`);
+      this.SwitchToOpenAPI = true;
       await this.openAPIRefreshStatus();
     }
   }

package/src/devices/motion.ts

@@ -2,7 +2,7 @@ import { interval, Subject } from 'rxjs';
 import { skipWhile } from 'rxjs/operators';
 import { SwitchBotPlatform } from '../platform';
 import { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
-import { DeviceURL, device, devicesConfig, serviceData, switchbot, deviceStatusResponse } from '../settings';
+import { DeviceURL, device, devicesConfig, serviceData, switchbot, deviceStatusResponse, deviceStatus } from '../settings';
 
 /**
  * Platform Accessory
@@ -23,10 +23,13 @@ export class Motion {
 
   // OpenAPI Others
   deviceStatus!: deviceStatusResponse;
+  moveDetected: deviceStatus['moveDetected'];
+  brightness: deviceStatus['brightness'];
 
   // BLE Others
   connected?: boolean;
   switchbot!: switchbot;
+  SwitchToOpenAPI?: boolean;
   serviceData!: serviceData;
   battery!: serviceData['battery'];
   movement!: serviceData['movement'];
@@ -108,12 +111,20 @@ export class Motion {
     }
 
     // Battery Service
-    if (device.ble) {
+    if (!device.ble) {
+      this.debugLog(`Motion Sensor: ${accessory.displayName} Removing Battery Service`);
+      this.batteryService = this.accessory.getService(this.platform.Service.Battery);
+      accessory.removeService(this.batteryService!);
+    } else if (!this.batteryService) {
+      this.debugLog(`Motion Sensor: ${accessory.displayName} Add Battery Service`);
       (this.batteryService =
-        accessory.getService(this.platform.Service.Battery) ||
-        accessory.addService(this.platform.Service.Battery)), `${accessory.displayName} Battery`;
+        this.accessory.getService(this.platform.Service.Battery) ||
+        this.accessory.addService(this.platform.Service.Battery)), `${accessory.displayName} Battery`;
 
       this.batteryService.setCharacteristic(this.platform.Characteristic.Name, `${accessory.displayName} Battery`);
+
+    } else {
+      this.debugLog(`Motion Sensor: ${accessory.displayName} Battery Service Not Added`);
     }
 
     // Retrieve initial values and updateHomekit
@@ -196,42 +207,38 @@ export class Motion {
    * Parse the device status from the SwitchBot api
    */
   async parseStatus() {
-    if (this.device.ble) {
-      await this.BLEparseStatus();
-    } else {
+    if (this.SwitchToOpenAPI || !this.device.ble) {
       await this.openAPIparseStatus();
+    } else {
+      await this.BLEparseStatus();
     }
   }
 
   private async BLEparseStatus() {
     this.debugLog(`Motion Sensor: ${this.accessory.displayName} BLE parseStatus`);
     // Movement
-    if (this.movement === undefined && this.platform.config.credentials?.openToken) {
-      this.openAPImotion();
-    } else if (this.movement === undefined) {
-      this.movement = false;
-      this.BLEmotion();
-    } else {
-      this.BLEmotion();
-    }
+    this.MotionDetected = this.movement!;
+    this.debugLog(`Motion Sensor: ${this.accessory.displayName} MotionDetected: ${this.MotionDetected}`);
     // Light Level
     if (!this.device.motion?.hide_lightsensor) {
       this.set_minLux = this.minLux();
       this.set_maxLux = this.maxLux();
-      if (this.lightLevel === undefined && this.platform.config.credentials?.openToken) {
-        this.openAPIlux();
-      } else if (this.lightLevel === undefined) {
-        this.lightLevel = 100;
-        this.BLElux();
-      } else {
-        this.BLElux();
+      switch (this.lightLevel) {
+        case 'dark':
+        case 1:
+          this.CurrentAmbientLightLevel = this.set_minLux;
+          break;
+        default:
+          this.CurrentAmbientLightLevel = this.set_maxLux;
       }
+      this.debugLog(`Motion Sensor: ${this.accessory.displayName} LightLevel: ${this.lightLevel},`
+        + ` CurrentAmbientLightLevel: ${this.CurrentAmbientLightLevel}`);
     }
     // Battery
     if (this.battery === undefined) {
       this.battery = 100;
     }
-    this.BatteryLevel = Number(this.battery);
+    this.BatteryLevel = this.battery!;
     if (this.BatteryLevel < 10) {
       this.StatusLowBattery = this.platform.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW;
     } else {
@@ -240,55 +247,31 @@ export class Motion {
     this.debugLog(`Motion Sensor: ${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel}, StatusLowBattery: ${this.StatusLowBattery}`);
   }
 
-  private BLEmotion() {
-    this.MotionDetected = Boolean(this.movement);
-    this.debugLog(`Motion Sensor: ${this.accessory.displayName} MotionDetected: ${this.MotionDetected}`);
-  }
-
-  private BLElux() {
-    switch (this.lightLevel) {
-      case 'dark':
-      case 1:
-        this.CurrentAmbientLightLevel = this.set_minLux;
-        break;
-      default:
-        this.CurrentAmbientLightLevel = this.set_maxLux;
-    }
-    this.debugLog(`Motion Sensor: ${this.accessory.displayName} LightLevel: ${this.lightLevel},`
-      + ` CurrentAmbientLightLevel: ${this.CurrentAmbientLightLevel}`);
-  }
-
   private async openAPIparseStatus() {
+    if (this.device.ble) {
+      this.SwitchToOpenAPI = false;
+    }
     if (this.platform.config.credentials?.openToken) {
       this.debugLog(`Motion Sensor: ${this.accessory.displayName} OpenAPI parseStatus`);
       // Motion State
-      this.openAPImotion();
+      this.MotionDetected = this.moveDetected!;
+      this.debugLog(`Motion Sensor: ${this.accessory.displayName} MotionDetected: ${this.MotionDetected}`);
       // Light Level
       if (!this.device.motion?.hide_lightsensor) {
-        this.openAPIlux();
-      }
-    }
-  }
-
-  private openAPImotion() {
-    if (typeof this.deviceStatus.body.moveDetected === 'boolean') {
-      this.MotionDetected = this.deviceStatus.body.moveDetected;
-    }
-    this.debugLog(`Motion Sensor: ${this.accessory.displayName} MotionDetected: ${this.MotionDetected}`);
-  }
+        this.set_minLux = this.minLux();
+        this.set_maxLux = this.maxLux();
+        switch (this.brightness) {
+          case 'dim':
+            this.CurrentAmbientLightLevel = this.set_minLux;
+            break;
+          case 'bright':
+          default:
+            this.CurrentAmbientLightLevel = this.set_maxLux;
+        }
+        this.debugLog(`Motion Sensor: ${this.accessory.displayName} CurrentAmbientLightLevel: ${this.CurrentAmbientLightLevel}`);
 
-  private openAPIlux() {
-    this.set_minLux = this.minLux();
-    this.set_maxLux = this.maxLux();
-    switch (this.deviceStatus.body.brightness) {
-      case 'dim':
-        this.CurrentAmbientLightLevel = this.set_minLux;
-        break;
-      case 'bright':
-      default:
-        this.CurrentAmbientLightLevel = this.set_maxLux;
+      }
     }
-    this.debugLog(`Motion Sensor: ${this.accessory.displayName} CurrentAmbientLightLevel: ${this.CurrentAmbientLightLevel}`);
   }
 
   /**
@@ -333,7 +316,7 @@ export class Motion {
     // Start to monitor advertisement packets
     if (switchbot !== false) {
       switchbot.startScan({
-        //model: 's',
+        model: 's',
         id: this.device.bleMac,
       }).then(() => {
         // Set an event hander
@@ -377,6 +360,7 @@ export class Motion {
         }
         if (this.platform.config.credentials?.openToken) {
           this.warnLog(`Motion Sensor: ${this.accessory.displayName} Using OpenAPI Connection`);
+          this.SwitchToOpenAPI = true;
           await this.openAPIRefreshStatus();
         }
         this.apiError(e);
@@ -390,6 +374,7 @@ export class Motion {
     this.errorLog(`Motion Sensor: ${this.accessory.displayName} wasn't able to establish BLE Connection, node-switchbot: ${switchbot}`);
     if (this.platform.config.credentials?.openToken) {
       this.warnLog(`Motion Sensor: ${this.accessory.displayName} Using OpenAPI Connection`);
+      this.SwitchToOpenAPI = true;
       await this.openAPIRefreshStatus();
     }
   }
@@ -400,6 +385,11 @@ export class Motion {
       try {
         this.deviceStatus = (await this.platform.axios.get(`${DeviceURL}/${this.device.deviceId}/status`)).data;
         this.debugLog(`Motion Sensor: ${this.accessory.displayName} refreshStatus: ${JSON.stringify(this.deviceStatus)}`);
+        if (this.deviceStatus.body.moveDetected === undefined) {
+          this.errorLog(`Motion Sensor: ${this.accessory.displayName} refreshStatus: ${JSON.stringify(this.deviceStatus)}`);
+        }
+        this.moveDetected = this.deviceStatus.body.moveDetected;
+        this.brightness = this.deviceStatus.body.brightness;
         this.parseStatus();
         this.updateHomeKitCharacteristics();
       } catch (e: any) {

package/src/platform.ts

@@ -192,8 +192,21 @@ export class SwitchBotPlatform implements DynamicPlatformPlugin {
     }
   }
 
+  connectBLE() {
+    let Switchbot: new () => any;
+    let switchbot: any;
+    try {
+      Switchbot = require('node-switchbot');
+      switchbot = new Switchbot();
+    } catch (e) {
+      switchbot = false;
+      this.errorLog(`Was 'node-switchbot' found: ${switchbot}`);
+    }
+    return switchbot;
+  }
+
   /**
- * this method discovers the Locations
+ * this method discovers devices
  */
   async discoverDevices() {
     try {