hm2mqtt 3.6.0 → 3.6.2

package/README.md

@@ -372,8 +372,8 @@ Same topics for events, variables, programs, counters, `set` and `paramset`. Dif
 ## Development
 
 `npm test` (node:test, no CCU needed), `npm run lint`. `deploy.sh` ships the package (and
-`file:../` siblings) to a host and restarts the `hm2mqtt@*` units. Plan and decisions:
-[ROADMAP.md](ROADMAP.md); changes: [CHANGELOG.md](CHANGELOG.md).
+`file:../` siblings) to a host and restarts the `hm2mqtt@*` units. Plan and decisions: the
+roadmap, kept outside this repository; changes: [CHANGELOG.md](CHANGELOG.md).
 
 ## License
 

package/lib/hadiscovery.js

@@ -635,7 +635,10 @@ function deviceBlock({iface, device, list, ctx, t, st, cmd, bridgeId, ignored})
     }
     const avty = [...availability(name, 2)];
     if (maintenance && maintenance.description.UNREACH && !ignored(iface, maintenance.ADDRESS, 'UNREACH')) {
-        avty.push({t: st(iface, maintenance.ADDRESS, 'UNREACH'), avty_tpl: t.bool('offline', 'online')});
+        // the template of an entry of an availability *list* is `val_tpl`; `avty_tpl` expands to
+        // `availability_template`, which Home Assistant's schema for such an entry does not allow
+        // - and it refuses the whole device payload over it (mqtt-interfaces-core 0.15.2)
+        avty.push({t: st(iface, maintenance.ADDRESS, 'UNREACH'), val_tpl: t.bool('offline', 'online')});
     }
     return {
         id,

package/lib/rpc.js

@@ -22,6 +22,8 @@ export const METHODS = [
 ];
 
 const TX_METHODS = new Set(['setValue', 'putParamset', 'activateLinkParamset']);
+/** a failed init is retried after 2, 4, 8, 16 s, then every INIT_RETRY_MS (the cap) */
+const INIT_BACKOFF_MS = [2000, 4000, 8000, 16000];
 const INIT_RETRY_MS = 30000;
 const DEINIT_TIMEOUT_MS = 1500;
 const CALL_TIMEOUT_MS = 30000;
@@ -48,6 +50,15 @@ export function batchHints(events) {
     return hints;
 }
 
+/**
+ * The delay before the next init attempt.
+ * @param {number} failures failed attempts in a row (1 after the first failure)
+ * @returns {number} ms
+ */
+export function initRetryDelay(failures) {
+    return failures >= 1 && failures <= INIT_BACKOFF_MS.length ? INIT_BACKOFF_MS[failures - 1] : INIT_RETRY_MS;
+}
+
 /**
  * The callback servers the CCU talks to. One http (xmlrpc) and/or one binrpc server, started on
  * demand; calls are routed by their init id to the registered RpcConnection.
@@ -288,6 +299,7 @@ export class RpcConnection extends EventEmitter {
         this.initTimer = null;
         this.pingTimer = null;
         this.lastInitError = null;
+        this.initFailures = 0;
     }
 
     createClient() {
@@ -343,7 +355,7 @@ export class RpcConnection extends EventEmitter {
         });
     }
 
-    /** Connects: init subscription (retried every 30 s while it fails), ping supervision. */
+    /** Connects: init subscription (retried with backoff from 2 s while it fails), ping supervision. */
     async start() {
         this.stopped = false;
         if (!this.wantInit) {
@@ -372,18 +384,33 @@ export class RpcConnection extends EventEmitter {
             this.log.info('rpc', this.name, '> init', url, this.initId);
             await this.methodCall('init', [url, this.initId]);
             this.initialized = true;
+            if (this.initFailures > 0) {
+                this.log.info('rpc', this.name, 'init succeeded after', this.initFailures + 1, 'attempts');
+            }
+            this.initFailures = 0;
             this.lastInitError = null;
             this.setConnected(true);
         } catch (err) {
+            if (this.stopped) {
+                return;
+            }
             const msg = err.message || String(err);
+            this.initFailures += 1;
+            const delay = initRetryDelay(this.initFailures);
             if (msg !== this.lastInitError) {
-                this.log.warn('rpc', this.name, 'init failed:', msg, `- retrying every ${INIT_RETRY_MS / 1000} s`);
+                this.log.warn(
+                    'rpc',
+                    this.name,
+                    'init failed:',
+                    msg,
+                    `- retrying in ${delay / 1000} s (then up to every ${INIT_RETRY_MS / 1000} s)`,
+                );
                 this.lastInitError = msg;
             } else {
-                this.log.debug('rpc', this.name, 'init failed:', msg);
+                this.log.debug('rpc', this.name, 'init failed:', msg, `- next attempt in ${delay / 1000} s`);
             }
             this.setConnected(false);
-            this.initTimer = this.timers.setTimeout(() => this.init(), INIT_RETRY_MS);
+            this.initTimer = this.timers.setTimeout(() => this.init(), delay);
             return;
         }
         if (this.wantPing) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hm2mqtt",
-  "version": "3.6.0",
+  "version": "3.6.2",
   "description": "Interface between Homematic CCU and MQTT",
   "type": "module",
   "main": "index.js",
@@ -70,7 +70,7 @@
     "binrpc": "^3.3.1",
     "homematic-rega": "^2.0.0",
     "homematic-xmlrpc": "^2.0.0",
-    "mqtt-interfaces-core": "^0.15.1"
+    "mqtt-interfaces-core": "^0.15.2"
   },
   "devDependencies": {
     "@eslint/js": "^9.0.0",