home-assistant.io/source/_components/vacuum.roomba.markdown
2017-08-24 08:43:30 +02:00

1.8 KiB

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release
layout title description date sidebar comments sharing footer logo ha_category ha_release
page iRobot Roomba Instructions 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.

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 variables:

  • host (Required): Hostname or IP address of the Roomba.
  • username (Required): The username (BLID) fro your device.
  • password (Required): The password for your device.
  • name (Optional): The name of the vacuum.
  • certificate (Optional): Path to your certificate store. Defaults to /etc/ssl/certs/ca-certificates.crt.
  • continuous (Optional): Whether to operate in continuous mode. Defaults to 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)

{% linkable_title Retrieving your credentials %}

Please refer to here or here to retrieve both the BLID (username) and the password.