lovelace-xiaomi-vacuum-map-card

Lovelace Vacuum Map card

This card provides a user-friendly way to fully control map-based vacuums in Home Assistant. Supported brands include Xiaomi (Roborock/Viomi/Dreame/Roidmi/Valetudo/Valetudo RE), Neato, Wyze, Roomba, Ecovacs (and probably more).

https://user-images.githubusercontent.com/6118709/140251738-7fb06e81-34b0-4bf8-b7b1-2221d0062331.mp4

Table of contents

• Features
• Installation
  • HACS
  • Manual
• Configuration
  • Main options
  • Preset options
  • Map source options
    • Cropping options
  • Calibration source options
    • Calibration points options
  • Supported vacuum platforms
  • Icon list entry options
  • Tile list entry options
  • Condition options
  • Map modes options
    • Supported templates
    • Supported selection types
    • Service call schema options
    • Supported repeats types
    • Predefined selection options
    • Icon options
    • Label options
  • Available actions
• FAQ
• Migrating from v1.x.x
• Translations
• Special thanks
• Support

Features

Features include:

• Map-based controls:
  • Zoned cleaning (manual and saved)
  • Going to target (manual and saved)
  • Room cleaning
  • Following path
  • Custom services
• Icon controls:
  • Conditional visibility
  • Customizable service calls
• Value tiles:
  • Customizable content
  • Conditional visibility
  • Customizable service calls
• General:
  • Multiple vacuums support
  • Multiple maps (camera/image) support
  • Fully customizable styling

Installation

HACS

• Open HACS
• Go to “Frontend” section
• Click button with “+” icon
• Search for “Xiaomi Vacuum Map”
• Install repository in HACS
• Make sure you have added this card to Lovelace resources

  url: /hacsfiles/lovelace-xiaomi-vacuum-map-card/xiaomi-vacuum-map-card.js
  type: module
  

• Refresh your browser

Manual

• Download xiaomi-vacuum-map-card.js file from the latest release
• Save downloaded file somewhere in <ha config>/www/ directory, e.g. /config/www/custom_lovelace/xiaomi-vacuum-map-card.js
• Add saved file to Lovelace resources

  url: /local/custom_lovelace/xiaomi-vacuum-map-card.js
  type: module
  

• Restart HA if you had to create www directory
• Refresh your browser

Configuration

This card contains UI configuration editor, but it is limited to only basic set of features. Its full potential can be achieved by manual yaml adjustments.

:warning::warning::warning:

You can use this configuration as an example: demo config (configuration used in full_demo.mp4).

:warning::warning::warning:

Main options

Preset options

¹ If multiple presets are configured

² Not mandatory when used with a platform that support a default calibration

Map source options

¹ Exactly one of camera or image must be provided

Cropping options

Calibration source options

¹ Exactly one of camera, entity, calibration_points, identity or platform must be provided

Calibration points options

Each of calibration points must have a following structure:

vacuum: # coordinates of a point in a vacuum coordinate system
  x: 25500
  y: 25500
map: # coordinates of a point in a map coordinate system (can be read using e.g. Paint or Gimp)
  x: 466
  y: 1889

Manual calibration guide

Supported vacuum platforms

Following vacuum platforms are supported out of the box at this moment:

• Xiaomi Miio
• Roborock
• humbertogontijo/homeassistant-roborock
• Tasshack/dreame-vacuum
• rand256/ValetudoRE
• Hypfer/Valetudo
• marotoweb/viomi SE
• tykarol/ViomiVacuumV8
• KrzysztofHajdamowicz/miio2
• send_command
• al-one/Xiaomi MIoT (additional manual configuration required)
• Neato
• Roomba
• DeebotUniverse/Deebot-4-Home-Assistant
• romedtino/simple-wyze-vac
• BenjaminPaap/home-assistant-myneato
• CoderAS-ru/hass-neatsvor
• johnnyh1975/ha_roomba_plus

Create a request for a new built-in platform

Adding a new platform

Icon list entry options

Menu icon additional options

Examples:

• Menu based on the select entity

  type: "menu",
  menu_id: "water_box_mode",
  icon_id: "water_box_mode",
  entity: "select.water_box_mode"
  available_values_attribute: "options"
  icon: "mdi:water",
  icon_mapping:
      off: "mdi:water-remove"
      mild: "mdi:water-minus"
      moderate: "mdi:water"
      intense: "mdi:water-plus"
      custom: "mdi:water-sync"
  tap_action:
      action: "call-service"
      service: "select.select_option"
      service_data:
          option: "[[value]]"
          entity_id: "[[entity_id]]"
  

Tile list entry options

Condition options

¹ Exactly one of them has to be provided

Map modes options

You can override any value from built-in template by providing it in your configuration

¹ Not required if all parameters with (²) are provided

² Required if template is not provided

³ Required if template is not provided and selection_type is one of: PREDEFINED_RECTANGLE, PREDEFINED_POINT, ROOM

Supported templates

List of supported templates depends on selected vacuum_platform

Supported selection types

Following selection types are supported at this moment:

• MANUAL_RECTANGLE: Free-drawn rectangular zones on the map

  Example video

  https://user-images.githubusercontent.com/6118709/141666913-d95f082d-f5bf-4ab5-a478-ba44effe6f34.mp4

• PREDEFINED_RECTANGLE: Rectangular zones that can be selected on the map from predefined_selections

  Example video

  https://user-images.githubusercontent.com/6118709/141666920-492a000c-9a78-4c20-b4f5-9343928140c7.mp4

• MANUAL_POINT: Point selected by clicking in an arbitrary place on the map

  Example video

  https://user-images.githubusercontent.com/6118709/141666921-2f3d66da-6ffc-492a-8439-625da97651bd.mp4

• PREDEFINED_POINT: Point selected on the map from predefined_selections

  Example video

  https://user-images.githubusercontent.com/6118709/141666923-965679e9-25fb-44cd-be08-fc63e5c85ce0.mp4

• ROOM: Identifier-based selection with free-drawn outline

  Example video

  https://user-images.githubusercontent.com/6118709/141666925-34b01cde-82ff-447b-aecc-e9ced402b1ed.mp4

• MANUAL_PATH: Path selected by clicking on the map

  Example video

  https://user-images.githubusercontent.com/6118709/141666931-48d1717f-96d0-461d-84f4-788c071f3a78.mp4

Service call schema options

It is possible to use several built-in placeholders in service_data section. They will be replaced by:

• [[entity_id]]: entity_id defined in preset’s config
• [[selection]]: selection made on the map (zone, point or path)
• [[selection_size]]: number of selections made on the map
• [[selection_unwrapped]]: the same as [[selection]], but passed as string unwrapped from brackets
• [[repeats]]: selected number of repeats
• [[point_x]]: x coordinate of selected point (for MANUAL_POINT and PREDEFINED_POINT selection types)
• [[point_y]]: y coordinate of selected point (for MANUAL_POINT and PREDEFINED_POINT selection types)
• [[variables]]: a list of variables for all selections

It is possible to use any value from variables section (wrapped with double rectangular brackets):

variables:
  test_variable: 123
service_call_schema:
  service: fake.service
  service_data:
    var: "[[test_variable]]"

It is possible to use following modifiers in service_data section:

• |[[jsonify]]: if value ends with this modifier it will be decoded as a JSON and attached to service call in unwrapped form
• |[[jsonify_jinja]]: behaves in the same way as |[[jsonify]], but is executed after jinja templating

Supported repeats types

Following repeats types are supported at this moment:

• NONE: No repeats
• INTERNAL: Repeats number included in coordinates array ([25500, 25000, 26500, 26500, 2])
• EXTERNAL: Repeats number used as a separate attribute in service_call_schema
• REPEAT: Repeats selection (repeats: 2, selection: [5,6] => [5,6,5,6])

Predefined selection options

Format of data depends on selected selection_type:

• PREDEFINED_RECTANGLE

  Key	Type	Required	Default	Description
  zones	list	yes	-	List of lists containing zone’s coordinates in [x,y,width,height] format (e.g. [[25500, 25000, 26500, 26500]])
  icon	object	no	-	Icon definition
  label	object	no	-	Label definition
  variables	object	no	-	Variables that should be passed to service_call_schema
  default_state	selected/unselected	no	unselected	Default state of selection
  state_entity	entity id	no	-	Entity that should be used to store the state of selection

  See this page to check how to easily retrieve zone coordinates.

• PREDEFINED_POINT

  Key	Type	Required	Default	Description
  position	list	yes	-	Point’s coordinates in [x,y] format (e.g. [25500, 25000])
  icon	object	no	-	Icon definition
  label	object	no	-	Label definition
  variables	object	no	-	Variables that should be passed to service_call_schema
  default_state	selected/unselected	no	unselected	Default state of selection
  state_entity	entity id	no	-	Entity that should be used to store the state of selection

  See this page to check how to easily retrieve point coordinates.

• ROOM

See this page to check how to easily create outline.

Icon options

Label options

Action handling

To enable handling actions you have to configure action_handler_id in Main options. This card handles following actions:

• Starts cleaning

    tap_action:
      action: fire-dom-event
      xiaomi_vacuum_map_card:
        action_handler_id: xiaomi_vacuum_map_card_id_1
        action: cleaning.start
  

• Set a value of internal variable

    tap_action:
      action: fire-dom-event
      xiaomi_vacuum_map_card:
        action_handler_id: xiaomi_vacuum_map_card_id_1
        action: internal_variable.set
        data:
          variable: variable_1
          value: "some value"
  

• Selects next map mode

    tap_action:
      action: fire-dom-event
      xiaomi_vacuum_map_card:
        action_handler_id: xiaomi_vacuum_map_card_id_1
        action: map_mode.next
  

• Selects previous map mode

    tap_action:
      action: fire-dom-event
      xiaomi_vacuum_map_card:
        action_handler_id: xiaomi_vacuum_map_card_id_1
        action: map_mode.previous
  

• Selects a specific map mode

    tap_action:
      action: fire-dom-event
      xiaomi_vacuum_map_card:
        action_handler_id: xiaomi_vacuum_map_card_id_1
        action: map_mode.set
        data:
          index: 2 
  

• Decrements a number of repeats

    tap_action:
      action: fire-dom-event
      xiaomi_vacuum_map_card:
        action_handler_id: xiaomi_vacuum_map_card_id_1
        action: repeats.decrement
  

• Increments a number of repeats

    tap_action:
      action: fire-dom-event
      xiaomi_vacuum_map_card:
        action_handler_id: xiaomi_vacuum_map_card_id_1
        action: repeats.increment
  

• Set a number of repeats

    tap_action:
      action: fire-dom-event
      xiaomi_vacuum_map_card:
        action_handler_id: xiaomi_vacuum_map_card_id_1
        action: repeats.set
        data:
          value: 2
  

• Clears current selection

    tap_action:
      action: fire-dom-event
      xiaomi_vacuum_map_card:
        action_handler_id: xiaomi_vacuum_map_card_id_1
        action: selection.clear
  

FAQ

• Make sure to check out FAQ section in Discussions, it contains a lot of useful information

• Does this card require rooted device?

  No, it only utilizes features of Home Assistant.

• How to create a map?

  The easiest way is to use Xiaomi Cloud Map Extractor, but you can use any image (e.g., a screenshot from Mi Home/FloleVac).

• Can I use image that has a perspective distortion?

  Yes, you just have to provide 4 calibration points.

Migrating from v1.x.x

type: custom:xiaomi-vacuum-map-card
entity: vacuum.xiaomi_vacuum
map_image: '/local/custom_lovelace/xiaomi_vacuum_map_card/map.png'
calibration_points:
  - vacuum:
      x: 25500
      y: 25500
    map:
      x: 466
      y: 1889
  - vacuum:
      x: 26500
      y: 26500
    map:
      x: 730
      y: 1625
  - vacuum:
      x: 25500
      y: 26500
    map:
      x: 466
      y: 1625
zones:
  - [[25500, 25500, 26500, 26500]]
  - [[24245, 25190, 27495, 27940], [27492, 26789, 28942, 27889]]

type: custom:xiaomi-vacuum-map-card
entity: vacuum.xiaomi_vacuum
map_source:
  image: '/local/custom_lovelace/xiaomi_vacuum_map_card/map.png'
calibration_source:
  calibration_points:
    - vacuum:
        x: 25500
        y: 25500
      map:
        x: 466
        y: 1889
    - vacuum:
        x: 26500
        y: 26500
      map:
        x: 730
        y: 1625
    - vacuum:
        x: 25500
        y: 26500
      map:
        x: 466
        y: 1625
map_modes:
  - template: vacuum_clean_zone
  - template: vacuum_goto
  - template: vacuum_clean_zone_predefined
    predefined_selections:
      - zones: [[25500, 25500, 26500, 26500]]
      - zones: [[24245, 25190, 27495, 27940], [27492, 26789, 28942, 27889]]

type: custom:xiaomi-vacuum-map-card
entity: vacuum.xiaomi_vacuum
map_camera: camera.xiaomi_cloud_map_extractor
camera_calibration: true
zones:
  - [[25500, 25500, 26500, 26500]]
  - [[24245, 25190, 27495, 27940], [27492, 26789, 28942, 27889]]

type: custom:xiaomi-vacuum-map-card
entity: vacuum.xiaomi_vacuum
map_source:
  camera: camera.xiaomi_cloud_map_extractor
calibration_source:
  camera: true
map_modes:
  - template: vacuum_clean_zone
  - template: vacuum_goto
  - template: vacuum_clean_zone_predefined
    predefined_selections:
      - zones: [[25500, 25500, 26500, 26500]]
      - zones: [[24245, 25190, 27495, 27940], [27492, 26789, 28942, 27889]]

Translations

Currently, this card contains translations for following languages:

• bg - Bulgarian (Български)
• ca - Catalan (Català)
• cs - Czech (Čeština)
• da - Danish (Dansk)
• de - German (Deutsch)
• el - Greek (Ελληνικά)
• en - English
• es - Spanish (Español)
• fi - Finnish (Suomi)
• fr - French (Français)
• he - Hebrew (עברית)
• hu - Hungarian (Magyar)
• is - Icelandic (Íslenska)
• it - Italian (Italiano)
• lv - Latvian (Latviešu)
• nb-NO - Norwegian Bokmål (Norsk bokmål)
• nl - Dutch (Nederlands)
• pl - Polish (Polski)
• pt - Portuguese (Português)
• pt-BR - Brazilian Portuguese (Português Brasileiro)
• ro - Romanian (Română)
• ru - Russian (Русский)
• sk - Slovak (Slovenčina)
• sv - Swedish (Svenska)
• tr - Turkish (Türkçe)
• uk - Ukrainian (Українська)
• zh - Chinese (中文)
• zh-Hant - Traditional Chinese (正體中文)

Adding a new language

Special thanks

I’d like to give special thanks to people who helped me with card’s design and development:

• Bartosz Orczyk
• Filip Schramm
• Kamil Dryzek
• Marek Trochimiak

Support

If you want to support my work with a donation you can use one of the following platforms:

Platform	Payment methods	Link	Comment
Ko-fi	PayPal Credit card		No fees Single or monthly payment
buycoffee.to	BLIK Bank transfer
PayPal	PayPal		No fees
Revolut	Revolut Credit Card		No fees

Powered by