Version 1.2.0 (#96)

## [Version 1.2.0](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v1.2.0) (2021-11-19) ## What's Changed * Added option to be able to do Bluetooth Low Energy (BLE) Only Connection. * Must supply `Device ID` & `Device Name` to the Device Config * Must Check `Enable Bluetooth Low Energy (BLE) Connection` * Fixed Bug: Air conditioner temperature not able to change. [#43](#43) * Add option to set Min Lux and Max Lux for Curtain's Light Sensor. * Add `updateHomeKitCharacteristics` to IR Devices to contain all `updateCharacteristics` in one spot. * Add `Saturation` and `Hue` to Colorbulb. * Housekeeping and updated dependencies. **Full Changelog**: v1.1.0...v1.2.0
OpenWonderLabs · Nov 20, 2021 · b6770c6 · b6770c6
1 parent 072eb78
commit b6770c6
Show file tree

Hide file tree

Showing 27 changed files with 2,632 additions and 1,542 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,12 +2,26 @@
 
 All notable changes to this project will be documented in this file. This project uses [Semantic Versioning](https://semver.org/)
 
+## [Version 1.2.0](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v1.2.0) (2021-11-19)
+
+## What's Changed
+* Added option to be able to do Bluetooth Low Energy (BLE) Only Connection.
+    * Must supply `Device ID` & `Device Name` to the Device Config
+    * Must Check `Enable Bluetooth Low Energy (BLE) Connection`
+* Fixed Bug: Air conditioner temperature not able to change. [#43](https://github.com/OpenWonderLabs/homebridge-switchbot/issues/43)
+* Add option to set Min Lux and Max Lux for Curtain's Light Sensor.
+* Add `updateHomeKitCharacteristics` to IR Devices to contain all `updateCharacteristics` in one spot.
+* Add `Saturation` and `Hue` to Colorbulb.
+* Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.1.0...v1.2.0
+
 ## [Version 1.1.0](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v1.1.0) (2021-11-16)
 
 ## What's Changed
 * Fixed Bug: Curtains alternate between open/close state. [#85](https://github.com/OpenWonderLabs/homebridge-switchbot/issues/85)
 * Fixed Bug: IR Fan won't be hidden in Home app. [#90](https://github.com/OpenWonderLabs/homebridge-switchbot/issues/90)
-* Fixed Bug: `hide_temperature` config option causing `Cannot read property 'updateCharacteristic' of undefined` for  Humidifiers. [#90](https://github.com/OpenWonderLabs/homebridge-switchbot/issues/90)
+* Fixed Bug: `hide_temperature` config option causing `Cannot read property 'updateCharacteristic' of undefined` for  Humidifiers. [#89](https://github.com/OpenWonderLabs/homebridge-switchbot/issues/89)
 * Add option to Hide Curtain's Light Sensor. [#91](https://github.com/OpenWonderLabs/homebridge-switchbot/issues/91)
 * Add option to Hide Contact Sensor's Motion Sensor or Light Sensor.
 

diff --git a/README.md b/README.md
@@ -23,16 +23,25 @@ plugin allows you to access your SwitchBot Device(s) from HomeKit with
 3. Click **Install**
 
 ## Configuration
+* ### If using OpenAPI Connection
+    1. Download SwitchBot App on App Store or Google Play Store
+    2. Register a SwitchBot account and log in into your account
+    3. Generate an Open Token within the App
+        - Click Bottom Profile Tab
+        - Click Preference
+        - Click App version 10 Times, this will enable Developer Options
+        - Click Developer Options
+        - Click Copy to Clipboard
+    4. Input your `openToken` into the config paramter
+* ### If using BLE Connection
+    1. Download SwitchBot App on App Store or Google Play Store
+    2. Register a SwitchBot account and log in into your account
+    3. Click on Device wanting to connect too plugin
+        - Click the Settings Gear
+        - Click Device Info
+        - Copy BLE Mac aka `deviceId`
+    4. Input your `deviceId` into the Device Config
 
-1. Download SwitchBot App on App Store or Google Play Store
-2. Register a SwitchBot account and log in into your account
-3. Generate an Open Token within the App
-    - Click Bottom Profile Tab
-    - Click Preference
-    - Click App version 10 Times, this will enable Developer Options
-    - Click Developer Options
-    - Click Copy to Clipboard
-4. Input your `Token` into the config paramter
 
 <p align="center">
 
@@ -43,36 +52,68 @@ plugin allows you to access your SwitchBot Device(s) from HomeKit with
 ## Supported SwitchBot Devices
 
 - [SwitchBot Humidifier](https://www.switch-bot.com/products/switchbot-smart-humidifier)
+    - Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
+        - Can Push Updates over OpenAPI
+        - Can Receive Udpates over BLE and OpenAPI
 - [SwitchBot Meter](https://www.switch-bot.com/products/switchbot-meter)
-    - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
-    - Enable Cloud Services for Device on SwitchBot App, If using OpenAPI.
+    - Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
+    - If using OpenAPI:
+        - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
+        - Enable Cloud Services for Device on SwitchBot App
+    - If using Bluetooth Low Energy (BLE) only:
+        - Must supply `deviceId` & `deviceName` to Device Config
+        - Check `Enable Bluetooth Low Energy (BLE) Connection` on Device Config  
 - [SwitchBot Motion Sensor](https://www.switch-bot.com/products/motion-sensor)
-    - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
-    - Enable Cloud Services for Device on SwitchBot App, If using OpenAPI.
+    - Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
+    - If using OpenAPI:
+        - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
+        - Enable Cloud Services for Device on SwitchBot App
+    - If using Bluetooth Low Energy (BLE) only:
+        - Must supply `deviceId` & `deviceName` to Device Config
+        - Check `Enable Bluetooth Low Energy (BLE) Connection` on Device Config        
 - [SwitchBot Contact Sensor](https://www.switch-bot.com/products/contact-sensor)
-    - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
-    - Enable Cloud Services for Device on SwitchBot App, If using OpenAPI.  
+    - Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
+    - If using OpenAPI:
+        - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
+        - Enable Cloud Services for Device on SwitchBot App
+    - If using Bluetooth Low Energy (BLE) only:
+        - Must supply `deviceId` & `deviceName` to Device Config
+        - Check `Enable Bluetooth Low Energy (BLE) Connection` on Device Config        
 - [SwitchBot Curtain](https://www.switch-bot.com/products/switchbot-curtain)
-    - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
-    - Enable Cloud Services for Device on SwitchBot App, If using OpenAPI.
+    - Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
+    - If using OpenAPI:
+        - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
+        - Enable Cloud Services for Device on SwitchBot App
+    - If using Bluetooth Low Energy (BLE) only:
+        - Must supply `deviceId` & `deviceName` to Device Config
+        - Check `Enable Bluetooth Low Energy (BLE) Connection` on Device Config        
 - [SwitchBot Bulb](https://www.switch-bot.com/products/switchbot-color-bulb)
-    - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
-    - Enable Cloud Services for Device on SwitchBot App, If using OpenAPI.
+    - Supports OpenAPI Connection Only
+    - If using OpenAPI:
+        - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
+        - Enable Cloud Services for Device on SwitchBot App      
 - [SwitchBot Bot](https://www.switch-bot.com/products/switchbot-bot)
-    - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
-    - Enable Cloud Services for Device on SwitchBot App, If using OpenAPI.
-    - You must set your Bot's Device ID in the Press Mode or Switch Mode Bot Settings (Advanced Settings > Bot Settings)
-        - Press Mode - Turns on then instantly turn it off
-        - Switch Mode - Turns on and keep it on until it is turned off
-            - This can get out of sync, since API doesn't give me a status
-            - To Correct you must go into the SwitchBot App and correct the status of either `On` or `Off`
+    - Supports OpenAPI & Bluetooth Low Energy (BLE) Connections
+    - If using OpenAPI:
+        - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
+        - Enable Cloud Services for Device on SwitchBot App
+        - You must set your Bot's Device ID in the Press Mode or Switch Mode Bot Settings (Advanced Settings > Device Settings > Bot Settings)
+            - Press Mode - Turns on then instantly turn it off
+            - Switch Mode - Turns on and keep it on until it is turned off
+                - This can get out of sync, since API doesn't give me a status
+                - To Correct you must go into the SwitchBot App and correct the status of either `On` or `Off`
+    - If using Bluetooth Low Energy (BLE) only:
+        - Must supply `deviceId` & `deviceName` to Device Config
+        - Check `Enable Bluetooth Low Energy (BLE) Connection` on Device Config
 - SwitchBot Plug
+    - Supports OpenAPI Connection Only
 
 ## Supported IR Devices
 ### _(All IR Devices require [Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) or [Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini))_
 
 - TV
     - Allows for On/Off and Volume Controls
+    - Optional Disable Sending Power Command
 - Projector (Displayed as TV)
     - Allows for On/Off and Volume Controls
 - Set Top Box  (Displayed as Set Top Box)