2026.5.1
Home ▸ Integrations

Vacuum

The Vacuum integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] enables the ability to control home cleaning robots within Home Assistant.

Note

Building block integration

This vacuum is a building block integration that cannot be added to your Home Assistant directly but is used and provided by other integrations.

A building block integration differs from the typical integration that connects to a device or service. Instead, other integrations that do integrate a device or service into Home Assistant use this vacuum building block to provide entities, services, and other functionality that you can use in your automations or dashboards.

If one of your integrations features this building block, this page documents the functionality the vacuum building block offers.

The state of a vacuum entity

A vacuum 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] can have the following states:

  • Cleaning: The vacuum is currently cleaning.
  • Docked: The vacuum is currently docked. It is assumed that docked can also mean charging.
  • Error: The vacuum encountered an error while cleaning.
  • Idle: The vacuum is not paused, not docked, and does not have any errors.
  • Paused: The vacuum was cleaning but was paused without returning to the dock.
  • Returning: The vacuum is done cleaning and is currently returning to the dock, but not yet docked.
  • Unavailable: The entity is currently unavailable.
  • Unknown: The state is not yet known.

Creating an automation to send the vacuum to clean specific areas

When your vacuum supports area cleaning, you can create an automation in Home Assistant to send your vacuum to clean specific areas. For example, you can set up an automation to have the vacuum clean the living room every day at 2 PM.

Creating such an automation involves two steps:

  1. Mapping your vacuum areas to Home Assistant areas. This is a one-time setup step to link the areas defined in your vacuum’s app to the areas defined in Home Assistant.
  2. Sending your vacuum to clean specific areas. This is where you create the automation that tells your vacuum to clean specific areas based on certain triggers.

Mapping your vacuum areas to Home Assistant areas

Before you can send your vacuum to clean specific areas, you need to map the areas of your vacuum to the areas in Home Assistant.

  1. Go to Settings > Devices & services > Entities.
  2. Select your vacuum entity.
  3. In the entity settings, select the cogwheel .
  4. Select Map vacuum segments to areas.
    • Result: In the dialog, you should see the vacuum areas listed on the left and the Home Assistant areas on the right.
    • If you do not see the Map vacuum segments to areas option, your vacuum does not support area cleaning. You cannot use the vacuum.clean_area action with this vacuum.
    • Troubleshooting: If there are no areas listed on the left, make sure the areas are properly set up in the vacuum’s app. You might need to save or confirm them again in the app.
  5. In the Map vacuum segments to areas dialog, for each area reported by your vacuum, select the corresponding Home Assistant area.
  6. Select Save.

Sending your vacuum to clean specific areas

Once you have the areas mapped, you can send your vacuum to clean specific areas using the vacuum.clean_area action.

  1. Go to Settings > Automations & scenes.
  2. Select Create automation.
  3. Set up your trigger. For example, you can use a time trigger to have the vacuum clean every day at 2 PM.
  4. In the Then do section, select Add action, and from the list, select the Vacuum: Clean area with vacuum cleaner action.
  5. Under Targets, select your vacuum entity.
  6. Under Areas, select the area to clean. You can select multiple areas.
  7. Give your automation a name and select Save.
  8. Test your automation by selecting Run actions. Your vacuum should start cleaning the specified areas.

List of triggers

The Vacuum integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides the following triggers. Each link below opens a dedicated page with examples, fields, and a step-by-step UI walkthrough.

For an overview of every trigger across all integrations, see the triggers reference.

List of conditions

The Vacuum integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides the following conditions. Each link below opens a dedicated page with examples, fields, and a step-by-step UI walkthrough.

For an overview of every condition across all integrations, see the conditions reference.

List of actions

The Vacuum integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] provides the following actions. Each link below opens a dedicated page with examples, parameters, and a step-by-step UI walkthrough.

  • Clean area (vacuum.clean_area) Cleans specific mapped areas using vacuum segments.

  • Clean spot (vacuum.clean_spot) Performs a spot cleaning at the vacuum’s location.

  • Locate vacuum (vacuum.locate) Plays a sound or flashes lights to help you find the vacuum.

  • Pause cleaning (vacuum.pause) Pauses the current cleaning task on a vacuum.

  • Return to base (vacuum.return_to_base) Sends the vacuum to the charging dock.

  • Send command (vacuum.send_command) Send a platform-specific command or advanced function.

  • Set fan speed (vacuum.set_fan_speed) Sets the fan/power level for cleaning.

  • Start cleaning (vacuum.start) Starts or resumes a cleaning task on a vacuum.

  • Start or pause cleaning (vacuum.start_pause) Starts, pauses, or resumes a vacuum cleaner’s cleaning task.

  • Stop vacuum (vacuum.stop) Stops the current activity of a vacuum.

  • Toggle vacuum power (vacuum.toggle) Toggles a vacuum cleaner on or off.

  • Turn off vacuum (vacuum.turn_off) Turns off a vacuum cleaner.

  • Turn on vacuum (vacuum.turn_on) Turns on a vacuum cleaner.

For an overview of every action across all integrations, see the actions reference.

Vacuum example automations

Use the vacuum triggers, conditions, and actions together to turn automation ideas into reliable routines that fit your household. Start from one small pain point, then decide which vacuum signal kicks things off, which condition keeps it safe, and which action finishes the job.

Tip

You don’t need to edit YAML to use these examples. Copy a YAML snippet from this page, open the automation editor in Home Assistant, and press Ctrl+V (or Cmd+V on Mac). Home Assistant automatically converts the pasted YAML into the visual editor format, whether it’s a full automation, a single trigger, a condition, or an action.

Automation: Pause cleaning during meetings

When the vacuum starts a run during a scheduled meeting, pause it automatically so the call stays quiet, then send yourself a reminder to resume the job later.

  • Trigger: vacuum.started_cleaning for the office vacuum.
  • Conditions: A calendar or busy sensor reports that a meeting is in progress, and vacuum.is_cleaning confirms the robot is still running.
  • Actions: vacuum.pause to stop the run, followed by a mobile notification that explains why the vacuum paused.
YAML example for pausing during meetings 
automation:
  alias: "Mute vacuum during meetings"
  triggers:
    - trigger: vacuum.started_cleaning
      target:
        entity_id: vacuum.office
  conditions:
    - condition: state
      entity_id: binary_sensor.meeting_in_progress
      state: "on"
    - condition: vacuum.is_cleaning
      target:
        entity_id: vacuum.office
  actions:
    - action: vacuum.pause
      target:
        entity_id: vacuum.office
    - action: notify.mobile_app_phone
      data:
        message: "The office vacuum paused because a meeting started. Resume it when the call ends."