Skip to content

Update Roomba to reflect the new state of things #5939

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
arbreng wants to merge 1 commit into from
Closed

Update Roomba to reflect the new state of things #5939

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 39 additions & 4 deletions source/_components/vacuum.roomba.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,23 @@ ha_release: 0.51

The `roomba` component allows you to control your [iRobot Roomba](http://www.irobot.com/For-the-Home/Vacuuming/Roomba.aspx) vacuum.

<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>
Currently supported features are:
- `start`
- `pause`
- `stop` - `stop`
- `return_to_home` - `return_to_home`
- `turn_off` (stop all activity and return to dock)
- `locate` - `locate`
- `clean_spot` - `clean_spot`
- `set_fan_speed` - `set_fan_speed`

Please follow [Retrieving your credentials](/components/vacuum.roomba/#retrieving-your-credentials) to retrieve the API token used in
`configuration.yaml`.


To add your Roomba vacuum to your installation, add the following to your `configuration.yaml` file:
## {% linkable_title Configuring the Platform %}

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

```yaml
# Example configuration.yaml entry
Expand All @@ -42,6 +54,29 @@ Configuration variables:
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>

## {% linkable_title Attributes %}
In addition to [all of the attributes provided by the `vacuum` component](/components/vacuum/#attributes),
(`battery_icon`, `cleaned_area`, `fan_speed`, `fan_speed_list`, `status`, and `params`), the `roomba` platform introduces specific attributes. These are:
- `bin_full`
- `bin_present`
- `cleaned_area`
- `cleaning_time`
- `error`
- `position`
- `software_version`

The following table shows the units of measurement for each attribute:

| Attribute | Unit of measurement | Description |
|---------------------------|---------------------|-------------------------------------------------------|
| `bin_full` | boolean | Debris bin full or not |
| `bin_present` | boolean | Debris bin attached to the Roomba or not |
| `cleaned_area` | square meter | Last / actual cleaned area in square meters |
| `cleaning_time` | minutes | Last / actual cleaning time in minutes |
| `error` | string | Detailed error message |
| `position` | (int,int) | (x,y) position of the Roomba's location |
| `software_version` | string | Firmware version of the Roomba |

### {% linkable_title 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.