homebridge-roborock-matter 2.9.3 → 2.9.5

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 2.9.5
+
+- **One synchronous disk write per received robot message eliminated.** The per-device diagnostics states (last cloud/local message, transport history) were flushed to disk with a blocking `fs.writeFileSync` on EVERY message a robot pushed — every few seconds per robot while cleaning. They are served from memory (the settings UI never reads the file); the on-disk copy only needs to survive restarts. Disk flushes for these two states are now debounced to at most once per minute, with a guaranteed flush on shutdown. Result: event-loop stalls removed from the message hot path, and meaningfully less SD-card wear on Raspberry Pi installs. Critical states (credentials, HomeData, room caches) still persist immediately.
+- Full suite: 263 passing (3 new persistence-debounce tests).
+
+## 2.9.4
+
+Startup-cost cleanup release (also refreshes the npm README with the Donate button and the prominent Verified badge).
+
+- **Two fewer RSA-2048 key generations at every startup.** The MQTT connector generated a protocol keypair that nothing ever read (removed), and the message layer generated its keypair eagerly even though it is only needed for the rare photo request path on camera-equipped models (now created lazily on first use). Measured ~50 ms per keygen on fast hardware — substantially more on a Raspberry Pi.
+- Removed dead code: the never-called `decryptWithPrivateKey` helper and the unused `scenesData` field (both HomeKit-era leftovers).
+
 ## 2.9.3
 
 **The plugin is now Verified by Homebridge!** 🎉 Reviewed and endorsed by the Homebridge team (homebridge/plugins#1124), with specific praise for the encrypted at-rest session storage, the preserved fork attribution, and the per-release notes.

package/README.md

@@ -9,7 +9,6 @@
 </p>
 
 <p align="center">
-  <a href="https://github.com/homebridge/homebridge/wiki/Verified-Plugins"><img src="https://img.shields.io/badge/homebridge-verified-blueviolet?color=%23491F59&style=flat" alt="verified-by-homebridge"></a>
   <a href="https://www.npmjs.com/package/homebridge-roborock-matter"><img src="https://img.shields.io/npm/v/homebridge-roborock-matter?label=npm&color=cb3837" alt="npm version"></a>
   <a href="https://www.npmjs.com/package/homebridge-roborock-matter"><img src="https://img.shields.io/npm/dt/homebridge-roborock-matter?label=downloads&color=8a5cf5" alt="npm downloads"></a>
   <a href="https://github.com/mathiashornbek/homebridge-roborock-matter/actions"><img src="https://img.shields.io/github/actions/workflow/status/mathiashornbek/homebridge-roborock-matter/nodejs.yml?label=CI" alt="CI status"></a>
@@ -18,6 +17,14 @@
   <a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" alt="MIT license"></a>
 </p>
 
+<p align="center">
+  <a href="https://paypal.me/MathiasHornbek"><img src="https://img.shields.io/badge/PayPal-Donate-00457C?logo=paypal&logoColor=white" alt="Donate via PayPal"></a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/homebridge/homebridge/wiki/Verified-Plugins"><img src="https://img.shields.io/badge/homebridge-verified-blueviolet?color=%23491F59&style=for-the-badge&logoColor=%23FFFFFF&logo=homebridge" alt="Verified by Homebridge"></a>
+</p>
+
 ---
 
 Log in with your **Roborock app account** — no token extraction, no rooted apps, no packet sniffing — and every robot appears in Apple Home as a first-class **Matter Robotic Vacuum Cleaner**: start, pause, dock, pick rooms, choose cleaning modes, and watch the status pill name the room the robot is _actually inside_, live.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-roborock-matter",
-  "version": "2.9.3",
+  "version": "2.9.5",
   "description": "Matter-only Homebridge plugin publishing Roborock robot vacuums (including 2025 B01/Q7-series) as native Matter accessories for Apple Home. Fork of homebridge-roborock-vacuum2.",
   "license": "MIT",
   "author": {

package/roborockLib/lib/message.js

@@ -32,7 +32,18 @@ class message {
     this.adapter = adapter;
     this.missingLocalKeyWarnings = new Set();
 
-    this.keys = roborockCrypto.generateRsaKeyPair();
+    // The protocol RSA keypair is only needed for the rare photo request
+    // path (camera-equipped models). Generate it lazily on first use
+    // instead of paying a full RSA-2048 keygen (~50 ms on fast hardware,
+    // substantially more on a Raspberry Pi) at every startup.
+    this._keys = null;
+  }
+
+  get keys() {
+    if (!this._keys) {
+      this._keys = roborockCrypto.generateRsaKeyPair();
+    }
+    return this._keys;
   }
 
   async buildPayload(

package/roborockLib/lib/roborock_mqtt_connector.js

@@ -77,7 +77,10 @@ class roborock_mqtt_connector {
 
     this.connected = false;
 
-    this.keys = roborockCrypto.generateRsaKeyPair();
+    // NOTE: this class previously generated its own RSA-2048 keypair here,
+    // but nothing ever read it — the protocol keypair lives in message.js
+    // (lazily created for the rare photo path). Removed: one full RSA
+    // keygen less at every startup.
   }
 
   async initUser(userdata) {
@@ -524,24 +527,6 @@ class roborock_mqtt_connector {
 
     return false;
   }
-
-  decryptWithPrivateKey(privateKeyPem, encryptedData) {
-    const privateKey = crypto.createPrivateKey({
-      key: privateKeyPem,
-      format: "pem",
-      type: "pkcs8",
-    });
-
-    const decryptedData = crypto.privateDecrypt(
-      {
-        key: privateKey,
-        padding: crypto.constants.RSA_PKCS1_PADDING,
-      },
-      encryptedData
-    );
-
-    return decryptedData;
-  }
 }
 
 /**

package/roborockLib/roborockAPI.js

@@ -42,6 +42,15 @@ const B01_LIVE_ROOM_CLEAR_V1_STATES = new Set([3, 8]);
 // slower cadence than the ~12s active status polls.
 const B01_LIVE_ROOM_MIN_FETCH_GAP_MS = 20000;
 
+// Persisted states whose disk flush is debounced (see setStateAsync): they
+// change on every received robot message, are served from memory, and only
+// need the on-disk copy for restart survival.
+const DEBOUNCED_PERSIST_IDS = new Set([
+  "TransportDiagnostics",
+  "RoborockDiagnostics",
+]);
+const PERSIST_FLUSH_DEBOUNCE_MS = 60000;
+
 const PERSISTED_STATE_IDS = new Set([
   "UserData",
   "clientID",
@@ -122,8 +131,6 @@ class Roborock {
     this.localDevices = {};
     this.remoteDevices = new Set();
 
-    this.scenesData = null; // Store scenes data locally
-
     this.name = "roborock";
     this.deviceNotify = null;
     this.serviceAreaRoomMapRefreshAttempts = new Map();
@@ -281,6 +288,19 @@ class Roborock {
   async setStateAsync(id, state) {
     try {
       if (PERSISTED_STATE_IDS.has(id)) {
+        // Chatty diagnostic states update on every received robot message
+        // (every few seconds while cleaning). They are read from memory by
+        // the settings UI; the on-disk copy only needs to survive restarts.
+        // Debouncing their disk flush to once per minute turns one
+        // SYNCHRONOUS write per robot message into at most one per minute
+        // — a real win for event-loop latency and SD-card wear on
+        // Raspberry Pi installs. Critical states (credentials, HomeData,
+        // room caches) still persist immediately.
+        if (DEBOUNCED_PERSIST_IDS.has(id)) {
+          this.states[id] = state;
+          this.schedulePersistFlush(id);
+          return;
+        }
         const persistPath = this.getPersistPath(id);
         fs.mkdirSync(path.dirname(persistPath), { recursive: true });
         fs.writeFileSync(persistPath, JSON.stringify(state, null, 2, "utf8"));
@@ -1530,6 +1550,7 @@ class Roborock {
 
   async stopService() {
     try {
+      this.flushPendingPersistedStates();
       await this.clearTimersAndIntervals();
       this.bInited = false;
     } catch (e) {
@@ -1537,6 +1558,59 @@ class Roborock {
     }
   }
 
+  /**
+   * Schedule a debounced disk flush for a chatty persisted state. The
+   * in-memory copy is already current; the trailing flush (unref'd so it
+   * never keeps the process alive) writes the LATEST value at most once
+   * per PERSIST_FLUSH_DEBOUNCE_MS.
+   * @param {string} id
+   */
+  schedulePersistFlush(id) {
+    if (!this._pendingPersistFlushes) {
+      this._pendingPersistFlushes = new Map();
+    }
+    if (this._pendingPersistFlushes.has(id)) {
+      return;
+    }
+    const timer = setTimeout(() => {
+      this._pendingPersistFlushes.delete(id);
+      this.persistStateToDisk(id);
+    }, PERSIST_FLUSH_DEBOUNCE_MS);
+    if (typeof timer?.unref === "function") {
+      timer.unref();
+    }
+    this._pendingPersistFlushes.set(id, timer);
+  }
+
+  /** Write the current in-memory value of a persisted state to disk now. */
+  persistStateToDisk(id) {
+    try {
+      const state = this.states[id];
+      if (state === undefined) {
+        return;
+      }
+      const persistPath = this.getPersistPath(id);
+      fs.mkdirSync(path.dirname(persistPath), { recursive: true });
+      fs.writeFileSync(persistPath, JSON.stringify(state, null, 2));
+    } catch (error) {
+      this.log.debug(
+        `Debounced persist of '${id}' failed: ${error?.message || error}`
+      );
+    }
+  }
+
+  /** Flush all pending debounced persists immediately (shutdown path). */
+  flushPendingPersistedStates() {
+    if (!this._pendingPersistFlushes) {
+      return;
+    }
+    for (const [id, timer] of this._pendingPersistFlushes) {
+      clearTimeout(timer);
+      this.persistStateToDisk(id);
+    }
+    this._pendingPersistFlushes.clear();
+  }
+
   async getUserData(loginApi) {
     try {
       if (this.isValidUserData(this.userData)) {