Custom cleaning

Use this action to start a custom cleaning run on your Neato Botvac from an automation or a script. You can set the same options as in the Neato app, such as the cleaning mode, navigation mode, map usage, and a specific zone to clean.

Using this action from the user interface

If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.

To start a custom cleaning run from an automation or a script:

1. Go to Settings > Automations & scenes.
2. Open an existing automation or script, or select Create automation > Create new automation.
3. If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger. They run when something else calls them.
4. In the Then do section, select Add action.
5. Select what you want to control. Under By target (see Targets), select the Neato Botvac you want to start.
6. From the actions shown for that target, select Neato: Custom cleaning.
7. Optionally, set the Mode, Navigation, Category, and Zone options.
8. Select Save.

Options in the UI

Using this action in YAML

If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.

In YAML, refer to this action as neato.custom_cleaning. A basic example looks like this:

action: neato.custom_cleaning
target:
  entity_id: vacuum.neato
data:
  mode: 2
  navigation: 1

This starts a turbo cleaning run with normal navigation.

Options in YAML

Targets of the action

This action requires a target. The target is the object of the action. You can point the action at a single 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], a device, an area, a floor, or a label, and Home Assistant will run the action on every matching vacuum entity behind that target.

• Entity: one specific vacuum entity, such as vacuum.living_room.
• Device: every vacuum entity that belongs to a device.
• Area: every vacuum entity in a room or area.
• Floor: every vacuum entity on a floor.
• Label: every vacuum entity that shares a label.

You can also select different target types in one action. For example, you can add a specific entity and an area as targets in the same action to run the action on both of them at once.

Good to know

• Not all Botvac models support every option. Only the Neato Botvac D7 supports the zone option and deep navigation.
• Use unique names for your zones in the Neato app to avoid starting the wrong zone.

Try it yourself

Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn 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] without writing a line of YAML.

Still stuck?

The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.