mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-04-27 23:07:34 +00:00
70 lines
2.0 KiB
Markdown
70 lines
2.0 KiB
Markdown
---
|
|
title: SwitchBot Cloud
|
|
description: Instructions on how to set up SwitchBot Devices.
|
|
ha_category:
|
|
- Button
|
|
- Hub
|
|
- Lock
|
|
- Plug
|
|
- Remote
|
|
- Sensor
|
|
- Switch
|
|
- Vacuum
|
|
ha_release: '2023.10'
|
|
ha_iot_class: Cloud Polling
|
|
ha_codeowners:
|
|
- '@SeraphicRav'
|
|
- '@laurence-presland'
|
|
- '@Gigatrappeur'
|
|
ha_domain: switchbot_cloud
|
|
ha_platforms:
|
|
- button
|
|
- climate
|
|
- lock
|
|
- sensor
|
|
- switch
|
|
- vacuum
|
|
ha_config_flow: true
|
|
ha_integration_type: hub
|
|
---
|
|
|
|
The SwitchBot Cloud integration allows you to control SwitchBot [devices](https://www.switch-bot.com/) 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 %}
|