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

package/src/devices/motion.ts

@@ -17,9 +17,9 @@ export class Motion {
 
   // Characteristic Values
   MotionDetected!: CharacteristicValue;
+  CurrentAmbientLightLevel!: CharacteristicValue;
   BatteryLevel?: CharacteristicValue;
   StatusLowBattery?: CharacteristicValue;
-  CurrentAmbientLightLevel?: CharacteristicValue;
 
   // OpenAPI Others
   deviceStatus!: deviceStatusResponse;
@@ -27,12 +27,15 @@ export class Motion {
   // BLE Others
   connected?: boolean;
   switchbot!: switchbot;
+  SwitchToOpenAPI?: boolean;
   serviceData!: serviceData;
   battery!: serviceData['battery'];
   movement!: serviceData['movement'];
   lightLevel!: serviceData['lightLevel'];
 
   // Config
+  set_minLux!: number;
+  set_maxLux!: number;
   scanDuration!: number;
   deviceLogging!: string;
   deviceRefreshRate!: number;
@@ -40,6 +43,8 @@ export class Motion {
   // Updates
   motionUbpdateInProgress!: boolean;
   doMotionUpdate!: Subject<void>;
+  moveDetected: boolean | undefined;
+  brightness: string | number | undefined;
 
   constructor(
     private readonly platform: SwitchBotPlatform,
@@ -52,6 +57,11 @@ export class Motion {
     this.refreshRate();
     this.MotionDetected = false;
 
+    // Motion Config
+    this.debugLog(`Motion Sensor: ${this.accessory.displayName} Config: (ble: ${device.ble}, offline: ${device.offline},`
+      + ` hide_lightsensor: ${device.motion?.hide_lightsensor},`
+      + ` set_minLux: ${this.device.motion?.set_minLux}, set_maxLux: ${this.device.motion?.set_maxLux})`);
+
     // this is subject we use to track when we need to POST changes to the SwitchBot API
     this.doMotionUpdate = new Subject();
     this.motionUbpdateInProgress = false;
@@ -72,21 +82,6 @@ export class Motion {
       accessory.getService(this.platform.Service.MotionSensor) ||
       accessory.addService(this.platform.Service.MotionSensor)), `${accessory.displayName} Motion Sensor`;
 
-    if (device.ble) {
-      (this.lightSensorService =
-        accessory.getService(this.platform.Service.LightSensor) ||
-        accessory.addService(this.platform.Service.LightSensor)), `${accessory.displayName} Light Sensor`;
-
-      this.lightSensorService.setCharacteristic(this.platform.Characteristic.Name, `${accessory.displayName} Light Sensor`);
-
-
-      (this.batteryService =
-        accessory.getService(this.platform.Service.Battery) ||
-        accessory.addService(this.platform.Service.Battery)), `${accessory.displayName} Battery`;
-
-      this.batteryService.setCharacteristic(this.platform.Characteristic.Name, `${accessory.displayName} Battery`);
-    }
-
     // To avoid "Cannot add a Service with the same UUID another Service without also defining a unique 'subtype' property." error,
     // when creating multiple services of the same type, you need to use the following syntax to specify a name and subtype id:
     // accessory.getService('NAME') ?? accessory.addService(this.platform.Service.Motion, 'NAME', 'USER_DEFINED_SUBTYPE');
@@ -98,8 +93,39 @@ export class Motion {
     // each service must implement at-minimum the "required characteristics" for the given service type
     // see https://developers.homebridge.io/#/service/MotionSensor
 
-    // create handlers for required characteristics
-    //this.service.setCharacteristic(this.platform.Characteristic.ChargingState, 2);
+    // Light Sensor Service
+    if (device.motion?.hide_lightsensor) {
+      this.debugLog(`Motion Sensor: ${accessory.displayName} Removing Light Sensor Service`);
+      this.lightSensorService = this.accessory.getService(this.platform.Service.LightSensor);
+      accessory.removeService(this.lightSensorService!);
+    } else if (!this.lightSensorService) {
+      this.debugLog(`Motion Sensor: ${accessory.displayName} Add Light Sensor Service`);
+      (this.lightSensorService =
+        this.accessory.getService(this.platform.Service.LightSensor) ||
+        this.accessory.addService(this.platform.Service.LightSensor)), `${accessory.displayName} Light Sensor`;
+
+      this.lightSensorService.setCharacteristic(this.platform.Characteristic.Name, `${accessory.displayName} Light Sensor`);
+
+    } else {
+      this.debugLog(`Motion Sensor: ${accessory.displayName} Light Sensor Service Not Added`);
+    }
+
+    // Battery Service
+    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 =
+        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
     this.updateHomeKitCharacteristics();
@@ -159,59 +185,92 @@ export class Motion {
     }
   }
 
+  private minLux(): number {
+    if (this.device.motion?.set_minLux) {
+      this.set_minLux = this.device.motion!.set_minLux!;
+    } else {
+      this.set_minLux = 1;
+    }
+    return this.set_minLux;
+  }
+
+  private maxLux(): number {
+    if (this.device.motion?.set_maxLux) {
+      this.set_maxLux = this.device.motion!.set_maxLux!;
+    } else {
+      this.set_maxLux = 6001;
+    }
+    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(`Motion Sensor: ${this.accessory.displayName} BLE parseStatus`);
-    this.MotionDetected = Boolean(this.movement);
+    // Movement
+    this.MotionDetected = this.movement!;
     this.debugLog(`Motion Sensor: ${this.accessory.displayName} MotionDetected: ${this.MotionDetected}`);
     // Light Level
-    switch (this.lightLevel) {
-      case 'dark':
-      case 0:
-        this.CurrentAmbientLightLevel = 0.0001;
-        break;
-      default:
-        this.CurrentAmbientLightLevel = 100000;
+    if (!this.device.motion?.hide_lightsensor) {
+      this.set_minLux = this.minLux();
+      this.set_maxLux = this.maxLux();
+      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
-    this.BatteryLevel = Number(this.battery);
+    if (this.battery === undefined) {
+      this.battery = 100;
+    }
+    this.BatteryLevel = 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(`Motion Sensor: ${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel}, StatusLowBattery: ${this.StatusLowBattery}`);
   }
 
   private async openAPIparseStatus() {
-    try {
-      if (this.platform.config.credentials?.openToken) {
-        this.debugLog(`Motion Sensor: ${this.accessory.displayName} OpenAPI parseStatus`);
-        if (typeof this.deviceStatus.body.moveDetected === 'boolean') {
-          this.MotionDetected = this.deviceStatus.body.moveDetected;
+    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.MotionDetected = this.moveDetected!;
+      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();
+        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} MotionDetected: ${this.MotionDetected}`);
-      }
-    } catch (e: any) {
-      this.errorLog(`Motion Sensor: ${this.accessory.displayName} failed parseStatus with OpenAPI Connection`);
-      if (this.deviceLogging === 'debug') {
-        this.errorLog(`Motion Sensor: ${this.accessory.displayName} failed parseStatus with OpenAPI Connection,`
-          + ` Error Message: ${JSON.stringify(e.message)}`);
-      }
-      if (this.platform.debugMode) {
-        this.errorLog(`Motion Sensor: ${this.accessory.displayName} failed parseStatus with OpenAPI Connection,`
-          + ` Error: ${JSON.stringify(e)}`);
+        this.debugLog(`Motion Sensor: ${this.accessory.displayName} CurrentAmbientLightLevel: ${this.CurrentAmbientLightLevel}`);
+
       }
-      this.apiError(e);
     }
   }
 
@@ -301,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);
@@ -314,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();
     }
   }
@@ -324,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 {

package/src/settings.ts

@@ -48,6 +48,7 @@ export interface devicesConfig extends device {
   humidifier?: humidifier;
   curtain?: curtain;
   contact?: contact;
+  motion?: motion;
   colorbulb?: colorbulb;
   ble?: string;
   scanDuration?: number;
@@ -89,6 +90,12 @@ export type contact = {
   hide_motionsensor?: boolean;
 };
 
+export type motion = {
+  hide_lightsensor?: boolean;
+  set_minLux?: number;
+  set_maxLux?: number;
+};
+
 export type colorbulb = {
   set_minStep?: number;
   adaptiveLightingShift?: number;