@switchbot/homebridge-switchbot 1.8.2 → 1.8.3-beta.0

package/src/devices/plugs.ts

@@ -1,22 +1,21 @@
-
-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';
+import * as axios from "axios";
+import * as rxjs from "rxjs";
+import * as platform_1 from "../platform";
+import * as operators from "rxjs/operators";
+import * as homebridge from "homebridge";
+import * as settings from "../settings";
 
 export class Plug {
   // Services
-  private service: Service;
+  private service: homebridge.Service;
 
   // Characteristic Values
-  On!: CharacteristicValue;
-  OnCached!: CharacteristicValue;
+  On!: homebridge.CharacteristicValue;
+  OnCached!: homebridge.CharacteristicValue;
 
   // OpenAPI Others
-  power: deviceStatus['power'];
-  deviceStatus!: deviceStatusResponse;
+  power: settings.deviceStatus["power"];
+  deviceStatus!: settings.deviceStatusResponse;
 
   // Config
   scanDuration!: number;
@@ -25,12 +24,12 @@ export class Plug {
 
   // Updates
   plugUpdateInProgress!: boolean;
-  doPlugUpdate!: Subject<void>;
+  doPlugUpdate!: rxjs.Subject<void>;
 
   constructor(
-    private readonly platform: SwitchBotPlatform,
-    private accessory: PlatformAccessory,
-    public device: device & devicesConfig,
+    private readonly platform: platform_1.SwitchBotPlatform,
+    private accessory: homebridge.PlatformAccessory,
+    public device: settings.device & settings.devicesConfig,
   ) {
     // default placeholders
     this.logs(device);
@@ -43,11 +42,8 @@ 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.doPlugUpdate = new rxjs.Subject();
     this.plugUpdateInProgress = false;
 
     // Retrieve initial values and updateHomekit
@@ -56,15 +52,22 @@ export class Plug {
     // set accessory information
     accessory
       .getService(this.platform.Service.AccessoryInformation)!
-      .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
-      .setCharacteristic(this.platform.Characteristic.Model, 'SWITCHBOT-PLUG-SP11')
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
+      .setCharacteristic(this.platform.Characteristic.Manufacturer, "SwitchBot")
+      .setCharacteristic(
+        this.platform.Characteristic.Model,
+        "SWITCHBOT-PLUG-SP11",
+      )
+      .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.service =
       accessory.getService(this.platform.Service.Outlet) ||
-      accessory.addService(this.platform.Service.Outlet)), `${device.deviceName} ${device.deviceType}`;
+      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:
@@ -72,20 +75,25 @@ 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.service.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.service.getCharacteristic(this.platform.Characteristic.On).onSet(this.OnSet.bind(this));
+    this.service
+      .getCharacteristic(this.platform.Characteristic.On)
+      .onSet(this.OnSet.bind(this));
 
     // Update Homekit
     this.updateHomeKitCharacteristics();
 
     // Start an update interval
-    interval(this.deviceRefreshRate * 1000)
-      .pipe(skipWhile(() => this.plugUpdateInProgress))
+    rxjs.interval(this.deviceRefreshRate * 1000)
+      .pipe(operators.skipWhile(() => this.plugUpdateInProgress))
       .subscribe(() => {
         this.refreshStatus();
       });
@@ -94,23 +102,23 @@ export class Plug {
     // We put in a debounce of 100ms so we don't make duplicate calls
     this.doPlugUpdate
       .pipe(
-        tap(() => {
+        operators.tap(() => {
           this.plugUpdateInProgress = true;
         }),
-        debounceTime(this.platform.config.options!.pushRate! * 1000),
+        operators.debounceTime(this.platform.config.options!.pushRate! * 1000),
       )
       .subscribe(async () => {
         try {
           await this.pushChanges();
         } catch (e: any) {
-          this.errorLog(`Plug: ${this.accessory.displayName} failed pushChanges`);
-          if (this.deviceLogging === 'debug') {
-            this.errorLog(`Plug: ${this.accessory.displayName} failed pushChanges,`
-              + ` Error Message: ${JSON.stringify(e.message)}`);
-          }
-          if (this.platform.debugMode) {
-            this.errorLog(`Plug: ${this.accessory.displayName} failed pushChanges,`
-              + ` Error: ${JSON.stringify(e)}`);
+          this.errorLog(
+            `Plug: ${this.accessory.displayName} failed pushChanges`,
+          );
+          if (this.deviceLogging.includes("debug")) {
+            this.errorLog(
+              `Plug: ${this.accessory.displayName} failed pushChanges,` +
+                ` Error Message: ${JSON.stringify(e.message)}`,
+            );
           }
           this.apiError(e);
         }
@@ -120,7 +128,7 @@ export class Plug {
 
   parseStatus() {
     switch (this.power) {
-      case 'on':
+      case "on":
         this.On = true;
         break;
       default:
@@ -131,57 +139,74 @@ export class Plug {
 
   private async refreshStatus() {
     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)}`);
+      this.deviceStatus = (
+        await this.platform.axios.get(
+          `${settings.DeviceURL}/${this.device.deviceId}/status`,
+        )
+      ).data;
+      this.debugLog(
+        `Plug: ${this.accessory.displayName} refreshStatus: ${JSON.stringify(
+          this.deviceStatus,
+        )}`,
+      );
       this.power = this.deviceStatus.body.power;
       this.parseStatus();
       this.updateHomeKitCharacteristics();
     } catch (e: any) {
-      this.errorLog(`Plug: ${this.accessory.displayName} failed refreshStatus with OpenAPI Connection`);
-      if (this.deviceLogging === 'debug') {
-        this.errorLog(`Plug: ${this.accessory.displayName} failed refreshStatus with OpenAPI Connection,`
-          + ` Error Message: ${JSON.stringify(e.message)}`);
-      }
-      if (this.platform.debugMode) {
-        this.errorLog(`Plug: ${this.accessory.displayName} failed refreshStatus with OpenAPI Connection,`
-          + ` Error: ${JSON.stringify(e)}`);
+      this.errorLog(
+        `Plug: ${this.accessory.displayName} failed refreshStatus with OpenAPI Connection`,
+      );
+      if (this.deviceLogging.includes("debug")) {
+        this.errorLog(
+          `Plug: ${this.accessory.displayName} failed refreshStatus with OpenAPI Connection,` +
+            ` Error Message: ${JSON.stringify(e.message)}`,
+        );
       }
       this.apiError(e);
     }
   }
 
   /**
- * 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
- */
+   * 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
+   */
   async pushChanges() {
     if (this.On !== this.OnCached) {
       const payload = {
-        commandType: 'command',
-        parameter: 'default',
-      } as payload;
+        commandType: "command",
+        parameter: "default",
+      } as settings.payload;
 
       if (this.On) {
-        payload.command = 'turnOn';
+        payload.command = "turnOn";
       } else {
-        payload.command = 'turnOff';
+        payload.command = "turnOff";
       }
 
-      this.infoLog(`Plug: ${this.accessory.displayName} Sending request to SwitchBot API. command: ${payload.command},`
-        + ` parameter: ${payload.parameter}, commandType: ${payload.commandType}`);
+      this.infoLog(
+        `Plug: ${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(`Plug: ${this.accessory.displayName} pushchanges: ${JSON.stringify(push.data)}`);
+      const push: any = await this.platform.axios.post(
+        `${settings.DeviceURL}/${this.device.deviceId}/commands`,
+        payload,
+      );
+      this.debugLog(
+        `Plug: ${this.accessory.displayName} pushchanges: ${JSON.stringify(
+          push.data,
+        )}`,
+      );
       this.statusCode(push);
       this.OnCached = this.On;
       this.accessory.context.On = this.OnCached;
     }
-    interval(5000)
-      .pipe(skipWhile(() => this.plugUpdateInProgress))
-      .pipe(take(1))
+    rxjs.interval(5000)
+      .pipe(operators.skipWhile(() => this.plugUpdateInProgress))
+      .pipe(operators.take(1))
       .subscribe(() => {
         this.refreshStatus();
       });
@@ -191,8 +216,13 @@ export class Plug {
     if (this.On === undefined) {
       this.debugLog(`Plug: ${this.accessory.displayName} On: ${this.On}`);
     } else {
-      this.service.updateCharacteristic(this.platform.Characteristic.On, this.On);
-      this.debugLog(`Plug: ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
+      this.service.updateCharacteristic(
+        this.platform.Characteristic.On,
+        this.On,
+      );
+      this.debugLog(
+        `Plug: ${this.accessory.displayName} updateCharacteristic On: ${this.On}`,
+      );
     }
   }
 
@@ -201,119 +231,155 @@ export class Plug {
     //throw new this.platform.api.hap.HapStatusError(HAPStatus.SERVICE_COMMUNICATION_FAILURE);
   }
 
-  private statusCode(push: AxiosResponse<{ statusCode: number; }>) {
+  private statusCode(push: axios.AxiosResponse<{ statusCode: number }>) {
     switch (push.data.statusCode) {
       case 151:
-        this.errorLog(`Plug: ${this.accessory.displayName} Command not supported by this device type.`);
+        this.errorLog(
+          `Plug: ${this.accessory.displayName} Command not supported by this device type.`,
+        );
         break;
       case 152:
         this.errorLog(`Plug: ${this.accessory.displayName} Device not found.`);
         break;
       case 160:
-        this.errorLog(`Plug: ${this.accessory.displayName} Command is not supported.`);
+        this.errorLog(
+          `Plug: ${this.accessory.displayName} Command is not supported.`,
+        );
         break;
       case 161:
         this.errorLog(`Plug: ${this.accessory.displayName} Device is offline.`);
         this.offlineOff();
         break;
       case 171:
-        this.errorLog(`Plug: ${this.accessory.displayName} Hub Device is offline. Hub: ${this.device.hubDeviceId}`);
+        this.errorLog(
+          `Plug: ${this.accessory.displayName} Hub Device is offline. Hub: ${this.device.hubDeviceId}`,
+        );
         this.offlineOff();
         break;
       case 190:
-        this.errorLog(`Plug: ${this.accessory.displayName} Device internal error due to device states not synchronized with server,`
-          + ` Or command: ${JSON.stringify(push.data)} format is invalid`);
+        this.errorLog(
+          `Plug: ${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(`Plug: ${this.accessory.displayName} Command successfully sent.`);
+        this.debugLog(
+          `Plug: ${this.accessory.displayName} Command successfully sent.`,
+        );
         break;
       default:
-        this.debugLog(`Plug: ${this.accessory.displayName} Unknown statusCode.`);
+        this.debugLog(
+          `Plug: ${this.accessory.displayName} Unknown statusCode.`,
+        );
     }
   }
 
   private offlineOff() {
     if (this.device.offline) {
       this.On = false;
-      this.service.getCharacteristic(this.platform.Characteristic.On).updateValue(this.On);
+      this.service
+        .getCharacteristic(this.platform.Characteristic.On)
+        .updateValue(this.On);
     }
   }
 
   /**
    * Handle requests to set the value of the "On" characteristic
    */
-  OnSet(value: CharacteristicValue) {
+  OnSet(value: homebridge.CharacteristicValue) {
     this.debugLog(`Plug: ${this.accessory.displayName} - Set On: ${value}`);
 
     this.On = value;
     this.doPlugUpdate.next();
   }
 
-  config(device: device & devicesConfig) {
+  config(device: settings.device & settings.devicesConfig) {
     let config = {};
     if (device.plug) {
       config = device.plug;
     }
     if (device.ble !== undefined) {
-      config['ble'] = device.ble;
+      config["ble"] = device.ble;
     }
     if (device.logging !== undefined) {
-      config['logging'] = device.logging;
+      config["logging"] = device.logging;
     }
     if (device.refreshRate !== undefined) {
-      config['refreshRate'] = device.refreshRate;
+      config["refreshRate"] = device.refreshRate;
     }
     if (device.scanDuration !== undefined) {
-      config['scanDuration'] = device.scanDuration;
+      config["scanDuration"] = device.scanDuration;
     }
     if (Object.entries(config).length !== 0) {
-      this.warnLog(`Plug: ${this.accessory.displayName} Config: ${JSON.stringify(config)}`);
+      this.warnLog(
+        `Plug: ${this.accessory.displayName} Config: ${JSON.stringify(config)}`,
+      );
     }
   }
 
-  refreshRate(device: device & devicesConfig) {
+  refreshRate(device: settings.device & settings.devicesConfig) {
     if (device.refreshRate) {
-      this.deviceRefreshRate = this.accessory.context.refreshRate = device.refreshRate;
-      this.debugLog(`Plug: ${this.accessory.displayName} Using Device Config refreshRate: ${this.deviceRefreshRate}`);
+      this.deviceRefreshRate = this.accessory.context.refreshRate =
+        device.refreshRate;
+      this.debugLog(
+        `Plug: ${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(`Plug: ${this.accessory.displayName} Using Platform Config refreshRate: ${this.deviceRefreshRate}`);
+      this.deviceRefreshRate = this.accessory.context.refreshRate =
+        this.platform.config.options!.refreshRate;
+      this.debugLog(
+        `Plug: ${this.accessory.displayName} Using Platform Config refreshRate: ${this.deviceRefreshRate}`,
+      );
     }
   }
 
-  scan(device: device & devicesConfig) {
+  scan(device: settings.device & settings.devicesConfig) {
     if (device.scanDuration) {
-      this.scanDuration = this.accessory.context.scanDuration = device.scanDuration;
+      this.scanDuration = this.accessory.context.scanDuration =
+        device.scanDuration;
       if (device.ble) {
-        this.debugLog(`Plug: ${this.accessory.displayName} Using Device Config scanDuration: ${this.scanDuration}`);
+        this.debugLog(
+          `Plug: ${this.accessory.displayName} Using Device Config scanDuration: ${this.scanDuration}`,
+        );
       }
     } else {
       this.scanDuration = this.accessory.context.scanDuration = 1;
       if (this.device.ble) {
-        this.debugLog(`Plug: ${this.accessory.displayName} Using Default scanDuration: ${this.scanDuration}`);
+        this.debugLog(
+          `Plug: ${this.accessory.displayName} Using Default scanDuration: ${this.scanDuration}`,
+        );
       }
     }
   }
 
-  logs(device: device & devicesConfig) {
+  logs(device: settings.device & settings.devicesConfig) {
     if (this.platform.debugMode) {
-      this.deviceLogging = this.accessory.context.logging = 'debugMode';
-      this.debugLog(`Plug: ${this.accessory.displayName} Using Debug Mode Logging: ${this.deviceLogging}`);
+      this.deviceLogging = this.accessory.context.logging = "debugMode";
+      this.debugLog(
+        `Plug: ${this.accessory.displayName} Using Debug Mode Logging: ${this.deviceLogging}`,
+      );
     } else if (device.logging) {
       this.deviceLogging = this.accessory.context.logging = device.logging;
-      this.debugLog(`Plug: ${this.accessory.displayName} Using Device Config Logging: ${this.deviceLogging}`);
+      this.debugLog(
+        `Plug: ${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(`Plug: ${this.accessory.displayName} Using Platform Config Logging: ${this.deviceLogging}`);
+      this.deviceLogging = this.accessory.context.logging =
+        this.platform.config.options?.logging;
+      this.debugLog(
+        `Plug: ${this.accessory.displayName} Using Platform Config Logging: ${this.deviceLogging}`,
+      );
     } else {
-      this.deviceLogging = this.accessory.context.logging = 'standard';
-      this.debugLog(`Plug: ${this.accessory.displayName} Logging Not Set, Using: ${this.deviceLogging}`);
+      this.deviceLogging = this.accessory.context.logging = "standard";
+      this.debugLog(
+        `Plug: ${this.accessory.displayName} Logging Not Set, Using: ${this.deviceLogging}`,
+      );
     }
   }
 
   /**
- * Logging for Device
- */
+   * Logging for Device
+   */
   infoLog(...log: any[]) {
     if (this.enablingDeviceLogging()) {
       this.platform.log.info(String(...log));
@@ -334,8 +400,8 @@ export class Plug {
 
   debugLog(...log: any[]) {
     if (this.enablingDeviceLogging()) {
-      if (this.deviceLogging === 'debug') {
-        this.platform.log.info('[DEBUG]', String(...log));
+      if (this.deviceLogging === "debug") {
+        this.platform.log.info("[DEBUG]", String(...log));
       } else {
         this.platform.log.debug(String(...log));
       }
@@ -343,6 +409,8 @@ export class Plug {
   }
 
   enablingDeviceLogging(): boolean {
-    return this.deviceLogging === 'debug' || this.deviceLogging === 'standard';
+    return (
+      this.deviceLogging.includes("debug") || this.deviceLogging === "standard"
+    );
   }
-}
+}

package/src/index.ts

@@ -1,10 +1,10 @@
-import { API } from 'homebridge';
-import { PLATFORM_NAME } from './settings';
-import { SwitchBotPlatform } from './platform';
+import * as homebridge from "homebridge";
+import * as settings from "./settings";
+import * as platform from "./platform";
 
 /**
  * This method registers the platform with Homebridge
  */
-export = (api: API): void => {
-  api.registerPlatform(PLATFORM_NAME, SwitchBotPlatform);
+export = (api: homebridge.API): void => {
+  api.registerPlatform(settings.PLATFORM_NAME, platform.SwitchBotPlatform);
 };