Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@switchbot/homebridge-switchbot

OpenWonderLabs3.7kISC4.3.1TypeScript support: included

The SwitchBot plugin allows you to access your SwitchBot device(s) from HomeKit.

homebridge-plugin, switchbot, lights, fan, outlet, hub, lightstrip, motion, contact, vacuum, lock, humidifier, humidity, temperature, bot, curtains, windows, ble, ir

readme

homebridge-verified

@switchbot/homebridge-switchbot

npm version npm downloads discord-switchbot

The Homebridge SwitchBot plugin allows you to access your SwitchBot Device(s) from HomeKit with Homebridge.

Installation

  1. Search for "SwitchBot" on the plugin screen of Homebridge Config UI X
  2. Find: @switchbot/homebridge-switchbot
    • See noble prerequisites for your OS. (This is used for BLE connection.)
  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 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 token to Clipboard
    4. Input your token into the config parameter
    5. Generate an Secret within the App
      • Click Bottom Profile Tab
      • Click Preference
      • Click App version 10 Times, this will enable Developer Options
      • Click Developer Options
      • Click Copy secret to Clipboard
    6. Input your secret into the config parameter

  • 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

Troubleshooting

  • If using Linux / Raspberry Pi OS

    1. bluetoothctl must be installed on the device, otherwise it cannot communicate via Bluetooth. Enable it with sudo bluetoothctl power on.

    2. If errors occur, while enabling it, restart the process:

      • rfkill block bluetooth
      • rfkill unblock bluetooth

    3. Also make sure, that the computer can discover the SwitchBot device:

      • sudo bluetoothctl
      • scan on

      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 (This is what is intended in documentation for the noble bluetooth package 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

Supported IR Devices

(All IR Devices require SwitchBot Hub 2 or 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)
    • Allows for On/Off and Volume Controls
  • DVD (Displayed as Set Top Box)
    • Allows for On/Off and Volume Controls
  • Streamer (Displayed as Streaming Stick)
    • Allows for On/Off and Volume Controls
  • Speaker (Displayed as Speaker)
    • Allows for On/Off and Volume Controls
  • Fans
    • Allows for On/Off Controls
    • Optional Rotation Speed
    • Optional Swing Mode
  • Lights
    • Allows for On/Off Controls
  • Air Purifiers
    • Allows for On/Off Controls
  • Air Conditioners
    • Allows for On/Off, Tempeture, and Mode Controls
    • Optional Disable Auto Mode
  • Cameras
    • Allows for On/Off Controls
  • Vacuum Cleaners
    • Allows for On/Off Controls
  • Water Heaters
    • Allows for On/Off Controls
  • Others
    • Option to Display as differenet Device Type
      • Supports Fan Device Type
    • Allows for On/Off Controls

SwitchBot APIs

Community

changelog

Changelog

All notable changes to this project will be documented in this file. This project uses Semantic Versioning

4.3.1 (2025-03-04)

No New Releases During Lent

What's Changed

  • Fixed issue with plugin config not displaying.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v4.3.0...v4.3.1

4.3.0 (2025-01-24)

What's Changed

  • Add Support for Relay Switch 1 & Relay Switch 1PM with OpenAPI
  • Add Meter Pro & Meter Pro (CO2) as meterType for IR AirConditioner
  • Fixed SwitchBot Meter Pro Battery Error #1160
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v4.2.0...v4.3.0

4.2.0 (2025-01-23)

What's Changed

  • Add option to disable platform BLE for specific devices.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v4.1.7...v4.2.0

4.1.7 (2024-12-22)

What's Changed

  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v4.1.6...v4.1.7

4.1.6 (2024-12-21)

What's Changed

  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v4.1.5...v4.1.6

4.1.5 (2024-11-27)

What's Changed

  • Update default refresh rate
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v4.1.4...v4.1.5

4.1.4 (2024-11-18)

What's Changed

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v4.1.3...v4.1.4

4.1.3 (2024-11-05)

What's Changed

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v4.1.2...v4.1.3

4.1.2 (2024-11-04)

What's Changed

  • Fix refreshRate Issue

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v4.1.1...v4.1.2

4.1.1 (2024-11-02)

What's Changed

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v4.1.0...v4.1.1

4.1.0 (2024-10-21)

What's Changed

  • Add Meter Pro deviceType Support
  • Fix node-switchbot noble issue.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v4.0.0...v4.1.0

4.0.0 (2024-10-11)

What's Changed

⚠️ Breaking Changes

  • Added deviceType based config
    • This allows you to set a setting that will be used across the same deviceType
    • deviceType based config settings can be over written by individual device settings set by the deviceId
  • Added remoteType based config
    • This allows you to set a setting that will be used across the same IR remoteType
    • remoteType based config settings can be over written by individual device settings set by the deviceId
  • All device specific configs have been moved to the same level on the config to elimate the use of multiple of the same config and to better support the new deviceType based config.
    • ** ⚠️ If you have config set for any of the following SwitchBot device Types: Curtain, Blind Tilt, Color Bulb, Strip Light, Hub, Meter, Meter Plus, Humidifier, Contact Sensor, Motion Sensor, Water Detector, Ceiling Light, or Lock; you will need to re-setup your config for that deviceId**
    • ** ⚠️ If you have config set for any of the following IR remote Types: Fan, DIY Fan, Light, DIY Light, Air Conditioner, DIY Air Conditioner, or Others; you will need to re-setup your config for that deviceId**
  • OpenAPI is now support by Version 3.0.0 of node-switchbot, so made changes to refect that.

Other Changes

  • Add K10+ Pro deviceType Support
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.8.3...v4.0.0

3.8.3 (2024-10-09)

What's Changed

  • Fix incorrect handling of openState in Contact Sensor #1061, Thanks @nzws
  • Fix light level stuck at max #1066, Thanks @4gra
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.8.2...v3.8.3

3.8.2 (2024-09-19)

What's Changed

  • Improved macAddress format and finding of invalid formating.
  • Fixed temperature reading issue for Hub 2, Indoor/Outdoor Sensor, Meter, & Meter Plus #1024, Thanks @azmke
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.8.1...v3.8.2

3.8.1 (2024-09-13)

What's Changed

  • Improved logging mechanism to avoid repetitive logs.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.8.0...v3.8.1

3.8.0 (2024-09-11)

What's Changed

  • Added specific macOS Bluetooth permission instructions to Readme #1026, Thanks @rSffsE
  • Added partial support for Roller Shade deviceType. Currently only supports status.
  • Added silentModeSwitch config option for both Curtain & Blind Titl deviceTypes, allowing two switches to be display for Closing and Moding Mode. If turned on then Silent Mode is enabled.
  • Added option to allow invalid Characters in displayName with config allowInvalidCharacters
  • Added dry config option to enable Dry Status support for Water Detector
  • Fixed Platform BLE Scanning events not registering
  • Fix On state for robot vacuum cleaners #1028, Thanks @JannThomas
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.7.0...v3.8.0

3.7.0 (2024-07-21)

What's Changed

  • Add Platform BLE Scanning
    • Enable by setting Enable BLE Scanning setting under Advanced Settings.
    • Will update devices as data is received.
  • Fix Bot and Other On issues.
  • Remove repetitive logging #1001, Thanks @dnicolson
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.6.0...v3.7.0

3.6.0 (2024-07-06)

What's Changed

  • Add Humdifier as meterType for IR AirConditioner
  • Fix Bot botDeviceType issue
  • Fix Other IR deviceType issue
  • Fix RangeError: Maximum call stack size exceeded error
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.5.1...v3.6.0

3.5.1 (2024-06-27)

What's Changed

  • Fixed issue RangeError: Maximum call stack size exceeded introduced in v3.5.0
  • Fixed Bot deviceType issue which wouldn't use config service or remove leftover services.
  • Fixed Other IR deviceType issue which wouldn't use config service or remove leftover services.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.5.0...v3.5.1

3.5.0 (2024-05-26)

What's Changed

  • Add Support for Water Detector
  • Add Support for Battery Circulator Fan
  • Add BLE support for Smart Lock
  • Add K10+ deviceType Support
  • Add Support for maxRetries and delayBetweenRetries on OpenAPI status refreshes based on #959, Thanks @sametguzeldev
  • Major Refactoring of device and irdevice files.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.4.0...v3.5.0

3.4.0 (2024-02-11)

What's Changed

  • Add support for Smart Lock Pro
  • Add Mini Robot Vacuum K10+ to config
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.3.0...v3.4.0

3.3.0 (2024-02-09)

What's Changed

  • Add config that allows you to set cool and heat: min & max
  • Fixed node-switchbot import #928, Thanks @dnicolson
  • Code cleanup: Remove unnecessary await keyword #929, Thanks @dnicolson
  • Code cleanup: Remove empty image tag #930, Thanks @dnicolson
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.2.0...v3.3.0

3.2.0 (2024-02-06)

What's Changed

  • Upgrade to latest node-switchbot with is now a Typescript ES-Module.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.1.3...v3.2.0

3.1.3 (2024-02-06)

What's Changed

  • Adjust noble and node-switchbot import and pass noble as object to the node-switchbot.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.1.2...v3.1.3

3.1.2 (2024-02-05)

What's Changed

  • Fixed node-switchbot import issue.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.1.1...v3.1.2

3.1.1 (2024-02-05)

What's Changed

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.1.0...v3.1.1

3.1.0 (2024-02-02)

What's Changed

  • Offical support for Curtain 3, deviceType: Curtain3.
  • Fixed issue with which prevented the plugin from loading.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v3.0.0...v3.1.0

3.0.0 (2024-01-31)

What's Changed

  • Moved from CommonJS to ES Module
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.14.0...v3.0.0

2.14.0 (2024-01-06)

What's Changed

  • Added Curtain Hold Command to OpenAPI.
    • This will only Works in 3rd Party Home App, Like Eve or Home+ 5

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.13.2...v2.14.0

2.13.2 (2024-01-05)

What's Changed

  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.13.1...v2.13.2

2.13.1 (2023-12-15)

What's Changed

  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.13.0...v2.13.1

2.13.0 (2023-12-04)

What's Changed

  • Add support for turning on WoSweeperMini, also known as SwitchBot Mini Robot Vacuum K10+
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.12.1...v2.13.0

2.12.1 (2023-11-26)

What's Changed

  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.12.0...v2.12.1

2.12.0 (2023-11-17)

What's Changed

  • Add Support for Stateless button on IR Lights #863
  • Fix noble version #864
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.11.0...v2.12.0

2.11.0 (2023-11-07)

What's Changed

  • Added Latch Switch to activate Latch on Lock #859, Thanks @quebulm
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.10.1...v2.11.0

2.10.1 (2023-11-01)

What's Changed

  • Added webhook event listener for Bot, Ceiling Light, Color Bulb, Contact, Curtain, IOSensor, Light Strip, Lock, Motion, Plug, & Robot Vacuum Cleaner
  • Added Webhook config to Plugin Config UI.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.10.0...v2.10.1

2.10.0 (2023-10-31)

What's Changed

  • Added webhook event listener for Meter, Meter Plus, & Hub 2 #850, Thanks @banboobee
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.9.2...v2.10.0

2.9.2 (2023-10-26)

What's Changed

  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.9.1...v2.9.2

2.9.1 (2023-10-14)

What's Changed

  • Fix issue with FirmwareRevision causing Homebridge Crash #839 #832 #829 #828
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.9.0...v2.9.1

2.9.0 (2023-09-16)

What's Changed

  • Add other deviceTypes for IR Type Other.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.8.2...v2.9.0

2.8.2 (2023-08-27)

What's Changed

  • Fixed issue with BatteryLevel & FirmwareRevision not displaying correctly for certain deviceTypes.
  • Fixed config issue where Eve History was not showing for WoIOSensor.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.8.1...v2.8.2

2.8.1 (2023-08-22)

What's Changed

  • Added additional logging to catch statusCodes like 190 (Requests reached the daily limit).
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.8.0...v2.8.1

2.8.0 (2023-08-19)

What's Changed

  • Add Hub 2 Light-Level Support. #776
  • Enable Meter Battery Level for OpenAPI #782, Thanks @mrlt8
  • Enable Meter Plus Battery Level for OpenAPI #787, Thanks @mrlt8
  • Enable Battery Level and Version for OpenAPI for BlindTilt, Bot, Ceiling Lights, Color Bulb, Contact, Curtain, Hub, Humidifier, Indoor/Outdoor Sensor, Light Strip, Lock, Meter, Meter Plus, Motion , Plug, Plug Mini, & Robot Vacuum Cleaner
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.7.1...v2.8.0

2.7.1 (2023-07-29)

What's Changed

  • Fixed Hub 2 temperature/humidity data for AC #779, Thanks @mrlt8
  • Fixed TargetTemperature not being updated in the HomeKit #779, Thanks @mrlt8
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.7.0...v2.7.1

2.7.0 (2023-07-25)

What's Changed

  • Will now log if there are no devices discovered by SwitchBot-API.
  • Added the ability to use Temperature from a SwitchBot Meter to be used with an IR Air Conditioner #761, Thanks @mrlt8
  • Adds the ability to enable EVE history SwitchBot Curtains #766, Thanks @banboobee
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.6.2...v2.7.0

2.6.2 (2023-04-17)

What's Changed

  • Fix for Commands not being sent, #721
  • Housekeeping.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.6.1...v2.6.2

2.6.1 (2023-04-15)

What's Changed

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.6.0...v2.6.1

2.6.0 (2023-04-15)

What's Changed

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.5.3...v2.6.0

2.5.3 (2023-04-08)

What's Changed

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.5.2...v2.5.3

2.5.2 (2023-02-10)

What's Changed

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.5.1...v2.5.2

2.5.1 (2023-01-28)

What's Changed

  • Fix Blind Tilt Config.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.5.0...v2.5.1

2.5.0 (2023-01-28)

What's Changed

  • Add Initial Support for Blind Tilt (OpenAPI Only) #649, Thanks @AndreasVerhoeven
  • Remove incorrect warning message #661, Thanks @dnicolson
  • Replace switchbot wait with utility function #633, Thanks @dnicolson
  • Enhancements to BLE functionality.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.4.0...v2.5.0

2.4.0 (2022-12-27)

What's Changed

  • Added a new Bot Device Type Multi-Press #628, Thanks @alvst
  • Added maxRetry option for Curtain, Celing Light, Celing Light Pro, Plug, Plug Mini (US), Plug Mini (JP), Robot Vacuum Cleaner S1 Plus, Robot Vacuum Cleaner S1, Color Bulb, and Strip Light Device Types #631, Thanks @dnicolson
  • Fix max retry option for Bot, Curtain, Celing Light, Celing Light Pro, Plug, Plug Mini (US), Plug Mini (JP), Robot Vacuum Cleaner S1 Plus, Robot Vacuum Cleaner S1, Color Bulb, and Strip Light Device Types #630, Thanks @dnicolson
  • Moved maxRetry option from Bot level to overall configDeviceType level.
    • If you had this set for your Bot you will have to update this config.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.3.2...v2.4.0

2.3.2 (2022-12-16)

What's Changed

  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.3.1...v2.3.2

2.3.1 (2022-12-11)

What's Changed

  • Fixed TypeError: Cannot read properties of undefined (reading 'setCharacteristic'). #610
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.3.0...v2.3.1

2.3.0 (2022-12-08)

What's Changed

  • Added Support for SwitchBot Robot Vacuum Cleaner S1 & SwitchBot Robot Vacuum Cleaner S1 Plus
  • Add Read-only BLE Support for Smart Lock.
  • Added disablePushDetail config to IR Air Conditioners.
  • Fixed issue where Meter did not parsing temperature. #571
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.2.2...v2.3.0

2.2.2 (2022-10-22)

What's Changed

  • Changed from allowPushOn and allowPushOff configs to disablePushOn and disablePushOff config, so default is to push changes.
    • Removed disable_power config in favor of disablePushOn and disablePushOff config settings.
  • Fixed Issue where IR Devices commands wouldn't send commands. #551, #553, #545
  • Issue where plugin would continue to crash homebridge. #547
  • Fix for node-switchbot showing not installed.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.2.1...v2.2.2

2.2.1 (2022-10-18)

What's Changed

  • Fix for node-switchbot showing not installed.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.2.0...v2.2.1

2.2.0 (2022-10-18)

What's Changed

  • Moved Air Conditioner config PushOn to be an overall IR Device config of allowPushOn and allowPushOff.
  • Fixed Issue where Brightness characteristic received "NaN". #518
  • Fixed Issue where IR TVs would not default to External Device. #520
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.1.2...v2.2.0

2.1.2 (2022-10-14)

What's Changed

  • Fix issue with IR Devices not having a default ConnectionType. #527
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.1.1...v2.1.2

2.1.1 (2022-10-14)

What's Changed

  • Fixed issue were CustomOff would send incorrect commands. Also Resolves #409.
  • Fixed issue were IR Commands were not sent from IR Devices #520, Thanks @jonzhan
  • Fixed issue with Curtain not refreshing moving status. #517
  • Fix issue with IR Devices not having a default ConnectionType. #527
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.1.0...v2.1.1

2.1.0 (2022-10-13)

What's Changed

  • Added pushRatePress config to set how many seconds inbetween doublePresses.
    • Also if doublePress isn't set it will not wait to pushChanges.
  • Added customize config option which will allow for custom On and off commands for IR Devices.
    • Added customOn & customOff to set custom commands for IR Devices.
  • Removed Other: commandOn & commandOff you will have to change your commands to the new customOn & customOff config under the customize config.
  • Fixed issue where devices are not exposed to Homekit. #507, #508, #513
  • Fixed issue with Non-group Curtains being removed or not displaying in Homekit. #510
  • Fixed issue were Plugin was waiting 15 seconds before sending command to SwitchBot API. #509
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.0.0...v2.1.0

2.0.0 (2022-10-12)

What's Changed

  • Moved from v1.0 to v1.1 of OpenAPI
  • Added Config that allows device(s) to be published as an external accessory.
  • Added connectionType config, this replaces the BLE config.
    • You can now select Both Connections, Only OpenAPI, Only BLE, or Disable.
      • Both will use BLE as the default connection and will use OpenAPI as a backup connection.
      • OpenAPI will only allow connections through the OpenAPI.
      • BLE will only allow connections through Bluetooth (BLE), .
      • Disable will disable all connections. This will also allow you to disable commands and refreshes for a specific device but leave it in HomeKit.
  • Added Support for Ceiling Light & Ceiling Light Pro
  • Fixes Smart Lock Issues fixed in v1.1 of OpenAPI. #462 = Fixes excessive logging from node-switchbot. #435, #444, #446
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.15.0...v2.0.0

1.15.0 (2022-08-27)

What's Changed

  • Added BLE support for PlugMini (US) & PlugMini (JP)
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.14.2...v1.15.0

1.14.2 (2022-08-20)

What's Changed

  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.14.1...v1.14.2

1.14.1 (2022-06-28)

What's Changed

  • Fixed some logging.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.14.0...v1.14.1

1.14.0 (2022-06-25)

What's Changed

  • Added support for Smart Lock commands over OpenAPI #382 #387, Thanks tom-todd
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.13.0...v1.14.0

1.13.0 (2022-05-04)

What's Changed

  • Added MQTT support for Meter and Curtain devices #337, Thanks banboobee
  • Added Eve history features for meter devices #338, Thanks banboobee
  • Added Config setOpenMode and setCloseMode so that you can set mode to be Performance or Silent.
  • Added Config to allow manually setting firmware version.
  • Fixed Smart Lock Display state status.
    • Still unable to control Locks because of API limitations.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.12.8...v1.13.0

1.12.8 (2022-03-19)

What's Changed

  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.12.7...v1.12.8

1.12.7 (2022-03-07)

What's Changed

  • Separated Color Bulb and Strip Lights
    • Strip Lights no longer support Adaptive Lighting.
      • Adaptive Lighting requires Color Temperature, which Strip Lights do not support.
  • Separated Meter and Meter Plus for BLE purposes.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.12.6...v1.12.7

1.12.6 (2022-03-04)

What's Changed

  • Fix for Curtain v3.3 and above, from v1.2.0 node-switchbot update.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.12.5...v1.12.6

1.12.5 (2022-02-15)

What's Changed

  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.12.4...v1.12.5

1.12.4 (2022-02-12)

What's Changed

  • Fix support for Meter Plus
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.12.3...v1.12.4

1.12.3 (2022-02-05)

What's Changed

  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.12.2...v1.12.3

1.12.2 (2022-02-02)

What's Changed

  • Fix: Issue where PositionState was not being sent back to Home App. Fixes #123 Thanks @dnicolson!

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.12.1...v1.12.2

1.12.1 (2022-02-01)

What's Changed

  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.12.0...v1.12.1

1.12.0 (2022-01-29)

What's Changed

  • Add option maxRetry for bots so you can set the number of retries for sending on or off for Bot.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.11.2...v1.12.0

1.11.2 (2022-01-29)

What's Changed

  • Fix: Use updateRate instead of refreshRate when overriding scanDuration.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.11.1...v1.11.2

1.11.1 (2022-01-29)

What's Changed

  • Fix: This plugin generated a warning from the characteristic 'Brightness': characteristic value expected valid finite number and received "undefined" (undefined).
  • Fix: This plugin generated a warning from the characteristic 'Color Temperature': characteristic value expected valid finite number and received "undefined" (undefined).
  • Fix: This plugin generated a warning from the characteristic 'Hue': characteristic value expected valid finite number and received "undefined" (undefined).
  • Fix: This plugin generated a warning from the characteristic 'Saturation': characteristic value expected valid finite number and received "undefined" (undefined).

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.11.0...v1.11.1

1.11.0 (2022-01-29)

What's Changed

  • Add Support for SwitchBot Smart Lock
  • Add Support for SwitchBot Strip Light
  • Add Support for SwitchBot Meter Plus (US)
  • Add Support for SwitchBot Meter Plus (JP)
  • Add Support for SwitchBot Plug Mini (US)
  • Add Support for SwitchBot Plug Mini (US)
  • Fixed: Curtain set_min and set_max options not work correctly with minimum and maximum curtain state. #123
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.10.1...v1.11.0

1.10.1 (2022-01-26)

What's Changed

  • Fixed: Option pushOn was not push On commands.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.10.0...v1.10.1

1.10.0 (2022-01-21)

What's Changed

  • Add option pushOn, this will allow the On commands to be sent along side Status change commands.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.9.0...v1.10.0

1.9.0 (2022-01-20)

What's Changed

  • Add option allowPush, this will allow commands to be sent even if device state is already in state that is being pushed.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.8.2...v1.9.0

1.8.2 (2022-01-15)

What's Changed

  • Fixed Bug: Only log config if it is set.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.8.1...v1.8.2

1.8.1 (2022-01-15)

What's Changed

  • Fixed Bug: Cannot set properties of undefined (setting 'logging')

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.8.0...v1.8.1

1.8.0 (2022-01-14)

What's Changed

  • Added option to display Bot a Stateful Programmable Switch.
    • This will only Works in 3rd Party Home App, Like Eve or Home+ 5
  • Add option to Hide Motion Sensor's Light Sensor.
  • Add option to Set Motion Sensor's Light Sensor set_minLux and set_maxLux.
  • Fixed Bug: Where BLE config would show for devices that don't support BLE.
  • Fixed Bug: Contact Sensors's Motion Sensor and Light Sensor showing undefined values.
  • Fixed Bug: Motion Sensors's Light Sensor showing undefined values.
  • Fixed Bug: Battery Service wouldn't be removed from Curtain, Contact Sensor, or Motion Sensor when switching from BLE to OpenAPI.
  • Enhancements: Made some improvement on the switch from BLE to OpenAPI when BLE connection fails.
  • Enhancements: Made Optional Switchbot Device Settings and Optional IR Device Settings more managable by using Tabs.
  • Change: Changed Curtain refreshRate to updateRate.
    • You will have to update your config for it to pickup the new updateRate.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.7.0...v1.8.0

1.7.0 (2022-01-05)

What's Changed

  • Added option to display Bot a Fan.
  • Added option to display Bot a Door. #179
  • Added option to display Bot a Lock. #179
  • Added option to display Bot a Faucet.
  • Added option to display Bot a Window.
  • Added option to display Bot a WindowCovering.
  • Added option to display Bot a Garage Door Opener. #179

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.6.3...v1.7.0

1.6.3 (2022-01-03)

What's Changed

  • Quick Fix for for issue not tested in v1.6.2.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.6.2...v1.6.3

1.6.2 (2022-01-03)

What's Changed

  • Fixed Bug: npm ERR! code 1. #151
    • Made node-switchbot an optionalDependencies
    • So If node-switchbot doesn't get installed successfully then BLE will not work.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.6.1...v1.6.2

1.6.1 (2022-01-02)

What's Changed

  • Fixed an issue where when Adaptive Lighting Shift was set to -1, Adaptive Lighting would not be removed.
  • Fixed an issue with motion sensor refreshStatus that would cause plugin to cause Homebridge restart.
  • Fixed Bug: npm ERR! code 1. #151
    • Made node-switchbot an optionalDependencies
    • So If node-switchbot doesn't get installed successfully then BLE will not work.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.6.0...v1.6.1

1.6.0 (2021-12-31)

What's Changed

  • Added scanDuration config option to set how long BLE scans, Scanning Duration is defaulted to 1 second.
  • Now Setting switch as the default bot mode for Bots, to change to press, config must be set under SwitchBot Device Settings in the Plugin Settings.
  • Fixed Bug: Contact Sensor talks about Curtain Light + Motion Sensor. #164
  • Fixed Bug: Reboot causes No Device Type Set Error. #172
  • Fixed Bug: Bot Status not working Correction with Switch and Press. #105, #130, #132, #165, #174
  • Fixed some issues with the New Logging Options release with v1.5.0, now logging when configured.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.5.0...v1.6.0

1.5.0 (2021-12-27)

What's Changed

Major Change To Logging

  • Added the following Logging Options:
    • Standard
    • None
    • Debug
  • Removed Device Logging Option, which was pushed into new logging under debug.
  • Added Device Logging Override for each Device, by using the Device Config.

Major Changes to refreshRate

  • Added an option to override refreshRate for each Device, by using the Device Config.

Other Changes

  • Fixed Bug: Air conditioner temperature not able to change. #43
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.4.0...v1.5.0

1.4.0 (2021-12-15)

What's Changed

  • Added Status Messages to logs for discoverDevices request.
  • Added Cached Status to IR device, Status will be saved to accessory context and restored on restart.
  • Added Option Offline as Off to be able set the device as off, if API reports offline.
  • Removed Meter Unit Config Option as it was confusing and probably never used.
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.3.0...v1.4.0

1.3.0 (2021-12-02)

What's Changed

  • Added Adpative Lighting to Color Bulb
  • Added Option Adaptive Lighting Shift to be able us this value to increase the mired for the Adaptive Lighting update, making the light appear warmer.
  • Fixed Bug: Color Bulb can't change color and is not dimmable. #97

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.2.5...v1.3.0

1.2.5 (2021-11-25)

What's Changed

  • Fixed Bug: Where set_minLux & set_maxLux config settings not effecting OpenAPI Lux.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.2.4...v1.2.5

1.2.4 (2021-11-24)

What's Changed

  • Fixed Bug: Cannot read properties of undefined (reading 'updateCharacteristic').

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.2.3...v1.2.4

1.2.3 (2021-11-24)

What's Changed

  • When BLE Connection isn't established, allow for OpenAPI to kick in if openToken is supplied.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.2.2...v1.2.3

1.2.2 (2021-11-24)

What's Changed

  • Allow the configDeviceName to override deviceName.
  • Added Logging when BLE Connection wasn't established.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.2.1...v1.2.2

1.2.1 (2021-11-24)

What's Changed

  • Fixed Bug: Curtains alternate between open/close state. #85
  • Fixed Bug: Meter not working with BLE. #110
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.2.0...v1.2.1

1.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
  • 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

1.1.0 (2021-11-16)

What's Changed

  • Fixed Bug: Curtains alternate between open/close state. #85
  • Fixed Bug: IR Fan won't be hidden in Home app. #90
  • Fixed Bug: hide_temperature config option causing Cannot read property 'updateCharacteristic' of undefined for Humidifiers. #89
  • Add option to Hide Curtain's Light Sensor. #91
  • Add option to Hide Contact Sensor's Motion Sensor or Light Sensor.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.0.2...v1.1.0

1.0.2 (2021-11-15)

What's Changed

  • Fixed Bug: failed to discover devices. cannot read property 'touppercase' of undefined. #84
  • Housekeeping and updated dependencies.

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.0.1...v1.0.2

1.0.1 (2021-11-14)

What's Changed

  • Fixed Cannot read properties of undefined (reading 'updateCharacteristic') on Bots. #77
  • Fixed Temperature not being retrieved for Switchbot Meter. #78

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.0.0...v1.0.1

1.0.0 (2021-11-13)

What's Changed

  • Official release of homebridge-Switchbot, which combines both BLE and OpenAPI into 1 plugin.
  • Adds Light Sensors to Curtains
    • with iOS 15.1 you can set automations on light sensors.
  • Adds Motion Sensor to Contact Sensors
  • Adds Support Color Bulbs

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v0.1.1...v1.0.0

0.1.1 (2021-09-11)

What's Changed

  • Fix Contact Sensor adding as Motion Sensor instead of Contact Sensor

Full Changelog: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v0.1.0...v0.1.1

0.1.0 (2021-09-10)

What's Changed

  • Initial release of homebridge-switchbot.
  • Adds Support for Motion & Contact Sensors
  • Adds Water Level to Humidifier