You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/_components/vacuum.roomba.markdown
+10-12Lines changed: 10 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -12,20 +12,18 @@ ha_category: Vacuum
12
12
ha_release: 0.51
13
13
---
14
14
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.
16
16
17
17
<pclass='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.
20
19
</p>
21
20
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:
23
22
24
23
```yaml
25
24
# Example configuration.yaml entry
26
25
vacuum:
27
26
- platform: roomba
28
-
name: My Roomba
29
27
host: IP_ADDRESS_OR_HOSTNAME
30
28
username: BLID
31
29
password: PASSWORD
@@ -34,16 +32,16 @@ vacuum:
34
32
Configuration variables:
35
33
36
34
- **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`.
41
40
42
41
<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)
45
43
</p>
46
44
47
-
### Retrieving your credentials
45
+
### {% linkable_title Retrieving your credentials %}
48
46
49
47
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