README.md

June 18, 2026 · View on GitHub

Matterbridge Roborock Platform Plugin Logo

Matterbridge Roborock Platform Plugin

npm version npm dev version typescript esm npm downloads nodejs ci codeql Codecov powered by Matterbridge styled with prettier linted with eslint 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 matterbridge@3.9.0

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

  • By default, one Matterbridge instance supports one Roborock vacuum. If you have more than one vacuum, you can either:

    • Run separate Matterbridge instances (one per vacuum), or
    • Enable Server Mode in the plugin configuration — this allows a single Matterbridge instance to host multiple vacuums at once.
  • To control which device(s) are exposed, add their DUID(s) to the White List in the plugin configuration. If the list is empty, all supported devices are exposed (limited to one unless Server Mode is enabled).

    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

  • Under active development
  • Requires matterbridge@3.7.3

➡️ See Supported & Tested Roborock Devices

📋 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