Valetudo Newcomer Guide

Hi and welcome to the Valetudo Newcomer Guide.

This should hopefully answer all the questions you might have and also be interesting to read for people that haven’t been following the recent development.

Last update: 2022-10-18

What is Valetudo?

Valetudo is a cloud replacement for vacuum robots enabling local-only operation. It is not a custom firmware. That means that it cannot change anything about how the robot operates.

What it can do however is protecting your data and enable you to connect your robot to your home automation system without having to detour through a vendor cloud, which, apart from the whole data problematic, might not be reachable due to your internet connection being down or some servers in the datacenter being on fire.

Not having to leave your local network of course also benefits the latency of commands, status reports etc.

Valetudo aims to be proof that easy to use and reliable smart appliances are possible without any cloud and/or account requirements. Maybe at some point it might help convince vendors that there is another way of doing things.

If you want to learn more about why someone would want to use something like Valetudo, check out the Why Valetudo? page.

If you want to learn more about why someone would not want to use something like Valetudo, check out the Why not Valetudo? page.

Who is Valetudo for?

Valetudo can be used by anyone with a basic understanding of the english language.

Note:
While Valetudo can be used by anyone with a basic understanding of the english language, it cannot be installed just with those skills.

To install Valetudo you will need some understanding of linux-ish operating systems as well as computers in general and maybe even some basic hardware hacking stuff. If you lack these skills, please consider asking a friend or computer repair shop to help you with that.

As Valetudo is just the hobby project of some guy on the internet, it is not possible (nor intended) for it to provide first-level/tier-one support.

What can Valetudo do?

By default, Valetudo provides control over your vacuum robot via a responsive webinterface that works on all of your devices. It can be used on phones, tablets as well as your desktop computer.

Furthermore, there’s a REST-interface documented with Swagger UI as well as MQTT. With support for both Homie and Home Assistant Autodiscovery for MQTT, you’re able to connect Valetudo to the open-source smarthome software of your choice.

Make sure to check out the MQTT Docs as well as the OpenHAB integration.

Valetudo fully supports:

as long as your robots firmware can actually do that.

You can find out what your Valetudo-enabled Robot is capable of by checking out the supported robots docs section as well as the capabilities overview.

By replacing the cloud, you also gain access to your own data, which you can use however you like.

For example there are already a few applications that turn your map data into various other formats such as Minecraft Worlds or Source-Engine maps. There’s a huge amount of possibilities yet to be explored.

Due to the openly documented, standardized and easily accessible Map Data, one can use any Valetudo-compatible Vacuum Robot to map out a new home, write some glue code to transform it into the 3d software of their choice and use that precise floorplan to figure out where to put the furniture.

Furthermore, the standardised Valetudo API allows for the creation of companion services such as Valeronoi, which can build a Wi-Fi signal heatmap from the data provided by Valetudo.

Which robot should I buy to use it with Valetudo?

To choose the right robot to buy, head over to Buying supported robots.

If you want to use Valetudo, please buy a supported robot.

Please refrain from buying any random robot just to then ask how we can make Valetudo on that thing happen.
Unless there are very good reasons to support a new Model/Brand/etc. such as

it likely won’t happen as chosen the strategy is to stick to a few well-supported and actually good models.

How do I install Valetudo?

The getting started guide is a good place to start.

Where can I get support?

If you’re looking for answers/supported, the first place to look are the docs.

Furthermore, you can also check the Telegram Group. Telegram features a very powerful full-text search so make sure to use that before asking.

There’s also the option of using the Github Discussions feature. The same “search before you ask” applies here. If you experience issues, please don’t immediately file a bug report but instead only do that if you’re 100% sure that it is actually a bug.

In general and especially if you’re new to open source, It’s strongly recommended to thoroughly read and understand “How To Ask Questions The Smart Way”, since that will make interactions much better for everyone involved.

How can I contribute to Valetudo?

As a regular user

You don’t need to be a developer to contribute to Valetudo, because the best way to support the project is to support other Valetudo users of which there are quite a few.

Just stick around in the Telegram Group, the IRC and/or the Github Discussions :)

As a developer

If you’re a developer, the usual stuff applies. They may be Issues tagged with “Good First Issue” which should be the right place to start.

If you intend to open a PR, please make sure to make yourself familiar with the PR Template.

If you intend to add a new feature, you should expect the discussion thread to be open at least a few weeks until you can start working on that. Please note that no response doesn’t mean yes. PRs not following these rules will be closed without further discussion

Valetudo

Open source cloud replacement for vacuum robots enabling local-only operation

View the Project on GitHub Hypfer/Valetudo

General

Newcomer Guide Why Valetudo? Why not Valetudo? Getting Started Supported Robots Implementation overview Capabilities Overview Upgrading Rooting instructions Firmware Updates Buying supported robots

Installation

Roborock OTA

Companion Apps

Valetudo Companion (Android) Valetudo Tray Companion (Windows) Valeronoi Lovelace Valetudo Map Card I can't believe it's not Valetudo node-red-contrib-valetudo Fun & Games Other Noteworthy Projects

Integrations

MQTT Home Assistant Node-RED openHAB

Misc

FAQ Roborock, Files to backup Style Guide Troubleshooting

Development

Building and Modifying Valetudo Valetudo core concepts MQTT

Archive

Supported Dreame Devices Supported Roborock Devices Newcomer Guide Early 2021 Newcomer Guide Late 2021