hm2mqtt 2.5.0 → 3.0.0

package/scripts/clean-retained.js

@@ -0,0 +1,69 @@
+#!/usr/bin/env node
+
+/**
+ * Lists (and with --yes clears) retained messages matching topic patterns — for the cutover
+ * (ROADMAP §9): the Node-RED flow left retained topics for unnamed channels (`hm/status//X`)
+ * and for devices and names that no longer exist.
+ *
+ *   node scripts/clean-retained.js mqtt://broker 'hm/status//#'            # list only
+ *   node scripts/clean-retained.js mqtt://broker 'hm/status//#' 'hm3/#' --yes
+ *   node scripts/clean-retained.js mqtts://broker:8883 'hm/#' --ca ca.pem --grep 'Alte Lampe'
+ */
+
+import fs from 'node:fs';
+import mqtt from 'mqtt';
+
+const args = process.argv.slice(2);
+const take = (flag) => {
+    const i = args.indexOf(flag);
+    return i === -1 ? undefined : args.splice(i, 2)[1];
+};
+const ca = take('--ca');
+const grep = take('--grep');
+const seconds = Number(take('--seconds') || 5);
+const yes = args.includes('--yes');
+const patterns = args.filter((a) => !a.startsWith('--') && a !== args[0]);
+const url = args[0];
+if (!url || patterns.length === 0) {
+    console.error(
+        'usage: clean-retained.js <mqtt-url> <pattern>... [--grep <substring>] [--seconds 5] [--ca file] [--yes]',
+    );
+    process.exit(1);
+}
+
+const found = new Map();
+const client = mqtt.connect(url, {ca: ca ? fs.readFileSync(ca) : undefined, rejectUnauthorized: Boolean(ca)});
+client.on('connect', () => {
+    client.subscribe(patterns);
+    console.error(`collecting retained messages for ${patterns.join(', ')} (${seconds} s) …`);
+});
+client.on('message', (topic, payload, packet) => {
+    if (packet.retain && payload.length > 0 && (!grep || topic.includes(grep))) {
+        found.set(topic, payload.toString().slice(0, 80));
+    }
+});
+setTimeout(() => {
+    const topics = [...found.keys()].sort();
+    for (const t of topics) {
+        console.log(`${t}  ${found.get(t)}`);
+    }
+    console.error(`${topics.length} retained topics`);
+    if (!yes) {
+        console.error('dry run — add --yes to clear them');
+        client.end(true);
+        return;
+    }
+    let n = 0;
+    for (const t of topics) {
+        client.publish(t, '', {retain: true}, () => {
+            n += 1;
+            if (n === topics.length) {
+                console.error(`cleared ${n}`);
+                client.end(true);
+            }
+        });
+    }
+    if (topics.length === 0) {
+        client.end(true);
+    }
+}, seconds * 1000);

package/scripts/compare-trees.js

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+
+/**
+ * Parallel-run check before the cutover (ROADMAP §9): subscribes to two status trees on the same
+ * broker, collects the retained state plus everything published while running, and prints
+ * what differs. Ignores the fields that legitimately differ (timestamps, cache flags).
+ *
+ *   node scripts/compare-trees.js mqtt://broker hm hm3 [seconds]
+ *   node scripts/compare-trees.js mqtts://user:pass@broker:8883 hm hm3 3600 --ca ca.pem
+ */
+
+import fs from 'node:fs';
+import mqtt from 'mqtt';
+import {compareTrees, formatReport} from '../lib/compare.js';
+
+const args = process.argv.slice(2);
+const caIndex = args.indexOf('--ca');
+const ca = caIndex === -1 ? undefined : fs.readFileSync(args.splice(caIndex, 2)[1]);
+const [url, leftName, rightName, seconds = '60'] = args;
+if (!url || !leftName || !rightName) {
+    console.error('usage: compare-trees.js <mqtt-url> <left-prefix> <right-prefix> [seconds] [--ca file]');
+    process.exit(1);
+}
+
+const left = new Map();
+const right = new Map();
+const client = mqtt.connect(url, {ca, rejectUnauthorized: Boolean(ca)});
+client.on('connect', () => {
+    client.subscribe([`${leftName}/status/#`, `${rightName}/status/#`]);
+    console.error(`collecting ${leftName}/status/# and ${rightName}/status/# for ${seconds} s …`);
+});
+client.on('message', (topic, payload) => {
+    const raw = payload.toString();
+    if (topic.startsWith(`${leftName}/status/`)) {
+        left.set(topic.slice(leftName.length + 8), raw);
+    } else if (topic.startsWith(`${rightName}/status/`)) {
+        right.set(topic.slice(rightName.length + 8), raw);
+    }
+});
+setTimeout(
+    () => {
+        client.end(true);
+        console.log(formatReport(compareTrees(left, right), {leftName, rightName}));
+    },
+    Number(seconds) * 1000,
+);

package/.npmignore

@@ -1,4 +0,0 @@
-node_modules
-.DS_Store
-.idea
-.nyc_output

package/.travis.yml

@@ -1,40 +0,0 @@
-sudo: true
-
-before_install:
-  - sudo apt-add-repository ppa:mosquitto-dev/mosquitto-ppa -y
-  - sudo apt-get update -y
-  - sudo apt-get install mosquitto -y
-
-services:
-  - docker
-
-before_script:
-  - sudo apt-get --yes --no-install-recommends install binfmt-support qemu-user-static
-  - echo ':arm:M::\x7fELF\x01\x01\x01\x00\x00\x00\x00\x00\x00\x00\x00\x00\x02\x00\x28\x00:\xff\xff\xff\xff\xff\xff\xff\x00\xff\xff\xff\xff\xff\xff\xff\xff\xfe\xff\xff\xff:/usr/bin/qemu-arm-static:' | sudo tee -a /proc/sys/fs/binfmt_misc/register
-
-jobs:
-  include:
-    - stage: test
-      script:
-      - nvm install 6
-      - npm install
-      - npm test
-      after_success: skip
-    - stage: build docker image
-      script:
-        - docker login -u="$DOCKER_USERNAME" -p="$DOCKER_PASSWORD"
-        - docker build -f Dockerfile.armhf -t hm2mqtt_armhf .
-        - docker images
-        - export TAG=`if [ "$TRAVIS_BRANCH" == "master" ]; then echo $(npm view hm2mqtt version); else echo -$TRAVIS_BRANCH ; fi`
-        - docker tag hm2mqtt_armhf mqttsmarthome/hm2mqtt_armhf:$TAG
-        - docker tag hm2mqtt_armhf mqttsmarthome/hm2mqtt_armhf:latest
-    - stage: test docker image
-      script:
-        - export TAG=`if [ "$TRAVIS_BRANCH" == "master" ]; then echo $(npm view hm2mqtt version); else echo -$TRAVIS_BRANCH ; fi`
-        - docker run -d mqttsmarthome/hm2mqtt_armhf:$TAG
-        - docker ps | grep armhf
-after_success:
-    - export TAG=`if [ "$TRAVIS_BRANCH" == "master" ]; then echo $(npm view hm2mqtt version); else echo -$TRAVIS_BRANCH ; fi`
-    - docker login -u="$DOCKER_USERNAME" -p="$DOCKER_PASSWORD"
-    - docker push mqttsmarthome/hm2mqtt_armhf:$TAG
-    - docker push mqttsmarthome/hm2mqtt_armhf:latest

package/Dockerfile

@@ -1,10 +0,0 @@
-FROM node:slim
-LABEL maintainer="Holger Imbery <contact@connectedobjects.cloud>" \
-      version="1.1a" \
-      description="HM2MQTT (hm2mqtt.js) dockerized version of https://github.com/hobbyquaker/hm2mqtt.js"
-
-RUN npm config set unsafe-perm true && npm install -g hm2mqtt
-
-EXPOSE 2126
-EXPOSE 2127
-ENTRYPOINT ["hm2mqtt"]

package/Dockerfile.armhf

@@ -1,11 +0,0 @@
-FROM hypriot/rpi-node:slim
-LABEL maintainer="Holger Imbery <contact@connectedobjects.cloud>" \
-      version="1.1a" \
-      description="HM2MQTT (hm2mqtt.js) dockerized version of https://github.com/hobbyquaker/hm2mqtt.js"
-
-RUN npm config set unsafe-perm true
-RUN npm install -g hm2mqtt
-
-EXPOSE 2126
-EXPOSE 2127
-ENTRYPOINT ["hm2mqtt"]

package/discover.js

@@ -1,24 +0,0 @@
-const net = require('net');
-
-module.exports = (host, interfaces, callback) => {
-    const sum = Object.keys(interfaces).length;
-    const connections = {};
-    let count = 0;
-
-    Object.keys(interfaces).forEach(service => {
-        connections[service] = net.connect({host, port: interfaces[service].port}, () => {
-            connections[service].end();
-            checkDone();
-        });
-        connections[service].on('error', () => {
-            delete interfaces[service];
-            checkDone();
-        });
-    });
-
-    function checkDone() {
-        if (++count >= sum) {
-            callback(interfaces);
-        }
-    }
-};

package/firstip.js

@@ -1,16 +0,0 @@
-const os = require('os');
-
-const interfaces = os.networkInterfaces();
-const addresses = [];
-Object.keys(interfaces).forEach(i => {
-    Object.keys(interfaces[i]).forEach(a => {
-        const address = interfaces[i][a];
-        if (address.family === 'IPv4' && !address.internal) {
-            addresses.push(address.address);
-        }
-    });
-});
-
-const [firstAddress] = addresses;
-
-module.exports = firstAddress;

package/regascripts/devices.fn

@@ -1,43 +0,0 @@
-!# devices.fn hm2mqtt
-!#
-!# Dieses Homematic-Script gibt eine Liste aller Geraete/Kanaele im JSON Format aus
-!#
-!# 3'2013-4'2017 hobbyquaker https://github.com/hobbyquaker
-!#
-
-string sDevId;
-string sChnId;
-
-Write('{');
-
-boolean dFirst = true;
-
-foreach (sDevId, root.Devices().EnumUsedIDs()) {
-
-    object oDevice   = dom.GetObject(sDevId);
-    boolean bDevReady = oDevice.ReadyConfig();
-
-    if (bDevReady) {
-
-        if (dFirst) {
-          dFirst = false;
-        } else {
-          WriteLine(',');
-        }
-
-        Write('"' # oDevice.Address() # '":"');
-        WriteURL(oDevice.Name());
-        Write('"');
-
-        foreach(sChnId, oDevice.Channels()) {
-        	object oChannel = dom.GetObject(sChnId);
-            WriteLine(',');
-          	Write('"' # oChannel.Address() # '":"');
-        	WriteURL(oChannel.Name());
-        	Write('"');
-        }
-
-    }
-}
-
-Write('}');

package/regascripts/programs.fn

@@ -1,27 +0,0 @@
-!# programs.fn hm2mqtt
-!# Dieses Script gibt eine Liste der Programme im JSON Format aus
-!#
-!# 3'2013-4'2017 hobbyquaker https://github.com/hobbyquaker
-!#
-
-string oPrgID;
-object oProgram;
-boolean first = true;
-Write('{');
-foreach (oPrgID, dom.GetObject(ID_PROGRAMS).EnumUsedIDs()) {
-  oProgram = dom.GetObject(oPrgID);
-  if(oProgram != null) {
-    if (first == false) {
-      WriteLine(',');
-    } else {
-      first = false;
-    }
-    Write('"' # oPrgID # '":{"name":"');
-    WriteURL(oProgram.Name());
-    Write('", "active":' # oProgram.Active());
-    Write(',"ts":"' # oProgram.ProgramLastExecuteTime());
-    Write('"}');
-
-  }
-}
-Write('}');

package/regascripts/variables.fn

@@ -1,78 +0,0 @@
-!# variables.fn hm2mqtt
-!#
-!# Dieses Script gibt die Systemvariablen im JSON Format aus
-!#
-!# 3'2013-4'2017 hobbyquaker https://github.com/hobbyquaker
-!#
-
-object oSysVar;
-string sSysVarId;
-string sValueType;
-string sValue;
-boolean bFirst = true;
-
-Write('{');
-
-WriteLine('"40":{"name":"Alarmmeldungen","val":' # dom.GetObject(40).Value() # ',"min":0,"max":65000,"unit":"","type":16,"enum":""},');
-Write('"41":{"name":"Servicemeldungen","val":' # dom.GetObject(41).Value() # ',"min":0,"max":65000,"unit":"","type":16,"enum":""}');
-
-foreach (sSysVarId, dom.GetObject(ID_SYSTEM_VARIABLES).EnumUsedIDs()) {
-
-  WriteLine(',');
-
-  oSysVar     = dom.GetObject(sSysVarId);
-  sValueType  = oSysVar.ValueType();
-
-  Write('"' # sSysVarId # '":{"name":"');
-  WriteURL(oSysVar.Name());
-  Write('","val":');
-  if (sValueType == 20) {
-    Write('"');
-  	WriteURL(oSysVar.Value());
-    Write('"');
-  } else {
-    sValue = oSysVar.Value();
-    if (sValueType == 2) {
-        if (sValue) {
-            Write("true");
-        } else {
-            Write("false");
-        }
-    } else {
-       if (sValue == "") {
-            Write("0");
-       } else {
-            Write(sValue);
-       }
-    }
-  }
-  string sValueMin = oSysVar.ValueMin();
-
-  if (sValueMin == '') {
-      sValueMin = 'null';
-  }
-
-  string sValueMax = oSysVar.ValueMax();
-
-  if (sValueMax == '') {
-      sValueMax = 'null';
-  }
-
-  Write(',"ts":"' # oSysVar.Timestamp());
-  Write('","min":' # sValueMin # ',"max":' # sValueMax # ',"unit":"');
-  WriteURL(oSysVar.ValueUnit());
-  Write('","type":' # sValueType);
-
-  if (sValueType == 2) {
-    Write(',"enum":"');
-    WriteURL(oSysVar.ValueName0() # ';' # oSysVar.ValueName1());
-  } else {
-    Write(',"enum":"');
-    WriteURL(oSysVar.ValueList());
-  }
-
-  Write('"}');
-
-}
-
-Write('}');

package/test.js

@@ -1,201 +0,0 @@
-#!/usr/bin/env node
-
-require('should');
-
-const cp = require('child_process');
-const request = require('request');
-const path = require('path');
-const streamSplitter = require('stream-splitter');
-const Mqtt = require('mqtt');
-mqtt = Mqtt.connect('mqtt://127.0.0.1');
-
-const simCmd = path.join(__dirname, '/node_modules/.bin/hm-simulator');
-const simArgs = [];
-let sim;
-let simPipeOut;
-let simPipeErr;
-const simSubscriptions = {};
-const simBuffer = [];
-
-const hmCmd = path.join(__dirname, '/index.js');
-const hmArgs = ['--mqtt-url', 'mqtt://127.0.0.1:1883', '--ccu-address', '127.0.0.1', '-v', 'debug'];
-let hm;
-let hmPipeOut;
-let hmPipeErr;
-const hmSubscriptions = {};
-const hmBuffer = [];
-
-let subIndex = 0;
-
-function subscribe(type, rx, cb) {
-    subIndex += 1;
-    if (type === 'sim') {
-        simSubscriptions[subIndex] = {rx, cb};
-    } else if (type === 'hm') {
-        hmSubscriptions[subIndex] = {rx, cb};
-    }
-    matchSubscriptions(type);
-    return subIndex;
-}
-
-function unsubscribe(type, subIndex) {
-    if (type === 'sim') {
-        delete simSubscriptions[subIndex];
-    } else if (type === 'hm') {
-        delete hmSubscriptions[subIndex];
-    }
-}
-
-function matchSubscriptions(type, data) {
-    let subs;
-    let buf;
-    if (type === 'sim') {
-        subs = simSubscriptions;
-        buf = simBuffer;
-    } else if (type === 'hm') {
-        subs = hmSubscriptions;
-        buf = hmBuffer;
-    }
-    if (data) {
-        buf.push(data);
-    }
-    buf.forEach((line, index) => {
-        Object.keys(subs).forEach(key => {
-            const sub = subs[key];
-            if (line.match(sub.rx)) {
-                sub.cb(line);
-                delete subs[key];
-                buf.splice(index, 1);
-            }
-        });
-    });
-}
-
-function startHm() {
-    hm = cp.spawn(hmCmd, hmArgs);
-    hmPipeOut = hm.stdout.pipe(streamSplitter('\n'));
-    hmPipeErr = hm.stderr.pipe(streamSplitter('\n'));
-    hmPipeOut.on('token', data => {
-        console.log('hm', data.toString());
-        matchSubscriptions('hm', data.toString());
-    });
-    hmPipeErr.on('token', data => {
-        console.log('hm', data.toString());
-        matchSubscriptions('hm', data.toString());
-    });
-}
-
-function startSim() {
-    sim = cp.spawn(simCmd, simArgs);
-    simPipeOut = sim.stdout.pipe(streamSplitter('\n'));
-    simPipeErr = sim.stderr.pipe(streamSplitter('\n'));
-    simPipeOut.on('token', data => {
-        console.log('sim', data.toString());
-        matchSubscriptions('sim', data.toString());
-    });
-    simPipeErr.on('token', data => {
-        console.log('sim', data.toString());
-        matchSubscriptions('sim', data.toString());
-    });
-}
-
-function end(code) {
-    if (hm.kill) {
-        hm.kill();
-    }
-    if (sim.kill) {
-        sim.kill();
-    }
-    if (typeof code !== 'undefined') {
-        process.exit(code);
-    }
-}
-
-process.on('SIGINT', () => {
-    end(1);
-});
-
-process.on('exit', () => {
-    end();
-});
-
-describe('start daemons', () => {
-    it('hm-simulator should start without error', function (done)  {
-        this.timeout(20000);
-        subscribe('sim', /binrpc server listening/, data => {
-            done();
-        });
-        startSim();
-
-    });
-    it('hm2mqtt should start without error', function (done) {
-        this.timeout(20000);
-        subscribe('hm', /hm2mqtt [0-9.]+ starting/, data => {
-            done();
-        });
-        startHm();
-    });
-});
-
-describe('hm2mqtt - mqtt connection', () => {
-    it('hm2mqtt should connect to the mqtt broker', function (done) {
-        this.timeout(12000);
-        subscribe('hm', /mqtt connected/, data => {
-            done();
-        });
-    });
-});
-
-describe('hm2mqtt - hm-simulator connection', () => {
-    it('hm2mqtt should have rfd devices', function (done) {
-        this.timeout(12000);
-        subscribe('hm', /rfd got [0-9]+ devices and channels/, data => {
-            done();
-        });
-    });
-    it('hm2mqtt should have hmip devices', function (done) {
-        this.timeout(12000);
-        subscribe('hm', /hmip got [0-9]+ devices and channels/, data => {
-            done();
-        });
-    });
-    it('hm2mqtt should save paramsetDescriptions (1)', function (done) {
-        this.timeout(180000);
-        subscribe('hm', /saving paramsetDescriptions/, data => {
-            done();
-        });
-    });
-    it('hm2mqtt should save paramsetDescriptions (2)', function (done) {
-        this.timeout(180000);
-        subscribe('hm', /saving paramsetDescriptions/, data => {
-            done();
-        });
-    });
-});
-
-describe('hm2mqtt - hm-simulator - mqtt', () => {
-    it('hm2mqtt should receive a BidCoS-RF:1 PRESS_SHORT event', function (done) {
-        this.timeout(12000);
-        subscribe('hm', /rpc < event \["hm2mqtt_rfd","BidCoS-RF:1","PRESS_SHORT",true\]/, data => {
-            done();
-        });
-    });
-    it('hm2mqtt should publish a mqtt message on hm/status/BidCoS-RF:1/PRESS_SHORT', function (done) {
-        this.timeout(12000);
-        subscribe('hm', /mqtt > hm\/status\/BidCoS-RF:1\/PRESS_SHORT/, data => {
-            done();
-        });
-    });
-    it('hm2mqtt should publish a BidCoS-RF:2 PRESS_SHORT event', function (done) {
-        this.timeout(12000);
-        subscribe('hm', /mqtt > hm\/status\/BidCoS-RF:2\/PRESS_SHORT/, data => {
-            done();
-        });
-        mqtt.publish('hm/set/BidCoS-RF:2/PRESS_SHORT', 'true');
-    });
-});
-
-setTimeout(() => {
-    hm2mqtt.kill();
-    process.exit(1);
-}, 30000);