2024.11.0
Home ▸ Integrations ▸

Template vacuum

The template platform creates vacuums that combine integrations and provides the ability to run scripts or invoke actions for each of the start, pause, stop, return_to_base, clean_spot, locate and set_fan_speed commands of a vacuum.

To enable Template Vacuums in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
vacuum:
  - platform: template
    vacuums:
      living_room_vacuum:
        start:
          action: script.vacuum_start

Configuration Variables

Looking for your configuration file?
vacuums map Required

List of your vacuums.

friendly_name string (Optional)

Name to use in the frontend.

unique_id string (Optional)

An ID that uniquely identifies this vacuum. Set this to a unique value to allow customization through the UI.

value_template template (Optional)

Defines a template to get the state of the vacuum. Valid value: docked/cleaning/idle/paused/returning/error

battery_level_template template (Optional)

Defines a template to get the battery level of the vacuum. Legal values are numbers between 0 and 100.

fan_speed_template template (Optional)

Defines a template to get the fan speed of the vacuum.

attribute_templates map (Optional)

Defines templates for attributes of the sensor.

attribute: template template Required

The attribute and corresponding template.

availability_template template (Optional, default: true)

Defines a template to get the available state of the entity. If the template either fails to render or returns True, "1", "true", "yes", "on", "enable", or a non-zero number, the entity will be available. If the template returns any other value, the entity will be unavailable. If not configured, the entity will always be available. Note that the string comparison not case sensitive; "TrUe" and "yEs" are allowed.

start action Required

Defines an action to run when the vacuum is started.

pause action (Optional)

Defines an action to run when the vacuum is paused.

stop action (Optional)

Defines an action to run when the vacuum is stopped.

return_to_base action (Optional)

Defines an action to run when the vacuum is given a return to base command.

clean_spot action (Optional)

Defines an action to run when the vacuum is given a clean spot command.

locate action (Optional)

Defines an action to run when the vacuum is given a locate command.

set_fan_speed action (Optional)

Defines an action to run when the vacuum is given a command to set the fan speed.

fan_speeds string | list (Optional)

List of fan speeds supported by the vacuum.

Template and action variables

State-based template entities have the special template variable this available in their templates and actions. The this variable aids self-referencing of an entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more]’s state and attribute in templates and actions.

Examples

Control vacuum with Harmony Hub

This example shows how you can use a Template Vacuum to control an IR vacuum cleaner using the Harmony Hub Remote integration.

vacuum:
  - platform: template
    vacuums:
      living_room_vacuum:
        start:
          - action: remote.send_command
            target:
              entity_id: remote.harmony_hub
            data:
              command: Clean
              device: 52840686
        return_to_base:
          - action: remote.send_command
            target:
              entity_id: remote.harmony_hub
            data:
              command: Home
              device: 52840686
        clean_spot:
          - action: remote.send_command
            target:
              entity_id: remote.harmony_hub
            data:
              command: SpotCleaning
              device: 52840686

Vacuum with state

This example shows how to use templates to specify the state of the vacuum.

vacuum:
  - platform: template
    vacuums:
      living_room_vacuum:
        value_template: "{{ states('sensor.vacuum_state') }}"
        battery_level_template: "{{ states('sensor.vacuum_battery_level')|int }}"
        fan_speed_template: "{{ states('sensor.vacuum_fan_speed') }}"
        start:
            action: script.vacuum_start
        pause:
            action: script.vacuum_pause
        stop:
            action: script.vacuum_stop
        return_to_base:
            action: script.vacuum_return_to_base
        clean_spot:
            action: script.vacuum_clean_spot
        locate:
            action: script.vacuum_locate_vacuum
        set_fan_speed:
            action: script.vacuum_set_fan_speed
            data:
              speed: "{{ fan_speed }}"
        fan_speeds:
            - Low
            - Medium
            - High

Add custom attributes

This example shows how to add custom attributes.

vacuum:
  - platform: template
    vacuums:
      living_room_vacuum:
        value_template: "{{ states('sensor.vacuum_state') }}"
        battery_level_template: "{{ states('sensor.vacuum_battery_level')|int }}"
        fan_speed_template: "{{ states('sensor.vacuum_fan_speed') }}"
        attribute_templates:
          status: >-
            {% if (states('sensor.robot_vacuum_robot_cleaner_movement') == "after" and states('sensor.robot_vacuum_robot_cleaner_cleaning_mode') == "stop")  %}
              Charging to Resume
            {% elif states('sensor.robot_vacuum_robot_cleaner_cleaning_mode') == "auto" %}
              Cleaning
            {% else %}
              Charging
            {% endif %}

Related topics