xiaomi-vacuum-card

Simple card for Xiaomi (and some other) robot vaccums in Home Assistant's Lovelace UI

Setup

Manually add xiaomi-vacuum-card.js to your <config>/www/ folder and add the following to your ui-lovelace.yaml file:

resources:
  - url: /local/xiaomi-vacuum-card.js?v=3.0.1
    type: module

OR install using HACS and add this instead:

resources:
  - url: /community_plugin/lovelace-xiaomi-vacuum-card/xiaomi-vacuum-card.js
    type: module

If you want to use the vacuum background image, download and add img/vacuum.png to <config>/www/img/ or configure your own preferred path.

Options

Name	Type	Default	Description
type	string	Required	custom:xiaomi-vacuum-card
entity	string	Required	vacuum.my_xiaomi_vacuum
name	string/bool	friendly_name	Override entity friendly name (set to false to hide title)
image	string/bool	/local/img/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
labels	object/bool	(see below)	Set to false to hide details/labels
icons	object		Set custom button icons (same keys as buttons object)

Buttons object

Name	Type	Default	Description
start	bool	true	Show or hide start button
pause	bool	true	Show or hide pause button
stop	bool	true	Show or hide stop button
spot	bool	false	Show or hide clean spot button
locate	bool	true	Show or hide locate button
return	bool	true	Show or hide return to home button

Labels object

Customize or translate label names.

Name	Type	Default	Description
status	string	Status	Change status label
battery	string	Battery	Change battery label
mode	string	Mode	Change mode label
main_brush	string	Main Brush	Change main brush label
side_brush	string	Side Brush	Change side brush label
filter	string	Filter	Change filter label
sensor	string	Sensor	Change sensor label
hours	string	h	Change hours label

Other vendors

This card was originally written for Xiaomi (Roborock) vacuum cleaners, but version 2.0 and later has added support for some other vendors too. If you think any more vendors should be added, feel free to open an issue or contribute directly with a PR.

Name	Type	Default	Description
vendor	string	xiaomi	Supported vendors: xiaomi, valetudo, ecovacs, deebot, robovac, roomba

Note: Vendor ecovacs and robovac shows the clean spot button instead of the stop button by default

Examples

Hidden title/name

Hidden button row

No background image

Simple config example:

- type: custom:xiaomi-vacuum-card
  entity: vacuum.xiaomi_vacuum_cleaner

Advanced configuration:

- type: custom:xiaomi-vacuum-card
  entity: vacuum.xiaomi_vacuum_cleaner
  image: /local/custom/folder/background.png
  name: My Vacuum
  vendor: xiaomi
  buttons:
    start: true
    stop: true
    locate: false
  icons:
    start: mdi:some-icon
    stop: mdi:other-icon
  labels:
    status: Etat
    battery: Batterie
    mode: Puissance
    main_brush: Brosse Principale
    side_brush: Brosse Latérale
    filter: Filtre
    sensor: Capteurs

Disclaimer

This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with the Xiaomi Corporation, or any of its subsidiaries or its affiliates. The official Xiaomi website can be found at https://www.mi.com/global/.

My cards

xiaomi-vacuum-card | multiple-entity-row | github-entity-row | attribute-entity-row