Added option to use iRobot credentials to get devices info.

homebridge-plugins · Feb 1, 2025 · f46aa99 · f46aa99
1 parent 3f8d2f6
commit f46aa99
Show file tree

Hide file tree

Showing 13 changed files with 629 additions and 146 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+## [2.1.0](https://github.com/homebridge-plugins/homebridge-roomba/releases/tag/v2.1.0) (2025-01-XX)
+
+### What's Changes
+- Added option to use iRobot credentials to get devices info.
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-roomba/compare/v2.0.0...v2.1.0
+
 ## [2.0.0](https://github.com/homebridge-plugins/homebridge-roomba/releases/tag/v2.0.0) (2025-01-25)
 
 ### What's Changes

diff --git a/config.schema.json b/config.schema.json
@@ -11,9 +11,34 @@
             "name": {
                 "type": "string",
                 "title": "Name",
-                "default": "NoIP",
+                "default": "Roomba",
                 "required": true
             },
+            "email": {
+                "type": "string",
+                "title": "iRobot Account Email",
+                "description": "The email address you use to log into the iRobot Home app.",
+                "pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$",
+                "required": true,
+                "x-schema-form": {
+                    "type": "email"
+                }
+            },
+            "password": {
+                "type": "string",
+                "title": "iRobot Account Password",
+                "description": "The password you use to log into the iRobot Home app.",
+                "required": true,
+                "x-schema-form": {
+                    "type": "password"
+                }
+            },
+            "disableDiscovery": {
+                "type": "boolean",
+                "title": "Auto Discovery",
+                "description": "Automatically discover Roomba devices on the network.",
+                "required": false
+            },
             "devices": {
                 "type": "array",
                 "items": {
@@ -109,7 +134,6 @@
                                     "type": "number",
                                     "title": "Clean rooms in order",
                                     "default": 1,
-                                    "required": true,
                                     "oneOf": [
                                         {
                                             "title": "Yes",
@@ -131,7 +155,6 @@
                                 "pmap_id": {
                                     "type": "string",
                                     "title": "Pmap Id",
-                                    "required": true,
                                     "condition": {
                                         "functionBody": "return (model.devices && model.devices[arrayIndices].cleanBehaviour === 'rooms');"
                                     }
@@ -144,14 +167,12 @@
                                         "properties": {
                                             "region_id": {
                                                 "type": "string",
-                                                "title": "Region Id",
-                                                "required": true
+                                                "title": "Region Id"
                                             },
                                             "type": {
                                                 "type": "string",
                                                 "title": "Type",
-                                                "default": "rid",
-                                                "required": true
+                                                "default": "rid"
                                             },
                                             "params": {
                                                 "type": "object",
@@ -224,47 +245,69 @@
     },
     "layout": [
         {
-            "key": "devices",
-            "notitle": false,
-            "type": "tabarray",
-            "title": "{{ value.name || value.ipaddress || value.serialnum || 'New Vacuum' }}",
+            "type": "fieldset",
+            "title": "iRobot Account",
+            "expandable": true,
+            "expanded": false,
+            "items": [
+                "email",
+                "password"
+            ]
+        },
+        {
+            "type": "fieldset",
+            "title": "Roomba Device Settings",
             "expandable": true,
             "expanded": false,
-            "orderable": false,
             "items": [
-                "devices[].name",
-                "devices[].model",
-                "devices[].serialnum",
-                "devices[].blid",
-                "devices[].robotpwd",
-                "devices[].ipaddress",
-                "devices[].homeSwitch",
-                "devices[].dockContactSensor",
-                "devices[].dockingContactSensor",
-                "devices[].runningContactSensor",
-                "devices[].binContactSensor",
-                "devices[].tankContactSensor",
-                "devices[].idleWatchInterval",
-                "devices[].cleanBehaviour",
                 {
-                    "key": "devices[].mission",
-                    "type": "fieldset",
-                    "title": "Mission Settings",
+                    "type": "help",
+                    "helpvalue": "<em class='primary-text'>With Roomba Device Setting, you can set device specific settings based on <b style='color: var(--secondary-color);'>blid</b>.</em>"
+                },
+                {
+                    "key": "devices",
+                    "notitle": false,
+                    "type": "tabarray",
+                    "title": "{{ value.name || value.ipaddress || value.serialnum || 'New Vacuum' }}",
                     "expandable": true,
                     "expanded": false,
+                    "orderable": false,
                     "items": [
-                        "devices[].mission.pmap_id",
-                        "devices[].mission.user_pmapv_id",
-                        "devices[].mission.regions",
-                        "devices[].mission.regions[].region_id",
-                        "devices[].mission.regions[].type",
-                        "devices[].mission.regions[].params.noAutoPasses",
-                        "devices[].mission.regions[].params.twoPass",
-                        "devices[].mission.ordered"
+                        "devices[].name",
+                        "devices[].model",
+                        "devices[].serialnum",
+                        "devices[].blid",
+                        "devices[].robotpwd",
+                        "devices[].ipaddress",
+                        "devices[].homeSwitch",
+                        "devices[].dockContactSensor",
+                        "devices[].dockingContactSensor",
+                        "devices[].runningContactSensor",
+                        "devices[].binContactSensor",
+                        "devices[].tankContactSensor",
+                        "devices[].idleWatchInterval",
+                        "devices[].cleanBehaviour",
+                        {
+                            "key": "devices[].mission",
+                            "type": "fieldset",
+                            "title": "Mission Settings",
+                            "expandable": true,
+                            "expanded": false,
+                            "items": [
+                                "devices[].mission.pmap_id",
+                                "devices[].mission.user_pmapv_id",
+                                "devices[].mission.regions",
+                                "devices[].mission.regions[].region_id",
+                                "devices[].mission.regions[].type",
+                                "devices[].mission.regions[].params.noAutoPasses",
+                                "devices[].mission.regions[].params.twoPass",
+                                "devices[].mission.ordered"
+                            ]
+                        },
+                        "devices[].stopBehaviour",
+                        "devices[].idleWatchInterval"
                     ]
-                },
-                "devices[].stopBehaviour",
-                "devices[].idleWatchInterval"
+                }
             ]
         },
         {
@@ -273,6 +316,7 @@
             "expandable": true,
             "expanded": false,
             "items": [
+                "disableDiscovery",
                 "debug"
             ]
         }

diff --git a/docs/functions/default.html b/docs/functions/default.html
@@ -1,2 +1,2 @@
 <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><style>body { visibility: hidden; }</style><meta charset="utf-8"><meta http-equiv="x-ua-compatible" content="IE=edge"><title>default | @homebridge-plugins/homebridge-roomba</title><meta name="description" content="Documentation for @homebridge-plugins/homebridge-roomba"><meta name="viewport" content="width=device-width, initial-scale=1"><link rel="stylesheet" href="../assets/style.css"><link rel="stylesheet" href="../assets/highlight.css"><script defer="" src="../assets/main.js"></script><script async="" src="../assets/icons.js" id="tsd-icons-script"></script><link rel="stylesheet" href="../assets/dmt/dmt-components.css"><link rel="stylesheet" href="../assets/dmt/dmt-theme.css"><script src="../assets/dmt/dmt-components.js" type="module"></script><noscript><style>body { visibility: visible; }</style></noscript></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";</script><div class="overlay"></div>
-<main><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field" id="dmt-search-main"></div><div class="field" id="dmt-toolbar"><a href="../index.html" class="title">@homebridge-plugins/homebridge-roomba</a></div></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main" tabindex="-1"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"></ul><div class="dmt-title-header-flex"><h1>Function default</h1></div></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="default" class="tsd-anchor"></a><span class="tsd-kind-call-signature">default</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">api</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">API</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">api</span>: <span class="tsd-signature-type">API</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/homebridge-plugins/homebridge-roomba/blob/ab678872d5be2d5ac5b4310dcc2c604a3a3a70dc/src/index.ts#L10">index.ts:10</a></li></ul></aside></li></ul></section></div><div class="col-sidebar" tabindex="-1"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked=""><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu" tabindex="-1"><nav class="tsd-navigation"><a href="../modules.html">@homebridge-plugins/homebridge-roomba</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"></ul></nav></div></div></div></main></body></html>
+<main><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field" id="dmt-search-main"></div><div class="field" id="dmt-toolbar"><a href="../index.html" class="title">@homebridge-plugins/homebridge-roomba</a></div></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main" tabindex="-1"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"></ul><div class="dmt-title-header-flex"><h1>Function default</h1></div></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="default" class="tsd-anchor"></a><span class="tsd-kind-call-signature">default</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">api</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">API</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#default" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">api</span>: <span class="tsd-signature-type">API</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/homebridge-plugins/homebridge-roomba/blob/a1ab2f3759643c480ef53da50ffa5dcbd7a930a2/src/index.ts#L7">index.ts:7</a></li></ul></aside></li></ul></section></div><div class="col-sidebar" tabindex="-1"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked=""><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu" tabindex="-1"><nav class="tsd-navigation"><a href="../modules.html">@homebridge-plugins/homebridge-roomba</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"></ul></nav></div></div></div></main></body></html>
diff --git a/docs/media/CHANGELOG.md b/docs/media/CHANGELOG.md
@@ -1,5 +1,13 @@
 # Changelog
 
+## [2.1.0](https://github.com/homebridge-plugins/homebridge-roomba/releases/tag/v2.1.0) (2025-01-XX)
+
+### What's Changes
+- Added option to use iRobot credentials to get devices info.
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-roomba/compare/v2.0.0...v2.1.0
+
 ## [2.0.0](https://github.com/homebridge-plugins/homebridge-roomba/releases/tag/v2.0.0) (2025-01-25)
 
 ### What's Changes
@@ -8,6 +16,7 @@
   - ***You will need to re-setup your vacuum***
     - You can reuse your config by taking your `serialnum`, `blid`, `robotpwd`, `ipaddress` from the Accessory config and input it in the Homebridge UI when adding a new device.
 - Pluging has been renamed from `homebridge-roomba2` to `homebridge-roomba` now that it is a scoped plugin.
+- Compaitable with Homebridge `v2.0.0`
 
 #### Other Changes
 - Housekeeping and updated dependencies.

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -64,7 +64,7 @@
     "@types/debug": "^4.1.12",
     "@types/fs-extra": "^11.0.4",
     "@types/mdast": "^4.0.4",
-    "@types/node": "^22.10.10",
+    "@types/node": "^22.13.0",
     "@types/promise-timeout": "^1.3.0",
     "@types/semver": "^7.5.8",
     "@types/source-map-support": "^0.5.10",