All Projects β†’ PiotrMachowski β†’ Lovelace Xiaomi Vacuum Map Card

PiotrMachowski / Lovelace Xiaomi Vacuum Map Card

Licence: mit
This card enables you to specify a target or start a zoned cleanup using live or static map, just like in Xiaomi Home app. Additionally you can define a list of zones and choose the ones to be cleaned.

Projects that are alternatives of or similar to Lovelace Xiaomi Vacuum Map Card

Home Assistant Config
Home Assistant Configuration & Documentation for my Smart House.
Stars: ✭ 1,115 (+157.51%)
Mutual labels:  home-assistant, xiaomi
Miflora Mqtt Daemon
Linux service to collect and transfer Xiaomi Mi Flora plant sensor data via MQTT to your smart home system, with cluster support 🌱🌼πŸ₯€πŸ‘🌳
Stars: ✭ 409 (-5.54%)
Mutual labels:  home-assistant, xiaomi
Xiaomigateway3
Control Zigbee, BLE and Mesh devices from Home Assistant with Xiaomi Gateway 3 (ZNDMWG03LM) on original firmware
Stars: ✭ 617 (+42.49%)
Mutual labels:  home-assistant, xiaomi
Home Assistant Custom Components Xiaomi Cloud Map Extractor
This custom integration provides a way to present a live view of a map for a Xiaomi (and Roborock) vacuums.
Stars: ✭ 318 (-26.56%)
Mutual labels:  home-assistant, xiaomi
Openmqttgateway
MQTT gateway for ESP8266, ESP32, Sonoff RF Bridge or Arduino with bidirectional 433mhz/315mhz/868mhz, Infrared communications, BLE, Bluetooth, beacons detection, mi flora, mi jia, LYWSD02, LYWSD03MMC, Mi Scale, TPMS, BBQ thermometer compatibility, SMS & LORA.
Stars: ✭ 2,413 (+457.27%)
Mutual labels:  home-assistant, xiaomi
Ble monitor
Xiaomi Mijia BLE MiBeacon monitor
Stars: ✭ 611 (+41.11%)
Mutual labels:  home-assistant, xiaomi
Xiaomi airconditioningcompanion
Xiaomi Mi and Aqara Air Conditioning Companion integration for Home Assistant
Stars: ✭ 304 (-29.79%)
Mutual labels:  home-assistant, xiaomi
Hass Xiaomi Miot
Auto integrate xiaomi devices by miot-spec for HomeAssistant
Stars: ✭ 93 (-78.52%)
Mutual labels:  home-assistant, xiaomi
Lovelace Xiaomi Vacuum Card
Simple card for various robot vacuums in Home Assistant's Lovelace UI
Stars: ✭ 137 (-68.36%)
Mutual labels:  home-assistant, xiaomi
Python Miio
Python library & console tool for controlling Xiaomi smart appliances
Stars: ✭ 1,995 (+360.74%)
Mutual labels:  home-assistant, xiaomi
xiaomiplug
Xiaomi Mi Smart WiFi Socket integration for Home Assistant
Stars: ✭ 99 (-77.14%)
Mutual labels:  home-assistant, xiaomi
Xiaomi airpurifier
Xiaomi Mi Air Purifier and Xiaomi Mi Air Humidifier integration for Home Assistant
Stars: ✭ 230 (-46.88%)
Mutual labels:  home-assistant, xiaomi
VacuumZones
Control zone cleaning for Xiaomi vacuum cleaners from voice assistants and Home Assistant
Stars: ✭ 39 (-90.99%)
Mutual labels:  home-assistant, xiaomi
Mi Shop
🌈xiaomi mobile mall.
Stars: ✭ 364 (-15.94%)
Mutual labels:  xiaomi
Mi Firmware Updater
Auto generates Xiaomi firmware flashable zip files every MIUI new update
Stars: ✭ 322 (-25.64%)
Mutual labels:  xiaomi
Com.xiaomi Miio
Homey app to control Mi Home devices that implement the miIO protocol and Xiaomi gateway child devices
Stars: ✭ 318 (-26.56%)
Mutual labels:  xiaomi
Magic Cards
🎩 Queue music, play movies, or trigger events with RFID cards.
Stars: ✭ 372 (-14.09%)
Mutual labels:  home-assistant
Simple Thermostat
A different take on the thermostat card for Home Assistant ♨️
Stars: ✭ 357 (-17.55%)
Mutual labels:  home-assistant
Esphome
ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configuration files and control them remotely through Home Automation systems.
Stars: ✭ 4,324 (+898.61%)
Mutual labels:  home-assistant
Xiaomi M365 Firmware Patcher
Automatize patching of Xiaomi Mijia M365 electric scooter firmware
Stars: ✭ 302 (-30.25%)
Mutual labels:  xiaomi

Lovelace Xiaomi Vacuum Map card

hacs_badge Community Forum buymeacoffee_badge paypalme_badge

This card enables you to specify a target or start a zoned cleanup using live or static map, just like in Mi Home app. Additionally you can define a list of zones and choose the ones to be cleaned.

Go to target

Go to target

Zoned cleanup

Zoned cleanup

Defined zones

Defined zones

Configuration options

Key Type Required Default Description
entity string True - ID of Xiaomi vacuum entity
map_image string False - Path to image of map
map_camera string False - ID of map camera entity (for map without root on a vacuum use this integration)
camera_refresh_interval integer False 5 Update interval for map camera in seconds
camera_calibration boolean False - Automatic calibration if camera entity provides calibration_points attribute
calibration_points list False - Pairs of coordinates: in vacuum system and on map image. See: Calibration
zones list False Empty List of predefined zones
modes list False [go_to_target, zoned_cleanup, predefined_zones] List of displayed modes. Possible values: go_to_target, zoned_cleanup, predefined_zones
default_mode string False - Default selected mode. Possible values: go_to_target, zoned_cleanup, predefined_zones
debug boolean False false Enables alerts with coordinates after holding Start button. Possible values: true, false
service string False vacuum.send_command Allows to define service used after clicking Start button. See: Defining service
ignore_zones_limit boolean False false Disables 5 zones limit. Possible values: true, false. See: Defining service
language string False en Language used in the card. Possible values: cz, en, de, dk, es, fi, fr, hu, it, nl, no, pl, pt, ru, se, uk

Example usage:

type: custom:xiaomi-vacuum-map-card
entity: vacuum.xiaomi_vacuum
map_image: '/local/custom_lovelace/xiaomi_vacuum_map_card/map.png'
calibration_points:
  - vacuum:
      x: 25500
      y: 25500
    map:
      x: 466
      y: 1889
  - vacuum:
      x: 26500
      y: 26500
    map:
      x: 730
      y: 1625
  - vacuum:
      x: 25500
      y: 26500
    map:
      x: 466
      y: 1625
zones:
  - [[25500, 25500, 26500, 26500]]
  - [[24215, 28125, 29465, 32175]]
  - [[24245, 25190, 27495, 27940], [27492, 26789, 28942, 27889]]
  - [[28972, 26715, 31072, 27915], [29457, 27903, 31107, 29203], [30198, 29215, 31498, 31215], [29461, 31228, 31511, 32478]]

Installation

  1. Download xiaomi-vacuum-map-card.js, coordinates-converter.js, texts.js and style.js to /www/custom_lovelace/xiaomi_vacuum_map_card directory:
    mkdir -p www/custom_lovelace/xiaomi_vacuum_map_card
    cd www/custom_lovelace/xiaomi_vacuum_map_card/
    wget https://github.com/PiotrMachowski/Home-Assistant-Lovelace-Xiaomi-Vacuum-Map-card/raw/master/dist/xiaomi-vacuum-map-card.js
    wget https://github.com/PiotrMachowski/Home-Assistant-Lovelace-Xiaomi-Vacuum-Map-card/raw/master/dist/coordinates-converter.js
    wget https://github.com/PiotrMachowski/Home-Assistant-Lovelace-Xiaomi-Vacuum-Map-card/raw/master/dist/texts.js
    wget https://github.com/PiotrMachowski/Home-Assistant-Lovelace-Xiaomi-Vacuum-Map-card/raw/master/dist/style.js
    
  2. Add the card to resources in ui-lovelace.yaml or in the raw editor if you are using the frontend UI editor:
    resources:
      - url: /local/custom_lovelace/xiaomi_vacuum_map_card/xiaomi-vacuum-map-card.js
        type: module
    

Calibration

To calibrate this card follow instructions from this guide.

Defining service

You can use a service parameter for example to run a script instead of starting a vacuum directly. Provided service will be run with following parameters:

  • entity_id - id of a vacuum
  • command - one of two:
    • app_goto_target - for Go to target mode
    • zoned_cleanup - for Zoned cleanup and Predefined zones modes
  • params - point or a list of zones (the same value as displayed in debug mode)
WARNING: In the current version of Home Assistant the service vacuum.send_command does not support templates!
To overcome this issue you can use a script and a python script.

Example HA script that can be used with this card is available here.

Hints

  • To find out values for calibration_points you can use the service vacuum.send_command with data:

    {
      "entity_id": "vacuum.xiaomi_vacuum",
      "command": "app_goto_target",
      "params": [25500, 25500]
    }
    

    Alternatively you can use vacuum.xiaomi_clean_zone:

    {
      "entity_id": "vacuum.xiaomi_vacuum",
      "zone": [[25500, 25500, 26500, 26500]],
      "repeats": 1
    }
    
  • You can find out coordinates for zones using two methods:

    • Enabling debug in settings, drawing zone in Zoned cleanup mode and holding Start button. Note: this method also works for other modes.
    • Android App FloleVac
  • To add another language modify file texts.js and set the language parameter in cards configuration.

FAQ

  • Can this card show a live map?

    Yes, to show a camera feed as a background set property map_camera in configuration. To get this feature without rooting your vacuum use this integration.

  • Does this card require rooted device?

    No, it only utilizes features of Home Assistant and not communicates directly with a vacuum.

  • How to create a map?

    You can use any image you want, the easiest way is to use a screenshot from Mi Home/FloleVac or this integration to provide live map without rooting.

Buy Me A Coffee

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].