From f36ce0c25351b14f70eb2b1749292005c84640ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20W?= Date: Mon, 25 Feb 2019 20:36:05 +0000 Subject: [PATCH] Neato supports custom cleaning (#8421) * Neato supports custom cleaning * Adding some details about the new service * More details on the new service * Revert back the domain to vacuum as requested --- source/_components/neato.markdown | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/source/_components/neato.markdown b/source/_components/neato.markdown index 6d17e1ccdea..63b20cbde64 100644 --- a/source/_components/neato.markdown +++ b/source/_components/neato.markdown @@ -42,7 +42,7 @@ password: {% endconfiguration %}

-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](https://support.neatorobotics.com/hc/en-us/articles/115004320694-Software-Update-4-0-for-Neato-Botvac-Connected-D3-D5-). +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](https://support.neatorobotics.com/hc/en-us/articles/115004320694-Software-Update-4-0-for-Neato-Botvac-Connected-D3-D5-).

## {% linkable_title Vacuum %} @@ -54,7 +54,7 @@ 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.

-### {% linkable_title Configuration %} +### {% linkable_title Services %} Currently supported services are: @@ -65,6 +65,30 @@ Currently supported services are: - `locate` - `spot_clean` +And a specific Platform Service: + +- `vacuum.neato_custom_cleaning` + +### {% linkable_title Platform Services %} + +#### {% linkable_title 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](https://developers.neatorobotics.com/api/robot-remote-protocol/housecleaning). +

+ +| 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. | + + ## {% linkable_title Camera %} The `neato` camera platform allows you to view the latest cleaning map of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/). @@ -73,4 +97,4 @@ The `neato` camera platform allows you to view the latest cleaning map of your [ The `neato` switch platform allows you to enable or disable the schedule of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/). -To add `neato` switch, camera and vacuum to your installation, follow instructions above. \ No newline at end of file +To add `neato` switch, camera and vacuum to your installation, follow instructions above.