diff --git a/source/_components/vacuum.roomba.markdown b/source/_components/vacuum.roomba.markdown new file mode 100644 index 00000000000..bad1e9a82f9 --- /dev/null +++ b/source/_components/vacuum.roomba.markdown @@ -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). + +
+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. +
+ +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`). + ++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) +
+ +### 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. diff --git a/source/images/supported_brands/irobot_roomba.png b/source/images/supported_brands/irobot_roomba.png new file mode 100644 index 00000000000..aeabd8c459d Binary files /dev/null and b/source/images/supported_brands/irobot_roomba.png differ