@switchbot/homebridge-switchbot 1.6.0 → 1.6.2-beta.0

package/package.json

@@ -1,72 +1,74 @@
 {
-  "displayName": "Homebridge SwitchBot",
-  "name": "@switchbot/homebridge-switchbot",
-  "version": "1.6.0",
-  "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.2-beta.0",
+    "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.6",
+        "@typescript-eslint/eslint-plugin": "^5.8.1",
+        "@typescript-eslint/parser": "^5.8.1",
+        "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",
-    "node-switchbot": "^1.1.2",
-    "rxjs": "^7.5.1"
-  },
-  "devDependencies": {
-    "@types/node": "^17.0.5",
-    "@typescript-eslint/eslint-plugin": "^5.8.1",
-    "@typescript-eslint/parser": "^5.8.1",
-    "eslint": "^8.5.0",
-    "homebridge": "^1.3.9",
-    "nodemon": "^2.0.15",
-    "npm-check-updates": "^12.0.5",
-    "rimraf": "^3.0.2",
-    "ts-node": "^10.4.0",
-    "typescript": "^4.5.4",
-    "typescript-axios-wb": "^1.0.3"
-  }
 }

package/src/devices/bots.ts

@@ -1,6 +1,5 @@
 
 import { AxiosResponse } from 'axios';
-import Switchbot from 'node-switchbot';
 import { interval, Subject } from 'rxjs';
 import { SwitchBotPlatform } from '../platform';
 import { debounceTime, skipWhile, take, tap } from 'rxjs/operators';
@@ -325,10 +324,16 @@ export class Bot {
   }
 
   private connectBLE() {
-    const switchbot = new Switchbot();
-    this.device.bleMac = ((this.device.deviceId!.match(/.{1,2}/g))!.join(':')).toLowerCase();
-    this.debugLog(`Bot: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
-    return switchbot;
+    let Switchbot: any;
+    try {
+      Switchbot = require('node-switchbot');
+      const switchbot = new Switchbot();
+      this.device.bleMac = ((this.device.deviceId!.match(/.{1,2}/g))!.join(':')).toLowerCase();
+      this.debugLog(`Bot: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
+      return switchbot;
+    } catch (e) {
+      Switchbot = false;
+    }
   }
 
   private async BLERefreshStatus() {

package/src/devices/colorbulb.ts

@@ -36,9 +36,10 @@ export class ColorBulb {
   set_minStep?: number;
   deviceLogging!: string;
   deviceRefreshRate!: number;
+  adaptiveLightingShift?: number;
 
   // Adaptive Lighting
-  AdaptiveLightingController: ControllerConstructor | Controller<ControllerServiceMap>;
+  AdaptiveLightingController?: ControllerConstructor | Controller<ControllerServiceMap>;
   minKelvin: number;
   maxKelvin: number;
 
@@ -55,6 +56,7 @@ export class ColorBulb {
     // default placeholders
     this.logs();
     this.refreshRate();
+    this.adaptiveLighting();
     if (this.On === undefined) {
       this.On = false;
     } else {
@@ -68,7 +70,8 @@ export class ColorBulb {
     this.maxKelvin = 9000;
 
     // ColorBulb Config
-    this.debugLog(`Color Bulb: ${this.accessory.displayName} Config: (ble: ${device.ble}, set_minStep: ${device.colorbulb?.set_minStep}`);
+    this.debugLog(`Color Bulb: ${this.accessory.displayName} Config: (ble: ${device.ble}, set_minStep: ${device.colorbulb?.set_minStep},`
+      + ` adaptiveLighting: ${device.colorbulb?.adaptiveLightingShift})`);
 
     // this is subject we use to track when we need to POST changes to the SwitchBot API
     this.doColorBulbUpdate = new Subject();
@@ -85,12 +88,20 @@ export class ColorBulb {
       .setCharacteristic(this.platform.Characteristic.Model, 'SWITCHBOT-COLORBULB-W1401400')
       .setCharacteristic(this.platform.Characteristic.SerialNumber, device.deviceId!);
 
-    // get the Television service if it exists, otherwise create a new Television service
+    // get the Lightbulb service if it exists, otherwise create a new Lightbulb service
     // you can create multiple services for each accessory
     (this.service =
       accessory.getService(this.platform.Service.Lightbulb) ||
       accessory.addService(this.platform.Service.Lightbulb)), `${accessory.displayName} Light Bulb`;
 
+
+    if (this.adaptiveLightingShift === -1 && this.accessory.context.adaptiveLighting) {
+      this.accessory.removeService(this.service);
+      this.service = this.accessory.addService(this.platform.Service.Lightbulb);
+      this.accessory.context.adaptiveLighting = false;
+      this.debugLog(`Color Bulb: ${this.accessory.displayName} adaptiveLighting: ${this.accessory.context.adaptiveLighting}`);
+    }
+
     // To avoid "Cannot add a Service with the same UUID another Service without also defining a unique 'subtype' property." error,
     // when creating multiple services of the same type, you need to use the following syntax to specify a name and subtype id:
     // accessory.getService('NAME') ?? accessory.addService(this.platform.Service.Outlet, 'NAME', 'USER_DEFINED_SUBTYPE');
@@ -153,11 +164,17 @@ export class ColorBulb {
       })
       .onSet(this.SaturationSet.bind(this));
 
-    const adaptiveLightingShift = device.colorbulb?.adaptiveLightingShift || 0;
-    this.AdaptiveLightingController = new platform.api.hap.AdaptiveLightingController(this.service, {
-      customTemperatureAdjustment: adaptiveLightingShift,
-    });
-    this.accessory.configureController(this.AdaptiveLightingController);
+
+    this.debugLog(`Color Bulb: ${this.accessory.displayName} adaptiveLightingShift: ${this.adaptiveLightingShift}`);
+    if (this.adaptiveLightingShift !== -1) {
+      this.AdaptiveLightingController = new platform.api.hap.AdaptiveLightingController(this.service, {
+        customTemperatureAdjustment: this.adaptiveLightingShift,
+      });
+      this.accessory.configureController(this.AdaptiveLightingController);
+      this.accessory.context.adaptiveLighting = true;
+      this.debugLog(`Color Bulb: ${this.accessory.displayName} adaptiveLighting: ${this.accessory.context.adaptiveLighting},`
+        + ` adaptiveLightingShift: ${this.adaptiveLightingShift}`);
+    }
 
     // Update Homekit
     this.updateHomeKitCharacteristics();
@@ -230,6 +247,16 @@ export class ColorBulb {
     }
   }
 
+  adaptiveLighting() {
+    if (this.device.colorbulb?.adaptiveLightingShift) {
+      this.adaptiveLightingShift = this.device.colorbulb.adaptiveLightingShift;
+      this.debugLog(`Color Bulb: ${this.accessory.displayName} adaptiveLightingShift: ${this.adaptiveLightingShift}`);
+    } else {
+      this.adaptiveLightingShift = 0;
+      this.debugLog(`Color Bulb: ${this.accessory.displayName} adaptiveLightingShift: ${this.adaptiveLightingShift}`);
+    }
+  }
+
   private minStep(): number {
     if (this.device.colorbulb?.set_minStep) {
       this.set_minStep = this.device.colorbulb?.set_minStep;

package/src/devices/contact.ts

@@ -1,4 +1,3 @@
-import Switchbot from 'node-switchbot';
 import { interval, Subject } from 'rxjs';
 import { skipWhile } from 'rxjs/operators';
 import { SwitchBotPlatform } from '../platform';
@@ -275,10 +274,16 @@ export class Contact {
   }
 
   private connectBLE() {
-    const switchbot = new Switchbot();
-    this.device.bleMac = ((this.device.deviceId!.match(/.{1,2}/g))!.join(':')).toLowerCase();
-    this.debugLog(`Contact Sensor: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
-    return switchbot;
+    let Switchbot: any;
+    try {
+      Switchbot = require('node-switchbot');
+      const switchbot = new Switchbot();
+      this.device.bleMac = ((this.device.deviceId!.match(/.{1,2}/g))!.join(':')).toLowerCase();
+      this.debugLog(`Bot: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
+      return switchbot;
+    } catch (e) {
+      Switchbot = false;
+    }
   }
 
   private async BLERefreshStatus() {

package/src/devices/curtains.ts

@@ -1,6 +1,5 @@
 
 import { AxiosResponse } from 'axios';
-import Switchbot from 'node-switchbot';
 import { interval, Subject } from 'rxjs';
 import { SwitchBotPlatform } from '../platform';
 import { debounceTime, skipWhile, take, tap } from 'rxjs/operators';
@@ -255,10 +254,16 @@ export class Curtain {
   }
 
   private connectBLE() {
-    const switchbot = new Switchbot();
-    this.device.bleMac = ((this.device.deviceId!.match(/.{1,2}/g))!.join(':')).toLowerCase();
-    this.debugLog(`Curtain: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
-    return switchbot;
+    let Switchbot: any;
+    try {
+      Switchbot = require('node-switchbot');
+      const switchbot = new Switchbot();
+      this.device.bleMac = ((this.device.deviceId!.match(/.{1,2}/g))!.join(':')).toLowerCase();
+      this.debugLog(`Bot: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
+      return switchbot;
+    } catch (e) {
+      Switchbot = false;
+    }
   }
 
   private minStep(): number {

package/src/devices/humidifiers.ts

@@ -1,5 +1,4 @@
 import { AxiosResponse } from 'axios';
-import Switchbot from 'node-switchbot';
 import { interval, Subject } from 'rxjs';
 import { SwitchBotPlatform } from '../platform';
 import { debounceTime, skipWhile, take, tap } from 'rxjs/operators';
@@ -341,10 +340,16 @@ export class Humidifier {
   }
 
   private connectBLE() {
-    const switchbot = new Switchbot();
-    this.device.bleMac = ((this.device.deviceId!.match(/.{1,2}/g))!.join(':')).toLowerCase();
-    this.debugLog(`Humidifier: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
-    return switchbot;
+    let Switchbot: any;
+    try {
+      Switchbot = require('node-switchbot');
+      const switchbot = new Switchbot();
+      this.device.bleMac = ((this.device.deviceId!.match(/.{1,2}/g))!.join(':')).toLowerCase();
+      this.debugLog(`Bot: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
+      return switchbot;
+    } catch (e) {
+      Switchbot = false;
+    }
   }
 
   private async BLERefreshStatus() {

package/src/devices/meters.ts

@@ -1,4 +1,3 @@
-import Switchbot from 'node-switchbot';
 import { interval, Subject } from 'rxjs';
 import { skipWhile } from 'rxjs/operators';
 import { SwitchBotPlatform } from '../platform';
@@ -305,12 +304,19 @@ export class Meter {
   }
 
   private connectBLE() {
-    const switchbot = new Switchbot();
-    this.device.bleMac = ((this.device.deviceId!.match(/.{1,2}/g))!.join(':')).toLowerCase();
-    this.debugLog(`Meter: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
-    return switchbot;
+    let Switchbot: any;
+    try {
+      Switchbot = require('node-switchbot');
+      const switchbot = new Switchbot();
+      this.device.bleMac = ((this.device.deviceId!.match(/.{1,2}/g))!.join(':')).toLowerCase();
+      this.debugLog(`Bot: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
+      return switchbot;
+    } catch (e) {
+      Switchbot = false;
+    }
   }
 
+
   private BLErefreshStatus() {
     this.debugLog(`Meter: ${this.accessory.displayName} BLE RefreshStatus`);
     // eslint-disable-next-line @typescript-eslint/no-var-requires

package/src/devices/motion.ts

@@ -1,4 +1,3 @@
-import Switchbot from 'node-switchbot';
 import { interval, Subject } from 'rxjs';
 import { skipWhile } from 'rxjs/operators';
 import { SwitchBotPlatform } from '../platform';
@@ -194,10 +193,25 @@ export class Motion {
   }
 
   private async openAPIparseStatus() {
-    if (this.platform.config.credentials?.openToken) {
-      this.debugLog(`Motion Sensor: ${this.accessory.displayName} OpenAPI parseStatus`);
-      this.MotionDetected = Boolean(this.deviceStatus.body.moveDetected);
-      this.debugLog(`Motion Sensor: ${this.accessory.displayName} MotionDetected: ${this.MotionDetected}`);
+    try {
+      if (this.platform.config.credentials?.openToken) {
+        this.debugLog(`Motion Sensor: ${this.accessory.displayName} OpenAPI parseStatus`);
+        if (typeof this.deviceStatus.body.moveDetected === 'boolean') {
+          this.MotionDetected = this.deviceStatus.body.moveDetected;
+        }
+        this.debugLog(`Motion Sensor: ${this.accessory.displayName} MotionDetected: ${this.MotionDetected}`);
+      }
+    } catch (e: any) {
+      this.errorLog(`Motion Sensor: ${this.accessory.displayName} failed parseStatus with OpenAPI Connection`);
+      if (this.deviceLogging === 'debug') {
+        this.errorLog(`Motion Sensor: ${this.accessory.displayName} failed parseStatus with OpenAPI Connection,`
+          + ` Error Message: ${JSON.stringify(e.message)}`);
+      }
+      if (this.platform.debugMode) {
+        this.errorLog(`Motion Sensor: ${this.accessory.displayName} failed parseStatus with OpenAPI Connection,`
+          + ` Error: ${JSON.stringify(e)}`);
+      }
+      this.apiError(e);
     }
   }
 
@@ -213,10 +227,16 @@ export class Motion {
   }
 
   private connectBLE() {
-    const switchbot = new Switchbot();
-    this.device.bleMac = ((this.device.deviceId!.match(/.{1,2}/g))!.join(':')).toLowerCase();
-    this.debugLog(`Motion Sensor: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
-    return switchbot;
+    let Switchbot: any;
+    try {
+      Switchbot = require('node-switchbot');
+      const switchbot = new Switchbot();
+      this.device.bleMac = ((this.device.deviceId!.match(/.{1,2}/g))!.join(':')).toLowerCase();
+      this.debugLog(`Bot: ${this.accessory.displayName} BLE Address: ${this.device.bleMac}`);
+      return switchbot;
+    } catch (e) {
+      Switchbot = false;
+    }
   }
 
   private async BLERefreshStatus() {