Neato Robotics


The neato component allows you to control your Neato Botvac Connected Robots.

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

# Example configuration.yaml entry
neato:
  username: YOUR_USERNAME
  password: YOUR_PASSWORD

Configuration Variables

username

(string)(Required)Username for the Neato account.

password

(string)(Required)Password for the Neato account.

After the update to firmware 4.0 (which adds cleaning maps) there is also support for displaying the maps of the Botvac D3 Connected and Botvac D5 Connected robots. More information on how to update can be found here.

Vacuum

The neato vacuum platform allows you to control your Neato Botvac Connected. The status will contain attributes on the robots last clean session.

If you notice the robot stops responding to commands check the state to see if the robot is “unavailable”. If you see “unavailable” first try to restart the vacuum and wait about 5 minutes to see if it is no longer “unavailable”. If you are still having issues check the Neato app and make sure your robot is connected and working. If it is not then follow the steps in the app to reset your robot and give it the same name as before then restart Home Assistant.

Services

Currently supported services are:

  • start
  • pause
  • stop
  • return_to_base
  • locate
  • spot_clean

And a specific Platform Service:

  • vacuum.neato_custom_cleaning

Platform Services

Service vacuum.neato_custom_cleaning

Starts a custom cleaning of your house. You can set the various options like in the mobile application (mode, map usage, navigation mode, zone).

Not all Botvac models support all the attributes. Only the Neato Botvac D7 supports the zone attribute. Some information about the capabilities might be found on the Neato Developer Portal.

Service data attribute Optional Description
entity_id no Only act on a specific robot
mode yes Set the cleaning mode: 1 for eco and 2 for turbo. Defaults to turbo if not set.
navigation yes Set the navigation mode: 1 for normal, 2 for extra care, 3 for deep. Defaults to normal if not set.
category yes Whether to use a persistent map or not for cleaning (i.e. No go lines): 2 for no map, 4 for map. Default to using map if not set (and fallback to no map if no map is found).
zone yes Only supported on the Botvac D7. Name of the zone to clean. Defaults to no zone i.e. complete house cleanup.

Camera

The neato camera platform allows you to view the latest cleaning map of your Neato Botvac Connected.

Switch

The neato switch platform allows you to enable or disable the schedule of your Neato Botvac Connected.

To add neato switch, camera and vacuum to your installation, follow instructions above.