default idleWatchInterval

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

Hide file tree

Showing 5 changed files with 13 additions and 8 deletions.
diff --git a/config.schema.json b/config.schema.json
@@ -236,6 +236,12 @@
                     }
                 }
             },
+            "idleWatchInterval": {
+                "type": "integer",
+                "title": "Idle Poll Interval (minutes)",
+                "description": "How often to poll Roomba's status when it is idle. Defaults to 15 minutes.",
+                "required": false
+            },
             "debug": {
                 "type": "boolean",
                 "title": "Debug logging",
@@ -316,6 +322,7 @@
             "expandable": true,
             "expanded": false,
             "items": [
+                "idleWatchInterval",
                 "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/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>
+<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/f46aa99151ad923c8dd4535da86e82f27fa2e420/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/src/accessory.ts b/src/accessory.ts
@@ -165,20 +165,17 @@ export default class RoombaAccessory implements AccessoryPlugin {
         },
       })
     }
-    const deviceInfo = device.info ?? undefined
-    this.log.debug('device info: %s', JSON.stringify(deviceInfo))
     this.name = device.name
     this.model = device.model
-    this.serialnum = deviceInfo?.mac ?? device.ipaddress
+    this.serialnum = typeof device.info === 'object' ? device.info.serialNum ?? 'unknown' : device.ipaddress ?? 'unknown'
     this.blid = device.blid
     this.robotpwd = device.password
     this.ipaddress = device.ipaddress ?? device.ip
     this.version = device.softwareVer ?? this.platform.version ?? '0.0.0'
     this.cleanBehaviour = device.cleanBehaviour !== undefined ? device.cleanBehaviour : 'everywhere'
     this.mission = device.mission || { pmap_id: 'local' }
     this.stopBehaviour = device.stopBehaviour !== undefined ? device.stopBehaviour : 'home'
-    this.idlePollIntervalMillis = (device.idleWatchInterval * 60_000) || 900_000
-
+    this.idlePollIntervalMillis = device.idleWatchInterval ? (device.idleWatchInterval * 60_000) : config.idleWatchInterval ? (config.idleWatchInterval * 60_000) : 900_000
     const showDockAsContactSensor = device.dockContactSensor === undefined ? true : device.dockContactSensor
     const showRunningAsContactSensor = device.runningContactSensor
     const showBinStatusAsContactSensor = device.binContactSensor

diff --git a/src/platform.ts b/src/platform.ts
@@ -73,7 +73,7 @@ export default class RoombaPlatform implements DynamicPlatformPlugin {
         ...device,
         cleanBehaviour: this.config.cleanBehaviour,
         stopBehaviour: this.config.stopBehaviour,
-        idleWatchInterval: this.config.idleWatchInterval,
+        idleWatchInterval: this.config.idleWatchInterval ?? 900_000,
       }))
     } else {
       this.log.error('No configuration provided for devices.')

diff --git a/src/settings.ts b/src/settings.ts
@@ -15,6 +15,7 @@ export const PLUGIN_NAME = '@homebridge-plugins/homebridge-roomba'
 export interface RoombaPlatformConfig extends PlatformConfig {
     devices: DeviceConfig[]
     disableDiscovery?: boolean
+    idleWatchInterval?: number
     debug?: boolean
 }
 
@@ -32,7 +33,7 @@ export interface DeviceConfig extends Robot {
      * Idle Poll Interval (minutes).
      * How often to poll Roomba's status when it is idle.
      */
-    idleWatchInterval: number
+    idleWatchInterval?: number
 
     dockContactSensor?: boolean
     runningContactSensor?: boolean