Guide: How to use the Lovelace Vacuum Card

[kristofferR]

Lovelace Vacuum Map card is a nice card that enables a visual interface to select rooms/zones to clean, quite similar to the Roborock app:

140251738-7fb06e81-34b0-4bf8-b7b1-2221d0062331.mp4

Due to the Roborock integration being so new, proper support hasn't been implemented yet, but it has been requested. In the meantime some customizations are required.

Guide:

1. Install Lovelace Vacuum Map card using HACS, add the card to a dashboard and edit it like this:

2. Press Generate Rooms Config and Generate Static Config.

3. Click the blue icon next to "Zone cleanup" on the card, and select Rooms. Take note of what IDs your rooms have.

4. Click into "Show code editor" and edit the room names to what you want.

5. Remove the quotes around the id's, then the visual room selector on the card will start working too. Each room should look like this:

       - id: 18
        icon:
          name: mdi:broom
          x: number
          'y': number
        label:
          text: Kitchen

If you want you can also change the "mdi:broom" to another HA icon that fits each room better.

I still haven't figured out how to get Pin & Go and Zone Cleaning working, looking for input.

[jdejaegh]

Pin & Go

Here is how I made the Pin & Go feature work on my side.

When editing the YAML config, I modified the related entry under map_modes to look like the following. The only thing I modified from the generated config is the service_call_schema. I took inspiration from the issue you mentioned for the service call and adapted it to fit the template.

map_modes:
  - name: Cible
    icon: mdi:map-marker-plus
    run_immediately: false
    coordinates_rounding: true
    selection_type: MANUAL_POINT
    max_selections: 999
    repeats_type: NONE
    max_repeats: 1
    service_call_schema:
      service: vacuum.send_command
      service_data:
        command: app_goto_target
        params:
          - '[[point_x]]'
          - '[[point_y]]'
        entity_id: '[[entity_id]]'
    predefined_selections: []
    variables: {}

Update since v0.0.2
The service roborock.vacuum_goto is now provided and does the same as the vacuum.send_command with app_goto_target, it's just easier to remember.
The service_call_schema can be rewritten as follows

    service_call_schema:
      service: roborock.vacuum_goto
      service_data:
        x_coord: '[[point_x]]'
        y_coord: '[[point_y]]'
        entity_id: '[[entity_id]]'

After this modification, I am able to select the pin icon, click somewhere on the map and then hit the "play" icon and the vacuum goes there.

Zone Cleaning

I haven't completely figured this one out.

Update since v0.0.2
It's now possible and similar to Pin & Go, see my comment below.

Here is what a service call looks like to clean zones. I don't know yet how to make a service call schema to match this. The params is a list of lists, each list is the four coordinates for the zone followed by the number of times the zone must be cleaned. I took inspiration from marcelrv/XiaomiRobotVacuumProtocol for the service call.

service: vacuum.send_command
data:
  command: app_zoned_clean
  params:
    - - 24153
      - 27813
      - 25021
      - 28512
      - 1
target:
  entity_id: vacuum.roborock_s7

[jdejaegh]

This is more a workaround for the Zone Cleaning to avoid setting a fancy service_call_schema but it works.

The idea is to create a service using the Pyscript custom component to handle the translation of the data format. The script will take a list of lists (like [[20340, 29691, 23496, 33293], [19877, 26036, 23805, 29072]]) and a number of repetitions (say 1) and modify the lists to include the repetitions: [[20340, 29691, 23496, 33293, 1], [19877, 26036, 23805, 29072, 1]]. This seems to be the required format (works on my S7).

Here is how:

1. Install Pyscript
2. Create a script in a file called zoned_clean.py with the following contents

@service
def zoned_clean(zone=None, repeats=None, entity_id=None):
    params = [l + [repeats] for l in zone]
    vacuum.send_command(command="app_zoned_clean", params=params, entity_id=entity_id)

3. Modify the YAML code of the Lovelace card related to the Zone Cleaning as follows (only modified service_call_schema to call my newly created service pyscript.zoned_clean)

map_modes:
  - name: Nettoyage de zone
    icon: mdi:select-drag
    run_immediately: false
    coordinates_rounding: true
    selection_type: MANUAL_RECTANGLE
    max_selections: 5
    repeats_type: EXTERNAL
    max_repeats: 3
    service_call_schema:
      service: pyscript.zoned_clean
      service_data:
        zone: '[[selection]]'
        repeats: '[[repeats]]'
        entity_id: '[[entity_id]]'
    predefined_selections: []
    variables: {}

4. Define zone(s) to clean on the card and hit the play button

[jdejaegh]

Since v0.0.2 new services were introduced making it less hacky to setup zone cleaning. The service roborock.vacuum_clean_zone allows to define a service_call_schema easily.

Here is what the relevant section under map_modes looks like with this new service (I only modified the service_call_schema from the generated YAML).

map_modes:
  - name: Nettoyage de zone
    icon: mdi:select-drag
    run_immediately: false
    coordinates_rounding: true
    selection_type: MANUAL_RECTANGLE
    max_selections: 5
    repeats_type: EXTERNAL
    max_repeats: 3
    service_call_schema:
      service: roborock.vacuum_clean_zone
      service_data:
        zone: '[[selection]]'
        repeats: '[[repeats]]'
        entity_id: '[[entity_id]]'
    predefined_selections: []
    variables: {}

[the-ress]

Note for others: don't forget to copy repeats_type: EXTERNAL otherwise it won't work and you'll spend a long time troubleshooting

[randyesperben]

Hi! I'm trying to add the lovelace vaccum card, but I can't set the camera entity. I attach screenshort.
What am I doing wrong?
I have not done the integration via xiaomi.

Many thanks!

[jdejaegh]

Does the camera appear on the device's page?

Maybe try this solution from issue #105

[randyesperben]

Yh! Thank you!

[norther-pit]

I get solution from FB group, and it worked great for me:

Integrations > Roborock > CONFIGURE
Change default "1" to "2" and camera entity appears in XIAOMY Vacuum Map Card.

[workinganimal]

Thank you so much. This worked for as well.

[challs]

Cleaning individual rooms

We mostly use the individual room cleaning function with our Roborock, so I wanted to get that working with the vacuum card. I used the card according to the instructions by setting it up to send_command. This is the configuration that works for me:

map_modes:
  - name: Rooms
    icon: mdi:floor-plan
    run_immediately: false
    coordinates_rounding: true
    selection_type: ROOM
    max_selections: 999
    repeats_type: REPEAT
    max_repeats: 3
    service_call_schema:
      service: roborock.vacuum_clean_segment
      service_data:
        segments: '[[selection]]'
        entity_id: '[[entity_id]]'
    predefined_selections:
      - id: 16
        icon:
          name: phu:rooms-hallway
          x: 27925
          'y': 31975
        label:
          text: Hall
          x: 27925
          'y': 31975
          offset_y: 35
        outline:
          - - 24500
            - 30550
          - - 31350
            - 30550
          - - 31350
            - 33400
          - - 24500
            - 33400
     [..followed by more rooms..]

By having the rooms as the first section in map_modes, I found that the default selection method is rooms on the card too.

I was able to test the room behaviour in the service tool using this yaml:

service: roborock.vacuum_clean_segment
data:
  segments:
    - 24
target:
  entity_id: vacuum.vac1

and I was able to add a button to a room-card that vacuums the room by using the following configuration example:

type: custom:room-card
info_entities:
  - entity: vacuum.fifi
    icon: mdi:robot-vacuum
    show_icon: true
    tap_action:
      action: call-service
      service: roborock.vacuum_clean_segment
      service_data:
        segments:
          - 24
      target:
        entity_id: vacuum.vac1

Thanks to the developers for getting this all working for us!

[and7ey]

Is there any way to change the color of some rooms and color_scan with this approach? Where should I define the colors?

[andras-tim]

I think, instead of this kind of manual configuration, a new "Vacuum platform" would be more user friednly in the Xiaomi Cloud Map Extractor.