Skip to content

About

SwitchBot MQTT Home Assistant add-on

Topics

Resources

Stars

134 stars

Watchers

3 watching

Forks

Repository files navigation

logo

SwitchBot MQTT Home Assistant App/Add-on

This project is a Home Assistant app that allows you to control various SwitchBot products through the API.

The app 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 app does not support operations on SwitchBot devices via Bluetooth.

New custom integration for Pan/Tilt Cam Plus here.

Current Support Status

aarch64-shield amd64-shield armv7-shield

Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.

Physical Devices

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 EnforceDeviceTypes option in your settings.
Device OpenAPI v1.1
Documented
Status
API
Webhook Command
API
Verification
Hub - - - - -
Hub ✅ - - -
Hub Plus ✅ - - -
Hub Mini [JP] ✅ - - - -
Hub 2 [JP] ✅ ✅ ✅ - ✅
Hub 3 [JP] ✅ ✅ ✅ - ✅
AI Hub [JP] ✅ ✅ - -
Home Automation - - - - -
Bot [JP] ✅ ✅ ✅ ✅
Curtain ✅ ✅ ✅ ✅ ✅
Curtain3 [JP] ✅ ✅ ✅ ✅
Curtain 4 ✅ ✅ ✅ ✅
Blind Tilt [JP] ✅ ✅ - ✅
Roller Shade ✅ ✅ ✅ ✅ ✅
Universal Remote [JP] - ✅ - - ✅
Wallet Finder Card [JP] - - - - -
Relay Switch 1PM ✅ ✅ ✅ ✅ ✅
Relay Switch 1 [JP] ✅ ✅ ✅ ✅ ✅
Relay Switch 2PM ✅ ✅ ✅ ✅ ✅
Garage Door Opener ✅ ✅ ✅ ✅
Smart Radiator Thermostat ✅ ✅ ✅ ✅
Home Climate Panel [JP] ✅ ✅ ✅ -
Kata Friends [JP] ✅ ✅ ✅ ✅
AI MindClip ✅ ✅ ✅ -
Home Appliance - - - - -
Humidifier [JP] ✅ ✅ - ✅
Evaporative Humidifier [JP] ✅ ✅ ✅ ✅
Evaporative Humidifier Auto-refill [JP] ✅ ✅ ✅ ✅
Fan -
Battery Circulator Fan [JP] ✅ ✅ ✅ ✅
Battery Circulator Fan 2 Pro [JP] ✅ ✅ ✅ ✅
Circulator Fan [JP] ✅ ✅ ✅ ✅ ✅
Standing Circulator Fan [JP] ✅ ✅ ✅ ✅
Air Purifier PM2.5 ✅ ✅ ✅ ✅
Air Purifier Table PM2.5 ✅ ✅ ✅ ✅
Air Purifier VOC [JP] ✅ ✅ ✅ ✅
Air Purifier Table VOC [JP] ✅ ✅ ✅ ✅
AI Art Frame [JP] ✅ ✅ ✅ ✅
AI Art Frame 2 ✅ ✅ ✅ ✅
Robot Vacuum - - - - -
Robot Vacuum Cleaner S1 [JP] ✅ ✅ ✅ ✅
Robot Vacuum Cleaner S1 Plus [JP] ✅ ✅ ✅ ✅
Mini Robot Vacuum K10+ [JP] ✅ ✅ ✅ ✅
Mini Robot Vacuum K10+ Pro [JP] ✅ ✅ ✅ ✅ ✅
Multitasking Household Robot K20+ Pro [JP] ✅ ✅ ✅ ✅
Floor Cleaning Robot S10 [JP] ✅ ✅ ✅ ✅
Floor Cleaning Robot S20 [JP] ✅ ✅ ✅ ✅
Robot Vacuum K10+ Pro Combo [JP] ✅ ✅ ✅ ✅
Robot Vacuum K11+ [JP] ✅ ✅ ✅ ✅
Robot Vacuum K11+ Pro [JP] ✅ ✅ ✅ ✅
Sensor - - - - -
Meter [JP] ✅ ✅ ✅ -
Meter Plus [JP] ✅ ✅ ✅ - ✅
Meter Pro [JP] ✅ ✅ ✅ -
Meter Pro CO2 [JP] ✅ ✅ ✅ - ✅
Outdoor Meter [JP] ✅ ✅ ✅ - ✅
Weather Station [JP] ✅ ✅ ✅ ✅
Motion Sensor [JP] ✅ ✅ ✅ - ✅
Presence Sensor [JP] ✅ ✅ ✅ - ✅
Contact Sensor [JP] ✅ ✅ ✅ - ✅
Water Leak Detector [JP] ✅ ✅ ✅ -
Security(Lock) - - - - -
Smart Lock [JP] ✅ ✅ ✅ ✅ ✅
Smart Lock Pro [JP] ✅ ✅ ✅ ✅
Smart Lock Lite [JP] ✅ ✅ ✅ ✅
Smart Lock Ultra [JP] ✅ ✅ ✅ ✅ ✅
Smart Lock Ultra Max ✅ ✅ ✅ ✅
Smart Lock Pro (Matter Enabled) ✅ ✅ ✅ ✅
Lock Vision ✅ ✅ ✅ ✅
Lock Vision Pro ✅ ✅ ✅ ✅
Keypad JP ✅ ✅ ✅ ✅
Keypad Touch [JP] ✅ ✅ ✅ ✅ ✅
Keypad Vision [JP] ✅ ✅ ✅ ✅
Keypad Vision Pro [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 2K(3MP) [JP] ✅ ✅📸 ✅📸 -
Pan/Tilt Cam Plus 3K(5MP) [JP] ✅ ✅📸 ✅📸 - ✅
Outdoor Pan/Tilt Cam 3K [JP] - ✅📸 ✅📸 - ✅
Solar Pan/Tilt Cam 2K ✅ ✅📸 ✅ ✅
Indoor Cam [JP] ✅ - ✅ - ✅
Video Doorbell [JP] ✅ ✅ ✅📸 ✅ ✅
Power & Switch - - - - -
Plug ✅ ✅ - ✅
Plug Mini (US) ✅ ✅ ✅ ✅
Plug Mini (JP) [JP] ✅ ✅ ✅ ✅ ✅
Plug Mini (EU) ✅ ✅ ✅ ✅
Remote [JP] ✅ - - - -
Lighting - - - - -
Ceiling Light [JP] ✅ ✅ ✅ ✅ ✅
Ceiling Light Pro [JP] ✅ ✅ ✅ ✅
Color Bulb [JP] ✅ ✅ ✅ ✅ ✅
Strip Light [JP]
Strip Light2 [JP]
✅ ✅ ✅ ✅ ✅
RGBWW Strip Light 3 [JP] ✅ ✅ ✅ ✅ ✅
RGBWW Floor Lamp [JP] ✅ ✅ ✅ ✅
RGBICWW Strip Light [JP] ✅ ✅ ✅ ✅
RGBICWW Floor Lamp [JP] ✅ ✅ ✅ ✅
RGBICWW Ceiling Light ✅ ✅ ✅ ✅
RGBICWW Light Bars [JP] ✅ ✅ ✅ ✅
Permanent Outdoor Lights [JP] ✅ ✅ ✅ ✅
RGBIC Neon Wire Rope Light [JP] ✅ ✅ ✅ ✅ ✅
RGBIC Neon Rope Light [JP] ✅ ✅ ✅ ✅
Candle Warmer Lamp [JP] ✅ ✅ ✅ ✅
  • The 📸 icon indicates that snapshots included in the Webhook payload are detected as MQTT Image.
  • The Feature APIs of Kata Friends (diary) and AI MindClip (recordings, summaries, todos, assistant) are out of scope for this MQTT bridge.
  • If you see errors such as unknown webhook payload or unknown status payload in the add-on logs, the API response or webhook body may have introduced new fields. Please share the relevant logs and API response or webhook body in a GitHub Issue.

Virtual Infrared Remote Devices

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 ✅

Installation Method

For installation instructions, please refer to here.

About

SwitchBot MQTT Home Assistant add-on

Topics

Resources

Stars

134 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages