@switchbot/homebridge-switchbot 4.1.4 → 4.1.6-beta.0

package/src/irdevice/irdevice.ts

@@ -1,6 +1,6 @@
 /* Copyright(C) 2021-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
  *
- * device.ts: @switchbot/homebridge-switchbot.
+ * irdevice.ts: @switchbot/homebridge-switchbot.
  */
 import type { API, CharacteristicValue, HAP, Logging, PlatformAccessory, Service } from 'homebridge'
 import type { bodyChange, irdevice } from 'node-switchbot'
@@ -16,9 +16,14 @@ export abstract class irdeviceBase {
 
   // Config
   protected deviceLogging!: string
-  protected disablePushOn!: boolean
-  protected disablePushOff!: boolean
-  protected disablePushDetail?: boolean
+  protected deviceRefreshRate!: number
+  protected deviceUpdateRate!: number
+  protected devicePushRate!: number
+  protected deviceMaxRetries!: number
+  protected deviceDelayBetweenRetries!: number
+  protected deviceDisablePushOn!: boolean
+  protected deviceDisablePushOff!: boolean
+  protected deviceDisablePushDetail?: boolean
 
   constructor(
     protected readonly platform: SwitchBotPlatform,
@@ -31,10 +36,9 @@ export abstract class irdeviceBase {
     this.hap = this.api.hap
 
     this.getDeviceLogSettings(accessory, device)
+    this.getDeviceRateSettings(device)
     this.getDeviceConfigSettings(device)
     this.getDeviceContext(accessory, device)
-    this.disablePushOnChanges(device)
-    this.disablePushOffChanges(device)
 
     // Set accessory information
     accessory
@@ -55,6 +59,41 @@ export abstract class irdeviceBase {
     this.debugLog(`Using ${logging} Logging: ${this.deviceLogging}`)
   }
 
+  async getDeviceRateSettings(device: irdevice & irDevicesConfig): Promise<void> {
+    // refreshRate
+    this.deviceRefreshRate = device.refreshRate ?? this.platform.platformRefreshRate ?? 300
+    const refreshRate = device.refreshRate ? 'Device Config' : this.platform.platformRefreshRate ? 'Platform Config' : 'Default'
+    this.accessory.context.refreshRate = this.deviceRefreshRate
+    // updateRate
+    this.deviceUpdateRate = device.updateRate ?? this.platform.platformUpdateRate ?? 5
+    const updateRate = device.updateRate ? 'Device Config' : this.platform.platformUpdateRate ? 'Platform Config' : 'Default'
+    this.accessory.context.updateRate = this.deviceUpdateRate
+    // pushRate
+    this.devicePushRate = device.pushRate ?? this.platform.platformPushRate ?? 0.1
+    const pushRate = device.pushRate ? 'Device Config' : this.platform.platformPushRate ? 'Platform Config' : 'Default'
+    this.accessory.context.pushRate = this.devicePushRate
+    this.debugLog(`Using ${refreshRate} refreshRate: ${this.deviceRefreshRate}, ${updateRate} updateRate: ${this.deviceUpdateRate}, ${pushRate} pushRate: ${this.devicePushRate}`)
+    // maxRetries
+    this.deviceMaxRetries = device.maxRetries ?? this.platform.platformMaxRetries ?? 2
+    const maxRetries = device.maxRetries ? 'Device' : this.platform.platformMaxRetries ? 'Platform' : 'Default'
+    this.debugLog(`Using ${maxRetries} Max Retries: ${this.deviceMaxRetries}`)
+    // delayBetweenRetries
+    this.deviceDelayBetweenRetries = device.delayBetweenRetries ? (device.delayBetweenRetries * 1000) : this.platform.platformDelayBetweenRetries ?? 3000
+    const delayBetweenRetries = device.delayBetweenRetries ? 'Device' : this.platform.platformDelayBetweenRetries ? 'Platform' : 'Default'
+    this.debugLog(`Using ${delayBetweenRetries} Delay Between Retries: ${this.deviceDelayBetweenRetries}`)
+
+    // disablePushOn
+    this.deviceDisablePushOn = device.disablePushOn ?? false
+    const disablePushOn = device.disablePushOn ? 'Device Config' : 'Default'
+    // disablePushOff
+    this.deviceDisablePushOff = device.disablePushOff ?? false
+    const disablePushOff = device.disablePushOff ? 'Device Config' : 'Default'
+    // disablePushDetail
+    this.deviceDisablePushDetail = device.disablePushDetail ?? false
+    const disablePushDetail = device.disablePushDetail ? 'Device Config' : 'Default'
+    this.debugLog(`Using ${disablePushOn} Disable Push On: ${this.deviceDisablePushOn}, ${disablePushOff} Disable Push Off: ${this.deviceDisablePushOff}, ${disablePushDetail} Disable Push Detail: ${this.deviceDisablePushDetail}`)
+  }
+
   async getDeviceConfigSettings(device: irdevice & irDevicesConfig): Promise<void> {
     const deviceConfig = Object.assign(
       {},
@@ -173,30 +212,6 @@ export abstract class irdeviceBase {
     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
-    } else {
-      this.disablePushOn = device.disablePushOn
-    }
-  }
-
-  async disablePushOffChanges(device: irdevice & irDevicesConfig): Promise<void> {
-    if (device.disablePushOff === undefined) {
-      this.disablePushOff = false
-    } else {
-      this.disablePushOff = device.disablePushOff
-    }
-  }
-
-  async disablePushDetailChanges(device: irdevice & irDevicesConfig): Promise<void> {
-    if (device.disablePushDetail === undefined) {
-      this.disablePushDetail = false
-    } else {
-      this.disablePushDetail = device.disablePushDetail
-    }
-  }
-
   async commandType(): Promise<string> {
     let commandType: string
     if (this.device.commandType && this.device.customize) {

package/src/irdevice/light.ts

@@ -166,8 +166,8 @@ export class Light extends irdeviceBase {
    * Light -       "command"       "channelSub"      "default"          =        previous channel
    */
   async pushLightOnChanges(On: boolean): Promise<void> {
-    this.debugLog(`pushLightOnChanges On: ${On}, disablePushOn: ${this.disablePushOn}`)
-    if (On === true && this.disablePushOn === false) {
+    this.debugLog(`pushLightOnChanges On: ${On}, disablePushOn: ${this.deviceDisablePushOn}`)
+    if (On === true && this.deviceDisablePushOn === false) {
       const commandType: string = await this.commandType()
       const command: string = await this.commandOn()
       const bodyChange: bodyChange = {
@@ -180,8 +180,8 @@ export class Light extends irdeviceBase {
   }
 
   async pushLightOffChanges(On: boolean): Promise<void> {
-    this.debugLog(`pushLightOffChanges On: ${On}, disablePushOff: ${this.disablePushOff}`)
-    if (On === false && this.disablePushOff === false) {
+    this.debugLog(`pushLightOffChanges On: ${On}, disablePushOff: ${this.deviceDisablePushOff}`)
+    if (On === false && this.deviceDisablePushOff === false) {
       const commandType: string = await this.commandType()
       const command: string = await this.commandOff()
       const bodyChange: bodyChange = {

package/src/irdevice/other.ts

@@ -407,9 +407,9 @@ export class Others extends irdeviceBase {
    * Other -       "command"       "channelSub"      "default"          =        previous channel
    */
   async pushOnChanges(On: boolean): Promise<void> {
-    this.debugLog(`pushOnChanges On: ${On}, disablePushOn: ${this.disablePushOn}, customize: ${this.device.customize}, customOn: ${this.device.customOn}`)
+    this.debugLog(`pushOnChanges On: ${On}, disablePushOn: ${this.deviceDisablePushOn}, customize: ${this.device.customize}, customOn: ${this.device.customOn}`)
     if (this.device.customize) {
-      if (On === true && !this.disablePushOn) {
+      if (On === true && !this.deviceDisablePushOn) {
         const commandType: string = await this.commandType()
         const command: string = await this.commandOn()
         const bodyChange: bodyChange = {
@@ -425,9 +425,9 @@ export class Others extends irdeviceBase {
   }
 
   async pushOffChanges(On: boolean): Promise<void> {
-    this.debugLog(`pushOffChanges On: ${On}, disablePushOff: ${this.disablePushOff}, customize: ${this.device.customize}, customOff: ${this.device.customOff}`)
+    this.debugLog(`pushOffChanges On: ${On}, disablePushOff: ${this.deviceDisablePushOff}, customize: ${this.device.customize}, customOff: ${this.device.customOff}`)
     if (this.device.customize) {
-      if (On === false && !this.disablePushOff) {
+      if (On === false && !this.deviceDisablePushOff) {
         const commandType: string = await this.commandType()
         const command: string = await this.commandOff()
         const bodyChange: bodyChange = {

package/src/irdevice/tv.ts

@@ -206,8 +206,8 @@ export class TV extends irdeviceBase {
    * TV           "command"       "channelSub"      "default"          previous channel
    */
   async pushTvOnChanges(): Promise<void> {
-    this.debugLog(`pushTvOnChanges Active: ${this.Television.Active}, disablePushOn: ${this.disablePushOn}`)
-    if (this.Television.Active === this.hap.Characteristic.Active.ACTIVE && !this.disablePushOn) {
+    this.debugLog(`pushTvOnChanges Active: ${this.Television.Active}, disablePushOn: ${this.deviceDisablePushOn}`)
+    if (this.Television.Active === this.hap.Characteristic.Active.ACTIVE && !this.deviceDisablePushOn) {
       const commandType: string = await this.commandType()
       const command: string = await this.commandOn()
       const bodyChange: bodyChange = {
@@ -220,8 +220,8 @@ export class TV extends irdeviceBase {
   }
 
   async pushTvOffChanges(): Promise<void> {
-    this.debugLog(`pushTvOffChanges Active: ${this.Television.Active}, disablePushOff: ${this.disablePushOff}`)
-    if (this.Television.Active === this.hap.Characteristic.Active.INACTIVE && !this.disablePushOff) {
+    this.debugLog(`pushTvOffChanges Active: ${this.Television.Active}, disablePushOff: ${this.deviceDisablePushOff}`)
+    if (this.Television.Active === this.hap.Characteristic.Active.INACTIVE && !this.deviceDisablePushOff) {
       const commandType: string = await this.commandType()
       const command: string = await this.commandOff()
       const bodyChange: bodyChange = {
@@ -234,8 +234,8 @@ export class TV extends irdeviceBase {
   }
 
   async pushOkChanges(): Promise<void> {
-    this.debugLog(`pushOkChanges disablePushDetail: ${this.disablePushDetail}`)
-    if (!this.disablePushDetail) {
+    this.debugLog(`pushOkChanges disablePushDetail: ${this.deviceDisablePushDetail}`)
+    if (!this.deviceDisablePushDetail) {
       const bodyChange: bodyChange = {
         command: 'Ok',
         parameter: 'default',
@@ -246,8 +246,8 @@ export class TV extends irdeviceBase {
   }
 
   async pushBackChanges(): Promise<void> {
-    this.debugLog(`pushBackChanges disablePushDetail: ${this.disablePushDetail}`)
-    if (!this.disablePushDetail) {
+    this.debugLog(`pushBackChanges disablePushDetail: ${this.deviceDisablePushDetail}`)
+    if (!this.deviceDisablePushDetail) {
       const bodyChange: bodyChange = {
         command: 'Back',
         parameter: 'default',
@@ -258,8 +258,8 @@ export class TV extends irdeviceBase {
   }
 
   async pushMenuChanges(): Promise<void> {
-    this.debugLog(`pushMenuChanges disablePushDetail: ${this.disablePushDetail}`)
-    if (!this.disablePushDetail) {
+    this.debugLog(`pushMenuChanges disablePushDetail: ${this.deviceDisablePushDetail}`)
+    if (!this.deviceDisablePushDetail) {
       const bodyChange: bodyChange = {
         command: 'Menu',
         parameter: 'default',
@@ -270,8 +270,8 @@ export class TV extends irdeviceBase {
   }
 
   async pushUpChanges(): Promise<void> {
-    this.debugLog(`pushUpChanges disablePushDetail: ${this.disablePushDetail}`)
-    if (!this.disablePushDetail) {
+    this.debugLog(`pushUpChanges disablePushDetail: ${this.deviceDisablePushDetail}`)
+    if (!this.deviceDisablePushDetail) {
       const bodyChange: bodyChange = {
         command: 'Up',
         parameter: 'default',
@@ -282,8 +282,8 @@ export class TV extends irdeviceBase {
   }
 
   async pushDownChanges(): Promise<void> {
-    this.debugLog(`pushDownChanges disablePushDetail: ${this.disablePushDetail}`)
-    if (!this.disablePushDetail) {
+    this.debugLog(`pushDownChanges disablePushDetail: ${this.deviceDisablePushDetail}`)
+    if (!this.deviceDisablePushDetail) {
       const bodyChange: bodyChange = {
         command: 'Down',
         parameter: 'default',
@@ -294,8 +294,8 @@ export class TV extends irdeviceBase {
   }
 
   async pushRightChanges(): Promise<void> {
-    this.debugLog(`pushRightChanges disablePushDetail: ${this.disablePushDetail}`)
-    if (!this.disablePushDetail) {
+    this.debugLog(`pushRightChanges disablePushDetail: ${this.deviceDisablePushDetail}`)
+    if (!this.deviceDisablePushDetail) {
       const bodyChange: bodyChange = {
         command: 'Right',
         parameter: 'default',
@@ -306,8 +306,8 @@ export class TV extends irdeviceBase {
   }
 
   async pushLeftChanges(): Promise<void> {
-    this.debugLog(`pushLeftChanges disablePushDetail: ${this.disablePushDetail}`)
-    if (!this.disablePushDetail) {
+    this.debugLog(`pushLeftChanges disablePushDetail: ${this.deviceDisablePushDetail}`)
+    if (!this.deviceDisablePushDetail) {
       const bodyChange: bodyChange = {
         command: 'Left',
         parameter: 'default',
@@ -318,8 +318,8 @@ export class TV extends irdeviceBase {
   }
 
   async pushVolumeUpChanges(): Promise<void> {
-    this.debugLog(`pushVolumeUpChanges disablePushDetail: ${this.disablePushDetail}`)
-    if (!this.disablePushDetail) {
+    this.debugLog(`pushVolumeUpChanges disablePushDetail: ${this.deviceDisablePushDetail}`)
+    if (!this.deviceDisablePushDetail) {
       const bodyChange: bodyChange = {
         command: 'volumeAdd',
         parameter: 'default',
@@ -330,8 +330,8 @@ export class TV extends irdeviceBase {
   }
 
   async pushVolumeDownChanges(): Promise<void> {
-    this.debugLog(`pushVolumeDownChanges disablePushDetail: ${this.disablePushDetail}`)
-    if (!this.disablePushDetail) {
+    this.debugLog(`pushVolumeDownChanges disablePushDetail: ${this.deviceDisablePushDetail}`)
+    if (!this.deviceDisablePushDetail) {
       const bodyChange: bodyChange = {
         command: 'volumeSub',
         parameter: 'default',

package/src/irdevice/vacuumcleaner.ts

@@ -65,8 +65,8 @@ export class VacuumCleaner extends irdeviceBase {
    * Vacuum Cleaner    "command"       "turnOn"       "default"       set to ON state
    */
   async pushOnChanges(): Promise<void> {
-    this.debugLog(`pushOnChanges On: ${this.Switch.On}, disablePushOn: ${this.disablePushOn}`)
-    if (this.Switch.On && !this.disablePushOn) {
+    this.debugLog(`pushOnChanges On: ${this.Switch.On}, disablePushOn: ${this.deviceDisablePushOn}`)
+    if (this.Switch.On && !this.deviceDisablePushOn) {
       const commandType: string = await this.commandType()
       const command: string = await this.commandOn()
       const bodyChange: bodyChange = {
@@ -79,8 +79,8 @@ export class VacuumCleaner extends irdeviceBase {
   }
 
   async pushOffChanges(): Promise<void> {
-    this.debugLog(`pushOffChanges On: ${this.Switch.On}, disablePushOff: ${this.disablePushOff}`)
-    if (!this.Switch.On && !this.disablePushOff) {
+    this.debugLog(`pushOffChanges On: ${this.Switch.On}, disablePushOff: ${this.deviceDisablePushOff}`)
+    if (!this.Switch.On && !this.deviceDisablePushOff) {
       const commandType: string = await this.commandType()
       const command: string = await this.commandOff()
       const bodyChange: bodyChange = {

package/src/irdevice/waterheater.ts

@@ -66,8 +66,8 @@ export class WaterHeater extends irdeviceBase {
    * WaterHeater     "command"       "turnOn"          "default"         set to ON state
    */
   async pushWaterHeaterOnChanges(): Promise<void> {
-    this.debugLog(`pushWaterHeaterOnChanges Active: ${this.Valve.Active}, disablePushOn: ${this.disablePushOn}`)
-    if (this.Valve.Active === this.hap.Characteristic.Active.ACTIVE && !this.disablePushOn) {
+    this.debugLog(`pushWaterHeaterOnChanges Active: ${this.Valve.Active}, disablePushOn: ${this.deviceDisablePushOn}`)
+    if (this.Valve.Active === this.hap.Characteristic.Active.ACTIVE && !this.deviceDisablePushOn) {
       const commandType: string = await this.commandType()
       const command: string = await this.commandOn()
       const bodyChange: bodyChange = {
@@ -80,8 +80,8 @@ export class WaterHeater extends irdeviceBase {
   }
 
   async pushWaterHeaterOffChanges(): Promise<void> {
-    this.debugLog(`pushWaterHeaterOffChanges Active: ${this.Valve.Active}, disablePushOff: ${this.disablePushOff}`)
-    if (this.Valve.Active === this.hap.Characteristic.Active.INACTIVE && !this.disablePushOff) {
+    this.debugLog(`pushWaterHeaterOffChanges Active: ${this.Valve.Active}, disablePushOff: ${this.deviceDisablePushOff}`)
+    if (this.Valve.Active === this.hap.Characteristic.Active.INACTIVE && !this.deviceDisablePushOff) {
       const commandType: string = await this.commandType()
       const command: string = await this.commandOff()
       const bodyChange: bodyChange = {

package/src/settings.ts

@@ -220,6 +220,11 @@ export interface irBaseDeviceConfig extends irdevice {
   connectionType?: string
   hide_device?: boolean
   external?: boolean
+  refreshRate?: number
+  updateRate?: number
+  pushRate?: number
+  maxRetries?: number
+  delayBetweenRetries?: number
   firmware?: string
   deviceId: string
   logging?: string