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

package/dist/device/bot.js

@@ -1,14 +1,10 @@
-/* Copyright(C) 2021-2024, donavanbecker (https://github.com/donavanbecker). All rights reserved.
- *
- * bot.ts: @switchbot/homebridge-switchbot.
- */
-import { deviceBase } from './device.js';
 /*
 * For Testing Locally:
 * import { SwitchBotBLEModel, SwitchBotBLEModelName } from '/Users/Shared/GitHub/OpenWonderLabs/node-switchbot/dist/index.js';
 */
 import { SwitchBotBLEModel, SwitchBotBLEModelName } from 'node-switchbot';
-import { Subject, debounceTime, interval, skipWhile, take, tap } from 'rxjs';
+import { debounceTime, interval, skipWhile, Subject, take, tap } from 'rxjs';
+import { deviceBase } from './device.js';
 /**
  * Platform Accessory
  * An instance of this class is created for each accessory your platform registers
@@ -31,7 +27,7 @@ export class Bot extends deviceBase {
     On;
     // OpenAPI
     deviceStatus;
-    //Webhook
+    // Webhook
     webhookContext;
     // BLE
     serviceData;
@@ -63,10 +59,7 @@ export class Bot extends deviceBase {
         };
         accessory.context.Battery = this.Battery;
         // Initialize Battery Characteristics
-        this.Battery.Service
-            .setCharacteristic(this.hap.Characteristic.Name, this.Battery.Name)
-            .setCharacteristic(this.hap.Characteristic.StatusLowBattery, this.Battery.StatusLowBattery)
-            .setCharacteristic(this.hap.Characteristic.ChargingState, this.hap.Characteristic.ChargingState.NOT_CHARGEABLE);
+        this.Battery.Service.setCharacteristic(this.hap.Characteristic.Name, this.Battery.Name).setCharacteristic(this.hap.Characteristic.StatusLowBattery, this.Battery.StatusLowBattery).setCharacteristic(this.hap.Characteristic.ChargingState, this.hap.Characteristic.ChargingState.NOT_CHARGEABLE);
         // deviceType
         if (this.botDeviceType === 'switch') {
             // Set category
@@ -80,10 +73,7 @@ export class Bot extends deviceBase {
             accessory.context.Switch = this.Switch;
             this.debugLog('Displaying as Switch');
             // Initialize Switch Characteristics
-            this.Switch.Service
-                .setCharacteristic(this.hap.Characteristic.Name, this.Switch.Name)
-                .getCharacteristic(this.hap.Characteristic.On)
-                .onSet(this.OnSet.bind(this));
+            this.Switch.Service.setCharacteristic(this.hap.Characteristic.Name, this.Switch.Name).getCharacteristic(this.hap.Characteristic.On).onSet(this.OnSet.bind(this));
             // Remove other services
             this.removeFanService(accessory);
             this.removeLockService(accessory);
@@ -107,17 +97,12 @@ export class Bot extends deviceBase {
             accessory.context.GarageDoor = this.GarageDoor;
             this.debugLog('Displaying as Garage Door Opener');
             // Initialize GarageDoor Characteristics
-            this.GarageDoor.Service
-                .setCharacteristic(this.hap.Characteristic.Name, this.GarageDoor.Name)
-                .setCharacteristic(this.hap.Characteristic.ObstructionDetected, false)
-                .getCharacteristic(this.hap.Characteristic.TargetDoorState)
-                .setProps({
+            this.GarageDoor.Service.setCharacteristic(this.hap.Characteristic.Name, this.GarageDoor.Name).setCharacteristic(this.hap.Characteristic.ObstructionDetected, false).getCharacteristic(this.hap.Characteristic.TargetDoorState).setProps({
                 validValues: [0, 100],
                 minValue: 0,
                 maxValue: 100,
                 minStep: 100,
-            })
-                .onSet(this.OnSet.bind(this));
+            }).onSet(this.OnSet.bind(this));
             // Remove other services
             this.removeFanService(accessory);
             this.removeLockService(accessory);
@@ -141,16 +126,12 @@ export class Bot extends deviceBase {
             accessory.context.Door = this.Door;
             this.debugLog('Displaying as Door');
             // Initialize Door Characteristics
-            this.Door.Service
-                .setCharacteristic(this.hap.Characteristic.Name, this.Door.Name)
-                .setCharacteristic(this.hap.Characteristic.PositionState, this.hap.Characteristic.PositionState.STOPPED)
-                .getCharacteristic(this.hap.Characteristic.TargetPosition).setProps({
+            this.Door.Service.setCharacteristic(this.hap.Characteristic.Name, this.Door.Name).setCharacteristic(this.hap.Characteristic.PositionState, this.hap.Characteristic.PositionState.STOPPED).getCharacteristic(this.hap.Characteristic.TargetPosition).setProps({
                 validValues: [0, 100],
                 minValue: 0,
                 maxValue: 100,
                 minStep: 100,
-            })
-                .onSet(this.OnSet.bind(this));
+            }).onSet(this.OnSet.bind(this));
             // Remove other services
             this.removeFanService(accessory);
             this.removeLockService(accessory);
@@ -174,16 +155,12 @@ export class Bot extends deviceBase {
             accessory.context.Window = this.Window;
             this.debugLog('Displaying as Window');
             // Initialize Window Characteristics
-            this.Window.Service
-                .setCharacteristic(this.hap.Characteristic.Name, this.Window.Name)
-                .setCharacteristic(this.hap.Characteristic.PositionState, this.hap.Characteristic.PositionState.STOPPED)
-                .getCharacteristic(this.hap.Characteristic.TargetPosition).setProps({
+            this.Window.Service.setCharacteristic(this.hap.Characteristic.Name, this.Window.Name).setCharacteristic(this.hap.Characteristic.PositionState, this.hap.Characteristic.PositionState.STOPPED).getCharacteristic(this.hap.Characteristic.TargetPosition).setProps({
                 validValues: [0, 100],
                 minValue: 0,
                 maxValue: 100,
                 minStep: 100,
-            })
-                .onSet(this.OnSet.bind(this));
+            }).onSet(this.OnSet.bind(this));
             // Remove other services
             this.removeFanService(accessory);
             this.removeLockService(accessory);
@@ -207,17 +184,12 @@ export class Bot extends deviceBase {
             accessory.context.WindowCovering = this.WindowCovering;
             this.debugLog('Displaying as Window Covering');
             // Initialize WindowCovering Characteristics
-            this.WindowCovering.Service
-                .setCharacteristic(this.hap.Characteristic.Name, this.WindowCovering.Name)
-                .setCharacteristic(this.hap.Characteristic.PositionState, this.hap.Characteristic.PositionState.STOPPED)
-                .getCharacteristic(this.hap.Characteristic.TargetPosition)
-                .setProps({
+            this.WindowCovering.Service.setCharacteristic(this.hap.Characteristic.Name, this.WindowCovering.Name).setCharacteristic(this.hap.Characteristic.PositionState, this.hap.Characteristic.PositionState.STOPPED).getCharacteristic(this.hap.Characteristic.TargetPosition).setProps({
                 validValues: [0, 100],
                 minValue: 0,
                 maxValue: 100,
                 minStep: 100,
-            })
-                .onSet(this.OnSet.bind(this));
+            }).onSet(this.OnSet.bind(this));
             // Remove other services
             this.removeFanService(accessory);
             this.removeLockService(accessory);
@@ -241,11 +213,7 @@ export class Bot extends deviceBase {
             accessory.context.LockMechanism = this.LockMechanism;
             this.debugLog('Displaying as Lock');
             // Initialize Lock Characteristics
-            this.LockMechanism.Service
-                .setCharacteristic(this.hap.Characteristic.Name, this.LockMechanism.Name)
-                .setCharacteristic(this.hap.Characteristic.PositionState, this.hap.Characteristic.PositionState.STOPPED)
-                .getCharacteristic(this.hap.Characteristic.LockTargetState)
-                .onSet(this.OnSet.bind(this));
+            this.LockMechanism.Service.setCharacteristic(this.hap.Characteristic.Name, this.LockMechanism.Name).setCharacteristic(this.hap.Characteristic.PositionState, this.hap.Characteristic.PositionState.STOPPED).getCharacteristic(this.hap.Characteristic.LockTargetState).onSet(this.OnSet.bind(this));
             // Remove other services
             this.removeFanService(accessory);
             this.removeDoorService(accessory);
@@ -269,10 +237,7 @@ export class Bot extends deviceBase {
             accessory.context.Faucet = this.Faucet;
             this.debugLog('Displaying as Faucet');
             // Initialize Faucet Characteristics
-            this.Faucet.Service
-                .setCharacteristic(this.hap.Characteristic.Name, this.Faucet.Name)
-                .getCharacteristic(this.hap.Characteristic.Active)
-                .onSet(this.OnSet.bind(this));
+            this.Faucet.Service.setCharacteristic(this.hap.Characteristic.Name, this.Faucet.Name).getCharacteristic(this.hap.Characteristic.Active).onSet(this.OnSet.bind(this));
             // Remove other services
             this.removeFanService(accessory);
             this.removeLockService(accessory);
@@ -296,10 +261,7 @@ export class Bot extends deviceBase {
             accessory.context.Fan = this.Fan;
             this.debugLog('Displaying as Fan');
             // Initialize Fan Characteristics
-            this.Fan.Service
-                .setCharacteristic(this.hap.Characteristic.Name, this.Fan.Name)
-                .getCharacteristic(this.hap.Characteristic.Active)
-                .onSet(this.OnSet.bind(this));
+            this.Fan.Service.setCharacteristic(this.hap.Characteristic.Name, this.Fan.Name).getCharacteristic(this.hap.Characteristic.Active).onSet(this.OnSet.bind(this));
             // Remove other services
             this.removeLockService(accessory);
             this.removeDoorService(accessory);
@@ -318,16 +280,12 @@ export class Bot extends deviceBase {
             accessory.context.StatefulProgrammableSwitch = accessory.context.StatefulProgrammableSwitch ?? {};
             this.StatefulProgrammableSwitch = {
                 Name: accessory.displayName,
-                Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch)
-                    ?? accessory.addService(this.hap.Service.StatefulProgrammableSwitch),
+                Service: accessory.getService(this.hap.Service.StatefulProgrammableSwitch) ?? accessory.addService(this.hap.Service.StatefulProgrammableSwitch),
             };
             accessory.context.StatefulProgrammableSwitch = this.StatefulProgrammableSwitch;
             this.debugLog('Displaying as Stateful Programmable Switch');
             // Initialize StatefulProgrammableSwitch Characteristics
-            this.StatefulProgrammableSwitch.Service
-                .setCharacteristic(this.hap.Characteristic.Name, this.StatefulProgrammableSwitch.Name)
-                .getCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState)
-                .onSet(this.OnSet.bind(this));
+            this.StatefulProgrammableSwitch.Service.setCharacteristic(this.hap.Characteristic.Name, this.StatefulProgrammableSwitch.Name).getCharacteristic(this.hap.Characteristic.ProgrammableSwitchOutputState).onSet(this.OnSet.bind(this));
             // Remove other services
             this.removeFanService(accessory);
             this.removeLockService(accessory);
@@ -351,10 +309,7 @@ export class Bot extends deviceBase {
             accessory.context.Outlet = this.Outlet;
             this.debugLog('Displaying as Outlet');
             // Initialize Outlet Characteristics
-            this.Outlet.Service
-                .setCharacteristic(this.hap.Characteristic.Name, this.Outlet.Name)
-                .getCharacteristic(this.hap.Characteristic.On)
-                .onSet(this.OnSet.bind(this));
+            this.Outlet.Service.setCharacteristic(this.hap.Characteristic.Name, this.Outlet.Name).getCharacteristic(this.hap.Characteristic.On).onSet(this.OnSet.bind(this));
             // Remove other services
             this.removeFanService(accessory);
             this.removeLockService(accessory);
@@ -377,7 +332,7 @@ export class Bot extends deviceBase {
         catch (e) {
             this.errorLog(`failed to retrieve initial values and update Homekit, Error: ${e}`);
         }
-        //regisiter webhook event handler if enabled
+        // regisiter webhook event handler if enabled
         try {
             this.debugLog('Registering Webhook Event Handler');
             this.registerWebhook();
@@ -385,7 +340,7 @@ export class Bot extends deviceBase {
         catch (e) {
             this.errorLog(`failed to registerWebhook, Error: ${e}`);
         }
-        //regisiter platform BLE event handler if enabled
+        // regisiter platform BLE event handler if enabled
         try {
             this.debugLog('Registering Platform BLE Event Handler');
             this.registerPlatformBLE();
@@ -430,8 +385,7 @@ export class Bot extends deviceBase {
      */
     async BLEparseStatus() {
         await this.debugLog('BLEparseStatus');
-        await this.debugLog(`(power, battery, deviceMode) = BLE:(${this.serviceData.state}, ${this.serviceData.battery}, ${this.serviceData.mode}),`
-            + ` current:(${this.accessory.context.On}, ${this.Battery.BatteryLevel}, ${this.botMode})`);
+        await this.debugLog(`(power, battery, deviceMode) = BLE:(${this.serviceData.state}, ${this.serviceData.battery}, ${this.serviceData.mode}), current:(${this.accessory.context.On}, ${this.Battery.BatteryLevel}, ${this.botMode})`);
         // BLEmode (true if Switch Mode) | (false if Press Mode)
         this.On = this.serviceData.mode ? this.serviceData.state : false;
         const mode = this.serviceData.mode ? 'Switch' : 'Press';
@@ -442,7 +396,8 @@ export class Bot extends deviceBase {
         await this.debugLog(`BatteryLevel: ${this.Battery.BatteryLevel}`);
         // StatusLowBattery
         this.Battery.StatusLowBattery = this.Battery.BatteryLevel < 10
-            ? this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW : this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
+            ? this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW
+            : this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
         await this.debugLog(`StatusLowBattery: ${this.Battery.StatusLowBattery}`);
     }
     /**
@@ -450,10 +405,9 @@ export class Bot extends deviceBase {
      */
     async openAPIparseStatus() {
         await this.debugLog('openAPIparseStatus');
-        await this.debugLog(`(power, battery, deviceMode) = API:(${this.deviceStatus.power}, ${this.deviceStatus.battery}, ${this.botMode}),`
-            + ` current:(${this.accessory.context.On}, ${this.Battery.BatteryLevel}, ${this.botMode})`);
+        await this.debugLog(`(power, battery, deviceMode) = API:(${this.deviceStatus.power}, ${this.deviceStatus.battery}, ${this.botMode}), current:(${this.accessory.context.On}, ${this.Battery.BatteryLevel}, ${this.botMode})`);
         // On
-        this.On = this.botMode === 'press' ? false : this.deviceStatus.power === 'on' ? true : false;
+        this.On = this.botMode === 'press' ? false : this.deviceStatus.power === 'on';
         this.accessory.context.On = this.On;
         await this.debugLog(`On: ${this.accessory.context.On}`);
         // Battery Level
@@ -461,7 +415,8 @@ export class Bot extends deviceBase {
         await this.debugLog(`BatteryLevel: ${this.Battery.BatteryLevel}`);
         // StatusLowBattery
         this.Battery.StatusLowBattery = this.Battery.BatteryLevel < 10
-            ? this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW : this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
+            ? this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW
+            : this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
         await this.debugLog(`StatusLowBattery: ${this.Battery.StatusLowBattery}`);
         // Firmware Version
         if (this.deviceStatus.version) {
@@ -480,17 +435,17 @@ export class Bot extends deviceBase {
     }
     async parseStatusWebhook() {
         await this.debugLog('parseStatusWebhook');
-        await this.debugLog(`(power, battery, deviceMode) = Webhook:(${this.webhookContext.power}, ${this.webhookContext.battery},`
-            + ` ${this.webhookContext.deviceMode}), current:(${this.On}, ${this.Battery.BatteryLevel}, ${this.botMode})`);
+        await this.debugLog(`(power, battery, deviceMode) = Webhook:(${this.webhookContext.power}, ${this.webhookContext.battery}, ${this.webhookContext.deviceMode}), current:(${this.On}, ${this.Battery.BatteryLevel}, ${this.botMode})`);
         // On
-        this.On = this.webhookContext.power === 'on' ? true : false;
+        this.On = this.webhookContext.power === 'on';
         await this.debugLog(`On: ${this.On}`);
         // BatteryLevel
         this.Battery.BatteryLevel = this.webhookContext.battery;
         await this.debugLog(`BatteryLevel: ${this.Battery.BatteryLevel}`);
         // StatusLowBattery
         this.Battery.StatusLowBattery = this.Battery.BatteryLevel < 10
-            ? this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW : this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
+            ? this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_LOW
+            : this.hap.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL;
         await this.debugLog(`StatusLowBattery: ${this.Battery.StatusLowBattery}`);
         // Mode
         this.botMode = this.webhookContext.deviceMode;
@@ -566,7 +521,6 @@ export class Bot extends deviceBase {
             const { body, statusCode } = await this.deviceRefreshStatus();
             const deviceStatus = await body.json();
             await this.debugLog(`statusCode: ${statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`);
-            ;
             if (await this.successfulStatusCodes(statusCode, deviceStatus)) {
                 await this.debugSuccessLog(`statusCode: ${statusCode}, deviceStatus: ${JSON.stringify(deviceStatus)}`);
                 this.deviceStatus = deviceStatus.body;
@@ -604,10 +558,10 @@ export class Bot extends deviceBase {
     }
     /**
      * Pushes the requested changes to the SwitchBot API
-     * deviceType	commandType	  Command	    command parameter	  Description
-     * Bot   -    "command"     "turnOff"   "default"	  =        set to OFF state
-     * Bot   -    "command"     "turnOn"    "default"	  =        set to ON state
-     * Bot   -    "command"     "press"     "default"	  =        trigger press
+     * deviceType  commandType  Command    command parameter  Description
+     * Bot         "command"    "turnOff"  "default"      =   set to OFF state
+     * Bot         "command"    "turnOn"   "default"      =   set to ON state
+     * Bot         "command"    "press"    "default"      =   trigger press
      */
     async pushChanges() {
         if (!this.device.enableCloudService && this.OpenAPI) {
@@ -637,7 +591,7 @@ export class Bot extends deviceBase {
             await this.debugLog(`BLEpushChanges On: ${this.On} OnCached: ${this.accessory.context.On}`);
             const switchbot = await this.platform.connectBLE(this.accessory, this.device);
             await this.convertBLEAddress();
-            //if (switchbot !== false) {
+            // if (switchbot !== false) {
             await this.debugLog(`Bot Mode: ${this.botMode}`);
             if (this.botMode === 'press') {
                 switchbot
@@ -764,9 +718,9 @@ export class Bot extends deviceBase {
                 this.On = true;
             }
         }
-        else if (this.botDeviceType === 'door' ||
-            this.botDeviceType === 'window' ||
-            this.botDeviceType === 'windowcovering') {
+        else if (this.botDeviceType === 'door'
+            || this.botDeviceType === 'window'
+            || this.botDeviceType === 'windowcovering') {
             this.debugLog(`Set TargetPosition: ${value}`);
             if (value === 0) {
                 this.On = false;
@@ -1117,38 +1071,48 @@ export class Bot extends deviceBase {
         accessory.removeService(this.Switch.Service);
     }
     async getBotConfigSettings(device) {
-        //Bot Device Type
-        this.botDeviceType = this.accessory.context.botDeviceType === device.bot?.deviceType ? this.accessory.context.botDeviceType
+        // Bot Device Type
+        this.botDeviceType = this.accessory.context.botDeviceType === device.bot?.deviceType
+            ? this.accessory.context.botDeviceType
             : device.bot?.deviceType ?? 'outlet';
-        const botDeviceType = this.accessory.context.botDeviceType ? `Using Device Type: ${this.botDeviceType}, from Accessory Cache.`
-            : device.bot?.deviceType ? `Using Device Type: ${this.botDeviceType}`
+        const botDeviceType = this.accessory.context.botDeviceType
+            ? `Using Device Type: ${this.botDeviceType}, from Accessory Cache.`
+            : device.bot?.deviceType
+                ? `Using Device Type: ${this.botDeviceType}`
                 : `No Device Type Set, deviceType: ${this.device.bot?.deviceType}, Using default deviceType: ${this.botDeviceType}`;
         await this.debugWarnLog(botDeviceType);
         this.accessory.context.botDeviceType = this.botDeviceType;
         // Bot Mode
         this.botMode = this.accessory.context.botMode ?? device.bot?.mode ?? 'switch';
-        const botMode = this.accessory.context.botMode ? `Using Bot Mode: ${this.botMode}, from Accessory Cache.`
+        const botMode = this.accessory.context.botMode
+            ? `Using Bot Mode: ${this.botMode}, from Accessory Cache.`
             : device.bot?.mode ? `Using Bot Mode: ${this.botMode}` : `No Bot Mode Set, Using default Bot Mode: ${this.botMode}`;
         await this.debugWarnLog(botMode);
         this.accessory.context.botMode = this.botMode;
         // Bot Double Press
         this.doublePress = this.accessory.context.doublePress ?? device.bot?.doublePress ?? 1;
-        const doublePress = this.accessory.context.doublePress ? `Using Double Press: ${this.doublePress}, from Accessory Cache.`
-            : device.bot?.doublePress ? `Using Double Press: ${this.doublePress}`
+        const doublePress = this.accessory.context.doublePress
+            ? `Using Double Press: ${this.doublePress}, from Accessory Cache.`
+            : device.bot?.doublePress
+                ? `Using Double Press: ${this.doublePress}`
                 : `No Double Press Set, Using default Double Press: ${this.doublePress}`;
         await this.debugWarnLog(doublePress);
         this.accessory.context.doublePress = this.doublePress;
         // Bot Press PushRate
         this.pushRatePress = this.accessory.context.pushRatePress ?? device.bot?.pushRatePress ?? 15;
-        const pushRatePress = this.accessory.context.pushRatePress ? `Using Push Rate Press: ${this.pushRatePress}, from Accessory Cache.`
-            : device.bot?.pushRatePress ? `Using Bot Push Rate Press: ${this.pushRatePress}`
+        const pushRatePress = this.accessory.context.pushRatePress
+            ? `Using Push Rate Press: ${this.pushRatePress}, from Accessory Cache.`
+            : device.bot?.pushRatePress
+                ? `Using Bot Push Rate Press: ${this.pushRatePress}`
                 : `No Push Rate Press Set, Using default Push Rate Press: ${this.pushRatePress}`;
         await this.debugWarnLog(pushRatePress);
         this.accessory.context.pushRatePress = this.pushRatePress;
         // Bot Allow Push
         this.allowPush = this.accessory.context.allowPush ?? device.bot?.allowPush ?? false;
-        const allowPush = this.accessory.context.allowPush ? `Using Allow Push: ${this.allowPush}, from Accessory Cache.`
-            : device.bot?.allowPush ? `Using Allow Push: ${this.allowPush}`
+        const allowPush = this.accessory.context.allowPush
+            ? `Using Allow Push: ${this.allowPush}, from Accessory Cache.`
+            : device.bot?.allowPush
+                ? `Using Allow Push: ${this.allowPush}`
                 : `No Allow Push Set, Using default Allow Push: ${this.allowPush}`;
         await this.debugWarnLog(allowPush);
         this.accessory.context.allowPush = this.allowPush;