Components Home Assistant "Vacuum" (vacuum cleaner)

3 minutes of reading
Proconductor: Home Assistant Community
Availability: included in thepersonale HUB Home Assistant
Category: software
Type: components Home Assistant
Implementation difficulties: low

The "Vacuum" component di Home Assistant allows to define one or more configurations entity times at control and monitoring di home cleaning robot.

Integrating a robot vacuum cleaner into personal domotics has the great advantage to be able to automate the behavior: trivially, it enables the convenience of forgetting (from the robot) and ensuring that it automatically goes into action when you leave the house (just to give an example).

To enable this component it is sufficient to indicate a new block in configuration"vacuum", Like the following:

#Esempio di integrazione
vacuum:
  platform: xiaomi_miio
  name: Living room
  host: 192.168.1.2

Which gives rise to an entity similar to the following:

Home Assistant - Vacuum

The platforms connected to this component they are different, over fifty: they are listed at the component page (right column) at the site of Home Assistant.

Component services

The available services associated with this component are:

Nb Not all the aforementioned services - illustrated in detail below - are available for all platforms connected to the component.

A child platform of the present component and used for some projets of inDomus is:

vacuum.turn_on

Start the procleaning process. For Xiaomi Vacuum and Neato platforms use in its place vacuum.start.

AttributeOptionalDescription
entity_idYupString or list of strings indicated to the service to which entity (of the "vacuum" type) the service is oriented. If omitted, it is oriented towards all the "vacuum" entities present in the configuration.

Example of automation:

automation:
  trigger:
    platform: time
    at: "07:15:00"
  action:
    - service: vacuum.turn_on
      data:
        entity_id: climate.mio_robot

vacuum.turn_off

Stop the procleaning process. For Xiaomi Vacuum and Neato platforms use in its place vacuum.stop.

AttributeOptionalDescription
entity_idYupString or list of strings indicated to the service to which entity (of the "vacuum" type) the service is oriented. If omitted, it is oriented towards all the "vacuum" entities present in the configuration.

Example of automation:

automation:
  trigger:
    platform: time
    at: "07:15:00"
  action:
    - service: vacuum.turn_off
      data:
        entity_id: climate.mio_robot

vacuum.start_pause

Start / stop / resume procleaning process.

AttributeOptionalDescription
entity_idYupString or list of strings indicated to the service to which entity (of the "vacuum" type) the service is oriented. If omitted, it is oriented towards all the "vacuum" entities present in the configuration.

vacuum.start

Start the procleaning process.

AttributeOptionalDescription
entity_idYupString or list of strings indicated to the service to which entity (of the "vacuum" type) the service is oriented. If omitted, it is oriented towards all the "vacuum" entities present in the configuration.

vacuum.pause

Stops (pausing it) on procleaning process.

AttributeOptionalDescription
entity_idYupString or list of strings indicated to the service to which entity (of the "vacuum" type) the service is oriented. If omitted, it is oriented towards all the "vacuum" entities present in the configuration.

vacuum.stop

Stop the procleaning process.

AttributeOptionalDescription
entity_idYupString or list of strings indicated to the service to which entity (of the "vacuum" type) the service is oriented. If omitted, it is oriented towards all the "vacuum" entities present in the configuration.

vacuum.return_to_base

It forces the robot to return to the charging base.

AttributeOptionalDescription
entity_idYupString or list of strings indicated to the service to which entity (of the "vacuum" type) the service is oriented. If omitted, it is oriented towards all the "vacuum" entities present in the configuration.

vacuum.locate

Locate the robot.

AttributeOptionalDescription
entity_idYupString or list of strings indicated to the service to which entity (of the "vacuum" type) the service is oriented. If omitted, it is oriented towards all the "vacuum" entities present in the configuration.

vacuum.clean_spot

Start the procleaning process on a specific preset point.

AttributeOptionalDescription
entity_idYupString or list of strings indicated to the service to which entity (of the "vacuum" type) the service is oriented. If omitted, it is oriented towards all the "vacuum" entities present in the configuration.

vacuum.set_fan_speed

Start / stop / resume procleaning process.

AttributeOptionalDescription
entity_idYupString or list of strings indicated to the service to which entity (of the "vacuum" type) the service is oriented. If omitted, it is oriented towards all the "vacuum" entities present in the configuration.
fan_speedNo.It allows to adjust the suction speed, obviously if the integration platform supports it. It is set in percentage (0-100%) or by string (eg "medium").

vacuum.send_command

Send specific commands for the viewing platform.

AttributeOptionalDescription
entity_idYupString or list of strings indicated to the service to which entity (of the "vacuum" type) the service is oriented. If omitted, it is oriented towards all the "vacuum" entities present in the configuration.
commandNo.Command to execute.
paramsYupAny parameters to be sent together with the command.


Home Assistant Official LogoATTENZIONE: remember that there is on our FORUM community an ad hoc section dedicated to Home Assistant, for any doubt, question, information on the specific merit of these components.


Please comment below