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

package/src/devices/curtains.ts

@@ -3,8 +3,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';
 
 export class Curtain {
   // Services
@@ -18,7 +17,7 @@ export class Curtain {
   CurrentAmbientLightLevel!: CharacteristicValue;
 
   // Others
-  deviceStatus!: deviceStatusResponse;
+  deviceStatus!: any;
   moveTimer!: NodeJS.Timeout;
   ScanIntervalId!: NodeJS.Timeout;
   setNewTargetTimer!: NodeJS.Timeout;
@@ -34,6 +33,8 @@ export class Curtain {
   PreviousPosition: any;
   Position: any;
   FastScanDuration: number | undefined;
+  set_minStep!: number;
+  refreshRate!: number;
   switchbot!: {
     discover: (
       arg0:
@@ -56,7 +57,7 @@ export class Curtain {
   constructor(
     private readonly platform: SwitchBotPlatform,
     private accessory: PlatformAccessory,
-    public device: device,
+    public device: device & devicesConfig,
   ) {
     // default placeholders
     this.setMinMax();
@@ -64,16 +65,16 @@ export class Curtain {
     this.TargetPosition = 0;
     this.PositionState = this.platform.Characteristic.PositionState.STOPPED;
     this.ScanDuration = this.platform.config.options!.refreshRate!;
-    if (this.platform.config.options?.ble?.includes(this.device.deviceId!)) {
+
+    // 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
@@ -88,7 +89,7 @@ export class Curtain {
     accessory
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
-      .setCharacteristic(this.platform.Characteristic.Model, 'SWITCHBOT-CURTAIN-W0701600')
+      .setCharacteristic(this.platform.Characteristic.Model, 'SWITCHBOT-WOCURTAIN-W0701600')
       .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
 
     // get the WindowCovering service if it exists, otherwise create a new WindowCovering service
@@ -114,19 +115,19 @@ export class Curtain {
     this.service
       .getCharacteristic(this.platform.Characteristic.CurrentPosition)
       .setProps({
-        minStep: this.platform.config.options?.curtain?.set_minStep || 1,
+        minStep: this.minStep(),
         minValue: 0,
         maxValue: 100,
         validValueRanges: [0, 100],
       })
       .onGet(() => {
-        return this.CurrentPosition;
+        return Number.isNaN(this.CurrentPosition);
       });
 
     this.service
       .getCharacteristic(this.platform.Characteristic.TargetPosition)
       .setProps({
-        minStep: this.platform.config.options?.curtain?.set_minStep || 1,
+        minStep: this.minStep(),
         validValueRanges: [0, 100],
       })
       .onSet(this.TargetPositionSet.bind(this));
@@ -134,8 +135,8 @@ export class Curtain {
     //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);
+      accessory.addService(this.platform.Service.LightSensor)), `${device.deviceName} Light Sensor`;
+    this.lightSensorService.setCharacteristic(this.platform.Characteristic.Name, `${device.deviceName} Light Sensor`);
     // handle on / off events using the On characteristic
     this.lightSensorService.getCharacteristic(this.platform.Characteristic.CurrentAmbientLightLevel).onGet(() => {
       if (this.CurrentAmbientLightLevel === 'bright') {
@@ -157,7 +158,7 @@ export class Curtain {
       });
 
     // update slide progress
-    interval(this.platform.config.options!.curtain!.refreshRate! * 1000)
+    interval(this.curtainRefreshRate() * 1000)
       .pipe(skipWhile(() => this.curtainUpdateInProgress))
       .subscribe(() => {
         if (this.PositionState === this.platform.Characteristic.PositionState.STOPPED) {
@@ -189,39 +190,71 @@ export class Curtain {
       });
   }
 
-  parseStatus() {
-    if (this.platform.config.options?.ble?.includes(this.device.deviceId!)) {
-      this.platform.log.warn('BLE DEVICE-3');
+  private curtainRefreshRate() {
+    if (this.device?.curtain?.refreshRate) {
+      this.refreshRate = this.device?.curtain?.refreshRate;
     } else {
-      // CurrentPosition
-      this.setMinMax();
-      this.CurrentPosition = 100 - this.deviceStatus.body.slidePosition!;
-      this.setMinMax();
-      this.platform.debug(`Curtain ${this.accessory.displayName} CurrentPosition - Device is Currently: ${this.CurrentPosition}`);
-      if (this.setNewTarget) {
-        this.platform.log.info(`Checking ${this.accessory.displayName} Status ...`);
+      this.refreshRate = 5;
+      if (this.platform.config.options?.debug === 'device') {
+        this.platform.log.warn('Using Default Curtain Refresh Rate.');
       }
+    }
 
-      if (this.deviceStatus.body.moving) {
-        if (this.TargetPosition > this.CurrentPosition) {
-          this.platform.debug(`Curtain ${this.accessory.displayName} - Current position: ${this.CurrentPosition} closing`);
-          this.PositionState = this.platform.Characteristic.PositionState.INCREASING;
-        } else if (this.TargetPosition < this.CurrentPosition) {
-          this.platform.debug(`Curtain ${this.accessory.displayName} - Current position: ${this.CurrentPosition} opening`);
-          this.PositionState = this.platform.Characteristic.PositionState.DECREASING;
-        } else {
-          this.platform.debug(`Curtain ${this.CurrentPosition} - standby`);
-          this.PositionState = this.platform.Characteristic.PositionState.STOPPED;
-        }
+    return this.refreshRate;
+  }
+
+  private minStep(): number | undefined {
+    if (this.device.curtain?.set_minStep) {
+      this.set_minStep = this.device.curtain?.set_minStep;
+    } else {
+      this.set_minStep = 1;
+    }
+    return this.set_minStep;
+  }
+
+  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.platform.device('Curtains BLE Device parseStatus');
+  }
+
+  private async openAPIparseStatus() {
+    this.setMinMax();
+    this.CurrentPosition = 100 - this.deviceStatus.body.slidePosition!;
+    this.setMinMax();
+    this.platform.debug(`Curtain ${this.accessory.displayName} CurrentPosition - Device is Currently: ${this.CurrentPosition}`);
+    if (this.setNewTarget) {
+      this.platform.log.info(`Checking ${this.accessory.displayName} Status ...`);
+    }
+
+    if (this.deviceStatus.body.moving) {
+      if (this.TargetPosition > this.CurrentPosition) {
+        this.platform.debug(`Curtain ${this.accessory.displayName} - Current position: ${this.CurrentPosition} closing`);
+        this.PositionState = this.platform.Characteristic.PositionState.INCREASING;
+      } else if (this.TargetPosition < this.CurrentPosition) {
+        this.platform.debug(`Curtain ${this.accessory.displayName} - Current position: ${this.CurrentPosition} opening`);
+        this.PositionState = this.platform.Characteristic.PositionState.DECREASING;
       } else {
-        this.platform.debug(`Curtain ${this.accessory.displayName} - Current position: ${this.CurrentPosition} standby`);
-        if (!this.setNewTarget) {
-          /*If Curtain calibration distance is short, there will be an error between the current percentage and the target percentage.*/
-          this.TargetPosition = this.CurrentPosition;
-          this.PositionState = this.platform.Characteristic.PositionState.STOPPED;
-        }
+        this.platform.debug(`Curtain ${this.CurrentPosition} - standby`);
+        this.PositionState = this.platform.Characteristic.PositionState.STOPPED;
+      }
+    } else {
+      this.platform.debug(`Curtain ${this.accessory.displayName} - Current position: ${this.CurrentPosition} standby`);
+      if (!this.setNewTarget) {
+        /*If Curtain calibration distance is short, there will be an error between the current percentage and the target percentage.*/
+        this.TargetPosition = this.CurrentPosition;
+        this.PositionState = this.platform.Characteristic.PositionState.STOPPED;
       }
     }
+
     // Brightness
     switch (this.deviceStatus.body.brightness) {
       case 'dim':
@@ -237,136 +270,156 @@ export class Curtain {
   }
 
   async refreshStatus() {
-    if (this.platform.config.options?.ble?.includes(this.device.deviceId!)) {
-      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) {
-        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('Curtains 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.debug(this.device.bleMac!);
+    switchbot.onadvertisement = (ad: any) => {
+      this.platform.debug(JSON.stringify(ad, null, '  '));
+      this.platform.device(`ad: ${JSON.stringify(ad)}`);
+    };
+    this.parseStatus();
+    this.updateHomeKitCharacteristics();
+    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: '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();
         });
-      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 {
-      await this.openAPIRefreshStatus();
-    }
+    }, this.platform.config.options!.refreshRate! * 60000);
   }
 
   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();
-      }
+      this.deviceStatus = (await this.platform.axios.get(`${DeviceURL}/${this.device.deviceId}/status`)).data;
+      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.platform.log.error(`Curtain ${this.accessory.displayName} failed to refresh status, Eror Message ${JSON.stringify(e.message)}`);
+      this.platform.debug(`Curtain ${this.accessory.displayName}, Error: ${JSON.stringify(e)}`);
       this.apiError(e);
     }
   }
 
   async pushChanges() {
-    if (this.platform.config.options?.ble?.includes(this.device.deviceId!)) {
-      this.platform.log.warn('BLE DEVICE-2');
+    if (this.device.ble) {
+      this.platform.device('BLE');
+      await this.BLEpushChanges();
     } else {
-      if (this.TargetPosition !== this.CurrentPosition) {
-        this.platform.debug(`Pushing ${this.TargetPosition}`);
-        const adjustedTargetPosition = 100 - Number(this.TargetPosition);
-        const payload = {
-          commandType: 'command',
-          command: 'setPosition',
-          parameter: `0,ff,${adjustedTargetPosition}`,
-        } as any;
-
-        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(`Curtain ${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(`Curtain ${this.accessory.displayName} Changes pushed - ${push.data}`);
-        this.statusCode(push);
-      }
+      this.platform.device('OpenAPI');
+      await this.OpenAPIpushChanges();
+    }
+  }
+
+  private async BLEpushChanges() {
+    this.platform.device('Curtains BLE Device pushChanges');
+  }
+
+  private async OpenAPIpushChanges() {
+    if (this.TargetPosition !== this.CurrentPosition) {
+      this.platform.debug(`Pushing ${this.TargetPosition}`);
+      const adjustedTargetPosition = 100 - Number(this.TargetPosition);
+      const payload = {
+        commandType: 'command',
+        command: 'setPosition',
+        parameter: `0,ff,${adjustedTargetPosition}`,
+      } as any;
+
+      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(`Curtain ${this.accessory.displayName} pushchanges: ${JSON.stringify(payload)}`);
+
+      // Make the API request
+      this.platform.log.error(this.device.deviceId!);
+      const push: any = (await this.platform.axios.post(`${DeviceURL}/${this.device.deviceId!}/commands`, payload));
+      this.platform.debug(`Curtain ${this.accessory.displayName} Changes pushed: ${JSON.stringify(push.data)}`);
+      this.statusCode(push);
     }
   }
 
   updateHomeKitCharacteristics() {
     this.platform.debug(
       `Curtain ${this.accessory.displayName} updateHomeKitCharacteristics - ${JSON.stringify({
-        CurrentPosition: this.CurrentPosition,
+        CurrentPosition: Number.isNaN(this.CurrentPosition),
         PositionState: this.PositionState,
-        TargetPosition: this.TargetPosition,
+        TargetPosition: Number.isNaN(this.TargetPosition),
         CurrentAmbientLightLevel: this.CurrentAmbientLightLevel,
       })}`,
     );
     this.setMinMax();
-    if (this.CurrentPosition !== undefined) {
-      this.service.updateCharacteristic(this.platform.Characteristic.CurrentPosition, this.CurrentPosition);
+    if (this.CurrentPosition === undefined) {
+      this.platform.debug(`Curtain ${this.accessory.displayName} CurrentPosition: ${this.CurrentPosition}`);
+    } else {
+      this.service.updateCharacteristic(this.platform.Characteristic.CurrentPosition, Number.isNaN(this.CurrentPosition));
+      this.platform.device(`Curtain ${this.accessory.displayName} updateCharacteristic CurrentPosition: ${this.CurrentPosition}`);
     }
-    if (this.PositionState !== undefined) {
+    if (this.PositionState === undefined) {
+      this.platform.debug(`Curtain ${this.accessory.displayName} PositionState: ${this.PositionState}`);
+    } else {
       this.service.updateCharacteristic(this.platform.Characteristic.PositionState, this.PositionState);
+      this.platform.device(`Curtain ${this.accessory.displayName} updateCharacteristic PositionState: ${this.PositionState}`);
     }
-    if (this.TargetPosition !== undefined) {
-      this.service.updateCharacteristic(this.platform.Characteristic.TargetPosition, this.TargetPosition);
+    if (this.TargetPosition === undefined) {
+      this.platform.debug(`Curtain ${this.accessory.displayName} TargetPosition: ${this.TargetPosition}`);
+    } else {
+      this.service.updateCharacteristic(this.platform.Characteristic.TargetPosition, Number.isNaN(this.TargetPosition));
+      this.platform.device(`Curtain ${this.accessory.displayName} updateCharacteristic TargetPosition: ${this.TargetPosition}`);
     }
-    if (this.CurrentAmbientLightLevel !== undefined) {
+    if (this.CurrentAmbientLightLevel === undefined) {
+      this.platform.debug(`Curtain ${this.accessory.displayName} CurrentAmbientLightLevel: ${this.CurrentAmbientLightLevel}`);
+    } else {
       this.lightSensorService.updateCharacteristic(this.platform.Characteristic.CurrentAmbientLightLevel, this.CurrentAmbientLightLevel);
+      this.platform.device(`Curtain ${this.accessory.displayName} updateCharacteristic CurrentAmbientLightLevel: ${this.CurrentAmbientLightLevel}`);
     }
   }
 
@@ -374,11 +427,10 @@ export class Curtain {
     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);
+    this.lightSensorService.updateCharacteristic(this.platform.Characteristic.CurrentAmbientLightLevel, 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.');
@@ -410,7 +462,7 @@ export class Curtain {
    * Handle requests to set the value of the "Target Position" characteristic
    */
   TargetPositionSet(value: CharacteristicValue) {
-    if (this.platform.config.options?.ble?.includes(this.device.deviceId!)) {
+    if (this.device.ble) {
       this.TargetPosition = value as number;
       this.platform.log.info('Target position of Curtain setting: ' + this.TargetPosition + '%');
       clearTimeout(this.moveTimer);
@@ -622,13 +674,13 @@ export class Curtain {
   }
 
   public setMinMax() {
-    if (this.platform.config.options?.curtain?.set_min) {
-      if (this.CurrentPosition <= this.platform.config.options?.curtain?.set_min) {
+    if (this.device.curtain?.set_min) {
+      if (this.CurrentPosition <= this.device.curtain?.set_min) {
         this.CurrentPosition = 0;
       }
     }
-    if (this.platform.config.options?.curtain?.set_max) {
-      if (this.CurrentPosition >= this.platform.config.options?.curtain?.set_max) {
+    if (this.device.curtain?.set_max) {
+      if (this.CurrentPosition >= this.device.curtain?.set_max) {
         this.CurrentPosition = 100;
       }
     }