Repository files navigation

This custom integration provides a way to present a live view of a map for Xiaomi, Roborock, Viomi, Roidmi and Dreame vacuums.(Supported devices)

This integration can be installed using HACS.To do it search forXiaomi Cloud Map Extractor inIntegrations section.

To install this integration manually you have to downloadxiaomi_cloud_map_extractor.zip and extract its contents toconfig/custom_components/xiaomi_cloud_map_extractor directory:

mkdir -p custom_components/xiaomi_cloud_map_extractorcd custom_components/xiaomi_cloud_map_extractorwget https://github.com/PiotrMachowski/Home-Assistant-custom-components-Xiaomi-Cloud-Map-Extractor/releases/latest/download/xiaomi_cloud_map_extractor.zipunzip xiaomi_cloud_map_extractor.ziprm xiaomi_cloud_map_extractor.zip

After installation of the custom component, it needs to be configured inconfiguration.yaml file.To do so, add a camera entry to your configuration with at least abasic orrecommended configuration.Vacuum token can be extracted by followingthis guide (ignore "not recommended" message, as it applies only to built-in Xiaomi Miio integration).You also need to enter your Xiaomi Cloud username and password.These are the credentials used for the Xiaomi Home app (not ones from Roborock app).

After installation and a reboot of your Home Assistant instance, you should get a camera entity which shows the vacuum map.This might take a few minutes after a first restart.If you have a problem with configuration validation you have to remove camera fromconfiguration.yaml, restart Home Assistant, add camera config and restart HA again.

After modification of camera's configuration you can reload its settings inConfiguration or usingxiaomi_cloud_map_extractor.reload service.

camera:  -platform:xiaomi_cloud_map_extractorhost:!secret xiaomi_vacuum_hosttoken:!secret xiaomi_vacuum_tokenusername:!secret xiaomi_cloud_usernamepassword:!secret xiaomi_cloud_password

camera:  -platform:xiaomi_cloud_map_extractorhost:!secret xiaomi_vacuum_hosttoken:!secret xiaomi_vacuum_tokenusername:!secret xiaomi_cloud_usernamepassword:!secret xiaomi_cloud_passworddraw:['all']attributes:      -calibration_points

camera:  -platform:xiaomi_cloud_map_extractorhost:!secret xiaomi_vacuum_hosttoken:!secret xiaomi_vacuum_tokenusername:!secret xiaomi_cloud_usernamepassword:!secret xiaomi_cloud_passwordcountry:"de"name:"My Vacuum Camera"colors:color_map_inside:[32, 115, 185]color_map_outside:[19, 87, 148]color_map_wall:[100, 196, 254]color_map_wall_v2:[93, 109, 126]color_grey_wall:[93, 109, 126]color_ignored_obstacle:[0, 0, 0, 127]color_ignored_obstacle_with_photo:[0, 0, 0, 127]color_obstacle:[0, 0, 0, 127]color_obstacle_with_photo:[0, 0, 0, 127]color_path:[147, 194, 238]color_mop_path:[255, 255, 255, 0x5F]color_goto_path:[0, 255, 0]color_predicted_path:[255, 255, 0, 0]color_cleaned_area:[127, 127, 127, 127]color_zones:[0xAD, 0xD8, 0xFF, 0x8F]color_zones_outline:[0xAD, 0xD8, 0xFF]color_virtual_walls:[255, 0, 0]color_carpets:[0xA9, 0xF7, 0xA9 ]color_no_carpet_zones:[255, 33, 55, 0x5F]color_no_carpet_zones_outline:[255, 0, 0]color_new_discovered_area:[64, 64, 64]color_no_go_zones:[255, 33, 55, 127]color_no_go_zones_outline:[255, 0, 0]color_no_mop_zones:[163, 130, 211, 127]color_no_mop_zones_outline:[163, 130, 211]color_charger:[0x66, 0xfe, 0xda, 0x7f]color_robo:[75, 235, 149]color_room_names:[0, 0, 0]color_unknown:[0, 0, 0]color_scan:[0xDF, 0xDF, 0xDF]room_colors:1:[240, 178, 122]2:[133, 193, 233]3:[217, 136, 128]4:[52, 152, 219]5:[205, 97, 85]6:[243, 156, 18]7:[88, 214, 141]8:[245, 176, 65]9:[252, 212, 81]10:[72, 201, 176]11:[84, 153, 199]12:[133, 193, 233]13:[245, 176, 65]14:[82, 190, 128]15:[72, 201, 176]16:[165, 105, 18]draw:      -charger      -cleaned_area      -goto_path      -ignored_obstacles      -ignored_obstacles_with_photo      -mop_path      -no_carpet_zones      -no_go_zones      -no_mopping_zones      -obstacles      -obstacles_with_photo      -path      -predicted_path      -room_names      -vacuum_position      -virtual_walls      -zonestexts:      -text:"Room 1"x:25y:25color:[125, 20, 213]      -text:"Room 2"x:25y:75color:[125, 20, 213, 127]font:"FreeSans.ttf"font_size:25map_transformation:scale:2rotate:180trim:top:10bottom:20left:30right:40sizes:charger_radius:4vacuum_radius:6.5path_width:1mop_path_width:16obstacle_radius:3ignored_obstacle_radius:3obstacle_with_photo_radius:3ignored_obstacle_with_photo_radius:3attributes:      -calibration_points      -carpet_map      -charger      -cleaned_rooms      -country      -goto      -goto_path      -goto_predicted_path      -image      -is_empty      -map_name      -mop_path      -no_carpet_areas      -no_go_areas      -no_mopping_areas      -obstacles      -ignored_obstacles      -obstacles_with_photo      -ignored_obstacles_with_photo      -path      -room_numbers      -rooms      -vacuum_position      -vacuum_room      -vacuum_room_name      -walls      -zonesscan_interval:seconds:10auto_update:truestore_map_raw:falsestore_map_image:truestore_map_path:"/tmp"force_api:xiaomi

Each color is represented by a list of 3 or 4 parameters:[red, green, blue] or[red, green, blue, alpha].Each parameter is a number from a range 0-255 and can be also provided as a HEX value: [0x12, 0xAF, 0xC5] matches #12AFC5.

This section contains mapping between room numbers and colors.Each color is represented by a list of 3 or 4 parameters:[red, green, blue] or[red, green, blue, alpha].Each parameter is a number from a range 0-255 and can be also provided as a HEX value: [0x12, 0xAF, 0xC5] matches #12AFC5.

A list of features to be drawn on a map. If all features should be drawn it can be replaced with:

draw:["all"]

Available values:

• charger
• cleaned_area
• goto_path
• ignored_obstacles_with_photo
• ignored_obstacles
• mop_path
• no_carpet_zones
• no_go_zones
• no_mopping_zones
• obstacles_with_photo
• obstacles
• path
• predicted_path
• room_names
• vacuum_position
• virtual_walls
• zones

Each list entry must obey a following schema.You can get a list of available fonts by executing this command:

fc-list| grep ttf| sed"s/.*\///"| sed"s/ttf.*/ttf/"

A list of attributes that an entity should have.Available values:

• calibration_points - Calculated calibration points forLovelace Xiaomi Vacuum Map card.
• carpet_map
• charger
• cleaned_rooms
• country
• goto_path
• goto_predicted_path
• goto
• ignored_obstacles_with_photo
• ignored_obstacles
• image
• is_empty
• map_name
• mop_path
• no_carpet_areas
• no_go_areas
• no_mopping_areas
• obstacles_with_photo
• obstacles
• path
• room_numbers
• rooms
• vacuum_position
• vacuum_room_name
• vacuum_room
• walls
• zones

Camera image is updated every 5s by default.It can be disabled in config usingauto_update property.

You can also disable and enable automatic updates using servicescamera.turn_off,camera.turn_on.

If automatic updates are disabled you can manually trigger update usinghomeassistant.update_entity service.

You can change interval of automatic updates usingscan_interval setting (documentation)

If you want to disable map updates when a vacuum is not running you can usethis blueprint.

This integration was tested on following vacuums:

• Xiaomi map format:
  • rockrobo.vacuum.v1 (Xiaomi Vacuum Gen 1, Mi Robot Vacuum, SDJQR01RR, SDJQR02RR)
  • roborock.vacuum.m1s (Xiaomi Mi Robot 1S)
  • roborock.vacuum.s4 (Roborock S4)
  • roborock.vacuum.s5 (Roborock S5)
  • roborock.vacuum.s5e (Roborock S5 Max)
  • rockrobo.vacuum.s6 (Roborock S6)
  • roborock.vacuum.a08 (Roborock S6 Pure)
  • roborock.vacuum.a10 (Roborock S6 MaxV)
  • roborock.vacuum.a15 (Roborock S7)
  • roborock.vacuum.a19 (Roborocka S4 Max)
  • roborock.vacuum.a27 (Roborock S7 MaxV)
  • roborock.vacuum.a70 (Roborock S8 Pro Ultra)
• Viomi map format:
  • viomi.vacuum.v6 (Viomi Vacuum V2 Pro, Xiaomi Mijia STYJ02YM, Mi Robot Vacuum Mop Pro)
  • viomi.vacuum.v7 (Mi Robot Vacuum-Mop Pro)
  • viomi.vacuum.v8 (Mi Robot Vacuum-Mop Pro)
  • viomi.vacuum.v13 (Viomi V3)
• Roidmi map format:
  • roidmi.vacuum.v60 (Roidmi EVE Plus)
  • viomi.vacuum.v18 (Viomi S9)
  • viomi.vacuum.v38 (Viomi V5 Pro)
  • zhimi.vacuum.xa1 (Lydsto R1)
  • chuangmi.vacuum.hmi707 (IMILAB V1 Vacuum)
• Dreame map format:
  • dreame.vacuum.mc1808 (Xiaomi Mi Mop/Xiaomi Mijia 1C)
  • dreame.vacuum.p2008 (Dreame F9)
  • dreame.vacuum.p2009 (Dreame D9)
  • dreame.vacuum.p2028 (Dreame Z10 Pro)
  • dreame.vacuum.p2029 (Dreame L10 Pro)
  • dreame.vacuum.p2036 (Trouver LDS Cleaner)
  • dreame.vacuum.p2041o (Xiaomi Mop 2 Pro+)
  • dreame.vacuum.p2140 (Mijia Robot Vacuum-Mop 2C)
  • dreame.vacuum.p2157 (MOVA L600)
  • dreame.vacuum.p2259 (Dreame D9 Max)

Whenstore_map_raw: true is added to your config this integration will store a raw map file in/tmp directory.If you don't use Core installation (installation types) you can retrieve this file in the following way:

• InSSH & Terminal add-on enable protected access
• Open terminal and use the following command to copy file:

  docker exec homeassistant bash -c "mkdir -p /config/tmp/ && cp /tmp/map_* /config/tmp/"

• Map file will appear intmp folder in yourconfig folder

To enable debug logging add following section to yourconfiguration.yaml

logger:default:infologs:custom_components.xiaomi_cloud_map_extractor:debug

This integration wouldn't exist without following projects:

• openHAB miIO add-on by@marcelrv
• valeCLOUDo by@Xento
• Xiaomi Robot Vacuum Protocol by@marcelrv
• Valetudo by@Hypfer

If you want to support my work with a donation you can use one of the following platforms:

Platform	Payment methods	Link	Comment
Ko-fi	PayPal Credit card		No fees Single or monthly payment
buycoffee.to	BLIK Bank transfer
PayPal	PayPal		No fees
Revolut	Revolut Credit Card		No fees