home-assistant.io/source/_integrations/switchbot_cloud.markdown
Gigatrappeur 98331bdc34
Add switchbot cloud vacuum support (#34745)
* Update switchbot_cloud.markdown

Add vacuum details

* fix vacuum syntax
2024-09-24 14:21:15 +02:00

58 lines
1.8 KiB
Markdown

---
title: SwitchBot Cloud
description: Instructions on how to set up SwitchBot Devices.
ha_category:
- Hub
- 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:
- climate
- 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
- Meter
- MeterPlus
- Outdoor Meter
- Vacuum K10+, K10+ pro, S1, S1 Plus
## 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 %}