home-assistant.io/source/_integrations/roomba.markdown

title, description, ha_category, ha_iot_class, ha_release, ha_conflig_flow, ha_codeowners, ha_domain, ha_config_flow

title	description	ha_category	ha_iot_class	ha_release	ha_conflig_flow	ha_codeowners	ha_domain	ha_config_flow
iRobot Roomba	Instructions on how to integrate your Wi-Fi enabled Roomba and Braava within Home Assistant.	Vacuum	Local Push	0.51	true	@pschmitt @cyr-ius @shenxn	roomba	true

The roomba integration allows you to control your iRobot Roomba vacuum or iRobot Braava m-series mop.

This platform has been tested and is confirmed to be working with the iRobot Roomba s9+, Roomba 980, Roomba 960, Roomba 890, and Braava jet m6 models, but should also work fine with any Wi-Fi enabled Roomba or Braava like the 690.

Configuration

To add your Roomba to your installation, go to Configuration >> Integrations in the UI, click the button with + sign and from the list of integrations select iRobot Roomba.

To add your Roomba vacuum to your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
roomba:
  - host: IP_ADDRESS_OR_HOSTNAME
    blid: BLID
    password: PASSWORD

{% configuration %} host: description: The hostname or IP address of the Roomba. required: true type: string blid: description: The username (BLID) for your device. required: true type: string password: description: The password for your device. required: true type: string continuous: description: Whether to operate in continuous mode. required: false type: boolean default: true delay: description: Custom connection delay (in seconds) for periodic mode required: false type: integer default: 1 {% 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

Integration Entities

The Roomba Integration will add the following sensors.

Sensors:

• roomba_battery_level : The status of your battery
• roomba_bin_full (if Roomba has the capacity to do) : Bin Full status

Multiple Roomba vacuums

# Example configuration.yaml entry
roomba:
  - host: IP_ADDRESS_OR_HOSTNAME_1
    blid: BLID_1
    password: PASSWORD_1
  - host: IP_ADDRESS_OR_HOSTNAME_2
    blid: BLID_2
    password: PASSWORD_2
    continuous: false
    delay: 5

Retrieving your credentials

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