This project is a Home Assistant add-on that allows you to control various SwitchBot products through the API.
The add-on can also receive Webhooks to obtain the device's status. Via an MQTT broker, it will be detected as an MQTT integration in Home Assistant.
You can perform manual scene executions that were configured in the SwitchBot app, as well as control virtual infrared remote devices.
Important: Please note that this add-on does not support operations on SwitchBot devices via Bluetooth.
We have implemented all devices according to the published API specifications, but testing has been conducted only on a subset.
- The "-" in the "Verification" column indicates that product was tested and found to have no specific functionality.
- To check which values can be referenced and what operations can be performed for each device, please refer to the links provided to each checkbox.
- Even for products not officially documented, the API may indicate the device type as another product. Additionally, devices with similar fields and commands may function if their device type is spoofed. For example, recognizing a K10+ as an S1 may enable operation. Configure the
EnforceDeviceTypesoption in your settings.
| Device | OpenAPI v1.1 Documented |
Status API |
Webhook | Command API |
Verification |
|---|---|---|---|---|---|
| Hub | - | - | - | - | - |
| Hub | ✅ | - | - | - | |
| Hub Plus | ✅ | - | - | - | |
| Hub Mini [JP] | ✅ | - | - | - | - |
| Hub 2 [JP] | ✅ | ✅ | ✅ | - | ✅ |
| Home Automation | - | - | - | - | - |
| Bot [JP] | ✅ | ✅ | ✅ | ✅ | |
| Curtain | ✅ | ✅ | ✅ | ✅ | ✅ |
| Curtain3 [JP] | ✅ | ✅ | ✅ | ✅ | |
| Blind Tilt [JP] | ✅ | ✅ | - | ✅ | |
| Roller Shade | ✅ | ✅ | ✅ | ✅ | |
| Universal Remote [JP] | - | ✅ | - | - | ✅ |
| Wallet Finder Card [JP] | - | - | - | - | - |
| Relay Switch 1PM | ✅ | ✅ | ✅ | ✅ | |
| Relay Switch 1 | ✅ | ✅ | ✅ | ✅ | |
| Home Appliance | - | - | - | - | - |
| Humidifier [JP] | ✅ | ✅ | - | ✅ | |
| Evaporative Humidifier [JP] | ✅ | ✅ | ✅ | ✅ | |
| Evaporative Humidifier Auto-refill [JP] | ✅ | ✅ | ✅ | ✅ | |
| Fan | - | ||||
| Battery Circulator Fan [JP] | ✅ | ✅ | ✅ | ✅ | |
| Circulator Fan [JP] | ✅ | ✅ | ✅ | ✅ | ✅ |
| Air Purifier PM2.5 | ✅ | ✅ | ✅ | ✅ | |
| Air Purifier Table PM2.5 | ✅ | ✅ | ✅ | ✅ | |
| Air Purifier VOC [JP] | ✅ | ✅ | ✅ | ✅ | |
| Air Purifier Table VOC [JP] | ✅ | ✅ | ✅ | ✅ | |
| Robot Vacuum | - | - | - | - | - |
| Robot Vacuum Cleaner S1 [JP] | ✅ | ✅ | ✅ | ✅ | |
| Robot Vacuum Cleaner S1 Plus [JP] | ✅ | ✅ | ✅ | ✅ | |
| Mini Robot Vacuum K10+ [JP] | ✅ | ✅ | ✅ | ✅ | |
| Mini Robot Vacuum K10+ Pro [JP] | ✅ | ✅ | ✅ | ✅ | |
| Floor Cleaning Robot S10 [JP] | ✅ | ✅ | ✅ | ✅ | |
| Robot Vacuum K10+ Pro Combo | ✅ | ✅ | ✅ | ✅ | |
| Sensor | - | - | - | - | - |
| Meter [JP] | ✅ | ✅ | ✅ | - | |
| Meter Plus [JP] | ✅ | ✅ | ✅ | - | ✅ |
| Meter Pro [JP] | ✅ | ✅ | ✅ | - | |
| Meter Pro CO2 [JP] | ✅ | ✅ | ✅ | - | ✅ |
| Outdoor Meter [JP] | ✅ | ✅ | ✅ | - | |
| Motion Sensor [JP] | ✅ | ✅ | ✅ | - | ✅ |
| Contact Sensor [JP] | ✅ | ✅ | ✅ | - | ✅ |
| Water Leak Detector [JP] | ✅ | ✅ | ✅ | - | |
| Security(Lock) | - | - | - | - | - |
| Smart Lock [JP] | ✅ | ✅ | ✅ | ✅ | ✅ |
| Smart Lock Pro [JP] | ✅ | ✅ | ✅ | ✅ | |
| Keypad JP | ✅ | ✅ | ✅ | ✅ | |
| Keypad Touch [JP] | ✅ | ✅ | ✅ | ✅ | ✅ |
| Security(Camera) | - | - | - | - | - |
| Outdoor Spotlight Cam 1080P [JP] | - | ||||
| Outdoor Spotlight Cam 2K(3MP) [JP] | - | - | - | - | - |
| Pan/Tilt Cam [JP] | ✅ | - | ✅ | - | |
| Pan/Tilt Cam 2K(3MP) [JP] | ✅ | ||||
| Pan/Tilt Cam Plus(3MP) [JP] | - | ||||
| Pan/Tilt Cam Plus(5MP) [JP] | - | - | ✅ | ✅ | |
| Indoor Cam [JP] | ✅ | - | ✅ | - | ✅ |
| Power & Switch | - | - | - | - | - |
| Plug | ✅ | ✅ | - | ✅ | |
| Plug Mini (US) | ✅ | ✅ | ✅ | ✅ | |
| Plug Mini (JP) [JP] | ✅ | ✅ | ✅ | ✅ | ✅ |
| Remote [JP] | ✅ | - | - | - | - |
| Lighting | - | - | - | - | - |
| Ceiling Light [JP] | ✅ | ✅ | ✅ | ✅ | |
| Ceiling Light Pro [JP] | ✅ | ✅ | ✅ | ✅ | |
| Color Bulb [JP] | ✅ | ✅ | ✅ | ✅ | ✅ |
| Strip Light [JP] | ✅ | ✅ | ✅ | ✅ | |
| Strip Light2 [JP] |
| Device | Command |
|---|---|
| Air Conditioner | ✅ |
| TV | ✅ |
| Light | ✅ |
| Fan | ✅ |
| IPTV(Streamer) | ✅ |
| Set Top Box | ✅ |
| DVD Player | ✅ |
| Speaker | ✅ |
| Robot Vacuum Cleaner | ✅ |
| Air Purifier | ✅ |
| Water Heater(Bath) | ✅ |
| Projector | ✅ |
| Camera | ✅ |
| Others | ✅ |
For installation instructions, please refer to here.