@switchbot/homebridge-switchbot 0.2.0-alpha.2 → 1.0.1-beta.2

package/src/devices/{bulb.ts → colorbulb.ts}

@@ -1,15 +1,16 @@
-import { Service, PlatformAccessory, CharacteristicValue, MacAddress } from 'homebridge';
+import { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
 import { SwitchBotPlatform } from '../platform';
 import { interval, Subject } from 'rxjs';
 import { debounceTime, skipWhile, tap } from 'rxjs/operators';
-import { DeviceURL, device, devicesConfig } from '../settings';
+import { DeviceURL, device, devicesConfig, switchbot, deviceStatusResponse } from '../settings';
+import { AxiosResponse } from 'axios';
 
 /**
  * Platform Accessory
  * An instance of this class is created for each accessory your platform registers
  * Each accessory may expose multiple services of different service types.
  */
-export class Bulb {
+export class ColorBulb {
   // Services
   service!: Service;
 
@@ -18,33 +19,27 @@ export class Bulb {
   Brightness!: CharacteristicValue;
   ColorTemperature!: CharacteristicValue;
 
-  // Others
-  deviceStatus: any;
-  switchbot!: {
-    discover: (
-      arg0:
-        {
-          duration: any;
-          model: string;
-          quick: boolean;
-          id: MacAddress;
-        }
-    ) => Promise<any>;
-    wait: (
-      arg0: number
-    ) => any;
-  };
+  // OpenAPI Others
+  deviceStatus!: deviceStatusResponse;
+
+  // BLE Others
+  switchbot!: switchbot;
+
+  // Config
+  set_minStep?: number;
 
   // Updates
-  bulbUpdateInProgress!: boolean;
-  doBulbUpdate;
-  set_minStep: any;
+  colorBulbUpdateInProgress!: boolean;
+  doColorBulbUpdate!: Subject<void>;
 
   constructor(
     private readonly platform: SwitchBotPlatform,
     private accessory: PlatformAccessory,
     public device: device & devicesConfig,
   ) {
+    // ColorBulb Config
+    this.platform.device(`[ColorBulb Config] ble: ${device.ble}, set_minStep: ${device.colorbulb?.set_minStep}`);
+
     // default placeholders
     this.On = false;
     this.Brightness = 0;
@@ -59,8 +54,8 @@ export class Bulb {
     }
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
-    this.doBulbUpdate = new Subject();
-    this.bulbUpdateInProgress = false;
+    this.doColorBulbUpdate = new Subject();
+    this.colorBulbUpdateInProgress = false;
 
 
     // Retrieve initial values and updateHomekit
@@ -70,7 +65,7 @@ export class Bulb {
     accessory
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
-      .setCharacteristic(this.platform.Characteristic.Model, 'SWITCHBOT-BULB-W1401400')
+      .setCharacteristic(this.platform.Characteristic.Model, 'SWITCHBOT-COLORBULB-W1401400')
       .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
 
     // get the Television service if it exists, otherwise create a new Television service
@@ -122,17 +117,17 @@ export class Bulb {
 
     // Start an update interval
     interval(this.platform.config.options!.refreshRate! * 1000)
-      .pipe(skipWhile(() => this.bulbUpdateInProgress))
+      .pipe(skipWhile(() => this.colorBulbUpdateInProgress))
       .subscribe(() => {
         this.refreshStatus();
       });
 
     // Watch for Bulb change events
     // We put in a debounce of 100ms so we don't make duplicate calls
-    this.doBulbUpdate
+    this.doColorBulbUpdate
       .pipe(
         tap(() => {
-          this.bulbUpdateInProgress = true;
+          this.colorBulbUpdateInProgress = true;
         }),
         debounceTime(this.platform.config.options!.pushRate! * 1000),
       )
@@ -141,16 +136,16 @@ export class Bulb {
           await this.pushChanges();
         } catch (e: any) {
           this.platform.log.error(JSON.stringify(e.message));
-          this.platform.debug(`Bulb ${accessory.displayName} - ${JSON.stringify(e)}`);
+          this.platform.debug(`Color Bulb ${accessory.displayName} - ${JSON.stringify(e)}`);
           this.apiError(e);
         }
-        this.bulbUpdateInProgress = false;
+        this.colorBulbUpdateInProgress = false;
       });
   }
 
   private minStep(): number | undefined {
-    if (this.device.bulb?.set_minStep) {
-      this.set_minStep = this.device.bulb?.set_minStep;
+    if (this.device.colorbulb?.set_minStep) {
+      this.set_minStep = this.device.colorbulb?.set_minStep;
     } else {
       this.set_minStep = 1;
     }
@@ -165,21 +160,21 @@ export class Bulb {
       default:
         this.On = false;
     }
-    this.platform.debug(`Bulb ${this.accessory.displayName} On: ${this.On}`);
+    this.platform.debug(`Color Bulb ${this.accessory.displayName} On: ${this.On}`);
     this.deviceStatus.body.brightness = Number(this.Brightness);
     this.deviceStatus.body.colorTemperature = Number(this.ColorTemperature);
   }
 
   async refreshStatus() {
     try {
-      this.platform.debug('Bulb - Reading', `${DeviceURL}/${this.device.deviceId}/status`);
+      this.platform.debug('Color Bulb - Reading', `${DeviceURL}/${this.device.deviceId}/status`);
       this.deviceStatus = (await this.platform.axios.get(`${DeviceURL}/${this.device.deviceId}/status`)).data;
-      this.platform.device(`Bulb ${this.accessory.displayName} refreshStatus: ${JSON.stringify(this.deviceStatus)}`);
+      this.platform.device(`Color Bulb ${this.accessory.displayName} refreshStatus: ${JSON.stringify(this.deviceStatus)}`);
       this.parseStatus();
       this.updateHomeKitCharacteristics();
     } catch (e: any) {
-      this.platform.log.error(`Bulb ${this.accessory.displayName} failed to refresh status, Error Message ${JSON.stringify(e.message)}`);
-      this.platform.debug(`Bulb ${this.accessory.displayName}, Error: ${JSON.stringify(e)}`);
+      this.platform.log.error(`Color Bulb ${this.accessory.displayName} failed to refresh status, Error Message ${JSON.stringify(e.message)}`);
+      this.platform.debug(`Color Bulb ${this.accessory.displayName}, Error: ${JSON.stringify(e)}`);
       this.apiError(e);
     }
   }
@@ -187,8 +182,8 @@ export class Bulb {
   /**
  * Pushes the requested changes to the SwitchBot API
  * deviceType	commandType	  Command	    command parameter	  Description
- * Bulb   -    "command"     "turnOff"   "default"	  =        set to OFF state
- * Bulb   -    "command"     "turnOn"    "default"	  =        set to ON state
+ * Color Bulb   -    "command"     "turnOff"   "default"	  =        set to OFF state
+ * Color Bulb   -    "command"     "turnOn"    "default"	  =        set to ON state
  */
   async pushChanges() {
     const payload = {
@@ -212,32 +207,32 @@ export class Bulb {
       'commandType:',
       payload.commandType,
     );
-    this.platform.debug(`Bulb ${this.accessory.displayName} pushchanges: ${JSON.stringify(payload)}`);
+    this.platform.debug(`Color Bulb ${this.accessory.displayName} pushchanges: ${JSON.stringify(payload)}`);
 
     // Make the API request
     const push: any = (await this.platform.axios.post(`${DeviceURL}/${this.device.deviceId}/commands`, payload));
-    this.platform.debug(`Bulb ${this.accessory.displayName} Changes pushed: ${JSON.stringify(push.data)}`);
+    this.platform.debug(`Color Bulb ${this.accessory.displayName} Changes pushed: ${JSON.stringify(push.data)}`);
     this.statusCode(push);
   }
 
   updateHomeKitCharacteristics() {
     if (this.On === undefined) {
-      this.platform.debug(`Bulb ${this.accessory.displayName} On: ${this.On}`);
+      this.platform.debug(`Color Bulb ${this.accessory.displayName} On: ${this.On}`);
     } else {
       this.service.updateCharacteristic(this.platform.Characteristic.On, this.On);
-      this.platform.device(`Bulb ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
+      this.platform.device(`Color Bulb ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
     }
     if (this.Brightness === undefined) {
-      this.platform.debug(`Bulb ${this.accessory.displayName} Brightness: ${this.Brightness}`);
+      this.platform.debug(`Color Bulb ${this.accessory.displayName} Brightness: ${this.Brightness}`);
     } else {
       this.service.updateCharacteristic(this.platform.Characteristic.Brightness, this.Brightness);
-      this.platform.device(`Bulb ${this.accessory.displayName} updateCharacteristic Brightness: ${this.Brightness}`);
+      this.platform.device(`Color Bulb ${this.accessory.displayName} updateCharacteristic Brightness: ${this.Brightness}`);
     }
     if (this.ColorTemperature === undefined) {
-      this.platform.debug(`Bulb ${this.accessory.displayName} ColorTemperature: ${this.ColorTemperature}`);
+      this.platform.debug(`Color Bulb ${this.accessory.displayName} ColorTemperature: ${this.ColorTemperature}`);
     } else {
       this.service.updateCharacteristic(this.platform.Characteristic.Brightness, this.ColorTemperature);
-      this.platform.debug(`Bulb ${this.accessory.displayName} updateCharacteristic ColorTemperature: ${this.ColorTemperature}`);
+      this.platform.debug(`Color Bulb ${this.accessory.displayName} updateCharacteristic ColorTemperature: ${this.ColorTemperature}`);
     }
   }
 
@@ -248,7 +243,7 @@ export class Bulb {
   }
 
 
-  private statusCode(push: { data: { statusCode: any; }; }) {
+  private statusCode(push: AxiosResponse<{ statusCode: number;}>) {
     switch (push.data.statusCode) {
       case 151:
         this.platform.log.error('Command not supported by this device type.');
@@ -285,7 +280,7 @@ export class Bulb {
     this.platform.debug(`${this.accessory.displayName} - Set On: ${value}`);
 
     this.On = value;
-    this.doBulbUpdate.next();
+    this.doColorBulbUpdate.next();
   }
 
   /**
@@ -295,7 +290,7 @@ export class Bulb {
     this.platform.debug(`${this.accessory.displayName} - Set On: ${value}`);
 
     this.Brightness = value;
-    this.doBulbUpdate.next();
+    this.doColorBulbUpdate.next();
   }
 
   /**
@@ -305,6 +300,6 @@ export class Bulb {
     this.platform.debug(`${this.accessory.displayName} - Set On: ${value}`);
 
     this.ColorTemperature = value;
-    this.doBulbUpdate.next();
+    this.doColorBulbUpdate.next();
   }
 }

package/src/devices/contact.ts

@@ -1,8 +1,8 @@
-import { Service, PlatformAccessory, CharacteristicValue, MacAddress } from 'homebridge';
+import { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
 import { SwitchBotPlatform } from '../platform';
 import { interval, Subject } from 'rxjs';
 import { skipWhile } from 'rxjs/operators';
-import { DeviceURL, device, devicesConfig } from '../settings';
+import { DeviceURL, device, devicesConfig, serviceData, switchbot, deviceStatusResponse } from '../settings';
 
 /**
  * Platform Accessory
@@ -12,34 +12,31 @@ import { DeviceURL, device, devicesConfig } from '../settings';
 export class Contact {
   // Services
   private service: Service;
-  motionService: Service;
+  private motionService: Service;
+  private lightSensorService: Service;
+  private batteryService?: Service;
 
   // Characteristic Values
   ContactSensorState!: CharacteristicValue;
   MotionDetected!: CharacteristicValue;
+  CurrentAmbientLightLevel!: CharacteristicValue;
+  BatteryLevel!: CharacteristicValue;
+  StatusLowBattery!: CharacteristicValue;
 
-  // Others
-  deviceStatus!: any;
-  BLEmotion!: boolean;
-  BLEstate!: boolean;
-  switchbot!: {
-    discover: (
-      arg0:
-        {
-          duration: any;
-          model: string;
-          quick: boolean;
-          id: MacAddress;
-        }
-    ) => Promise<any>;
-    wait: (
-      arg0: number
-    ) => any;
-  };
+  // OpenAPI others
+  deviceStatus!: deviceStatusResponse;
+
+  // BLE Others
+  switchbot!: switchbot;
+  serviceData!: serviceData;
+  battery!: serviceData['battery'];
+  movement!: serviceData['movement'];
+  doorState!: serviceData['doorState'];
+  lightLevel!: serviceData['lightLevel'];
 
   // Updates
   contactUbpdateInProgress!: boolean;
-  doContactUpdate;
+  doContactUpdate!: Subject<void>;
 
   constructor(
     private readonly platform: SwitchBotPlatform,
@@ -74,7 +71,7 @@ export class Contact {
       .setCharacteristic(this.platform.Characteristic.Model, 'SWITCHBOT-WOCONTACT-W1201500')
       .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
 
-    // get the Battery service if it exists, otherwise create a new Contact service
+    // get the Contact 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) ||
@@ -96,6 +93,20 @@ export class Contact {
 
     this.motionService.setCharacteristic(this.platform.Characteristic.Name, `${accessory.displayName} Motion Sensor`);
 
+    (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`);
+
+    if (device.ble) {
+      (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`);
+    }
+
     // Retrieve initial values and updateHomekit
     this.updateHomeKitCharacteristics();
 
@@ -121,10 +132,41 @@ export class Contact {
   }
 
   private async BLEparseStatus() {
-    this.MotionDetected = Boolean(this.BLEmotion);
-    this.ContactSensorState = Boolean(this.BLEstate);
-    this.platform.debug(`${this.accessory.displayName}
-    , ContactSensorState: ${this.ContactSensorState}, MotionDetected: ${this.MotionDetected}`);
+    this.platform.debug('Contact BLE Device parseStatus');
+    // Movement
+    this.MotionDetected = Boolean(this.movement);
+    // Door State
+    switch (this.doorState) {
+      case 'open':
+      case 1:
+        this.ContactSensorState = this.platform.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED;
+        break;
+      case 'close':
+      case 0:
+        this.ContactSensorState = this.platform.Characteristic.ContactSensorState.CONTACT_DETECTED;
+        break;
+      default:
+        this.platform.log.error('timeout no closed');
+    }
+    // Light Level
+    switch (this.lightLevel) {
+      case 'dark':
+      case 0:
+        this.CurrentAmbientLightLevel = 0.0001;
+        break;
+      default:
+        this.CurrentAmbientLightLevel = 100000;
+    }
+    // Battery
+    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.platform.debug(`${this.accessory.displayName}, ContactSensorState: ${this.ContactSensorState}, MotionDetected: ${this.MotionDetected}`
+      + `CurrentAmbientLightLevel: ${this.CurrentAmbientLightLevel}, BatteryLevel: ${this.BatteryLevel}`);
   }
 
   private async openAPIparseStatus() {
@@ -155,8 +197,7 @@ export class Contact {
     }
   }
 
-  private async BLERefreshStatus() {
-    this.platform.debug('Contact BLE Device RefreshStatus');
+  private connectBLE() {
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     const Switchbot = require('node-switchbot');
     const switchbot = new Switchbot();
@@ -164,47 +205,41 @@ export class Contact {
     const bleMac = colon!.join(':'); //returns 1A:23:B4:56:78:9A;
     this.device.bleMac = bleMac.toLowerCase();
     this.platform.device(this.device.bleMac!);
-    switchbot.onadvertisement = (ad: any) => {
-      this.platform.log.info(JSON.stringify(ad, null, '  '));
-      this.platform.device('ad:', JSON.stringify(ad));
-      this.BLEmotion = ad.serviceData.motion;
-      this.BLEstate = ad.serviceData.state;
-    };
-    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();
-        });
+    return switchbot;
+  }
+
+  private async BLERefreshStatus() {
+    this.platform.debug('Contact BLE Device RefreshStatus');
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const switchbot = this.connectBLE();
+    // Start to monitor advertisement packets
+    switchbot.startScan({
+      model: 'd',
+      id: this.device.bleMac,
+    }).then(() => {
+      // Set an event hander
+      switchbot.onadvertisement = (ad: any) => {
+        this.serviceData = ad.serviceData;
+        this.platform.device(`${this.device.bleMac}: ${JSON.stringify(ad.serviceData)}`);
+        this.movement = ad.serviceData.movement;
+        this.doorState = ad.serviceData.doorState;
+        this.lightLevel = ad.serviceData.lightLevel;
+        this.battery = ad.serviceData.battery;
+        this.platform.device(`${this.accessory.displayName}, Movement: ${ad.serviceData.movement}, Door State: ${ad.serviceData.doorState},`
+          + ` Light Level: ${ad.serviceData.lightLevel}, Battery: ${ad.serviceData.battery}`);
+      };
+      // Wait 10 seconds
+      return switchbot.wait(10000);
+    }).then(() => {
+      // Stop to monitor
+      switchbot.stopScan();
       this.parseStatus();
       this.updateHomeKitCharacteristics();
-    }, this.platform.config.options!.refreshRate! * 60000);
+    }).catch(async (e: any) => {
+      this.platform.log.error(`BLE Connection Failed: ${e.message}`);
+      this.platform.log.warn('Using OpenAPI Connection');
+      await this.openAPIRefreshStatus();
+    });
   }
 
   private async openAPIRefreshStatus() {
@@ -236,10 +271,31 @@ export class Contact {
       this.motionService.updateCharacteristic(this.platform.Characteristic.MotionDetected, this.MotionDetected);
       this.platform.device(`Contact ${this.accessory.displayName} updateCharacteristic MotionDetected: ${this.MotionDetected}`);
     }
+    if (this.CurrentAmbientLightLevel === undefined) {
+      this.platform.debug(`Contact ${this.accessory.displayName} CurrentAmbientLightLevel: ${this.CurrentAmbientLightLevel}`);
+    } else {
+      this.lightSensorService.updateCharacteristic(this.platform.Characteristic.CurrentAmbientLightLevel, this.CurrentAmbientLightLevel);
+      this.platform.device(`Contact ${this.accessory.displayName} updateCharacteristic CurrentAmbientLightLevel: ${this.CurrentAmbientLightLevel}`);
+    }
+    if (this.BatteryLevel === undefined) {
+      this.platform.debug(`Contact ${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel}`);
+    } else {
+      this.batteryService?.updateCharacteristic(this.platform.Characteristic.BatteryLevel, this.BatteryLevel);
+      this.platform.device(`Contact ${this.accessory.displayName} updateCharacteristic BatteryLevel: ${this.BatteryLevel}`);
+    }
+    if (this.StatusLowBattery === undefined) {
+      this.platform.debug(`Contact ${this.accessory.displayName} StatusLowBattery: ${this.StatusLowBattery}`);
+    } else {
+      this.batteryService?.updateCharacteristic(this.platform.Characteristic.StatusLowBattery, this.StatusLowBattery);
+      this.platform.device(`Contact ${this.accessory.displayName} updateCharacteristic StatusLowBattery: ${this.StatusLowBattery}`);
+    }
   }
 
   public apiError(e: any) {
     this.service.updateCharacteristic(this.platform.Characteristic.ContactSensorState, e);
     this.motionService.updateCharacteristic(this.platform.Characteristic.MotionDetected, e);
+    this.lightSensorService.updateCharacteristic(this.platform.Characteristic.CurrentAmbientLightLevel, e);
+    this.batteryService?.updateCharacteristic(this.platform.Characteristic.BatteryLevel, e);
+    this.batteryService?.updateCharacteristic(this.platform.Characteristic.StatusLowBattery, e);
   }
 }