Roborock for Home Assistant (built-in integration)

About

Roborock is a built-in Home Assistant integration that controls Roborock robot vacuums and mops locally. It adds vacuum entities along with buttons, selects, switches, numbers, times, sensors and binary sensors for settings such as cleaning mode, mop intensity, drying mode, volume and do not disturb hours. Buttons cover emptying the dustbin and resetting consumable counters, and sensors report status, errors, cleaning progress and filter time left. A map image is provided, and options choose what is drawn on it, such as room names, no-go zones, the path and obstacles. Actions can fetch maps, get the current position, send the vacuum to a position and clean a zone. Setup is done in the UI with an account email and a verification code, and devices can be discovered on the network.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
Set up in the UI Add it in Settings, Devices and services. Nothing to download.
Found by itself Home Assistant spots it on the network and offers to add it.
Cleans up devices Devices that are gone are removed by themselves.
Silver quality Home Assistant's own rating of its code and setup experience.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

Vacuums
Switches
Sensors

Setting it up

Home Assistant usually finds it on the network and offers to add it. It can also be added by hand under Settings, Devices and services.

Connect

Roborock server regionThe server region your Roborock account is registered in when setting up the app. Auto is recommended unless you are having issues.
EmailThe email address used to sign in to the Roborock app.

Enter the code

Verification codeThe verification code sent to your email.

Custom url

Roborock Server URLThe URL of the Roborock server.

After setup

ChargerShow the charger on the map.
Cleaned areaShow the area cleaned on the map.
Go-to pathShow the go-to path on the map.
Ignored obstaclesShow ignored obstacles on the map.
Ignored obstacles with photoShow ignored obstacles with photos on the map.
Mop pathShow the mop path on the map.
No carpet zonesShow the no carpet zones on the map.
No-go zonesShow the no-go zones on the map.
No mopping zonesShow the no-mop zones on the map.
ObstaclesShow obstacles on the map.
Obstacles with photoShow obstacles with photos on the map.
PathShow the path on the map.
Predicted pathShow the predicted path on the map.
Room namesShow room names on the map.
Show backgroundAdd a background to the map.

Texts from Home Assistant's source code, Apache License 2.0.

Entities

Binary sensorsClean water box, Cleaning fluid, Detergent, Dirty water box, Cleaning, Mop attached, Mop drying, Softener, Water box attached, Water shortage
ButtonsEmpty dustbin, Pause, Reset air filter consumable, Reset cleaning brush consumable, Reset strainer consumable, Reset main brush consumable, Reset sensor consumable, Reset side brush consumable, Shut down, Start
ImagesMap
NumbersVolume
SelectsCleaning mode, Cleaning route, Detergent type, Drying mode, Empty mode, Operating mode, Mop intensity, Mop mode, Wash program, Rinse times, Selected map, Softener type, and 3 more
SensorsError, Status, Roller left, Cleaning progress, Cleaning area, Maintenance brush time left, Cleaning time, Countdown, Current room, Dock error, Filter time used, Filter time left, and 18 more
SwitchesIndicator light, Child lock, Do not disturb, Dust collection, Dust emptying, Mop drying, Mop washing, Off-peak charging, Sound setting, Status indicator light
TimesDo not disturb end, Do not disturb begin, Off-peak end, Off-peak start

Actions

Get mapsRetrieves the map and room information of your device.
Get current positionRetrieves the current position of the vacuum.
Go to positionSends the vacuum to a specific position.Fields: X-coordinate, Y-coordinate
Clean zoneStarts cleaning the specified zone.Fields: Repeats, X1-coordinate, X2-coordinate, Y1-coordinate, Y2-coordinate

Troubleshooting

DiagnosticsDownloads a diagnostics file to attach to a bug report.
Repair noticesNotices it can show in Settings, Repairs:Cloud API used, The Roborock mop drying binary sensor is deprecated