Valetudo

Cloud-free control webinterface for vacuum robots

View the Project on GitHub Hypfer/Valetudo

General

Newcomer Guide Early 2021 Supported Robots Capabilities Overview Rooting instructions Upgrading

Installation

Roborock OTA Viomi

Companion Apps

Valeronoi Lovelace Valetudo Map Card I can't belive it's not Valetudo node-red-contrib-valetudo Fun & Games Other Noteworthy Projects

Integrations

MQTT Home Assistant Node-RED openHAB

Misc

FAQ Frequently requested features Troubleshooting

Development

Building and Modifying Valetudo Valetudo core concepts MQTT

Knowledge Base

Supported Roborock Devices Supported Viomi Devices Supported Dreame Devices

Capabilities overview

To support a growing list of robots with different sub- as well as supersets of features, the concept of capabilities was introduced.

Although the names should be fairly self-explanatory, this page documents what each of them does. Your robot will probably have multiple but not all of these.

BasicControlCapability

Basic robot controls. This should be something that all supported ValetudoRobots implement.

Its methods are:

Unfortunately, not all vendors support “stop”. If that’s not the case, stop will perform a pause.

CarpetModeControlCapability

This capability enables you to enable or disable the automatic suction power increase when the robot detects that it has driven onto a carpet.

CombinedVirtualRestrictionsCapability

This capability enables you to configure Virtual Walls + Restricted Zones.

ConsumableMonitoringCapability

This capability enables you to view and reset the status of the consumables of your robot.

DoNotDisturbCapability

This capability enables you to set a DND timespan. The exact behaviour is dependent on your vendor.

One usual behaviour is that the robot won’t continue a cleanup that has been interrupted due to an empty battery until DND is over. On some robots it also dims the LEDs during the DND phase.

FanSpeedControlCapability

This capability enables you to set the suction power of your robot.

GoToLocationCapability

This capability enables you to send your robot to a location on your map. It will simply stay there and do nothing.

One common use-case of this is to send the robot to your bin.

Furthermore, this capability will enable you to define ValetudoGoToLocationPresets which are predefined spots that can be called via MQTT.

LocateCapability

This capability enables you to let the robot play some kind of sound often at full volume so that you can find it.

Useful if you’ve completely lost track of where that thing went. It’s usually below the couch.

MapResetCapability

This capability enables you to reset the current map.

MapSegmentEditCapability

This capability enables you to join and split detected segments.

If you’re new to Valetudo, you might be referring to Segments as Rooms. It’s the same thing. I just didn’t like the term room, because they don’t necessarily have to actually be rooms.

MapSegmentRenameCapability

This capability enables you to assign names to segments. Naming segments makes it easier to distinguish them.

MapSegmentationCapability

This capability enables you to clean detected segments.

If you’re new to Valetudo, you might be referring to Segments as Rooms. It’s the same thing. I just didn’t like the term room, because they don’t necessarily have to actually be rooms.

MapSnapshotCapability

This capability enables you to list all existing map snapshots as well as restore one of them.

Snapshots are made automatically by the robots firmware. They’re basically backups. Use this if your robot has lost track of where it is and somehow corrupted the map.

PersistentMapControlCapability

This capability enables you to control whether the robot persists its map across cleanups. When persisted maps are disabled, a new map is generated on each new full cleanup.

DebugCapability

This capability is only for debugging purposes. Its behavior is undefined and it may change without notice. Do not use it. It has to be explicitly enabled in the Valetudo config to be available.

SpeakerTestCapability

This capability enables you to play a test sound at the configured volume level. It is used to try out the newly set audio volume.

SpeakerVolumeControlCapability

This capability enables you to control the volume of the integrated speaker of the robot.

VoicePackManagementCapability

This capability enables you to change and upload new voice packs to the robot.

WaterUsageControlCapability

This capability enables you to configure the water output flow for mopping.

WifiConfigurationCapability

This capability enables you to get the current Wi-Fi connection details (including rssi) as well as reconfigure Wi-Fi.

ZoneCleaningCapability

This capability enables you to send your robot to clean one or more (depending on the vendor) zones drawn onto the map.

Furthermore, this also enables you to define ValetudoZonePresets which are predefined zones that can be called via MQTT.