Xiaomi Cloud Map Extractor
A Home Assistant custom integration to display live maps for Xiaomi, Roborock, Viomi, Roidmi, and Dreame robot vacuums without rooting.
What is Xiaomi Cloud Map Extractor?
Xiaomi Cloud Map Extractor is a custom integration for Home Assistant that provides a live map view for compatible robot vacuums. It extracts map data directly from the Xiaomi cloud, allowing users to see cleaning progress, room layouts, and vacuum location in real-time without requiring rooted devices. The integration solves the problem of limited or absent native map support in Home Assistant for these vacuum brands.
Home Assistant users who own Xiaomi, Roborock, Viomi, Roidmi, or Dreame robot vacuums and want to integrate detailed, live mapping into their smart home dashboard for monitoring and automation.
Developers choose this integration because it offers a no-root, cloud-based solution with extensive customization options, real-time updates, and compatibility with a wide range of vacuum models, enhancing Home Assistant's vacuum control capabilities beyond basic controls.
Overview
This custom integration provides a way to present a live view of a map for Xiaomi (Roborock/Viomi/Roidmi/Dreame) vacuums without a need for rooting.
Use Cases
Best For
- Displaying a live vacuum map in Home Assistant Lovelace
- Creating automations based on vacuum location or room cleaning status
- Visualizing cleaning paths and zones for Roborock or Xiaomi vacuums
- Integrating vacuum maps with custom Lovelace cards like Xiaomi Vacuum Map Card
- Monitoring multiple robot vacuum brands in a unified interface
- Storing and analyzing raw vacuum map data externally
Not Ideal For
- Users with robot vacuums from unsupported brands like iRobot or Neato
- Environments requiring offline-only operation due to unreliable internet or privacy policies
- Those seeking a plug-and-play integration with zero credential extraction or complex YAML configuration
- Projects where cloud service dependencies are unacceptable due to data sovereignty concerns
Pros & Cons
Pros
Supports vacuums from Xiaomi, Roborock, Viomi, Roidmi, and Dreame using multiple map formats, as evidenced by the extensive tested devices list in the README.
Offers extensive configuration for colors, drawn elements, room colors, and text overlays, allowing precise control over map appearance, detailed in the colors and draw configuration sections.
Exposes rich entity attributes like vacuum position, cleaned rooms, and zones, enabling advanced automations and integration with Lovelace cards, as shown in the attributes configuration.
Provides configurable scan intervals, manual update triggers, and automations to disable updates when docked, giving users fine-grained control over map refreshing, detailed in the updates section.
Cons
Requires extracting a vacuum token and Xiaomi cloud credentials, which involves non-trivial steps like following an external guide, and the README warns about configuration validation issues needing restarts.
Relies on Xiaomi cloud servers, introducing potential points of failure from API changes, downtime, or regional restrictions, and raises privacy concerns as credentials are stored locally but transmitted externally.
The full configuration example is overwhelming with numerous options, and the README explicitly cautions against copying it recklessly, which can lead to errors for inexperienced users.
Frequently Asked Questions
Related Projects
Sonoff LANControl Sonoff Devices with eWeLink (original) firmware over LAN and/or Cloud from Home Assistant
WebRTC CameraHome Assistant custom component for real-time viewing of almost any camera stream using WebRTC and other technologies.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.