@switchbot/homebridge-switchbot 1.10.2-beta.5 → 1.11.0

package/src/device/meter.ts

@@ -11,9 +11,9 @@ import { DeviceURL, device, devicesConfig, serviceData, ad, switchbot, deviceSta
  */
 export class Meter {
   // Services
-  private batteryService?: Service;
-  private temperatureservice?: Service;
-  private humidityservice?: Service;
+  batteryService?: Service;
+  temperatureservice?: Service;
+  humidityservice?: Service;
 
   // Characteristic Values
   CurrentRelativeHumidity!: CharacteristicValue;
@@ -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;
@@ -163,15 +157,15 @@ export class Meter {
     // Start an update interval
     interval(this.deviceRefreshRate * 1000)
       .pipe(skipWhile(() => this.meterUpdateInProgress))
-      .subscribe(() => {
-        this.refreshStatus();
+      .subscribe(async () => {
+        await this.refreshStatus();
       });
   }
 
   /**
    * Parse the device status from the SwitchBot api
    */
-  async parseStatus() {
+  async parseStatus(): Promise<void> {
     if (this.SwitchToOpenAPI || !this.device.ble) {
       await this.openAPIparseStatus();
     } else {
@@ -179,7 +173,7 @@ export class Meter {
     }
   }
 
-  private async BLEparseStatus() {
+  async BLEparseStatus(): Promise<void> {
     this.debugLog(`Meter: ${this.accessory.displayName} BLE parseStatus`);
 
     // Battery
@@ -205,7 +199,7 @@ export class Meter {
     }
   }
 
-  private async openAPIparseStatus() {
+  async openAPIparseStatus(): Promise<void> {
     if (this.device.ble) {
       this.SwitchToOpenAPI = false;
     }
@@ -228,7 +222,7 @@ export class Meter {
   /**
    * Asks the SwitchBot API for the latest device information
    */
-  async refreshStatus() {
+  async refreshStatus(): Promise<void> {
     if (this.device.ble) {
       this.BLErefreshStatus();
     } else {
@@ -236,7 +230,7 @@ export class Meter {
     }
   }
 
-  private async BLErefreshStatus() {
+  async BLErefreshStatus(): Promise<void> {
     this.debugLog(`Meter: ${this.accessory.displayName} BLE RefreshStatus`);
     const switchbot = await this.platform.connectBLE();
     // Convert to BLE Address
@@ -309,7 +303,7 @@ export class Meter {
     }
   }
 
-  private async BLEconnection(switchbot: any) {
+  async BLEconnection(switchbot: any): Promise<void> {
     this.errorLog(`Meter: ${this.accessory.displayName} wasn't able to establish BLE Connection, node-switchbot: ${switchbot}`);
     if (this.platform.config.credentials?.openToken) {
       this.warnLog(`Meter: ${this.accessory.displayName} Using OpenAPI Connection`);
@@ -318,7 +312,7 @@ export class Meter {
     }
   }
 
-  private async openAPIRefreshStatus() {
+  async openAPIRefreshStatus(): Promise<void> {
     if (this.platform.config.credentials?.openToken) {
       this.debugLog(`Meter: ${this.accessory.displayName} OpenAPI RefreshStatus`);
       try {
@@ -346,7 +340,7 @@ export class Meter {
   /**
    * Updates the status for each of the HomeKit Characteristics
    */
-  updateHomeKitCharacteristics() {
+  async updateHomeKitCharacteristics(): Promise<void> {
     if (!this.device.meter?.hide_humidity) {
       if (this.CurrentRelativeHumidity === undefined) {
         this.debugLog(`Meter: ${this.accessory.displayName} CurrentRelativeHumidity: ${this.CurrentRelativeHumidity}`);
@@ -379,7 +373,7 @@ export class Meter {
     }
   }
 
-  public apiError(e: any) {
+  async apiError(e: any): Promise<void> {
     if (!this.device.meter?.hide_humidity) {
       this.humidityservice?.updateCharacteristic(this.platform.Characteristic.CurrentRelativeHumidity, e);
     }
@@ -396,16 +390,16 @@ export class Meter {
   model(device: device & devicesConfig): CharacteristicValue {
     let model: string;
     if (device.deviceType === 'Meter Plus (US)') {
-      model = 'SWITCHBOT-METERTH-W2301500';
+      model = 'W2301500';
     } else if (device.deviceType === 'Meter Plus (JP)') {
-      model = 'SWITCHBOT-METERTH-W2201500';
+      model = 'W2201500';
     } else {
-      model = 'SWITCHBOT-METERTH-S1';
+      model = 'S1';
     }
     return model;
   }
 
-  config(device: device & devicesConfig) {
+  async config(device: device & devicesConfig): Promise<void> {
     let config = {};
     if (device.meter) {
       config = device.meter;
@@ -427,7 +421,7 @@ export class Meter {
     }
   }
 
-  refreshRate(device: device & devicesConfig) {
+  async refreshRate(device: device & devicesConfig): Promise<void> {
     if (device.refreshRate) {
       this.deviceRefreshRate = this.accessory.context.refreshRate = device.refreshRate;
       this.debugLog(`Meter: ${this.accessory.displayName} Using Device Config refreshRate: ${this.deviceRefreshRate}`);
@@ -437,7 +431,7 @@ export class Meter {
     }
   }
 
-  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) {
@@ -451,7 +445,7 @@ export class Meter {
     }
   }
 
-  logs(device: device & devicesConfig) {
+  async logs(device: device & devicesConfig): Promise<void> {
     if (this.platform.debugMode) {
       this.deviceLogging = this.accessory.context.logging = 'debugMode';
       this.debugLog(`Meter: ${this.accessory.displayName} Using Debug Mode Logging: ${this.deviceLogging}`);
@@ -470,25 +464,25 @@ export class Meter {
   /**
    * 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));

package/src/device/motion.ts

@@ -11,9 +11,9 @@ import { DeviceURL, device, devicesConfig, serviceData, switchbot, deviceStatusR
  */
 export class Motion {
   // Services
-  private service: Service;
-  private lightSensorService?: Service;
-  private batteryService?: Service;
+  motionSensorService: Service;
+  lightSensorService?: Service;
+  batteryService?: Service;
 
   // Characteristic Values
   MotionDetected!: CharacteristicValue;
@@ -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;
@@ -72,12 +65,12 @@ export class Motion {
     accessory
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
-      .setCharacteristic(this.platform.Characteristic.Model, 'SWITCHBOT-WOMOTION-W1101500')
+      .setCharacteristic(this.platform.Characteristic.Model, 'W1101500')
       .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
 
     // get the Battery service if it exists, otherwise create a new Motion service
     // you can create multiple services for each accessory
-    (this.service = accessory.getService(this.platform.Service.MotionSensor) || accessory.addService(this.platform.Service.MotionSensor)),
+    (this.motionSensorService = accessory.getService(this.platform.Service.MotionSensor) || accessory.addService(this.platform.Service.MotionSensor)),
     `${accessory.displayName} Motion Sensor`;
 
     // To avoid "Cannot add a Service with the same UUID another Service without also defining a unique 'subtype' property." error,
@@ -86,7 +79,7 @@ export class Motion {
 
     // 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.service.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
+    this.motionSensorService.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/MotionSensor
@@ -128,15 +121,15 @@ export class Motion {
     // Start an update interval
     interval(this.deviceRefreshRate * 1000)
       .pipe(skipWhile(() => this.motionUbpdateInProgress))
-      .subscribe(() => {
-        this.refreshStatus();
+      .subscribe(async () => {
+        await this.refreshStatus();
       });
   }
 
   /**
    * Parse the device status from the SwitchBot api
    */
-  async parseStatus() {
+  async parseStatus(): Promise<void> {
     if (this.SwitchToOpenAPI || !this.device.ble) {
       await this.openAPIparseStatus();
     } else {
@@ -144,7 +137,7 @@ export class Motion {
     }
   }
 
-  private async BLEparseStatus() {
+  async BLEparseStatus(): Promise<void> {
     this.debugLog(`Motion Sensor: ${this.accessory.displayName} BLE parseStatus`);
     // Movement
     this.MotionDetected = this.movement!;
@@ -179,7 +172,7 @@ export class Motion {
     this.debugLog(`Motion Sensor: ${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel}, StatusLowBattery: ${this.StatusLowBattery}`);
   }
 
-  private async openAPIparseStatus() {
+  async openAPIparseStatus(): Promise<void> {
     if (this.device.ble) {
       this.SwitchToOpenAPI = false;
     }
@@ -208,7 +201,7 @@ export class Motion {
   /**
    * Asks the SwitchBot API for the latest device information
    */
-  async refreshStatus() {
+  async refreshStatus(): Promise<void> {
     if (this.device.ble) {
       await this.BLERefreshStatus();
     } else {
@@ -216,7 +209,7 @@ export class Motion {
     }
   }
 
-  private async BLERefreshStatus() {
+  async BLERefreshStatus(): Promise<void> {
     this.debugLog(`Motion Sensor: ${this.accessory.displayName} BLE RefreshStatus`);
     const switchbot = await this.platform.connectBLE();
     // Convert to BLE Address
@@ -289,7 +282,7 @@ export class Motion {
     }
   }
 
-  public async BLEconnection(switchbot: any) {
+  async BLEconnection(switchbot: any): Promise<void> {
     this.errorLog(`Motion Sensor: ${this.accessory.displayName} wasn't able to establish BLE Connection, node-switchbot: ${switchbot}`);
     if (this.platform.config.credentials?.openToken) {
       this.warnLog(`Motion Sensor: ${this.accessory.displayName} Using OpenAPI Connection`);
@@ -298,7 +291,7 @@ export class Motion {
     }
   }
 
-  private async openAPIRefreshStatus() {
+  async openAPIRefreshStatus(): Promise<void> {
     if (this.platform.config.credentials?.openToken) {
       this.debugLog(`Motion Sensor: ${this.accessory.displayName} OpenAPI RefreshStatus`);
       try {
@@ -332,11 +325,11 @@ export class Motion {
   /**
    * Updates the status for each of the HomeKit Characteristics
    */
-  updateHomeKitCharacteristics() {
+  async updateHomeKitCharacteristics(): Promise<void> {
     if (this.MotionDetected === undefined) {
       this.debugLog(`Motion Sensor: ${this.accessory.displayName} MotionDetected: ${this.MotionDetected}`);
     } else {
-      this.service.updateCharacteristic(this.platform.Characteristic.MotionDetected, this.MotionDetected);
+      this.motionSensorService.updateCharacteristic(this.platform.Characteristic.MotionDetected, this.MotionDetected);
       this.debugLog(`Motion Sensor: ${this.accessory.displayName} updateCharacteristic MotionDetected: ${this.MotionDetected}`);
     }
     if (this.device.ble) {
@@ -363,8 +356,8 @@ export class Motion {
     }
   }
 
-  public apiError(e: any) {
-    this.service.updateCharacteristic(this.platform.Characteristic.MotionDetected, e);
+  async apiError(e: any): Promise<void> {
+    this.motionSensorService.updateCharacteristic(this.platform.Characteristic.MotionDetected, e);
     if (this.device.ble) {
       this.batteryService?.updateCharacteristic(this.platform.Characteristic.BatteryLevel, e);
       this.batteryService?.updateCharacteristic(this.platform.Characteristic.StatusLowBattery, e);
@@ -373,7 +366,7 @@ export class Motion {
     //throw new this.platform.api.hap.HapStatusError(HAPStatus.SERVICE_COMMUNICATION_FAILURE);
   }
 
-  config(device: device & devicesConfig) {
+  async config(device: device & devicesConfig): Promise<void> {
     let config = {};
     if (device.motion) {
       config = device.motion;
@@ -390,12 +383,15 @@ 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)}`);
     }
   }
 
-  refreshRate(device: device & devicesConfig) {
+  async refreshRate(device: device & devicesConfig): Promise<void> {
     if (device.refreshRate) {
       this.deviceRefreshRate = this.accessory.context.refreshRate = device.refreshRate;
       this.debugLog(`Motion Sensor: ${this.accessory.displayName} Using Device Config refreshRate: ${this.deviceRefreshRate}`);
@@ -405,7 +401,7 @@ export class Motion {
     }
   }
 
-  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) {
@@ -419,7 +415,7 @@ export class Motion {
     }
   }
 
-  logs(device: device & devicesConfig) {
+  async logs(device: device & devicesConfig): Promise<void> {
     if (this.platform.debugMode) {
       this.deviceLogging = this.accessory.context.logging = 'debugMode';
       this.debugLog(`Motion Sensor: ${this.accessory.displayName} Using Debug Mode Logging: ${this.deviceLogging}`);
@@ -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 {
@@ -456,25 +452,25 @@ export class Motion {
   /**
    * 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));

package/src/device/plug.ts

@@ -7,7 +7,7 @@ import { DeviceURL, device, devicesConfig, deviceStatusResponse, payload, device
 
 export class Plug {
   // Services
-  private service: Service;
+  outletService: Service;
 
   // Characteristic Values
   On!: CharacteristicValue;
@@ -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;
@@ -55,9 +52,9 @@ export class Plug {
       .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
+    // get the Outlet service if it exists, otherwise create a new Outlet service
     // you can create multiple services for each accessory
-    (this.service = accessory.getService(this.platform.Service.Outlet) || accessory.addService(this.platform.Service.Outlet)),
+    (this.outletService = 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,
@@ -66,13 +63,13 @@ export class Plug {
 
     // 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.service.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
+    this.outletService.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
+    // see https://developers.homebridge.io/#/service/Outlet
 
     // create handlers for required characteristics
-    this.service.getCharacteristic(this.platform.Characteristic.On).onSet(this.OnSet.bind(this));
+    this.outletService.getCharacteristic(this.platform.Characteristic.On).onSet(this.OnSet.bind(this));
 
     // Update Homekit
     this.updateHomeKitCharacteristics();
@@ -80,8 +77,8 @@ export class Plug {
     // Start an update interval
     interval(this.deviceRefreshRate * 1000)
       .pipe(skipWhile(() => this.plugUpdateInProgress))
-      .subscribe(() => {
-        this.refreshStatus();
+      .subscribe(async () => {
+        await this.refreshStatus();
       });
 
     // Watch for Plug change events
@@ -110,7 +107,7 @@ export class Plug {
       });
   }
 
-  parseStatus() {
+  async parseStatus(): Promise<void> {
     switch (this.power) {
       case 'on':
         this.On = true;
@@ -121,7 +118,7 @@ export class Plug {
     this.debugLog(`Plug ${this.accessory.displayName} On: ${this.On}`);
   }
 
-  private async refreshStatus() {
+  async refreshStatus(): Promise<void> {
     try {
       this.deviceStatus = (await this.platform.axios.get(`${DeviceURL}/${this.device.deviceId}/status`)).data;
       this.debugLog(`Plug: ${this.accessory.displayName} refreshStatus: ${JSON.stringify(this.deviceStatus)}`);
@@ -151,7 +148,7 @@ export class Plug {
    * Plug Mini (US/JP)  -    "command"      turnOff     default     =        set to OFF state
    * Plug Mini (US/JP)  -    "command"      toggle      default     =        toggle state
    */
-  async pushChanges() {
+  async pushChanges(): Promise<void> {
     if (this.On !== this.OnCached) {
       const payload = {
         commandType: 'command',
@@ -179,26 +176,26 @@ export class Plug {
     interval(5000)
       .pipe(skipWhile(() => this.plugUpdateInProgress))
       .pipe(take(1))
-      .subscribe(() => {
-        this.refreshStatus();
+      .subscribe(async () => {
+        await this.refreshStatus();
       });
   }
 
-  updateHomeKitCharacteristics() {
+  async updateHomeKitCharacteristics(): Promise<void> {
     if (this.On === undefined) {
       this.debugLog(`Plug: ${this.accessory.displayName} On: ${this.On}`);
     } else {
-      this.service.updateCharacteristic(this.platform.Characteristic.On, this.On);
+      this.outletService.updateCharacteristic(this.platform.Characteristic.On, this.On);
       this.debugLog(`Plug: ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
     }
   }
 
-  public apiError(e: any) {
-    this.service.updateCharacteristic(this.platform.Characteristic.On, e);
+  async apiError(e: any): Promise<void> {
+    this.outletService.updateCharacteristic(this.platform.Characteristic.On, e);
     //throw new this.platform.api.hap.HapStatusError(HAPStatus.SERVICE_COMMUNICATION_FAILURE);
   }
 
-  private statusCode(push: AxiosResponse<{ statusCode: number }>) {
+  async statusCode(push: AxiosResponse<{ statusCode: number }>): Promise<void> {
     switch (push.data.statusCode) {
       case 151:
         this.errorLog(`Plug: ${this.accessory.displayName} Command not supported by this device type.`);
@@ -234,7 +231,7 @@ export class Plug {
   async offlineOff(): Promise<void> {
     if (this.device.offline) {
       this.On = false;
-      this.service.getCharacteristic(this.platform.Characteristic.On).updateValue(this.On);
+      this.outletService.getCharacteristic(this.platform.Characteristic.On).updateValue(this.On);
     }
   }
 
@@ -251,11 +248,11 @@ export class Plug {
   model(device: device & devicesConfig): string {
     let model: string;
     if (device.deviceType === 'Plug Mini (US)') {
-      model = 'SWITCHBOT-PLUG-W1901400';
+      model = 'W1901400';
     } else if (device.deviceType === 'Plug Mini (JP)') {
-      model = 'SWITCHBOT-PLUG-W2001400';
+      model = 'W2001400';
     } else {
-      model = 'SWITCHBOT-PLUG-SP11';
+      model = 'SP11';
     }
     return model;
   }
@@ -277,6 +274,9 @@ 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)}`);
     }

package/src/settings.ts

@@ -51,7 +51,7 @@ export interface devicesConfig extends device {
   motion?: motion;
   colorbulb?: colorbulb;
   plug?: Record<any, any>;
-  lock?: Record<any, any>;
+  lock?: lock;
   ble?: boolean;
   scanDuration?: number;
   hide_device?: boolean;
@@ -104,6 +104,10 @@ export type colorbulb = {
   adaptiveLightingShift?: number;
 };
 
+export type lock = {
+  hide_contactsensor?: boolean;
+};
+
 export interface irDevicesConfig extends irdevice {
   configRemoteType?: string;
   deviceId: string;