roomba-vacuum-card
HA Lovelace Card for iRobot Roomba Vacuum or Braava Mop leveraging the rest980 Docker Image
Please refer my ha-rest980-roomba GitHub Repository for detailed instructions for using this card.
Setup
Install using HACS using the following custom plugin repository https://github.com/jeremywillans/lovelace-roomba-vacuum-card
resources:
- type: module
url: /hacsfiles/lovelace-roomba-vacuum-card/roomba-vacuum-card.jsOR
Manually add roomba-vacuum-card.js and vacuum.png (optionally include mop.png)
to your <config>/www/ folder and add the following to your ui-lovelace.yaml file:
resources:
- type: module
url: /local/roomba-vacuum-card.js Note: You will need to update the image path when configuring lovelace as it by default will look in the hacs install folder
Options
| Name | Type | Default | Description |
|---|---|---|---|
| type | string | Required | custom:roomba-vacuum-card |
| entity | string | Required | sensor.vacuum |
| mode | string | vacuum |
Defines preset configuration, options are vacuum or mop |
| name | string/bool | friendly_name |
Override entity friendly name (set to false to hide title) |
| image | string/bool | /<hacs>/vacuum.png |
Custom path/name of background image (set to false to disable background) |
| buttons | object/bool | (see below) | Set to false to hide button row |
| attributes | object/bool | (see below) | Customize attribute fields |
| labels | object/bool | (see below) | Customize label fields |
| robot_states | object/bool | (see below) | Customize robot states |
| layout | object/bool | (see below) | Customize vacuum card layout |
| maint | bool | true | Display maintenance and clean mode status |
| clean_base | bool | true | If no Clean Base, Set to false to show Bin Status |
| totals | bool | true | Show Total Stats on Right |
| job | bool | true | Show Job Stats on Right |
| defaultTotals | bool | true | Shows Total Stats by default when not cleaning |
| autoswitch | bool | true | Auto switches to Job Stats when cleaning |
| robot_action | string | vacuum_action |
Change action rest command, default for mop mode is mop_action |
Mode
This card now has preset options for the Braava Mop. If selected using mode: mop the following will apply
- Layout lists tank and pad, replacing Clean Base and Evacs
- Background Image is changed to Braava Jet
- Robot Action is changed to
mop_action - Clean Mode is updated to reflect Pad Wetness Attribute
Buttons object
| Name | Type | Default | Description |
|---|---|---|---|
| startstop | bool | true |
Show or hide start button |
| stop | bool | false |
Show or hide stop button - enable blank (below) if you disable this |
| blank | bool | true |
Show or hide blank button - splits startstop and dock if stop is disabled |
| dock | bool | true |
Show or hide dock/empty button |
Layout object
Customize card layout.
Note: Status (top left), cannot be customized.
If you want to hide a field, use false, if you want to keep a blank link in its place, use blank
| Name | Type | Default |
|---|---|---|
| left_2 | string | mode |
| left_3 | string | battery |
| left_4 | string | clean_base |
| right_total_1 | string | total_area |
| right_total_2 | string | total_time |
| right_total_3 | string | total_jobs |
| right_total_4 | string | evac_events |
| right_job_1 | string | job_initiator |
| right_job_2 | string | job_time |
| right_job_3 | string | job_recharge |
| right_job_4 | string | job_expires |
Attributes object
Customize attribute fields.
| Name | Type | Default | Description |
|---|---|---|---|
| status | string | state |
Change status attribute |
| mode | string | phase |
Change mode attribute |
| battery | string | battery |
Change battery attribute |
| clean_base | string | clean_base |
Change clean base attribute |
| bin | string | bin |
Change bin attribute |
| maint_due | string | maint_due |
Change maintenance due attribute (boolean) |
| total_area | string | area_cleaned |
Change total area cleaned attribute |
| total_time | string | job_time |
Change total job time attribute |
| total_jobs | string | total_jobs |
Change total jobs attribute |
| evac_events | string | evac_events |
Change clean base empties attribute (for Clean Base) |
| job_initiator | string | job_initiator |
Change current/last mission job initiator attribute |
| job_time | string | job_time |
Change current/last mission area time attribute |
| job_recharge | string | job_recharge |
Change current/last mission recharge minutes attribute |
| job_expires | string | job_expires |
Change current/last mission expiry minutes attribute |
| tank | string | tank |
Change tank attribute |
| pad | string | pad |
Change pad attribute |
Labels object
Customize or translate label names.
| Name | Type | Default | Description |
|---|---|---|---|
| status | string | Status |
Change status label |
| mode | string | Mode |
Change mode label |
| battery | string | Battery |
Change battery label |
| clean_base | string | Clean Base |
Change clean base label |
| bin | string | Bin |
Change bin label |
| total_area | string | Area |
Change total area cleaned label |
| total_time | string | Time |
Change total job time label |
| total_jobs | string | Jobs |
Change total jobs label |
| evac_events | string | Evacs |
Change clean base empties label (for Clean Base) |
| job_initiator | string | Source |
Change current/last mission job initiator label |
| job_time | string | Time |
Change current/last mission area time label |
| job_recharge | string | Recharge In |
Change current/last mission recharge minutes label |
| job_expires | string | Expires In |
Change current/last mission expiry minutes label |
| full_clean | string | Full Clean |
Change full clean button label |
| resume | string | Resume |
Change resume button label |
| pause | string | Pause |
Change pause button label |
| empty | string | Empty Bin |
Change empty bin button label |
| dock | string | Dock |
Change dock button label |
| stop | string | Stop |
Change stop button label |
| tank | string | Tank |
Change tank label |
| pad | string | Pad |
Change pad label |
| missing | string | Missing! |
Change missing label |
| unavailable | string | Unavailable |
Change unavailable label |
Robot_States object
Customize or translate robot states as defined in vacuum.yaml or mop.yaml.
| Name | Type | Default | Description |
|---|---|---|---|
| ready | string | Ready |
Change Ready state |
| stuck | string | Stuck |
Change Stuck state |
| pending | string | Pending |
Change Pending state |
| charge | string | Charge |
Change Charge state |
| idle | string | Idle |
Change Idle state |
| empty | string | Empty |
Change Empty state |
Examples
Default
Default - Jobs Page
Hidden Title/Name and Maintenance
Hidden Button Row (with Maintenance Due)
No Background Image and Hidden Title/Name
Simple config example:
- type: custom:roomba-vacuum-card
entity: sensor.vacuumAdvanced configuration:
- type: custom:roomba-vacuum-card
entity: sensor.vacuum
image: /local/img/different_vacuum.png
name: Bump
clean_base: false
buttons:
blank: true
stop: false
labels:
status: Estado
battery: Batería
mode: Modo
area_cleaned: Zona
job_time: Hora
total_jobs: Trabajos
evac_events: EnvasesSupport
Got questions? Please post them here.
In case you've found a bug, please open an issue on GitHub.
Disclaimer
This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with the iRobot Corporation, or any of its subsidiaries or its affiliates. The official iRobot website can be found at https://www.irobot.com
Credits
- Ben Tomlin for creating the xiaomi-vacuum-card from which this is shamelessly derived from!
- Facu ZAK for creating dorita980 and rest980 !
My Repos
ha-rest980-roomba | roomba-vacuum-card | hass-addons | event-emitter
