matterbridge-roborock-vacuum-plugin-regions 1.1.1-jb.1

package/.github/workflows/build.yml

@@ -0,0 +1,56 @@
+name: Build, lint and test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [20.x, 22.x, 24.x]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.12.0
+        with:
+          access_token: ${{ github.token }}
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: 'https://registry.npmjs.org/'
+
+      - name: Clean cache
+        run: npm cache clean --force
+
+      - name: Verify Node.js version
+        run: node -v
+
+      - name: Verify Npm version
+        run: npm -v
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Install dependencies
+        run: npm run precondition && npm run deepClean && npm install && npm link matterbridge
+
+      - name: Lint the project
+        run: npm run lint
+
+      - name: Test the project
+        run: npm run test
+
+      - name: Build (optional)
+        run: npm run build

package/.github/workflows/coverage.yml

@@ -0,0 +1,59 @@
+name: Analyze code coverage
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Cancel Previous Runs
+        uses: styfle/cancel-workflow-action@0.12.0
+        with:
+          access_token: ${{ github.token }}
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org/'
+
+      - name: Clean cache
+        run: npm cache clean --force
+
+      - name: Verify Node.js version
+        run: node -v
+
+      - name: Verify Npm version
+        run: npm -v
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Install dependencies
+        run: npm run precondition && npm run deepClean && npm install && npm link matterbridge
+
+      - name: Lint the project
+        run: npm run lint
+
+      - name: Test the project
+        run: npm run test
+
+      - name: Test with coverage
+        run: npm run test -- --coverage
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: RinDevJunior/matterbridge-roborock-vacuum-plugin
+
+      - name: Build (optional)
+        run: npm run build

package/.github/workflows/publish.yml

@@ -0,0 +1,37 @@
+name: Publish to npm
+
+on:
+  push:
+    tags:
+      - '*.*.*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org/'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Install dependencies
+        run: npm run precondition && npm run deepClean && npm install && npm link matterbridge
+
+      - name: Build (optional)
+        run: npm run build
+
+      - name: Run tests
+        run: npm run test
+
+      - name: Publish to npm
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.tarignore

@@ -0,0 +1,5 @@
+**/node_modules
+**/.shouldnotcommit
+**/.git
+**/.DS_Store
+**/webui

package/CHANGELOG.md

@@ -0,0 +1,62 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+---
+
+## [1.1.0-rc15] - 2025-07-26
+### Changed
+- Refactor codebase.
+- Correct LocalNetworkClient connecting process.
+- Update and fix unit tests.
+- Various lint fixes.
+
+## [1.1.0-rc14] - 2025-07-26
+### Added
+- Initialize sync device status via MQTT.
+
+## [1.1.0-rc13] - 2025-07-25
+### Added
+- More unit tests.
+- Increased unit test coverage.
+
+### Fixed
+- Several bugs related to socket connection issues.
+- Improve reconnect logic and cleaning status reporting.
+
+## [1.1.0-rc11] - 2025-07-22
+### Fixed
+- Unable to get room from `get_room_mapping`.
+- Can not get room from `get_multi_maps_list`.
+
+## [1.1.0-rc10] - 2025-07-22
+### Fixed
+- Stop retrying to connect socket when exceeding retry count.
+- Lint and unit test updates.
+
+## [1.1.0-rc09] - 2025-07-20
+### Fixed
+- Do not re-connect MQTT unnecessarily.
+- Reconnect when socket or MQTT is unexpectedly disconnected.
+
+### Enhanced
+- Save user data for subsequent logins.
+- Unit test improvements.
+
+## [1.1.0-rc07] - 2025-07-17
+### Changed
+- Enable server mode fixes.
+- Improved error logging when plugin can't connect to device.
+
+## [1.1.0-rc06] - 2025-07-16
+### Fixed
+- Can not start plugin when server mode is disabled.
+
+## [1.1.0-rc04] - 2025-07-16
+### Added
+- Unit tests.
+- GitHub Actions improvements.
+
+---
+
+**Note:** This changelog includes only the most recent 30 commits. For the full commit history, view more on [GitHub](https://github.com/RinDevJunior/matterbridge-roborock-vacuum-plugin/commits?sort=updated&direction=desc).

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,135 @@
+<p align="center">
+  <img src="./logo.png" alt="Matterbridge Roborock Platform Plugin Logo" width="64" height="64" />
+</p>
+
+<h1 align="center">Matterbridge Roborock Platform Plugin</h1>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/matterbridge-roborock-vacuum-plugin">
+    <img src="https://img.shields.io/npm/v/matterbridge-roborock-vacuum-plugin.svg" alt="npm version" />
+  </a>
+  <a href="https://www.npmjs.com/package/matterbridge-roborock-vacuum-plugin">
+    <img src="https://img.shields.io/npm/dt/matterbridge-roborock-vacuum-plugin.svg" alt="npm downloads" />
+  </a>
+  <a href="https://github.com/RinDevJunior/matterbridge-roborock-vacuum-plugin/actions/workflows/publish.yml/badge.svg">
+    <img src="https://github.com/RinDevJunior/matterbridge-roborock-vacuum-plugin/actions/workflows/publish.yml/badge.svg" alt="nodejs ci" />
+  </a>
+  <a href="https://codecov.io/gh/RinDevJunior/matterbridge-roborock-vacuum-plugin">
+    <img src="https://codecov.io/gh/RinDevJunior/matterbridge-roborock-vacuum-plugin/branch/main/graph/badge.svg" alt="codecov" />
+  </a>
+  <a href="https://www.npmjs.com/package/matterbridge">
+    <img src="https://img.shields.io/badge/powered%20by-matterbridge-blue" alt="powered by Matterbridge" />
+  </a>
+  <a href="https://www.npmjs.com/package/node-ansi-logger">
+    <img src="https://img.shields.io/badge/powered%20by-node--ansi--logger-blue" alt="powered by node-ansi-logger" />
+  </a>
+</p>
+
+---
+
+**Matterbridge Roborock Platform Plugin** is a dynamic platform plugin for [Matterbridge](https://www.npmjs.com/package/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](https://github.com/RinDevJunior/matterbridge-roborock-vacuum-plugin)
+
+---
+
+
+### ⚠️ Important Notes
+
+- **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](https://github.com/Luligu/matterbridge/discussions/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:
+   ```text
+   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.1.7`**
+- ⚠️ **Known Issue:** 
++ 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
++ 
+
+---
+
+
+### ➡️ [See Supported & Tested Roborock Devices](./README_SUPPORTED.md)
+
+
+📋 **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](./README_CLEANMODE.md)
+
+---
+
+### 📦 Prerequisites
+
+- A working installation of [Matterbridge](https://github.com/Luligu/matterbridge)
+- Compatible Roborock vacuum model (not all models supported yet)
+
+---
+
+### ⚙️ Matterbridge setting
+
+<div align="center">
+  <img src="./screenshot/IMG_6.PNG" alt="Matterbridge Configuration Screenshot" style="border-radius: 8px; max-width: 100%; box-shadow: 0 4px 12px rgba(0,0,0,0.1);" />
+</div>
+
+---
+
+### 💬 Need Help?
+
+🛠️ **Reporting an Issue**  
+Before opening an issue, please make sure to read the instructions here:  
+[📄 How to Report an Issue](./README_REPORT_ISSUE.md)
+
+💬 **Community Support**  
+Join our Discord for support, updates, and community discussions:  
+👉 [Join the Matterbridge Roborock Discord](https://discord.gg/favqExHGn4)
+
+---
+
+### 🧱 Built With
+
+This plugin is built on top of the official dynamic platform example:  
+🔗 [matterbridge-example-dynamic-platform](https://github.com/Luligu/matterbridge-example-dynamic-platform)
+
+---
+
+### 📸 Screenshot
+
+<p align="center">
+  <img src="./screenshot/IMG_1.PNG" alt="Screenshot1" width="292" height="633" />
+  <img src="./screenshot/IMG_2.PNG" alt="Screenshot2" width="292" height="633" />
+</p>
+<p align="center">
+  <img src="./screenshot/IMG_3.PNG" alt="Screenshot3" width="292" height="633" />
+  <img src="./screenshot/IMG_4.PNG" alt="Screenshot4" width="292" height="633" />
+</p>
+<p align="center">
+  <img src="./screenshot/IMG_5.PNG" alt="Screenshot5" width="292" height="633" />
+</p>

package/README_CLEANMODE.md

@@ -0,0 +1,29 @@
+# Apple Home RVC Clean Mode Mapping to Roborock Clean Setting
+
+This table shows the mapping between **Apple Home RVC Clean Modes** and the corresponding **Roborock Clean Settings** as defined in `smart.ts` and `default.ts`.
+
+| Apple Home RVC Clean Mode (Key) | Apple Home Mode Name         | Roborock Clean Mode | suctionPower (enum value) | waterFlow (enum value) | distance_off | mopRoute (enum value) |
+|:-------------------------------:|:-----------------------------|:--------------------|:--------------------------|:----------------------|:------------:|:---------------------:|
+| 4 *(smart only)*                | Mop & Vacuum: Automatic      | Smart Plan          | 0                         | 0                     | 0            | Smart (306)           |
+| 5                               | Mop & Vacuum: Day (Automatic)| Vac & Mop           | Balanced (102)            | Medium (202)          | 0            | Standard (300)        |
+| 6                               | Mop & Vacuum: Quick          | Vac & Mop           | Balanced (102)            | Medium (202)          | 0            | Fast (304)            |
+| 7                               | Mop & Vacuum: Max            | Vac & Mop           | Max (104)                 | Medium (202)          | 0            | Standard (300)        |
+| 8                               | Mop & Vacuum: Min            | Vac & Mop           | Balanced (102)            | Low (201)             | 0            | Standard (300)        |
+| 9                               | Mop & Vacuum: Quiet          | Vac & Mop           | Quiet (101)               | Medium (202)          | 0            | Standard (300)        |
+| 10                              | Mop & Vacuum: LowEnergy      | Custom              | Custom (106)              | Custom (204)          | 0            | Custom (302)          |
+| 31                              | Mop: Default                 | Mop                 | Off (105)                 | Medium (202)          | 0            | Standard (300)        |
+| 32                              | Mop: Max                     | Mop                 | Off (105)                 | High (203)            | 0            | Standard (300)        |
+| 33                              | Mop: Min                     | Mop                 | Off (105)                 | Low (201)             | 0            | Standard (300)        |
+| 34                              | Mop: Quick                   | Mop                 | Off (105)                 | Medium (202)          | 0            | Fast (304)            |
+| 35                              | Mop: DeepClean               | Mop                 | Off (105)                 | Medium (202)          | 0            | Deep (301)            |
+| 66                              | Vacuum: Default              | Vacuum              | Balanced (102)            | Off (200)             | 0            | Standard (300)        |
+| 67                              | Vacuum: Max                  | Vacuum              | Max (104)                 | Off (200)             | 0            | Standard (300)        |
+| 68                              | Vacuum: Quiet                | Vacuum              | Quiet (101)               | Off (200)             | 0            | Standard (300)        |
+| 69                              | Vacuum: Quick                | Vacuum              | Balanced (102)            | Off (200)             | 0            | Fast (304)            |
+| 99                              | Mop & Vacuum: Vacation       |                     |                           |                       |              |                       |
+
+**Notes:**
+- The values in parentheses are enum values from `VacuumSuctionPowerSmart`/`VacuumSuctionPower`, `MopWaterFlowSmart`/`MopWaterFlow`, and `MopRouteSmart`/`MopRoute` in `smart.ts` and `default.ts`.
+- Key 4 ("Smart Plan") is only available on some new vacuums.
+- This mapping helps you understand how Apple Home clean modes correspond to Roborock's internal cleaning settings for both "smart" and "default" behaviors.
+- Key 99 is a tricky mode to support go to charge in Apple Home Automation

package/README_DEV.md

@@ -0,0 +1,75 @@
+# How to Implement a New Device
+
+Follow these steps to add support for a new device:
+
+---
+## 0. Precondition
+- Matterbridge must be run at childbridge mode
+
+## 1. Check the Model
+
+- Open [`src/roborockCommunication/Zmodel/deviceModel.ts`](src/roborockCommunication/Zmodel/deviceModel.ts).
+- If your model does not exist, **create a new entry** for it.
+
+---
+
+## 2. Create a New Behavior Folder
+
+- Create a new folder under [`src/behaviors/roborock.vacuum`](src/behaviors/roborock.vacuum) named after the market name of your vacuum.
+- Inside this folder:
+  - **Create a `initalData.ts` file**  
+    _Example:_ [`src/behaviors/roborock.vacuum/smart/initalData.ts`](src/behaviors/roborock.vacuum/smart/initalData.ts)
+    This file defines functions that return initial data for your device. (You can inherit from default or create your own)
+  - **Create an `runtimes.ts` file**  
+  _Example:_ [`src/behaviors/roborock.vacuum/smart/runtimes.ts`](src/behaviors/roborock.vacuum/smart/runtimes.ts)
+    In case you define your own initial data. Create new method that override the default method.
+  - **Create an `abcyxz.ts` file**  
+  _Example:_ [`src/behaviors/roborock.vacuum/smart/smart.ts`](src/behaviors/roborock.vacuum/smart/smart.ts)
+    Define matterbridge command handler logic to sending requests to control your vacuum (start, pause, resume, go home, etc.).
+    (Use in step 4)
+
+---
+
+## 3. Register Your Initial Functions
+
+- Add your initial functions to the following files:
+  - [`src/initialData/getSupportedCleanModes.ts`](src/initialData/getSupportedCleanModes.ts)
+  - [`src/initialData/getSupportedRunModes.ts`](src/initialData/getSupportedRunModes.ts)
+  - [`src/initialData/getOperationalStates.ts`](src/initialData/getOperationalStates.ts)
+
+***_In somecase, you may need to update whole function to support switch case_***
+---
+
+## 4. Update the Behavior Factory
+
+- Add a new `switch` case to [`src/behaviorFactory.ts`](src/behaviorFactory.ts).
+  - This is where you set the behavior handler for your device.
+
+---
+
+## 5. Build and Run
+
+```sh
+sudo npm run precondition
+sudo npm run deepCleanBuild
+sudo npm run matterbridge:add
+sudo npm run start:roborock
+```
+---
+
+## 6. Current issue
+- Device show twice in Apple Home
+- Device information shows incorrectly in Apple Home (Device name, firmware ....)
+- Play Sound to Locate (Apple Home) not working
+- Showing wrong location during opration
+
+## 7. Not Tested
+- Clean selected room
+
+## 8. TODO
+- correct state_to_matter_state
+
+## 9. Build package
+```sh
+cd .. && tar -czvf matterbridge-roborock-vacuum-plugin-1.0.1-rc02.tgz matterbridge-roborock-vacuum-plugin && cd matterbridge-roborock-vacuum-plugin
+```