node-red-contrib-ccu 4.2.0 → 4.3.0

package/nodes/ccu-rpc-event.html

@@ -29,6 +29,7 @@
             change: {value: false},
             working: {value: false},
             cache: {value: false},
+            certainOnly: {value: false},
             topic: {value: '${CCU}/${Interface}/${channelName}/${datapoint}'}  
         },
         inputs: 0,
@@ -596,6 +597,11 @@
                 <input type="checkbox" id="node-input-cache">
                 <span data-i18n="ccu-rpc-event.cache"></span>
             </label>
+
+            <label class="ccu-checkbox">
+                <input type="checkbox" id="node-input-certainOnly">
+                <span data-i18n="ccu-rpc-event.certainOnly"></span>
+            </label>
         </div>
     </div>
     <div class="form-row">

package/nodes/ccu-rpc-event.js

@@ -1,6 +1,20 @@
 const path = require('path');
 
 const statusHelper = require(path.join(__dirname, '/lib/status.js'));
+const {valueStatus} = require(path.join(__dirname, '/lib/valuestatus.js'));
+
+const FILTER_ATTRIBUTES = [
+    'rooms',
+    'functions',
+    'device',
+    'deviceName',
+    'deviceType',
+    'channel',
+    'channelName',
+    'channelType',
+    'channelIndex',
+    'datapoint',
+];
 
 module.exports = function (RED) {
     class CcuRpcEventNode {
@@ -21,20 +35,15 @@ module.exports = function (RED) {
                 iface: config.iface,
             };
 
+            // opt-in: only present when the option is enabled, so existing
+            // subscriptions keep receiving uncertain values (#96)
+            if (config.certainOnly) {
+                filter.uncertain = false;
+            }
+
             this.ccu.register(this);
 
-            [
-                'rooms',
-                'functions',
-                'device',
-                'deviceName',
-                'deviceType',
-                'channel',
-                'channelName',
-                'channelType',
-                'channelIndex',
-                'datapoint',
-            ].forEach((attr) => {
+            FILTER_ATTRIBUTES.forEach((attr) => {
                 if (!config[attr]) {
                     return;
                 }
@@ -45,8 +54,14 @@ module.exports = function (RED) {
                     filter[attr] = config[attr];
                 }
             });
+
+            // The node used to show nothing at all; show what came through
+            // last and how long ago (#52)
+            this.valueStatus = valueStatus(this);
+
             this.idSubscription = this.ccu.subscribe(filter, (message) => {
                 message.topic = this.ccu.topicReplace(config.topic, message);
+                this.valueStatus.set(message.topic + ' = ' + message.payload, message.ts);
                 this.send(message);
             });
             this.on('close', this._destructor);
@@ -54,6 +69,10 @@ module.exports = function (RED) {
 
         _destructor(done) {
             this.debug('ccu-rpc-event close');
+            if (this.valueStatus) {
+                this.valueStatus.stop();
+            }
+
             this.ccu.unsubscribe(this.idSubscription);
             this.ccu.deregister(this);
             done();

package/nodes/ccu-set-value.html

@@ -624,8 +624,46 @@
 
     <h3>Input</h3>
 
+
+    <h3>Dynamische Konfiguration</h3>
+    <p><code>msg.config</code> ist ein Objekt, dessen Eigenschaften die Konfiguration dieses Nodes für genau diese Nachricht überschreiben. Die gespeicherte Konfiguration bleibt unverändert.</p>
+    <ul>
+        <li><code>iface</code></li>
+        <li><code>rooms</code></li>
+        <li><code>functions</code></li>
+        <li><code>device</code></li>
+        <li><code>deviceType</code></li>
+        <li><code>deviceName</code></li>
+        <li><code>channel</code></li>
+        <li><code>channelType</code></li>
+        <li><code>channelIndex</code></li>
+        <li><code>channelName</code></li>
+        <li><code>datapoint</code></li>
+        <li><code>force</code></li>
+        <li><code>sowie die zugehörigen <code>...Rx</code>-Selektoren</code></li>
+    </ul>
+    <p>Zusätzlich füllen gleichnamige Eigenschaften der Nachricht selbst (<code>msg.rooms</code> usw.) leer gelassene Felder — so war es schon immer.</p>
 </script>
 
 <script type="text/x-red" data-help-name="ccu-set-value" lang="en-US">
     <p>Control multiple devices at once.</p>
+
+    <h3>Dynamic configuration</h3>
+    <p><code>msg.config</code> is an object whose properties override this node's configuration for that one message. The stored configuration is never modified.</p>
+    <ul>
+        <li><code>iface</code></li>
+        <li><code>rooms</code></li>
+        <li><code>functions</code></li>
+        <li><code>device</code></li>
+        <li><code>deviceType</code></li>
+        <li><code>deviceName</code></li>
+        <li><code>channel</code></li>
+        <li><code>channelType</code></li>
+        <li><code>channelIndex</code></li>
+        <li><code>channelName</code></li>
+        <li><code>datapoint</code></li>
+        <li><code>force</code></li>
+        <li><code>and the matching <code>...Rx</code> selectors</code></li>
+    </ul>
+    <p>Properties of the message itself (<code>msg.rooms</code> and so on) also fill in fields left empty in the dialog, as they always did.</p>
 </script>

package/nodes/ccu-set-value.js

@@ -1,6 +1,11 @@
 const path = require('path');
 
 const statusHelper = require(path.join(__dirname, '/lib/status.js'));
+const {effectiveConfig, configCacheKey} = require(path.join(__dirname, '/lib/dynconfig.js'));
+const {channelMatches, datapointsOf, CONFIG_KEYS} = require(path.join(__dirname, '/lib/channelfilter.js'));
+
+/** Configuration keys an incoming message may supply (B-2). */
+const DYNAMIC_KEYS = [...CONFIG_KEYS, 'force'];
 
 module.exports = function (RED) {
     class CcuSetValue {
@@ -15,36 +20,31 @@ module.exports = function (RED) {
 
             this.ccu.register(this);
 
-            this.config = {
-                iface: config.iface,
-                rooms: config.rooms,
-                functions: config.functions,
-                device: config.device,
-                deviceType: config.deviceType,
-                deviceName: config.deviceName,
-                channel: config.channel,
-                channelType: config.channelType,
-                channelIndex: config.channelIndex,
-                channelName: config.channelName,
-                datapoint: config.datapoint,
-                roomsRx: config.roomsRx,
-                functionsRx: config.functionsRx,
-                deviceRx: config.deviceRx,
-                deviceTypeRx: config.deviceTypeRx,
-                deviceNameRx: config.deviceNameRx,
-                channelRx: config.channelRx,
-                channelTypeRx: config.channelTypeRx,
-                channelIndexRx: config.channelIndexRx,
-                channelNameRx: config.channelNameRx,
-                datapointRx: config.datapointRx,
-                force: config.force,
-            };
+            this.config = {};
+            DYNAMIC_KEYS.forEach((key) => {
+                this.config[key] = config[key];
+            });
 
+            // Channels already known to (not) match the filter currently in
+            // effect. Keyed by that filter, so a message that changes it gets
+            // a fresh evaluation instead of inheriting the previous one (#133).
+            this.filterKey = null;
             this.blacklist = new Set();
             this.whitelist = new Set();
 
-            this.on('input', (message) => {
-                this.setValues(message);
+            this.on('input', (message, send, done) => {
+                try {
+                    this.setValues(message);
+                    if (done) {
+                        done();
+                    }
+                } catch (error) {
+                    if (done) {
+                        done(error);
+                    } else {
+                        this.error(error.message, message);
+                    }
+                }
             });
 
             this.on('close', this._destructor);
@@ -63,22 +63,23 @@ module.exports = function (RED) {
             statusHelper(this, data);
         }
 
-        setValues(message) {
-            const {config} = this;
-            let dynamicConfig = false;
-            Object.keys(config).forEach((key) => {
-                if (!config[key]) {
-                    if (key in message) {
-                        dynamicConfig = true;
-                        config[key] = message[key];
-                    }
-                }
-            });
-
-            if (dynamicConfig) {
-                this.whitelist.clear();
-                this.blacklist.clear();
+        /**
+         * The match caches are only valid for the filter they were built
+         * from — reset them whenever the effective filter changes.
+         * @param {object} config effective configuration for this message
+         */
+        useFilter(config) {
+            const key = configCacheKey(config, CONFIG_KEYS);
+            if (key !== this.filterKey) {
+                this.filterKey = key;
+                this.blacklist = new Set();
+                this.whitelist = new Set();
             }
+        }
+
+        setValues(message) {
+            const {config} = effectiveConfig(this.config, message, DYNAMIC_KEYS, {flat: true});
+            this.useFilter(config);
 
             let count = 0;
             Object.keys(this.ccu.metadata.devices).forEach((iface) => {
@@ -91,206 +92,29 @@ module.exports = function (RED) {
                         return;
                     }
 
-                    const channel = this.ccu.metadata.devices[iface][address];
-
-                    if (!channel.PARENT) {
-                        this.blacklist.add(address);
-                        return;
-                    }
-
                     if (!this.whitelist.has(address)) {
-                        const device = this.ccu.metadata.devices[iface][channel.PARENT];
-                        if (config.device) {
-                            if (config.deviceRx === 'str' && config.device !== channel.PARENT) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-
-                            if (config.deviceRx === 're' && !channel.PARENT.match(new RegExp(config.device))) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-                        }
-
-                        if (config.deviceType) {
-                            if (config.deviceTypeRx === 'str' && config.deviceType !== device.TYPE) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-
-                            if (config.deviceTypeRx === 're' && !device.TYPE.match(new RegExp(config.deviceType))) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-                        }
-
-                        if (config.deviceName) {
-                            if (!this.ccu.channelNames[address]) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-
-                            if (
-                                config.deviceNameRx === 'str' &&
-                                this.ccu.channelNames[channel.PARENT] !== config.deviceName
-                            ) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-
-                            if (
-                                config.deviceNameRx === 're' &&
-                                !this.ccu.channelNames[channel.PARENT].match(new RegExp(config.deviceName))
-                            ) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-                        }
-
-                        if (config.channel) {
-                            if (config.channelRx === 'str' && config.channel !== address) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-
-                            if (config.channelRx === 're' && !address.match(new RegExp(config.channel))) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-                        }
-
-                        if (config.channelType) {
-                            if (config.channelTypeRx === 'str' && config.channelType !== channel.TYPE) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-
-                            if (config.channelTypeRx === 're' && !channel.TYPE.match(new RegExp(config.channelType))) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-                        }
-
-                        if (config.channelIndex) {
-                            if (config.channelIndexRx === 'str' && !address.endsWith(':' + config.channelIndex)) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-
-                            if (
-                                config.channelIndexRx === 're' &&
-                                !address.split(':')[1].match(new RegExp(String(config.channelIndex)))
-                            ) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-                        }
-
-                        if (config.channelName) {
-                            if (!this.ccu.channelNames[address]) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-
-                            if (
-                                config.channelNameRx === 'str' &&
-                                this.ccu.channelNames[address] !== config.channelName
-                            ) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-
-                            if (
-                                config.channelNameRx === 're' &&
-                                !this.ccu.channelNames[address].match(new RegExp(config.channelName))
-                            ) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-                        }
-
-                        if (config.rooms) {
-                            if (!this.ccu.channelRooms[address]) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-
-                            if (config.roomsRx === 'str' && !this.ccu.channelRooms[address].includes(config.rooms)) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-
-                            if (config.roomsRx === 're') {
-                                let match = false;
-                                this.ccu.channelRooms[address].forEach((room) => {
-                                    if (room.match(new RegExp(config.rooms))) {
-                                        match = true;
-                                    }
-                                });
-                                if (!match) {
-                                    this.blacklist.add(address);
-                                    return;
-                                }
-                            }
-                        }
-
-                        if (config.functions) {
-                            if (!this.ccu.channelFunctions[address]) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-
-                            if (
-                                config.functionsRx === 'str' &&
-                                !this.ccu.channelFunctions[address].includes(config.functions)
-                            ) {
-                                this.blacklist.add(address);
-                                return;
-                            }
-
-                            if (config.functionsRx === 're') {
-                                let match = false;
-                                this.ccu.channelFunctions[address].forEach((func) => {
-                                    if (func.match(new RegExp(config.functions))) {
-                                        match = true;
-                                    }
-                                });
-                                if (!match) {
-                                    this.blacklist.add(address);
-                                    return;
-                                }
-                            }
+                        if (!channelMatches(this.ccu, iface, address, config)) {
+                            this.blacklist.add(address);
+                            return;
                         }
 
                         this.whitelist.add(address);
                     }
 
-                    const psKey = this.ccu.paramsetName(iface, channel, 'VALUES');
-                    if (this.ccu.paramsetDescriptions[psKey]) {
-                        const rx = new RegExp(config.datapoint);
-                        Object.keys(this.ccu.paramsetDescriptions[psKey]).forEach((dp) => {
-                            if (config.datapointRx === 'str' && dp !== config.datapoint) {
-                                return;
-                            }
-
-                            if (config.datapointRx === 're' && !dp.match(rx)) {
-                                return;
-                            }
-
-                            const datapointName = iface + '.' + address + '.' + dp;
-                            const currentValue = this.ccu.values[datapointName] && this.ccu.values[datapointName].value;
-                            count += 1;
-                            if (
-                                dp.startsWith('PRESS_') ||
-                                typeof currentValue === 'undefined' ||
-                                currentValue !== message.payload
-                            ) {
-                                this.ccu
-                                    .setValueQueued(iface, address, dp, message.payload, false, config.force)
-                                    .catch(() => {});
-                            }
-                        });
-                    }
+                    datapointsOf(this.ccu, iface, address, config).forEach((dp) => {
+                        const datapointName = iface + '.' + address + '.' + dp;
+                        const currentValue = this.ccu.values[datapointName] && this.ccu.values[datapointName].value;
+                        count += 1;
+                        if (
+                            dp.startsWith('PRESS_') ||
+                            typeof currentValue === 'undefined' ||
+                            currentValue !== message.payload
+                        ) {
+                            this.ccu
+                                .setValueQueued(iface, address, dp, message.payload, false, config.force)
+                                .catch(() => {});
+                        }
+                    });
                 });
             });
             this.status({fill: 'green', shape: 'ring', text: String(count) + ' datapoints'});

package/nodes/ccu-signal.html

@@ -268,7 +268,9 @@
 
                 $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('');
                 }
             }
@@ -645,8 +647,60 @@
 
 <script type="text/x-red" data-help-name="ccu-signal" lang="de-DE">
     <p>Senden von LED- und Tonsignalen an Displaytaster und Funk-Gongs.</p>
+
+    <h3>Dynamische Konfiguration</h3>
+    <p><code>msg.config</code> ist ein Objekt, dessen Eigenschaften die Konfiguration dieses Nodes für genau diese Nachricht überschreiben. Die gespeicherte Konfiguration bleibt unverändert.</p>
+    <ul>
+        <li><code>iface</code></li>
+        <li><code>channel</code></li>
+        <li><code>channelType</code></li>
+        <li><code>chime</code></li>
+        <li><code>led</code></li>
+        <li><code>signal</code></li>
+        <li><code>volume</code></li>
+        <li><code>repeat</code></li>
+        <li><code>repetitions</code></li>
+        <li><code>durationUnit</code></li>
+        <li><code>durationValue</code></li>
+        <li><code>rampTimeUnit</code></li>
+        <li><code>rampTimeValue</code></li>
+        <li><code>acousticAlarmSelection</code></li>
+        <li><code>opticalAlarmSelection</code></li>
+        <li><code>dimmerLevel</code></li>
+        <li><code>dimmerColor</code></li>
+        <li><code>dimmerList</code></li>
+        <li><code>soundLevel</code></li>
+        <li><code>soundList</code></li>
+    </ul>
+    <p><code>soundList</code> und <code>dimmerList</code> akzeptieren auch ein einfaches Array von Werten, z.B. <code>msg.config.soundList = [1, 2]</code>.</p>
 </script>
 
 <script type="text/x-red" data-help-name="ccu-signal" lang="en-US">
     <p>Send LED- and Sound-Signals.</p>
+
+    <h3>Dynamic configuration</h3>
+    <p><code>msg.config</code> is an object whose properties override this node's configuration for that one message. The stored configuration is never modified.</p>
+    <ul>
+        <li><code>iface</code></li>
+        <li><code>channel</code></li>
+        <li><code>channelType</code></li>
+        <li><code>chime</code></li>
+        <li><code>led</code></li>
+        <li><code>signal</code></li>
+        <li><code>volume</code></li>
+        <li><code>repeat</code></li>
+        <li><code>repetitions</code></li>
+        <li><code>durationUnit</code></li>
+        <li><code>durationValue</code></li>
+        <li><code>rampTimeUnit</code></li>
+        <li><code>rampTimeValue</code></li>
+        <li><code>acousticAlarmSelection</code></li>
+        <li><code>opticalAlarmSelection</code></li>
+        <li><code>dimmerLevel</code></li>
+        <li><code>dimmerColor</code></li>
+        <li><code>dimmerList</code></li>
+        <li><code>soundLevel</code></li>
+        <li><code>soundList</code></li>
+    </ul>
+    <p><code>soundList</code> and <code>dimmerList</code> also accept a plain array of values, e.g. <code>msg.config.soundList = [1, 2]</code>.</p>
 </script>

package/nodes/ccu-signal.js

@@ -1,6 +1,46 @@
 const path = require('path');
 
 const statusHelper = require(path.join(__dirname, '/lib/status.js'));
+const {effectiveConfig} = require(path.join(__dirname, '/lib/dynconfig.js'));
+
+/** Fields that already carry a typed input (`<name>Type`) in the editor. */
+const TYPED_VALUES = ['rampTimeValue', 'durationValue', 'repeat', 'volume', 'soundLevel'];
+
+/** Everything a message may override through `msg.config` (B-2, #80 #148 #185). */
+const DYNAMIC_KEYS = [
+    'iface',
+    'channel',
+    'channelType',
+    'chime',
+    'led',
+    'signal',
+    'acousticAlarmSelection',
+    'opticalAlarmSelection',
+    'durationUnit',
+    'rampTimeUnit',
+    'repetitions',
+    'dimmerLevel',
+    'dimmerColor',
+    'dimmerList',
+    'soundList',
+    ...TYPED_VALUES,
+];
+
+/**
+ * Accept both the editor's list shape and a plain array of values, so a
+ * flow can send `msg.config.soundList = [1, 2]` instead of building
+ * `[{sound: 1}, {sound: 2}]` by hand (#148).
+ * @param {*} list
+ * @param {string} key 'sound' or 'color'
+ * @returns {object[]}
+ */
+function normalizeList(list, key) {
+    if (!Array.isArray(list)) {
+        return [];
+    }
+
+    return list.map((item) => (item !== null && typeof item === 'object' ? item : {[key]: item}));
+}
 
 module.exports = function (RED) {
     class CcuSignal {
@@ -33,7 +73,10 @@ module.exports = function (RED) {
                         this.error(error.message);
                     })
                     .then(() => {
-                        this.sendCommand({...this.config, ...values})
+                        // msg.config wins over both the stored config and the
+                        // typed inputs above
+                        const {config: effective} = effectiveConfig({...this.config, ...values}, message, DYNAMIC_KEYS);
+                        this.sendCommand(effective)
                             .then(() => {
                                 done();
                             })
@@ -51,12 +94,10 @@ module.exports = function (RED) {
 
             switch (config.channelType) {
                 case 'SIGNAL_CHIME':
-                    console.log('config.chime', config.chime);
-                    payload = [config.volume / 100, config.repeat, 108000, ...config.chime.split(',')];
-                    console.log('payload', payload);
+                    payload = [config.volume / 100, config.repeat, 108000, ...String(config.chime).split(',')];
                     return this.ccu.setValue(config.iface, config.channel, 'SUBMIT', payload);
                 case 'SIGNAL_LED':
-                    payload = ['1', config.repeat, 108000, ...config.led.split(',')];
+                    payload = ['1', config.repeat, 108000, ...String(config.led).split(',')];
                     return this.ccu.setValue(config.iface, config.channel, 'SUBMIT', payload);
                 case 'ALARM_SWITCH_VIRTUAL_RECEIVER':
                     return this.ccu.methodCall(config.iface, 'putParamset', [
@@ -70,6 +111,7 @@ module.exports = function (RED) {
                         },
                     ]);
                 case 'DIMMER_VIRTUAL_RECEIVER': {
+                    const dimmerList = normalizeList(config.dimmerList, 'color');
                     const parameters = {
                         LEVEL: config.dimmerLevel / 100,
                         RAMP_TIME_UNIT: config.rampTimeUnit,
@@ -77,9 +119,9 @@ module.exports = function (RED) {
                         DURATION_UNIT: config.durationUnit,
                         DURATION_VALUE: Number.parseInt(config.durationValue, 10) || 0,
                         REPETITIONS: Number(config.repetitions),
-                        OUTPUT_SELECT_SIZE: config.dimmerList.length,
+                        OUTPUT_SELECT_SIZE: dimmerList.length,
                     };
-                    config.dimmerList.forEach((item, i) => {
+                    dimmerList.forEach((item, i) => {
                         const index = i + 1;
                         parameters['COLOR_LIST_' + index] = Number(item.color);
                         parameters['ON_TIME_LIST_' + index] = Number(item.ontime);
@@ -103,6 +145,7 @@ module.exports = function (RED) {
                 }
 
                 case 'ACOUSTIC_SIGNAL_VIRTUAL_RECEIVER': {
+                    const soundList = normalizeList(config.soundList, 'sound');
                     const parameters = {
                         LEVEL: config.soundLevel / 100,
                         RAMP_TIME_UNIT: config.rampTimeUnit,
@@ -110,9 +153,9 @@ module.exports = function (RED) {
                         DURATION_UNIT: config.durationUnit,
                         DURATION_VALUE: Number.parseInt(config.durationValue, 10) || 0,
                         REPETITIONS: Number(config.repetitions),
-                        OUTPUT_SELECT_SIZE: config.soundList.length,
+                        OUTPUT_SELECT_SIZE: soundList.length,
                     };
-                    config.soundList.forEach((item, i) => {
+                    soundList.forEach((item, i) => {
                         const index = i + 1;
                         parameters['SOUNDFILE_LIST_' + index] = Number(item.sound);
                     });