Feature request: Support of Xiaomi Miot vacuum platform

[fewdji]

Description

Please add support of al-one/hass-xiaomi-miot platform.

Solution

Example of calling service for zone cleaning:

vacuum_carpet:
  sequence:
    - service: xiaomi_miot.call_action
      data:
        entity_id: vacuum.dreame_d9
        siid: 4
        aiid: 1
        params:
          - piid: 1
            value: 19
          - piid: 10
            value: '{"areas":[[-1300,-2150,-20,-390,3,1,1]]}'
        force_params: true

...and room:

vacuum_room:
  sequence:
    - service: xiaomi_miot.call_action
      data:
        entity_id: vacuum.dreame_d9
        siid: 4
        aiid: 1
        params:
          - piid: 1
            value: 18
          - piid: 10
            value: '{"selects":[[4,1,3,3,1]]}'
        force_params: true

Alternatives

No response

Context

No response

[PiotrMachowski]

@fewdji can you provide a more detailed description for these services? (including stuff passed in params)

[fewdji]

siid and aiid are ids of actions.
piid - id of property.

{"areas":[[-1300,-2150,-20,-390,3,1,1]]}
First four - coordinates, number of repetitions, power level, water level

{"selects":[[4,1,3,3,1]]}
Room id, number of repetitions, power level, water level, ???

[PiotrMachowski]

I'm not sure if I understand everything correctly, can describe lines with ????

vacuum_carpet:
  sequence:
    - service: xiaomi_miot.call_action
      data:
        entity_id: vacuum.dreame_d9
        siid: 4         # vacuum-extend
        aiid: 1         # start-clean
        params:
          - piid: 1     # ??? (is it work-mode? if so, in documentation it is marked as readonly)
            value: 19   # ??? 
          - piid: 10    # clean-extend-data
            value: '{"areas":[[-1300,-2150,-20,-390,3,1,1]]}'
        force_params: true

vacuum_room:
  sequence:
    - service: xiaomi_miot.call_action
      data:
        entity_id: vacuum.dreame_d9
        siid: 4         # vacuum-extend
        aiid: 1         # start-clean
        params:
          - piid: 1     # ??? (is it work-mode? if so, in documentation it is marked as readonly)
            value: 18   # ??? 
          - piid: 10    # clean-extend-data
            value: '{"selects":[[4,1,3,3,1]]}'
        force_params: true

It seems that every device has its own specific values for siid/aiid/piid + own formats for values, am I right?

[fewdji]

        params:
          - piid: 1     # work mode
            value: 19   # cleaning by room

        params:
          - piid: 1     # work mode
            value: 18   # cleaning by zones

You're right every model has own values for siid/aiid/piid.
Maybe the best way is to implement 'Custom' platform which allows to call custom services/scripts with params. Something like this:

service: xiaomi_miot.call_action
    data:
      entity_id: vacuum.dreame_d9
      siid: 4
      aiid: 1
      params:
        - piid: 1
          value: 19
        - piid: 10
          value: '{"areas":[[%coordinates%,%repeats%,1,1]]}' # just like example
      force_params: true

[PiotrMachowski]

Ok, I don't really want to add a separate platform for each vacuum from this integration.

Custom platform already exists: you don't provide vacuum_platform and provide service_call_schema for every entry in map_mode list, just like here: example.

The problem is that currently it is not possible to substitute a part of a value, just whole value, so it can't be used to describe xiaomi_miot.call_action service. I will try to add it 👍

[fewdji]

Agree with the first sentence.
Adding part of a value would be great!
Thank you!

[PiotrMachowski]

Template processor has been improved in v2.0.9. Now it is possible to use xiaomi_miot.call_action service:

• Vacuum zone

  - template: vacuum_clean_zone
    max_selections: 1
    repeats_type: EXTERNAL
    max_repeats: 5
    service_call_schema:
      service: xiaomi_miot.call_action
      service_data:
        entity_id: '[[entity_id]]'
        siid: 4
        aiid: 1
        params:
          - piid: 1
            value: 19
          - piid: 10
            value: '{"areas":[[[[selection_unwrapped]],[[repeats]],1,1]]}'
        force_params: true

• Vacuum room

  - template: vacuum_clean_segment
    max_selections: 1
    repeats_type: EXTERNAL
    max_repeats: 5
    service_call_schema:
      service: xiaomi_miot.call_action
      service_data:
        entity_id: '[[entity_id]]'
        siid: 4
        aiid: 1
        params:
          - piid: 1
            value: 18
          - piid: 10
            value: '{"selects":[[[[selection_unwrapped]],[[repeats]],3,3,1]]}'
        force_params: true
    predefined_selections:
      ...

[ffesius]

Hello. Can't get the roidmi eve vacuum cleaner to work properly. It doesn't have siid vacuum-extend. https://home.miot-spec.com/spec/roidmi.vacuum.v60 I have already tried the commands, but I cannot start cleaning the zone.

[muehlt]

siid and aiid are ids of actions. piid - id of property.

{"areas":[[-1300,-2150,-20,-390,3,1,1]]} First four - coordinates, number of repetitions, power level, water level

{"selects":[[4,1,3,3,1]]} Room id, number of repetitions, power level, water level, ???

How did you find out about the exact values needed for clean-extend-data and the work mode? I am currently working with a Dreame W10 (dreame.vacuum.p2027) and our devices seem to have a very similar set of siids, aiids and piids but I cannot get it to work with the above configuration. I also tried it with the start-room-sweep action that is not present for your robot but always get the same error code (-704220025) that indicates a wrong parameter.
Thanks!

Edit: I checked again - if i provide both

params:
    - piid: 1
      value: 19
    - piid: 10
      value: '{"selects":[[1,1,2,2,1]]}'

i get miot_action_error: -704220025 The number of action parameters does not match
and if i only provide

params:
    - piid: 10
      value: '{"selects":[[1,1,2,2,1]]}'

i get miot_action_error: -704220035 Action parameter error