Xiaomi Cloud Vacuum Map Extractor

Ildar_Gabdullin · November 16, 2021, 12:48am

Great, will try it next day! Thank you!

Ildar_Gabdullin · November 16, 2021, 12:30pm

@3_14
Piotr, is it possible to support templates for yaml config file?
I think that it would be great to switch on/off displaying rooms etc…

3_14 · November 16, 2021, 12:32pm

maybe someday

Ildar_Gabdullin · November 16, 2021, 8:39pm

Piotr, I got some questions about your script, could you clarify?
I made a small chart of the script:

1) python_script.vacuum_send_command
   send first 5 segments

if command == 'app_zoned_clean':
     if `there more than 5 segments to clean`
          2) Wait until `vacuum = CLEANING`
          3) Wait until `vacuum != CLEANING`  (waiting for completion of cleaning the first 5 segments)
          4) Pause the vacuum
          5) script.vacuum_send_command_multiple_zones (recursive call of the same script)
             send rest of the segments
     endif
endif

Questions:

What is a format of the params variable? Should it be like

[1, 2, 3, 45, 67, 8]

I see that you provided some checks & parsing & cleanup to ensure that the input data format is valid.

Regarding the python_script.vacuum_send_command:
According to the script, you are passing first 5 segments to the vacuum - does it mean that the vacuum can process max 5 segments per service call?
According to the py script definition, that params value (i.e. first 5 segments) will be converted to

['1', '2', '3', '45', '67']

before sending to the vacuum. Does it mean that a vacuum accepts this format only?

I think this line is not required for the first call:
{%- set rest = cleaned | replace(firstBatch, "") | replace("[,[", "[[") -%}
I think that the firstBatch and rest may be defined as variables. Just a speculation, I am still learning and never used variables in scripts so far…

3_14 · November 16, 2021, 11:19pm

Well, the script has been created over a year ago and some stuff has changed in HA . Right now it should be possible to make this script simpler - I think usage of python script can be avoided.

Answers:

Yes
Yes, as far as I know. You can try to check it in Xiaomi Home (my vacuum doesn’t have rooms)
Actually it should be [1, 2, 3, 45, 67]
Yes, it isn’t. I have left it there for consistency reasons
Yes, the script has been created before variables in script appeared in HA

Ildar_Gabdullin · November 17, 2021, 12:12am

Thank you very much for your answers!
Now - about my problem.

I described my approach to generate a command for cleaning segments.
The template sensor with this code

          {% set ns = namespace(COMMAND = "") -%}
          {%- set ROOM_FLAGS = expand('group.vacuum_clean_rooms') -%}

          {%- for flag in ROOM_FLAGS -%}
            {%- if flag.entity_id | regex_match("input_boolean.vacuum_clean_room_", ignorecase=False) and
                   is_state(flag.entity_id,'on') -%}
              {%- set ROOM = flag.entity_id.split("vacuum_clean_room_")[1] -%}
              {%- set ROOM_NUMBER = states('input_number.vacuum_clean_room_number_' + ROOM)|int -%}
              {%- set CLEAN_COUNT = states('input_number.vacuum_clean_room_count_' + ROOM)|int -%}
              {%- set ROOM_NUMBER_STRING = (ROOM_NUMBER|string + ",") * CLEAN_COUNT -%}
              {%- set ns.COMMAND = ns.COMMAND + ROOM_NUMBER_STRING -%}
            {%- endif -%}
          {%- endfor -%}

          {%- set ns.COMMAND = (ns.COMMAND)[:-1] -%}
          {{ ns.COMMAND }}

generates this output:

Note the “Result type: list” text.
But using this script

script:
  vacuum_clean_rooms:
    alias: 'vacuum: Clean rooms'
    sequence:
      - service: vacuum.send_command
        data:
          entity_id: vacuum.xiaomi_roborock_s50
          command: app_segment_clean
          params: "{{states('sensor.vacuum_clean_command')}}"

gives an error:
Unable to send command to the vacuum: {'code': -10000, 'message': 'data for segment is not a number'}
Tried to discuss this issue, no solution so far.
Using the code directly in script (w/o that template sensor like you proposed before) does not help…

I started learning your script to find answers, not succeeded so far.

3_14 · November 17, 2021, 1:27am

Can you try using service xiaomi_miio.vacuum_clean_segment?

service: xiaomi_miio.vacuum_clean_segment
data:
  entity_id: vacuum.xiaomi_roborock_s50
  segments: "{{states('sensor.vacuum_clean_command')}}"

Ildar_Gabdullin · November 17, 2021, 1:55am

Error message:
Failed to call service xiaomi_miio.vacuum_clean_segment. expected int for dictionary value @ data['segments']. Got None

3_14 · November 17, 2021, 2:30am

it seems like a bug in HA template engine… So probably the only way is to launch it via python script

pplucky · November 17, 2021, 9:34am

I haven’t played with that for a long time, but last time I checked, the segments were not “templatable”.

Ildar_Gabdullin · November 17, 2021, 12:19pm

There is a service input_select.set_option which accepts a list.
A correct syntax with a template is:

service: input_select.set_options
target:
  entity_id: input_select.test_input_select_templatable
data:
  options: "{{['one','two','three','four']}}"

Calling a service for vacuum with the same format

entity_id: vacuum.xiaomi_roborock_s50
command: app_segment_clean
params: "{{['2','3','3']}}"

causes same error
Unable to send command to the vacuum: {'code': -10000, 'message': 'data for segment is not a number'}
I think that the problem is in the service itself - it accepts a number, not a string.
I tried this call:

entity_id: vacuum.xiaomi_roborock_s50
command: app_segment_clean
params: "{{[2|int,3|int,3|int]}}"

it works!!!

3_14 · November 17, 2021, 12:35pm

Soooo, maybe this will work as well?

          ...
          {%- set ns.COMMAND = (ns.COMMAND)[:-1] -%}
          {{ ns.COMMAND | from_json }}

Ildar_Gabdullin · November 17, 2021, 12:38pm

Made this, gonna test it after completion of the started cleaning:

          params: >-
            {% set ns = namespace(COMMAND = "") -%}
            {%- set ROOM_FLAGS = expand('group.vacuum_clean_rooms') -%}

            {%- for flag in ROOM_FLAGS -%}
              {%- if flag.entity_id | regex_match("input_boolean.vacuum_clean_room_", ignorecase=False) and
                    is_state(flag.entity_id,'on') -%}
                {%- set ROOM = flag.entity_id.split("vacuum_clean_room_")[1] -%}
                {%- set ROOM_NUMBER = states('input_number.vacuum_clean_room_number_' + ROOM)|int -%}
                {%- set CLEAN_COUNT = states('input_number.vacuum_clean_room_count_' + ROOM)|int -%}
                {%- set ROOM_NUMBER_STRING = (ROOM_NUMBER|string +"|int" + ",") * CLEAN_COUNT -%}
                {%- set ns.COMMAND = ns.COMMAND + ROOM_NUMBER_STRING -%}
              {%- endif -%}
            {%- endfor -%}

            {%- set ns.COMMAND = (ns.COMMAND)[:-1] -%}
            [{{ ns.COMMAND }}]

Actually, I have never used from_json things, need some time for testing…

Update:
Because of unknown reasons the script above did not work - same error as before…
So I went back to the previous version with this expression:
[{{ ns.COMMAND }}]
and without this expression:
+"|int"

Code:

  vacuum_clean_rooms:
    alias: 'vacuum: Clean rooms'
    sequence:
      - service: vacuum.send_command
        data:
          entity_id: vacuum.xiaomi_roborock_s50
          command: app_segment_clean
          params: >-
            {% set ns = namespace(COMMAND = "") -%}
            {%- set ROOM_FLAGS = expand('group.vacuum_clean_rooms') -%}
            {%- for flag in ROOM_FLAGS -%}
              {%- if flag.entity_id | regex_match("input_boolean.vacuum_clean_room_", ignorecase=False) and
                    is_state(flag.entity_id,'on') -%}
                {%- set ROOM = flag.entity_id.split("vacuum_clean_room_")[1] -%}
                {%- set ROOM_NUMBER = states('input_number.vacuum_clean_room_number_' + ROOM)|int -%}
                {%- set CLEAN_COUNT = states('input_number.vacuum_clean_room_count_' + ROOM)|int -%}
                {%- set ROOM_NUMBER_STRING = (ROOM_NUMBER|string +",") * CLEAN_COUNT -%}
                {%- set ns.COMMAND = ns.COMMAND + ROOM_NUMBER_STRING -%}
              {%- endif -%}
            {%- endfor -%}
            {%- set ns.COMMAND = (ns.COMMAND)[:-1] -%}
            [{{ ns.COMMAND }}]

Probably earlier I started the script before it was actually updated in HA after correction.
So to be sure I restarted HA - and the script works!

Now everything looks OK:
expanded control panel:

expanded settings with restricted access:

c1tru55 · November 21, 2021, 10:25am

hey, I’m new in HA so sorry for probably stupid questions. questions are related to both Xiaomi Cloud Vacuum Map Extractor and Lovelace Xiaomi Vacuum Map card:

it is nowhere said how vacuum itself should be integrated in HA (to get entity for Lovelace Xiaomi Vacuum Map card). I understand, that probably it is out of scope, but for new users it can be very helpful. tried first via Vacuum integration, but entity didn’t appear. then tried via Xiaomi Miio and finally get entity. but this integration cannot be configured via config. is it correct way?
how can I clean specific rooms? example in config is based only on coordinates, not sure if it is proper way, because in MiHome I can clean specific rooms with complex shapes.
how can I get room numbers? there is said in the docs add rooms/room_numbers attribute - and what next? in tons of comments I found that I should check it in dev tools. how? what should I do to see it? https://i.imgur.com/OECBfta.png why docs is so not new-user-friendly
I have HA in russian, obviously set russian language in Lovelace Xiaomi Vacuum Map card, but bottom row still has mixed texts from english and russian. is it a bug? missing translation? misconfiguration? https://i.imgur.com/XJyWlIE.png

thanks in advance.

c1tru55 · November 29, 2021, 5:21pm

@3_14 please advice

teleksterling · November 29, 2021, 11:57pm

That is the way I have set up mine, over a year ago. As far as I know, that’s still how it’s done.

3_14 · November 30, 2021, 2:12am

Vacuum configuration depends on specific model, I am not able to cover all cases. You should use an integration that supports your model, built-in Xiaomi Miio is always a good first shot.
It’s possible to do it. Discussion: link
This screenshot shows attributes of the vacuum, room numbers are in attributes of a camera entity.
These values are entity states/attributes, which currently are not translated. Maybe I will add possibility to translate them in future versions of the card.

c1tru55 · December 5, 2021, 11:35am

@3_14 thank you, finally got what I wanted:

another question: is there any way to reset sensors/filter/main brush/side brush from the card? it is the only thing, for which I still need MiHome. I saw tap_action/hold_action/double_tap_action options in config, but better to have example.

Ildar_Gabdullin · December 5, 2021, 12:57pm

Kind of this code (russian:Choto tipa takogo):

                  - type: custom:button-card
                    template: button_card_template__simple_button_red
                    name: Сбросить наработку щетки
                    tap_action:
                      action: call-service
                      service: vacuum.send_command
                      service_data:
                        entity_id: '[[SENSOR_VACUUM]]'
                        command: reset_consumable
                        params:
                          - main_brush_work_time
                      confirmation: &ref_confirmation
                        text: |
                          Сбросить время наработки?
                          Данное действие необратимо
...
                  - type: custom:button-card
                    template: button_card_template__simple_button_red
                    name: Сбросить наработку щетки
                    tap_action:
                      action: call-service
                      service: vacuum.send_command
                      service_data:
                        entity_id: '[[SENSOR_VACUUM]]'
                        command: reset_consumable
                        params:
                          - side_brush_work_time
                      confirmation: *ref_confirmation
...
                  - type: custom:button-card
                    template: button_card_template__simple_button_red
                    name: Сбросить наработку фильтра
                    tap_action:
                      action: call-service
                      service: vacuum.send_command
                      service_data:
                        entity_id: '[[SENSOR_VACUUM]]'
                        command: reset_consumable
                        params:
                          - filter_work_time
                      confirmation: *ref_confirmation
...
                  - type: custom:button-card
                    template: button_card_template__simple_button_red
                    name: Сбросить наработку сенсоров
                    tap_action:
                      action: call-service
                      service: vacuum.send_command
                      service_data:
                        entity_id: '[[SENSOR_VACUUM]]'
                        command: reset_consumable
                        params:
                          - sensor_dirty_time
                      confirmation: *ref_confirmation

bergasha · December 6, 2021, 2:56am

This has stopped working on the latest beta, 2021.12.0b1 error below

Entity camera.xiaomi_cloud_map_extractor (<class ‘custom_components.xiaomi_cloud_map_extractor.camera.VacuumCamera’>) implements device_state_attributes. Please report it to the custom component author