Add documentation for Neato switch (#1261)

* Add documentation for Neato switch

Signed-off-by: Hugo D. (jabesq) <jabesq@gmail.com>

* Add an overview of the variables
This commit is contained in:
Hugo Dupras 2016-10-22 10:35:43 +02:00 committed by Fabian Affolter
parent 4ab2ea993b
commit 6e02222571
2 changed files with 36 additions and 0 deletions

View File

@ -0,0 +1,36 @@
---
layout: page
title: "Neato Robotics Switch"
description: "Instructions how to integrate a Neato Botvac Connected switch within Home Assistant."
date: 2016-10-19 17:10
sidebar: true
comments: false
sharing: true
footer: true
logo: neato.png
ha_category: Switch
ha_release: 0.3X
---
The `neato` switch platform allows you to control your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/).
This will automatically add a switch for each Botvac Connected that you have. The switch will start a full home cleaning when turned ON and return the robot to base when turned OFF.
To enable this switch in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
platform: neato
username: USERNAME
password: PASSWORD
```
Configuration variables:
- **username** (*Required*): Username for the Neato account.
- **password** (*Required*): Password for the Neato account.
<p class='note'>
The Home Assistant Neato platform has only be tested with a Botvac Connected. There is no support for the Botvac D3 Connected and Botvac D5 Connected robots at this time.
</p>

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB