https://github.com/humbertogontijo/homeassistant-roborock
Roborock integration for Home Assistant. This integration uses your devices from the Roborock App
https://github.com/humbertogontijo/homeassistant-roborock
home-assistant home-automation python roborock smart-home
Last synced: 5 months ago
JSON representation
Roborock integration for Home Assistant. This integration uses your devices from the Roborock App
- Host: GitHub
- URL: https://github.com/humbertogontijo/homeassistant-roborock
- Owner: humbertogontijo
- License: gpl-3.0
- Created: 2022-12-08T00:41:47.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-06T13:59:45.000Z (7 months ago)
- Last Synced: 2025-04-14T03:11:51.778Z (6 months ago)
- Topics: home-assistant, home-automation, python, roborock, smart-home
- Language: Python
- Homepage:
- Size: 883 KB
- Stars: 704
- Watchers: 21
- Forks: 75
- Open Issues: 151
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Roborock integration for HomeAsssistant
## IMPORTANT NOTE!!
It is recommended you switch to the core version of this integration. Due to the time that the maintainers have, most time goes into supporting the core version of this integration as there are approximately 5 times as many users using that integration. There are multiple known issues with the custom component version of Roborock that are not planned to be fixed. If a user is so inclined - they can look at the fixes on the core component and carry them over here and we will approve PR. But otherwise, expect updates and fixes to this repository to be very limited at least for the time being.
## About this repo
I've bought a Roborock S7 Maxv and hated the fact that I had to use the Roborock App or the previous existing HomeAssistant integration. But not both.
Using the Xiaomi integration there is also a limit to the number of map request which this integration doesn't have
Hope everyone can enjoy this integration along side the Roborock App
[](https://www.buymeacoffee.com/humbertogontijo)
---
## Installation
I recommend installing it through [HACS](https://github.com/hacs/integration)
## IMPORTANT
Ensure that your HA instance can listen for device broadcasts on port 58866
Ensure that your HA instance can communicate to device on port 58867
### Installing via HACS
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=humbertogontijo&repository=homeassistant-roborock&category=integration)
or
1. Go to HACS->Integrations
1. Add this repo into your HACS custom repositories
1. Search for Roborock and Download it
1. Restart your HomeAssistant
1. Go to Settings->Devices & Services
1. Shift reload your browser
### Setup the Integration
[](https://my.home-assistant.io/redirect/config_flow_start/?domain=roborock)
1. Click Add Integration
1. Search for Roborock
1. Type your username used in the Roborock App and hit submit
1. You will receive an Email with a verification code
1. Type the verification code and hit submit
1. You're all set
---
## Functionality
### Vacuum
- Start the vacuum
- Stop the vacuum
- Pause the vacuum
- Dock the vacuum
- Control vacuum fan speed
- Vacuum battery
- Locate vacuum
- Clean Spot
Additional Vacuum functionality that is supported through services:
- Remote control
- Clean zone
- Go to
- Clean segment
- Set mop mode
- Set mop intensity
- Reset consumables
### Map
There is a map built in to the integration that shows you your most recent/current run of the vacuum.
### Sensors
- DND start
- DND end
- Last clean start
- Last clean end
- last clean duration
- last clean area
- current error
- current clean duration
- current clean area
- total duration
- total clean area
- total clean count
- total dust collection count
- main brush left
- side brush left
- filter left
- sensor dirty left
- battery
### Binary Sensors
- Mop attached
- Water box attached
- Water shortage
## Camera
If your vacuum has a builtin camera, you can use [go2rtc](https://github.com/AlexxIT/go2rtc) made by @AlexxIT. Steps [here](https://github.com/AlexxIT/go2rtc#source-roborock)
---
## Special thanks
Thanks @rovo89 for https://gist.github.com/rovo89/dff47ed19fca0dfdda77503e66c2b7c7
And thanks @PiotrMachowski for https://github.com/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Cloud-Map-Extractor
---