hm2mqtt 3.5.1 → 3.6.0

package/lib/names.js

@@ -0,0 +1,49 @@
+/**
+ * What every names provider does with its result, whatever it read it from: apply the name file
+ * on top, index the names for the reverse lookup, and resolve a name or address coming in on a
+ * set topic. Shared by lib/rega.js (ReGaHSS) and lib/meta.js (openccu-lite).
+ */
+
+/**
+ * Overrides the names read from the box with the ones from `--name-file` and returns the reverse
+ * index (name -> address). `channelNames` is mutated, as the providers' own state.
+ * @param {Object<string, string>} channelNames
+ * @param {Object<string, string>} [nameFile]
+ * @returns {Object<string, string>} name -> address
+ */
+export function indexNames(channelNames, nameFile = {}) {
+    for (const [address, name] of Object.entries(nameFile)) {
+        if (typeof name === 'string' && name !== '') {
+            channelNames[address] = name;
+        }
+    }
+    const addresses = {};
+    for (const [address, name] of Object.entries(channelNames)) {
+        // the first address of a duplicate name wins; channels win over devices
+        if (!addresses[name] || (address.includes(':') && !addresses[name].includes(':'))) {
+            addresses[name] = address;
+        }
+    }
+    return addresses;
+}
+
+/**
+ * Address of a channel (or device, with `devices`) by name or address.
+ * @param {{addresses: Object<string, string>, metadata?: object}} provider
+ * @param {string} nameOrAddress
+ * @param {boolean} [devices]
+ */
+export function resolveAddress({addresses, metadata}, nameOrAddress, devices = false) {
+    let address;
+    if (metadata && metadata.findIface(nameOrAddress)) {
+        address = nameOrAddress;
+    } else if (addresses[nameOrAddress]) {
+        address = addresses[nameOrAddress];
+    } else if (!metadata && /^[\w-]+(:\d+)?$/.test(nameOrAddress)) {
+        address = nameOrAddress;
+    }
+    if (!address) {
+        return undefined;
+    }
+    return devices || address.includes(':') ? address : undefined;
+}

package/lib/rega.js

@@ -8,6 +8,7 @@ import fs from 'node:fs';
 import path from 'node:path';
 import {EventEmitter} from 'node:events';
 import {castVariable} from './cast.js';
+import {indexNames, resolveAddress} from './names.js';
 
 export class RegaSync extends EventEmitter {
     /**
@@ -29,6 +30,7 @@ export class RegaSync extends EventEmitter {
         this.nameFile = nameFile || {};
         this.log = log;
         this.now = now || Date.now;
+        this.label = 'rega';
         this.channelNames = {};
         this.addresses = {};
         this.regaIdChannel = {};
@@ -88,18 +90,7 @@ export class RegaSync extends EventEmitter {
     }
 
     applyNameFile() {
-        for (const [address, name] of Object.entries(this.nameFile)) {
-            if (typeof name === 'string' && name !== '') {
-                this.channelNames[address] = name;
-            }
-        }
-        this.addresses = {};
-        for (const [address, name] of Object.entries(this.channelNames)) {
-            // the first address of a duplicate name wins; channels win over devices
-            if (!this.addresses[name] || (address.includes(':') && !this.addresses[name].includes(':'))) {
-                this.addresses[name] = address;
-            }
-        }
+        this.addresses = indexNames(this.channelNames, this.nameFile);
     }
 
     /*
@@ -112,18 +103,7 @@ export class RegaSync extends EventEmitter {
 
     /** Address of a channel (or device, with `devices`) by ReGa name or address. */
     channelAddress(nameOrAddress, devices = false) {
-        let address;
-        if (this.metadata && this.metadata.findIface(nameOrAddress)) {
-            address = nameOrAddress;
-        } else if (this.addresses[nameOrAddress]) {
-            address = this.addresses[nameOrAddress];
-        } else if (!this.metadata && /^[\w-]+(:\d+)?$/.test(nameOrAddress)) {
-            address = nameOrAddress;
-        }
-        if (!address) {
-            return undefined;
-        }
-        return devices || address.includes(':') ? address : undefined;
+        return resolveAddress(this, nameOrAddress, devices);
     }
 
     rooms(address) {

package/lib/topics.js

@@ -17,11 +17,6 @@ export const DEFAULT_TOPIC_SYSVAR_SET = '${prefix}/set/${name}';
 export const DEFAULT_TOPIC_PROGRAM_STATUS = '${prefix}/status/${name}';
 export const DEFAULT_TOPIC_PROGRAM_SET = '${prefix}/set/${name}';
 
-/** The item part of the classic topics, kept for `--item-template` and for the plain mirror tree. */
-export const DEFAULT_ITEM_TEMPLATE = '${channelName|channel}/${datapoint}';
-export const DEFAULT_SYSVAR_ITEM_TEMPLATE = '${name}';
-export const DEFAULT_PROGRAM_ITEM_TEMPLATE = '${name}';
-
 /** first topic levels an adapter uses itself; a channel or variable with such a name gets a suffix */
 export const RESERVED = new Set(['counter', 'interface', 'rega', 'paramset', 'rpc', 'response']);
 
@@ -266,25 +261,52 @@ export function templateRemainder(template, topic, fields = {}) {
     return topic.startsWith(literal) ? topic.slice(literal.length) : null;
 }
 
+const kebab = (name) => name.replace(/[A-Z]/g, (c) => '-' + c.toLowerCase());
+
 /**
  * `--item-template` and its two siblings named the part after `<name>/status/`. They still work:
  * an item template becomes the corresponding pair of topic templates, so an existing config keeps
- * publishing exactly where it did.
+ * publishing exactly where it did. A topic template the user changed wins over the deprecated
+ * option; either way the migration explains itself in `config.$warnings`.
  * @param {object} config
  * @returns {object} the same config, with the topic templates filled in
  */
 export function applyItemTemplates(config) {
     const pairs = [
-        ['itemTemplate', 'topicStatus', 'topicSet'],
-        ['sysvarItemTemplate', 'topicSysvarStatus', 'topicSysvarSet'],
-        ['programItemTemplate', 'topicProgramStatus', 'topicProgramSet'],
+        ['itemTemplate', 'topicStatus', DEFAULT_TOPIC_STATUS, 'topicSet', DEFAULT_TOPIC_SET],
+        [
+            'sysvarItemTemplate',
+            'topicSysvarStatus',
+            DEFAULT_TOPIC_SYSVAR_STATUS,
+            'topicSysvarSet',
+            DEFAULT_TOPIC_SYSVAR_SET,
+        ],
+        [
+            'programItemTemplate',
+            'topicProgramStatus',
+            DEFAULT_TOPIC_PROGRAM_STATUS,
+            'topicProgramSet',
+            DEFAULT_TOPIC_PROGRAM_SET,
+        ],
     ];
-    for (const [item, status, set] of pairs) {
+    for (const [item, status, statusDefault, set, setDefault] of pairs) {
         if (!config[item]) {
             continue;
         }
-        config.$deprecated = config.$deprecated || [];
-        config.$deprecated.push(item);
+        config.$warnings = config.$warnings || [];
+        const changed = [
+            [status, statusDefault],
+            [set, setDefault],
+        ]
+            .filter(([key, fallback]) => config[key] !== fallback)
+            .map(([key]) => '--' + kebab(key));
+        if (changed.length > 0) {
+            config.$warnings.push(
+                `--${kebab(item)} is deprecated and ignored here because ${changed.join(' and ')} ${changed.length > 1 ? 'are' : 'is'} set`,
+            );
+            continue;
+        }
+        config.$warnings.push(`--${kebab(item)} is deprecated - use --${kebab(status)} and --${kebab(set)}`);
         config[status] = '${prefix}/status/' + config[item];
         config[set] = '${prefix}/set/' + config[item];
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hm2mqtt",
-  "version": "3.5.1",
+  "version": "3.6.0",
   "description": "Interface between Homematic CCU and MQTT",
   "type": "module",
   "main": "index.js",
@@ -27,7 +27,8 @@
     "test": "node --test",
     "test:watch": "node --test --watch",
     "deploy": "bash deploy.sh",
-    "test:e2e": "HM2MQTT_E2E=1 node --test --test-force-exit test/e2e.test.js"
+    "test:e2e": "HM2MQTT_E2E=1 node --test --test-force-exit test/e2e.test.js",
+    "test:occulite": "node --test --test-force-exit test/occulite.test.js"
   },
   "repository": {
     "type": "git",

package/scripts/addon-api.js

@@ -9,7 +9,6 @@
  *   node scripts/addon-api.js discover   [--timeout 4000]
  *   node scripts/addon-api.js probe      --host 127.0.0.1 [--tls]
  *   node scripts/addon-api.js mqtt-test  --url mqtt://host:1883 [--username u] [--password p]
- *   node scripts/addon-api.js channels   --host 127.0.0.1 [--limit 20]
  *   node scripts/addon-api.js preview    --host 127.0.0.1 --template '${prefix}/status/${channelName|channel}/${datapoint}' [--prefix hm]
  *
  * Errors are JSON too ({"error": "..."}), so the UI never has to parse a stack trace.
@@ -17,7 +16,7 @@
 
 import Rega from 'homematic-rega';
 import {discover} from 'mqtt-interfaces-core';
-import {probeInterfaces, detectLocal, INTERFACE_NAMES} from '../lib/interfaces.js';
+import {probeInterfaces, detectLocal, isLocalHost, regaPort, INTERFACE_NAMES} from '../lib/interfaces.js';
 import {discoveryHint, interfacesOf} from '../lib/discovery.js';
 import {compileTemplate, DEFAULT_TOPIC_STATUS} from '../lib/topics.js';
 
@@ -53,10 +52,9 @@ const args = parseArgs(rest);
  * @returns {Rega}
  */
 function rega({host = '127.0.0.1', port, username, password} = {}) {
-    const local = host === '127.0.0.1' || host === 'localhost';
     return new Rega({
         host,
-        port: port ? Number(port) : local ? 8183 : 8181,
+        port: port ? Number(port) : regaPort({local: isLocalHost(host)}),
         username,
         password,
         translate: false,
@@ -117,15 +115,6 @@ const commands = {
         }
     },
 
-    async channels() {
-        const limit = Number(args.limit || 20);
-        const channels = await rega(args).getChannels();
-        return {
-            count: channels.length,
-            channels: channels.slice(0, limit).map(({address, name}) => ({address, name})),
-        };
-    },
-
     async preview() {
         const template = String(args.template || DEFAULT_TOPIC_STATUS);
         const prefix = String(args.prefix || 'hm');