@switchbot/homebridge-switchbot 0.1.2-beta.7 → 0.2.0-alpha.1

package/src/devices/bulb.ts

@@ -2,8 +2,7 @@ import { Service, PlatformAccessory, CharacteristicValue, MacAddress } from 'hom
 import { SwitchBotPlatform } from '../platform';
 import { interval, Subject } from 'rxjs';
 import { debounceTime, skipWhile, tap } from 'rxjs/operators';
-import { DeviceURL, device, deviceStatusResponse } from '../settings';
-import { AxiosResponse } from 'axios';
+import { DeviceURL, device, devicesConfig } from '../settings';
 
 /**
  * Platform Accessory
@@ -20,7 +19,7 @@ export class Bulb {
   ColorTemperature!: CharacteristicValue;
 
   // Others
-  deviceStatus!: deviceStatusResponse;
+  deviceStatus: any;
   switchbot!: {
     discover: (
       arg0:
@@ -39,25 +38,24 @@ export class Bulb {
   // Updates
   bulbUpdateInProgress!: boolean;
   doBulbUpdate;
+  set_minStep: any;
 
   constructor(
     private readonly platform: SwitchBotPlatform,
     private accessory: PlatformAccessory,
-    public device: device,
+    public device: device & devicesConfig,
   ) {
     // default placeholders
     this.On = false;
     this.Brightness = 0;
-    if (this.platform.config.options?.ble?.includes(this.device.deviceId!)) {
+    if (device.ble) {
       // 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) {
-        this.platform.log.warn(this.device.bleMac.toLowerCase());
-      }
+      this.platform.device(this.device.bleMac.toLowerCase());
     }
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
@@ -72,14 +70,14 @@ export class Bulb {
     accessory
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
-      .setCharacteristic(this.platform.Characteristic.Model, device.deviceType)
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId);
+      .setCharacteristic(this.platform.Characteristic.Model, 'SWITCHBOT-BULB-W1401400')
+      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
 
     // get the Television service if it exists, otherwise create a new Television service
     // you can create multiple services for each accessory
     (this.service =
       accessory.getService(this.platform.Service.Lightbulb) ||
-      accessory.addService(this.platform.Service.Lightbulb)), `${device.deviceName} ${device.deviceType}`;
+      accessory.addService(this.platform.Service.Lightbulb)), `${accessory.displayName} Light Bulb`;
 
     // 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:
@@ -96,7 +94,7 @@ export class Bulb {
     // handle Brightness events using the Brightness characteristic
     this.service.getCharacteristic(this.platform.Characteristic.Brightness)
       .setProps({
-        minStep: this.platform.config.options?.bulb?.set_minStep || 1,
+        minStep: this.minStep(),
         minValue: 0,
         maxValue: 100,
         validValueRanges: [0, 100],
@@ -109,7 +107,7 @@ export class Bulb {
     // handle ColorTemperature events using the ColorTemperature characteristic
     this.service.getCharacteristic(this.platform.Characteristic.ColorTemperature)
       .setProps({
-        minStep: this.platform.config.options?.bulb?.set_minStep || 1,
+        minStep: this.minStep(),
         minValue: 0,
         maxValue: 100,
         validValueRanges: [0, 100],
@@ -129,7 +127,7 @@ export class Bulb {
         this.refreshStatus();
       });
 
-    // Watch for Plug change events
+    // Watch for Bulb change events
     // We put in a debounce of 100ms so we don't make duplicate calls
     this.doBulbUpdate
       .pipe(
@@ -143,13 +141,22 @@ export class Bulb {
           await this.pushChanges();
         } catch (e: any) {
           this.platform.log.error(JSON.stringify(e.message));
-          this.platform.debug(`Plug ${accessory.displayName} - ${JSON.stringify(e)}`);
+          this.platform.debug(`Bulb ${accessory.displayName} - ${JSON.stringify(e)}`);
           this.apiError(e);
         }
         this.bulbUpdateInProgress = false;
       });
   }
 
+  private minStep(): number | undefined {
+    if (this.device.bulb?.set_minStep) {
+      this.set_minStep = this.device.bulb?.set_minStep;
+    } else {
+      this.set_minStep = 1;
+    }
+    return this.set_minStep;
+  }
+
   parseStatus() {
     switch (this.deviceStatus.body.power) {
       case 'on':
@@ -158,29 +165,21 @@ export class Bulb {
       default:
         this.On = false;
     }
-    this.platform.debug(`Plug ${this.accessory.displayName} On: ${this.On}`);
+    this.platform.debug(`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('Plug - 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.log.warn(`Plug ${this.accessory.displayName} refreshStatus - ${JSON.stringify(this.deviceStatus)}`);
-        this.parseStatus();
-        this.updateHomeKitCharacteristics();
-      }
+      this.platform.debug('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.parseStatus();
+      this.updateHomeKitCharacteristics();
     } catch (e: any) {
-      this.platform.log.error(
-        `Plug - Failed to refresh status of ${this.device.deviceName}`,
-        JSON.stringify(e.message),
-        this.platform.debug(`Plug ${this.accessory.displayName} - ${JSON.stringify(e)}`),
-      );
+      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.apiError(e);
     }
   }
@@ -188,8 +187,8 @@ export class Bulb {
   /**
  * Pushes the requested changes to the SwitchBot API
  * deviceType	commandType	  Command	    command parameter	  Description
- * Plug   -    "command"     "turnOff"   "default"	  =        set to OFF state
- * Plug   -    "command"     "turnOn"    "default"	  =        set to ON state
+ * Bulb   -    "command"     "turnOff"   "default"	  =        set to OFF state
+ * Bulb   -    "command"     "turnOn"    "default"	  =        set to ON state
  */
   async pushChanges() {
     const payload = {
@@ -213,23 +212,32 @@ export class Bulb {
       'commandType:',
       payload.commandType,
     );
-    this.platform.debug(`Plug ${this.accessory.displayName} pushChanges - ${JSON.stringify(payload)}`);
+    this.platform.debug(`Bulb ${this.accessory.displayName} pushchanges: ${JSON.stringify(payload)}`);
 
     // Make the API request
-    const push = await this.platform.axios.post(`${DeviceURL}/${this.device.deviceId}/commands`, payload);
-    this.platform.debug(`Plug ${this.accessory.displayName} Changes pushed - ${push.data}`);
+    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.statusCode(push);
   }
 
   updateHomeKitCharacteristics() {
-    if (this.On !== undefined) {
+    if (this.On === undefined) {
+      this.platform.debug(`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}`);
     }
-    if (this.Brightness !== undefined) {
+    if (this.Brightness === undefined) {
+      this.platform.debug(`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}`);
     }
-    if (this.ColorTemperature !== undefined) {
+    if (this.ColorTemperature === undefined) {
+      this.platform.debug(`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}`);
     }
   }
 
@@ -240,7 +248,7 @@ export class Bulb {
   }
 
 
-  private statusCode(push: AxiosResponse<any>) {
+  private statusCode(push: { data: { statusCode: any; }; }) {
     switch (push.data.statusCode) {
       case 151:
         this.platform.log.error('Command not supported by this device type.');

package/src/devices/contact.ts

@@ -2,7 +2,7 @@ import { Service, PlatformAccessory, CharacteristicValue, MacAddress } from 'hom
 import { SwitchBotPlatform } from '../platform';
 import { interval, Subject } from 'rxjs';
 import { skipWhile } from 'rxjs/operators';
-import { DeviceURL, device, deviceStatusResponse } from '../settings';
+import { DeviceURL, device, devicesConfig } from '../settings';
 
 /**
  * Platform Accessory
@@ -19,7 +19,9 @@ export class Contact {
   MotionDetected!: CharacteristicValue;
 
   // Others
-  deviceStatus!: deviceStatusResponse;
+  deviceStatus!: any;
+  BLEmotion!: boolean;
+  BLEstate!: boolean;
   switchbot!: {
     discover: (
       arg0:
@@ -42,21 +44,22 @@ export class Contact {
   constructor(
     private readonly platform: SwitchBotPlatform,
     private accessory: PlatformAccessory,
-    public device: device,
+    public device: device & devicesConfig,
   ) {
     // default placeholders
-    this.ContactSensorState = this.platform.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED;
-    if (this.platform.config.options?.ble?.includes(this.device.deviceId!)) {
+    this.ContactSensorState = this.platform.Characteristic.ContactSensorState.CONTACT_DETECTED;
+
+    // BLE Connection
+    if (device.ble) {
       // 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) {
-        this.platform.log.warn(this.device.bleMac.toLowerCase());
-      }
+      this.platform.device(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;
@@ -68,14 +71,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.SerialNumber, device.deviceId);
+      .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
     // you can create multiple services for each accessory
     (this.service =
       accessory.getService(this.platform.Service.ContactSensor) ||
-      accessory.addService(this.platform.Service.ContactSensor)), `${device.deviceName} ${device.deviceType}`;
+      accessory.addService(this.platform.Service.ContactSensor)), `${accessory.displayName} Contact Sensor`;
 
     // 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:
@@ -89,10 +92,9 @@ export class Contact {
     // 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}`;
+      accessory.addService(this.platform.Service.MotionSensor)), `${accessory.displayName} Motion Sensor`;
 
-    // create handlers for required characteristics
-    //this.service.setCharacteristic(this.platform.Characteristic.ChargingState, 2);
+    this.motionService.setCharacteristic(this.platform.Characteristic.Name, `${accessory.displayName} Motion Sensor`);
 
     // Retrieve initial values and updateHomekit
     this.updateHomeKitCharacteristics();
@@ -108,12 +110,32 @@ export class Contact {
   /**
    * Parse the device status from the SwitchBot api
    */
-  parseStatus() {
-    // Set Room Sensor State
-    if (this.deviceStatus.body.openState) {
-      this.ContactSensorState = this.platform.Characteristic.ContactSensorState.CONTACT_DETECTED;
+  async parseStatus() {
+    if (this.device.ble) {
+      this.platform.device('BLE');
+      await this.BLEparseStatus();
     } else {
+      this.platform.device('OpenAPI');
+      await this.openAPIparseStatus();
+    }
+  }
+
+  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}`);
+  }
+
+  private async openAPIparseStatus() {
+    if (this.deviceStatus.body.openState === 'open') {
       this.ContactSensorState = this.platform.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED;
+      this.platform.log.info(`${this.accessory.displayName} ${this.deviceStatus.body.openState}`);
+    } else if (this.deviceStatus.body.openState === 'close') {
+      this.ContactSensorState = this.platform.Characteristic.ContactSensorState.CONTACT_DETECTED;
+      this.platform.device(`${this.accessory.displayName} ${this.deviceStatus.body.openState}`);
+    } else {
+      this.platform.device(`${this.accessory.displayName} ${this.deviceStatus.body.openState}`);
     }
     this.MotionDetected = Boolean(this.deviceStatus.body.moveDetected);
     this.platform.debug(`${this.accessory.displayName}
@@ -124,77 +146,76 @@ export class Contact {
    * Asks the SwitchBot API for the latest device information
    */
   async refreshStatus() {
-    if (this.platform.config.options?.ble?.includes(this.device.deviceId!)) {
-      this.platform.log.warn('BLE DEVICE-REFRESH');
-      // 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) {
-        this.platform.log.warn(this.device.bleMac!);
-      }
-      switchbot.onadvertisement = (ad: any) => {
-        this.platform.log.info(JSON.stringify(ad, null, '  '));
-        this.platform.log.warn('ad:', JSON.stringify(ad));
-      };
+    if (this.device.ble) {
+      this.platform.device('BLE');
+      await this.BLERefreshStatus();
+    } else {
+      this.platform.device('OpenAPI');
+      await this.openAPIRefreshStatus();
+    }
+  }
+
+  private async BLERefreshStatus() {
+    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();
+    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({
-          id: this.device.bleMac,
+          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();
         });
-      setInterval(() => {
-        this.platform.log.info('Start scan ' + this.device.deviceName + '(' + this.device.bleMac + ')');
-        switchbot
-          .startScan({
-            mode: 'C',
-            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();
-    }
+      this.parseStatus();
+      this.updateHomeKitCharacteristics();
+    }, this.platform.config.options!.refreshRate! * 60000);
   }
 
   private async openAPIRefreshStatus() {
     try {
-      const deviceStatus: deviceStatusResponse = (
-        await this.platform.axios.get(`${DeviceURL}/${this.device.deviceId}/status`)
-      ).data;
-      if (deviceStatus.message === 'success') {
-        this.deviceStatus = deviceStatus;
-        this.platform.debug(`Contact ${this.accessory.displayName} refreshStatus - ${JSON.stringify(this.deviceStatus)}`);
-
-        this.parseStatus();
-        this.updateHomeKitCharacteristics();
-      }
+      this.deviceStatus = (await this.platform.axios.get(`${DeviceURL}/${this.device.deviceId}/status`)).data;
+      this.platform.debug(`Contact ${this.accessory.displayName} refreshStatus: ${JSON.stringify(this.deviceStatus)}`);
+      this.parseStatus();
+      this.updateHomeKitCharacteristics();
     } catch (e: any) {
-      this.platform.log.error(
-        '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.log.error(`Contact ${this.accessory.displayName} failed to refresh status. Error Message: ${JSON.stringify(e.message)}`);
+      this.platform.debug(`Contact ${this.accessory.displayName}, Error: ${JSON.stringify(e)}`);
       this.apiError(e);
     }
   }
@@ -203,11 +224,17 @@ export class Contact {
    * Updates the status for each of the HomeKit Characteristics
    */
   updateHomeKitCharacteristics() {
-    if (this.ContactSensorState !== undefined) {
+    if (this.ContactSensorState === undefined) {
+      this.platform.debug(`Contact ${this.accessory.displayName} ContactSensorState: ${this.ContactSensorState}`);
+    } else {
       this.service.updateCharacteristic(this.platform.Characteristic.ContactSensorState, this.ContactSensorState);
+      this.platform.device(`Contact ${this.accessory.displayName} updateCharacteristic ContactSensorState: ${this.ContactSensorState}`);
     }
-    if (this.MotionDetected !== undefined) {
+    if (this.MotionDetected === undefined) {
+      this.platform.debug(`Contact ${this.accessory.displayName} MotionDetected: ${this.MotionDetected}`);
+    } else {
       this.motionService.updateCharacteristic(this.platform.Characteristic.MotionDetected, this.MotionDetected);
+      this.platform.device(`Contact ${this.accessory.displayName} updateCharacteristic MotionDetected: ${this.MotionDetected}`);
     }
   }