home-assistant.io/source/_integrations/switchbot_cloud.markdown
2025-01-21 13:21:08 +01:00

2.0 KiB

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.
Button
Hub
Lock
Plug
Remote
Sensor
Switch
Vacuum
2023.10 Cloud Polling
@SeraphicRav
@laurence-presland
@Gigatrappeur
switchbot_cloud
button
climate
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.

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

{% include integrations/config_flow.md %}

Supported devices

  • Plug (Wi-Fi only, only available in Japan)
  • Plug Mini, both the original and HomeKit-enabled
  • IR appliances exposed through the different hubs:
    • ON/OFF for all appliance types excepted "Others"
    • Air Conditioner
  • Lock
  • Lock Pro
  • Meter
  • MeterPlus
  • MeterPro
  • MeterPro (C02)
  • Outdoor Meter
  • Vacuum K10+, K10+ pro, S1, S1 Plus
  • Hub 2
  • Relay Switch 1
  • Relay Switch 1PM
  • Bot (as a Switch in switchMode and customizeMode, as a Button in pressMode)

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 %}