2.1 KiB
layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, redirect_from
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | ha_release | redirect_from | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| page | iRobot Roomba | Instructions on how to integrate your Wi-Fi enabled Roomba within Home Assistant. | 2017-08-04 20:43 | true | false | true | true | irobot_roomba.png | Vacuum | 0.51 |
|
The roomba component allows you to control your iRobot Roomba vacuum.
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.
{% linkable_title Configuration %}
To add your Roomba vacuum to your installation, add the following to your configuration.yaml file:
# Example configuration.yaml entry
vacuum:
- platform: roomba
host: IP_ADDRESS_OR_HOSTNAME
username: BLID
password: PASSWORD
{% configuration %} host: description: The hostname or IP address of the Roomba. required: true type: string username: description: The username (BLID) for your device. required: true type: string password: description: The password for your device. required: true type: string name: description: The name of the vacuum. required: false type: string default: Roomba certificate: description: Path to your certificate store. required: false type: string default: /etc/ssl/certs/ca-certificates.crt continuous: description: Whether to operate in continuous mode. required: false type: boolean default: true {% endconfiguration %}
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)
{% linkable_title Retrieving your credentials %}
Please refer to here or here to retrieve both the BLID (username) and the password.