Vacuum cleaner card for Home Assistant Lovelace UI

By default, Home Assistant does not provide any card for controlling vacuum cleaners. This card displays the state and allows to control your robot.

💡 Tip: If you like this project and want to get some stickers and postcards, consider becoming a patron:

or just buy me a cup of ☕️ or 🥤:

This card is available in HACS (Home Assistant Community Store).

Just search for Vacuum Card in plugins tab.

1. Download vacuum-card.js file from the latest-release.
2. Put vacuum-card.js file into your config/www folder.
3. Add reference to vacuum-card.js in Lovelace. There's two way to do that:
   1. Using UI: Configuration → Lovelace Dashboards → Resources → Click Plus button → Set Url as /local/vacuum-card.js → Set Resource type as JavaScript Module.
   2. Using YAML: Add following code to lovelace section.

      resources:
        - url: /local/vacuum-card.js
          type: module

4. Add custom:vacuum-card to Lovelace UI as any other card (using either editor or YAML configuration).

This card can be configured using Lovelace UI editor.

1. In Lovelace UI, click 3 dots in top left corner.
2. Click Configure UI.
3. Click Plus button to add a new card.
4. Find Custom: Vacuum Card in the list.
5. Choose entity.
6. Now you should see the preview of the card!

Sorry, no support for actions in visual config yet.

Typical example of using this card in YAML config would look like this:

type: 'custom:vacuum-card'
entity: vacuum.vacuum_cleaner
actions:
  - name: Clean living room
    service: script.clean_living_room
    icon: 'mdi:sofa'
  - name: Clean bedroom
    service: script.clean_bedroom
    icon: 'mdi:bed-empty'
  - name: Clean kitchen
    service: script.clean_kitchen
    icon: 'mdi:silverware-fork-knife'

Here is what every option means:

I've added some animations for this card to make it alive. Animations are applied only for image property. Here's how they look like:

Cleaning	Docking

This card relies on basic vacuum services, like pause, start, stop, return_to_base, etc. It should work with any robot vacuum, however I can physically test it only with my own robot vacuum.

If this card works with your vacuum cleaner, please open a PR and your model to the list.

• Roborock S6
• Roborock S5
• Roborock S5 Max
• Roborock S4
• Xiaomi Mi Robot Vacuum (STYJ02YM)
• Roomba 675
• Dyson 360 Eye (brush and filter hours are not supported)
• Neato D7
• Your vacuum?

Want to contribute to the project?

First of all, thanks! Check contributing guideline for more information.

This project is heavily inspired by:

• MacBury Smart House — basically, this project is a refinement of MacBury's custom card.
• Benji vacuum card — this is where I noticed this vacuum card design for the first time.

Huge thanks for their ideas and efforts 👍

MIT © Denys Dovhan