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

package/src/irdevices/fans.ts

@@ -1,7 +1,13 @@
-import { AxiosResponse } from 'axios';
-import { SwitchBotPlatform } from '../platform';
-import { CharacteristicValue, PlatformAccessory, Service } from 'homebridge';
-import { DeviceURL, irdevice, deviceStatusResponse, irDevicesConfig, payload } from '../settings';
+import { AxiosResponse } from "axios";
+import { SwitchBotPlatform } from "../platform";
+import { CharacteristicValue, PlatformAccessory, Service } from "homebridge";
+import {
+  DeviceURL,
+  irdevice,
+  deviceStatusResponse,
+  irDevicesConfig,
+  payload,
+} from "../settings";
 
 /**
  * Platform Accessory
@@ -46,15 +52,19 @@ export class Fan {
     // set accessory information
     accessory
       .getService(this.platform.Service.AccessoryInformation)!
-      .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
+      .setCharacteristic(this.platform.Characteristic.Manufacturer, "SwitchBot")
       .setCharacteristic(this.platform.Characteristic.Model, device.remoteType)
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
+      .setCharacteristic(
+        this.platform.Characteristic.SerialNumber,
+        device.deviceId!,
+      );
 
     // get the Television service if it exists, otherwise create a new Television service
     // you can create multiple services for each accessory
     (this.service =
       accessory.getService(this.platform.Service.Fanv2) ||
-      accessory.addService(this.platform.Service.Fanv2)), `${accessory.displayName} Fan`;
+      accessory.addService(this.platform.Service.Fanv2)),
+    `${accessory.displayName} Fan`;
 
     // 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:
@@ -62,10 +72,15 @@ export class Fan {
 
     // 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,
+    );
 
     // handle on / off events using the Active characteristic
-    this.service.getCharacteristic(this.platform.Characteristic.Active).onSet(this.ActiveSet.bind(this));
+    this.service
+      .getCharacteristic(this.platform.Characteristic.Active)
+      .onSet(this.ActiveSet.bind(this));
 
     if (device.irfan?.rotation_speed) {
       if (device.irfan?.set_minStep) {
@@ -93,27 +108,46 @@ export class Fan {
         })
         .onSet(this.RotationSpeedSet.bind(this));
     } else if (
-      this.service.testCharacteristic(this.platform.Characteristic.RotationSpeed) &&
-      !device.irfan?.swing_mode) {
-      const characteristic = this.service.getCharacteristic(this.platform.Characteristic.RotationSpeed);
+      this.service.testCharacteristic(
+        this.platform.Characteristic.RotationSpeed,
+      ) &&
+      !device.irfan?.swing_mode
+    ) {
+      const characteristic = this.service.getCharacteristic(
+        this.platform.Characteristic.RotationSpeed,
+      );
       this.service.removeCharacteristic(characteristic);
-      this.debugLog(`Fan: ${this.accessory.displayName} Rotation Speed Characteristic was removed.`);
+      this.debugLog(
+        `Fan: ${this.accessory.displayName} Rotation Speed Characteristic was removed.`,
+      );
     } else {
       // eslint-disable-next-line max-len
-      this.debugLog(`Fan: ${this.accessory.displayName} Rotation Speed Characteristic was not removed or not added. To Remove Chracteristic, Clear Cache on this Accessory.`);
+      this.debugLog(
+        `Fan: ${this.accessory.displayName} Rotation Speed Characteristic was not removed or not added. To Remove Chracteristic, Clear Cache on this Accessory.`,
+      );
     }
 
     if (device.irfan?.swing_mode) {
       // handle Osolcation events using the SwingMode characteristic
-      this.service.getCharacteristic(this.platform.Characteristic.SwingMode).onSet(this.SwingModeSet.bind(this));
-    } else if (this.service.testCharacteristic(this.platform.Characteristic.SwingMode) && !device.irfan?.swing_mode) {
-      const characteristic = this.service.getCharacteristic(this.platform.Characteristic.SwingMode);
+      this.service
+        .getCharacteristic(this.platform.Characteristic.SwingMode)
+        .onSet(this.SwingModeSet.bind(this));
+    } else if (
+      this.service.testCharacteristic(this.platform.Characteristic.SwingMode) &&
+      !device.irfan?.swing_mode
+    ) {
+      const characteristic = this.service.getCharacteristic(
+        this.platform.Characteristic.SwingMode,
+      );
       this.service.removeCharacteristic(characteristic);
-      this.debugLog(`Fan: ${this.accessory.displayName} Swing Mode Characteristic was removed.`);
+      this.debugLog(
+        `Fan: ${this.accessory.displayName} Swing Mode Characteristic was removed.`,
+      );
     } else {
       // eslint-disable-next-line max-len
-      this.debugLog(`Fan: ${this.accessory.displayName} Swing Mode Characteristic was not removed or not added. To Remove Chracteristic, Clear Cache on this Accessory.`);
-
+      this.debugLog(
+        `Fan: ${this.accessory.displayName} Swing Mode Characteristic was not removed or not added. To Remove Chracteristic, Clear Cache on this Accessory.`,
+      );
     }
   }
 
@@ -133,22 +167,43 @@ export class Fan {
 
   private updateHomeKitCharacteristics() {
     if (this.Active === undefined) {
-      this.debugLog(`Fan: ${this.accessory.displayName} Active: ${this.Active}`);
+      this.debugLog(
+        `Fan: ${this.accessory.displayName} Active: ${this.Active}`,
+      );
     } else {
-      this.service?.updateCharacteristic(this.platform.Characteristic.Active, this.Active);
-      this.debugLog(`Fan: ${this.accessory.displayName} updateCharacteristic Active: ${this.Active}`);
+      this.service?.updateCharacteristic(
+        this.platform.Characteristic.Active,
+        this.Active,
+      );
+      this.debugLog(
+        `Fan: ${this.accessory.displayName} updateCharacteristic Active: ${this.Active}`,
+      );
     }
     if (this.SwingMode === undefined) {
-      this.debugLog(`Fan: ${this.accessory.displayName} SwingMode: ${this.SwingMode}`);
+      this.debugLog(
+        `Fan: ${this.accessory.displayName} SwingMode: ${this.SwingMode}`,
+      );
     } else {
-      this.service?.updateCharacteristic(this.platform.Characteristic.SwingMode, this.SwingMode);
-      this.debugLog(`Fan: ${this.accessory.displayName} updateCharacteristic SwingMode: ${this.SwingMode}`);
+      this.service?.updateCharacteristic(
+        this.platform.Characteristic.SwingMode,
+        this.SwingMode,
+      );
+      this.debugLog(
+        `Fan: ${this.accessory.displayName} updateCharacteristic SwingMode: ${this.SwingMode}`,
+      );
     }
     if (this.RotationSpeed === undefined) {
-      this.debugLog(`Fan: ${this.accessory.displayName} RotationSpeed: ${this.RotationSpeed}`);
+      this.debugLog(
+        `Fan: ${this.accessory.displayName} RotationSpeed: ${this.RotationSpeed}`,
+      );
     } else {
-      this.service?.updateCharacteristic(this.platform.Characteristic.RotationSpeed, this.RotationSpeed);
-      this.debugLog(`Fan: ${this.accessory.displayName} updateCharacteristic RotationSpeed: ${this.RotationSpeed}`);
+      this.service?.updateCharacteristic(
+        this.platform.Characteristic.RotationSpeed,
+        this.RotationSpeed,
+      );
+      this.debugLog(
+        `Fan: ${this.accessory.displayName} updateCharacteristic RotationSpeed: ${this.RotationSpeed}`,
+      );
     }
   }
 
@@ -189,9 +244,9 @@ export class Fan {
   async pushFanOnChanges() {
     if (this.Active !== 1) {
       const payload = {
-        commandType: 'command',
-        parameter: 'default',
-        command: 'turnOn',
+        commandType: "command",
+        parameter: "default",
+        command: "turnOn",
       } as payload;
       await this.pushTVChanges(payload);
     }
@@ -199,87 +254,112 @@ export class Fan {
 
   async pushFanOffChanges() {
     const payload = {
-      commandType: 'command',
-      parameter: 'default',
-      command: 'turnOff',
+      commandType: "command",
+      parameter: "default",
+      command: "turnOff",
     } as payload;
     await this.pushTVChanges(payload);
   }
 
   async pushFanSpeedUpChanges() {
     const payload = {
-      commandType: 'command',
-      parameter: 'default',
-      command: 'highSpeed',
+      commandType: "command",
+      parameter: "default",
+      command: "highSpeed",
     } as payload;
     await this.pushTVChanges(payload);
   }
 
   async pushFanSpeedDownChanges() {
     const payload = {
-      commandType: 'command',
-      parameter: 'default',
-      command: 'lowSpeed',
+      commandType: "command",
+      parameter: "default",
+      command: "lowSpeed",
     } as payload;
     await this.pushTVChanges(payload);
   }
 
   async pushFanSwingChanges() {
     const payload = {
-      commandType: 'command',
-      parameter: 'default',
-      command: 'swing',
+      commandType: "command",
+      parameter: "default",
+      command: "swing",
     } as payload;
     await this.pushTVChanges(payload);
   }
 
   public async pushTVChanges(payload: payload) {
     try {
-      this.infoLog(`Fan: ${this.accessory.displayName} Sending request to SwitchBot API. command: ${payload.command},`
-        + ` parameter: ${payload.parameter}, commandType: ${payload.commandType}`);
+      this.infoLog(
+        `Fan: ${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.debugLog(`Fan: ${this.accessory.displayName} pushTVChanges: ${push.data}`);
+      const push = await this.platform.axios.post(
+        `${DeviceURL}/${this.device.deviceId}/commands`,
+        payload,
+      );
+      this.debugLog(
+        `Fan: ${this.accessory.displayName} pushTVChanges: ${push.data}`,
+      );
       this.statusCode(push);
       this.updateHomeKitCharacteristics();
     } catch (e: any) {
-      this.errorLog(`Fan: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection`);
-      if (this.deviceLogging === 'debug') {
-        this.errorLog(`Fan: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,`
-          + ` Error Message: ${JSON.stringify(e.message)}`);
+      this.errorLog(
+        `Fan: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection`,
+      );
+      if (this.deviceLogging === "debug") {
+        this.errorLog(
+          `Fan: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,` +
+            ` Error Message: ${JSON.stringify(e.message)}`,
+        );
       }
       if (this.platform.debugMode) {
-        this.errorLog(`Fan: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,`
-          + ` Error: ${JSON.stringify(e)}`);
+        this.errorLog(
+          `Fan: ${this.accessory.displayName} failed pushChanges with OpenAPI Connection,` +
+            ` Error: ${JSON.stringify(e)}`,
+        );
       }
       this.apiError(e);
     }
   }
 
-  private statusCode(push: AxiosResponse<{ statusCode: number; }>) {
+  private statusCode(push: AxiosResponse<{ statusCode: number }>) {
     switch (push.data.statusCode) {
       case 151:
-        this.errorLog(`Fan: ${this.accessory.displayName} Command not supported by this device type.`);
+        this.errorLog(
+          `Fan: ${this.accessory.displayName} Command not supported by this device type.`,
+        );
         break;
       case 152:
         this.errorLog(`Fan: ${this.accessory.displayName} Device not found.`);
         break;
       case 160:
-        this.errorLog(`Fan: ${this.accessory.displayName} Command is not supported.`);
+        this.errorLog(
+          `Fan: ${this.accessory.displayName} Command is not supported.`,
+        );
         break;
       case 161:
         this.errorLog(`Fan: ${this.accessory.displayName} Device is offline.`);
         break;
       case 171:
-        this.errorLog(`Fan: ${this.accessory.displayName} Hub Device is offline. Hub: ${this.device.hubDeviceId}`);
+        this.errorLog(
+          `Fan: ${this.accessory.displayName} Hub Device is offline. Hub: ${this.device.hubDeviceId}`,
+        );
         break;
       case 190:
-        this.errorLog(`Fan: ${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(
+          `Fan: ${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(`Fan: ${this.accessory.displayName} Command successfully sent.`);
+        this.debugLog(
+          `Fan: ${this.accessory.displayName} Command successfully sent.`,
+        );
         break;
       default:
         this.debugLog(`Fan: ${this.accessory.displayName} Unknown statusCode.`);
@@ -288,8 +368,14 @@ export class Fan {
 
   public apiError(e: any) {
     this.service.updateCharacteristic(this.platform.Characteristic.Active, e);
-    this.service.updateCharacteristic(this.platform.Characteristic.RotationSpeed, e);
-    this.service.updateCharacteristic(this.platform.Characteristic.SwingMode, e);
+    this.service.updateCharacteristic(
+      this.platform.Characteristic.RotationSpeed,
+      e,
+    );
+    this.service.updateCharacteristic(
+      this.platform.Characteristic.SwingMode,
+      e,
+    );
     //throw new this.platform.api.hap.HapStatusError(HAPStatus.SERVICE_COMMUNICATION_FAILURE);
   }
 
@@ -299,32 +385,43 @@ export class Fan {
       config = device.irfan;
     }
     if (device.logging !== undefined) {
-      config['logging'] = device.logging;
+      config["logging"] = device.logging;
     }
     if (Object.entries(config).length !== 0) {
-      this.warnLog(`Fan: ${this.accessory.displayName} Config: ${JSON.stringify(config)}`);
+      this.warnLog(
+        `Fan: ${this.accessory.displayName} Config: ${JSON.stringify(config)}`,
+      );
     }
   }
 
   logs(device: irdevice & irDevicesConfig) {
     if (this.platform.debugMode) {
-      this.deviceLogging = this.accessory.context.logging = 'debugMode';
-      this.debugLog(`Fan: ${this.accessory.displayName} Using Debug Mode Logging: ${this.deviceLogging}`);
+      this.deviceLogging = this.accessory.context.logging = "debugMode";
+      this.debugLog(
+        `Fan: ${this.accessory.displayName} Using Debug Mode Logging: ${this.deviceLogging}`,
+      );
     } else if (device.logging) {
       this.deviceLogging = this.accessory.context.logging = device.logging;
-      this.debugLog(`Fan: ${this.accessory.displayName} Using Device Config Logging: ${this.deviceLogging}`);
+      this.debugLog(
+        `Fan: ${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(`Fan: ${this.accessory.displayName} Using Platform Config Logging: ${this.deviceLogging}`);
+      this.deviceLogging = this.accessory.context.logging =
+        this.platform.config.options?.logging;
+      this.debugLog(
+        `Fan: ${this.accessory.displayName} Using Platform Config Logging: ${this.deviceLogging}`,
+      );
     } else {
-      this.deviceLogging = this.accessory.context.logging = 'standard';
-      this.debugLog(`Fan: ${this.accessory.displayName} Logging Not Set, Using: ${this.deviceLogging}`);
+      this.deviceLogging = this.accessory.context.logging = "standard";
+      this.debugLog(
+        `Fan: ${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));
@@ -345,8 +442,8 @@ export class Fan {
 
   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));
       }
@@ -354,6 +451,6 @@ export class Fan {
   }
 
   enablingDeviceLogging(): boolean {
-    return this.deviceLogging === 'debug' || this.deviceLogging === 'standard';
+    return this.deviceLogging.includes("debug") || this.deviceLogging === "standard";
   }
 }