@switchbot/homebridge-switchbot 1.10.2-beta.2 → 1.10.2-beta.6

package/src/device/lock.ts

@@ -0,0 +1,345 @@
+import { AxiosResponse } from 'axios';
+import { interval, Subject } from 'rxjs';
+import { SwitchBotPlatform } from '../platform';
+import { debounceTime, skipWhile, take, tap } from 'rxjs/operators';
+import { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
+import { DeviceURL, device, devicesConfig, deviceStatusResponse, payload, deviceStatus } from '../settings';
+
+export class Lock {
+  // Services
+  private lockService: Service;
+  private doorService?: Service;
+
+  // Characteristic Values
+  LockCurrentState!: CharacteristicValue;
+  LockTargetState!: CharacteristicValue;
+  LockTargetStateCached!: CharacteristicValue;
+
+  // OpenAPI Others
+  doorState!: deviceStatus['doorState'];
+  lockState!: deviceStatus['lockState'];
+  deviceStatus!: deviceStatusResponse;
+
+  // Config
+  scanDuration!: number;
+  deviceLogging!: string;
+  deviceRefreshRate!: number;
+
+  // Updates
+  lockUpdateInProgress!: boolean;
+  doLockUpdate!: Subject<void>;
+
+  constructor(private readonly platform: SwitchBotPlatform, private accessory: PlatformAccessory, public device: device & devicesConfig) {
+    // default placeholders
+    this.logs(device);
+    this.scan(device);
+    this.refreshRate(device);
+    this.config(device);
+    if (this.LockTargetState === undefined) {
+      this.LockTargetState = false;
+    } else {
+      this.LockTargetState = this.accessory.context.On;
+    }
+
+    // this is subject we use to track when we need to POST changes to the SwitchBot API
+    this.doLockUpdate = new Subject();
+    this.lockUpdateInProgress = false;
+
+    // Retrieve initial values and updateHomekit
+    this.refreshStatus();
+
+    // set accessory information
+    accessory
+      .getService(this.platform.Service.AccessoryInformation)!
+      .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
+      .setCharacteristic(this.platform.Characteristic.Model, 'SWITCHBOT-LOCK-W1601700')
+      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
+
+    // get the WindowCovering service if it exists, otherwise create a new WindowCovering service
+    // you can create multiple services for each accessory
+    (this.lockService = accessory.getService(this.platform.Service.Outlet) || accessory.addService(this.platform.Service.Outlet)),
+    `${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:
+    // accessory.getService('NAME') ?? accessory.addService(this.platform.Service.Lightbulb, 'NAME', 'USER_DEFINED_SUBTYPE');
+
+    // set the service name, this is what is displayed as the default name on the Home app
+    // in this example we are using the name we stored in the `accessory.context` in the `discoverDevices` method.
+    this.lockService.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/WindowCovering
+
+    // create handlers for required characteristics
+    this.lockService.getCharacteristic(this.platform.Characteristic.LockCurrentState).onSet(this.LockTargetStateSet.bind(this));
+
+    // Update Homekit
+    this.updateHomeKitCharacteristics();
+
+    // Start an update interval
+    interval(this.deviceRefreshRate * 1000)
+      .pipe(skipWhile(() => this.lockUpdateInProgress))
+      .subscribe(() => {
+        this.refreshStatus();
+      });
+
+    // Watch for Lock change events
+    // We put in a debounce of 100ms so we don't make duplicate calls
+    this.doLockUpdate
+      .pipe(
+        tap(() => {
+          this.lockUpdateInProgress = true;
+        }),
+        debounceTime(this.platform.config.options!.pushRate! * 1000),
+      )
+      .subscribe(async () => {
+        try {
+          await this.pushChanges();
+        } catch (e: any) {
+          this.errorLog(`Lock: ${this.accessory.displayName} failed pushChanges`);
+          if (this.deviceLogging === 'debug') {
+            this.errorLog(`Lock: ${this.accessory.displayName} failed pushChanges,` + ` Error Message: ${JSON.stringify(e.message)}`);
+          }
+          if (this.platform.debugMode) {
+            this.errorLog(`Lock: ${this.accessory.displayName} failed pushChanges,` + ` Error: ${JSON.stringify(e)}`);
+          }
+          this.apiError(e);
+        }
+        this.lockUpdateInProgress = false;
+      });
+  }
+
+  parseStatus() {
+    switch (this.lockState) {
+      case 'on':
+        this.LockCurrentState = this.platform.Characteristic.LockCurrentState.UNSECURED;
+        break;
+      default:
+        this.LockCurrentState = this.platform.Characteristic.LockCurrentState.SECURED;
+    }
+    this.debugLog(`Lock: ${this.accessory.displayName} On: ${this.LockTargetState}`);
+  }
+
+  private async refreshStatus() {
+    try {
+      this.deviceStatus = (await this.platform.axios.get(`${DeviceURL}/${this.device.deviceId}/status`)).data;
+      this.debugLog(`Lock: ${this.accessory.displayName} refreshStatus: ${JSON.stringify(this.deviceStatus)}`);
+      this.lockState = this.deviceStatus.body.lockState;
+      this.warnLog(this.lockState);
+      this.doorState = this.deviceStatus.body.doorState;
+      this.warnLog(this.doorState);
+      this.parseStatus();
+      this.updateHomeKitCharacteristics();
+    } catch (e: any) {
+      this.errorLog(`Lock: ${this.accessory.displayName} failed refreshStatus with OpenAPI Connection`);
+      if (this.deviceLogging === 'debug') {
+        this.errorLog(
+          `Lock: ${this.accessory.displayName} failed refreshStatus with OpenAPI Connection,` + ` Error Message: ${JSON.stringify(e.message)}`,
+        );
+      }
+      if (this.platform.debugMode) {
+        this.errorLog(`Lock: ${this.accessory.displayName} failed refreshStatus with OpenAPI Connection,` + ` Error: ${JSON.stringify(e)}`);
+      }
+      this.apiError(e);
+    }
+  }
+
+  /**
+   * Pushes the requested changes to the SwitchBot API
+   * deviceType	commandType	  Command	    command parameter	  Description
+   * Lock   -    "command"     "????"   "????"	  =        set to ???? state
+   * Lock   -    "command"     "????"    "????"	  =        set to ???? state - LockCurrentState
+   */
+  async pushChanges() {
+    if (this.LockTargetState !== this.LockTargetStateCached) {
+      const payload = {
+        commandType: 'command',
+        parameter: 'default',
+      } as payload;
+
+      if (this.LockTargetState) {
+        payload.command = 'turnOn';
+      } else {
+        payload.command = 'turnOff';
+      }
+
+      this.infoLog(
+        `Lock: ${this.accessory.displayName} Sending request to SwitchBot API. command: ${payload.command},` +
+          ` parameter: ${payload.parameter}, commandType: ${payload.commandType}`,
+      );
+
+      // Make the API request
+      const push: any = await this.platform.axios.post(`${DeviceURL}/${this.device.deviceId}/commands`, payload);
+      this.debugLog(`Lock: ${this.accessory.displayName} pushchanges: ${JSON.stringify(push.data)}`);
+      this.statusCode(push);
+      this.LockTargetStateCached = this.LockTargetState;
+      this.accessory.context.On = this.LockTargetStateCached;
+    }
+    interval(5000)
+      .pipe(skipWhile(() => this.lockUpdateInProgress))
+      .pipe(take(1))
+      .subscribe(() => {
+        this.refreshStatus();
+      });
+  }
+
+  updateHomeKitCharacteristics() {
+    if (this.LockTargetState === undefined) {
+      this.debugLog(`Lock: ${this.accessory.displayName} LockTargetState: ${this.LockTargetState}`);
+    } else {
+      this.lockService.updateCharacteristic(this.platform.Characteristic.LockTargetState, this.LockTargetState);
+      this.debugLog(`Lock: ${this.accessory.displayName} updateCharacteristic LockTargetState: ${this.LockTargetState}`);
+    }
+    if (this.LockCurrentState === undefined) {
+      this.debugLog(`Lock: ${this.accessory.displayName} LockCurrentState: ${this.LockCurrentState}`);
+    } else {
+      this.lockService.updateCharacteristic(this.platform.Characteristic.LockCurrentState, this.LockCurrentState);
+      this.debugLog(`Lock: ${this.accessory.displayName} updateCharacteristic LockTargetState: ${this.LockCurrentState}`);
+    }
+  }
+
+  public apiError(e: any) {
+    this.lockService.updateCharacteristic(this.platform.Characteristic.LockTargetState, e);
+    this.lockService.updateCharacteristic(this.platform.Characteristic.LockCurrentState, e);
+    //throw new this.platform.api.hap.HapStatusError(HAPStatus.SERVICE_COMMUNICATION_FAILURE);
+  }
+
+  private statusCode(push: AxiosResponse<{ statusCode: number }>) {
+    switch (push.data.statusCode) {
+      case 151:
+        this.errorLog(`Lock: ${this.accessory.displayName} Command not supported by this device type.`);
+        break;
+      case 152:
+        this.errorLog(`Lock: ${this.accessory.displayName} Device not found.`);
+        break;
+      case 160:
+        this.errorLog(`Lock: ${this.accessory.displayName} Command is not supported.`);
+        break;
+      case 161:
+        this.errorLog(`Lock: ${this.accessory.displayName} Device is offline.`);
+        break;
+      case 171:
+        this.errorLog(`Lock: ${this.accessory.displayName} Hub Device is offline. Hub: ${this.device.hubDeviceId}`);
+        break;
+      case 190:
+        this.errorLog(
+          `Lock: ${this.accessory.displayName} Device internal error due to device states not synchronized with server,` +
+            ` Or command: ${JSON.stringify(push.data)} format is invalid`,
+        );
+        break;
+      case 100:
+        this.debugLog(`Lock: ${this.accessory.displayName} Command successfully sent.`);
+        break;
+      default:
+        this.debugLog(`Lock: ${this.accessory.displayName} Unknown statusCode.`);
+    }
+  }
+
+  /**
+   * Handle requests to set the value of the "On" characteristic
+   */
+  LockTargetStateSet(value: CharacteristicValue) {
+    this.debugLog(`Lock: ${this.accessory.displayName} Set LockTargetState: ${value}`);
+
+    this.LockTargetState = value;
+    this.doLockUpdate.next();
+  }
+
+  config(device: device & devicesConfig) {
+    let config = {};
+    if (device.lock) {
+      config = device.lock;
+    }
+    if (device.ble !== undefined) {
+      config['ble'] = device.ble;
+    }
+    if (device.logging !== undefined) {
+      config['logging'] = device.logging;
+    }
+    if (device.refreshRate !== undefined) {
+      config['refreshRate'] = device.refreshRate;
+    }
+    if (device.scanDuration !== undefined) {
+      config['scanDuration'] = device.scanDuration;
+    }
+    if (Object.entries(config).length !== 0) {
+      this.warnLog(`Lock: ${this.accessory.displayName} Config: ${JSON.stringify(config)}`);
+    }
+  }
+
+  refreshRate(device: device & devicesConfig) {
+    if (device.refreshRate) {
+      this.deviceRefreshRate = this.accessory.context.refreshRate = device.refreshRate;
+      this.debugLog(`Lock: ${this.accessory.displayName} Using Device Config refreshRate: ${this.deviceRefreshRate}`);
+    } else if (this.platform.config.options!.refreshRate) {
+      this.deviceRefreshRate = this.accessory.context.refreshRate = this.platform.config.options!.refreshRate;
+      this.debugLog(`Lock: ${this.accessory.displayName} Using Platform Config refreshRate: ${this.deviceRefreshRate}`);
+    }
+  }
+
+  scan(device: device & devicesConfig) {
+    if (device.scanDuration) {
+      this.scanDuration = this.accessory.context.scanDuration = device.scanDuration;
+      if (device.ble) {
+        this.debugLog(`Lock: ${this.accessory.displayName} Using Device Config scanDuration: ${this.scanDuration}`);
+      }
+    } else {
+      this.scanDuration = this.accessory.context.scanDuration = 1;
+      if (this.device.ble) {
+        this.debugLog(`Lock: ${this.accessory.displayName} Using Default scanDuration: ${this.scanDuration}`);
+      }
+    }
+  }
+
+  logs(device: device & devicesConfig) {
+    if (this.platform.debugMode) {
+      this.deviceLogging = this.accessory.context.logging = 'debugMode';
+      this.debugLog(`Lock: ${this.accessory.displayName} Using Debug Mode Logging: ${this.deviceLogging}`);
+    } else if (device.logging) {
+      this.deviceLogging = this.accessory.context.logging = device.logging;
+      this.debugLog(`Lock: ${this.accessory.displayName} Using Device Config Logging: ${this.deviceLogging}`);
+    } else if (this.platform.config.options?.logging) {
+      this.deviceLogging = this.accessory.context.logging = this.platform.config.options?.logging;
+      this.debugLog(`Lock: ${this.accessory.displayName} Using Platform Config Logging: ${this.deviceLogging}`);
+    } else {
+      this.deviceLogging = this.accessory.context.logging = 'standard';
+      this.debugLog(`Lock: ${this.accessory.displayName} Logging Not Set, Using: ${this.deviceLogging}`);
+    }
+  }
+
+  /**
+   * Logging for Device
+   */
+  infoLog(...log: any[]) {
+    if (this.enablingDeviceLogging()) {
+      this.platform.log.info(String(...log));
+    }
+  }
+
+  warnLog(...log: any[]) {
+    if (this.enablingDeviceLogging()) {
+      this.platform.log.warn(String(...log));
+    }
+  }
+
+  errorLog(...log: any[]) {
+    if (this.enablingDeviceLogging()) {
+      this.platform.log.error(String(...log));
+    }
+  }
+
+  debugLog(...log: any[]) {
+    if (this.enablingDeviceLogging()) {
+      if (this.deviceLogging === 'debug') {
+        this.platform.log.info('[DEBUG]', String(...log));
+      } else {
+        this.platform.log.debug(String(...log));
+      }
+    }
+  }
+
+  enablingDeviceLogging(): boolean {
+    return this.deviceLogging === 'debug' || this.deviceLogging === 'standard';
+  }
+}

package/src/{devices/meters.ts → device/meter.ts}

@@ -66,12 +66,6 @@ export class Meter {
       this.CurrentTemperature = this.accessory.context.CurrentTemperature;
     }
 
-    // Meter Config
-    this.debugLog(
-      `Meter: ${this.accessory.displayName} Config: (ble: ${device.ble}, hide_temperature: ${device.meter?.hide_temperature},` +
-        ` hide_humidity: ${device.meter?.hide_humidity})`,
-    );
-
     // this is subject we use to track when we need to POST changes to the SwitchBot API
     this.doMeterUpdate = new Subject();
     this.meterUpdateInProgress = false;
@@ -83,7 +77,7 @@ export class Meter {
     accessory
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
-      .setCharacteristic(this.platform.Characteristic.Model, 'SWITCHBOT-METERTH-S1')
+      .setCharacteristic(this.platform.Characteristic.Model, this.model(device))
       .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
 
     // Temperature Sensor Service
@@ -393,6 +387,18 @@ export class Meter {
     //throw new this.platform.api.hap.HapStatusError(HAPStatus.SERVICE_COMMUNICATION_FAILURE);
   }
 
+  model(device: device & devicesConfig): CharacteristicValue {
+    let model: string;
+    if (device.deviceType === 'Meter Plus (US)') {
+      model = 'SWITCHBOT-METERTH-W2301500';
+    } else if (device.deviceType === 'Meter Plus (JP)') {
+      model = 'SWITCHBOT-METERTH-W2201500';
+    } else {
+      model = 'SWITCHBOT-METERTH-S1';
+    }
+    return model;
+  }
+
   config(device: device & devicesConfig) {
     let config = {};
     if (device.meter) {

package/src/{devices → device}/motion.ts

@@ -54,13 +54,6 @@ export class Motion {
     this.config(device);
     this.MotionDetected = false;
 
-    // Motion Config
-    this.debugLog(
-      `Motion Sensor: ${this.accessory.displayName} Config: (ble: ${device.ble}, offline: ${device.offline},` +
-        ` hide_lightsensor: ${device.motion?.hide_lightsensor},` +
-        ` set_minLux: ${this.device.motion?.set_minLux}, set_maxLux: ${this.device.motion?.set_maxLux})`,
-    );
-
     // this is subject we use to track when we need to POST changes to the SwitchBot API
     this.doMotionUpdate = new Subject();
     this.motionUbpdateInProgress = false;
@@ -390,6 +383,9 @@ export class Motion {
     if (device.scanDuration !== undefined) {
       config['scanDuration'] = device.scanDuration;
     }
+    if (device.offline !== undefined) {
+      config['offline'] = device.offline;
+    }
     if (Object.entries(config).length !== 0) {
       this.warnLog(`Motion Sensor: ${this.accessory.displayName} Config: ${JSON.stringify(config)}`);
     }
@@ -435,7 +431,7 @@ export class Motion {
     }
   }
 
-  private minLux(): number {
+  minLux(): number {
     if (this.device.motion?.set_minLux) {
       this.set_minLux = this.device.motion!.set_minLux!;
     } else {
@@ -444,7 +440,7 @@ export class Motion {
     return this.set_minLux;
   }
 
-  private maxLux(): number {
+  maxLux(): number {
     if (this.device.motion?.set_maxLux) {
       this.set_maxLux = this.device.motion!.set_maxLux!;
     } else {

package/src/{devices/plugs.ts → device/plug.ts}

@@ -38,9 +38,6 @@ export class Plug {
       this.On = this.accessory.context.On;
     }
 
-    // Plug Config
-    this.debugLog(`Plug: ${this.accessory.displayName} Config: (offline: ${device.offline})`);
-
     // this is subject we use to track when we need to POST changes to the SwitchBot API
     this.doPlugUpdate = new Subject();
     this.plugUpdateInProgress = false;
@@ -52,7 +49,7 @@ export class Plug {
     accessory
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
-      .setCharacteristic(this.platform.Characteristic.Model, 'SWITCHBOT-PLUG-SP11')
+      .setCharacteristic(this.platform.Characteristic.Model, this.model(device))
       .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
 
     // get the WindowCovering service if it exists, otherwise create a new WindowCovering service
@@ -145,8 +142,11 @@ export class Plug {
   /**
    * 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
+   * Plug               -    "command"     "turnOff"   "default"	  =        set to OFF state
+   * Plug               -    "command"     "turnOn"    "default"	  =        set to ON state
+   * Plug Mini (US/JP)  -    "command"      turnOn      default     =        set to ON state
+   * Plug Mini (US/JP)  -    "command"      turnOff     default     =        set to OFF state
+   * Plug Mini (US/JP)  -    "command"      toggle      default     =        toggle state
    */
   async pushChanges() {
     if (this.On !== this.OnCached) {
@@ -228,7 +228,7 @@ export class Plug {
     }
   }
 
-  private offlineOff() {
+  async offlineOff(): Promise<void> {
     if (this.device.offline) {
       this.On = false;
       this.service.getCharacteristic(this.platform.Characteristic.On).updateValue(this.On);
@@ -238,14 +238,26 @@ export class Plug {
   /**
    * Handle requests to set the value of the "On" characteristic
    */
-  OnSet(value: CharacteristicValue) {
+  async OnSet(value: CharacteristicValue): Promise<void> {
     this.debugLog(`Plug: ${this.accessory.displayName} - Set On: ${value}`);
 
     this.On = value;
     this.doPlugUpdate.next();
   }
 
-  config(device: device & devicesConfig) {
+  model(device: device & devicesConfig): string {
+    let model: string;
+    if (device.deviceType === 'Plug Mini (US)') {
+      model = 'SWITCHBOT-PLUG-W1901400';
+    } else if (device.deviceType === 'Plug Mini (JP)') {
+      model = 'SWITCHBOT-PLUG-W2001400';
+    } else {
+      model = 'SWITCHBOT-PLUG-SP11';
+    }
+    return model;
+  }
+
+  async config(device: device & devicesConfig): Promise<void> {
     let config = {};
     if (device.plug) {
       config = device.plug;
@@ -262,12 +274,15 @@ export class Plug {
     if (device.scanDuration !== undefined) {
       config['scanDuration'] = device.scanDuration;
     }
+    if (device.offline !== undefined) {
+      config['offline'] = device.offline;
+    }
     if (Object.entries(config).length !== 0) {
       this.warnLog(`Plug: ${this.accessory.displayName} Config: ${JSON.stringify(config)}`);
     }
   }
 
-  refreshRate(device: device & devicesConfig) {
+  async refreshRate(device: device & devicesConfig): Promise<void> {
     if (device.refreshRate) {
       this.deviceRefreshRate = this.accessory.context.refreshRate = device.refreshRate;
       this.debugLog(`Plug: ${this.accessory.displayName} Using Device Config refreshRate: ${this.deviceRefreshRate}`);
@@ -277,7 +292,7 @@ export class Plug {
     }
   }
 
-  scan(device: device & devicesConfig) {
+  async scan(device: device & devicesConfig): Promise<void> {
     if (device.scanDuration) {
       this.scanDuration = this.accessory.context.scanDuration = device.scanDuration;
       if (device.ble) {
@@ -291,7 +306,7 @@ export class Plug {
     }
   }
 
-  logs(device: device & devicesConfig) {
+  async logs(device: device & devicesConfig): Promise<void> {
     if (this.platform.debugMode) {
       this.deviceLogging = this.accessory.context.logging = 'debugMode';
       this.debugLog(`Plug: ${this.accessory.displayName} Using Debug Mode Logging: ${this.deviceLogging}`);
@@ -310,25 +325,25 @@ export class Plug {
   /**
    * Logging for Device
    */
-  infoLog(...log: any[]) {
+  infoLog(...log: any[]): void {
     if (this.enablingDeviceLogging()) {
       this.platform.log.info(String(...log));
     }
   }
 
-  warnLog(...log: any[]) {
+  warnLog(...log: any[]): void {
     if (this.enablingDeviceLogging()) {
       this.platform.log.warn(String(...log));
     }
   }
 
-  errorLog(...log: any[]) {
+  errorLog(...log: any[]): void {
     if (this.enablingDeviceLogging()) {
       this.platform.log.error(String(...log));
     }
   }
 
-  debugLog(...log: any[]) {
+  debugLog(...log: any[]): void {
     if (this.enablingDeviceLogging()) {
       if (this.deviceLogging === 'debug') {
         this.platform.log.info('[DEBUG]', String(...log));