hm2mqtt 3.0.0 → 3.1.0

package/README.md

@@ -66,7 +66,7 @@ so the CCU can call back. `--restart unless-stopped` brings it back after `maint
 | `-m, --name-file`                                                                                                                            | —                                                 | JSON `{address: name}` overriding ReGa names ([example-names.json](example-names.json))                            |
 | `--item-template`, `--sysvar-item-template`, `--program-item-template`                                                                       | `${channelName\|channel}/${datapoint}`, `${name}` | how items (topic parts) are built, see [Item templates](#item-templates)                                           |
 | `--rega-names-interval`                                                                                                                      | 3600                                              | seconds between re-reads of names/rooms/functions (0 = only at start and on `set/rega/sync`)                       |
-| `--hm-payload` / `--no-hm-payload`                                                                                                           | on                                                | the `hm` meta data block in status payloads ([Payloads](#payloads))                                                |
+| `--payload`                                                                                                                                  | `mqsh-extended`                                   | status payload format: `mqsh-extended`, `mqsh-basic` or `plain` ([Payloads](#payloads))                            |
 | `--plain-tree <level>`                                                                                                                       | —                                                 | additionally publish plain payloads under `<name>/<level>/…` (the second `ccu-mqtt` node of the Node-RED flow)     |
 | `--publish-cache`                                                                                                                            | off                                               | publish every datapoint value known to the ReGa at start (thousands of retained messages)                          |
 | `--publish-counters`, `--duty-cycle-interval`                                                                                                | on, 90                                            | rpc rx/tx counters and `listBidcosInterfaces` duty cycle polling (0 = off)                                         |
@@ -165,9 +165,10 @@ meta data block of node-red-contrib-ccu's messages, field for field:
 `ENUM` datapoints carry `datapointEnum` (the value list) and `valueEnum` (the name of the current
 value). Variables have `type: "SYSVAR"` with `valueType`, `unit`, `enum`, `valueEnum`, `id` and —
 when bound to a channel — the channel fields; programs `type: "PROGRAM"` with `active`,
-`activePrevious`, `ts` (last execution). `--no-hm-payload` leaves `{val, ts, lc}`,
-`--no-json-payloads` publishes the bare value. `--plain-tree state` mirrors every item to
-`<name>/state/…` with plain values and booleans as `0`/`1`.
+`activePrevious`, `ts` (last execution). `--payload` selects the format the way the `ccu-mqtt` node did:
+`mqsh-extended` (default, as above), `mqsh-basic` (`{val, ts, lc}`) or `plain` (the bare value,
+booleans as `0`/`1`). `--plain-tree state` additionally mirrors every item to `<name>/state/…` in
+the plain format (the second `ccu-mqtt` node of a flow).
 
 ## Names
 

package/config.js

@@ -76,7 +76,14 @@ export const OPTIONS = {
         default: DEFAULT_SYSVAR_ITEM_TEMPLATE,
     },
     'program-item-template': {type: 'string', describe: 'item of a program', default: DEFAULT_PROGRAM_ITEM_TEMPLATE},
-    'hm-payload': {type: 'boolean', describe: 'add the "hm" meta data block to every status payload', default: true},
+    payload: {
+        type: 'string',
+        describe:
+            'status payload format: mqsh-extended ({val, ts, lc, hm}), mqsh-basic ({val, ts, lc}) or plain (value only, booleans as 0/1)',
+        choices: ['plain', 'mqsh-basic', 'mqsh-extended'],
+        default: 'mqsh-extended',
+    },
+    'hm-payload': {type: 'boolean', describe: 'deprecated: --no-hm-payload = --payload mqsh-basic', hidden: true},
     'plain-tree': {
         type: 'string',
         describe: 'additionally publish plain payloads under <name>/<level>/... (e.g. "state")',

package/index.js

@@ -77,11 +77,32 @@ if (config.nameFile) {
     nameFile = JSON.parse(fs.readFileSync(path.resolve(config.nameFile), 'utf8'));
 }
 
+/*
+ * payload format (node-red-contrib-ccu's mqsh-extended / mqsh-basic / plain)
+ */
+let payloadFormat = config.payload;
+if (config.hmPayload === false && payloadFormat === 'mqsh-extended') {
+    payloadFormat = 'mqsh-basic';
+}
+if (!config.jsonPayloads) {
+    payloadFormat = 'plain';
+}
+config.jsonPayloads = payloadFormat !== 'plain';
+const withHm = payloadFormat === 'mqsh-extended';
+/** the value as published: plain format uses node-red's 0/1 for booleans */
+const outValue = (value) => (payloadFormat === 'plain' ? plainValue(value) : value);
+
 const adapter = createAdapter({
     pkg,
     config,
     deviceLabel: 'ccu',
-    info: () => ({ccu: host, interfaces: enabled, devices: metadata.count(), rega: Boolean(regaSync)}),
+    info: () => ({
+        ccu: host,
+        interfaces: enabled,
+        devices: metadata.count(),
+        rega: Boolean(regaSync),
+        payload: payloadFormat,
+    }),
     onSet: handleSet,
     subscriptions: {
         'paramset/#': handleParamset,
@@ -212,8 +233,8 @@ function publishPlain(item, value, retain) {
 
 function publishMessage(message, {retain = true} = {}) {
     const item = rendered(renderItem, message, message.datapointName);
-    const extra = config.hmPayload ? {hm: hmBlock(message)} : undefined;
-    pubStatus(item, message.value, {retain, extra, ts: message.ts, lc: message.lc});
+    const extra = withHm ? {hm: hmBlock(message)} : undefined;
+    pubStatus(item, outValue(message.value), {retain, extra, ts: message.ts, lc: message.lc});
     publishPlain(item, message.value, retain);
 }
 
@@ -221,13 +242,13 @@ function publishRega(message) {
     const render = message.type === 'PROGRAM' ? renderProgramItem : renderSysvarItem;
     const item = rendered(render, message, `${message.type} ${message.name}`);
     itemIndex.add(item, {kind: message.type === 'PROGRAM' ? 'program' : 'sysvar', name: message.name});
-    const extra = config.hmPayload ? {hm: hmBlock(message)} : undefined;
-    pubStatus(item, message.value, {retain: true, extra, ts: message.ts, lc: message.lc});
+    const extra = withHm ? {hm: hmBlock(message)} : undefined;
+    pubStatus(item, outValue(message.value), {retain: true, extra, ts: message.ts, lc: message.lc});
     publishPlain(item, message.value, true);
 }
 
 function publishItem(item, value, {retain = true} = {}) {
-    pubStatus(item, value, {retain});
+    pubStatus(item, outValue(value), {retain});
     publishPlain(item, value, retain);
 }
 

package/package.json

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