node-red-contrib-ccu 4.1.0 → 4.3.0

package/nodes/ccu-connection.html

@@ -16,7 +16,9 @@
 
             regaPoll: {value: true},
             regaInterval: {value: 30},
+            regaMetaInterval: {value: 15},
 
+            rpcPing: {value: true},
             rpcPingTimeout: {value: 60},
             rpcInitAddress: {value: ''},
             rpcServerHost: {value: '', required: true},
@@ -39,6 +41,18 @@
         },
 
         oneditprepare() {
+            // pre-4.3.0 config nodes have neither property - show the defaults
+            // the runtime uses rather than an unchecked box / empty field
+            if (typeof this.rpcPing === 'undefined') {
+                this.rpcPing = true;
+                $('#node-config-input-rpcPing').prop('checked', true);
+            }
+
+            if (typeof this.regaMetaInterval === 'undefined') {
+                this.regaMetaInterval = 15;
+                $('#node-config-input-regaMetaInterval').val(15);
+            }
+
             const $nodeConfigInputHost = $('#node-config-input-host');
             const $nodeConfigInputName = $('#node-config-input-name');
             const $nodeConfigInputRpcServerHost = $('#node-config-input-rpcServerHost');
@@ -178,6 +192,13 @@
             <input type="text" id="node-config-input-jackPort" style="width: 70px;" placeholder="2121">
         </div>
     </div>
+    <div class="form-row">
+        <label for="node-config-input-rpcPing"><i class="icon-tag"></i> RPC ping</label>
+        <div style="width: 70%; display: inline-block; vertical-align: text-top;">
+            <label class="ccu-checkbox"><input type="checkbox" id="node-config-input-rpcPing"> Enabled</label><br>
+            <small>Off disables the periodic ping and the timeout-triggered re-init for this connection.</small>
+        </div>
+    </div>
     <div class="form-row">
         <label for="node-config-input-rpcPingTimeout"><i class="icon-tag"></i> RPC ping timeout (s)</label>
         <input type="text" id="node-config-input-rpcPingTimeout">
@@ -192,6 +213,11 @@
         <label for="node-config-input-regaInterval"><i class="icon-tag"></i> Rega poll interval (s)</label>
         <input type="text" id="node-config-input-regaInterval">
     </div>
+    <div class="form-row">
+        <label for="node-config-input-regaMetaInterval"><i class="icon-tag"></i> Names/rooms refresh (min)</label>
+        <input type="text" id="node-config-input-regaMetaInterval">
+        <small>How often channel names, rooms and functions are re-read. 0 = never (the behaviour before 4.3.0).</small>
+    </div>
     <div class="form-row">
         <label for="node-config-input-queueTimeout"><i class="icon-tag"></i> Queue timeout (ms)</label>
         <input type="text" id="node-config-input-queueTimeout">

package/nodes/ccu-connection.js

@@ -9,6 +9,7 @@ const {castValue, castSysvar} = require('./lib/cast.js');
 const {combinedParameterValue} = require('./lib/combined.js');
 const {createMessage} = require('./lib/message.js');
 const {topicReplace} = require('./lib/topic.js');
+const {isLocalCcu} = require('./lib/localccu.js');
 const {bestMatch} = require('./lib/similarity.js');
 const nextport = require('./lib/nextport.js');
 const hmDiscover = require('./lib/discover.js');
@@ -208,6 +209,39 @@ module.exports = function (RED) {
                     break;
                 }
 
+                case 'devices': {
+                    // ccu-homeassistant editor: every device (not channel) of every, or the
+                    // given, interface with its channels
+                    const all = (config.metadata && config.metadata.devices) || {};
+                    const ifaces = request.query.iface ? [request.query.iface] : Object.keys(all);
+                    ifaces.forEach((iface) => {
+                        const devices = all[iface] || {};
+                        Object.keys(devices).forEach((addr) => {
+                            const device = devices[addr];
+                            if (!device || device.PARENT) {
+                                return;
+                            }
+
+                            object[addr] = {
+                                name: config.channelNames[addr],
+                                type: device.TYPE,
+                                iface,
+                                firmware: device.FIRMWARE,
+                                channels: (device.CHILDREN || [])
+                                    .filter((ch) => devices[ch])
+                                    .map((ch) => ({
+                                        address: ch,
+                                        name: config.channelNames[ch],
+                                        type: devices[ch].TYPE,
+                                    })),
+                            };
+                        });
+                    });
+
+                    res.status(200).send(JSON.stringify(object));
+                    break;
+                }
+
                 case 'rooms':
                     res.status(200).send(
                         JSON.stringify({
@@ -374,15 +408,13 @@ module.exports = function (RED) {
 
             this.checkDuplicateConfig(config);
 
-            this.isLocal = false;
-            if (config.host.startsWith('127.') || config.host === 'localhost') {
-                try {
-                    const rfdConf = fs.readFileSync('/etc/lighttpd/conf.d/proxy.conf').toString();
-                    if (rfdConf.match(/"port"\s+=>\s+32001/)) {
-                        this.logger.info('local connection on ccu >= v3.41 detected');
-                        this.isLocal = true;
-                    }
-                } catch {}
+            // B-4: this used to grep /etc/lighttpd/conf.d/proxy.conf for the
+            // direct port. That file is a bare include on current firmware, so
+            // the check never matched and every local install went through the
+            // proxy. Ask the kernel for a listener instead.
+            this.isLocal = isLocalCcu(config.host);
+            if (this.isLocal) {
+                this.logger.info('local connection on ccu >= v3.41 detected');
             }
 
             this.ifaceTypes = {
@@ -496,6 +528,10 @@ module.exports = function (RED) {
             this.rpcBinPort = Number.parseInt(config.rpcBinPort, 10);
             this.rpcXmlPort = Number.parseInt(config.rpcXmlPort, 10);
             this.rpcPingTimeout = Number.parseInt(config.rpcPingTimeout, 10) || 60;
+            // #44: opt out of the periodic ping/timeout supervision. Off means
+            // no pings and no timeout-triggered re-init for this connection -
+            // reconnecting after a CCU restart is then up to the CCU.
+            this.rpcPingEnabled = config.rpcPing === undefined ? true : Boolean(config.rpcPing);
             this.rpcPingTimer = {};
             this.ifaceStatus = {};
             this.serverError = {};
@@ -506,6 +542,10 @@ module.exports = function (RED) {
 
             this.regaEnabled = config.regaEnabled;
             this.regaPollEnabled = config.regaPoll;
+            // #167: minutes between re-reads of channel names, rooms and
+            // functions. 0 switches it off.
+            this.regaMetaInterval =
+                config.regaMetaInterval === undefined ? 15 : Number.parseInt(config.regaMetaInterval, 10) || 0;
             this.regaInterval = Number.parseInt(config.regaInterval, 10);
             this.hadTimeout = new Set();
 
@@ -599,6 +639,7 @@ module.exports = function (RED) {
             });
 
             if (config.regaEnabled) {
+                this.lastRegaDataRefresh = now();
                 this.getRegaData().then(() => {
                     this.regaPoll();
                     this.initIfaces(config);
@@ -688,8 +729,10 @@ module.exports = function (RED) {
          * @returns {*}
          */
         deregister(node, done) {
-            delete node.users[node.id];
-            return done();
+            delete this.users[node.id];
+            if (typeof done === 'function') {
+                done();
+            }
         }
 
         /**
@@ -1049,7 +1092,14 @@ module.exports = function (RED) {
                             const ts = dp.ts;
                             const [iface, channel, datapoint] = dp.name.split('.');
                             if (this.enabledIfaces.includes(iface) && datapoint) {
-                                if (['RSSI_DEVICE', 'RSSI_PEER'].includes(datapoint)) {
+                                if (
+                                    ['RSSI_DEVICE', 'RSSI_PEER'].includes(datapoint) &&
+                                    typeof dp.value === 'number' &&
+                                    dp.value > 127
+                                ) {
+                                    // the ReGa reports the unsigned byte; without
+                                    // the guard an already-signed value or the 0
+                                    // for "never received" became -318 / -256 (#183)
                                     dp.value -= 256;
                                 }
 
@@ -1285,7 +1335,12 @@ module.exports = function (RED) {
         regaPoll() {
             //this.logger.trace('regaPoll');
             if (this.regaPollPending) {
-                this.logger.warn('rega poll already pending');
+                // #166: writing several variables at once used to lose all but
+                // the first immediate re-poll, so their new values only showed
+                // up at the next scheduled one (30 s by default). Remember the
+                // request and run exactly one more poll afterwards.
+                this.logger.debug('rega poll already pending, will repeat');
+                this.regaPollAgain = true;
             } else {
                 this.regaPollPending = true;
                 clearTimeout(this.regaPollTimeout);
@@ -1307,6 +1362,14 @@ module.exports = function (RED) {
 
                         this.firstRegaPollDone = true;
                         this.regaPollPending = false;
+
+                        if (this.regaPollAgain && !this.cancelRegaPoll) {
+                            this.regaPollAgain = false;
+                            this.regaPoll();
+                        } else {
+                            this.regaPollAgain = false;
+                            this.refreshRegaDataIfDue();
+                        }
                     });
             }
         }
@@ -1446,6 +1509,35 @@ module.exports = function (RED) {
          * Poll ReGaHSS variables and call subscription callbacks
          * @returns {Promise}
          */
+        /**
+         * Re-read the ReGa metadata that only ever got fetched once, in the
+         * constructor: channel names, rooms and functions. A room or function
+         * added in the CCU WebUI was invisible until the flow was redeployed
+         * (#167). Cheap enough for a slow schedule - three small scripts.
+         * @returns {Promise<any>}
+         */
+        refreshRegaData() {
+            this.lastRegaDataRefresh = now();
+            this.logger.debug('refreshRegaData');
+            return this.getRegaChannels()
+                .then(() => this.getRegaRooms())
+                .then(() => this.getRegaFunctions())
+                .then(() => this.saveRegadata())
+                .catch((error) => this.logger.error('refreshRegaData', error));
+        }
+
+        /** Runs refreshRegaData() when the configured interval has elapsed. */
+        refreshRegaDataIfDue() {
+            if (!this.regaMetaInterval || this.cancelRegaPoll) {
+                return;
+            }
+
+            const elapsed = now() - (this.lastRegaDataRefresh || 0);
+            if (elapsed >= this.regaMetaInterval * 60000) {
+                this.refreshRegaData();
+            }
+        }
+
         getRegaVariables() {
             return new Promise((resolve, reject) => {
                 this.logger.debug('getRegaVariables');
@@ -1731,6 +1823,10 @@ module.exports = function (RED) {
          * @param iface
          */
         rpcCheckInit(iface) {
+            if (!this.rpcPingEnabled) {
+                return;
+            }
+
             if (!this.metadata.devices[iface] || !Object.keys(this.metadata.devices[iface]).length > 0) {
                 return;
             }
@@ -2474,6 +2570,7 @@ module.exports = function (RED) {
                 'change',
                 'cache',
                 'stable',
+                'uncertain',
                 'iface',
                 'device',
                 'deviceType',
@@ -2679,6 +2776,15 @@ module.exports = function (RED) {
             let matchChange;
             let matchStable;
 
+            // Checked before the attribute loop below: that loop may break
+            // early for a whitelisted datapoint, and this decision has to be
+            // made for every message regardless of key order. Only present in
+            // the filter when a node opted in, so existing subscriptions keep
+            // receiving values the ReGa could not timestamp (#96).
+            if (filter && filter.uncertain === false && message.uncertain) {
+                return false;
+            }
+
             if (filter) {
                 const arrayAttr = Object.keys(filter);
 
@@ -2718,6 +2824,11 @@ module.exports = function (RED) {
                         continue;
                     }
 
+                    if (attr === 'uncertain') {
+                        // already decided above, and not a value to compare
+                        continue;
+                    }
+
                     if (this.callbackWhitelists[message.datapointName].has(id)) {
                         if (matchCache && matchChange && matchStable) {
                             break;

package/nodes/ccu-display.js

@@ -1,6 +1,19 @@
 const path = require('path');
 
 const statusHelper = require(path.join(__dirname, '/lib/status.js'));
+const {effectiveConfig} = require(path.join(__dirname, '/lib/dynconfig.js'));
+
+/** Everything a message may override through msg.config (B-2, #80 #185). */
+const DYNAMIC_KEYS = [
+    'iface',
+    'channel',
+    'channelType',
+    'sound',
+    'repeat',
+    'pause',
+    'signal',
+    ...[1, 2, 3, 4, 5, 6].flatMap((i) => ['line' + i, 'color' + i, 'icon' + i, 'disable' + i]),
+];
 
 module.exports = function (RED) {
     class CcuDisplay {
@@ -143,43 +156,46 @@ module.exports = function (RED) {
             }
 
             this.on('input', (message, send, done) => {
+                // msg.line1 & co. keep working as before; msg.config
+                // additionally reaches the channel and the EP-WM55 settings
+                const {config: effective} = effectiveConfig(config, message, DYNAMIC_KEYS);
                 let payload = '0x02';
 
                 let countLines = 6; // HM-Dis-WM55
-                if (config.channelType === 'HM-Dis-EP-WM55') {
+                if (effective.channelType === 'HM-Dis-EP-WM55') {
                     payload += ',0x0A';
                     countLines = 3;
                 }
 
                 for (let i = 1; i <= countLines; i++) {
-                    if (!message['disable' + i] && !config['disable' + i]) {
-                        payload += convertString(message['line' + i] || config['line' + i]);
-                        if (config.channelType === 'HM-Dis-WM55') {
-                            payload += convertColor(message['color' + i] || config['color' + i]);
+                    if (!message['disable' + i] && !effective['disable' + i]) {
+                        payload += convertString(message['line' + i] || effective['line' + i]);
+                        if (effective.channelType === 'HM-Dis-WM55') {
+                            payload += convertColor(message['color' + i] || effective['color' + i]);
                         }
 
-                        payload += convertIcon(message['icon' + i] || config['icon' + i]);
+                        payload += convertIcon(message['icon' + i] || effective['icon' + i]);
                     }
 
                     payload += ',0x0A';
                 }
 
-                if (config.channelType === 'HM-Dis-EP-WM55') {
-                    if (config.sound) {
-                        payload += ',0x14,' + config.sound + ',0x1C';
+                if (effective.channelType === 'HM-Dis-EP-WM55') {
+                    if (effective.sound) {
+                        payload += ',0x14,' + effective.sound + ',0x1C';
                     }
 
-                    payload += ',' + config.repeat + ',0x1D,' + config.pause + ',0x16';
+                    payload += ',' + effective.repeat + ',0x1D,' + effective.pause + ',0x16';
 
-                    if (config.signal) {
-                        payload += ',' + config.signal;
+                    if (effective.signal) {
+                        payload += ',' + effective.signal;
                     }
                 }
 
                 payload += ',0x03';
 
                 this.ccu
-                    .setValue(config.iface, config.channel, 'SUBMIT', payload)
+                    .setValue(effective.iface, effective.channel, 'SUBMIT', payload)
                     .then(() => {
                         done();
                     })

package/nodes/ccu-get-value.html

@@ -195,7 +195,9 @@
                     arr.sort((a, b) => a.localeCompare(b));
                     $nodeInputChannel.autocomplete('option', 'source', arr);
 
-                    if (!data[$nodeInputChannel.val().split(' ')[0]]) {
+                    // ${ENV} placeholders are substituted by Node-RED before the node is
+                    // constructed (subflow parameters, #158) - do not clear them
+                    if (!/^\$\{[^}]+\}$/.test($nodeInputChannel.val()) && !data[$nodeInputChannel.val().split(' ')[0]]) {
                         $nodeInputChannel.val('');
                         $nodeInputDatapoint.val('');
                     }