3.5 KiB
roomba_rest980
Drop-in native integration/replacement for jerrywillans/ha-rest980-roomba.
Still work in progress, but the vacuum entity has been fully ported over.
Roadmap
- Feature parity (minus actions) with vacuum entity
- Actions
- Dynamically grab rooms and add them to the UI
Setup
Prerequisites / Recommendations
- HACS
- rest980
- If you don't have it yet, don't worry; this guide will show you how to add it.
- Rooms mapped/setup in iRobot app
- Note that everytime you remap and a room changes, it's ID may change!
- Knowledge of your Roomba's IP
I recommend that you use the lovelace-roomba-vacuum-card until I remake it for this integration.
Step 1: Setting up rest980: Grab Robot Credentials
If you already have it setup, and you know its url (like http://localhost:3000), you may skip this step.
First, you must gather your robot's on-device password and BLID (identifier).
NOTE: You cannot have the iRobot app running on your phone, or anything else connected to it during this step!
For Docker users
Execute this command: ```sh docker run -it node sh -c "npm install -g dorita980 && get-roomba-password " ``` and follow the on-screen instructions.HA Addon by jeremywillans
Add https://github.com/jeremywillans/hass-addons to the Addons tab.
Locate and install the roombapw addon, following the included instructions.
Other HA installation method
If you dont have direct access to Docker, you can clone and install the dorita980 package locally.
See dorita980's instructions on how to get the credentials.
Setting up rest980: Bringing The Server Up
Now that you have your robot's IP, BLID, and password, we need to actually start rest980.
For Docker users (docker-compose)
Download the docker-compose.yaml file, and bring the service up.
To bring the service up (just rest980) and leave it in the background, run
docker-compose up -d rest980
You may also add the service to an existing configuration. You do not need to add file binds/mounts, as there are not any.
HA Addon by jeremywillans
If you haven't, add https://github.com/jeremywillans/hass-addons to the Addons tab.
Locate and install the rest980 addon, then update and save the configuration options with the credentials you got from the previous step.
NOTE: Rest980 Firmware option 2 implies v2+ (inclusive of 3.x)
Other HA installation method
Clone and start the rest980 server by koalazak, and note your computer's IP and port.