Draws the map from a Xiaomi vacuum cleaner, that is rooted and flashed with Valetudo, in a Home Assistant Lovelace card.
Currently, there are 2 big Valetudo projects:
The original Valetudo, found on https://github.com/Hypfer/Valetudo. For this one, both the MQTT and REST methods are supported. No further tools are necessary.
A popular fork, found on https://github.com/rand256/valetudo. If you want to use this repository with Valetudo RE, you will have to set up valetudo-mapper and set publishMapData to true in that /app/config.json. You will have to use the MQTT configuration for this repository.
It is highly recommended to use HACS for managing custom extensions of Home Assistant. It automatically manages the registration of additional resources required by custom cards and makes it easy to keep them up-to-date.
To install HACS follow their installation instructions. There is no need to manually add this repository to HACS, just wait for the Valetudo Map Card to appear in the Frontend Page of the HACS interface in your Home Assistant instance.
When using HACS there is no need to manually make Home Assistant aware of custom javascript resources of this custom card. If you do need to check this manually, it is visible in the Configuration -> Lovelace Dashboards -> Resources tab.
On older versions you may need to add this to the lovelace configuration yaml manually.
lovelace.yaml: Add custom Lovelace configuration in Home Assistant to enable valetudo-map-card JavaScript. Go to your HA overview, then right top "Configure UI", then right top again on the 3 dots and "Raw config editor".
resources:
- type: js
url: /community_plugin/lovelace-valetudo-map-card/valetudo-map-card.jsYou will need to follow either the instructions for MQTT or for REST. Following the MQTT instructions is strongly recommended.
configuration.yaml: Valetudo officially supports MQTT, with the preferred example configuration as follows. You will need to have MQTT configured in Home Assistant and Valetudo.
Unfortunately Home Assistant does not support authentication via MQTT. See below for a deprecated alternative example configuration using Valetudo's REST API (unsupported) if you prefer not to use MQTT or require authentication.
sensor:
- platform: mqtt
state_topic: "valetudo/rockrobo/state"
json_attributes_topic: "valetudo/rockrobo/map_data"
name: xiaomi_map
value_template: 'OK'Note: If you are using Valetudo RE with valetudo-mapper, use valetudo/rockrobo/map_data_parsed as json_attributes_topic instead.
Deprecated alternative configuration.yaml, using authentication via REST (unsupported):
sensor:
- platform: rest
resource: http://ip_of_your_vacuum/api/map/latest
name: xiaomi_map
json_attributes:
- image
- path
- charger
- robot
- virtual_walls
- no_go_areas
value_template: 'OK'
scan_interval: 5
authentication: basic
username: !secret xiaomi_map_username
password: !secret xiaomi_map_passwordauthentication, username and password configuration variables are required if using Valetudo Password Authentication (undocumented). Otherwise, omit.
Even when installing via HACS, the new card will not appear automatically in the list of card previews when hitting the "+" button on the UI. Instead, choose the "Manual" option and provide the following yaml content:
type: 'custom:valetudo-map-card'
entity: sensor.xiaomi_map
rotate: 0
crop:
top: 0
bottom: 0
left: 0
right: 0
min_height: 0Be sure to use the same entity name that you used for the sensor above.
It's also highly recommended to exclude the sensor from the recorder component in configuration.yaml to keep the database small:
recorder:
exclude:
entities:
- sensor.xiaomi_map| Name | Type | Default | Description |
|---|---|---|---|
| type | string | Required | custom:valetudo-map-card |
| title | string | Vacuum | Title to show in the card header |
| entity | string | Sensor to get state from | |
| vacuum_entity | string | Vacuum to show buttons to control for | |
| background_color | string | Background color of the card | |
| floor_color | string | '--valetudo-map-floor-color', '--secondary-background-color' | Floor color |
| floor_opacity | number | 1 | Floor opacity |
| wall_color | string | '--valetudo-map-wall-color', '--accent-color' | Wall |
| wall_opacity | number | 1 | Wall opacity |
| currently_cleaned_zone_color | string | '--valetudo-currently_cleaned_zone_color', '--secondary-text-color' | Color of zones selected for cleanup |
| currently_cleaned_zone_opacity | number | 0.5 | Opacity of the currently cleaned zones |
| no_go_area_color | string | '--valetudo-no-go-area-color', '--accent-color' | No go area color |
| no_go_area_opacity | number | 0.5 | Opacity of the no go areas |
| virtual_wall_color | string | '--valetudo-virtual-wall-color', '--accent-color' | Virtual wall color |
| virtual_wall_opacity | number | 1 | Virtual wall opacity |
| virtual_wall_width | number | 1 | Virtual wall line width |
| path_color | string | '--valetudo-map-path-color', '--primary-text-color' | Path color |
| path_opacity | number | 1 | Path opacity |
| path_width | number | 1 | Path line width |
| segment_colors | array | '#19A1A1', '#7AC037', '#DF5618', '#F7C841' | Segment colors |
| segment_opacity | number | 0.75 | Segment opacity |
| show_floor | boolean | true | Draw the floor on the map |
| show_dock | boolean | true | Draw the charging dock on the map |
| show_vacuum | boolean | true | Draw the vacuum on the map |
| show_walls | boolean | true | Draw walls on the map |
| show_currently_cleaned_zones | boolean | true | Show zones selected for zoned cleanup on the map |
| show_no_go_areas | boolean | true | Draw no go areas on the map |
| show_virtual_walls | boolean | true | Draw virtual walls on the map |
| show_path | boolean | true | Draw the path the vacuum took |
| show_no_go_border | boolean | true | Draw a border around no go areas |
| show_predicted_path | boolean | true | Draw the predicted path for the vacuum |
| show_goto_target | boolean | true | Draw the go to target |
| show_segments | boolean | true | Draw the floor segments on the map |
| show_status | boolean | true | Show the status of vacuum_entity |
| show_battery_level | boolean | true | Show the battery level of vacuum_entity |
| show_start_button | boolean | true | Show the start button for vacuum_entity |
| show_pause_button | boolean | true | Show the pause button for vacuum_entity |
| show_stop_button | boolean | true | Show the stop button for vacuum_entity |
| show_home_button | boolean | true | Show the home button for vacuum_entity |
| goto_target_icon | string | mdi:pin | The icon to use for the go to target |
| goto_target_color | string | 'blue' | The color to use for the go to target icon |
| dock_icon | string | mdi:flash | The icon to use for the charging dock |
| dock_color | string | 'green' | The color to use for the charging dock icon |
| vacuum_icon | string | mdi:robot-vacuum | The icon to use for the vacuum |
| vacuum_color | string | '--primary-text-color' | The color to use for the vacuum icon |
| map_scale | number | 1 | Scale the map by this value |
| icon_scale | number | 1 | Scale the icons (vacuum & dock) by this value |
| rotate | number | 0 | Value to rotate the map by (default is in deg, but a value like 2rad is valid too) |
| crop | Object | {top: 0, bottom: 0, left: 0, right: 0} | Crop the map |
| min_height | string | 0 | The minimum height of the card the map is displayed in, regardless of the map's size itself. Suffix with 'w' if you want it to be times the width (ex: 0.5625w is equivalent to a picture card's 16x9 aspect_ratio) |
Colors can be any valid CSS value in the card config, like name (red), hex code (#FF0000), rgb(255,255,255), rgba(255,255,255,0.8)...
When combining this card with Home Assistant's picture-elements, you could use this to show your vacuum's position on top of your house. Make sure to set both show_floor: false and background_color: transparent in this card:
type: picture-elements
image: https://online.visual-paradigm.com/repository/images/e5728e49-09ce-4c95-b83c-482deee24386.png
elements:
- type: 'custom:valetudo-map-card'
entity: sensor.xiaomi_map
show_floor: false
background_color: transparent
Then use map_scale and crop to make it fit.
Lovelace Valetudo Map Card is licensed under the MIT license. It includes some code from the Valetudo project, which is available under the Apache 2 license. This third-party code is clearly marked as such.