mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-15 05:16:49 +00:00
Add Config flow for Roomba (#12793)
* Add Config flow for Roomba
* Add Config flow for Roomba
* Add Config flow for Roomba
* Add Config flow for Roomba
* Update roomba.markdown
* Add multiple vacuum
* Update roomba.markdown
* Update roomba.markdown
* Add ha_conflig_flow
* Update roomba.markdown
* ✏️ Tweak
Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
This commit is contained in:
parent
2fd8b2b320
commit
0fb93ffc64
@ -4,8 +4,10 @@ description: Instructions on how to integrate your Wi-Fi enabled Roomba within H
|
||||
ha_category:
|
||||
- Vacuum
|
||||
ha_release: 0.51
|
||||
ha_conflig_flow: true
|
||||
ha_codeowners:
|
||||
- '@pschmitt'
|
||||
- '@cyr-ius'
|
||||
ha_domain: roomba
|
||||
---
|
||||
|
||||
@ -21,14 +23,15 @@ This platform has been tested and is confirmed to be working with the iRobot Roo
|
||||
|
||||
## 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:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
vacuum:
|
||||
- platform: roomba
|
||||
host: IP_ADDRESS_OR_HOSTNAME
|
||||
username: BLID
|
||||
roomba:
|
||||
- host: IP_ADDRESS_OR_HOSTNAME
|
||||
blid: BLID
|
||||
password: PASSWORD
|
||||
```
|
||||
|
||||
@ -37,7 +40,7 @@ host:
|
||||
description: The hostname or IP address of the Roomba.
|
||||
required: true
|
||||
type: string
|
||||
username:
|
||||
blid:
|
||||
description: The username (BLID) for your device.
|
||||
required: true
|
||||
type: string
|
||||
@ -45,11 +48,6 @@ password:
|
||||
description: The password for your device.
|
||||
required: true
|
||||
type: string
|
||||
name:
|
||||
description: The name of the vacuum.
|
||||
required: false
|
||||
type: string
|
||||
default: Roomba
|
||||
certificate:
|
||||
description: Path to your certificate store.
|
||||
required: false
|
||||
@ -73,6 +71,29 @@ The Roomba's MQTT server only allows a single connection. Enabling continuous mo
|
||||
|
||||
</div>
|
||||
|
||||
## 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
|
||||
|
||||
```yaml
|
||||
# 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](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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user