3.6 KiB
title | description | ha_category | ha_iot_class | ha_release | ha_config_flow | ha_codeowners | ha_domain | ha_platforms | ha_integration_type | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Roborock | Instructions on how to integrate Roborock vacuums into Home Assistant |
|
Local Polling | 2023.5 | true |
|
roborock |
|
integration |
The Roborock integration allows you to control your Roborock vacuum while using the Roborock app.
This integration requires a cloud connection to set up the device, but it communicates with the device entirely over your home network.
Once you log in with your Roborock account, the integration will automatically discover your Roborock devices and get the needed information to communicate locally with them. Please ensure your Home Assistant instance can communicate with the local IP of your device. We recommend setting a static IP for your Roborock Vacuum to help prevent future issues.
{% include integrations/config_flow.md %}
FAQ
Can I use the Mi home app with this integration?
No. This integration requires information from your Roborock app to set up and uses Roborock's protocols to communicate with your device. You must have your vacuum synced to the Roborock app.
Can I block internet access for this device?
As of right now - no. When the vacuum is disconnected from the internet, it will attempt to disconnect itself from Wi-Fi and reconnect itself until it can reach the Roborock servers. We are looking for the best way to handle this and see what can be blocked while still allowing the vacuum to function.
What devices are supported?
If you can add your device to the Roborock app - it is supported. However, some older vacuums like the Roborock S5 must be connected using the Mi Home app and can be set up in Home Assistant through the Xiaomi Miio integration.
What features will you support?
We are working on adding a lot of features to the core integration. We have reverse-engineered over 100 commands. The following are some of the functionalities we plan to add to Home Assistant Core. We ask that you are patient with us as we add them.
- Selective room cleaning
- Dock controls
- Manual vacuum remote control
- Status information such as errors, clean time, consumables, etc.
- Viewing the camera
- Viewing the map
How can I clean a specific room?
We plan to make the process simpler in the future, but for now, it is a multi-step process.
- Enable debug logging for this integration and reload it.
- Search your logs for 'Got home data' and then find the attribute rooms.
- Write the rooms down; they have a name and 6 digit ID.
- Go to Developer Tools > Services > Vacuum: Send Command. Select your vacuum as the entity and 'get_room_mapping' as the command.
- Go back to your logs and look at the response to
get_room_mapping
. This is a list of the 6-digit IDs you saw earlier to 2-digit IDs. In your original list of room names and 6-digit IDs, replace the 6-digit ID with its pairing 2-digit ID. - Now, you have the 2-digit ID that your vacuum uses to describe a room.
- Go back to Developer Tools > Services > Vacuum: Send Command then type
app_segment_clean
as your command and 'segments' with a list of the 2-digit IDs you want to clean. Then, addrepeat
with a number (ranging from 1 to 3) to determine how many times you want to clean these areas.
Example:
service: vacuum.send_command
data:
command: app_segment_clean
params:
- segments:
- 22
- 23
- repeat: 1
target:
entity_id: vacuum.s7_roborock