homebridge-roborock-matter 2.1.0

package/config.schema.json

@@ -0,0 +1,118 @@
+{
+  "pluginAlias": "RoborockVacuumPlatform",
+  "pluginType": "platform",
+  "singular": true,
+  "customUi": true,
+  "customUiPath": "./homebridge-ui",
+  "schema": {
+    "type": "object",
+    "properties": {
+      "email": {
+        "title": "Email",
+        "type": "string",
+        "format": "email",
+        "description": "Email address for the Roborock account that owns or has access to the vacuum."
+      },
+      "password": {
+        "title": "Password",
+        "type": "string",
+        "format": "password",
+        "placeholder": "Password",
+        "description": "Roborock account password. Used for password login or as a fallback when no encrypted token is available."
+      },
+      "encryptedToken": {
+        "title": "Encrypted Token",
+        "type": "string",
+        "description": "Encrypted Roborock session data. This is created and managed by the plugin UI after a successful login.",
+        "readOnly": true
+      },
+      "skipDevices": {
+        "title": "Skip Devices",
+        "type": "string",
+        "description": "Comma-separated Roborock serial numbers or DUIDs to ignore during discovery."
+      },
+      "baseURL": {
+        "title": "Region",
+        "type": "string",
+        "default": "https://usiot.roborock.com",
+        "enum": [
+          "https://usiot.roborock.com",
+          "https://euiot.roborock.com",
+          "https://cniot.roborock.com",
+          "https://api.roborock.com"
+        ],
+        "enumNames": [
+          "US (usiot.roborock.com)",
+          "EU (euiot.roborock.com)",
+          "CN (cniot.roborock.com)",
+          "Asia (api.roborock.com)"
+        ],
+        "description": "Roborock cloud region endpoint. Choose the region used by your Roborock account."
+      },
+      "debugMode": {
+        "title": "Debug Mode",
+        "description": "Write verbose Roborock API, discovery, and transport diagnostics to the Homebridge log.",
+        "type": "boolean",
+        "default": false
+      },
+      "transientWarningThrottleHours": {
+        "title": "Transient Warning Interval",
+        "description": "Hours between repeated transient timeout warnings for each vacuum. Use 0 to hide these recurring warnings unless debug logging is enabled.",
+        "type": "number",
+        "default": 6,
+        "minimum": 0
+      },
+      "enableMatterServiceArea": {
+        "title": "Enable Matter Room/Map Selection",
+        "description": "Adds Matter Service Area room and map selection to the Matter vacuum for clients that support it. Disable this if a Matter controller gets stuck showing the vacuum as Updating.",
+        "type": "boolean",
+        "default": true
+      },
+      "enableMatterPowerSource": {
+        "title": "Enable Matter Battery",
+        "description": "Adds the Matter battery/power-source cluster to the Matter vacuum. Disable this if a Matter controller gets stuck showing the vacuum as Updating.",
+        "type": "boolean",
+        "default": true
+      },
+      "enableMatterCleanMode": {
+        "title": "Enable Matter Cleaning Mode Selection",
+        "description": "Adds Matter vacuum/mop cleaning mode selection to the Matter vacuum. Disable this if a Matter controller shows the vacuum as No Response after pairing.",
+        "type": "boolean",
+        "default": true
+      },
+      "enableMatterExtendedOperationalStates": {
+        "title": "Enable Matter Returning Status",
+        "description": "Opt in to the extended Matter Returning status while the vacuum is heading back to the dock. Unless Charging/Docked status is also enabled below, docked and charging still report as Ready for Apple Home compatibility.",
+        "type": "boolean",
+        "default": false
+      },
+      "enableMatterChargingDockedStates": {
+        "title": "Enable Matter Charging/Docked Status",
+        "description": "Report real Charging and Docked states so the Apple Home tile shows Charging/Docked instead of Ready. Requires a recent iOS/tvOS; if the tile shows odd status text or pairing misbehaves after enabling, turn this off again and restart the Roborock bridge.",
+        "type": "boolean",
+        "default": false
+      },
+      "matterChargedBatteryThreshold": {
+        "title": "Charged Battery Threshold (%)",
+        "description": "Battery percentage at which a docked robot switches from Charging to Docked on the Apple Home tile. Default 100. Lower it (e.g. 90) if a worn battery makes the robot report fully charged early.",
+        "type": "number",
+        "minimum": 1,
+        "maximum": 100,
+        "default": 100
+      },
+      "cloudOnlyMode": {
+        "title": "Use Roborock Cloud Only",
+        "description": "Disables local LAN discovery and local TCP commands for this plugin, routing commands and status polling through Roborock cloud when available. Useful when local LAN connections appear connected but consistently time out. Restart the Roborock child bridge after changing this setting.",
+        "type": "boolean",
+        "default": false
+      },
+      "preferCloudForMatterCommands": {
+        "title": "Prefer Roborock Cloud for Matter Commands",
+        "description": "Sends Matter vacuum commands through the Roborock cloud when cloud transport is connected. This can avoid local LAN command timeouts on some models, such as S8, while keeping the legacy HomeKit accessories unchanged.",
+        "type": "boolean",
+        "default": false
+      }
+    },
+    "required": ["email"]
+  }
+}

package/dist/crypto.js

@@ -0,0 +1,65 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.encryptSession = encryptSession;
+exports.decryptSession = decryptSession;
+const crypto_1 = __importDefault(require("crypto"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const KEY_FILENAME = "roborock.token.key";
+function loadOrCreateKey(storagePath) {
+    const keyPath = path_1.default.join(storagePath, KEY_FILENAME);
+    try {
+        const existing = fs_1.default.readFileSync(keyPath);
+        if (existing.length === 32) {
+            return existing;
+        }
+    }
+    catch (error) {
+        // Ignore and create a new key.
+    }
+    const key = crypto_1.default.randomBytes(32);
+    fs_1.default.mkdirSync(storagePath, { recursive: true });
+    fs_1.default.writeFileSync(keyPath, key, { mode: 0o600 });
+    return key;
+}
+function encryptSession(session, storagePath) {
+    const key = loadOrCreateKey(storagePath);
+    const iv = crypto_1.default.randomBytes(12);
+    const cipher = crypto_1.default.createCipheriv("aes-256-gcm", key, iv);
+    const plaintext = Buffer.from(JSON.stringify(session), "utf8");
+    const ciphertext = Buffer.concat([cipher.update(plaintext), cipher.final()]);
+    const tag = cipher.getAuthTag();
+    const payload = {
+        iv: iv.toString("base64"),
+        tag: tag.toString("base64"),
+        data: ciphertext.toString("base64"),
+    };
+    return Buffer.from(JSON.stringify(payload), "utf8").toString("base64");
+}
+function decryptSession(encrypted, storagePath) {
+    if (!encrypted) {
+        return null;
+    }
+    try {
+        const key = loadOrCreateKey(storagePath);
+        const raw = Buffer.from(encrypted, "base64").toString("utf8");
+        const payload = JSON.parse(raw);
+        const iv = Buffer.from(payload.iv, "base64");
+        const tag = Buffer.from(payload.tag, "base64");
+        const ciphertext = Buffer.from(payload.data, "base64");
+        const decipher = crypto_1.default.createDecipheriv("aes-256-gcm", key, iv);
+        decipher.setAuthTag(tag);
+        const plaintext = Buffer.concat([
+            decipher.update(ciphertext),
+            decipher.final(),
+        ]).toString("utf8");
+        return JSON.parse(plaintext);
+    }
+    catch (error) {
+        return null;
+    }
+}
+//# sourceMappingURL=crypto.js.map

package/dist/crypto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.js","sourceRoot":"","sources":["../src/crypto.ts"],"names":[],"mappings":";;;;;AAwBA,wCAmBC;AAED,wCAgCC;AA7ED,oDAA4B;AAC5B,4CAAoB;AACpB,gDAAwB;AAExB,MAAM,YAAY,GAAG,oBAAoB,CAAC;AAE1C,SAAS,eAAe,CAAC,WAAmB;IAC1C,MAAM,OAAO,GAAG,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IAErD,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,YAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAC1C,IAAI,QAAQ,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAC3B,OAAO,QAAQ,CAAC;QAClB,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,+BAA+B;IACjC,CAAC;IAED,MAAM,GAAG,GAAG,gBAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IACnC,YAAE,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,YAAE,CAAC,aAAa,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;IAChD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAgB,cAAc,CAC5B,OAAgC,EAChC,WAAmB;IAEnB,MAAM,GAAG,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC;IACzC,MAAM,EAAE,GAAG,gBAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,gBAAM,CAAC,cAAc,CAAC,aAAa,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAE7D,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC;IAC/D,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAC7E,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,EAAE,CAAC;IAEhC,MAAM,OAAO,GAAG;QACd,EAAE,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC;QACzB,GAAG,EAAE,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAC3B,IAAI,EAAE,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC;KACpC,CAAC;IAEF,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACzE,CAAC;AAED,SAAgB,cAAc,CAC5B,SAAiB,EACjB,WAAmB;IAEnB,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC;QACzC,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC9D,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAI7B,CAAC;QAEF,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;QAC7C,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC/C,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEvD,MAAM,QAAQ,GAAG,gBAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;QACjE,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAEzB,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC;YAC9B,QAAQ,CAAC,MAAM,CAAC,UAAU,CAAC;YAC3B,QAAQ,CAAC,KAAK,EAAE;SACjB,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACpB,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAA4B,CAAC;IAC1D,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const platform_1 = __importDefault(require("./platform"));
+const settings_1 = require("./settings");
+module.exports = (api) => {
+    api.registerPlatform(settings_1.PLATFORM_NAME, platform_1.default);
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AACA,0DAA0C;AAC1C,yCAA2C;AAK3C,iBAAS,CAAC,GAAQ,EAAE,EAAE;IACpB,GAAG,CAAC,gBAAgB,CAAC,wBAAa,EAAE,kBAAgB,CAAC,CAAC;AACxD,CAAC,CAAC"}

package/dist/live_message.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLiveMessageForThisAccessory = getLiveMessageForThisAccessory;
+function getLiveMessageForThisAccessory(data, context) {
+    if (!data || typeof data !== "object") {
+        return data;
+    }
+    if (Array.isArray(data)) {
+        if (!context.shouldAcceptUnscopedLiveMessage()) {
+            context.logDebug(`Ignoring unscoped live Roborock update for ${context.getVacuumName()} because multiple vacuums are configured.`);
+            return null;
+        }
+        return data;
+    }
+    const message = data;
+    if (Object.prototype.hasOwnProperty.call(message, "duid") &&
+        Object.prototype.hasOwnProperty.call(message, "payload")) {
+        if (String(message.duid) !== context.getDuid()) {
+            return null;
+        }
+        return message.payload;
+    }
+    return data;
+}
+//# sourceMappingURL=live_message.js.map

package/dist/live_message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"live_message.js","sourceRoot":"","sources":["../src/live_message.ts"],"names":[],"mappings":";;AAoBA,wEAgCC;AAhCD,SAAgB,8BAA8B,CAC5C,IAAa,EACb,OAAoC;IAEpC,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,IAAI,CAAC,OAAO,CAAC,+BAA+B,EAAE,EAAE,CAAC;YAC/C,OAAO,CAAC,QAAQ,CACd,8CAA8C,OAAO,CAAC,aAAa,EAAE,2CAA2C,CACjH,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,OAAO,GAAG,IAA+B,CAAC;IAChD,IACE,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC;QACrD,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,EAAE,SAAS,CAAC,EACxD,CAAC;QACD,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC;YAC/C,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,OAAO,CAAC,OAAO,CAAC;IACzB,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}

package/dist/logger.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Decorates the Homebridge logger to only log debug messages when debug mode is enabled.
+ */
+class RoborockPlatformLogger {
+    constructor(logger, debugMode) {
+        this.logger = logger;
+        this.debugMode = debugMode;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    emit(fn, messages) {
+        for (let i = 0; i < messages.length; i++) {
+            fn(messages[i]);
+        }
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    debug(...messages) {
+        if (this.debugMode) {
+            this.emit((message) => this.logger.debug(message), messages);
+        }
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    info(...messages) {
+        this.emit((message) => this.logger.info(message), messages);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    warn(...messages) {
+        this.emit((message) => this.logger.warn(message), messages);
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    error(...messages) {
+        this.emit((message) => this.logger.error(message), messages);
+    }
+}
+exports.default = RoborockPlatformLogger;
+//# sourceMappingURL=logger.js.map

package/dist/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";;AAEA;;GAEG;AACH,MAAqB,sBAAsB;IACzC,YACmB,MAAc,EACd,SAAkB;QADlB,WAAM,GAAN,MAAM,CAAQ;QACd,cAAS,GAAT,SAAS,CAAS;IAClC,CAAC;IAEJ,8DAA8D;IACtD,IAAI,CAAC,EAA0B,EAAE,QAAe;QACtD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACzC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IAED,8DAA8D;IAC9D,KAAK,CAAC,GAAG,QAAe;QACtB,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED,8DAA8D;IAC9D,IAAI,CAAC,GAAG,QAAe;QACrB,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED,8DAA8D;IAC9D,IAAI,CAAC,GAAG,QAAe;QACrB,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED,8DAA8D;IAC9D,KAAK,CAAC,GAAG,QAAe;QACtB,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,CAAC;IAC/D,CAAC;CACF;AAlCD,yCAkCC"}