@switchbot/homebridge-switchbot 1.6.2 → 1.6.4-beta.2

package/package.json

@@ -1,74 +1,74 @@
 {
-  "displayName": "Homebridge SwitchBot",
-  "name": "@switchbot/homebridge-switchbot",
-  "version": "1.6.2",
-  "description": "The [Homebridge](https://homebridge.io) SwitchBot plugin allows you to access your [SwitchBot](https://www.switch-bot.com) device(s) from HomeKit.",
-  "author": "SwitchBot <support@wondertechlabs.com> (https://github.com/SwitchBot)",
-  "license": "ISC",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/OpenWonderLabs/homebridge-switchbot.git"
-  },
-  "bugs": {
-    "url": "https://github.com/OpenWonderLabs/homebridge-switchbot/issues"
-  },
-  "engines": {
-    "homebridge": "^1.3.9",
-    "node": "^14.18.2 || ^16.13.1"
-  },
-  "main": "dist/index.js",
-  "scripts": {
-    "check": "npm install && npm outdated",
-    "update": "ncu -u && npm update && npm install",
-    "lint": "eslint src/**.ts",
-    "watch": "npm run build && npm link && nodemon",
-    "build": "rimraf ./dist && tsc",
-    "prepublishOnly": "npm run lint && npm run build"
-  },
-  "funding": [
-    {
-      "type": "Paypal",
-      "url": "https://paypal.me/donavanbecker"
+    "displayName": "Homebridge SwitchBot",
+    "name": "@switchbot/homebridge-switchbot",
+    "version": "1.6.4-beta.2",
+    "description": "The [Homebridge](https://homebridge.io) SwitchBot plugin allows you to access your [SwitchBot](https://www.switch-bot.com) device(s) from HomeKit.",
+    "author": "SwitchBot <support@wondertechlabs.com> (https://github.com/SwitchBot)",
+    "license": "ISC",
+    "repository": {
+        "type": "git",
+        "url": "git://github.com/OpenWonderLabs/homebridge-switchbot.git"
     },
-    {
-      "type": "GitHub",
-      "url": "https://github.com/sponsors/donavanbecker"
+    "bugs": {
+        "url": "https://github.com/OpenWonderLabs/homebridge-switchbot/issues"
+    },
+    "engines": {
+        "homebridge": "^1.3.9",
+        "node": "^14.18.2 || ^16.13.1"
+    },
+    "main": "dist/index.js",
+    "scripts": {
+        "check": "npm install && npm outdated",
+        "update": "ncu -u && npm update && npm install",
+        "lint": "eslint src/**.ts",
+        "watch": "npm run build && npm link && nodemon",
+        "build": "rimraf ./dist && tsc",
+        "prepublishOnly": "npm run lint && npm run build"
+    },
+    "funding": [
+        {
+            "type": "Paypal",
+            "url": "https://paypal.me/donavanbecker"
+        },
+        {
+            "type": "GitHub",
+            "url": "https://github.com/sponsors/donavanbecker"
+        }
+    ],
+    "publishConfig": {
+        "access": "public"
+    },
+    "keywords": [
+        "homebridge-plugin",
+        "switchbot",
+        "humidifier",
+        "humidity",
+        "temperature",
+        "bot",
+        "curtains",
+        "windows",
+        "ble",
+        "ir"
+    ],
+    "dependencies": {
+        "@homebridge/plugin-ui-utils": "^0.0.19",
+        "axios": "^0.24.0",
+        "rxjs": "^7.5.1"
+    },
+    "devDependencies": {
+        "@types/node": "^17.0.7",
+        "@typescript-eslint/eslint-plugin": "^5.9.0",
+        "@typescript-eslint/parser": "^5.9.0",
+        "eslint": "^8.6.0",
+        "homebridge": "^1.3.9",
+        "nodemon": "^2.0.15",
+        "npm-check-updates": "^12.1.0",
+        "rimraf": "^3.0.2",
+        "ts-node": "^10.4.0",
+        "typescript": "^4.5.4",
+        "typescript-axios-wb": "^1.0.3"
+    },
+    "optionalDependencies": {
+        "node-switchbot": "^1.1.2"
     }
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "keywords": [
-    "homebridge-plugin",
-    "switchbot",
-    "humidifier",
-    "humidity",
-    "temperature",
-    "bot",
-    "curtains",
-    "windows",
-    "ble",
-    "ir"
-  ],
-  "dependencies": {
-    "@homebridge/plugin-ui-utils": "^0.0.19",
-    "axios": "^0.24.0",
-    "rxjs": "^7.5.1"
-  },
-  "devDependencies": {
-    "@types/node": "^17.0.7",
-    "@typescript-eslint/eslint-plugin": "^5.9.0",
-    "@typescript-eslint/parser": "^5.9.0",
-    "eslint": "^8.6.0",
-    "homebridge": "^1.3.9",
-    "nodemon": "^2.0.15",
-    "npm-check-updates": "^12.1.0",
-    "rimraf": "^3.0.2",
-    "ts-node": "^10.4.0",
-    "typescript": "^4.5.4",
-    "typescript-axios-wb": "^1.0.3"
-  },
-  "optionalDependencies": {
-    "node-switchbot": "^1.1.2"
-  }
-}
+}

package/src/devices/bots.ts

@@ -13,10 +13,13 @@ import { DeviceURL, device, devicesConfig, serviceData, ad, switchbot, deviceSta
  */
 export class Bot {
   // Services
-  private outletService?: Service;
   private switchService?: Service;
+  private doorService?: Service;
+  private garageDoorService?: Service;
+  private outletService?: Service;
   private batteryService?: Service;
 
+
   // Characteristic Values
   On!: CharacteristicValue;
   OnCached!: CharacteristicValue;
@@ -94,29 +97,56 @@ export class Bot {
     // get the LightBulb service if it exists, otherwise create a new LightBulb service
     // you can create multiple services for each accessory
     if (device.bot?.deviceType === 'switch') {
-      // If outletService still pressent, then remove first
-      if (this.outletService) {
-        this.debugLog(`Bot: ${accessory.displayName} Removing Leftover outletService first`);
-      }
-      this.outletService = this.accessory.getService(this.platform.Service.Outlet);
-      accessory.removeService(this.outletService!);
+      this.removeDoorService(accessory);
+      this.removeOutletService(accessory);
+      this.removeGarageDoorService(accessory);
 
       // Add switchService
       (this.switchService =
         accessory.getService(this.platform.Service.Switch) ||
         accessory.addService(this.platform.Service.Switch)), `${accessory.displayName} Switch`;
-      if (this.deviceLogging !== 'none') {
-        this.infoLog(`Bot: ${accessory.displayName} Displaying as Switch`);
-      }
+      this.infoLog(`Bot: ${accessory.displayName} Displaying as Switch`);
+
+      this.switchService.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
+      this.switchService.getCharacteristic(this.platform.Characteristic.On).onSet(this.handleOnSet.bind(this));
+    } else if (device.bot?.deviceType === 'garagedoor') {
+      this.removeDoorService(accessory);
+      this.removeOutletService(accessory);
+      this.removeSwitchService(accessory);
+
+      // Add switchService
+      (this.garageDoorService =
+        accessory.getService(this.platform.Service.GarageDoorOpener) ||
+        accessory.addService(this.platform.Service.GarageDoorOpener)), `${accessory.displayName} Garage Door Opener`;
+      this.infoLog(`Bot: ${accessory.displayName} Displaying as Garage Door Opener`);
+
+      this.garageDoorService.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
+      this.garageDoorService.getCharacteristic(this.platform.Characteristic.TargetDoorState).onSet(this.handleOnSet.bind(this));
+      this.garageDoorService.setCharacteristic(this.platform.Characteristic.ObstructionDetected, false);
+    } else if (device.bot?.deviceType === 'door') {
+      this.removeOutletService(accessory);
+      this.removeSwitchService(accessory);
+      this.removeGarageDoorService(accessory);
 
-      this.switchService?.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
+      // Add switchService
+      (this.doorService =
+        accessory.getService(this.platform.Service.Door) ||
+        accessory.addService(this.platform.Service.Door)), `${accessory.displayName} Door`;
+      this.infoLog(`Bot: ${accessory.displayName} Displaying as Garage Door Opener`);
+
+      this.doorService.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
+      this.doorService.getCharacteristic(this.platform.Characteristic.TargetPosition)
+        .setProps({
+          validValues: [0, 100],
+          minValue: 0,
+          maxValue: 100,
+          minStep: 100,
+        }).onSet(this.handleOnSet.bind(this));
+      this.doorService.setCharacteristic(this.platform.Characteristic.PositionState, this.platform.Characteristic.PositionState.STOPPED);
     } else {
-      // If switchService still pressent, then remove first
-      if (this.switchService) {
-        this.debugLog(`Bot: ${accessory.displayName} Removing Leftover switchService first`);
-      }
-      this.switchService = this.accessory.getService(this.platform.Service.Switch);
-      accessory.removeService(this.switchService!);
+      this.removeDoorService(accessory);
+      this.removeSwitchService(accessory);
+      this.removeGarageDoorService(accessory);
 
       // Add outletService
       (this.outletService =
@@ -124,7 +154,8 @@ export class Bot {
         accessory.addService(this.platform.Service.Outlet)), `${accessory.displayName} Outlet`;
       this.infoLog(`Bot: ${accessory.displayName} Displaying as Outlet`);
 
-      this.outletService?.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
+      this.outletService.setCharacteristic(this.platform.Characteristic.Name, accessory.displayName);
+      this.outletService.getCharacteristic(this.platform.Characteristic.On).onSet(this.handleOnSet.bind(this));
     }
 
     if (device.ble) {
@@ -135,15 +166,6 @@ export class Bot {
       this.batteryService.setCharacteristic(this.platform.Characteristic.Name, `${accessory.displayName} Battery`);
     }
 
-    // each service must implement at-minimum the "required characteristics" for the given service type
-    // see https://developers.homebridge.io/#/service/Outlet
-
-    if (device.bot?.deviceType === 'switch') {
-      this.switchService!.getCharacteristic(this.platform.Characteristic.On).onSet(this.handleOnSet.bind(this));
-    } else {
-      this.outletService!.getCharacteristic(this.platform.Characteristic.On).onSet(this.handleOnSet.bind(this));
-    }
-
     // Retrieve initial values and updateHomekit
     this.updateHomeKitCharacteristics();
 
@@ -185,6 +207,42 @@ export class Bot {
       });
   }
 
+  private removeOutletService(accessory: PlatformAccessory) {
+    // If outletService still pressent, then remove first
+    if (this.outletService) {
+      this.debugLog(`Bot: ${accessory.displayName} Removing Leftover outletService first`);
+    }
+    this.outletService = this.accessory.getService(this.platform.Service.Outlet);
+    accessory.removeService(this.outletService!);
+  }
+
+  private removeGarageDoorService(accessory: PlatformAccessory) {
+    // If garageDoorService still pressent, then remove first
+    if (this.garageDoorService) {
+      this.debugLog(`Bot: ${accessory.displayName} Removing Leftover garageDoorService first`);
+    }
+    this.garageDoorService = this.accessory.getService(this.platform.Service.GarageDoorOpener);
+    accessory.removeService(this.garageDoorService!);
+  }
+
+  private removeDoorService(accessory: PlatformAccessory) {
+    // If doorService still pressent, then remove first
+    if (this.doorService) {
+      this.debugLog(`Bot: ${accessory.displayName} Removing Leftover doorService first`);
+    }
+    this.doorService = this.accessory.getService(this.platform.Service.Door);
+    accessory.removeService(this.doorService!);
+  }
+
+  private removeSwitchService(accessory: PlatformAccessory) {
+    // If switchService still pressent, then remove first
+    if (this.switchService) {
+      this.debugLog(`Bot: ${accessory.displayName} Removing Leftover switchService first`);
+    }
+    this.switchService = this.accessory.getService(this.platform.Service.Switch);
+    accessory.removeService(this.switchService!);
+  }
+
   refreshRate() {
     if (this.device.refreshRate) {
       this.deviceRefreshRate = this.accessory.context.refreshRate = this.device.refreshRate;
@@ -335,8 +393,7 @@ export class Bot {
     // Convert to BLE Address
     const switchbot = this.connectBLE();
     // Start to monitor advertisement packets
-    this.debugLog(`Bot: ${this.accessory.displayName} platform.Switchbot: ${JSON.stringify(switchbot)}`);
-    if (switchbot) {
+    if (switchbot !== false) {
       switchbot.startScan({
         model: 'H',
         id: this.device.bleMac,
@@ -447,8 +504,7 @@ export class Bot {
     if (this.On !== this.OnCached) {
       this.debugLog(`Bot: ${this.accessory.displayName} BLE pushChanges`);
       const switchbot = this.connectBLE();
-      this.debugLog(`Bot: ${this.accessory.displayName} platform.Switchbot: ${JSON.stringify(switchbot)}`);
-      if (switchbot) {
+      if (switchbot !== false) {
         if (this.botMode === 'press') {
           this.debugLog(`Bot: ${this.accessory.displayName} Bot Mode: ${this.botMode}`);
           switchbot.discover({ model: 'H', quick: true, id: this.device.bleMac })
@@ -587,16 +643,61 @@ export class Bot {
    * Updates the status for each of the HomeKit Characteristics
    */
   updateHomeKitCharacteristics() {
-    if (this.On === undefined) {
-      this.debugLog(`Bot: ${this.accessory.displayName} On: ${this.On}`);
-    } else {
-      if (this.device.bot?.deviceType === 'switch') {
+    if (this.device.bot?.deviceType === 'garagedoor') {
+      if (this.On === undefined) {
+        this.debugLog(`Bot: ${this.accessory.displayName} On: ${this.On}`);
+      } else {
+        if (this.On) {
+          this.garageDoorService?.updateCharacteristic(this.platform.Characteristic.TargetDoorState,
+            this.platform.Characteristic.TargetDoorState.OPEN);
+          this.garageDoorService?.updateCharacteristic(this.platform.Characteristic.CurrentDoorState,
+            this.platform.Characteristic.CurrentDoorState.OPEN);
+          this.debugLog(`Bot: ${this.accessory.displayName} updateCharacteristic TargetDoorState: Open, CurrentDoorState: Open`);
+        } else {
+          this.garageDoorService?.updateCharacteristic(this.platform.Characteristic.TargetDoorState,
+            this.platform.Characteristic.TargetDoorState.CLOSED);
+          this.garageDoorService?.updateCharacteristic(this.platform.Characteristic.CurrentDoorState,
+            this.platform.Characteristic.CurrentDoorState.CLOSED);
+          this.debugLog(`Bot: ${this.accessory.displayName} updateCharacteristic TargetDoorState: Open, CurrentDoorState: Open`);
+        }
+      }
+      this.debugLog(`Bot: ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
+    } else if (this.device.bot?.deviceType === 'door') {
+      if (this.On === undefined) {
+        this.debugLog(`Bot: ${this.accessory.displayName} On: ${this.On}`);
+      } else {
+        if (this.On) {
+          this.doorService?.updateCharacteristic(this.platform.Characteristic.TargetPosition, 100);
+          this.doorService?.updateCharacteristic(this.platform.Characteristic.CurrentPosition, 100);
+          this.doorService?.updateCharacteristic(this.platform.Characteristic.PositionState,
+            this.platform.Characteristic.PositionState.STOPPED);
+          this.debugLog(`Bot: ${this.accessory.displayName} updateCharacteristic TargetPosition: 100, CurrentPosition: 100`);
+        } else {
+          this.doorService?.updateCharacteristic(this.platform.Characteristic.TargetPosition, 0);
+          this.doorService?.updateCharacteristic(this.platform.Characteristic.CurrentPosition, 0);
+          this.doorService?.updateCharacteristic(this.platform.Characteristic.PositionState,
+            this.platform.Characteristic.PositionState.STOPPED);
+          this.debugLog(`Bot: ${this.accessory.displayName} updateCharacteristic TargetPosition: 0, CurrentPosition: 0`);
+        }
+      }
+      this.debugLog(`Bot: ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
+    } else if (this.device.bot?.deviceType === 'switch') {
+      if (this.On === undefined) {
+        this.debugLog(`Bot: ${this.accessory.displayName} On: ${this.On}`);
+      } else {
         this.switchService?.updateCharacteristic(this.platform.Characteristic.On, this.On);
+        this.debugLog(`Bot: ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
+      }
+    } else {
+      if (this.On === undefined) {
+        this.debugLog(`Bot: ${this.accessory.displayName} On: ${this.On}`);
       } else {
         this.outletService?.updateCharacteristic(this.platform.Characteristic.On, this.On);
+        this.debugLog(`Bot: ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
       }
-      this.debugLog(`Bot: ${this.accessory.displayName} updateCharacteristic On: ${this.On}`);
     }
+
+
     if (this.device.ble) {
       if (this.BatteryLevel === undefined) {
         this.debugLog(`Bot: ${this.accessory.displayName} BatteryLevel: ${this.BatteryLevel}`);
@@ -614,7 +715,15 @@ export class Bot {
   }
 
   public apiError(e: any) {
-    if (this.device.bot?.deviceType === 'switch') {
+    if (this.device.bot?.deviceType === 'garagedoor') {
+      this.garageDoorService?.updateCharacteristic(this.platform.Characteristic.TargetDoorState, e);
+      this.garageDoorService?.updateCharacteristic(this.platform.Characteristic.CurrentDoorState, e);
+      this.garageDoorService?.updateCharacteristic(this.platform.Characteristic.ObstructionDetected, e);
+    } else if (this.device.bot?.deviceType === 'door') {
+      this.doorService?.updateCharacteristic(this.platform.Characteristic.TargetPosition, e);
+      this.doorService?.updateCharacteristic(this.platform.Characteristic.CurrentPosition, e);
+      this.doorService?.updateCharacteristic(this.platform.Characteristic.PositionState, e);
+    } else if (this.device.bot?.deviceType === 'switch') {
       this.switchService?.updateCharacteristic(this.platform.Characteristic.On, e);
     } else {
       this.outletService?.updateCharacteristic(this.platform.Characteristic.On, e);
@@ -672,8 +781,24 @@ export class Bot {
    * Handle requests to set the "On" characteristic
    */
   private handleOnSet(value: CharacteristicValue) {
-    this.debugLog(`Bot: ${this.accessory.displayName} On: ${value}`);
-    this.On = value;
+    if (this.device.bot?.deviceType === 'garagedoor') {
+      this.debugLog(`Bot: ${this.accessory.displayName} TargetDoorState: ${value}`);
+      if (value === this.platform.Characteristic.TargetDoorState.CLOSED) {
+        this.On = false;
+      } else {
+        this.On = true;
+      }
+    } else if (this.device.bot?.deviceType === 'door') {
+      this.debugLog(`Bot: ${this.accessory.displayName} TargetPosition: ${value}`);
+      if (value === 100) {
+        this.On = false;
+      } else {
+        this.On = true;
+      }
+    } else {
+      this.debugLog(`Bot: ${this.accessory.displayName} On: ${value}`);
+      this.On = value;
+    }
     this.doBotUpdate.next();
   }
 

package/src/devices/contact.ts

@@ -286,8 +286,7 @@ export class Contact {
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     const switchbot = this.connectBLE();
     // Start to monitor advertisement packets
-    this.debugLog(`Contact Sensor: ${this.accessory.displayName} platform.Switchbot: ${JSON.stringify(switchbot)}`);
-    if (switchbot) {
+    if (switchbot !== false) {
       switchbot.startScan({
         model: 'd',
         id: this.device.bleMac,

package/src/devices/curtains.ts

@@ -454,8 +454,7 @@ export class Curtain {
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     const switchbot = this.connectBLE();
     // Start to monitor advertisement packets
-    this.debugLog(`Curtain: ${this.accessory.displayName} platform.Switchbot: ${JSON.stringify(switchbot)}`);
-    if (switchbot) {
+    if (switchbot !== false) {
       switchbot.startScan({
         model: 'c',
         id: this.device.bleMac,
@@ -564,8 +563,7 @@ export class Curtain {
     if (this.TargetPosition !== this.CurrentPosition) {
       this.debugLog(`Curtain: ${this.accessory.displayName} BLE pushChanges`);
       const switchbot = this.connectBLE();
-      this.debugLog(`Curtain: ${this.accessory.displayName} platform.Switchbot: ${JSON.stringify(switchbot)}`);
-      if (switchbot) {
+      if (switchbot !== false) {
         switchbot.discover({ model: 'c', quick: true, id: this.device.bleMac }).then((device_list) => {
           this.infoLog(`${this.accessory.displayName} Target Position: ${this.TargetPosition}`);
           return device_list[0].runToPos(100 - Number(this.TargetPosition));

package/src/devices/humidifiers.ts

@@ -352,8 +352,7 @@ export class Humidifier {
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     const switchbot = this.connectBLE();
     // Start to monitor advertisement packets
-    this.debugLog(`Humidifier: ${this.accessory.displayName} platform.Switchbot: ${JSON.stringify(switchbot)}`);
-    if (switchbot) {
+    if (switchbot !== false) {
       switchbot.startScan({
         model: 'e',
         id: this.device.bleMac,
@@ -463,8 +462,7 @@ export class Humidifier {
   private async BLEpushChanges() {
     this.debugLog(`Humidifier: ${this.accessory.displayName} BLE pushChanges`);
     const switchbot = this.connectBLE();
-    this.debugLog(`Humidifier: ${this.accessory.displayName} platform.Switchbot: ${JSON.stringify(switchbot)}`);
-    if (switchbot) {
+    if (switchbot !== false) {
       switchbot.discover({ model: 'e', quick: true, id: this.device.bleMac }).then((device_list) => {
         this.infoLog(`${this.accessory.displayName} Target Position: ${this.Active}`);
         return device_list[0].percentage(this.RelativeHumidityHumidifierThreshold);

package/src/devices/meters.ts

@@ -317,8 +317,7 @@ export class Meter {
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     const switchbot = this.connectBLE();
     // Start to monitor advertisement packets
-    this.debugLog(`Meter: ${this.accessory.displayName} platform.Switchbot: ${JSON.stringify(switchbot)}`);
-    if (switchbot) {
+    if (switchbot !== false) {
       switchbot.startScan({
         model: 'T',
         id: this.device.bleMac,

package/src/devices/motion.ts

@@ -239,8 +239,7 @@ export class Motion {
     // eslint-disable-next-line @typescript-eslint/no-var-requires
     const switchbot = this.connectBLE();
     // Start to monitor advertisement packets
-    this.debugLog(`Motion Sensor: ${this.accessory.displayName} platform.Switchbot: ${JSON.stringify(switchbot)}`);
-    if (switchbot) {
+    if (switchbot !== false) {
       switchbot.startScan({
         model: 's',
         id: this.device.bleMac,