sudoxreboot/roomba_rest980
1
0
Fork 0
mirror of https://github.com/sudoxnym/roomba_rest980.git synced 2026-04-14 11:37:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Aiden 2025-08-09 13:48:43 -05:00 committed by GitHub
parent c2d46895b2
commit 699310c93c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -8,7 +8,8 @@ Still work in progress, but the vacuum entity has been fully ported over.
- [x] Attribute parity with jeremywillans' YAML entry - [x] Attribute parity with jeremywillans' YAML entry
- [x] Cloud API connection - [x] Cloud API connection
- [ ] Cloud MQTT connection - [x] Cloud MQTT connection
- ONLY IN TESTING RIGHT NOW! I've reverse engineered their MQTT stack (but not all available commands) and will be releasing a better writeup later
- [x] Actions - [x] Actions
- [x] Start - [x] Start
- [x] Favorites - [x] Favorites
@ -56,9 +57,11 @@ First, you must gather your robot's on-device password and BLID (identifier).
For Docker users For Docker users
</summary> </summary>
Execute this command: Execute this command:
```sh ```sh
docker run -it node sh -c "npm install -g dorita980 && get-roomba-password <robotIP>" docker run -it node sh -c "npm install -g dorita980 && get-roomba-password <robotIP>"
``` ```
and follow the on-screen instructions. and follow the on-screen instructions.
</details> </details>
@ -226,4 +229,4 @@ Returning: The vacuum is done cleaning and is currently returning to the dock, b
Unavailable: The entity is currently unavailable. Unavailable: The entity is currently unavailable.
Unknown: The state is not yet known. Unknown: The state is not yet known.
``` ```
Since the Roomba reports a much more extensive cycle/phase output, I added an attribute "extendedStatus" that gives you "Ready", "Training", "Spot". Since the Roomba reports a much more extensive cycle/phase output, I added an attribute "extendedStatus" that gives you "Ready", "Training", "Spot".