Add documentation for roomba platform (#3136)

This commit is contained in:
Philipp Schmitt 2017-08-06 11:09:12 +02:00 committed by Martin Hjelmare
parent 7c05b9cd28
commit 20c8c18098
2 changed files with 49 additions and 0 deletions

View File

@ -0,0 +1,49 @@
---
layout: page
title: "iRobot Roomba"
description: "Instructions how to integrate your Wi-Fi enabled Roomba within Home Assistant."
date: 2017-08-04 20:43
sidebar: true
comments: false
sharing: true
footer: true
logo: irobot_roomba.png
ha_category: Hub
ha_release: 0.51
---
The `roomba` component allows you to control your [Roomba](http://www.irobot.com/For-the-Home/Vacuuming/Roomba.aspx).
<p class='note'>
This platform has only been tested with an iRobot Roomba 980, but should work find
with any Wi-Fi enabled Roomba like the 690, 890 or the 960.
</p>
To add your roomba vacuum to your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
vacuum:
- platform: roomba
name: My Roomba
host: IP_ADDRESS_OR_HOSTNAME
username: BLID
password: PASSWORD
```
Configuration variables:
- **host** (*Required*): Hostname or IP address of the Roomba.
- **username** (*Required*): Username (BLID).
- **password** (*Required*): Password.
- **certificate** (*Optional*): Path to your certificate store (Default: `/etc/ssl/certs/ca-certificates.crt`)
- **continuous** (*Optional*): Whether to operate in continuous mode (Default: `True`).
<p class='note'>
The Roomba's MQTT server only allows a single connection. Enabling continuous
mode will force the App to connect via the cloud to your Roomba. [More info here](https://github.com/NickWaterton/Roomba980-Python#firmware-2xx-notes)
</p>
### Retrieving your credentials
Please refer to [here](https://github.com/NickWaterton/Roomba980-Python#how-to-get-your-usernameblid-and-password) or [here](https://github.com/koalazak/dorita980#how-to-get-your-usernameblid-and-password) to retrieve both the BLID (username) and the password.

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.1 KiB