Part 1: How to Setup & Configure Roborock S7 with Home Assistant

by Danny
25 comments

READING TIME: 9 MINUTES

In this guide, I’ll show you how to setup and configure the Roborock S7 in Home Assistant. The Roborock S7 is easily one of the best robot vacuum/mop combo’s for Home Assistant in 2021/2022. I won’t go into all the features, but a full list is available on their Amazon product page.

Once it’s setup and added to Home Assistant, the possibilities are endless. You can create automations to run at certain days or times, scheduled daily vacuuming if away from home, pick individual rooms to vacuum, or simply view the stats & status of it – battery level, cleaning count, etc.

In Part 1 (this guide), I’ll show you:

  • First time setup
  • Connecting to MiHome App
  • Extracting the token (for use with a Lovelace card)
  • Adding Roborock S7 to Home Assistant
  • Adding the Xiaomi Lovelace cards

In Part 2, I’ll show you:

  • How to customize your Vacuum map card to include clickable zones
  • How to add text/icons for rooms on Vacuum Map Card
  • How to create a dropdown menu of rooms you can instruct your vacuum to clean or go to

In Part 3, I’ll show you:

  • How to configure with Google Assistant to send voice commands
  • Example automations & scheduling

In Part 4, I’ll show you:

  • How to control Roborock S7 mopping in Home Assistant.

In Part 5, I’ll show you:

  • How to vacuum multiple rooms in an automation (by calling each script.vacuum_xyz script). This allows you to select the order and schedule vacuuming for as many rooms as you’d like.

In Part 6, I’ll show you:

  • A super clean, compact vacuum & mop control card

Let’s get started!

Sale
roborock S7 Robot Vacuum and Mop, 2500PA Suction & Sonic Mopping, Robotic Vacuum Cleaner with Multi-Level Mapping, Works with Alexa, Mop Floors and Vacuum Carpets in One Clean, Perfect for Pet Hair
  • Roborock S7 robot vacuum is the Winner of 17 Best of CES 2021 Awards, from Business Insider, Digital Trends, Newsweek, How To Geek, and many more. Please be aware products purchased from non-authorized channels are not covered by the official warranty.
  • Sonic Mopping Technology. Roborock S7 robot vacuum mops with the power of sound, scrubbing up to 3,000 times per minute. Fed by a 300 ml electronic water tank, stains from coffee to mud and more can be cleaned deeply and effectively.

Step 1: Unbox and Charge

The first thing you’ll want to do in unbox everything and plug in your dock. Mine arrived with about 40% charge initially.

Locate the silver charging ports on the bottom of the robot and place it on the dock. Once plugged in, the light on the top should flash green and the vacuum will verbally tell you it’s “charging”.

Next, open the lid. If your wifi status light is already blinking blue, you are ready for Step 2: Adding to the MiHome app.

If yours is not blinking, press the “Spot Clean” and “Dock” buttons at the same time until you hear the “resetting wifi” voice alert. Then proceed with Step 2.


Step 2: Download MiHome App

Download the MiHome app from the Google Play or Apple App store. (The instructions tell you to download the Roborock app, but if you do that, you won’t be able to extract the token.)

Accept the ToS, choose your country, and then create your MiHome account. Make note of the username and password as you’ll need that for the token extraction step.

Once logged in, click Add a device:

It should autodetect it.

Then, connect it to your wifi network.

Then, pick a room where your robot vacuum will be docked at.

Then, look through the app settings.

  • Rename your device under Robot Settings. I named mine Rosie (Get it, Rosie the Robot from the Jetsons?)
  • Under Manage Maps, enable Map Saving.

Step 3: Retrieve Xiaomi Cloud Token

Next, we need to retrieve the Xiaomi token. This is needed so we can view the cleaning map we see in the MiHome app inside Home Assistant.

Navigate here: https://github.com/PiotrMachowski/Xiaomi-cloud-tokens-extractor

I’m using Windows 11 so I ran the token_extractor.exe, but you can also use this tool with docker, python, or linux.

Run the program after downloading. If using Windows, you’ll see a blue Windows Smartscreen message which is normal (just means the program hasn’t been digitally signed). Click More info and Run Anyway.

In the black box that pops up, enter your MiHome:

  • Username (UserID found in Profile in the MiHome app)
  • Password
  • Server (leave empty)

If the info was added correctly, you’ll see your Roborock’s token and IP address:

Quick Note: If you only want to add the vacuum to Home Assistant and don’t plan on using the Lovelace card to manage it, you don’t need the token. You just need the MiHome username and password.

If you plan on adding the Xiaomi Vacuum Map Card to control your Roborock from Lovelace, then you’ll need it.


Step 4: Add to Home Assistant

Now that you’ve retrieved the token and IP address, you can add it to Home Assistant. We are going to use the built-in Xiaomi miio integration for this.

Open Home Assistant. Go to Configuration > Integrations and search for Xiaomi Miio.

Enter your username, password, country, and then check the box for Configure Manually. Then click Submit.

Again, if you aren’t going to use the map card, then you don’t need to configure manually.

Enter the IP address and token:

Then choose a room and click Finish.


Step 5: Enable Disabled Entities

Go to Configuration > Devices and search for your vacuum.

Enable any entities that weren’t enabled by default. Some disabled ones you might want are Total Clean Count, Total Clean Area, and Total Duration. I enabled them all.


Install Xiaomi Cloud Map Extractor Integration

Before you can add the Lovelace map card, you need to add Xiaomi Cloud Map Extractor to Home Assistant. This will import the map from you MiHome app so you can view it in Lovelace by creating a camera: entity.

Assuming you have HACS installed, just open HACS > Integrations and search for Xiaomi Cloud Map Extractor.

In the bottom right corner, click Download this repository in HACS. After it’s downloaded, restart Home Assistant from Configuration > Settings > Server Controls.

Then, open File Editor > Configuration.yaml and add either the Basic or Recommend camera config (I used the Recommended one). If you aren’t using a !secrets file yet, you can just hardcode the values for now.

Basic:

camera:
  - platform: xiaomi_cloud_map_extractor
    host: !secret xiaomi_vacuum_host
    token: !secret xiaomi_vacuum_token
    username: !secret xiaomi_cloud_username
    password: !secret xiaomi_cloud_password

Recommended:

camera:
  - platform: xiaomi_cloud_map_extractor
    host: !secret xiaomi_vacuum_host
    token: !secret xiaomi_vacuum_token
    username: !secret xiaomi_cloud_username
    password: !secret xiaomi_cloud_password
    draw: ['all']
    attributes:
      - calibration_points 

Restart Home Assistant again. Then go to Configuration > Entities and search for “camera”. You should see a new entity camera.xiaomi_cloud_map_extractor.


Add Xiaomi Vacuum Map to Lovelace

Now that you have your camera entity, install the Xiaomi Vacuum Map card.

  1. Open HACS
  2. Click the Frontend section
  3. Click the “+” button
  4. Search for “Xiaomi Vacuum Map” and install
  5. Reload

Then, navigate to one of your Lovelace dashboards.

Add Card > Search for “xiaomi”. It will look like this:

To use the card, you can either click the “Zone Cleanup” option and drag over an area that you’d like to clean, or “Pin & Go”, where you can just tell your roborock to go to a specific location.

I use the pin & go feature if I’m being lazy and want Rosie to meet me at the trash can.


Wrapping Up

That’s it! You have now successfully added your Roborock 7 vacuum to Home Assistant, as well as added some really nice Lovelace cards to manage it. This guide can also be followed for previous Roborock versions including Roborock 5, Roborock 6, etc.

I also wanted to point out that this vacuum now has an optional Auto-Empty Dock:

roborock Auto-Empty Dock, Automatic Dust Collection, 3L Dust Bag Holds up to 60 Days of Dust, App-Controlled, Suitable S7, S7MaxV Robot Vacuum, Black
  • Automatic Dust Collection: Dust is automatically emptied after a cleanup, turning dustbin emptying from often to occasional.
  • Dust Bag Support: Empty the bin without making a mess while keeping the dustbin clean. The large-capacity 3L bag holds up to 120 Days of Dust(Spare 1 Dust Bag Included).

The only downside (so far) of adding this vacuum to Home Assistant is that mopping isn’t yet supported in Home Assistant. To schedule mopping, you’ll need to use the MiHome app. You can now control Roborock mopping from Home Assistant – follow this guide!

Make sure to follow all parts 1-4 (links at the very top of this guide), where I show you how to define zones vacuum “zones”. So, rather than having to drag over a room to vacuum it – you can simply click a room on the Lovelace map. I’ll also show you some neat automations I’ve set up as well as how I’ve configured it to work with Google Assistant to manage Rosie using voice commands.


My Favorite Home Assistant Devices

Below are some of the Home Assistant-compatible devices I personally use in my home. I highly recommend each of them.

The full list of all Home Assistant compatible & recommended devices I use can be found on my Equipment List page.

25 comments

You may also like

25 comments

Paladine January 4, 2022 - 9:39 am

Thanks for great guide! Eagerly waiting for part 2 if I get my rooms working in that camera view as well 🙂 Seems like map extractor pulled SOME rooms right that I have on Xiaomi Mi app, but not all, and none of them are named.

Reply
Danny January 4, 2022 - 11:53 am

I do have a Part 2 created, but it doesn’t include rooms from the MiHome app: https://smarthomepursuits.com/roborock-s7-home-assistant-customize-map-card-create-zone-automations/ I basically created my own rooms in Home Assistant. But I am working on a guide for MiHome rooms to Home Assistant today; I’ll comment back once that’s complete.

Reply
Scott January 16, 2022 - 8:58 pm

Through this setup, would you recommend creating all maps first or will this integration pull maps when added? I’ve run the initial map but have a room with steps that I use the vacuum in as well as upstairs.

Reply
Danny January 18, 2022 - 12:00 am

Hey Scott,

I would try to do the mapping first, but I don’t think it really matters. I got about 75% of the mapping done before adding to HA. A few weeks later I mapped the rest and the updated map was successfully pulled into Home Assistant.

Reply
ThatGuy January 24, 2022 - 10:42 pm

Does my roborock vacuum need to be on the same network as my HA server? I have a primary network that my HA server is connected to, but my vacuums are on a separate guest network for security reasons. Some of my cloud based iOT devices don’t seem to care about this, but I’m getting a red error icons for both my S5 and S4 Max and wonder if that’s why it’s not completely working. Any suggestions?

Reply
Danny January 24, 2022 - 11:04 pm

I’m honestly not sure since I have mine on the same network. But I would guess having it on a separate VLAN could cause some issues.

Reply
Danny January 24, 2022 - 11:12 pm

As a quick test you could try connecting it to your main wifi and see: https://forum.roborock.com/discussion/2266/roborock-s6maxv-how-to-update-wifi-settings

Reply
Peter January 30, 2022 - 6:01 pm

Great guide! Do you know if it is possible to have the robot in MiHome app and Roborock app at the same time? Or do I need to move over to MiHome for this to work?

Reply
Danny January 30, 2022 - 11:00 pm

From what I’ve read, you’ll need to unpair it from the Roborock app and set it up through MiHome instead.

Reply
Michael February 4, 2022 - 1:30 am

Fantastic guide! Do you know if it is possible to change the maps in HA instead of going through the Mi Home? Since I have multiple levels in the house and I have 3 maps saved in Mi Home.

Reply
Lance February 28, 2022 - 1:56 pm

Hi Danny. Great guide! Do you know if this integration would also work with the newer Roborock S7 MaxV Ultra model?

Reply
Danny March 3, 2022 - 9:54 am

Hey Lance, I don’t see why it wouldn’t work! If the S7 works, the S7 Max should add as well.

Reply
Lance May 14, 2022 - 2:55 am

Thanks Danny! I was indeed able to integrate my S7 Max V Ultra to Home Assistant.

Reply
Danny May 14, 2022 - 4:40 pm

You’re welcome! I’m glad to hear things still work with the newer version.

Reply
Dave March 3, 2022 - 9:06 am

I tried to add the map extractor and it refused to validate config.yaml saying that the value for the token was too long.
I don’t have a !secrets file yet so I pasted the values direct into config.yaml

Reply
Danny March 3, 2022 - 9:55 am

Hey Dave, I didn’t run into that issue, but you could try setting up secrets. It’s super easy and would take maybe 5 minutes. Here’s my guide on setting up secrets if you’d like to try it out: https://smarthomepursuits.com/how-to-store-secrets-in-home-assistant/

Reply
Dave March 4, 2022 - 5:38 am

Hi Danny, as soon as I looked at the how to set up secrets page I realised what I’d done wrong, so thanks 🙂

Reply
davidk. May 26, 2022 - 4:04 am

What is the “host” or “xiaomi_vacuum_host”?

Reply
Danny May 27, 2022 - 10:38 am

The host is the IP address of your Roborock.

Reply
Ron June 25, 2022 - 9:25 am

TY a ton for writing this, it was quite helpful and helped me quite a bit

Reply
Eric July 25, 2022 - 10:07 pm

This guide is great!

I have made it through Part 1 and everything is working. However, I have rotated my map in the MiHome app to orient as I like. That orientation will not show up in the lovelace card. Any ideas on how to rotate the orientation in HA so it shows up similar to the MiHome app?

Reply
Danny July 25, 2022 - 10:59 pm

Thank you!

I don’t have a need to rotate mine, but there are some promising suggestions in this community post: https://community.home-assistant.io/t/vacuum-interactive-map-card/123901/865

Reply
kenneth August 26, 2022 - 4:44 pm

hello great guide got everything but can’t get the card when i go to add the card its just not there not sure whats going on with this any help would be great thanks

Reply
bala November 11, 2022 - 1:20 pm

after setup do i still need MiHome app, can i removed and reconnect with Roborock app?

Reply
Danny November 11, 2022 - 2:44 pm

I don’t know if it still needed, I kept it but rarely use it. The only things I really use it for are forcing it to empty the bin (if you have the auto empty dock) and for maintenance/cleaning tracking of the parts.

Reply

Leave a Comment