Skip to content

RinDevJunior/matterbridge-roborock-vacuum-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

135 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Matterbridge Roborock Platform Plugin Logo

Matterbridge Roborock Platform Plugin

npm version npm downloads nodejs ci codecov powered by Matterbridge powered by node-ansi-logger


Matterbridge Roborock Platform Plugin is a dynamic platform plugin for Matterbridge that integrates Roborock vacuums into the Matter ecosystem, enabling control via Apple Home and other Matter-compatible apps.

⭐ If you find this project useful, please consider starring the repository on GitHub:
https://github.com/RinDevJunior/matterbridge-roborock-vacuum-plugin


⚠️ Important Notes

Requires [email protected]

  • Matterbridge must be run in child bridge mode for proper operation.

  • Use one Matterbridge instance per Roborock vacuum.
    If you have more than one vacuum, please run separate instances. Please put the <Vacuum name>-<duid> of device you want to use into whiteList section in the plugin configuration popup.

    More details available here: Discussion #264


🆔 How to Get Your DUID

To get the DUID for your devices, you have two options:

Option 1: From Matterbridge Logs

  1. Start Matterbridge with the plugin enabled.
  2. Watch the Docker console logs directly (not the Matterbridge UI logs, as they may be truncated).
  3. Look for the log message that says:
    Initializing - devices: [...]
    

Option 2: From the Roborock App

  1. Open the Roborock app on your phone.
  2. Go to your Device.
  3. Tap Settings > Product Info.
  4. Find the DID field. The value will look like rr_xxxxxxx.
  5. Remove the rr_ prefix from the DID value. The remaining string is your DUID.

🚧 Project Status

  • Vacuum may appear as two devices in Apple Home
  • Error: Wrong CRC32 2241274590, expected 0 -> this is normal error and not impact to plugin functionality

📋 Apple Home ↔️ Roborock Clean Mode Mapping:
For a detailed table of how Apple Home clean modes map to Roborock settings, see 👉 Apple Home ↔️ Roborock Clean Mode Mapping


📦 Prerequisites

  • A working installation of Matterbridge
  • Compatible Roborock vacuum model (not all models supported yet)

⚙️ Matterbridge setting

Matterbridge Configuration Screenshot

💬 Need Help?

🛠️ Reporting an Issue
Before opening an issue, please make sure to read the instructions here:
📄 How to Report an Issue

💬 Community Support
Join our Discord for support, updates, and community discussions:
👉 Join the Matterbridge Roborock Discord


🧱 Built With

This plugin is built on top of the official dynamic platform example:
🔗 matterbridge-example-dynamic-platform


📸 Screenshot

Screenshot1 Screenshot2

Screenshot3 Screenshot4

Screenshot5

About

A Matterbridge plugin to bring my roborock vacuum to Apple Home

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

 
 
 

Contributors

Languages