Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joseantmazonsb/homebridge-switchbot
Link switchbot devices to homebridge
https://github.com/joseantmazonsb/homebridge-switchbot
homebridge homebridge-plugin homekit plugin switchbot
Last synced: about 1 month ago
JSON representation
Link switchbot devices to homebridge
- Host: GitHub
- URL: https://github.com/joseantmazonsb/homebridge-switchbot
- Owner: joseantmazonsb
- License: apache-2.0
- Created: 2023-02-24T20:30:15.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-06-21T16:23:09.000Z (over 1 year ago)
- Last Synced: 2024-11-29T18:05:05.142Z (2 months ago)
- Topics: homebridge, homebridge-plugin, homekit, plugin, switchbot
- Language: TypeScript
- Homepage:
- Size: 184 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Homebridge Switchbot Reloaded
[](https://www.npmjs.com/package/@joseantmazon/homebridge-switchbot) [](https://www.npmjs.com/package/@joseantmazon/homebridge-switchbot)
**SwitchBot meets Homekit!** This plugins uses **SwitchBot's Open API** to connect your devices to Homekit through Homebridge.
## Installation
1. Go to `Plugins` from the Homebridge web UI
2. Find `@joseantmazon/homebridge-switchbot`
3. Hit `Install`
## Setup
You only need to set your SwitchBot keys to get started. To do so, you'll have to:
1. Download SwitchBot App on App Store or Google Play Store and log in
3. Generate your keys within the App
- Click `Profile` on the bottom navigation menu
- Click `Preferences`
- Click `App version` 10 times to enable `Developer Options`
- Click `Developer Options`
- Input your `token` and `secret` into the configuration parameters.
Your homebridge config file would look similar to this afterwards:
```json
{
"platforms": [
{
"platform": "Homebridge Switchbot Reloaded",
"name": "@joseantmazon/homebridge-switchbot",
"settings": {
"api": {
"token": "",
"secret": "",
"url": "https://api.switch-bot.com/v1.1"
}
}
}
]
}
```
## Supported devices
- [SwitchBot Meter](https://www.switch-bot.com/products/switchbot-meter)
## 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` or `cool`)
- Fan speed (`auto`, `low`, `medium` or `high`)
**Overrides**
- `auto` operation mode can be overriden through the configuration so it behaves as `heat` or `cool`.
- For all devices:
```json
{
"platforms": [{
"platform": "Homebridge Switchbot Reloaded",
"name": "@joseantmazon/homebridge-switchbot",
"settings": {
"overrides": {
"thermostats": {
"all": {
"autoOperationMode": "heat"
}
}
}
}
}]
}
```
- For a single device:
```json
{
"platforms": [{
"platform": "Homebridge Switchbot Reloaded",
"name": "@joseantmazon/homebridge-switchbot",
"settings": {
"overrides": {
"thermostats": {
"": {
"autoOperationMode": "heat"
}
}
}
}
}]
}
```
***Note***: *single device settings override global directives*
## Contributing
Do you want to take part in the development? Please, head to [CONTRIBUTING](./CONTRIBUTING.md) to get started.
## Disclaimer
The motivation for this plugin was to improve [@switchbot/homebridge-switchbot](https://github.com/OpenWonderLabs/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.