matterbridge-irobot 0.0.1 → 0.0.2

package/CHANGELOG.md

@@ -1,13 +1,13 @@
-# <img src="https://github.com/Luligu/matterbridge/blob/main/frontend/public/matterbridge%2064x64.png" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge test plugin changelog
+# <img src="https://matterbridge.io/assets/matterbridge.svg" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge iRobot plugin changelog
 
 All notable changes to this project will be documented in this file.
 
-If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-example-dynamic-platform and sponsoring it.
+If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-irobot and sponsoring it.
 
 ## [0.0.1] - 2025-02-11
 
 <a href="https://www.buymeacoffee.com/luligugithub">
-  <img src="./yellow-button.png" alt="Buy me a coffee" width="120">
+  <img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="120">
 </a>
 
 <!-- Commented out section

package/README.md

@@ -1,15 +1,17 @@
-# <img src="https://github.com/Luligu/matterbridge/blob/main/frontend/public/matterbridge%2064x64.png" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge irobot plugin
+# <img src="https://matterbridge.io/assets/matterbridge.svg" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge iRobot plugin
 
 [![npm version](https://img.shields.io/npm/v/matterbridge-irobot.svg)](https://www.npmjs.com/package/matterbridge-irobot)
 [![npm downloads](https://img.shields.io/npm/dt/matterbridge-irobot.svg)](https://www.npmjs.com/package/matterbridge-irobot)
-[![Docker Version](https://img.shields.io/docker/v/luligu/matterbridge?label=docker%20version&sort=semver)](https://hub.docker.com/r/luligu/matterbridge)
-[![Docker Pulls](https://img.shields.io/docker/pulls/luligu/matterbridge.svg)](https://hub.docker.com/r/luligu/matterbridge)
-![Node.js CI](https://github.com/Luligu/matterbridge-irobot/actions/workflows/build-matterbridge-plugin.yml/badge.svg)
+[![Docker Version](https://img.shields.io/docker/v/luligu/matterbridge/latest?label=docker%20version)](https://hub.docker.com/r/luligu/matterbridge)
+[![Docker Pulls](https://img.shields.io/docker/pulls/luligu/matterbridge?label=docker%20pulls)](https://hub.docker.com/r/luligu/matterbridge)
+![Node.js CI](https://github.com/Luligu/matterbridge-irobot/actions/workflows/build.yml/badge.svg)
 ![Jest coverage](https://img.shields.io/badge/Jest%20coverage-100%25-brightgreen)
 
-[![power by](https://img.shields.io/badge/powered%20by-matterbridge-blue)](https://www.npmjs.com/package/matterbridge)
-[![power by](https://img.shields.io/badge/powered%20by-matter--history-blue)](https://www.npmjs.com/package/matter-history)
-[![power by](https://img.shields.io/badge/powered%20by-node--ansi--logger-blue)](https://www.npmjs.com/package/node-ansi-logger)
-[![power by](https://img.shields.io/badge/powered%20by-node--persist--manager-blue)](https://www.npmjs.com/package/node-persist-manager)
+[![powered by](https://img.shields.io/badge/powered%20by-matterbridge-blue)](https://www.npmjs.com/package/matterbridge)
+[![powered by](https://img.shields.io/badge/powered%20by-matter--history-blue)](https://www.npmjs.com/package/matter-history)
+[![powered by](https://img.shields.io/badge/powered%20by-node--ansi--logger-blue)](https://www.npmjs.com/package/node-ansi-logger)
+[![powered by](https://img.shields.io/badge/powered%20by-node--persist--manager-blue)](https://www.npmjs.com/package/node-persist-manager)
 
 ---
+
+Work in progress!

package/dist/iRobot.d.ts

@@ -0,0 +1,89 @@
+import dgram from 'node:dgram';
+export interface DiscoveryInfo {
+    ip: string;
+    ver?: string;
+    hostname?: string;
+    robotname?: string;
+    robotid?: string;
+    mac?: string;
+    sw?: string;
+    sku?: string;
+    nc?: number;
+    proto?: string;
+    cap?: {
+        'pose'?: number;
+        'rNav'?: number;
+        'ns'?: number;
+        'maps'?: number;
+        'pmaps'?: number;
+        'sem2umf'?: number;
+        'floorTypeDetect'?: number;
+        'keepOutZones'?: number;
+        'multiPass'?: number;
+        'carpetBoost'?: number;
+        'edge'?: number | null;
+        'eco'?: number;
+        'area'?: number;
+        'regions'?: number;
+        'cleaningPasses'?: number;
+        'alwaysFinish'?: number;
+        'binFullDetect'?: number;
+        'addOnHw'?: number;
+        'dockComm'?: number;
+        'tLine'?: number;
+        'tank'?: number;
+        'evac'?: number;
+        'odoa'?: number;
+        'obstacleAvoidance'?: number;
+        'ota'?: number;
+        'langOta'?: number;
+        'lang'?: number;
+        '5ghz'?: number;
+        'ble'?: number;
+        'pp'?: number;
+        'pw'?: number;
+        'oMode'?: number;
+        'prov'?: number;
+        'sched'?: number;
+        'svcConf'?: number;
+        'mc'?: number;
+        'expectingUserConf'?: number;
+        'team'?: number;
+        'hm'?: number;
+        'idl'?: number;
+        'missionStatus'?: number;
+        'batteryStatus'?: number;
+        'chargingState'?: number;
+        'dockingState'?: number;
+        'runningState'?: number;
+        'pausedState'?: number;
+        'log'?: number;
+        'bleLog'?: number;
+        'filterMaintenance'?: number;
+        'errorReporting'?: number;
+        'cloud'?: number;
+        'remoteControl'?: number;
+        'fwUpdateNotify'?: number;
+    } & Record<string, number | null>;
+    freq?: number;
+    cloudConnState?: number;
+    rinfo: dgram.RemoteInfo;
+}
+export declare class Discovery {
+    private readonly port;
+    private readonly message;
+    private readonly timeout;
+    private readonly devices;
+    constructor(timeout?: number);
+    discover(): Promise<DiscoveryInfo[]>;
+    retrieveLocalCredentials(robotIP: string): Promise<{
+        blid: string;
+        password: string;
+    }>;
+    retrieveLocalCredentialsV1(robotIP: string): Promise<{
+        blid: string;
+        password: string;
+    }>;
+    private getRobotPublicInfo;
+    private getBlidV1;
+}

package/dist/iRobot.js

@@ -0,0 +1,256 @@
+import dgram from 'node:dgram';
+import { connect as tlsConnect } from 'node:tls';
+import { request as httpsRequest } from 'node:https';
+export class Discovery {
+    port = 5678;
+    message = Buffer.from('irobotmcs');
+    timeout;
+    devices = new Map();
+    constructor(timeout = 3000) {
+        this.timeout = timeout;
+    }
+    discover() {
+        return new Promise((resolve, reject) => {
+            const socket = dgram.createSocket('udp4');
+            socket.on('error', (err) => {
+                socket.close();
+                reject(err);
+            });
+            socket.on('message', (msg, rinfo) => {
+                try {
+                    const parsed = JSON.parse(msg.toString());
+                    const prefix = parsed.hostname?.split('-')[0];
+                    if ((prefix === 'Roomba' || prefix === 'iRobot') && parsed.ip) {
+                        parsed.rinfo = rinfo;
+                        this.devices.set(parsed.ip, parsed);
+                    }
+                }
+                catch {
+                }
+            });
+            socket.bind(this.port, () => {
+                socket.setBroadcast(true);
+                socket.send(this.message, 0, this.message.length, this.port, '255.255.255.255');
+            });
+            setTimeout(() => {
+                socket.close();
+                resolve(Array.from(this.devices.values()));
+            }, this.timeout);
+        });
+    }
+    async retrieveLocalCredentials(robotIP) {
+        return new Promise((resolve, reject) => {
+            this.getRobotPublicInfo(robotIP)
+                .then((robotData) => {
+                const blid = robotData.hostname?.split('-')[1];
+                if (!blid) {
+                    reject(new Error('Could not extract BLID from robot hostname'));
+                }
+                const packet = Buffer.from('f005efcc3b2900', 'hex');
+                const client = tlsConnect(8883, robotIP, {
+                    timeout: 10000,
+                    rejectUnauthorized: false,
+                    ciphers: 'AES128-SHA256',
+                });
+                let sliceFrom = 13;
+                client.on('connect', () => {
+                    client.write(packet);
+                });
+                client.on('data', (data) => {
+                    if (data.length === 2) {
+                        sliceFrom = 9;
+                        return;
+                    }
+                    if (data.length <= 7) {
+                        client.end();
+                        reject(new Error('Error getting password. Follow the instructions and try again.'));
+                    }
+                    else {
+                        const password = data.slice(sliceFrom).toString();
+                        client.end();
+                        resolve({
+                            blid: blid,
+                            password,
+                        });
+                    }
+                });
+                client.on('error', (error) => {
+                    client.destroy();
+                    reject(new Error(`TLS connection failed: ${error.message}. Ensure robot is on home base and HOME button was pressed.`));
+                });
+                client.on('timeout', () => {
+                    client.destroy();
+                    reject(new Error('Timeout - ensure you pressed the HOME button on the robot'));
+                });
+            })
+                .catch(reject);
+        });
+    }
+    async retrieveLocalCredentialsV1(robotIP) {
+        return new Promise((resolve, reject) => {
+            let requestId = 1;
+            const maxRetries = 120;
+            const requestOptions = {
+                hostname: robotIP,
+                port: 443,
+                path: '/umi',
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                    'Connection': 'close',
+                    'User-Agent': 'aspen%20production/2618 CFNetwork/758.3.15 Darwin/15.4.0',
+                    'Content-Encoding': 'identity',
+                    'Accept': '*/*',
+                    'Accept-Language': 'en-us',
+                    'Host': robotIP,
+                },
+                rejectUnauthorized: false,
+            };
+            const pollForPassword = () => {
+                if (requestId > maxRetries) {
+                    reject(new Error('Timeout getting password. Are you following the instructions?'));
+                    return;
+                }
+                const postData = JSON.stringify({
+                    do: 'get',
+                    args: ['passwd'],
+                    id: requestId,
+                });
+                const req = httpsRequest(requestOptions, (res) => {
+                    let body = '';
+                    res.on('data', (chunk) => {
+                        body += chunk;
+                    });
+                    res.on('end', () => {
+                        if (res.statusCode === 401) {
+                            setTimeout(() => {
+                                requestId++;
+                                pollForPassword();
+                            }, 2000);
+                        }
+                        else if (res.statusCode === 200) {
+                            try {
+                                const response = JSON.parse(body);
+                                const password = response.ok?.passwd;
+                                if (password) {
+                                    this.getBlidV1(robotIP, password, requestId + 1)
+                                        .then((blid) => resolve({ blid, password }))
+                                        .catch(reject);
+                                }
+                                else {
+                                    reject(new Error('Invalid password response format'));
+                                }
+                            }
+                            catch (error) {
+                                reject(new Error(`Failed to parse password response: ${error}`));
+                            }
+                        }
+                        else {
+                            setTimeout(() => {
+                                requestId++;
+                                pollForPassword();
+                            }, 2000);
+                        }
+                    });
+                });
+                req.on('error', (error) => {
+                    reject(new Error(`HTTPS request failed: ${error.message}`));
+                });
+                req.write(postData);
+                req.end();
+            };
+            pollForPassword();
+        });
+    }
+    getRobotPublicInfo(robotIP) {
+        return new Promise((resolve, reject) => {
+            const socket = dgram.createSocket('udp4');
+            const timeout = 5000;
+            const timeoutId = setTimeout(() => {
+                socket.close();
+                reject(new Error(`Timeout getting robot info from ${robotIP}`));
+            }, timeout);
+            socket.on('error', (err) => {
+                clearTimeout(timeoutId);
+                socket.close();
+                reject(err);
+            });
+            socket.on('message', (msg) => {
+                try {
+                    const parsedMsg = JSON.parse(msg.toString());
+                    if (parsedMsg.hostname && parsedMsg.ip && (parsedMsg.hostname.split('-')[0] === 'Roomba' || parsedMsg.hostname.split('-')[0] === 'iRobot')) {
+                        clearTimeout(timeoutId);
+                        socket.close();
+                        const blid = parsedMsg.hostname.split('-')[1];
+                        resolve({ ...parsedMsg, robotid: blid });
+                    }
+                }
+                catch {
+                }
+            });
+            socket.bind(5678, () => {
+                const message = Buffer.from('irobotmcs');
+                socket.send(message, 0, message.length, 5678, robotIP);
+            });
+        });
+    }
+    getBlidV1(robotIP, password, requestId) {
+        return new Promise((resolve, reject) => {
+            const auth = Buffer.from(`user:${password}`).toString('base64');
+            const requestOptions = {
+                hostname: robotIP,
+                port: 443,
+                path: '/umi',
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                    'Authorization': `Basic ${auth}`,
+                    'Connection': 'close',
+                    'User-Agent': 'aspen%20production/2618 CFNetwork/758.3.15 Darwin/15.4.0',
+                    'Content-Encoding': 'identity',
+                    'Accept': '*/*',
+                    'Accept-Language': 'en-us',
+                    'Host': robotIP,
+                },
+                rejectUnauthorized: false,
+            };
+            const postData = JSON.stringify({
+                do: 'get',
+                args: ['sys'],
+                id: requestId,
+            });
+            const req = httpsRequest(requestOptions, (res) => {
+                let body = '';
+                res.on('data', (chunk) => {
+                    body += chunk;
+                });
+                res.on('end', () => {
+                    if (res.statusCode === 200) {
+                        try {
+                            const response = JSON.parse(body);
+                            const blidArray = response.ok?.blid;
+                            if (Array.isArray(blidArray)) {
+                                const blid = blidArray.map((dec) => (dec + 0x10000).toString(16).substr(-2).toUpperCase()).join('');
+                                resolve(blid);
+                            }
+                            else {
+                                reject(new Error('Invalid BLID response format'));
+                            }
+                        }
+                        catch (error) {
+                            reject(new Error(`Failed to parse BLID response: ${error}`));
+                        }
+                    }
+                    else {
+                        reject(new Error(`Unexpected status code getting BLID: ${res.statusCode}`));
+                    }
+                });
+            });
+            req.on('error', (error) => {
+                reject(new Error(`HTTPS request failed: ${error.message}`));
+            });
+            req.write(postData);
+            req.end();
+        });
+    }
+}

package/dist/module.d.ts

@@ -0,0 +1,9 @@
+import { MatterbridgeDynamicPlatform, PlatformConfig, PlatformMatterbridge } from 'matterbridge';
+import { AnsiLogger } from 'matterbridge/logger';
+export default function initializePlugin(matterbridge: PlatformMatterbridge, log: AnsiLogger, config: PlatformConfig): Platform;
+export declare class Platform extends MatterbridgeDynamicPlatform {
+    constructor(matterbridge: PlatformMatterbridge, log: AnsiLogger, config: PlatformConfig);
+    onStart(reason?: string): Promise<void>;
+    onConfigure(): Promise<void>;
+    onShutdown(reason?: string): Promise<void>;
+}

package/dist/{platform.js → module.js}

@@ -1,15 +1,22 @@
 import { MatterbridgeDynamicPlatform } from 'matterbridge';
+import { Discovery } from './iRobot.js';
+export default function initializePlugin(matterbridge, log, config) {
+    return new Platform(matterbridge, log, config);
+}
 export class Platform extends MatterbridgeDynamicPlatform {
     constructor(matterbridge, log, config) {
         super(matterbridge, log, config);
-        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('2.1.5')) {
-            throw new Error(`The test plugin requires Matterbridge version >= "2.1.5". Please update Matterbridge to the latest version in the frontend.`);
+        if (this.verifyMatterbridgeVersion === undefined || typeof this.verifyMatterbridgeVersion !== 'function' || !this.verifyMatterbridgeVersion('3.5.0')) {
+            throw new Error(`This plugin requires Matterbridge version >= "3.5.0". Please update Matterbridge to the latest version in the frontend.`);
         }
         this.log.info('Initializing platform:', this.config.name);
         this.log.info('Finished initializing platform:', this.config.name);
     }
     async onStart(reason) {
         this.log.info('onStart called with reason:', reason ?? 'none');
+        const iRobot = new Discovery();
+        const devices = await iRobot.discover();
+        this.log.info('Discovered iRobot devices:', devices);
     }
     async onConfigure() {
         await super.onConfigure();

package/npm-shrinkwrap.json

@@ -1,19 +1,19 @@
 {
   "name": "matterbridge-irobot",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge-irobot",
-      "version": "0.0.1",
+      "version": "0.0.2",
       "license": "Apache-2.0",
       "dependencies": {
-        "node-ansi-logger": "^3.0.0",
-        "node-persist-manager": "^1.0.8"
+        "node-ansi-logger": "3.1.1",
+        "node-persist-manager": "2.0.0"
       },
       "engines": {
-        "node": ">=18.0.0 <19.0.0 || >=20.0.0 <21.0.0 || >=22.0.0 <23.0.0"
+        "node": ">=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
       },
       "funding": {
         "type": "buymeacoffee",
@@ -21,12 +21,13 @@
       }
     },
     "node_modules/node-ansi-logger": {
-      "version": "3.0.0",
-      "resolved": "https://registry.npmjs.org/node-ansi-logger/-/node-ansi-logger-3.0.0.tgz",
-      "integrity": "sha512-OkXtONak4f+mH1ECBP7xoM2sD4ZiFKyKVb/QrMCMwX8k/W8ZuDA0WgskD9PJMZqgaUF1wUQA39yVdpGH/xUsuw==",
-      "license": "MIT",
+      "version": "3.1.1",
+      "resolved": "https://registry.npmjs.org/node-ansi-logger/-/node-ansi-logger-3.1.1.tgz",
+      "integrity": "sha512-tFeCSxwiRg5XaNda5nC27alzraZP76nLtUk1JDZqb9byhW4WYaSGL7/lmxFHEI16gypQDMEYljuF+wcG+cPPHw==",
+      "hasShrinkwrap": true,
+      "license": "Apache-2.0",
       "engines": {
-        "node": "18.x || 20.x || 22.x"
+        "node": ">=18.0.0 <19.0.0 || >=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
       },
       "funding": {
         "type": "buymeacoffee",
@@ -46,15 +47,15 @@
       }
     },
     "node_modules/node-persist-manager": {
-      "version": "1.0.8",
-      "resolved": "https://registry.npmjs.org/node-persist-manager/-/node-persist-manager-1.0.8.tgz",
-      "integrity": "sha512-J0wjdxOloD6aw4s2kljbV3nvHfguWph8LnfmTL+6MZiBsh46wjaIaZd/cHU0HWonrNfktCv7Zuvn0sEH0f2s+A==",
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/node-persist-manager/-/node-persist-manager-2.0.0.tgz",
+      "integrity": "sha512-jpgOqCCn4ZEnIr4WcvqkyyGmmLJarV6aUyBlDQdG1G84X9UUmOmI1W2OZtc9K0z375CYWhjtGEXaY7GXNiEOfA==",
       "license": "MIT",
       "dependencies": {
-        "node-persist": "^4.0.2"
+        "node-persist": "4.0.4"
       },
       "engines": {
-        "node": ">=18.0.0"
+        "node": ">=18.0.0 <19.0.0 || >=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
       },
       "funding": {
         "type": "buymeacoffee",

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "matterbridge-irobot",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Matterbridge irobot plugin",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",
   "type": "module",
-  "main": "dist/index.js",
+  "main": "dist/module.js",
+  "types": "dist/module.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Luligu/matterbridge-irobot.git"
@@ -30,10 +31,18 @@
     "shelly"
   ],
   "engines": {
-    "node": ">=18.0.0 <19.0.0 || >=20.0.0 <21.0.0 || >=22.0.0 <23.0.0"
+    "node": ">=20.0.0 <21.0.0 || >=22.0.0 <23.0.0 || >=24.0.0 <25.0.0"
   },
+  "files": [
+    "bin",
+    "dist",
+    "npm-shrinkwrap.json",
+    "CHANGELOG.md",
+    "*.config.json",
+    "*.schema.json"
+  ],
   "dependencies": {
-    "node-ansi-logger": "^3.0.0",
-    "node-persist-manager": "^1.0.8"
+    "node-ansi-logger": "3.1.1",
+    "node-persist-manager": "2.0.0"
   }
 }

package/dist/index.js

@@ -1,4 +0,0 @@
-import { Platform } from './platform.js';
-export default function initializePlugin(matterbridge, log, config) {
-    return new Platform(matterbridge, log, config);
-}