Valetudo aims to be a vendor-agnostic abstraction and cloud replacement for vacuum robots which started as a standalone binary on rooted roborock vacuums.
View the Project on GitHub Hypfer/Valetudo
Newcomer Guide Early 2021 Supported Robots Capabilities Overview Rooting instructions Upgrading
Valeronoi Lovelace Valetudo Map Card I can't believe it's not Valetudo node-red-contrib-valetudo Fun & Games Other Noteworthy Projects
MQTT Home Assistant Node-RED openHAB
FAQ Frequently requested features Roborock, Files to backup Troubleshooting
Building and Modifying Valetudo Valetudo core concepts MQTT
Supported Roborock Devices Supported Viomi Devices Supported Dreame Devices
This guide applies to the following robot models
If your roborock model is newer or not listed here, there’s no point in following this guide since the instructions will be different.
For newer Gen 1 robots, you will need to follow the instructions to root an S6, which can be found on the rooting instructions page.
Valetudo is not a custom firmware.
It is simply an alternative App implementation + mock cloud which runs on the robot itself.
To do that, some secret data is required. Those being the did, the cloudKey and the current local token.
Running on the robot itself enables Valetudo to access those as well as work while in AP mode.
It’s also very neat to have a completely self-contained appliance with a web interface.
Therefore, installing Valetudo simply means taking the stock firmware and injecting Valetudo into it.
Sadly though, this process has to be done by each user individually because hosting firmware images with Valetudo preinstalled would probably be copyright infringement.
It is recommended to use the Dustbuilder to build your firmware image. It can be found here: https://builder.dontvacuum.me/
The service is provided by Dennis who is also the reason, why Valetudo can exist in the first place.
If you however don’t trust us that’s perfectly fine. You can use https://github.com/zvldz/vacuum to build the image yourself.
The reason this guide switched to dustbuilder only is that it provides a controlled environment, which eliminates common support issues. The irony that this guide suggests using “the cloud” to uncloud your device is not lost on me.
To flash the image we are going to use python-miio, which provides mirobo - a tool to control a vacuum cleaner from a terminal.
First, we need to get it and for this we recommend to create a python virtual environment for it.
cd ..
mkdir flasher
cd flasher
python3 -m venv venv
Now, when the virtual environment is ready we are going to activate it and install miio python package which provides mirobo:
source venv/bin/activate
pip3 install wheel
pip3 install python-miio
cd ..
Flashing an image requires providing your robot’s token.
To acquire it, connect to your robot’s WiFi Access Point and run the following command:
mirobo --debug discover --handshake true
You’re looking for a similar line:
INFO:miio.miioprotocol: IP 192.168.8.1 (ID: 0f90319a) - token: b'ffffffffffffffffffffffffffffffff'
If your robot doesn’t show up check if you have multiple connected network interfaces. Either disable all other (those not connected to your robot’s WiFi) or use a VM which you explicitly connect to your host’s WiFi interface. Another possibility is an internal firewall blocking it. On RedHat-based Linux systems using Firewalld (CentOS, Fedora, etc.), make sure the firewall zone for your connection to the robot’s WiFi Access Point is set to “trusted” instead of “public”.
With token in out hand we can upload the firmware to the robot:
mirobo --token XXXXXXXXXXXXXXXX --ip ROBOT_IP_ADDRESS update-firmware path/to/built/image.pkg
ROBOT_IP_ADDRESS is 192.168.8.1 by default but if you’re upgrading Valetudo to a new version, you need to replace it with the robot’s current IP address.
Also please keep the distance between your WiFi antenna and your robot as short as possible or the connection might get lost.
After the successful transfer of the image to the robot, the robot will start flashing the image. This will take about 5~10 minutes. After the process is done, the robot will state that the update was successful.
You should then reboot the Robot either via ssh command ssh root@192.168.8.1 and typing reboot or simply by taking it out of dock and push the ON switch to prevent valetudo stuck on LOADING STATE???
To connect the robot to your home Wifi, just connect to http://192.168.8.1 and use Valetudos settings dialog to enter your wifi credentials. Please note that only WPA2-PSK is supported. After updating the Wifi settings, you should reboot your robot.
You need to get the IP of your robot (e.g. from your router) and connect to it using your browser e.g. http://192.168.Y.Z