@switchbot/homebridge-switchbot 3.7.1-beta.2 → 3.7.1-beta.21

package/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file. This project uses [Semantic Versioning](https://semver.org/)
 
+## [3.7.1](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v3.7.1) (2024-07-23)
+
+### What's Changed
+- Added specific macOS Bluetooth permission instructions to Readme [#1026](https://github.com/OpenWonderLabs/homebridge-switchbot/pull/1026), Thanks [@rSffsE](https://github.com/rSffsE)
+- Fixed Platform BLE Scanning events not registering
+- Fix `On` state for robot vacuum cleaners [#1028](https://github.com/OpenWonderLabs/homebridge-switchbot/pull/1028), Thanks [@JannThomas](https://github.com/JannThomas)
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.7.0...v3.7.1
+
 ## [3.7.0](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v3.7.0) (2024-07-21)
 
 ### What's Changed

package/README.md

@@ -65,6 +65,20 @@
 
      This lists all discovered Bluetooth devices. The BLE address of the SwitchBot device should be included in this list, otherwise your computer does not discover it.
 
+- ### If using MacOS
+  1. Manually grant Bluetooth access in System Settings UI for `Security & Privacy -> Privacy` to the node executable, eg `/usr/local/bin/node`
+  ![Security & Privacy -> Privacy](assets/security-privacy-bluetooth.png)
+ (This is what is intended in documentation for the noble bluetooth package [prerequisites](https://github.com/abandonware/noble#prerequisites) by "Add terminal app", however for HomeBridge it is `node` that needs the permission granted, not `terminal`. 
+  Without this step, then you will receive the following error when the swichbot plugin launches, which will cause Homebridge or the child bridge process to restart:
+  ```
+  Error: Failed to initialize the Noble object: unauthorized
+    at Noble.<anonymous> (file:///usr/local/lib/node_modules/@switchbot/homebridge-switchbot/node_modules/node-switchbot/src/switchbot.ts:244:19)
+    at Object.onceWrapper (node:events:629:26)
+    at Noble.emit (node:events:514:28)
+    at Noble.onStateChange (/usr/local/lib/node_modules/@switchbot/homebridge-switchbot/node_modules/@stoprocent/noble/lib/noble.js:92:8)
+    at NobleMac.emit (node:events:514:28)
+  ```
+
 ## Supported SwitchBot Devices
 
 - [SwitchBot Humidifier](https://www.switch-bot.com/products/switchbot-smart-humidifier)

package/config.schema.json

@@ -221,6 +221,12 @@
                         "Robot Vacuum Cleaner S1 Plus"
                       ]
                     },
+                    {
+                      "title": "Roller Shade",
+                      "enum": [
+                        "Roller Shade"
+                      ]
+                    },
                     {
                       "title": "Smart Fan",
                       "enum": [
@@ -699,6 +705,13 @@
                         "functionBody": "return (model.options && model.options.devices && !model.options.devices[arrayIndices].hide_device && (model.options.devices[arrayIndices].configDeviceType === 'Curtain' || model.options.devices[arrayIndices].configDeviceType === 'Curtain3') && model.options.devices[arrayIndices].deviceId);"
                       }
                     },
+                    "silentModeSwitch": {
+                      "title": "Enable Curtain Silent Mode Switches",
+                      "type": "boolean",
+                      "condition": {
+                        "functionBody": "return (model.options && model.options.devices && !model.options.devices[arrayIndices].hide_device && (model.options.devices[arrayIndices].configDeviceType === 'Curtain' || model.options.devices[arrayIndices].configDeviceType === 'Curtain3') && model.options.devices[arrayIndices].deviceId);"
+                      }
+                    },
                     "hide_lightsensor": {
                       "title": "Hide Light Sensor",
                       "type": "boolean",
@@ -810,6 +823,55 @@
                       "condition": {
                         "functionBody": "return (model.options && model.options.devices && !model.options.devices[arrayIndices].hide_device && model.options.devices[arrayIndices].configDeviceType === 'Blind Tilt' && model.options.devices[arrayIndices].deviceId);"
                       }
+                    },
+                    "setOpenMode": {
+                      "title": "Blind Tilt's Opening Mode",
+                      "type": "string",
+                      "oneOf": [
+                        {
+                          "enum": [
+                            "0"
+                          ],
+                          "title": "Performance Mode"
+                        },
+                        {
+                          "enum": [
+                            "1"
+                          ],
+                          "title": "Silent Mode"
+                        }
+                      ],
+                      "condition": {
+                        "functionBody": "return (model.options && model.options.devices && !model.options.devices[arrayIndices].hide_device && model.options.devices[arrayIndices].configDeviceType === 'Blind Tilt' && model.options.devices[arrayIndices].deviceId);"
+                      }
+                    },
+                    "setCloseMode": {
+                      "title": "Blind Tilt's Closing Mode",
+                      "type": "string",
+                      "oneOf": [
+                        {
+                          "enum": [
+                            "0"
+                          ],
+                          "title": "Performance Mode"
+                        },
+                        {
+                          "enum": [
+                            "1"
+                          ],
+                          "title": "Silent Mode"
+                        }
+                      ],
+                      "condition": {
+                        "functionBody": "return (model.options && model.options.devices && !model.options.devices[arrayIndices].hide_device && model.options.devices[arrayIndices].configDeviceType === 'Blind Tilt' && model.options.devices[arrayIndices].deviceId);"
+                      }
+                    },
+                    "silentModeSwitch": {
+                      "title": "Enable Blind Tilt Silent Mode Switches",
+                      "type": "boolean",
+                      "condition": {
+                        "functionBody": "return (model.options && model.options.devices && !model.options.devices[arrayIndices].hide_device && model.options.devices[arrayIndices].configDeviceType === 'Blind Tilt' && model.options.devices[arrayIndices].deviceId);"
+                      }
                     }
                   }
                 },
@@ -1737,6 +1799,11 @@
                 ]
               }
             ]
+          },
+          "allowInvalidCharacters": {
+            "title": "Allow Invalid Characters",
+            "type": "boolean",
+            "description": "If true, invalid characters will be allowed in the device name."
           }
         },
         "required": [
@@ -1802,6 +1869,7 @@
             "options.devices[].curtain.set_max",
             "options.devices[].curtain.setOpenMode",
             "options.devices[].curtain.setCloseMode",
+            "options.devices[].curtain.silentModeSwitch",
             "options.devices[].curtain.updateRate",
             "options.devices[].curtain.disable_group",
             "options.devices[].curtain.hide_lightsensor",
@@ -1813,6 +1881,9 @@
             "options.devices[].blindTilt.set_max",
             "options.devices[].blindTilt.hide_lightsensor",
             "options.devices[].blindTilt.updateRate",
+            "options.devices[].blindTilt.setOpenMode",
+            "options.devices[].blindTilt.setCloseMode",
+            "options.devices[].blindTilt.silentModeSwitch",
             "options.devices[].contact.hide_lightsensor",
             "options.devices[].contact.set_minlux",
             "options.devices[].contact.set_maxlux",
@@ -1929,8 +2000,9 @@
           "key": "options.pushRate",
           "description": "<em class='primary-text'>Specifies the interval, in seconds, between pushes to the SwitchBot API.</em>"
         },
-        "options.logging"
+        "options.logging",
+        "options.allowInvalidCharacters"
       ]
     }
   ]
-}
+}

package/dist/device/blindtilt.d.ts

@@ -1,25 +1,28 @@
-import { deviceBase } from './device.js';
-import { BlindTiltMappingMode } from '../utils.js';
-import { Subject } from 'rxjs';
-import type { devicesConfig } from '../settings.js';
-import type { device } from '../types/devicelist.js';
+import type { CharacteristicValue, PlatformAccessory } from 'homebridge';
 import type { SwitchBotPlatform } from '../platform.js';
+import type { devicesConfig } from '../settings.js';
 import type { blindTiltServiceData } from '../types/bledevicestatus.js';
+import type { device } from '../types/devicelist.js';
 import type { blindTiltStatus } from '../types/devicestatus.js';
 import type { blindTiltWebhookContext } from '../types/devicewebhookstatus.js';
-import type { PlatformAccessory, CharacteristicValue } from 'homebridge';
+import { Subject } from 'rxjs';
+import { BlindTiltMappingMode } from '../utils.js';
+import { deviceBase } from './device.js';
 export declare class BlindTilt extends deviceBase {
     readonly platform: SwitchBotPlatform;
     private WindowCovering;
     private Battery;
     private LightSensor?;
+    private OpenModeSwitch?;
+    private CloseModeSwitch?;
     deviceStatus: blindTiltStatus;
     mappingMode: BlindTiltMappingMode;
     webhookContext: blindTiltWebhookContext;
     serviceData: blindTiltServiceData;
     setNewTarget: boolean;
     setNewTargetTimer: NodeJS.Timeout;
-    blindTiltUpdateInProgress: any;
+    blindTiltMoving: boolean;
+    blindTiltUpdateInProgress: boolean;
     doBlindTiltUpdate: Subject<void>;
     constructor(platform: SwitchBotPlatform, accessory: PlatformAccessory, device: device & devicesConfig);
     /**
@@ -36,6 +39,7 @@ export declare class BlindTilt extends deviceBase {
      */
     refreshStatus(): Promise<void>;
     BLERefreshStatus(): Promise<void>;
+    registerPlatformBLE(): Promise<void>;
     openAPIRefreshStatus(): Promise<void>;
     registerWebhook(): Promise<void>;
     pushChanges(): Promise<void>;
@@ -50,6 +54,14 @@ export declare class BlindTilt extends deviceBase {
      */
     TargetPositionSet(value: CharacteristicValue): Promise<void>;
     startUpdatingBlindTiltIfNeeded(): Promise<void>;
+    /**
+     * Handle requests to set the value of the "Target Position" characteristic
+     */
+    OpenModeSwitchSet(value: CharacteristicValue): Promise<void>;
+    /**
+     * Handle requests to set the value of the "Target Position" characteristic
+     */
+    CloseModeSwitchSet(value: CharacteristicValue): Promise<void>;
     updateHomeKitCharacteristics(): Promise<void>;
     BLEPushConnection(): Promise<void>;
     BLERefreshConnection(switchbot: any): Promise<void>;
@@ -65,7 +77,7 @@ export declare class BlindTilt extends deviceBase {
      * Maps device values to homekit values
      *
      * @param devicePosition the position as reported by the devide
-     * @param direction the direction as reported by the device
+     * @param deviceDirection the direction as reported by the device
      * @returns [homekit position, homekit tiltAngle]
      */
     mapDeviceValuesToHomekitValues(devicePosition: number, deviceDirection: string): [CharacteristicValue, CharacteristicValue?];
@@ -73,7 +85,7 @@ export declare class BlindTilt extends deviceBase {
      * Maps homekit values to device values
      *
      * @param homekitPosition the position as reported by homekit
-     * @param homekitTiltAngle? the tilt angle as reported by homekit
+     * @param homekitTiltAngle the tilt angle as reported by homekit
      * @returns [device position, device direction]
      */
     mapHomekitValuesToDeviceValues(homekitPosition: number, homekitTiltAngle: number): [string, number];

package/dist/device/blindtilt.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"blindtilt.d.ts","sourceRoot":"","sources":["../../src/device/blindtilt.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAEnD,OAAO,EAAE,OAAO,EAAgD,MAAM,MAAM,CAAC;AAE7E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AACrD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC/E,OAAO,KAAK,EAAW,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAGlF,qBAAa,SAAU,SAAQ,UAAU;IA6CrC,QAAQ,CAAC,QAAQ,EAAE,iBAAiB;IA3CtC,OAAO,CAAC,cAAc,CAQpB;IAEF,OAAO,CAAC,OAAO,CAMb;IAEF,OAAO,CAAC,WAAW,CAAC,CAIlB;IAGF,YAAY,EAAG,eAAe,CAAC;IAC/B,WAAW,EAAE,oBAAoB,CAA+B;IAGhE,cAAc,EAAG,uBAAuB,CAAC;IAGzC,WAAW,EAAG,oBAAoB,CAAC;IAGnC,YAAY,EAAG,OAAO,CAAC;IACvB,iBAAiB,EAAG,MAAM,CAAC,OAAO,CAAC;IAGnC,yBAAyB,MAAC;IAC1B,iBAAiB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;gBAGtB,QAAQ,EAAE,iBAAiB,EACpC,SAAS,EAAE,iBAAiB,EAC5B,MAAM,EAAE,MAAM,GAAG,aAAa;IA2KhC;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IA6DrC;;OAEG;IACG,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAgDnC,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IA0BzC;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAa9B,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAuCjC,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAqBrC,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAkBhC,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAoB5B,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAsC/B,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAwDzC;;OAEG;IACG,4BAA4B,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAa7E;;OAEG;IACG,iBAAiB,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAY5D,8BAA8B,IAAI,OAAO,CAAC,IAAI,CAAC;IAmC/C,4BAA4B,IAAI,OAAO,CAAC,IAAI,CAAC;IAiC7C,iBAAiB;IAOjB,oBAAoB,CAAC,SAAS,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnD,cAAc;;;;IA6Bd,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAsB1B,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAU3B,QAAQ,CAAC,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAe/B,2BAA2B,CAC/B,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,GAAG,uBAAuB,CAAC,WAAW,CAAC,EAC9E,aAAa,EAAE,eAAe,CAAC,eAAe,CAAC,GAAG,uBAAuB,CAAC,eAAe,CAAC;IAiD5F;;;;;;OAMG;IACH,8BAA8B,CAAC,cAAc,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAC;IAiD5H;;;;;;OAMG;IACH,8BAA8B,CAAC,eAAe,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;CAyDpG"}
+{"version":3,"file":"blindtilt.d.ts","sourceRoot":"","sources":["../../src/device/blindtilt.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,mBAAmB,EAAE,iBAAiB,EAAW,MAAM,YAAY,CAAA;AAEjF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAA;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AACnD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAA;AACvE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAA;AACpD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAA;AAC/D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAA;AAO9E,OAAO,EAAqC,OAAO,EAAa,MAAM,MAAM,CAAA;AAE5E,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAExC,qBAAa,SAAU,SAAQ,UAAU;IA0DrC,QAAQ,CAAC,QAAQ,EAAE,iBAAiB;IAxDtC,OAAO,CAAC,cAAc,CAQrB;IAED,OAAO,CAAC,OAAO,CAMd;IAED,OAAO,CAAC,WAAW,CAAC,CAInB;IAED,OAAO,CAAC,cAAc,CAAC,CAItB;IAED,OAAO,CAAC,eAAe,CAAC,CAIvB;IAGD,YAAY,EAAG,eAAe,CAAA;IAC9B,WAAW,EAAE,oBAAoB,CAA8B;IAG/D,cAAc,EAAG,uBAAuB,CAAA;IAGxC,WAAW,EAAG,oBAAoB,CAAA;IAGlC,YAAY,EAAG,OAAO,CAAA;IACtB,iBAAiB,EAAG,MAAM,CAAC,OAAO,CAAA;IAGlC,eAAe,EAAE,OAAO,CAAA;IACxB,yBAAyB,EAAE,OAAO,CAAA;IAClC,iBAAiB,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;gBAGrB,QAAQ,EAAE,iBAAiB,EACpC,SAAS,EAAE,iBAAiB,EAC5B,MAAM,EAAE,MAAM,GAAG,aAAa;IA4NhC;;OAEG;IACG,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IA4DrC;;OAEG;IACG,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IA+CnC,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAyBzC;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAa9B,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAuBjC,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAqBpC,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAqBrC,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IAkBhC,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAoB5B,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAqC/B,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC;IAqDzC;;OAEG;IACG,4BAA4B,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAa7E;;OAEG;IACG,iBAAiB,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAY5D,8BAA8B,IAAI,OAAO,CAAC,IAAI,CAAC;IAmCrD;;OAEG;IACG,iBAAiB,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IASlE;;OAEG;IACG,kBAAkB,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAS7D,4BAA4B,IAAI,OAAO,CAAC,IAAI,CAAC;IAyB7C,iBAAiB;IAOjB,oBAAoB,CAAC,SAAS,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnD,cAAc;;;;IA6Bd,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAsB1B,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAU3B,QAAQ,CAAC,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAe/B,2BAA2B,CAC/B,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,GAAG,uBAAuB,CAAC,WAAW,CAAC,EAC9E,aAAa,EAAE,eAAe,CAAC,eAAe,CAAC,GAAG,uBAAuB,CAAC,eAAe,CAAC;IAiD5F;;;;;;OAMG;IACH,8BAA8B,CAAC,cAAc,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,CAAC,mBAAmB,EAAE,mBAAmB,CAAC,CAAC;IAiD5H;;;;;;OAMG;IACH,8BAA8B,CAAC,eAAe,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;CAyDpG"}