@switchbot/homebridge-switchbot 1.3.1-beta.9 → 1.4.1-beta.2

package/src/irdevices/vacuumcleaners.ts

@@ -1,7 +1,7 @@
 import { AxiosResponse } from 'axios';
 import { SwitchBotPlatform } from '../platform';
 import { irDevicesConfig, DeviceURL, irdevice, payload } from '../settings';
-import { CharacteristicValue, PlatformAccessory, Service } from 'homebridge';
+import { CharacteristicValue, HAPStatus, PlatformAccessory, Service } from 'homebridge';
 
 /**
  * Platform Accessory
@@ -14,16 +14,24 @@ export class VacuumCleaner {
 
   // Characteristic Values
   On!: CharacteristicValue;
+  OnCached!: CharacteristicValue;
 
   // Config
-  private readonly deviceDebug = this.platform.config.options?.debug === 'device' || this.platform.debugMode;
-  private readonly debugDebug = this.platform.config.options?.debug === 'debug' || this.platform.debugMode;
+  deviceLogging!: string;
 
   constructor(
     private readonly platform: SwitchBotPlatform,
     private accessory: PlatformAccessory,
     public device: irdevice & irDevicesConfig,
   ) {
+    // default placeholders
+    this.logs();
+    if (this.On === undefined) {
+      this.On = false;
+    } else {
+      this.On = this.accessory.context.On;
+    }
+
     // set accessory information
     accessory
       .getService(this.platform.Service.AccessoryInformation)!
@@ -49,8 +57,18 @@ export class VacuumCleaner {
     this.service.getCharacteristic(this.platform.Characteristic.On).onSet(this.OnSet.bind(this));
   }
 
+  logs() {
+    if (this.device.logging) {
+      this.deviceLogging = this.accessory.context.logging = this.device.logging;
+    } else if (this.platform.config.options?.logging) {
+      this.deviceLogging = this.accessory.context.logging = this.platform.config.options?.logging;
+    } else {
+      this.deviceLogging = this.accessory.context.logging = 'standard';
+    }
+  }
+
   private OnSet(value: CharacteristicValue) {
-    this.platform.debug(`Vacuum Cleaner: ${this.accessory.displayName} On: ${value}`);
+    this.debugLog(`Vacuum Cleaner: ${this.accessory.displayName} On: ${value}`);
     this.On = value;
     if (this.On) {
       this.pushOnChanges();
@@ -61,10 +79,10 @@ export class VacuumCleaner {
 
   private updateHomeKitCharacteristics() {
     if (this.On === undefined) {
-      this.platform.debug(`Vacuum Cleaner: ${this.accessory.displayName} On: ${this.On}`);
+      this.debugLog(`Vacuum Cleaner: ${this.accessory.displayName} On: ${this.On}`);
     } else {
       this.service?.updateCharacteristic(this.platform.Characteristic.On, this.On);
-      this.platform.device(`Vacuum Cleaner: ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
+      this.debugLog(`Vacuum Cleaner: ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
     }
   }
 
@@ -102,58 +120,95 @@ export class VacuumCleaner {
 
   public async pushChanges(payload: payload) {
     try {
-      this.platform.log.info(`Vacuum Cleaner: ${this.accessory.displayName} Sending request to SwitchBot API. command: ${payload.command},`
+      this.infoLog(`Vacuum Cleaner: ${this.accessory.displayName} Sending request to SwitchBot API. command: ${payload.command},`
         + ` parameter: ${payload.parameter}, commandType: ${payload.commandType}`);
 
       // Make the API request
       const push = await this.platform.axios.post(`${DeviceURL}/${this.device.deviceId}/commands`, payload);
-      this.platform.debug(`Vacuum Cleaner: ${this.accessory.displayName} pushChanges: ${push.data}`);
+      this.debugLog(`Vacuum Cleaner: ${this.accessory.displayName} pushChanges: ${push.data}`);
       this.statusCode(push);
+      this.OnCached = this.On;
+      this.accessory.context.On = this.OnCached;
       this.updateHomeKitCharacteristics();
     } catch (e: any) {
-      this.platform.log.error(`Vacuum Cleaner: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection`);
-      if (this.deviceDebug) {
-        this.platform.log.error(`Vacuum Cleaner: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,`
+      this.errorLog(`Vacuum Cleaner: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection`);
+      if (this.deviceLogging === 'debug') {
+        this.errorLog(`Vacuum Cleaner: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,`
           + ` Error Message: ${JSON.stringify(e.message)}`);
       }
-      if (this.debugDebug) {
-        this.platform.log.error(`Vacuum Cleaner: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,`
+      if (this.platform.debugMode) {
+        this.errorLog(`Vacuum Cleaner: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,`
           + ` Error: ${JSON.stringify(e)}`);
       }
-      this.apiError(e);
+      this.apiError();
     }
   }
 
   private statusCode(push: AxiosResponse<{ statusCode: number; }>) {
     switch (push.data.statusCode) {
       case 151:
-        this.platform.log.error(`Vacuum Cleaner: ${this.accessory.displayName} Command not supported by this device type.`);
+        this.errorLog(`Vacuum Cleaner: ${this.accessory.displayName} Command not supported by this device type.`);
         break;
       case 152:
-        this.platform.log.error(`Vacuum Cleaner: ${this.accessory.displayName} Device not found.`);
+        this.errorLog(`Vacuum Cleaner: ${this.accessory.displayName} Device not found.`);
         break;
       case 160:
-        this.platform.log.error(`Vacuum Cleaner: ${this.accessory.displayName} Command is not supported.`);
+        this.errorLog(`Vacuum Cleaner: ${this.accessory.displayName} Command is not supported.`);
         break;
       case 161:
-        this.platform.log.error(`Vacuum Cleaner: ${this.accessory.displayName} Device is offline.`);
+        this.errorLog(`Vacuum Cleaner: ${this.accessory.displayName} Device is offline.`);
         break;
       case 171:
-        this.platform.log.error(`Vacuum Cleaner: ${this.accessory.displayName} Hub Device is offline. Hub: ${this.device.hubDeviceId}`);
+        this.errorLog(`Vacuum Cleaner: ${this.accessory.displayName} Hub Device is offline. Hub: ${this.device.hubDeviceId}`);
         break;
       case 190:
-        this.platform.log.error(`Vacuum Cleaner: ${this.accessory.displayName} Device internal error due to device states not synchronized`
+        this.errorLog(`Vacuum Cleaner: ${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.platform.debug(`Vacuum Cleaner: ${this.accessory.displayName} Command successfully sent.`);
+        this.debugLog(`Vacuum Cleaner: ${this.accessory.displayName} Command successfully sent.`);
         break;
       default:
-        this.platform.debug(`Vacuum Cleaner: ${this.accessory.displayName} Unknown statusCode.`);
+        this.debugLog(`Vacuum Cleaner: ${this.accessory.displayName} Unknown statusCode.`);
+    }
+  }
+
+  public apiError() {
+    throw new this.platform.api.hap.HapStatusError(HAPStatus.SERVICE_COMMUNICATION_FAILURE);
+  }
+
+  /**
+  * 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));
+      }
     }
   }
 
-  public apiError(e: any) {
-    this.service.updateCharacteristic(this.platform.Characteristic.On, e);
+  enablingDeviceLogging(): boolean {
+    return this.deviceLogging === 'debug' || this.deviceLogging === 'standard';
   }
 }

package/src/irdevices/waterheaters.ts

@@ -1,7 +1,7 @@
 import { AxiosResponse } from 'axios';
 import { SwitchBotPlatform } from '../platform';
 import { irDevicesConfig, DeviceURL, irdevice, payload } from '../settings';
-import { CharacteristicValue, PlatformAccessory, Service } from 'homebridge';
+import { CharacteristicValue, HAPStatus, PlatformAccessory, Service } from 'homebridge';
 
 /**
  * Platform Accessory
@@ -14,16 +14,24 @@ export class WaterHeater {
 
   // Characteristic Values
   Active!: CharacteristicValue;
+  ActiveCached!: CharacteristicValue;
 
   // Config
-  private readonly deviceDebug = this.platform.config.options?.debug === 'device' || this.platform.debugMode;
-  private readonly debugDebug = this.platform.config.options?.debug === 'debug' || this.platform.debugMode;
+  deviceLogging!: string;
 
   constructor(
     private readonly platform: SwitchBotPlatform,
     private accessory: PlatformAccessory,
     public device: irdevice & irDevicesConfig,
   ) {
+    // default placeholders
+    this.logs();
+    if (this.Active === undefined) {
+      this.Active = this.platform.Characteristic.Active.INACTIVE;
+    } else {
+      this.Active = this.accessory.context.Active;
+    }
+
     // set accessory information
     accessory
       .getService(this.platform.Service.AccessoryInformation)!
@@ -58,8 +66,18 @@ export class WaterHeater {
     this.service.getCharacteristic(this.platform.Characteristic.Active).onSet(this.ActiveSet.bind(this));
   }
 
+  logs() {
+    if (this.device.logging) {
+      this.deviceLogging = this.accessory.context.logging = this.device.logging;
+    } else if (this.platform.config.options?.logging) {
+      this.deviceLogging = this.accessory.context.logging = this.platform.config.options?.logging;
+    } else {
+      this.deviceLogging = this.accessory.context.logging = 'standard';
+    }
+  }
+
   private ActiveSet(value: CharacteristicValue) {
-    this.platform.debug(`Water Heater: ${this.accessory.displayName} Active: ${value}`);
+    this.debugLog(`Water Heater: ${this.accessory.displayName} Active: ${value}`);
     if (value === this.platform.Characteristic.Active.INACTIVE) {
       this.pushWaterHeaterOffChanges();
       this.service.setCharacteristic(
@@ -71,14 +89,16 @@ export class WaterHeater {
       this.service.setCharacteristic(this.platform.Characteristic.InUse, this.platform.Characteristic.InUse.IN_USE);
     }
     this.Active = value;
+    this.ActiveCached = this.Active;
+    this.accessory.context.Active = this.ActiveCached;
   }
 
   private updateHomeKitCharacteristics() {
     if (this.Active === undefined) {
-      this.platform.debug(`Water Heater: ${this.accessory.displayName} Active: ${this.Active}`);
+      this.debugLog(`Water Heater: ${this.accessory.displayName} Active: ${this.Active}`);
     } else {
       this.service?.updateCharacteristic(this.platform.Characteristic.Active, this.Active);
-      this.platform.device(`Water Heater: ${this.accessory.displayName} updateCharacteristic Active: ${this.Active}`);
+      this.debugLog(`Water Heater: ${this.accessory.displayName} updateCharacteristic Active: ${this.Active}`);
     }
   }
 
@@ -116,58 +136,93 @@ export class WaterHeater {
 
   public async pushChanges(payload: payload) {
     try {
-      this.platform.log.info(`Water Heater: ${this.accessory.displayName} Sending request to SwitchBot API. command: ${payload.command},`
+      this.infoLog(`Water Heater: ${this.accessory.displayName} Sending request to SwitchBot API. command: ${payload.command},`
         + ` parameter: ${payload.parameter}, commandType: ${payload.commandType}`);
 
       // Make the API request
       const push = await this.platform.axios.post(`${DeviceURL}/${this.device.deviceId}/commands`, payload);
-      this.platform.debug(`Water Heater: ${this.accessory.displayName} pushChanges: ${push.data}`);
+      this.debugLog(`Water Heater: ${this.accessory.displayName} pushChanges: ${push.data}`);
       this.statusCode(push);
       this.updateHomeKitCharacteristics();
     } catch (e: any) {
-      this.platform.log.error(`Water Heater: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection`);
-      if (this.deviceDebug) {
-        this.platform.log.error(`Water Heater: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,`
+      this.errorLog(`Water Heater: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection`);
+      if (this.deviceLogging === 'debug') {
+        this.errorLog(`Water Heater: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,`
           + ` Error Message: ${JSON.stringify(e.message)}`);
       }
-      if (this.debugDebug) {
-        this.platform.log.error(`Water Heater: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,`
+      if (this.platform.debugMode) {
+        this.errorLog(`Water Heater: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,`
           + ` Error: ${JSON.stringify(e)}`);
       }
-      this.apiError(e);
+      this.apiError();
     }
   }
 
   private statusCode(push: AxiosResponse<{ statusCode: number; }>) {
     switch (push.data.statusCode) {
       case 151:
-        this.platform.log.error(`Water Heater: ${this.accessory.displayName} Command not supported by this device type.`);
+        this.errorLog(`Water Heater: ${this.accessory.displayName} Command not supported by this device type.`);
         break;
       case 152:
-        this.platform.log.error(`Water Heater: ${this.accessory.displayName} Device not found.`);
+        this.errorLog(`Water Heater: ${this.accessory.displayName} Device not found.`);
         break;
       case 160:
-        this.platform.log.error(`Water Heater: ${this.accessory.displayName} Command is not supported.`);
+        this.errorLog(`Water Heater: ${this.accessory.displayName} Command is not supported.`);
         break;
       case 161:
-        this.platform.log.error(`Water Heater: ${this.accessory.displayName} Device is offline.`);
+        this.errorLog(`Water Heater: ${this.accessory.displayName} Device is offline.`);
         break;
       case 171:
-        this.platform.log.error(`Water Heater: ${this.accessory.displayName} Hub Device is offline. Hub: ${this.device.hubDeviceId}`);
+        this.errorLog(`Water Heater: ${this.accessory.displayName} Hub Device is offline. Hub: ${this.device.hubDeviceId}`);
         break;
       case 190:
-        this.platform.log.error(`Water Heater: ${this.accessory.displayName} Device internal error due to device states not synchronized`
+        this.errorLog(`Water Heater: ${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.platform.debug(`Water Heater: ${this.accessory.displayName} Command successfully sent.`);
+        this.debugLog(`Water Heater: ${this.accessory.displayName} Command successfully sent.`);
         break;
       default:
-        this.platform.debug(`Water Heater: ${this.accessory.displayName} Unknown statusCode.`);
+        this.debugLog(`Water Heater: ${this.accessory.displayName} Unknown statusCode.`);
+    }
+  }
+
+  public apiError() {
+    throw new this.platform.api.hap.HapStatusError(HAPStatus.SERVICE_COMMUNICATION_FAILURE);
+  }
+
+  /**
+ * 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));
+      }
     }
   }
 
-  public apiError(e: any) {
-    this.service.updateCharacteristic(this.platform.Characteristic.Active, e);
+  enablingDeviceLogging(): boolean {
+    return this.deviceLogging === 'debug' || this.deviceLogging === 'standard';
   }
 }