@switchbot/homebridge-switchbot 1.7.1-beta.0 → 1.7.1-beta.4

package/src/devices/bots.ts

@@ -38,6 +38,7 @@ export class Bot {
   // BLE Others
   connected?: boolean;
   switchbot!: switchbot;
+  SwitchToOpenAPI?: boolean;
   serviceData!: serviceData;
   mode!: serviceData['mode'];
   state!: serviceData['state'];
@@ -317,12 +318,21 @@ export class Bot {
       this.outletService.getCharacteristic(this.platform.Characteristic.On).onSet(this.handleOnSet.bind(this));
     }
 
-    if (device.ble) {
+    // Battery Service
+    if (!device.ble) {
+      this.debugLog(`Bot: ${accessory.displayName} Removing Battery Service`);
+      this.batteryService = this.accessory.getService(this.platform.Service.Battery);
+      accessory.removeService(this.batteryService!);
+    } else if (!this.batteryService) {
+      this.debugLog(`Bot: ${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(`Bot: ${accessory.displayName} Battery Service Not Added`);
     }
 
     // Retrieve initial values and updateHomekit
@@ -523,10 +533,10 @@ export class Bot {
    * 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();
     }
   }
 
@@ -560,6 +570,9 @@ export class Bot {
   }
 
   private async openAPIparseStatus() {
+    if (this.device.ble) {
+      this.SwitchToOpenAPI = false;
+    }
     if (this.platform.config.credentials?.openToken) {
       this.debugLog(`Bot: ${this.accessory.displayName} OpenAPI parseStatus`);
       if (this.botMode === 'press') {
@@ -664,6 +677,7 @@ export class Bot {
         this.errorLog(`Bot: ${this.accessory.displayName} wasn't able to establish BLE Connection`);
         if (this.platform.config.credentials?.openToken) {
           this.warnLog(`Bot: ${this.accessory.displayName} Using OpenAPI Connection`);
+          this.SwitchToOpenAPI = true;
           await this.openAPIRefreshStatus();
         }
       }
@@ -679,6 +693,7 @@ export class Bot {
       }
       if (this.platform.config.credentials?.openToken) {
         this.warnLog(`Bot: ${this.accessory.displayName} Using OpenAPI Connection`);
+        this.SwitchToOpenAPI = true;
         await this.openAPIRefreshStatus();
       }
       this.apiError(e);

package/src/devices/contact.ts

@@ -29,6 +29,7 @@ export class Contact {
   // BLE Others
   connected?: boolean;
   switchbot!: switchbot;
+  SwitchToOpenAPI!: boolean;
   serviceData!: serviceData;
   battery!: serviceData['battery'];
   movement!: serviceData['movement'];
@@ -38,7 +39,6 @@ export class Contact {
   // Config
   set_minLux!: number;
   set_maxLux!: number;
-  spaceBetweenLevels!: number;
   scanDuration!: number;
   deviceLogging!: string;
   deviceRefreshRate!: number;
@@ -60,8 +60,8 @@ export class Contact {
 
     // Contact Config
     this.debugLog(`Contact Sensor: ${this.accessory.displayName} Config: (ble: ${device.ble}, offline: ${device.offline},`
-      + ` hide_lightsensor: ${device.contact?.hide_lightsensor}, hide_motionsensor: ${device.contact?.hide_motionsensor})`);
-
+      + ` hide_lightsensor: ${device.contact?.hide_lightsensor}, hide_motionsensor: ${device.contact?.hide_motionsensor},`
+      + ` set_minLux: ${this.device.contact?.set_minLux}, set_maxLux: ${this.device.contact?.set_maxLux})`);
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
     this.doContactUpdate = new Subject();
@@ -92,7 +92,7 @@ export class Contact {
     this.service.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
 
     // each service must implement at-minimum the "required characteristics" for the given service type
-    // see https://developers.homebridge.io/#/service/MotionSensor
+    // see https://developers.homebridge.io/#/service/ContactSensor
 
     // Motion Sensor Service
     if (device.contact?.hide_motionsensor) {
@@ -128,12 +128,21 @@ export class Contact {
       this.debugLog(`Contact Sensor: ${accessory.displayName} Light Sensor Service Not Added`);
     }
 
-    if (device.ble) {
+    // Battery Service
+    if (!device.ble) {
+      this.debugLog(`Contact 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(`Contact 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(`Contact Sensor: ${accessory.displayName} Battery Service Not Added`);
     }
 
     // Retrieve initial values and updateHomekit
@@ -195,7 +204,7 @@ export class Contact {
   }
 
   private minLux(): number {
-    if (this.device.curtain?.set_minLux) {
+    if (this.device.contact?.set_minLux) {
       this.set_minLux = this.device.contact!.set_minLux!;
     } else {
       this.set_minLux = 1;
@@ -204,7 +213,7 @@ export class Contact {
   }
 
   private maxLux(): number {
-    if (this.device.curtain?.set_maxLux) {
+    if (this.device.contact?.set_maxLux) {
       this.set_maxLux = this.device.contact!.set_maxLux!;
     } else {
       this.set_maxLux = 6001;
@@ -216,19 +225,15 @@ export class Contact {
    * 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(`Contact Sensor: ${this.accessory.displayName} BLE parseStatus`);
-    if (!this.device.contact?.hide_motionsensor) {
-      // Movement
-      this.MotionDetected = Boolean(this.movement);
-    }
     // Door State
     switch (this.doorState) {
       case 'open':
@@ -242,90 +247,46 @@ export class Contact {
       default:
         this.errorLog(`Contact Sensor: ${this.accessory.displayName} timeout no closed, doorstate: ${this.doorState}`);
     }
-    // Light Level
-    if (!this.device.contact?.hide_lightsensor) {
-      switch (this.lightLevel) {
-        case 'dark':
-        case 0:
-          this.CurrentAmbientLightLevel = 0.0001;
-          break;
-        default:
-          this.CurrentAmbientLightLevel = 100000;
-      }
+    // Movement
+    if (!this.device.contact?.hide_motionsensor) {
+      this.MotionDetected = Boolean(this.movement);
+      this.debugLog(`Contact Sensor: ${this.accessory.displayName} MotionDetected: ${this.MotionDetected}`);
     }
-
-    /*
     // Light Level
     if (!this.device.contact?.hide_lightsensor) {
       this.set_minLux = this.minLux();
       this.set_maxLux = this.maxLux();
-      this.spaceBetweenLevels = 9;
-
-      //
       switch (this.lightLevel) {
-        case 1:
+        case 'dark':
+        case 0:
           this.CurrentAmbientLightLevel = this.set_minLux;
-          this.debugLog(`Curtain: ${this.accessory.displayName} LightLevel: ${this.lightLevel}`);
-          break;
-        case 2:
-          this.CurrentAmbientLightLevel = ((this.set_maxLux - this.set_minLux) / this.spaceBetweenLevels);
-          this.debugLog(`Curtain: ${this.accessory.displayName} LightLevel: ${this.lightLevel},`
-            + ` Calculation: ${((this.set_maxLux - this.set_minLux) / this.spaceBetweenLevels)}`);
-          break;
-        case 3:
-          this.CurrentAmbientLightLevel = (((this.set_maxLux - this.set_minLux) / this.spaceBetweenLevels) * 2);
-          this.debugLog(`Curtain: ${this.accessory.displayName} LightLevel: ${this.lightLevel}`);
-          break;
-        case 4:
-          this.CurrentAmbientLightLevel = (((this.set_maxLux - this.set_minLux) / this.spaceBetweenLevels) * 3);
-          this.debugLog(`Curtain: ${this.accessory.displayName} LightLevel: ${this.lightLevel}`);
           break;
-        case 5:
-          this.CurrentAmbientLightLevel = (((this.set_maxLux - this.set_minLux) / this.spaceBetweenLevels) * 4);
-          this.debugLog(`Curtain: ${this.accessory.displayName} LightLevel: ${this.lightLevel}`);
-          break;
-        case 6:
-          this.CurrentAmbientLightLevel = (((this.set_maxLux - this.set_minLux) / this.spaceBetweenLevels) * 5);
-          this.debugLog(`Curtain: ${this.accessory.displayName} LightLevel: ${this.lightLevel}`);
-          break;
-        case 7:
-          this.CurrentAmbientLightLevel = (((this.set_maxLux - this.set_minLux) / this.spaceBetweenLevels) * 6);
-          this.debugLog(`Curtain: ${this.accessory.displayName} LightLevel: ${this.lightLevel}`);
-          break;
-        case 8:
-          this.CurrentAmbientLightLevel = (((this.set_maxLux - this.set_minLux) / this.spaceBetweenLevels) * 7);
-          this.debugLog(`Curtain: ${this.accessory.displayName} LightLevel: ${this.lightLevel}`);
-          break;
-        case 9:
-          this.CurrentAmbientLightLevel = (((this.set_maxLux - this.set_minLux) / this.spaceBetweenLevels) * 8);
-          this.debugLog(`Curtain: ${this.accessory.displayName} LightLevel: ${this.lightLevel}`);
-          break;
-        case 10:
         default:
           this.CurrentAmbientLightLevel = this.set_maxLux;
-          this.debugLog();
       }
-      this.debugLog(`Curtain: ${this.accessory.displayName} LightLevel: ${this.lightLevel},`
+      this.debugLog(`Contact Sensor: ${this.accessory.displayName} LightLevel: ${this.lightLevel},`
         + ` CurrentAmbientLightLevel: ${this.CurrentAmbientLightLevel}`);
-    }*/
-
-
+    }
     // Battery
+    if (this.battery === undefined) {
+      this.battery === 100;
+    }
     this.BatteryLevel = Number(this.battery);
     if (this.BatteryLevel < 10) {
       this.StatusLowBattery = this.platform.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW;
     } else {
       this.StatusLowBattery = this.platform.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
     }
-
-    this.debugLog(`Contact Sensor: ${this.accessory.displayName} ContactSensorState: ${this.ContactSensorState}, MotionDetected: `
-      + `${this.MotionDetected}, CurrentAmbientLightLevel: ${this.CurrentAmbientLightLevel}, BatteryLevel: ${this.BatteryLevel}`);
+    this.debugLog(`Contact Sensor: ${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel}, StatusLowBattery: ${this.StatusLowBattery}`);
   }
 
   private async openAPIparseStatus() {
+    if (this.device.ble) {
+      this.SwitchToOpenAPI = false;
+    }
     if (this.platform.config.credentials?.openToken) {
-      // Contact State
       this.debugLog(`Contact Sensor: ${this.accessory.displayName} OpenAPI parseStatus`);
+      // Contact State
       if (this.deviceStatus.body.openState === 'open') {
         this.ContactSensorState = this.platform.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED;
         this.debugLog(`Contact Sensor: ${this.accessory.displayName} ContactSensorState: ${this.ContactSensorState}`);
@@ -337,14 +298,15 @@ export class Contact {
       }
       // Motion State
       if (!this.device.contact?.hide_motionsensor) {
-        this.MotionDetected = Boolean(this.deviceStatus.body.moveDetected);
+        if (typeof this.deviceStatus.body.moveDetected === 'boolean') {
+          this.MotionDetected = this.deviceStatus.body.moveDetected;
+        }
+        this.debugLog(`Contact Sensor: ${this.accessory.displayName} MotionDetected: ${this.MotionDetected}`);
       }
-      this.debugLog(`Contact Sensor: ${this.accessory.displayName} MotionDetected: ${this.MotionDetected}`);
       // Light Level
       if (!this.device.contact?.hide_lightsensor) {
         this.set_minLux = this.minLux();
         this.set_maxLux = this.maxLux();
-        // Brightness
         switch (this.deviceStatus.body.brightness) {
           case 'dim':
             this.CurrentAmbientLightLevel = this.set_minLux;
@@ -449,6 +411,7 @@ export class Contact {
         }
         if (this.platform.config.credentials?.openToken) {
           this.warnLog(`Contact Sensor: ${this.accessory.displayName} Using OpenAPI Connection`);
+          this.SwitchToOpenAPI = true;
           await this.openAPIRefreshStatus();
         }
         this.apiError(e);
@@ -462,6 +425,7 @@ export class Contact {
     this.errorLog(`Contact Sensor: ${this.accessory.displayName} wasn't able to establish BLE Connection, node-switchbot: ${switchbot}`);
     if (this.platform.config.credentials?.openToken) {
       this.warnLog(`Contact Sensor: ${this.accessory.displayName} Using OpenAPI Connection`);
+      this.SwitchToOpenAPI = true;
       await this.openAPIRefreshStatus();
     }
   }

package/src/devices/curtains.ts

@@ -26,11 +26,13 @@ export class Curtain {
   // BLE Others
   connected?: boolean;
   switchbot!: switchbot;
+  SwitchToOpenAPI?: boolean;
   serviceData!: serviceData;
   calibration: serviceData['calibration'];
   battery: serviceData['battery'];
   position: serviceData['position'];
   lightLevel: serviceData['lightLevel'];
+  spaceBetweenLevels!: number;
 
   // Target
   setNewTarget!: boolean;
@@ -44,7 +46,6 @@ export class Curtain {
   scanDuration!: number;
   deviceLogging!: string;
   deviceRefreshRate!: number;
-  spaceBetweenLevels!: number;
 
   // Updates
   curtainUpdateInProgress!: boolean;
@@ -142,6 +143,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 +271,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,11 +298,14 @@ 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();
     }
   }
 
@@ -407,6 +404,9 @@ 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
@@ -468,7 +468,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 +509,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 +525,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 +539,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();
     }
   }
@@ -578,7 +584,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();
     }
   }