Dreame

This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers. For more details and for information how to disable the error reporting see Sentry-Plugin Documentation! Sentry reporting is used starting with js-controller 3.0.

dreame adapter for ioBroker

Adapter for Dreame and MOVA robot vacuums and robot mowers.

Supported brands: Dreame, MOVA (select in adapter settings)

Tested with: L10, L20, X40, A2 1200 (Mower), MOVA 600, MOVA 1000

Installation

Via ioBroker Admin (recommended)

1. Make sure the "Latest" repository is active under Admin → Settings → Repositories
2. Go to the "Adapters" tab and search for "dreame"
3. Click install

The adapter is currently available in the Latest repository. Stable repository inclusion has been requested (see status at https://github.com/ioBroker/ioBroker.repositories/pull/6200).

Via CLI

iobroker install dreame@latest

For adapter development

If you want to contribute to the adapter code itself (not just use it):

git clone https://github.com/TA2k/ioBroker.dreame.git
cd ioBroker.dreame
npm install
npm link

Configuration

MOVA devices (600, 1000) use the same cloud backend as Dreame but with different domains. Select MOVA if you use the MOVA app.

Vacuum (L10, L20, X40, ...)

The adapter creates states for vacuum robots lazily — only properties actually reported by your device appear in the object tree. States fill in gradually after adapter start and after the first polling cycle. The tables below show all known possible states; your device may only report a subset.

Vacuum Status

Consumables

Station Status

Statistics

AutoSwitch Parsed Values

These are parsed from the auto-switch-settings JSON and available as individual states:

Vacuum Remote

AutoSwitch Set Commands

These write directly to the device's AutoSwitch settings (property 4-50):

Actions

Breaking change since 0.3.18: Action states (start-clean, stop, pause, return-to-dock, locate, start-washing, start-auto-empty, clear-warning, and all reset buttons) are now type boolean / role button. Write true to trigger them. Scripts or Vis widgets that previously wrote a string value must be updated.

Room Cleaning

dreame.0.XXXX.remote.start-custom-clean

[
  { "piid": 1, "value": 18 },
  { "piid": 10, "value": "{\"selects\":[[X,1,3,2,1]]}" }
]

X = Room ID. Multiple rooms: {\"selects\":[[X,1,3,2,1],[Y,1,3,2,1]]}

Switch Map

dreame.0.XXXXXXX.remote.customCommand:

{ "siid": 6, "aiid": 2, "in": [{ "piid": 4, "value": "{\"sm\":{},\"mapid\":X}" }] }

X = mapId (see dreame.0.XXXX.status.map-list)

Custom Room Cleaning

The Custom Room Cleaning feature lets you select individual rooms and send the robot only to those rooms, instead of cleaning the entire floor. Suction level and water volume apply globally to all selected rooms.

Step-by-step guide

a) Name your map (optional, recommended for multi-floor households)

When a map is first detected, map.maps.<id>.mapName is created with the placeholder value "Map <id>" (e.g. "Map 1"). This state is directly writable — change the value in the ioBroker object tree to something meaningful, e.g. from "Map 1" to "Ground Floor". The channel name of map.maps.<id> updates automatically as soon as you save the new value. No adapter restart required.

b) Set the active map

Write the map ID (e.g. 1) to remote.custom-room-cleaning.active-map. Only the rooms belonging to that map will be sent to the robot when you trigger start. The named map from step (a) helps you identify which ID corresponds to which floor.

c) Select rooms

Under remote.custom-room-cleaning.map-<id>/, each recognized room appears as a boolean state. The channel and state names show the translated room name from the map (e.g. kitchen, living-room, bathroom). Set the desired rooms to true.

d) Adjust suction level and water volume (optional)

remote.suction-level and remote.water-volume apply to all selected rooms. Set them before triggering start if you want non-default values. These are the same states used for regular cleaning.

e) Start the cleaning run

Set remote.custom-room-cleaning.start to true. The adapter builds the room selection from the active map's checkboxes, sends it to the robot, and resets the start state to false automatically.

Advanced: direct customCommand editing

remote.custom-room-cleaning.customCommand holds the raw selection as a JSON string. You can write it directly if you prefer:

{"selects":[[roomId, repeats, suctionLevel, waterVolume, index], ...]}

Example — kitchen (ID 4) once at strong suction, medium water:

{"selects":[[4, 1, 2, 2, 1]]}

The customCommand and the room checkboxes are bidirectionally synchronized: editing either one updates the other automatically. Writing customCommand directly updates the checkboxes for the active map; ticking a checkbox rebuilds customCommand. Both paths are equivalent.

Known limitations

• Global suction/water only — suction level and water volume are set identically for all selected rooms. Per-room settings (as shown in map.cleanset.*) are not supported by this feature.
• Multi-floor tested with one map — the multi-map structure (one channel group per map) is fully implemented, but only single-map operation has been tested extensively on real hardware. Multi-floor households with two or more maps should work but are not yet verified end-to-end.

Vacuum Shortcuts

Shortcuts (quick commands created in the Dreame app) are parsed from property 4-48 (base64 encoded names). Each shortcut gets its own channel under deviceId.shortcuts.{id}:

Channels are rebuilt automatically on adapter start (not just on the next app-side change) and removed automatically when a shortcut is deleted in the app.

Schedules

Schedules created in the Dreame app (property 8-2) are parsed into one channel per schedule entry under deviceId.schedule.{id}:

Schedule channels are rebuilt automatically on adapter start and removed automatically when a schedule is deleted in the app, same as shortcuts above.

Live Map Widget

The adapter includes a browser-based live map widget: robot position, cleaning trail and cleaned rooms, updating in real time while the robot cleans. It is served directly by this adapter — no vis widget or extra adapter needed, and it's ready to embed as an iframe in vis, Grafana or a custom dashboard.

Setup

• Requires the ioBroker web adapter (any instance) to serve the page.
• Open it at %web_protocol%://%ip%:%web_port%/dreame/ — e.g. http://<your-iobroker>:8082/dreame/. A ready-made link ("Dreame-Map") is on the ioBroker start page and next to this instance in the adapter list.
• Get Map must be enabled (see Configuration) — without it the widget has no data.
• If no map is shown yet, start the adapter once while the robot sits in its dock so the first full map can load.
• Multiple robots on the same instance: the widget shows a device switcher in the header when more than one device is found, or pick one directly with ?did=<did> in the address.

Camera/VSLAM robots are not supported. Devices that navigate by camera instead of lidar (e.g. Mijia 1C/1T, Dreame F9) are not covered by the map widget — it is built and tested for lidar robots only. The adapter logs a warning and the map stays empty for these devices.

Appearance

All appearance settings live in the widget itself — open the gear icon in the top-right corner. Four color modes are available:

Features

• Device switcher in the header for setups with multiple robots
• Customizable layout: sidebar left/right, UI zoom, sidebar width, map rotation
• Panels can be shown or hidden individually (Cleaning, Shortcuts, Station, Maintenance, Water & Mop, Statistics) — some panels additionally let you hide individual rows/tiles inside them (e.g. suction level or moisture on the Cleaning panel)
• Shortcuts panel: one tile per app shortcut, tap to start it directly from the widget
• Schedules button opens a table of all schedules created in the Dreame app (time, weekdays, type, per-room or whole-floor settings) with an on/off switch for each — a schedule pointing at a deleted shortcut shows a locked switch instead of silently doing nothing
• Widget UI is available in German and English, following the ioBroker system language
• Kiosk mode (?gear=0) hides the settings gear — for read-only displays (wall tablets, dashboards)
• Current appearance and panel settings can be exported as a compact link (?cfg=<blob>), for quickly sharing or reusing a setup across multiple embeds without touching the stored configuration
• Tank and mop consumption counters (Water & Mop panel)
• One-click reset back to default appearance and panel settings, independent of the stored adapter configuration

Kiosk / iframe example

Combine ?gear=0 (hide settings) with a ?cfg= link generated in the settings panel to embed a pre-configured, read-only view:

http://<your-iobroker>:8082/dreame/?gear=0&cfg=<blob>

The <blob> is generated by the "Link" section in the widget's settings panel and only affects that browser tab/embed — it never overwrites the settings stored for the widget itself.

Mower (A2, A2 1200, ...)

The adapter supports Dreame robotic mowers with dedicated states and map rendering. States are created lazily — only properties actually reported by your device appear in the object tree.

Mower Status

Position and Task Data (binary protocol, live)

These states are populated from MQTT binary messages and created lazily — they only appear after the mower sends its first binary update.

From robot position packet (siid 1-5):

From device telemetry packet (siid 1-1):

Mower Remote

Mowing Specific Zones

Every mowing area defined on the map is exposed as its own channel under dreame.0.<did>.mower.map.slot<X>.zone<zoneId>. Open ioBroker's Object Browser, navigate to your mower, then to mower.map, and you will see one slot0, slot1, ... per stored map. Each slot contains one zone<N> channel per mowing area — for example slot0.zone1, slot0.zone3. Inside each zone you find name (as shown in the app), area (m²), time, and path.

The numeric part after zone is the zone ID you write into remote.mow-zone. So if the tree looks like this:

dreame.0.<did>.mower.map.slot0.zone1     name = "Front lawn"
dreame.0.<did>.mower.map.slot0.zone3     name = "Back lawn"
dreame.0.<did>.mower.map.slot0.zone5     name = "Side strip"

then:

Single zone — mow "Front lawn":

dreame.0.<did>.remote.mow-zone = "1"

Multiple zones — mow "Front lawn" + "Back lawn" + "Side strip":

dreame.0.<did>.remote.mow-zone = "1,3,5"

JSON form works too — useful from Blockly or JavaScript scripts:

dreame.0.<did>.remote.mow-zone = "[1,3,5]"

Blockly / JavaScript-Adapter example:

setState('dreame.0.' + did + '.remote.mow-zone', '1,3', false);

The mower parses the list, starts mowing the selected zones, and returns to the dock when done. To stop mid-run, press stop-mow (o=2) or pause-mow (o=4). Switching maps first (mow-change-map) is required if the target zones live on a different map — otherwise the zone IDs will not resolve.

Switching the Active Map

If the mower has more than one map, select which map is active before writing zone IDs:

dreame.0.<did>.remote.mow-change-map = 0   // first map
dreame.0.<did>.remote.mow-change-map = 1   // second map

Mower Shortcuts

Shortcuts are parsed from property 4-48 (base64 encoded names). Each shortcut gets its own channel under deviceId.shortcuts.{id}:

Mower History

Cleaning history is fetched from the cloud API (last 20 mow sessions).

Mower Map

Map data is fetched via the Dreame iotuserdata API (not MQTT like vacuums).

Map polling: The map is fetched on adapter start and via the fetchMap button. During active mowing (status 1, 3, 5, 11) the map is automatically polled every 30 seconds to track the mowing path.

Map rendering: Requires the optional canvas npm package. The map shows zones (green), contours (white outlines), mowing path (yellow), forbidden areas (red), and obstacles (red circles).

3D LIDAR Map: Press generate-3dmap to trigger the mower to scan and upload a 3D point cloud map. The downloaded file is a PCD (Point Cloud Data) file that can be viewed with tools like CloudCompare or MeshLab. Progress is tracked in 3dmap-progress. Once complete, the pre-signed download URL is written to 3dmap-url. The URL is temporary and expires after some hours.

Custom Commands for Mower

Via dreame.0.XXXXXX.remote.customCommand:

{
  "siid": 5,
  "aiid": 9,
  "in": [{ "order": 4, "region": [1], "type": "order" }]
}

Known Limitations

Object tree fills in gradually (lazy state creation) States only appear once the device has reported the corresponding property at least once. After a fresh installation or adapter restart, the tree may look incomplete for a few minutes — this is expected behaviour.

L40s Pro Ultra and similar: some states appear only after active use Properties in the SIID 4 group (cleaning-mode 4-23, suction-level 4-4, water-volume 4-5) and SIID 28 (wetness-level 28-1) may only be pushed by the device after an active cleaning session, not during idle polling. These states will not appear until at least one cleaning cycle has completed after the adapter was installed or restarted.

cleaning-mode raw values on some devices Versions before 0.3.18 could report raw compound values (e.g. 5120, 5121, 5122) instead of the documented 0–3 range on some devices, including the L40s Pro Ultra. This was caused by the adapter not decoding a compound-encoded value that combines mode, area and humidity in a single integer. Since 0.3.18 this is decoded correctly. If you still see raw values above 1000 after updating, please open an issue with your model and the raw value you observe.

Translations

State names and descriptions are available in 11 languages: English, German, Russian, Portuguese, Dutch, French, Italian, Spanish, Polish, Ukrainian, and Chinese (simplified).

lib/i18n/en.json is the authoritative source. All other languages are generated from it via npm run translate. Corrections to non-English translations should be submitted as PRs against the respective lib/i18n/<lang>.json file.

Changelog

0.4.10 (2026-09-12)

• Fix: axios bumped to 1.20.0 for upstream security fixes; Node.js built-in requires now use the node: prefix (lib/haDecode.js, lib/mapMerge.js)

0.4.9 (2026-09-12)

• Fix: map.cover type-mismatch log flood during cleaning runs (#141)

0.4.8 (2026-09-12)

• Fix Issue #119 for Dreame L40s / X40 Ultra (r9419*): SIID 4 PIID 6 is remapped to reflect mop-pad presence 1:1, same as r6001a in v0.4.7, based on an isolated pad-remove/reinstall test on an r9419h device in this development cycle. Generalize the mop-in-station / mop-pad-installed fixes from v0.4.7 across all vacuum models: the permanently-0 mop-in-station property is now removed from every vacuum device's object tree at spec load time, and mop-pad-installed is renamed to mop-handling-pulse since it only emits ~1s pulses during mechanical mop handling (state id unchanged so existing user scripts keep working). The frischwasser widget's Mopp-montiert indicator now uses the mop-pad-presence state on models where the REMAP is active — visible after the first cloud poll cycle following the update. Also completes missing UI translations (Issue #122). Thanks to @SilentM1978 and @ralfheitz for confirming the pulse behavior on their devices.

0.4.7 (2026-09-06)

• New tap-to-sequence widget for custom cleaning order directly on the map with room badges, plus a fresh-water/detergent widget for L20 Ultra. Fix Issue #126: clean-water-tank-status bit-mask handling and derived Boolean states for r2253* (L20 Ultra) models. Fix Issue #119: correct mop-pad status on Dreame X60 Pro Ultra Complete (r6001a) via a new model-override layer — removes the dead mop-in-station property, renames the mop-handling pulse, and remaps SIID 4 PIID 6 to actual mop-pad presence on r6001*. Adds status codes 116/117/121/122 (Installing mop, Removing mop, Entering dock, Exiting dock) globally for all vacuum models. Thanks to @SilentM1978 for the detailed live traces that made the r6001a fix possible.

0.4.6 (2026-08-29)

• Attempted fix for issue #124 layer 4 (missing pixel raster on r2253c/r2253w): map background, walls, and room fills were not rendered even though overlays and metadata came through correctly. Adds a fallback to combined_pixel_type when the base pixel raster is empty (matching Home Assistant's renderer), and introduces permanent [MERGE-DEBUG] info-level logging (dimensions, pixel counts, wall/segment counts) so this failure mode is instantly diagnosable if it returns. Models whose base raster is already populated (e.g. r9419h) are unchanged. Thanks to luckyheiko for the pinpoint analysis.

0.4.5 (2026-08-28)

• Fix for issue #124 (Layer 3): map rendering could crash on the frontend when the device reported detected carpets with an invalid polygon field (null or malformed). Adds a filter in lib/mapMerge.js so invalid carpets never reach the frontend, a defensive guard in the carpet drawing routine in www/js/karte/merger.js, and a generic try/catch around overlay drawing so a single bad overlay never breaks the whole map rendering. The unreferenced legacy widget page www/legacy.html, which carried the same bug, is removed. Combined with 0.4.3 (comma-truncation) and 0.4.4 (AES decryption), this closes the full end-to-end map path for r2253c/r2253w. Thanks to luckyheiko for identifying the root cause and proposing the fix approach.

0.4.4 (2026-08-28)

• Fix for issue #124 (Layer 2): map payload for r2253c, r2253w and similar newer Dreame models is AES-256-CBC encrypted; the adapter now derives the AES key from the object_name comma suffix (SHA256, first 32 hex chars as UTF-8), uses a model-specific IV, and decrypts the payload before zlib inflation. Combined with the 0.4.3 comma-truncation fix, this closes the full end-to-end map download path for r2253 models. Also fixes a long-standing bug in lib/dreame.js where the persistent MAP_LIST path used an empty IV instead of the model-specific one. Models without a comma suffix in the object_name (e.g. r9419h/L40s) are unchanged. Thanks to luckyheiko and ralfheitz for the diagnostic logs.

0.4.3 (2026-08-28)

• Fix for issue #124 (HTTP 404 on map download for r2253c, r2253w and similar newer Dreame models where the Dreame backend returns an object_name with a comma suffix that the OSS storage does not resolve): the adapter now transparently retries with the object_name truncated at the first comma. Models without a comma in the object_name (e.g. r9419h/L40s) are unchanged. Diagnostic [MAP-DIAG] logging from 0.4.2 remains but only fires when the fallback also fails; new [MAP-DIAG-2] captures the retry outcome for future analysis.

0.4.2 (2026-08-27)

• Diagnostic release for issue #124 (HTTP 404 on r2253c/L20 Ultra map download): adds temporary [MAP-DIAG] logging on HTTP errors during fresh map downloads (model, did, object_name, download_url, HTTP status, timing, content-type, response body head) to distinguish race, region and object-name-format hypotheses. No functional changes; fallback to persistent MAP_LIST map unchanged. Diagnostic will be reverted in 0.4.3 together with the actual fix.

0.4.1 (2026-08-03)

• Added Schedules: schedules created in the Dreame app are now parsed into schedule.<id>.* states (time, weekdays, type, enabled toggle, per-room or whole-floor settings with translated room names and enum values, linked shortcut for shortcut-type schedules). See Schedules.
• Widget: added a Schedules panel/button showing all schedules in a table with an on/off switch each; schedules pointing at a deleted shortcut show a locked switch instead of silently failing.
• Widget: added a Shortcuts panel — one tile per app shortcut, tap to start it directly.
• Fixed app shortcuts being unavailable on vacuums (previously mower-only); shortcut channels are now rebuilt on adapter restart and cleaned up when deleted in the app.
• Widget: full German/English translation of every panel (Cleaning, Shortcuts, Schedules, Station, Maintenance, Water & Mop, Statistics, Kopf/Fehler status and error text), following the ioBroker system language.
• Widget: individual rows/tiles within a panel can now be hidden, not just whole panels (e.g. hide suction level or moisture on the Cleaning panel).
• Widget: menu width control changed from a slider (which visibly drifted under the pointer while dragging) to a number field with −/+ buttons, matching the existing UI zoom control.
• Widget: fixed a label/input association bug where clicking the "UI zoom"/"Menu width" caption activated the adjacent minus button instead of focusing the field (#104, thanks RicardoHipp).
• Widget: the cleaning-mode tile is no longer locked as soon as any room is selected — testing showed the robot does honour the globally set mode for room cleaning except for the combined vacuum+mop mode (#103, thanks RicardoHipp).
• Widget: removed the unused, never-wired-up Mopp panel placeholder; configVersion bumped 5→6 to clean up any leftover panels.mopp config entry.
• Retyped six MIoT settings from boolean to number (auto-dust-collecting, auto-lds-coverage, clean-carpets-first, silent-drying, hair-compression, mopping-with-detergent) — devices reporting a value outside 0/1 had those silently rejected before. Thanks to krobipd for the analysis.
• Fixed several map.* states logging "has no existing object" on first creation (missing await before the object was created).
• Named 13 previously raw/unnamed status datapoints (mop pad and dirty water tank consumables, firmware/MCU version, cleaning-related flags, camera light, current city, cleaning mode) after cross-checking them against another adapter on the same hardware. Thanks to krobipd.
• Decoded status.error (previously a raw numeric code) into readable, translated text for 98 error codes, cross-checked against two independent sources. Thanks to krobipd.
• Added a fallback so status.state/status.battery-level still populate on models whose regular status poll omits them (e.g. Aqua10 Ultra / r95475). Thanks to krobipd.
• Added remote.go-to-point (x/y/use-current-position/start): send the robot to a stored map coordinate to look around, without cleaning on the way. Thanks to krobipd.
• Added per-device info.online reachability state with one log line per online/offline transition, replacing silent timeout logging.
• Bumped pako (map data compression) from 2.x to 3.x.

0.4.0 (2026-07-31)

• Modular widget rebuild: customizable appearance (light/dark/main-color/custom themes), configurable panels, kiosk mode with URL-based configuration sharing, robot switcher for multi-device setups.

0.3.26 (2026-07-20)

• Fixed stream-status (siid 10001 piid 1) type warning: the value is a streaming-session object, not a number - state declaration corrected to type string / role json, matching the convention used for dnd-task, task-info and zone-status (#82). The boolean type mismatch reported by flapman on remote.auto-dust-collecting, mopping-with-detergent, hair-compression, silent-drying, auto-lds-coverage and clean-carpets-first is already covered by the boolean coercion added in 0.3.25 - please update. Thanks to krobipd for reporting the exact device payload and preparing the fix.

0.3.25 (2026-07-20)

• Fixed room-specific cleaning settings being written to the wrong room (cleanset used RoomOrder instead of the real room id) (#95). Fixed boolean switches being rejected by the device - values are now sent as 1/0 (#94). Fixed adapter reboot loop on devices without a generated map, e.g. MOVA Z70 (#83). Fixed multi-room cleaning only cleaning the first selected room on 5th gen devices. Fixed swapped cleaning modes (vacuum/vacuum+mop) on devices with liftable mop pads. Fixed stream-status type warning (#82). German translation: renamed dining hall segment from Speisesaal to Esszimmer. Thanks to RicardoHipp for reporting and analyzing several of these issues.

0.3.24 (2026-07-01)

• Fixed custom room cleaning bug where switching active-map without touching a checkbox left customCommand holding room IDs from the previously selected map, causing the robot to clean the wrong room (room segment IDs are not unique across maps). customCommand is now rebuilt automatically whenever active-map changes, and is recomputed fresh from the active map's checkboxes immediately before every start as a final safeguard. Start is now aborted with a warning if no room is selected for the active map.

Credits

• TA2k — repository owner and original adapter author
• RicardoHipp — original map renderer this widget's map rendering is based on (MIT licensed)
• Sefina-DS (David) — co-maintainer, widget rebuild, live testing
• Community — krobipd, flapman, volvodani, and everyone else reporting issues and testing devices

License

MIT License

Copyright (c) 2024-2026 TA2k tombox2020@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.