@switchbot/homebridge-switchbot 1.7.0 → 1.7.1-beta.11

package/dist/devices/bots.js

@@ -15,10 +15,11 @@ class Bot {
         this.accessory = accessory;
         this.device = device;
         // default placeholders
-        this.logs();
-        this.scan();
-        this.refreshRate();
+        this.logs(device);
+        this.scan(device);
+        this.refreshRate(device);
         this.PressOrSwitch();
+        this.config(device);
         if (this.On === undefined) {
             this.On = false;
             this.accessory.context.On = this.On;
@@ -35,9 +36,6 @@ class Bot {
         }
         this.BatteryLevel = 100;
         this.StatusLowBattery = 0;
-        // Bot Config
-        this.debugLog(`Bot: ${this.accessory.displayName} Config: (ble: ${device.ble}, offline: ${device.offline}, mode: ${device.bot?.mode},`
-            + ` deviceType: ${device.bot?.deviceType}, doublePress: ${this.doublePress})`);
         // this is subject we use to track when we need to POST changes to the SwitchBot API
         this.doBotUpdate = new rxjs_1.Subject();
         this.botUpdateInProgress = false;
@@ -60,6 +58,7 @@ class Bot {
             this.removeWindowService(accessory);
             this.removeGarageDoorService(accessory);
             this.removeWindowCoveringService(accessory);
+            this.removeStatefulProgrammableSwitchService(accessory);
             // Add switchService
             (this.switchService =
                 accessory.getService(this.platform.Service.Switch) ||
@@ -77,6 +76,7 @@ class Bot {
             this.removeSwitchService(accessory);
             this.removeWindowService(accessory);
             this.removeWindowCoveringService(accessory);
+            this.removeStatefulProgrammableSwitchService(accessory);
             // Add switchService
             (this.garageDoorService =
                 accessory.getService(this.platform.Service.GarageDoorOpener) ||
@@ -95,6 +95,7 @@ class Bot {
             this.removeWindowService(accessory);
             this.removeGarageDoorService(accessory);
             this.removeWindowCoveringService(accessory);
+            this.removeStatefulProgrammableSwitchService(accessory);
             // Add switchService
             (this.doorService =
                 accessory.getService(this.platform.Service.Door) ||
@@ -119,6 +120,7 @@ class Bot {
             this.removeSwitchService(accessory);
             this.removeGarageDoorService(accessory);
             this.removeWindowCoveringService(accessory);
+            this.removeStatefulProgrammableSwitchService(accessory);
             // Add switchService
             (this.windowService =
                 accessory.getService(this.platform.Service.Window) ||
@@ -143,6 +145,7 @@ class Bot {
             this.removeSwitchService(accessory);
             this.removeWindowService(accessory);
             this.removeGarageDoorService(accessory);
+            this.removeStatefulProgrammableSwitchService(accessory);
             // Add switchService
             (this.windowCoveringService =
                 accessory.getService(this.platform.Service.WindowCovering) ||
@@ -167,6 +170,7 @@ class Bot {
             this.removeWindowService(accessory);
             this.removeGarageDoorService(accessory);
             this.removeWindowCoveringService(accessory);
+            this.removeStatefulProgrammableSwitchService(accessory);
             // Add switchService
             (this.lockService =
                 accessory.getService(this.platform.Service.LockMechanism) ||
@@ -184,6 +188,7 @@ class Bot {
             this.removeWindowService(accessory);
             this.removeGarageDoorService(accessory);
             this.removeWindowCoveringService(accessory);
+            this.removeStatefulProgrammableSwitchService(accessory);
             // Add switchService
             (this.faucetService =
                 accessory.getService(this.platform.Service.Faucet) ||
@@ -201,6 +206,7 @@ class Bot {
             this.removeWindowService(accessory);
             this.removeGarageDoorService(accessory);
             this.removeWindowCoveringService(accessory);
+            this.removeStatefulProgrammableSwitchService(accessory);
             // Add switchService
             (this.fanService =
                 accessory.getService(this.platform.Service.Fan) ||
@@ -209,6 +215,25 @@ class Bot {
             this.fanService.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
             this.fanService.getCharacteristic(this.platform.Characteristic.On).onSet(this.handleOnSet.bind(this));
         }
+        else if (device.bot?.deviceType === 'stateful') {
+            this.removeFanService(accessory);
+            this.removeLockService(accessory);
+            this.removeDoorService(accessory);
+            this.removeFaucetService(accessory);
+            this.removeOutletService(accessory);
+            this.removeSwitchService(accessory);
+            this.removeWindowService(accessory);
+            this.removeGarageDoorService(accessory);
+            this.removeWindowCoveringService(accessory);
+            // Add switchService
+            (this.statefulProgrammableSwitchService =
+                accessory.getService(this.platform.Service.StatefulProgrammableSwitch) ||
+                    accessory.addService(this.platform.Service.StatefulProgrammableSwitch)), `${accessory.displayName} Stateful Programmable Switch`;
+            this.infoLog(`Bot: ${accessory.displayName} Displaying as Stateful Programmable Switch`);
+            this.statefulProgrammableSwitchService.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
+            this.statefulProgrammableSwitchService.getCharacteristic(this.platform.Characteristic.ProgrammableSwitchOutputState)
+                .onSet(this.handleOnSet.bind(this));
+        }
         else {
             this.removeFanService(accessory);
             this.removeLockService(accessory);
@@ -218,6 +243,7 @@ class Bot {
             this.removeWindowService(accessory);
             this.removeGarageDoorService(accessory);
             this.removeWindowCoveringService(accessory);
+            this.removeStatefulProgrammableSwitchService(accessory);
             // Add outletService
             (this.outletService =
                 accessory.getService(this.platform.Service.Outlet) ||
@@ -226,12 +252,22 @@ class Bot {
             this.outletService.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
             this.outletService.getCharacteristic(this.platform.Characteristic.On).onSet(this.handleOnSet.bind(this));
         }
-        if (device.ble) {
+        // Battery Service
+        if (!device.ble) {
+            this.debugLog(`Bot: ${accessory.displayName} Removing Battery Service`);
+            this.batteryService = this.accessory.getService(this.platform.Service.Battery);
+            accessory.removeService(this.batteryService);
+        }
+        else if (device.ble && !this.batteryService) {
+            this.debugLog(`Bot: ${accessory.displayName} Add Battery Service`);
             (this.batteryService =
-                accessory.getService(this.platform.Service.Battery) ||
-                    accessory.addService(this.platform.Service.Battery)), `${accessory.displayName} Battery`;
+                this.accessory.getService(this.platform.Service.Battery) ||
+                    this.accessory.addService(this.platform.Service.Battery)), `${accessory.displayName} Battery`;
             this.batteryService.setCharacteristic(this.platform.Characteristic.Name, `${accessory.displayName} Battery`);
         }
+        else {
+            this.debugLog(`Bot: ${accessory.displayName} Battery Service Not Added`);
+        }
         // Retrieve initial values and updateHomekit
         this.updateHomeKitCharacteristics();
         // Start an update interval
@@ -332,6 +368,14 @@ class Bot {
         }
         accessory.removeService(this.windowCoveringService);
     }
+    removeStatefulProgrammableSwitchService(accessory) {
+        // If statefulProgrammableSwitchService still pressent, then remove first
+        this.statefulProgrammableSwitchService = this.accessory.getService(this.platform.Service.StatefulProgrammableSwitch);
+        if (this.statefulProgrammableSwitchService) {
+            this.warnLog(`Bot: ${accessory.displayName} Removing Leftover Stateful Programmable Switch Service`);
+        }
+        accessory.removeService(this.statefulProgrammableSwitchService);
+    }
     removeSwitchService(accessory) {
         // If switchService still pressent, then remove first
         this.switchService = this.accessory.getService(this.platform.Service.Switch);
@@ -340,53 +384,54 @@ class Bot {
         }
         accessory.removeService(this.switchService);
     }
-    refreshRate() {
-        if (this.device.refreshRate) {
-            this.deviceRefreshRate = this.accessory.context.refreshRate = this.device.refreshRate;
-            if (this.platform.debugMode || (this.deviceLogging === 'debug')) {
-                this.warnLog(`Bot: ${this.accessory.displayName} Using Device Config refreshRate: ${this.deviceRefreshRate}`);
+    scan(device) {
+        if (device.scanDuration) {
+            this.scanDuration = this.accessory.context.scanDuration = device.scanDuration;
+            if (device.ble) {
+                this.debugLog(`Bot: ${this.accessory.displayName} Using Device Config scanDuration: ${this.scanDuration}`);
             }
         }
-        else if (this.platform.config.options.refreshRate) {
-            this.deviceRefreshRate = this.accessory.context.refreshRate = this.platform.config.options.refreshRate;
-            if (this.platform.debugMode || (this.deviceLogging === 'debug')) {
-                this.warnLog(`Bot: ${this.accessory.displayName} Using Platform Config refreshRate: ${this.deviceRefreshRate}`);
+        else {
+            this.scanDuration = this.accessory.context.scanDuration = 1;
+            if (this.device.ble) {
+                this.debugLog(`Bot: ${this.accessory.displayName} Using Default scanDuration: ${this.scanDuration}`);
             }
         }
     }
-    scan() {
-        if (this.device.scanDuration) {
-            this.scanDuration = this.accessory.context.scanDuration = this.device.scanDuration;
-            if (this.platform.debugMode || (this.deviceLogging === 'debug')) {
-                this.warnLog(`Bot: ${this.accessory.displayName} Using Device Config scanDuration: ${this.scanDuration}`);
-            }
+    config(device) {
+        if (device.bot !== undefined) {
+            device.bot['ble'] = device.ble;
+            device.bot['logging'] = this.deviceLogging;
+            device.bot['refreshRate'] = this.deviceRefreshRate;
+            this.warnLog(`Bot: ${this.accessory.displayName} Config: ${JSON.stringify(device.bot)}`);
         }
-        else {
-            this.scanDuration = this.accessory.context.scanDuration = 1;
-            if (this.platform.debugMode || (this.deviceLogging === 'debug')) {
-                this.warnLog(`Bot: ${this.accessory.displayName} Using Default scanDuration: ${this.scanDuration}`);
-            }
+    }
+    refreshRate(device) {
+        if (device.refreshRate) {
+            this.deviceRefreshRate = this.accessory.context.refreshRate = device.refreshRate;
+            this.debugLog(`Bot: ${this.accessory.displayName} Using Device Config refreshRate: ${this.deviceRefreshRate}`);
+        }
+        else if (this.platform.config.options.refreshRate) {
+            this.deviceRefreshRate = this.accessory.context.refreshRate = this.platform.config.options.refreshRate;
+            this.debugLog(`Bot: ${this.accessory.displayName} Using Platform Config refreshRate: ${this.deviceRefreshRate}`);
         }
     }
-    logs() {
+    logs(device) {
         if (this.platform.debugMode) {
-            this.deviceLogging = this.accessory.context.logging = 'debug';
-            this.warnLog(`Bot: ${this.accessory.displayName} Using Debug Mode Logging: ${this.deviceLogging}`);
+            this.deviceLogging = this.accessory.context.logging = 'debugMode';
+            this.debugLog(`Bot: ${this.accessory.displayName} Using Debug Mode Logging: ${this.deviceLogging}`);
         }
-        else if (this.device.logging) {
-            this.deviceLogging = this.accessory.context.logging = this.device.logging;
-            if (this.deviceLogging === 'debug' || this.deviceLogging === 'standard') {
-                this.warnLog(`Bot: ${this.accessory.displayName} Using Device Config Logging: ${this.deviceLogging}`);
-            }
+        else if (device.logging) {
+            this.deviceLogging = this.accessory.context.logging = device.logging;
+            this.debugLog(`Bot: ${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;
-            if (this.deviceLogging === 'debug' || this.deviceLogging === 'standard') {
-                this.warnLog(`Bot: ${this.accessory.displayName} Using Platform Config Logging: ${this.deviceLogging}`);
-            }
+            this.debugLog(`Bot: ${this.accessory.displayName} Using Platform Config Logging: ${this.deviceLogging}`);
         }
         else {
             this.deviceLogging = this.accessory.context.logging = 'standard';
+            this.debugLog(`Bot: ${this.accessory.displayName} Logging Not Set, Using: ${this.deviceLogging}`);
         }
     }
     PressOrSwitch() {
@@ -411,11 +456,11 @@ class Bot {
      * Parse the device status from the SwitchBot api
      */
     async parseStatus() {
-        if (this.device.ble) {
-            await this.BLEparseStatus();
+        if (this.SwitchToOpenAPI || !this.device.ble) {
+            await this.openAPIparseStatus();
         }
         else {
-            await this.openAPIparseStatus();
+            await this.BLEparseStatus();
         }
     }
     async BLEparseStatus() {
@@ -448,6 +493,9 @@ class Bot {
         this.debugLog(`Bot: ${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel}`);
     }
     async openAPIparseStatus() {
+        if (this.device.ble) {
+            this.SwitchToOpenAPI = false;
+        }
         if (this.platform.config.credentials?.openToken) {
             this.debugLog(`Bot: ${this.accessory.displayName} OpenAPI parseStatus`);
             if (this.botMode === 'press') {
@@ -456,15 +504,19 @@ class Bot {
                 this.accessory.context.On = this.OnCached;
             }
             else {
-                if (this.deviceStatus.body.power === 'on') {
-                    this.On = true;
-                    this.OnCached = this.On;
-                    this.accessory.context.On = this.OnCached;
-                }
-                else {
+                /*if (this.power === 'on') {
+                  this.On = true;
+                  this.OnCached = this.On;
+                  this.accessory.context.On = this.OnCached;
+                } else {
+                  this.On = false;
+                  this.OnCached = this.On;
+                  this.accessory.context.On = this.OnCached;
+                }*/
+                this.OnCached = this.On;
+                this.accessory.context.On = this.OnCached;
+                if (this.On === undefined) {
                     this.On = false;
-                    this.OnCached = this.On;
-                    this.accessory.context.On = this.OnCached;
                 }
             }
             this.debugLog(`Bot: ${this.accessory.displayName} On: ${this.On}`);
@@ -481,34 +533,12 @@ class Bot {
             await this.openAPIRefreshStatus();
         }
     }
-    async connectBLE() {
-        let switchbot;
-        try {
-            // eslint-disable-next-line @typescript-eslint/no-var-requires
-            const Switchbot = require('node-switchbot');
-            switchbot = new Switchbot();
-            // Convert to BLE Address
-            this.device.bleMac = ((this.device.deviceId.match(/.{1,2}/g)).join(':')).toLowerCase();
-            this.debugLog(`Bot: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
-        }
-        catch (e) {
-            switchbot = false;
-            this.errorLog(`Bot: ${this.accessory.displayName} 'node-switchbot' found: ${switchbot}`);
-            if (this.deviceLogging === 'debug') {
-                this.errorLog(`Bot: ${this.accessory.displayName} 'node-switchbot' found: ${switchbot},`
-                    + ` Error Message: ${JSON.stringify(e.message)}`);
-            }
-            if (this.platform.debugMode) {
-                this.errorLog(`Bot: ${this.accessory.displayName} 'node-switchbot' found: ${switchbot},`
-                    + ` Error: ${JSON.stringify(e)}`);
-            }
-        }
-        return switchbot;
-    }
     async BLERefreshStatus() {
         this.debugLog(`Bot: ${this.accessory.displayName} BLE refreshStatus`);
+        const switchbot = await this.platform.connectBLE();
         // Convert to BLE Address
-        const switchbot = await this.connectBLE();
+        this.device.bleMac = ((this.device.deviceId.match(/.{1,2}/g)).join(':')).toLowerCase();
+        this.debugLog(`Curtain: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
         // Start to monitor advertisement packets
         if (switchbot === false) {
             this.errorLog(`Bot: ${this.accessory.displayName} wasn't able to establish BLE Connection: ${switchbot}`);
@@ -548,6 +578,7 @@ class Bot {
                 this.errorLog(`Bot: ${this.accessory.displayName} wasn't able to establish BLE Connection`);
                 if (this.platform.config.credentials?.openToken) {
                     this.warnLog(`Bot: ${this.accessory.displayName} Using OpenAPI Connection`);
+                    this.SwitchToOpenAPI = true;
                     await this.openAPIRefreshStatus();
                 }
             }
@@ -563,6 +594,7 @@ class Bot {
             }
             if (this.platform.config.credentials?.openToken) {
                 this.warnLog(`Bot: ${this.accessory.displayName} Using OpenAPI Connection`);
+                this.SwitchToOpenAPI = true;
                 await this.openAPIRefreshStatus();
             }
             this.apiError(e);
@@ -574,6 +606,7 @@ class Bot {
             try {
                 this.deviceStatus = (await this.platform.axios.get(`${settings_1.DeviceURL}/${this.device.deviceId}/status`)).data;
                 this.debugLog(`Bot: ${this.accessory.displayName} refreshStatus: ${JSON.stringify(this.deviceStatus)}`);
+                this.power = this.deviceStatus.body.power;
                 this.parseStatus();
                 this.updateHomeKitCharacteristics();
             }
@@ -616,7 +649,10 @@ class Bot {
         this.debugLog(`Bot: ${this.accessory.displayName} BLE pushChanges On: ${this.On} OnCached: ${this.OnCached}`);
         if (this.On !== this.OnCached) {
             this.debugLog(`Bot: ${this.accessory.displayName} BLE pushChanges`);
-            const switchbot = await this.connectBLE();
+            const switchbot = await this.platform.connectBLE();
+            // Convert to BLE Address
+            this.device.bleMac = ((this.device.deviceId.match(/.{1,2}/g)).join(':')).toLowerCase();
+            this.debugLog(`Curtain: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
             //if (switchbot !== false) {
             if (this.botMode === 'press') {
                 this.debugLog(`Bot: ${this.accessory.displayName} Bot Mode: ${this.botMode}`);
@@ -886,6 +922,24 @@ class Bot {
             }
             this.debugLog(`Bot: ${this.accessory.displayName} Fan On: ${this.On}`);
         }
+        else if (this.device.bot?.deviceType === 'stateful') {
+            if (this.On === undefined) {
+                this.debugLog(`Bot: ${this.accessory.displayName} On: ${this.On}`);
+            }
+            else {
+                if (this.On) {
+                    this.statefulProgrammableSwitchService?.updateCharacteristic(this.platform.Characteristic.ProgrammableSwitchEvent, this.platform.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS);
+                    this.statefulProgrammableSwitchService?.updateCharacteristic(this.platform.Characteristic.ProgrammableSwitchOutputState, 1);
+                    this.debugLog(`Bot: ${this.accessory.displayName} updateCharacteristic ProgrammableSwitchEvent: SINGLE, ProgrammableSwitchOutputState: 1`);
+                }
+                else {
+                    this.statefulProgrammableSwitchService?.updateCharacteristic(this.platform.Characteristic.ProgrammableSwitchEvent, this.platform.Characteristic.ProgrammableSwitchEvent.SINGLE_PRESS);
+                    this.statefulProgrammableSwitchService?.updateCharacteristic(this.platform.Characteristic.ProgrammableSwitchOutputState, 0);
+                    this.debugLog(`Bot: ${this.accessory.displayName} updateCharacteristic ProgrammableSwitchEvent: SINGLE, ProgrammableSwitchOutputState: 0`);
+                }
+            }
+            this.debugLog(`Bot: ${this.accessory.displayName} StatefulProgrammableSwitch On: ${this.On}`);
+        }
         else if (this.device.bot?.deviceType === 'switch') {
             if (this.On === undefined) {
                 this.debugLog(`Bot: ${this.accessory.displayName} On: ${this.On}`);
@@ -952,6 +1006,10 @@ class Bot {
         else if (this.device.bot?.deviceType === 'fan') {
             this.fanService?.updateCharacteristic(this.platform.Characteristic.On, e);
         }
+        else if (this.device.bot?.deviceType === 'stateful') {
+            this.statefulProgrammableSwitchService?.updateCharacteristic(this.platform.Characteristic.ProgrammableSwitchEvent, e);
+            this.statefulProgrammableSwitchService?.updateCharacteristic(this.platform.Characteristic.ProgrammableSwitchOutputState, e);
+        }
         else if (this.device.bot?.deviceType === 'switch') {
             this.switchService?.updateCharacteristic(this.platform.Characteristic.On, e);
         }
@@ -1047,6 +1105,15 @@ class Bot {
                 this.On = true;
             }
         }
+        else if (this.device.bot?.deviceType === 'stateful') {
+            this.debugLog(`Bot: ${this.accessory.displayName} ProgrammableSwitchOutputState: ${value}`);
+            if (value === 0) {
+                this.On = false;
+            }
+            else {
+                this.On = true;
+            }
+        }
         else {
             this.debugLog(`Bot: ${this.accessory.displayName} On: ${value}`);
             this.On = value;