home-assistant.io/source/_integrations/switchbot_cloud.markdown

title, description, ha_category, ha_release, ha_iot_class, ha_codeowners, ha_domain, ha_platforms, ha_config_flow, ha_integration_type

title	description	ha_category	ha_release	ha_iot_class	ha_codeowners	ha_domain	ha_platforms	ha_config_flow	ha_integration_type
SwitchBot Cloud	Instructions on how to set up SwitchBot Devices.	Binary Sensor Button Cover Fan Hub Humidifier Light Lock Plug Remote Sensor Switch Vacuum	2023.10	Cloud Polling	@SeraphicRav @laurence-presland @Gigatrappeur @XiaoLing-git	switchbot_cloud	binary_sensor button climate cover fan humidifier light lock sensor switch vacuum	true	hub

The SwitchBot Cloud integration allows you to control SwitchBot devices connected through the SwitchBot hub.

Prerequisites

In order to use this integration, you will need at least a SwitchBot Hub and a SwitchBot account to get a token and secret key from the SwitchBot mobile app in Profiles > Preferences > Developer Options. If Developer Options is not present in preferences, tap the App Version (e.g. 6.24) several times (5~15 times) in succession to open the Developer Options. See also SwitchBot's blog for more information specific to the app.

Please note, device names configured in the SwitchBot app are transferred into Home Assistant.

{% include integrations/config_flow.md %}

Supported devices

Plugs and switches

• Bot (WoHand)
• Relay Switch 2PM
• Relay Switch 1
• Relay Switch 1PM
• Plug Mini (WoPlug)
• Plug Mini (HomeKit Enabled)
• Plug Mini (EU)
• Plug (Wi-Fi only, only available in Japan)

Cover

• Curtain (WoCurtain) (version 1 & 2)
• Curtain 3 (WoCtn3)
• Blind Tilt (WoBlindTilt)
• Roller Shade
• Garage Door Opener

Lights

• LED Strip Light 3
• Floor Lamp
• Color Bulb (WoBulb)
• Light Strip (WoStrip)
• RGBICWW Floor Lamp
• RGBICWW Strip Light

Locks

• Lock (WoLock)
• Lock Pro (WoLockPro)

Sensors

• Meter
• Meter Plus
• Indoor/Outdoor Meter (WoIOSensorTH)
• Meter Pro
• Meter Pro CO2 Monitor
• Contact Sensor
• Motion Sensor
• Water Leak Detector
• Climate Panel
• Presence Sensor

Hubs

• Hub 2 (WoHub2) (currently only supports retrieving sensor data, does not yet support device control)
• Hub 3 (currently only supports retrieving sensor data, does not yet support device control)
• IR appliances exposed through the different hubs:
  • ON/OFF for all appliance types except for Others
  • Change temperature and mode for Air Conditioner

Humidifiers

• Humidifier (WoHumi)
• Evaporative Humidifier

Vacuums

• K10+
• K10+ Pro
• K10+ Pro Combo
• K11+
• K20+ Pro
• S20
• S10
• S1
• S1 Plus

Fans

• Circulator Fan
• Air Purifier
• Air Purifier Table

Supported functionality

Plugs and switches

Bot

Features:

• acted as a Switch in switchMode and customizeMode, as a Button in pressMode
• turn on or off
• press
• get battery level

Plug Mini

Features:

• turn on or off
• get power consumption readings

Relay Switch 2PM

Features: displayed as two switches with the following properties or actions individually,

• turn on or off
• get power
• get voltage
• get current
• get daily used electricity or power consumption

Relay Switch 1

Features:

• turn on or off

Relay Switch 1PM

Features:

• turn on or off
• get power
• get voltage
• get current

Plug

Features:

• turn on or off

Cover

Curtain

Features:

• open/close/pause
• set position
• get position
• get battery level
• get calibration state

Curtain 3

Features:

• open/close/pause
• set position
• get position
• get battery level
• get calibration state

Blind Tilt

Features:

• close up/close down
• set position
• get position
• get battery level
• get calibration state

Roller Shade

Features:

• open/close
• set position
• get position
• get battery level
• get calibration state

Garage Door Opener

Features:

• open/close
• set position
• get position
• get calibration state

Sensors

Meter

Features:

• get temperature
• get humidity
• get battery level

Meter Plus

Features:

• get temperature
• get humidity
• get battery level

Indoor/Outdoor Meter

Features:

• get temperature
• get humidity
• get battery level

Meter Pro

Features:

• get temperature
• get humidity
• get battery level

Meter Pro CO2 Monitor

Features:

• get temperature
• get humidity
• get carbon dioxide
• get battery level

Contact Sensor

Features:

• get motion detection state
• get light state
• get open state
• get battery level

Motion Sensor

Features:

• get motion detection state
• get battery level

Presence Sensor

Features:

• get motion detection state
• get battery level

Water Leak Detector

Features:

• get leak state
• get battery level

Climate Panel

Features:

• get temperature
• get humidity
• get battery level
• light detect
• motion detect

Lights

LED Strip Light 3

Features:

• turn on or off
• change brightness
• change color temperature
• change color

Floor Lamp

Features:

• turn on or off
• change brightness
• change color temperature
• change color

Color Bulb

Features:

• turn on or off
• change brightness
• change color temperature
• change color

LED Strip Light

Features:

• turn on or off
• change brightness
• change color

Locks

Lock

Features:

• Lock or unlock
• open or closed state
• calibration state
• get battery level

Lock Pro

Features:

• Lock or unlock
• open or closed state
• calibration state
• get battery level

Hubs

Some of the hubs can be served as a bridge while the sensor data can be retrieved. Hub 2 displays temperature and humidity through a sensor cable. Without a digital display, Hub Mini Matter Enabled can also read from a sensor cable.

Hub 2

Features:

• get temperature
• get humidity

Hub 3

Features:

• get motion detection state
• get temperature
• get humidity
• get light level

Humidifiers

Humidifier entities are added for Humidifier and Evaporative Humidifier.

Humidifier

Features:

• turn on
• turn off
• set mode
• set humidity

Evaporative Humidifier

Note: Not all modes support unless you bind the temperature and humidity sensor.

Features:

• turn on
• turn off
• set mode
• set humidity

Fans

Battery Circulator Fan/Circulator Fan

Features:

• turn on
• turn off
• set speed, only applicable for [direct mode]
• set mode
• get battery, only applicable for [Battery Circulator Fan]

Air Purifier

Features:

• get states
• turn on
• turn off
• set mode

Air Purifier Table

Features:

• get states
• turn on
• turn off
• set mode

Vacuums

Vacuum entities are added for K10+, K10+ Pro, K10+ Pro Combo, K11+, K20+ Pro, S10, S20.

Features:

• get states
• start/clean
• pause
• set cleaning mode
• return to base
• get battery

Important considerations

{% note %} Each sensor will request a status update from the SwitchBot Cloud API once every 10 minutes (600 seconds). The SwitchBot Cloud API limits users to 10,000 requests per day. {% endnote %}

{% warning %} For IR Appliances, the state is inferred from previous commands in Home Assistant and might not reflect reality if you use other ways to control the device. {% endwarning %}

Webhook support

For vacuums, the states are updated from SwitchBot's cloud.

{% warning %} Only ONE webhook URL seems to be accepted by the SwitchBot's cloud. So, if you want several applications notified, you need to use a “proxy” to re-dispatch the message to the other applications. {% endwarning %}