mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-15 21:36:52 +00:00
Roomba: add steps to close all apps... (#29914)
This commit is contained in:
parent
7115a66b27
commit
5d7709da4a
@ -22,7 +22,7 @@ ha_integration_type: integration
|
||||
ha_zeroconf: true
|
||||
---
|
||||
|
||||
The `roomba` integration allows you to control your [iRobot Roomba](https://www.irobot.com/roomba) vacuum or [iRobot Braava](https://www.irobot.com/braava) m-series mop.
|
||||
The **Roomba** {% term integrations %} allows you to control your [iRobot Roomba](https://www.irobot.com/roomba) vacuum or [iRobot Braava](https://www.irobot.com/braava) m-series mop.
|
||||
|
||||
<p class='img'>
|
||||
<img src='/images/screenshots/more-info-dialog-roomba.png' />
|
||||
@ -30,7 +30,7 @@ The `roomba` integration allows you to control your [iRobot Roomba](https://www.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
This integration has been tested and 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. For auto-discovery, you will need to initiate a Roomba reboot. For example, by holding the clean button for up to 20 seconds on an i7 or 980. [More information about rebooting your robot](https://homesupport.irobot.com/s/article/9087).
|
||||
This {% term integrations %} has been tested and 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. For auto-discovery, you will need to initiate a Roomba reboot. For example, by holding the clean button for up to 20 seconds on an i7 or 980. [More information about rebooting your robot](https://homesupport.irobot.com/s/article/9087).
|
||||
|
||||
</div>
|
||||
|
||||
@ -38,27 +38,34 @@ This integration has been tested and confirmed to be working with the iRobot Roo
|
||||
|
||||
<div class='note'>
|
||||
|
||||
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)
|
||||
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. For more information, refer to the [Roomba 980 repository](https://github.com/NickWaterton/Roomba980-Python#firmware-2xx-notes).
|
||||
|
||||
</div>
|
||||
|
||||
## Integration entities
|
||||
|
||||
The Roomba Integration will add the following sensors.
|
||||
The **Roomba** {% term integrations %} 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
|
||||
- roomba_missions_cancelled: Total missions that have been canceled
|
||||
- roomba_missions_failed: Total missions that have failed
|
||||
- roomba_missions_successful: Total successful missions
|
||||
- roomba_missions_total: All total missions together
|
||||
- roomba_scrubs_count: Total amount of how often the robot has executed "scrub"
|
||||
- roomba_total_cleaning_time: How long the robot has spend cleaning (total) (in hours)
|
||||
|
||||
### Manually retrieving your credentials
|
||||
- **Battery**: The status of your battery
|
||||
- **Bin full** (if Roomba has the capacity to do): If the bin is full
|
||||
- **Canceled missions**: Total number of missions that have been canceled
|
||||
- **Failed missions**: Total number of missions that have failed
|
||||
- **Successful missions**: Total number of successful missions
|
||||
- **Average mission time**: The amount of time a mission took on average
|
||||
- **Total missions**: The total number of all missions
|
||||
- **Scrubs**: Total number of times the robot has executed a "scrub"
|
||||
- **Total cleaning time**: How many hours the robot has spent cleaning in total
|
||||
|
||||
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.
|
||||
### Retrieving your credentials
|
||||
|
||||
Check if the credentials can be retrieved directly from your device:
|
||||
|
||||
1. Make sure the Roomba app is closed on all of your devices.
|
||||
2. Follow the instructions in Home Assistant to retrieve the credentials.
|
||||
|
||||
If automatic retrieval does not work, you can retrieve the credentials manually. To manually retrieve both the BLID (username) and the password, refer to the instructions in the [Roomba 980](https://github.com/NickWaterton/Roomba980-Python#how-to-get-your-usernameblid-and-password) or [dority 980](https://github.com/koalazak/dorita980#how-to-get-your-usernameblid-and-password) repository.
|
||||
|
||||
For Home Assistant Container, the following command retrieves the BLID (username) and password:
|
||||
|
||||
@ -74,7 +81,7 @@ The command to retrieve the credentials does not need any additional software to
|
||||
|
||||
#### Retrieving credentials from the cloud with dorita980
|
||||
|
||||
The underlying Python library is currently unable to retrieve the credentials from some newer models (e.g. J7). See [this issue](https://github.com/pschmitt/roombapy/issues/97) for details. Luckily, the password can be retrieved from the cloud using a tool provided by the [dorita980](https://github.com/koalazak/dorita980) library. Follow [these instructions](https://github.com/koalazak/dorita980#how-to-get-your-usernameblid-and-password) to do this, you should receive output of the form:
|
||||
The underlying Python library is currently unable to retrieve the credentials from some newer models (for example, the J7). See [this issue](https://github.com/pschmitt/roombapy/issues/97) for details. Luckily, the password can be retrieved from the cloud using a tool provided by the [dorita980](https://github.com/koalazak/dorita980) library. Follow [these instructions](https://github.com/koalazak/dorita980#how-to-get-your-usernameblid-and-password) to do this, you should receive output of the form:
|
||||
|
||||
```shell
|
||||
Found 1 robot(s)!
|
||||
|
Loading…
x
Reference in New Issue
Block a user