hm2mqtt 3.2.0 → 3.2.1

package/README.md

@@ -35,12 +35,12 @@ state directory; broker credentials can live in the shared `/etc/mqtt-interfaces
 `--uninstall -n hm` removes the instance. `--config-schema` prints a JSON schema of all options
 (management UIs like [she](https://github.com/hobbyquaker/she) build their config forms from it).
 
-Docker (build from the Dockerfile — no published image yet):
+Docker (multi-arch image for amd64, arm64 and armv7):
 
 ```
-docker build -t hm2mqtt .
-docker run -d --name hm2mqtt --network host -v hm2mqtt:/data \
-  -e HM2MQTT_CCU_ADDRESS=homematic-ccu3 -e HM2MQTT_MQTT_URL=mqtt://broker hm2mqtt
+docker run -d --name hm2mqtt --restart unless-stopped --network host -v hm2mqtt:/data \
+  -e HM2MQTT_CCU_ADDRESS=homematic-ccu3 -e HM2MQTT_MQTT_URL=mqtt://broker \
+  ghcr.io/hobbyquaker/hm2mqtt.js
 ```
 
 Host networking, or publish 2126/2127 and set `HM2MQTT_INIT_ADDRESS` to the docker host's address

package/lib/compare.js

@@ -39,12 +39,14 @@ function same(a, b) {
 /**
  * @param {Map<string, string>} left item → raw payload (the reference, e.g. the flow)
  * @param {Map<string, string>} right item → raw payload (hm2mqtt)
- * @returns {{leftOnly: string[], rightOnly: string[], differences: Array<{item: string, field: string, left: *, right: *}>, same: number}}
+ * @returns {{leftOnly: string[], rightOnly: string[], differences: Array<{item: string, field: string, left: *, right: *}>,
+ *          additions: Array<{item: string, field: string, right: *}>, same: number}}
  */
 export function compareTrees(left, right) {
     const leftOnly = [];
     const rightOnly = [];
     const differences = [];
+    const additions = [];
     let sameCount = 0;
     for (const item of left.keys()) {
         if (!right.has(item)) {
@@ -73,7 +75,11 @@ export function compareTrees(left, right) {
             if (IGNORED_HM_FIELDS.has(field)) {
                 continue;
             }
-            if (!(field in hl) && ADDED_HM_FIELDS.has(field)) {
+            if (hl[field] === undefined && hr[field] !== undefined) {
+                // a field the reference never had: an addition, not a difference
+                if (!ADDED_HM_FIELDS.has(field)) {
+                    additions.push({item, field: 'hm.' + field, right: hr[field]});
+                }
                 continue;
             }
             if (!same(hl[field], hr[field])) {
@@ -87,17 +93,38 @@ export function compareTrees(left, right) {
     }
     leftOnly.sort();
     rightOnly.sort();
-    return {leftOnly, rightOnly, differences, same: sameCount};
+    return {leftOnly, rightOnly, differences, additions, same: sameCount};
+}
+
+function countBy(list, key) {
+    const counts = new Map();
+    for (const entry of list) {
+        counts.set(entry[key], (counts.get(entry[key]) || 0) + 1);
+    }
+    return [...counts].sort((a, b) => b[1] - a[1]);
 }
 
 export function formatReport(
-    {leftOnly, rightOnly, differences, same},
+    {leftOnly, rightOnly, differences, additions = [], same},
     {leftName = 'left', rightName = 'right', limit = 50} = {},
 ) {
     const lines = [];
+    const differing = new Set(differences.map((d) => d.item)).size;
     lines.push(
-        `${same} items identical, ${differences.length} differences, ${leftOnly.length} only in ${leftName}, ${rightOnly.length} only in ${rightName}`,
+        `${same} items identical, ${differing} items with ${differences.length} differences, ${additions.length} added fields, ${leftOnly.length} only in ${leftName}, ${rightOnly.length} only in ${rightName}`,
     );
+    if (differences.length > 0) {
+        lines.push('', 'differences by field:');
+        for (const [field, n] of countBy(differences, 'field')) {
+            lines.push(`  ${field}: ${n}`);
+        }
+    }
+    if (additions.length > 0) {
+        lines.push('', `fields only in ${rightName} (additions):`);
+        for (const [field, n] of countBy(additions, 'field')) {
+            lines.push(`  ${field}: ${n}`);
+        }
+    }
     const list = (title, items) => {
         if (items.length === 0) {
             return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hm2mqtt",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "description": "Interface between Homematic CCU and MQTT",
   "type": "module",
   "main": "index.js",