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

package/src/devices/bots.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
@@ -15,7 +14,7 @@ export class Bot {
 
   SwitchOn!: CharacteristicValue;
   OutletInUse!: CharacteristicValue;
-  deviceStatus!: deviceStatusResponse;
+  deviceStatus!: { statusCode: number; body: { deviceId: string; deviceType: string; hubDeviceId: string; power: string; }; message: string; };
   RunTimer!: NodeJS.Timeout;
   ScanDuration: number;
   TargetState;
@@ -40,15 +39,15 @@ export class Bot {
   constructor(
     private readonly platform: SwitchBotPlatform,
     private accessory: PlatformAccessory,
-    public device: device,
+    public device: device & devicesConfig,
   ) {
     // default placeholders
     this.SwitchOn = false;
     this.ScanDuration = this.platform.config.options!.refreshRate!;
-    if (!this.platform.config.options?.bot?.switch) {
+    if (device.bot?.mode !== 'switch') {
       this.OutletInUse = true;
     }
-    if (this.platform.config.options?.ble?.includes(this.device.deviceId!)) {
+    if (device.ble) {
       this.SwitchOn = false;
       // eslint-disable-next-line @typescript-eslint/no-var-requires
       const SwitchBot = require('node-switchbot');
@@ -56,9 +55,7 @@ export class Bot {
       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);
-      }
+      this.platform.device(this.device.bleMac);
     }
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
@@ -77,14 +74,14 @@ export class Bot {
 
     // get the LightBulb service if it exists, otherwise create a new LightBulb service
     // you can create multiple services for each accessory
-    if (this.platform.config.options?.bot?.switch) {
+    if (device.bot?.mode === 'switch') {
       (this.service =
         accessory.getService(this.platform.Service.Switch) ||
-        accessory.addService(this.platform.Service.Switch)), `${device.deviceName} ${device.deviceType}`;
+        accessory.addService(this.platform.Service.Switch)), `${accessory.displayName} Switch`;
     } else {
       (this.service =
         accessory.getService(this.platform.Service.Outlet) ||
-        accessory.addService(this.platform.Service.Outlet)), `${device.deviceName} ${device.deviceType}`;
+        accessory.addService(this.platform.Service.Outlet)), `${accessory.displayName} Outlet`;
     }
 
     // To avoid "Cannot add a Service with the same UUID another Service without also defining a unique 'subtype' property." error,
@@ -134,22 +131,28 @@ export class Bot {
   /**
    * Parse the device status from the SwitchBot api
    */
-  parseStatus() {
-    if (this.platform.config.options?.ble?.includes(this.device.deviceId!)) {
-      this.platform.log.warn('BLE DEVICE-PARSE');
+  async parseStatus() {
+    if (this.device.ble) {
+      this.platform.device('BLE');
+      await this.BLEparseStatus();
     } else {
-      if (!this.platform.config.options?.bot?.switch) {
-        this.OutletInUse = true;
-        if (this.platform.config.options?.bot?.device_press?.includes(this.device.deviceId!)) {
-          this.SwitchOn = false;
-        }
-        this.platform.debug(`Bot ${this.accessory.displayName} OutletInUse: ${this.OutletInUse} On: ${this.SwitchOn}`);
-      } else {
-        if (this.platform.config.options?.bot?.device_press?.includes(this.device.deviceId!)) {
-          this.SwitchOn = false;
-        }
-        this.platform.debug(`Bot ${this.accessory.displayName} On: ${this.SwitchOn}`);
-      }
+      this.platform.device('OpenAPI');
+      await this.openAPIparseStatus();
+    }
+  }
+
+  private async BLEparseStatus() {
+    this.platform.debug('Bots BLE Device RefreshStatus');
+  }
+
+  private async openAPIparseStatus() {
+    if (this.device.bot?.mode !== 'switch') {
+      this.OutletInUse = true;
+      this.SwitchOn = false;
+      this.platform.debug(`Bot ${this.accessory.displayName} OutletInUse: ${this.OutletInUse} On: ${this.SwitchOn}`);
+    } else {
+      this.SwitchOn = false;
+      this.platform.debug(`Bot ${this.accessory.displayName} On: ${this.SwitchOn}`);
     }
   }
 
@@ -157,62 +160,68 @@ export class Bot {
    * 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.device('Bot 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.debug(JSON.stringify(ad, null, '  '));
+      this.platform.device(`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);
+        this.openAPIRefreshStatus();
+      });
+    setInterval(() => {
+      this.platform.log.info('Start scan ' + this.device.deviceName + '(' + this.device.bleMac + ')');
       switchbot
         .startScan({
-          id: this.device.bleMac,
+          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.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 {
-      this.openAPIRefreshStatus();
-    }
+      this.parseStatus();
+      this.updateHomeKitCharacteristics();
+    }, this.platform.config.options!.refreshRate! * 60000);
   }
 
-  private openAPIRefreshStatus() {
+  private async openAPIRefreshStatus() {
     try {
-      const deviceStatus: deviceStatusResponse = {
+      this.deviceStatus = {
         statusCode: 100,
         body: {
           deviceId: this.device.deviceId!,
@@ -222,14 +231,11 @@ export class Bot {
         },
         message: 'success',
       };
-      this.deviceStatus = deviceStatus;
       this.parseStatus();
       this.updateHomeKitCharacteristics();
     } catch (e: any) {
-      this.platform.log.error(
-        `Bot - Failed to update status of ${this.device.deviceName}`,
-        JSON.stringify(e.message),
-        this.platform.debug(`Bot ${this.accessory.displayName} - ${JSON.stringify(e)}`));
+      this.platform.log.error(`Bot ${this.accessory.displayName} failed to refresh status, Error Message: ${JSON.stringify(e.message)}`);
+      this.platform.debug(`Bot ${this.accessory.displayName}, Error: ${JSON.stringify(e)}`);
       this.apiError(e);
     }
   }
@@ -242,117 +248,134 @@ export class Bot {
    * Bot   -    "command"     "press"     "default"	  =        trigger press
    */
   async pushChanges() {
-    if (this.platform.config.options?.ble?.includes(this.device.deviceId!)) {
-      this.platform.log.warn('BLE DEVICE-PUSH');
-      // Target state has been changed.
-      this.platform.log.info('Target state of Bot setting: ' + (this.TargetState ? 'ON' : 'OFF'));
-      this.switchbot
-        .discover({ duration: this.ScanDuration, model: 'H', quick: true, id: (this.device.bleMac!) })
-        .then((device_list: any) => {
-          this.platform.log.info('Scan done.');
-          let targetDevice: any = null;
-          for (const device of device_list) {
-            // log.info(device.modelName, device.address);
-            if (device.address === this.device.bleMac) {
-              targetDevice = device;
-              break;
-            }
-          }
-          if (!targetDevice) {
-            this.platform.log.info('No device was found during scan.');
-            return new Promise((resolve, reject) => {
-              reject(new Error('No device was found during scan.'));
-            });
-          } else {
-            this.platform.log.info(targetDevice.modelName + ' (' + targetDevice.address + ') was found.');
-            // Set event handers
-            targetDevice.onconnect = () => {
-              // log.info('Connected.');
-            };
-            targetDevice.ondisconnect = () => {
-              // log.info('Disconnected.');
-            };
-            this.platform.log.info('Bot is running...');
-            return this.setTargetDeviceState(targetDevice, this.TargetState);
-          }
-        })
-        .then(() => {
-          this.platform.log.info('Done.');
-          this.SwitchOn = this.TargetState;
-          this.RunTimer = setTimeout(() => {
-            this.service?.getCharacteristic(this.platform.Characteristic.On).updateValue(this.SwitchOn);
-          }, 500);
-          this.platform.log.info('Bot state has been set to: ' + (this.SwitchOn ? 'ON' : 'OFF'));
-        })
-        .catch((error: any) => {
-          this.platform.log.error(error);
-          this.RunTimer = setTimeout(() => {
-            this.service?.getCharacteristic(this.platform.Characteristic.On).updateValue(this.SwitchOn);
-          }, 500);
-          this.platform.log.info('Bot state failed to be set to: ' + (this.TargetState ? 'ON' : 'OFF'));
-        });
+    if (this.device.ble) {
+      this.platform.device('BLE');
+      await this.BLEpushChanges();
     } else {
-      const payload = {
-        commandType: 'command',
-        parameter: 'default',
-      } as any;
-
-      if (this.platform.config.options?.bot?.device_switch?.includes(this.device.deviceId!) && this.SwitchOn) {
-        payload.command = 'turnOn';
-        this.SwitchOn = true;
-        this.platform.debug(`Switch Mode, Turning ${this.SwitchOn}`);
-      } else if (this.platform.config.options?.bot?.device_switch?.includes(this.device.deviceId!) && !this.SwitchOn) {
-        payload.command = 'turnOff';
-        this.SwitchOn = false;
-        this.platform.debug(`Switch Mode, Turning ${this.SwitchOn}`);
-      } else if (this.platform.config.options?.bot?.device_press?.includes(this.device.deviceId!)) {
-        payload.command = 'press';
-        this.platform.debug('Press Mode');
-        this.SwitchOn = false;
-      } else {
-        throw new Error('Bot Device Paramters not set for this Bot.');
-      }
-
-      this.platform.log.info(
-        'Sending request for',
-        this.accessory.displayName,
-        'to SwitchBot API. command:',
-        payload.command,
-        'parameter:',
-        payload.parameter,
-        'commandType:',
-        payload.commandType,
-      );
-      this.platform.debug(`Bot ${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(`Bot ${this.accessory.displayName} Changes pushed - ${push.data}`);
-      this.statusCode(push);
+      this.platform.device('OpenAPI');
+      await this.openAPIpushChanges();
     }
     this.refreshStatus();
   }
 
+  private async BLEpushChanges() {
+    this.platform.device('Bot BLE Device pushChanges');
+    // Target state has been changed.
+    this.platform.log.info('Target state of Bot setting: ' + (this.TargetState ? 'ON' : 'OFF'));
+    this.switchbot
+      .discover({ duration: this.ScanDuration, model: 'H', quick: true, id: (this.device.bleMac!) })
+      .then((device_list: any) => {
+        this.platform.log.info('Scan done.');
+        let targetDevice: any = null;
+        for (const device of device_list) {
+          // log.info(device.modelName, device.address);
+          if (device.address === this.device.bleMac) {
+            targetDevice = device;
+            break;
+          }
+        }
+        if (!targetDevice) {
+          this.platform.log.info('No device was found during scan.');
+          return new Promise((resolve, reject) => {
+            reject(new Error('No device was found during scan.'));
+          });
+        } else {
+          this.platform.log.info(targetDevice.modelName + ' (' + targetDevice.address + ') was found.');
+          // Set event handers
+          targetDevice.onconnect = () => {
+            // log.info('Connected.');
+          };
+          targetDevice.ondisconnect = () => {
+            // log.info('Disconnected.');
+          };
+          this.platform.log.info('Bot is running...');
+          return this.setTargetDeviceState(targetDevice, this.TargetState);
+        }
+      })
+      .then(() => {
+        this.platform.log.info('Done.');
+        this.SwitchOn = this.TargetState;
+        this.RunTimer = setTimeout(() => {
+          this.service?.getCharacteristic(this.platform.Characteristic.On).updateValue(this.SwitchOn);
+        }, 500);
+        this.platform.log.info('Bot state has been set to: ' + (this.SwitchOn ? 'ON' : 'OFF'));
+      })
+      .catch((error: any) => {
+        this.platform.log.error(error);
+        this.RunTimer = setTimeout(() => {
+          this.service?.getCharacteristic(this.platform.Characteristic.On).updateValue(this.SwitchOn);
+        }, 500);
+        this.platform.log.info('Bot state failed to be set to: ' + (this.TargetState ? 'ON' : 'OFF'));
+      });
+  }
+
+  private async openAPIpushChanges() {
+    const payload = {
+      commandType: 'command',
+      parameter: 'default',
+    } as any;
+
+    if (this.device.bot?.mode === 'switch' && (this.SwitchOn)) {
+      payload.command = 'turnOn';
+      this.SwitchOn = true;
+      this.platform.debug(`Switch Mode, Turning ${this.SwitchOn}`);
+    } else if (this.device.bot?.mode === 'switch' && (!this.SwitchOn)) {
+      payload.command = 'turnOff';
+      this.SwitchOn = false;
+      this.platform.debug(`Switch Mode, Turning ${this.SwitchOn}`);
+    } else if (this.device.bot?.mode === 'press') {
+      payload.command = 'press';
+      this.platform.debug('Press Mode');
+      this.SwitchOn = false;
+    } else {
+      throw new Error('Bot Device Paramters not set for this Bot.');
+    }
+
+    this.platform.log.info(
+      'Sending request for',
+      this.accessory.displayName,
+      'to SwitchBot API. command:',
+      payload.command,
+      'parameter:',
+      payload.parameter,
+      'commandType:',
+      payload.commandType,
+    );
+    this.platform.debug(`Bot ${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(`Bot ${this.accessory.displayName} Changes pushed: ${JSON.stringify(push.data)}`);
+    this.statusCode(push);
+  }
+
   /**
    * Updates the status for each of the HomeKit Characteristics
    */
   updateHomeKitCharacteristics() {
-    if (this.SwitchOn !== undefined) {
+    if (this.SwitchOn === undefined) {
+      this.platform.debug(`Bot ${this.accessory.displayName} On: ${this.SwitchOn}`);
+    } else {
       this.service.updateCharacteristic(this.platform.Characteristic.On, this.SwitchOn);
+      this.platform.device(`Bot ${this.accessory.displayName} updateCharacteristic On: ${this.SwitchOn}`);
     }
-    if (!this.platform.config.options?.bot?.switch && this.OutletInUse !== undefined) {
+    if (this.OutletInUse === undefined || this.device.bot?.mode === 'switch') {
+      this.platform.debug(`Bot ${this.accessory.displayName} On: ${this.OutletInUse}, Switch: ${this.device.bot?.mode}`);
+    } else {
       this.service.updateCharacteristic(this.platform.Characteristic.OutletInUse, this.OutletInUse);
+      this.platform.device(`Bot ${this.accessory.displayName} updateCharacteristic On: ${this.OutletInUse},`
+        + ` Switch: ${this.device.bot?.mode}`);
     }
   }
 
   public apiError(e: any) {
     this.service.updateCharacteristic(this.platform.Characteristic.On, e);
-    if (!this.platform.config.options?.bot?.switch) {
+    if (this.device.bot?.mode !== 'switch') {
       this.service.updateCharacteristic(this.platform.Characteristic.OutletInUse, e);
     }
   }
 
-  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.');
@@ -384,9 +407,9 @@ export class Bot {
    * Handle requests to set the "On" characteristic
    */
   private handleOnSet(value: CharacteristicValue) {
-    if (this.platform.config.options?.ble?.includes(this.device.deviceId!)) {
+    if (this.device.ble) {
       this.TargetState = value as boolean;
-      this.platform.log.warn('BLE DEVICE-SET');
+      this.platform.device(`Bot BLE Device - ${this.TargetState}`);
       if (this.TargetState === this.SwitchOn) {
         this.platform.log.info('Target state of Bot has not changed: ' + (this.SwitchOn ? 'ON' : 'OFF'));
         this.service?.getCharacteristic(this.platform.Characteristic.On).updateValue(this.SwitchOn);