@joseantmazon/homebridge-switchbot
v1.0.0
Published
Link your switchbot devices to homebridge!
Downloads
23
Maintainers
Readme
Homebridge Switchbot Reloaded
SwitchBot meets Homekit! This plugins uses SwitchBot's Open API to connect your devices to Homekit through Homebridge.
Installation
- Go to
Plugins
from the Homebridge web UI - Find
@joseantmazon/homebridge-switchbot
- Hit
Install
Setup
You only need to set your SwitchBot keys to get started. To do so, you'll have to:
- Download SwitchBot App on App Store or Google Play Store and log in
- Generate your keys within the App
- Click
Profile
on the bottom navigation menu - Click
Preferences
- Click
App version
10 times to enableDeveloper Options
- Click
Developer Options
- Input your
token
andsecret
into the configuration parameters.
- Click
Your homebridge config file would look similar to this afterwards:
{
"platforms": [
{
"platform": "Homebridge Switchbot Reloaded",
"name": "@joseantmazon/homebridge-switchbot",
"settings": {
"api": {
"token": "<your-switchbot-token>",
"secret": "<your-switchbot-secret-key>",
"url": "https://api.switch-bot.com/v1.1"
}
}
}
]
}
Supported devices
Supported IR devices
Bear in mind that Switchbot's API does not allow to query the status of IR devices and therefore I may only provide a best effort approach by storing the result of the most recent operation. Hence, operating infrared devices by means other than this plugin may result in an inaccurate display of information through Homebridge.
TV/DIY TV
Capabilities
- On/Off
- Volume controls
Air conditioner
Capabilities
- On/Off
- Temperature
- Operation mode (
auto
,heat
orcool
) - Fan speed (
auto
,low
,medium
orhigh
)
Overrides
auto
operation mode can be overriden through the configuration so it behaves asheat
orcool
.- For all devices:
{ "platforms": [{ "platform": "Homebridge Switchbot Reloaded", "name": "@joseantmazon/homebridge-switchbot", "settings": { "overrides": { "thermostats": { "all": { "autoOperationMode": "heat" } } } } }] }
- For a single device:
{ "platforms": [{ "platform": "Homebridge Switchbot Reloaded", "name": "@joseantmazon/homebridge-switchbot", "settings": { "overrides": { "thermostats": { "<deviceId>": { "autoOperationMode": "heat" } } } } }] }
- For all devices:
Contributing
Do you want to take part in the development? Please, head to CONTRIBUTING to get started.
Disclaimer
The motivation for this plugin was to improve @switchbot/homebridge-switchbot for my personal use case. Therefore, support for other devices is not guaranteed and it will highly depend on contributions, which are more than welcome.