← Directory

Valetudo-mapper

Valetudo-mapper is a companion service for Valetudo-RE that offloads PNG map generation from the vacuum robot to a host with sufficient CPU and memory,…

  • Home Automation
  • Tools & Utilities
Valetudo-mapper is a companion service for Valetudo-RE that offloads PNG map generation from the vacuum robot to a host with sufficient CPU and memory, publishing the resulting maps over MQTT for third-party integrations such as Home Assistant.

Platform availability

Available on 1 of 9 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

16/100 Low

Maintained
0last commit 1126 days ago
Popular
3874 GitHub stars
Easy to install
201 install platform, Docker image
Light to run
No data

Based on 3 of 4 factors.

Availability: platform listings confirmed today, links checked 15 days ago

GitHub stars
74
Open issues
0
Last commit
2023-09-15
License
Apache-2.0
Activity
stale

Checked 7 days ago - source: GitHub (rand256/valetudo-mapper)

Resources & Compatibility

ARM (e.g. Raspberry Pi) is supported.

Checked 17 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Back up the robot's storage first Before installing, make compressed backups of the robot's nandb and nandk storage areas and save them to your computer. If the install goes wrong, these backups are what let you restore the robot to a working state. source
  • Keep the robot docked during install Have the vacuum plugged into its charging dock before running the firmware install. If it loses power or moves during the update, the install can be interrupted and leave the robot unable to boot. source
  • Reboot after the autostart setup After copying the autostart script and making it executable, reboot the robot once. Without this reboot, the changes may not apply and Valetudo may not start automatically next time. source
  • Create a config.json before first run Before starting the container, create a config.json file containing your MQTT broker URL, credentials, and topic settings, then map it to /app/config.json inside the container. An example configuration is provided in the repository README. source

Fetched today - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

Do I need to prepare a config file before running valetudo-mapper?

Yes, you should make sure the needed config file is already created before using the service.

How can I remove empty spaces or mirrored artifacts from the generated map?

Autocrop removes empty spaces at the edges, and its value determines how many pixels to keep at the border. You can also specify manual crop values to cut out mirrored artifacts outside the actual rooms.

Can I use Valetudo maps in Home Assistant automations?

Yes, users discuss using a Xiaomi map card with Valetudo maps to send a vacuum to a selected room.

Does Valetudo change the robot's mapping or navigation?

No, Valetudo does not change the mapping and navigation; it is about the interface.

Answers sourced from github.com, www.reddit.com, www.reddit.com

Community

Collected 16 days ago - public community threads