dreame-vacuum Home Assistant Integration

Second-generation robots and newer devices use P-type (Partial) maps. Unlike standard I-type maps, P-type maps only contain the differences from the previous frame.

This integration supports P-type decoding to provide a three-second refresh rate with a three-second delay, matching the performance of the official App. Note that Valetudo does not parse P-frames and instead requests new map refreshes.

When the robot is performing fast mapping or spot cleaning, it creates a new map in its local memory. During this state:

• The robot does not respond to local map_request API actions.
• The newly created map does not have an object name yet and can only be accessed via the cloud map_data property.
• These maps require specific decoding and rendering rules different from standard maps.

The integration manages room entities for customized cleaning settings, which are available on firmware version 1156 or later.

Key Behaviors:

• Customized Cleaning Mode: If enabled, the robot uses these specific room settings for both cleaning and custom segment cleaning jobs. These settings cannot be overridden by start action parameters.
• Dynamic Entity Updates: Room settings are stored on the current map data. Because only selected map settings are accessible via the cloud API, the integration dynamically updates room entity names and icons whenever the selected map is changed.
• Map Availability: The integration exposes rooms from all saved maps, but updates their availability state based on the currently selected map.

The integration provides reverse-engineered support for Valetudo map data generation.

Note on behavior: The Valetudo map card uses its own color index algorithm, does not render room icons or names, and ignores the map rotation setting from the map data. However, it allows for faster image generation because rendering occurs in the browser.

The integration tracks specific device properties and generates persistent notifications in Home Assistant, mimicking the behavior of the official Dreame app.

Note: You can enable or disable this notification feature within the integration settings in Home Assistant.

You can manage all room settings (names, icons, suction, water/mop settings) using a single consolidated card. This requires two custom Home Assistant Lovelace cards:

1. config-template-card
2. multiple-entity-row

To use the provided template, you must update the vacuum_entity variable with your specific vacuum's entity ID (e.g., vacuum.dreame_l10s_ultra).

{# ----------------- PROVIDE YOUR OWN ENTITY ID AND ROOM COUNT HERE ----------------- #}
{% set vacuum_entity = "vacuum." %} 
{# ... rest of the template ... #}

You can install the Dreame vacuum integration for Home Assistant using two methods:

Via HACS (Recommended)

Search for dreame-vacuum in the Home Assistant Community Store (HACS).

Manually

Run the following command in your terminal to download and install the integration:

wget -O - https://raw.githubusercontent.com/Tasshack/dreame-vacuum/master/install | bash -

To set up the Dreame Vacuum integration in Home Assistant, follow these steps:

1. Navigate to Settings -> Devices & Services -> Add Integration.
2. Search for and select Dreame Vacuum.
3. Choose your preferred configuration type (e.g., Cloud or Local, depending on the UI options provided).
4. Enter the required credentials for your selected configuration type.
5. Set your device name and integration settings (such as notification preferences or map color schemes).

Important: Ensure that your devices are on the same subnet for both configuration types to avoid connectivity issues.

You can customize the map's visual density and style through the integration configuration options.

Selectable Icon Sets:

• Dreame: Official Dreame App icons.
• Dreame Old: Icons from older VSLAM robot versions.
• Mijia: Official Mijia App icons.
• Material: Material Design icons.

Hidden Map Objects (Configurable): You can disable specific elements to declutter the map, including:

• Room details: Colors, Icons, Names, Order, Suction Level, Water Volume, Cleaning Times, and Cleaning Mode (device dependent).
• Map elements: Path, No Go Zones, No Mop Zones, Virtual Walls, Active Areas, Active Points, Carpet Areas (not supported yet), and Cleaning Direction (not supported yet).
• Icons: Charger Icon, Robot Icon, AI Obstacle, and Cleaning Direction.