About: Extract the maps of Vacuum Cleaners connected via MQTT to Home Assistant such as Valetudo Hypfer or RE(rand256) firmwares, easy setup thanks to HACS and guided Home Assistant GUI configuration.
What it is:
❗This is an unofficial repo and is not created, maintained, or in any sense linked to valetudo.cloud
This custom component is simple to install and setup, decode and render the vacuum maps to Home Assistant in few clicks. When you want also to control your vacuum you will need to also install the: lovelace-xiaomi-vacuum-map-card (recommended) from HACS as well.
The goal of this project is to deliver an out-of-the-box solution for integrating MQTT-based vacuums into the Home Assistant ecosystem. This includes real-time map extraction, sensor data (when not provided), and control services (not available by default) for a seamless user experience.
Our current focus is evolving beyond map rendering to provide full vacuum control, ensuring a reliable, complete integration for all Valetudo-based vacuums, while continuously improving the user experience through regular updates.
Planned in the next Release
- Features:
- Added on 2024.11.0 the Actions for Rand256 to load and save maps fully integrate MapLoader.
- Fix #263: The init process will be coordinated as we have Cameras and Sensors that need to be initialized.
- Fix #276 "Unknown error" when some vacuum data is not reachable (refactoring).
Please Read the "Limitations and Compatibility" before to install the camera.
I kindly ask for your understanding regarding any limitations you may encounter with this custom component (please read also our notice). While it's been extensively tested on a PI4 8GB and now also on ProxMox VE, hardware below PI4 8GB may face issues. Your feedback on such platforms is invaluable; please report any problems you encounter. As a team of one, I'm diligently working to address compatibility across all environments, but this process takes time. In the interim, you can utilize ValetudoPNG as an alternative on unsupported platforms. Your support in making this component compatible with all environments is greatly appreciated. If you'd like to contribute, whether through code or time, please consider joining our efforts. For further details on how the camera operates and how you can contribute, refer to the Wiki section of this project. Your patience and assistance are crucial as we strive toward our goal of universal compatibility.
- PI3 4GB: The camera is working on PI3 4GB, anyhow no chance there to run two vacuums cameras at the same time.
- PI4 4GB: The camera is working on PI4 4GB, anyhow run two vacuums cameras at the same time isn't advised even if possible.
We here list, thanks to our users and tests done, the known working vacuums.
- Dreame D9
- Dreame Z10 Pro
- Dreame L10s Ultra
- Mi Robot Vacuum-Mop P
- Roborock.S5 / S50 / S55 (Gen.2)
- Roborock.S6
- Roborock.S7
- Roborock.S8
- Roborock.V1 (Gen.1)
- Xiaomi C1
- In general, it works with all flashed Valetudo Hypfer or RE(rand256) vacuums.
The instructions in here show detailed steps and will help to set up the camera also without HACS (manual setup). Our setup guide also includes important informations on how to setup the lovelace-xiaomi-vacuum-map-card (recommended).
We here List what this camera offers as futures.
- All Valetudo equipped vacuums are supported.
- Supported languages (English, Arabic, Chinese, Czech, Dutch, French, German, Italian, Japanese, Polish, Norwegian, Russian, Spanish, Swedish).
- Automatically Generate the calibration points for the lovelace-xiaomi-vacuum-map-card to ensure full compatibility to this user-friendly card.
- Automatically Generate rooms based configuration when vacuum support this functionality, this will allow you to configure the rooms quickly on the lovelace-xiaomi-vacuum-map-card.
- The camera take automatically snapshots (when the vacuum idle/ error / docked). It is also possible to save a snapshot using the Action from Home Assistant with the file name and location you want to use. By the default the snapshot is saved in the www folder of Home Assistant. If the snapshot is disabled from Image Options the png will be deleted automatically.
service: camera.snapshot target: entity_id: camera.valetudo_your_vacuum_camera data: filename: /config/www/REPLACE_ME.png - Change the image options directly form the Home Assistant integration UI with a simple click on the integration configuration.
- Image Rotation: 0, 90, 180, 270 (default is 0).
- Trim automatically the images. The standard Valetudo images size 5210x5210 or more, are resized automatically (At boot the camera trims and reduces the images sizes). Default margins are 150 pixels, you can customize this value from the image options.
- Base colors are the colors for robot, charger, walls, background, zones etc.
- Rooms colors, Room 1 is actually also the Floor color (for vacuum that do not support rooms).
- Transparency level for all elements and rooms colours can be also customize.
- It is possible to display on the image the vacuum status, this option add a vacuum status text at the top left of the image. Status and room where the vacuum is will be display on the text filed.
- This integration make possible to render multiple vacuums as per each camera will be named with the vacuum name (example: vacuum.robot1 = camera.robot1_camera.. vacuum.robotx = camera.robotx_camera)
- The camera as all cameras in HA supports the ON/OFF service, it is possible to suspend and resume the camera streem as desired.
- In the attributes is possible to get on what room the vacuum is.
- No Go, Virtual Walls, Zone Clean, Active Segments and Obstacles are draw on the map when available.
- Auto Zooming the room (segment) when the vacuum is cleaning it.
- Support Actions "reload" and "reset_trims" implemented for changing the camera settings without restarting Home Assistant.
- Rand256 sensors are pre-configured from the integration, this will allow you to have all the sensors available in Home Assistant.
- Added the Actions for Rand256 / Hypfer to control the vacuums without to format the MQTT messages.
- This integration is developed and tested using a PI4 with Home Assistant OS fully updated to the last version, this allows us to confirm that the component is working properly with Home Assistant. Tested also on ProxMox and Docker Supervised "production" enviroment (fully setup home installation).
- @PiotrMachowski inspiring this integration and his amazing work.
- @billyourself for providing us the data and motivation to evolve this project.
- @Skeletorjus that using this integration gave us several ideas to improve it.
- @rohankapoorcom autor of the v1.4.0 that make really easy to set up this integration.
- @gunjambi that found a solution to re-draw the robot and also implemented the snapshots png to be enabled or disabled from the options.
- @T0ytoy for the amazing cooperation in testing our Camera that improved using the threading.
- And to all of you using this integration and reporting any issues, improvements and vacuums used with it.