@switchbot/homebridge-switchbot 1.12.8 → 1.12.9-beta.10

package/package.json

@@ -1,80 +1,80 @@
 {
-  "displayName": "Homebridge SwitchBot",
-  "name": "@switchbot/homebridge-switchbot",
-  "version": "1.12.8",
-  "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.4.0",
-    "node": "^14.19.0 || ^16.14.0"
-  },
-  "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",
-    "postpublish": "npm run clean",
-    "clean": "rimraf ./dist",
-    "test": "eslint src/**.ts"
-  },
-  "funding": [
-    {
-      "type": "Paypal",
-      "url": "https://paypal.me/donavanbecker"
+    "displayName": "Homebridge SwitchBot",
+    "name": "@switchbot/homebridge-switchbot",
+    "version": "1.12.9-beta.10",
+    "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.4.0",
+        "node": "^14.19.0 || ^16.14.0"
+    },
+    "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",
+        "postpublish": "npm run clean",
+        "clean": "rimraf ./dist",
+        "test": "eslint src/**.ts"
+    },
+    "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.26.1",
+        "rxjs": "^7.5.5"
+    },
+    "devDependencies": {
+        "@types/node": "^17.0.23",
+        "@typescript-eslint/eslint-plugin": "^5.17.0",
+        "@typescript-eslint/parser": "^5.17.0",
+        "eslint": "^8.12.0",
+        "eslint-config-prettier": "8.5.0",
+        "eslint-plugin-prettier": "4.0.0",
+        "homebridge": "^1.4.0",
+        "nodemon": "^2.0.15",
+        "npm-check-updates": "^12.5.7",
+        "prettier": "2.6.2",
+        "rimraf": "^3.0.2",
+        "ts-node": "^10.7.0",
+        "typescript": "^4.6.3",
+        "typescript-axios-wb": "^1.0.3"
+    },
+    "optionalDependencies": {
+        "node-switchbot": "^1.2.0"
     }
-  ],
-  "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.26.1",
-    "rxjs": "^7.5.5"
-  },
-  "devDependencies": {
-    "@types/node": "^17.0.21",
-    "@typescript-eslint/eslint-plugin": "^5.15.0",
-    "@typescript-eslint/parser": "^5.15.0",
-    "eslint": "^8.11.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-prettier": "4.0.0",
-    "homebridge": "^1.4.0",
-    "nodemon": "^2.0.15",
-    "npm-check-updates": "^12.5.4",
-    "prettier": "2.6.0",
-    "rimraf": "^3.0.2",
-    "ts-node": "^10.7.0",
-    "typescript": "^4.6.2",
-    "typescript-axios-wb": "^1.0.3"
-  },
-  "optionalDependencies": {
-    "node-switchbot": "^1.2.0"
-  }
 }

package/src/device/bot.ts

@@ -93,7 +93,9 @@ export class Bot {
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
       .setCharacteristic(this.platform.Characteristic.Model, 'SWITCHBOT-BOT-S1')
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
+      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!)
+      .setCharacteristic(this.platform.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision)
+      .getCharacteristic(this.platform.Characteristic.FirmwareRevision).updateValue(accessory.context.firmwareRevision);
 
     // get the service if it exists, otherwise create a new service
     // you can create multiple services for each accessory

package/src/device/colorbulb.ts

@@ -83,7 +83,9 @@ export class ColorBulb {
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
       .setCharacteristic(this.platform.Characteristic.Model, 'W1401400')
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
+      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!)
+      .setCharacteristic(this.platform.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision)
+      .getCharacteristic(this.platform.Characteristic.FirmwareRevision).updateValue(accessory.context.firmwareRevision);
 
     // get the Lightbulb service if it exists, otherwise create a new Lightbulb service
     // you can create multiple services for each accessory

package/src/device/contact.ts

@@ -71,7 +71,9 @@ export class Contact {
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
       .setCharacteristic(this.platform.Characteristic.Model, 'W1201500')
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
+      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!)
+      .setCharacteristic(this.platform.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision)
+      .getCharacteristic(this.platform.Characteristic.FirmwareRevision).updateValue(accessory.context.firmwareRevision);
 
     // get the Contact service if it exists, otherwise create a new Contact service
     // you can create multiple services for each accessory

package/src/device/curtain.ts

@@ -24,6 +24,8 @@ export class Curtain {
   slidePosition: deviceStatus['slidePosition'];
   moving: deviceStatus['moving'];
   brightness: deviceStatus['brightness'];
+  setPositionMode?: string | number;
+  Mode!: string;
 
   // BLE Others
   connected?: boolean;
@@ -49,6 +51,8 @@ export class Curtain {
   scanDuration!: number;
   deviceLogging!: string;
   deviceRefreshRate!: number;
+  setCloseMode!: string;
+  setOpenMode!: string;
 
   // Updates
   curtainUpdateInProgress!: boolean;
@@ -77,7 +81,9 @@ export class Curtain {
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
       .setCharacteristic(this.platform.Characteristic.Model, 'W0701600')
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId);
+      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId)
+      .setCharacteristic(this.platform.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision)
+      .getCharacteristic(this.platform.Characteristic.FirmwareRevision).updateValue(accessory.context.firmwareRevision);
 
     // get the WindowCovering service if it exists, otherwise create a new WindowCovering service
     // you can create multiple services for each accessory
@@ -528,12 +534,34 @@ export class Curtain {
         .join(':')
         .toLowerCase();
       this.debugLog(`Curtain: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
+      if (this.TargetPosition > 50) {
+        if (this.device.curtain?.setOpenMode === '1') {
+          this.setPositionMode = 1;
+          this.Mode = 'Silent Mode';
+        } else {
+          this.setPositionMode = 0;
+          this.Mode = 'Performance Mode';
+        }
+      } else {
+        if (this.device.curtain?.setCloseMode === '1') {
+          this.setPositionMode = 1;
+          this.Mode = 'Silent Mode';
+        } else {
+          this.setPositionMode = 0;
+          this.Mode = 'Performance Mode';
+        }
+      }
+      const adjustedMode = this.setPositionMode || null;
+      if (adjustedMode === null) {
+        this.Mode = 'Default Mode';
+      }
+      this.debugLog(`${this.accessory.displayName} Mode: ${this.Mode}`);
       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));
+            return device_list[0].runToPos(100 - Number(this.TargetPosition), adjustedMode);
           })
           .then(() => {
             this.debugLog(`Curtain: ${this.accessory.displayName} Done.`);
@@ -573,10 +601,24 @@ export class Curtain {
         if (this.TargetPosition !== this.CurrentPosition) {
           this.debugLog(`Pushing ${this.TargetPosition}`);
           const adjustedTargetPosition = 100 - Number(this.TargetPosition);
+          if (this.TargetPosition > 50) {
+            this.setPositionMode = this.device.curtain?.setOpenMode;
+          } else {
+            this.setPositionMode = this.device.curtain?.setCloseMode;
+          }
+          if (this.setPositionMode === '1') {
+            this.Mode = 'Silent Mode';
+          } else if (this.setPositionMode === '0') {
+            this.Mode = 'Performance Mode';
+          } else {
+            this.Mode = 'Default Mode';
+          }
+          this.debugLog(`${this.accessory.displayName} Mode: ${this.Mode}`);
+          const adjustedMode = this.setPositionMode || 'ff';
           const payload = {
             commandType: 'command',
             command: 'setPosition',
-            parameter: `0,ff,${adjustedTargetPosition}`,
+            parameter: `0,${adjustedMode},${adjustedTargetPosition}`,
           } as payload;
 
           this.infoLog(

package/src/device/humidifier.ts

@@ -77,7 +77,9 @@ export class Humidifier {
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
       .setCharacteristic(this.platform.Characteristic.Model, 'W0801800')
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
+      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!)
+      .setCharacteristic(this.platform.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision)
+      .getCharacteristic(this.platform.Characteristic.FirmwareRevision).updateValue(accessory.context.firmwareRevision);
 
     // get the service if it exists, otherwise create a new service
     // you can create multiple services for each accessory
@@ -124,7 +126,6 @@ export class Humidifier {
       })
       .onSet(this.handleRelativeHumidityHumidifierThresholdSet.bind(this));
 
-    // create a new Temperature Sensor service
     // Temperature Sensor Service
     if (device.humidifier?.hide_temperature || device.ble) {
       this.debugLog(`Humidifier: ${accessory.displayName} Removing Temperature Sensor Service`);

package/src/device/lock.ts

@@ -11,6 +11,7 @@ export class Lock {
   contactSensorService?: Service;
 
   // Characteristic Values
+  ContactSensorState!: CharacteristicValue;
   LockCurrentState!: CharacteristicValue;
   LockTargetState!: CharacteristicValue;
   LockTargetStateCached!: CharacteristicValue;
@@ -53,7 +54,9 @@ export class Lock {
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
       .setCharacteristic(this.platform.Characteristic.Model, 'W1601700')
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
+      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!)
+      .setCharacteristic(this.platform.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision)
+      .getCharacteristic(this.platform.Characteristic.FirmwareRevision).updateValue(accessory.context.firmwareRevision);
 
     // get the LockMechanism service if it exists, otherwise create a new LockMechanism service
     // you can create multiple services for each accessory
@@ -74,6 +77,22 @@ export class Lock {
     // create handlers for required characteristics
     this.lockService.getCharacteristic(this.platform.Characteristic.LockCurrentState).onSet(this.LockTargetStateSet.bind(this));
 
+    // Contact Sensor Service
+    if (device.lock?.hide_contactsensor) {
+      this.debugLog(`Lock: ${accessory.displayName} Removing Contact Sensor Service`);
+      this.contactSensorService = this.accessory.getService(this.platform.Service.ContactSensor);
+      accessory.removeService(this.contactSensorService!);
+    } else if (!this.contactSensorService) {
+      this.debugLog(`Lock: ${accessory.displayName} Add Contact Sensor Service`);
+      (this.contactSensorService =
+        this.accessory.getService(this.platform.Service.ContactSensor) || this.accessory.addService(this.platform.Service.ContactSensor)),
+      `${accessory.displayName} Contact Sensor`;
+
+      this.contactSensorService.setCharacteristic(this.platform.Characteristic.Name, `${accessory.displayName} Contact Sensor`);
+    } else {
+      this.debugLog(`Lock: ${accessory.displayName} Contact Sensor Service Not Added`);
+    }
+
     // Update Homekit
     this.updateHomeKitCharacteristics();
 
@@ -107,13 +126,24 @@ export class Lock {
       });
   }
 
+  //{"deviceId":"DBDC23B53139","deviceType":"Smart Lock","hubDeviceId":"E68B14109DA2","lockState":"locked","doorState":"opened","calibrate":true}
+
   async parseStatus(): Promise<void> {
     switch (this.lockState) {
-      case 'on':
+      case 'locked':
+        this.LockCurrentState = this.platform.Characteristic.LockCurrentState.SECURED;
+        this.LockTargetState = this.platform.Characteristic.LockTargetState.SECURED;
+        break;
+      default:
         this.LockCurrentState = this.platform.Characteristic.LockCurrentState.UNSECURED;
+        this.LockTargetState = this.platform.Characteristic.LockTargetState.UNSECURED;
+    }
+    switch (this.doorState) {
+      case 'opened':
+        this.ContactSensorState = this.platform.Characteristic.ContactSensorState.CONTACT_NOT_DETECTED;
         break;
       default:
-        this.LockCurrentState = this.platform.Characteristic.LockCurrentState.SECURED;
+        this.ContactSensorState = this.platform.Characteristic.ContactSensorState.CONTACT_DETECTED;
     }
     this.debugLog(`Lock: ${this.accessory.displayName} On: ${this.LockTargetState}`);
   }
@@ -123,9 +153,7 @@ export class Lock {
       this.deviceStatus = (await this.platform.axios.get(`${DeviceURL}/${this.device.deviceId}/status`)).data;
       this.debugLog(`Lock: ${this.accessory.displayName} refreshStatus: ${JSON.stringify(this.deviceStatus)}`);
       this.lockState = this.deviceStatus.body.lockState;
-      this.warnLog(`Lock: ${this.accessory.displayName} lockState: ${JSON.stringify(this.lockState)} (COPY THIS LOG)`);
       this.doorState = this.deviceStatus.body.doorState;
-      this.debugLog(`Lock: ${this.accessory.displayName} doorState: ${JSON.stringify(this.doorState)} (COPY THIS LOG)`);
       this.parseStatus();
       this.updateHomeKitCharacteristics();
     } catch (e: any) {
@@ -178,6 +206,14 @@ export class Lock {
   }
 
   async updateHomeKitCharacteristics(): Promise<void> {
+    if (!this.device.lock?.hide_contactsensor) {
+      if (this.ContactSensorState === undefined) {
+        this.debugLog(`Lock: ${this.accessory.displayName} ContactSensorState: ${this.ContactSensorState}`);
+      } else {
+        this.contactSensorService?.updateCharacteristic(this.platform.Characteristic.ContactSensorState, this.ContactSensorState);
+        this.debugLog(`Lock: ${this.accessory.displayName} updateCharacteristic ContactSensorState: ${this.ContactSensorState}`);
+      }
+    }
     if (this.LockTargetState === undefined) {
       this.debugLog(`Lock: ${this.accessory.displayName} LockTargetState: ${this.LockTargetState}`);
     } else {
@@ -188,11 +224,14 @@ export class Lock {
       this.debugLog(`Lock: ${this.accessory.displayName} LockCurrentState: ${this.LockCurrentState}`);
     } else {
       this.lockService.updateCharacteristic(this.platform.Characteristic.LockCurrentState, this.LockCurrentState);
-      this.debugLog(`Lock: ${this.accessory.displayName} updateCharacteristic LockTargetState: ${this.LockCurrentState}`);
+      this.debugLog(`Lock: ${this.accessory.displayName} updateCharacteristic LockCurrentState: ${this.LockCurrentState}`);
     }
   }
 
   async apiError(e: any): Promise<void> {
+    if (!this.device.lock?.hide_contactsensor) {
+      this.contactSensorService?.updateCharacteristic(this.platform.Characteristic.ContactSensorState, e);
+    }
     this.lockService.updateCharacteristic(this.platform.Characteristic.LockTargetState, e);
     this.lockService.updateCharacteristic(this.platform.Characteristic.LockCurrentState, e);
     //throw new this.platform.api.hap.HapStatusError(HAPStatus.SERVICE_COMMUNICATION_FAILURE);

package/src/device/meter.ts

@@ -79,7 +79,9 @@ export class Meter {
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
       .setCharacteristic(this.platform.Characteristic.Model, 'METERTH-S1')
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
+      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!)
+      .setCharacteristic(this.platform.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision)
+      .getCharacteristic(this.platform.Characteristic.FirmwareRevision).updateValue(accessory.context.firmwareRevision);
 
     // Temperature Sensor Service
     if (device.meter?.hide_temperature) {

package/src/device/meterplus.ts

@@ -79,7 +79,9 @@ export class MeterPlus {
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
       .setCharacteristic(this.platform.Characteristic.Model, this.model(device))
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
+      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!)
+      .setCharacteristic(this.platform.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision)
+      .getCharacteristic(this.platform.Characteristic.FirmwareRevision).updateValue(accessory.context.firmwareRevision);
 
     // Temperature Sensor Service
     if (device.meter?.hide_temperature) {

package/src/device/motion.ts

@@ -67,7 +67,9 @@ export class Motion {
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
       .setCharacteristic(this.platform.Characteristic.Model, 'W1101500')
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
+      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!)
+      .setCharacteristic(this.platform.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision)
+      .getCharacteristic(this.platform.Characteristic.FirmwareRevision).updateValue(accessory.context.firmwareRevision);
 
     // get the Battery service if it exists, otherwise create a new Motion service
     // you can create multiple services for each accessory

package/src/device/plug.ts

@@ -50,7 +50,9 @@ export class Plug {
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
       .setCharacteristic(this.platform.Characteristic.Model, this.model(device))
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
+      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!)
+      .setCharacteristic(this.platform.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision)
+      .getCharacteristic(this.platform.Characteristic.FirmwareRevision).updateValue(accessory.context.firmwareRevision);
 
     // get the Outlet service if it exists, otherwise create a new Outlet service
     // you can create multiple services for each accessory

package/src/device/striplight.ts

@@ -78,7 +78,9 @@ export class StripLight {
       .getService(this.platform.Service.AccessoryInformation)!
       .setCharacteristic(this.platform.Characteristic.Manufacturer, 'SwitchBot')
       .setCharacteristic(this.platform.Characteristic.Model, 'W1701100')
-      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
+      .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!)
+      .setCharacteristic(this.platform.Characteristic.FirmwareRevision, accessory.context.FirmwareRevision)
+      .getCharacteristic(this.platform.Characteristic.FirmwareRevision).updateValue(accessory.context.firmwareRevision);
 
     // get the Lightbulb service if it exists, otherwise create a new Lightbulb service
     // you can create multiple services for each accessory