@switchbot/homebridge-switchbot 0.1.2-beta.0 → 0.1.2-beta.12

package/src/devices/contact.ts

@@ -1,4 +1,4 @@
-import { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
+import { Service, PlatformAccessory, CharacteristicValue, MacAddress } from 'homebridge';
 import { SwitchBotPlatform } from '../platform';
 import { interval, Subject } from 'rxjs';
 import { skipWhile } from 'rxjs/operators';
@@ -10,13 +10,32 @@ import { DeviceURL, device, deviceStatusResponse } from '../settings';
  * Each accessory may expose multiple services of different service types.
  */
 export class Contact {
+  // Services
   private service: Service;
-  temperatureservice?: Service;
-  humidityservice?: Service;
+  motionService: Service;
 
+  // Characteristic Values
   ContactSensorState!: CharacteristicValue;
-  deviceStatus!: deviceStatusResponse;
+  MotionDetected!: CharacteristicValue;
 
+  // Others
+  deviceStatus!: deviceStatusResponse;
+  switchbot!: {
+    discover: (
+      arg0:
+        {
+          duration: any;
+          model: string;
+          quick: boolean;
+          id: MacAddress;
+        }
+    ) => Promise<any>;
+    wait: (
+      arg0: number
+    ) => any;
+  };
+
+  // Updates
   contactUbpdateInProgress!: boolean;
   doContactUpdate;
 
@@ -27,7 +46,17 @@ export class Contact {
   ) {
     // default placeholders
     this.ContactSensorState = this.platform.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED;
-
+    if (this.platform.config.options?.ble?.includes(this.device.deviceId!)) {
+      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      const SwitchBot = require('node-switchbot');
+      this.switchbot = new SwitchBot();
+      const colon = device.deviceId!.match(/.{1,2}/g);
+      const bleMac = colon!.join(':'); //returns 1A:23:B4:56:78:9A;
+      this.device.bleMac = bleMac.toLowerCase();
+      if (this.platform.config.options.debug === 'device') {
+        this.platform.debug(this.device.bleMac.toLowerCase());
+      }
+    }
     // this is subject we use to track when we need to POST changes to the SwitchBot API
     this.doContactUpdate = new Subject();
     this.contactUbpdateInProgress = false;
@@ -39,14 +68,14 @@ export class Contact {
     accessory
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
-      .setCharacteristic(this.platform.Characteristic.Model, 'SWITCHBOT-CONTACT-')
+      .setCharacteristic(this.platform.Characteristic.Model, 'SWITCHBOT-CONTACT-W1201500')
       .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId);
 
     // get the Battery service if it exists, otherwise create a new Contact service
     // you can create multiple services for each accessory
     (this.service =
       accessory.getService(this.platform.Service.ContactSensor) ||
-      accessory.addService(this.platform.Service.ContactSensor)), '%s %s', device.deviceName, device.deviceType;
+      accessory.addService(this.platform.Service.ContactSensor)), `${device.deviceName} ${device.deviceType}`;
 
     // 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:
@@ -57,7 +86,10 @@ 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/ContactSensor
+    // see https://developers.homebridge.io/#/service/MotionSensor
+    (this.motionService =
+      accessory.getService(this.platform.Service.MotionSensor) ||
+      accessory.addService(this.platform.Service.MotionSensor)), `${device.deviceName} ${device.deviceType}`;
 
     // create handlers for required characteristics
     //this.service.setCharacteristic(this.platform.Characteristic.ChargingState, 2);
@@ -83,12 +115,69 @@ export class Contact {
     } else {
       this.ContactSensorState = this.platform.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED;
     }
+    this.MotionDetected = Boolean(this.deviceStatus.body.moveDetected);
+    this.platform.debug(`${this.accessory.displayName}
+    , ContactSensorState: ${this.ContactSensorState}, MotionDetected: ${this.MotionDetected}`);
   }
 
   /**
    * Asks the SwitchBot API for the latest device information
    */
   async refreshStatus() {
+    if (this.platform.config.options?.ble?.includes(this.device.deviceId!)) {
+      this.platform.debug('Contact BLE Device RefreshStatus');
+      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      const Switchbot = require('node-switchbot');
+      const switchbot = new Switchbot();
+      const colon = this.device.deviceId!.match(/.{1,2}/g);
+      const bleMac = colon!.join(':'); //returns 1A:23:B4:56:78:9A;
+      this.device.bleMac = bleMac.toLowerCase();
+      if (this.platform.config.options.debug === 'device') {
+        this.platform.debug(this.device.bleMac!);
+      }
+      switchbot.onadvertisement = (ad: any) => {
+        this.platform.log.info(JSON.stringify(ad, null, '  '));
+        this.platform.log.warn('ad:', JSON.stringify(ad));
+      };
+      switchbot
+        .startScan({
+          id: this.device.bleMac,
+        })
+        .then(() => {
+          return switchbot.wait(this.platform.config.options!.refreshRate! * 1000);
+        })
+        .then(() => {
+          switchbot.stopScan();
+        })
+        .catch(async (error: any) => {
+          this.platform.log.error(error);
+          await this.openAPIRefreshStatus();
+        });
+      setInterval(() => {
+        this.platform.log.info('Start scan ' + this.device.deviceName + '(' + this.device.bleMac + ')');
+        switchbot
+          .startScan({
+            mode: 'D',
+            id: bleMac,
+          })
+          .then(() => {
+            return switchbot.wait(this.platform.config.options!.refreshRate! * 1000);
+          })
+          .then(() => {
+            switchbot.stopScan();
+            this.platform.log.info('Stop scan ' + this.device.deviceName + '(' + this.device.bleMac + ')');
+          })
+          .catch(async (error: any) => {
+            this.platform.log.error(error);
+            await this.openAPIRefreshStatus();
+          });
+      }, this.platform.config.options!.refreshRate! * 60000);
+    } else {
+      await this.openAPIRefreshStatus();
+    }
+  }
+
+  private async openAPIRefreshStatus() {
     try {
       const deviceStatus: deviceStatusResponse = (
         await this.platform.axios.get(`${DeviceURL}/${this.device.deviceId}/status`)
@@ -105,8 +194,7 @@ export class Contact {
         'Contact - Failed to update status of',
         this.device.deviceName,
         JSON.stringify(e.message),
-        this.platform.debug(`Contact ${this.accessory.displayName} - ${JSON.stringify(e)}`),
-      );
+        this.platform.debug(`Contact ${this.accessory.displayName} - ${JSON.stringify(e)}`));
       this.apiError(e);
     }
   }
@@ -118,9 +206,13 @@ export class Contact {
     if (this.ContactSensorState !== undefined) {
       this.service.updateCharacteristic(this.platform.Characteristic.ContactSensorState, this.ContactSensorState);
     }
+    if (this.MotionDetected !== undefined) {
+      this.motionService.updateCharacteristic(this.platform.Characteristic.MotionDetected, this.MotionDetected);
+    }
   }
 
   public apiError(e: any) {
     this.service.updateCharacteristic(this.platform.Characteristic.ContactSensorState, e);
+    this.motionService.updateCharacteristic(this.platform.Characteristic.MotionDetected, e);
   }
 }

package/src/devices/curtains.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-var-requires */
-import { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
+import { Service, PlatformAccessory, CharacteristicValue, MacAddress } from 'homebridge';
 import { SwitchBotPlatform } from '../platform';
 import { interval, Subject } from 'rxjs';
 import { debounceTime, skipWhile, tap } from 'rxjs/operators';
@@ -7,31 +7,51 @@ import { DeviceURL, device, deviceStatusResponse } from '../settings';
 import { AxiosResponse } from 'axios';
 
 export class Curtain {
+  // Services
   private service: Service;
+  private lightSensorService: Service;
 
+  // Characteristic Values
   CurrentPosition!: CharacteristicValue;
   PositionState!: CharacteristicValue;
   TargetPosition!: CharacteristicValue;
-  deviceStatus!: deviceStatusResponse;
-  setNewTarget!: boolean;
-  setNewTargetTimer!: NodeJS.Timeout;
+  CurrentAmbientLightLevel!: CharacteristicValue;
 
-  curtainUpdateInProgress!: boolean;
-  doCurtainUpdate;
-  switchbot;
+  // Others
+  deviceStatus!: deviceStatusResponse;
   moveTimer!: NodeJS.Timeout;
+  ScanIntervalId!: NodeJS.Timeout;
+  setNewTargetTimer!: NodeJS.Timeout;
+  AutoDisableFastScanTimeoutId!: NodeJS.Timeout;
+  setNewTarget!: boolean;
   moveTime!: number;
   ScanDuration: any;
   ReverseDir: any;
   FastScanEnabled!: boolean;
-  ScanIntervalId!: NodeJS.Timeout;
   FastScanInterval!: number;
   SlowScanInterval!: number;
   OpenCloseThreshold: any;
   PreviousPosition: any;
   Position: any;
-  AutoDisableFastScanTimeoutId;
   FastScanDuration: number | undefined;
+  switchbot!: {
+    discover: (
+      arg0:
+        {
+          duration: any;
+          model: string;
+          quick: boolean;
+          id: MacAddress;
+        }
+    ) => Promise<any>;
+    wait: (
+      arg0: number
+    ) => any;
+  };
+
+  // Updates
+  curtainUpdateInProgress!: boolean;
+  doCurtainUpdate;
 
   constructor(
     private readonly platform: SwitchBotPlatform,
@@ -51,8 +71,8 @@ export class Curtain {
       const colon = device.deviceId!.match(/.{1,2}/g);
       const bleMac = colon!.join(':'); //returns 1A:23:B4:56:78:9A;
       this.device.bleMac = bleMac.toLowerCase();
-      if (this.platform.config.options.debug) {
-        this.platform.log.warn(this.device.bleMac.toLowerCase());
+      if (this.platform.config.options.debug === 'device') {
+        this.platform.debug(this.device.bleMac.toLowerCase());
       }
     }
 
@@ -75,7 +95,7 @@ export class Curtain {
     // you can create multiple services for each accessory
     (this.service =
       accessory.getService(this.platform.Service.WindowCovering) ||
-      accessory.addService(this.platform.Service.WindowCovering)), '%s %s', device.deviceName, device.deviceType;
+      accessory.addService(this.platform.Service.WindowCovering)), `${device.deviceName} ${device.deviceType}`;
 
     // 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:
@@ -111,6 +131,21 @@ export class Curtain {
       })
       .onSet(this.TargetPositionSet.bind(this));
 
+    //set up brightness level from the builtin sensor as light sensor accessory
+    (this.lightSensorService =
+      accessory.getService(this.platform.Service.LightSensor) ||
+      accessory.addService(this.platform.Service.LightSensor)), 'Builtin Lightsensor of %s %s', device.deviceName, device.deviceType;
+    this.lightSensorService.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
+    // handle on / off events using the On characteristic
+    this.lightSensorService.getCharacteristic(this.platform.Characteristic.CurrentAmbientLightLevel).onGet(() => {
+      if (this.CurrentAmbientLightLevel === 'bright') {
+        return 100000;
+      } else {
+        return 0.0001;
+      }
+    });
+
+
     // Update Homekit
     this.updateHomeKitCharacteristics();
 
@@ -187,35 +222,94 @@ export class Curtain {
         }
       }
     }
+    // Brightness
+    switch (this.deviceStatus.body.brightness) {
+      case 'dim':
+        this.CurrentAmbientLightLevel = 0.0001;
+        break;
+      default:
+        this.CurrentAmbientLightLevel = 100000;
+    }
     this.platform.debug(
-      `Curtain ${this.accessory.displayName} CurrentPosition: ${this.CurrentPosition}, 
-      TargetPosition: ${this.TargetPosition}, PositionState: ${this.PositionState}`);
+      `Curtain ${this.accessory.displayName} CurrentPosition: ${this.CurrentPosition}
+      , TargetPosition: ${this.TargetPosition}, PositionState: ${this.PositionState}
+      , CurrentAmbientLightLevel: ${this.CurrentAmbientLightLevel}`);
   }
 
   async refreshStatus() {
     if (this.platform.config.options?.ble?.includes(this.device.deviceId!)) {
-      this.platform.log.warn('BLE DEVICE-1');
+      this.platform.log.warn('BLE DEVICE-REFRESH-1');
+      // eslint-disable-next-line @typescript-eslint/no-var-requires
+      const Switchbot = require('node-switchbot');
+      const switchbot = new Switchbot();
+      const colon = this.device.deviceId!.match(/.{1,2}/g);
+      const bleMac = colon!.join(':'); //returns 1A:23:B4:56:78:9A;
+      this.device.bleMac = bleMac.toLowerCase();
+      if (this.platform.config.options.debug === 'device') {
+        this.platform.debug(this.device.bleMac!);
+      }
+      switchbot.onadvertisement = (ad: any) => {
+        this.platform.log.info(JSON.stringify(ad, null, '  '));
+        this.platform.log.warn('ad:', JSON.stringify(ad));
+      };
+      switchbot
+        .startScan({
+          id: this.device.bleMac,
+        })
+        .then(() => {
+          return switchbot.wait(this.platform.config.options!.refreshRate! * 1000);
+        })
+        .then(() => {
+          switchbot.stopScan();
+        })
+        .catch(async (error: any) => {
+          this.platform.log.error(error);
+          await this.openAPIRefreshStatus();
+        });
+      setInterval(() => {
+        this.platform.log.info('Start scan ' + this.device.deviceName + '(' + this.device.bleMac + ')');
+        switchbot
+          .startScan({
+            mode: 'T',
+            id: bleMac,
+          })
+          .then(() => {
+            return switchbot.wait(this.platform.config.options!.refreshRate! * 1000);
+          })
+          .then(() => {
+            switchbot.stopScan();
+            this.platform.log.info('Stop scan ' + this.device.deviceName + '(' + this.device.bleMac + ')');
+          })
+          .catch(async (error: any) => {
+            this.platform.log.error(error);
+            await this.openAPIRefreshStatus();
+          });
+      }, this.platform.config.options!.refreshRate! * 60000);
     } else {
-      try {
-        this.platform.debug('Curtain - Reading', `${DeviceURL}/${this.device.deviceId}/status`);
-        const deviceStatus: deviceStatusResponse = (
-          await this.platform.axios.get(`${DeviceURL}/${this.device.deviceId}/status`)
-        ).data;
-        if (deviceStatus.message === 'success') {
-          this.deviceStatus = deviceStatus;
-          this.platform.debug(`Curtain ${this.accessory.displayName} refreshStatus - ${JSON.stringify(this.deviceStatus)}`);
-          this.setMinMax();
-          this.parseStatus();
-          this.updateHomeKitCharacteristics();
-        }
-      } catch (e: any) {
-        this.platform.log.error(
-          `Curtain - Failed to refresh status of ${this.device.deviceName}`,
-          JSON.stringify(e.message),
-          this.platform.debug(`Curtain ${this.accessory.displayName} - ${JSON.stringify(e)}`),
-        );
-        this.apiError(e);
+      await this.openAPIRefreshStatus();
+    }
+  }
+
+  private async openAPIRefreshStatus() {
+    try {
+      this.platform.debug('Curtain - Reading', `${DeviceURL}/${this.device.deviceId}/status`);
+      const deviceStatus: deviceStatusResponse = (
+        await this.platform.axios.get(`${DeviceURL}/${this.device.deviceId}/status`)
+      ).data;
+      if (deviceStatus.message === 'success') {
+        this.deviceStatus = deviceStatus;
+        this.platform.debug(`Curtain ${this.accessory.displayName} refreshStatus - ${JSON.stringify(this.deviceStatus)}`);
+        this.setMinMax();
+        this.parseStatus();
+        this.updateHomeKitCharacteristics();
       }
+    } catch (e: any) {
+      this.platform.log.error(
+        `Curtain - Failed to refresh status of ${this.device.deviceName}`,
+        JSON.stringify(e.message),
+        this.platform.debug(`Curtain ${this.accessory.displayName} - ${JSON.stringify(e)}`),
+      );
+      this.apiError(e);
     }
   }
 
@@ -258,7 +352,9 @@ export class Curtain {
         CurrentPosition: this.CurrentPosition,
         PositionState: this.PositionState,
         TargetPosition: this.TargetPosition,
-      })}`);
+        CurrentAmbientLightLevel: this.CurrentAmbientLightLevel,
+      })}`,
+    );
     this.setMinMax();
     if (this.CurrentPosition !== undefined) {
       this.service.updateCharacteristic(this.platform.Characteristic.CurrentPosition, this.CurrentPosition);
@@ -269,12 +365,16 @@ export class Curtain {
     if (this.TargetPosition !== undefined) {
       this.service.updateCharacteristic(this.platform.Characteristic.TargetPosition, this.TargetPosition);
     }
+    if (this.CurrentAmbientLightLevel !== undefined) {
+      this.lightSensorService.updateCharacteristic(this.platform.Characteristic.CurrentAmbientLightLevel, this.CurrentAmbientLightLevel);
+    }
   }
 
   public apiError(e: any) {
     this.service.updateCharacteristic(this.platform.Characteristic.CurrentPosition, e);
     this.service.updateCharacteristic(this.platform.Characteristic.PositionState, e);
     this.service.updateCharacteristic(this.platform.Characteristic.TargetPosition, e);
+    this.service.updateCharacteristic(this.platform.Characteristic.CurrentAmbientLightLevel, e);
   }
 
 
@@ -406,7 +506,7 @@ export class Curtain {
    * Ask the device to start moving to the given position (which must be a device value and not an HomeKit value).
    * Returns a Promise that's resolved as soon as the command was sent to the device.
    */
-  public runToPosition(pos: number): Promise<void> {
+  public async runToPosition(pos: number): Promise<void> {
     const SwitchBot = require('node-switchbot');
     const switchbot = new SwitchBot();
 
@@ -533,4 +633,4 @@ export class Curtain {
       }
     }
   }
-}
+}

package/src/devices/humidifiers.ts

@@ -11,9 +11,11 @@ import { AxiosResponse } from 'axios';
  * Each accessory may expose multiple services of different service types.
  */
 export class Humidifier {
+  // Services
   private service: Service;
   temperatureservice?: Service;
 
+  // Characteristic Values
   CurrentRelativeHumidity!: CharacteristicValue;
   CurrentTemperature!: CharacteristicValue;
   TargetHumidifierDehumidifierState!: CharacteristicValue;
@@ -21,8 +23,11 @@ export class Humidifier {
   RelativeHumidityHumidifierThreshold!: CharacteristicValue;
   Active!: CharacteristicValue;
   WaterLevel!: CharacteristicValue;
+
+  // Others
   deviceStatus!: deviceStatusResponse;
 
+  // Updates
   humidifierUpdateInProgress!: boolean;
   doHumidifierUpdate;
 
@@ -58,7 +63,7 @@ export class Humidifier {
     // you can create multiple services for each accessory
     (this.service =
       accessory.getService(this.platform.Service.HumidifierDehumidifier) ||
-      accessory.addService(this.platform.Service.HumidifierDehumidifier)), '%s %s', device.deviceName, device.deviceType;
+      accessory.addService(this.platform.Service.HumidifierDehumidifier)), `${device.deviceName} ${device.deviceType}`;
 
     // 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:
@@ -102,18 +107,18 @@ export class Humidifier {
     // create a new Temperature Sensor service
     // Temperature Sensor Service
     if (this.platform.config.options?.humidifier?.hide_temperature) {
-      if (this.platform.config.options.debug) {
+      if (this.platform.config.options.debug === 'device') {
         this.platform.log.error('Removing service');
       }
       this.temperatureservice = this.accessory.getService(this.platform.Service.TemperatureSensor);
       accessory.removeService(this.temperatureservice!);
     } else if (!this.temperatureservice) {
-      if (this.platform.config.options?.debug) {
+      if (this.platform.config.options?.debug === 'device') {
         this.platform.log.warn('Adding service');
       }
       (this.temperatureservice =
         this.accessory.getService(this.platform.Service.TemperatureSensor) ||
-        this.accessory.addService(this.platform.Service.TemperatureSensor)), '%s %s TemperatureSensor', device.deviceName, device.deviceType;
+        this.accessory.addService(this.platform.Service.TemperatureSensor)), `${device.deviceName} ${device.deviceType} TemperatureSensor`;
 
       this.temperatureservice
         .getCharacteristic(this.platform.Characteristic.CurrentTemperature)