@switchbot/homebridge-switchbot 3.7.1-beta.11 → 3.7.1-beta.13

package/src/irdevice/irdevice.ts

@@ -2,41 +2,43 @@
  *
  * device.ts: @switchbot/homebridge-switchbot.
  */
-import { request } from 'undici';
-import { Devices } from '../settings.js';
+import type { API, CharacteristicValue, HAP, Logging, PlatformAccessory, Service } from 'homebridge'
 
-import type { SwitchBotPlatform } from '../platform.js';
-import type { API, HAP, Logging, PlatformAccessory, Service, CharacteristicValue } from 'homebridge';
-import type { SwitchBotPlatformConfig, irDevicesConfig } from '../settings.js';
-import type { irdevice } from '../types/irdevicelist.js';
+import type { SwitchBotPlatform } from '../platform.js'
+import type { irDevicesConfig, SwitchBotPlatformConfig } from '../settings.js'
+import type { irdevice } from '../types/irdevicelist.js'
+
+import { request } from 'undici'
+
+import { Devices } from '../settings.js'
 
 export abstract class irdeviceBase {
-  public readonly api: API;
-  public readonly log: Logging;
-  public readonly config!: SwitchBotPlatformConfig;
-  protected readonly hap: HAP;
+  public readonly api: API
+  public readonly log: Logging
+  public readonly config!: SwitchBotPlatformConfig
+  protected readonly hap: HAP
 
   // Config
-  protected deviceLogging!: string;
-  protected disablePushOn!: boolean;
-  protected disablePushOff!: boolean;
-  protected disablePushDetail?: boolean;
+  protected deviceLogging!: string
+  protected disablePushOn!: boolean
+  protected disablePushOff!: boolean
+  protected disablePushDetail?: boolean
 
   constructor(
     protected readonly platform: SwitchBotPlatform,
     protected accessory: PlatformAccessory,
     protected device: irdevice & irDevicesConfig,
   ) {
-    this.api = this.platform.api;
-    this.log = this.platform.log;
-    this.config = this.platform.config;
-    this.hap = this.api.hap;
+    this.api = this.platform.api
+    this.log = this.platform.log
+    this.config = this.platform.config
+    this.hap = this.api.hap
 
-    this.getDeviceLogSettings(device);
-    this.getDeviceConfigSettings(device);
-    this.getDeviceContext(accessory, device);
-    this.disablePushOnChanges(device);
-    this.disablePushOffChanges(device);
+    this.getDeviceLogSettings(device)
+    this.getDeviceConfigSettings(device)
+    this.getDeviceContext(accessory, device)
+    this.disablePushOnChanges(device)
+    this.disablePushOffChanges(device)
 
     // Set accessory information
     accessory
@@ -47,22 +49,22 @@ export abstract class irdeviceBase {
       .setCharacteristic(this.hap.Characteristic.ConfiguredName, accessory.displayName)
       .setCharacteristic(this.hap.Characteristic.Model, accessory.context.model ?? 'Unknown')
       .setCharacteristic(this.hap.Characteristic.ProductData, device.deviceId)
-      .setCharacteristic(this.hap.Characteristic.SerialNumber, device.deviceId);
+      .setCharacteristic(this.hap.Characteristic.SerialNumber, device.deviceId)
   }
 
   async getDeviceLogSettings(device: irdevice & irDevicesConfig): Promise<void> {
     if (this.platform.debugMode) {
-      this.deviceLogging = this.accessory.context.logging = 'debugMode';
-      await this.debugWarnLog(`Using Debug Mode Logging: ${this.deviceLogging}`);
+      this.deviceLogging = this.accessory.context.logging = 'debugMode'
+      await this.debugWarnLog(`Using Debug Mode Logging: ${this.deviceLogging}`)
     } else if (device.logging) {
-      this.deviceLogging = this.accessory.context.logging = device.logging;
-      await this.debugWarnLog(`Using Device Config Logging: ${this.deviceLogging}`);
+      this.deviceLogging = this.accessory.context.logging = device.logging
+      await this.debugWarnLog(`Using Device Config Logging: ${this.deviceLogging}`)
     } else if (this.config.logging) {
-      this.deviceLogging = this.accessory.context.logging = this.config.logging;
-      await this.debugWarnLog(`Using Platform Config Logging: ${this.deviceLogging}`);
+      this.deviceLogging = this.accessory.context.logging = this.config.logging
+      await this.debugWarnLog(`Using Platform Config Logging: ${this.deviceLogging}`)
     } else {
-      this.deviceLogging = this.accessory.context.logging = 'standard';
-      await this.debugWarnLog(`Logging Not Set, Using: ${this.deviceLogging}`);
+      this.deviceLogging = this.accessory.context.logging = 'standard'
+      await this.debugWarnLog(`Logging Not Set, Using: ${this.deviceLogging}`)
     }
   }
 
@@ -79,7 +81,7 @@ export abstract class irdeviceBase {
       device.disablePushOn === true && { disablePushOn: device.disablePushOn },
       device.disablePushOff === true && { disablePushOff: device.disablePushOff },
       device.disablePushDetail === true && { disablePushDetail: device.disablePushDetail },
-    );
+    )
     const config = Object.assign(
       {},
       deviceConfig,
@@ -92,29 +94,29 @@ export abstract class irdeviceBase {
       device.irtv,
       device.irvc,
       device.irwh,
-    );
+    )
     if (Object.keys(config).length !== 0) {
-      this.debugSuccessLog(`Config: ${JSON.stringify(config)}`);
+      this.debugSuccessLog(`Config: ${JSON.stringify(config)}`)
     }
   }
 
   async getDeviceContext(accessory: PlatformAccessory, device: irdevice & irDevicesConfig): Promise<void> {
-    accessory.context.name = device.deviceName;
-    accessory.context.model = device.remoteType;
-    accessory.context.deviceId = device.deviceId;
-    accessory.context.remoteType = device.remoteType;
-
-    const deviceFirmwareVersion = device.firmware ?? accessory.context.version ?? this.platform.version ?? '0.0.0';
-    const version = deviceFirmwareVersion.toString();
-    await this.debugLog(`version: ${version?.replace(/^V|-.*$/g, '')}`);
-    let deviceVersion: string;
+    accessory.context.name = device.deviceName
+    accessory.context.model = device.remoteType
+    accessory.context.deviceId = device.deviceId
+    accessory.context.remoteType = device.remoteType
+
+    const deviceFirmwareVersion = device.firmware ?? accessory.context.version ?? this.platform.version ?? '0.0.0'
+    const version = deviceFirmwareVersion.toString()
+    await this.debugLog(`version: ${version?.replace(/^V|-.*$/g, '')}`)
+    let deviceVersion: string
     if (version?.includes('.') === false) {
-      const replace = version?.replace(/^V|-.*$/g, '');
-      const match = replace?.match(/.{1,1}/g);
-      const validVersion = match?.join('.');
-      deviceVersion = validVersion ?? '0.0.0';
+      const replace = version?.replace(/^V|-.*$/g, '')
+      const match = replace?.match(/./g)
+      const validVersion = match?.join('.')
+      deviceVersion = validVersion ?? '0.0.0'
     } else {
-      deviceVersion = version.replace(/^V|-.*$/g, '') ?? '0.0.0';
+      deviceVersion = version.replace(/^V|-.*$/g, '') ?? '0.0.0'
     }
     accessory
       .getService(this.hap.Service.AccessoryInformation)!
@@ -122,118 +124,114 @@ export abstract class irdeviceBase {
       .setCharacteristic(this.hap.Characteristic.SoftwareRevision, deviceVersion)
       .setCharacteristic(this.hap.Characteristic.FirmwareRevision, deviceVersion)
       .getCharacteristic(this.hap.Characteristic.FirmwareRevision)
-      .updateValue(deviceVersion);
-    accessory.context.version = deviceVersion;
-    this.debugSuccessLog(`version: ${accessory.context.version}`);
+      .updateValue(deviceVersion)
+    accessory.context.version = deviceVersion
+    this.debugSuccessLog(`version: ${accessory.context.version}`)
   }
 
-  async pushChangeRequest(bodyChange: string): Promise<{ body: any; statusCode: any; }> {
+  async pushChangeRequest(bodyChange: string): Promise<{ body: any, statusCode: any }> {
     return await request(`${Devices}/${this.device.deviceId}/commands`, {
       body: bodyChange,
       method: 'POST',
       headers: this.platform.generateHeaders(),
-    });
+    })
   }
 
   async successfulStatusCodes(statusCode: any, deviceStatus: any) {
-    return (statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100);
+    return (statusCode === 200 || statusCode === 100) && (deviceStatus.statusCode === 200 || deviceStatus.statusCode === 100)
   }
 
   /**
-  * Update the characteristic value and log the change.
-  *
-  * @param Service: Service
-  * @param Characteristic: Characteristic
-  * @param CharacteristicValue: CharacteristicValue | undefined
-  * @param CharacteristicName: string
-  * @return: void
-  *
-  */
-  async updateCharacteristic(Service: Service, Characteristic: any,
-    CharacteristicValue: CharacteristicValue | undefined, CharacteristicName: string): Promise<void> {
+   * Update the characteristic value and log the change.
+   *
+   * @param Service Service
+   * @param Characteristic Characteristic
+   * @param CharacteristicValue CharacteristicValue | undefined
+   * @param CharacteristicName string
+   * @return: void
+   *
+   */
+  async updateCharacteristic(Service: Service, Characteristic: any, CharacteristicValue: CharacteristicValue | undefined, CharacteristicName: string): Promise<void> {
     if (CharacteristicValue === undefined) {
-      await this.debugLog(`${CharacteristicName}: ${CharacteristicValue}`);
+      await this.debugLog(`${CharacteristicName}: ${CharacteristicValue}`)
     } else {
-      Service.updateCharacteristic(Characteristic, CharacteristicValue);
-      await this.debugLog(`updateCharacteristic ${CharacteristicName}: ${CharacteristicValue}`);
-      await this.debugWarnLog(`${CharacteristicName} context before: ${this.accessory.context[CharacteristicName]}`);
-      this.accessory.context[CharacteristicName] = CharacteristicValue;
-      await this.debugWarnLog(`${CharacteristicName} context after: ${this.accessory.context[CharacteristicName]}`);
+      Service.updateCharacteristic(Characteristic, CharacteristicValue)
+      await this.debugLog(`updateCharacteristic ${CharacteristicName}: ${CharacteristicValue}`)
+      await this.debugWarnLog(`${CharacteristicName} context before: ${this.accessory.context[CharacteristicName]}`)
+      this.accessory.context[CharacteristicName] = CharacteristicValue
+      await this.debugWarnLog(`${CharacteristicName} context after: ${this.accessory.context[CharacteristicName]}`)
     }
   }
 
   async pushStatusCodes(statusCode: any, deviceStatus: any) {
-    await this.debugWarnLog(`statusCode: ${statusCode}`);
-    await this.debugWarnLog(`deviceStatus: ${JSON.stringify(deviceStatus)}`);
-    await this.debugWarnLog(`deviceStatus statusCode: ${deviceStatus.statusCode}`);
+    await this.debugWarnLog(`statusCode: ${statusCode}`)
+    await this.debugWarnLog(`deviceStatus: ${JSON.stringify(deviceStatus)}`)
+    await this.debugWarnLog(`deviceStatus statusCode: ${deviceStatus.statusCode}`)
   }
 
   async successfulPushChange(statusCode: any, deviceStatus: any, bodyChange: any) {
-    this.debugSuccessLog(`statusCode: ${statusCode} & deviceStatus `
-      + `StatusCode: ${deviceStatus.statusCode}`);
-    this.successLog('request to SwitchBot API,'
-      + ` body: ${JSON.stringify(JSON.parse(bodyChange))} sent successfully`);
+    this.debugSuccessLog(`statusCode: ${statusCode} & deviceStatus StatusCode: ${deviceStatus.statusCode}`)
+    this.successLog(`request to SwitchBot API, body: ${JSON.stringify(JSON.parse(bodyChange))} sent successfully`)
   }
 
   async pushChangeError(e: Error) {
-    this.errorLog(`failed pushChanges with ${this.device.connectionType}`
-      + ` Connection, Error Message: ${JSON.stringify(e.message)}`);
+    this.errorLog(`failed pushChanges with ${this.device.connectionType} Connection, Error Message: ${JSON.stringify(e.message)}`)
   }
 
   async disablePushOnChanges(device: irdevice & irDevicesConfig): Promise<void> {
     if (device.disablePushOn === undefined) {
-      this.disablePushOn = false;
+      this.disablePushOn = false
     } else {
-      this.disablePushOn = device.disablePushOn;
+      this.disablePushOn = device.disablePushOn
     }
   }
 
   async disablePushOffChanges(device: irdevice & irDevicesConfig): Promise<void> {
     if (device.disablePushOff === undefined) {
-      this.disablePushOff = false;
+      this.disablePushOff = false
     } else {
-      this.disablePushOff = device.disablePushOff;
+      this.disablePushOff = device.disablePushOff
     }
   }
 
   async disablePushDetailChanges(device: irdevice & irDevicesConfig): Promise<void> {
     if (device.disablePushDetail === undefined) {
-      this.disablePushDetail = false;
+      this.disablePushDetail = false
     } else {
-      this.disablePushDetail = device.disablePushDetail;
+      this.disablePushDetail = device.disablePushDetail
     }
   }
 
   async commandType(): Promise<string> {
-    let commandType: string;
+    let commandType: string
     if (this.device.commandType && this.device.customize) {
-      commandType = this.device.commandType;
+      commandType = this.device.commandType
     } else if (this.device.customize) {
-      commandType = 'customize';
+      commandType = 'customize'
     } else {
-      commandType = 'command';
+      commandType = 'command'
     }
-    return commandType;
+    return commandType
   }
 
   async commandOn(): Promise<string> {
-    let command: string;
+    let command: string
     if (this.device.customize && this.device.customOn) {
-      command = this.device.customOn;
+      command = this.device.customOn
     } else {
-      command = 'turnOn';
+      command = 'turnOn'
     }
-    return command;
+    return command
   }
 
   async commandOff(): Promise<string> {
-    let command: string;
+    let command: string
     if (this.device.customize && this.device.customOff) {
-      command = this.device.customOff;
+      command = this.device.customOff
     } else {
-      command = 'turnOff';
+      command = 'turnOff'
     }
-    return command;
+    return command
   }
 
   async statusCode(statusCode: number): Promise<void> {
@@ -255,15 +253,14 @@ export abstract class irdeviceBase {
       422: 'Unprocessable Entity: The server cannot process the request, often due to exceeded API limits.',
       429: 'Too Many Requests, exceeded the number of requests allowed for a given time window',
       500: 'Internal Server Error, An unexpected error occurred. These errors should be rare',
-    };
+    }
     if (statusCode === 171 && (this.device.hubDeviceId === this.device.deviceId || this.device.hubDeviceId === '000000000000')) {
-      this.debugErrorLog(`statusCode 171 changed to 161: hubDeviceId ${this.device.hubDeviceId} matches deviceId`
-        + ` ${this.device.deviceId}, device is its own hub.`);
-      statusCode = 161;
+      this.debugErrorLog(`statusCode 171 changed to 161: hubDeviceId ${this.device.hubDeviceId} matches deviceId ${this.device.deviceId}, device is its own hub.`)
+      statusCode = 161
     }
-    const logMessage = statusMessages[statusCode] || `Unknown statusCode: ${statusCode}, Submit Bugs Here: https://tinyurl.com/SwitchBotBug`;
-    const logMethod = [100, 200].includes(statusCode) ? 'debugLog' : statusMessages[statusCode] ? 'errorLog' : 'infoLog';
-    this[logMethod](`${logMessage}, statusCode: ${statusCode}`);
+    const logMessage = statusMessages[statusCode] || `Unknown statusCode: ${statusCode}, Submit Bugs Here: https://tinyurl.com/SwitchBotBug`
+    const logMethod = [100, 200].includes(statusCode) ? 'debugLog' : statusMessages[statusCode] ? 'errorLog' : 'infoLog'
+    this[logMethod](`${logMessage}, statusCode: ${statusCode}`)
   }
 
   /**
@@ -271,48 +268,48 @@ export abstract class irdeviceBase {
    */
   async infoLog(...log: any[]): Promise<void> {
     if (await this.enablingDeviceLogging()) {
-      this.log.info(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log));
+      this.log.info(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
     }
   }
 
   async successLog(...log: any[]): Promise<void> {
     if (await this.enablingDeviceLogging()) {
-      this.log.success(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log));
+      this.log.success(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
     }
   }
 
   async debugSuccessLog(...log: any[]): Promise<void> {
     if (await this.enablingDeviceLogging()) {
       if (await this.loggingIsDebug()) {
-        this.log.success(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log));
+        this.log.success(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
       }
     }
   }
 
   async warnLog(...log: any[]): Promise<void> {
     if (await this.enablingDeviceLogging()) {
-      this.log.warn(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log));
+      this.log.warn(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
     }
   }
 
   async debugWarnLog(...log: any[]): Promise<void> {
     if (await this.enablingDeviceLogging()) {
       if (await this.loggingIsDebug()) {
-        this.log.warn(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log));
+        this.log.warn(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
       }
     }
   }
 
   async errorLog(...log: any[]): Promise<void> {
     if (await this.enablingDeviceLogging()) {
-      this.log.error(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log));
+      this.log.error(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
     }
   }
 
   async debugErrorLog(...log: any[]): Promise<void> {
     if (await this.enablingDeviceLogging()) {
       if (await this.loggingIsDebug()) {
-        this.log.error(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log));
+        this.log.error(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
       }
     }
   }
@@ -320,18 +317,18 @@ export abstract class irdeviceBase {
   async debugLog(...log: any[]): Promise<void> {
     if (await this.enablingDeviceLogging()) {
       if (this.deviceLogging === 'debug') {
-        this.log.info(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log));
+        this.log.info(`[DEBUG] ${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
       } else if (this.deviceLogging === 'debugMode') {
-        this.log.debug(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log));
+        this.log.debug(`${this.device.remoteType}: ${this.accessory.displayName}`, String(...log))
       }
     }
   }
 
   async loggingIsDebug(): Promise<boolean> {
-    return this.deviceLogging === 'debugMode' || this.deviceLogging === 'debug';
+    return this.deviceLogging === 'debugMode' || this.deviceLogging === 'debug'
   }
 
   async enablingDeviceLogging(): Promise<boolean> {
-    return this.deviceLogging === 'debugMode' || this.deviceLogging === 'debug' || this.deviceLogging === 'standard';
+    return this.deviceLogging === 'debugMode' || this.deviceLogging === 'debug' || this.deviceLogging === 'standard'
   }
-}
+}