Skip to content

Commit f77ddca

Browse files
committed
Fix configuration sample
1 parent b589e12 commit f77ddca

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

source/_components/vacuum.roomba.markdown

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,20 +12,18 @@ ha_category: Vacuum
1212
ha_release: 0.51
1313
---
1414

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

1717
<p class='note'>
18-
This platform has only been tested with an iRobot Roomba 980 but should work find
19-
with any Wi-Fi enabled Roomba like the 690, 890 or the 960.
18+
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.
2019
</p>
2120

22-
To add your roomba vacuum to your installation, add the following to your `configuration.yaml` file:
21+
To add your Roomba vacuum to your installation, add the following to your `configuration.yaml` file:
2322

2423
```yaml
2524
# Example configuration.yaml entry
2625
vacuum:
2726
- platform: roomba
28-
name: My Roomba
2927
host: IP_ADDRESS_OR_HOSTNAME
3028
username: BLID
3129
password: PASSWORD
@@ -34,16 +32,16 @@ vacuum:
3432
Configuration variables:
3533
3634
- **host** (*Required*): Hostname or IP address of the Roomba.
37-
- **username** (*Required*): Username (BLID).
38-
- **password** (*Required*): Password.
39-
- **certificate** (*Optional*): Path to your certificate store (Default: `/etc/ssl/certs/ca-certificates.crt`)
40-
- **continuous** (*Optional*): Whether to operate in continuous mode (Default: `True`).
35+
- **username** (*Required*): The username (BLID) fro your device.
36+
- **password** (*Required*): The password for your device.
37+
- **name** (*Optional*): The name of the vacuum.
38+
- **certificate** (*Optional*): Path to your certificate store. Defaults to `/etc/ssl/certs/ca-certificates.crt`.
39+
- **continuous** (*Optional*): Whether to operate in continuous mode. Defaults to `True`.
4140

4241
<p class='note'>
43-
The Roomba's MQTT server only allows a single connection. Enabling continuous
44-
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)
42+
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)
4543
</p>
4644

47-
### Retrieving your credentials
45+
### {% linkable_title Retrieving your credentials %}
4846

4947
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.

0 commit comments

Comments
 (0)