node-red-contrib-ccu 3.4.1 → 4.0.0

package/nodes/ccu-display.html

@@ -101,6 +101,7 @@
 
             let ifacesLoaded = false;
             let ifacesPending = false;
+            let ifaceLoadRetries = 5;
 
             function loadIfaces(iface, cb) {
                 if (ifacesPending) {
@@ -108,7 +109,6 @@
                 }
 
                 ifacesPending = true;
-                console.log('loadIfaces()');
                 $nodeInputIface.html('');
                 const nodeId = $nodeInputCcuConfig.val();
                 if (nodeId === '_ADD_') {
@@ -128,6 +128,12 @@
                             cb();
                             ifacesPending = false;
                         }
+                    }).fail(() => {
+                        // config node not (yet) available in the runtime - allow retrying
+                        ifacesPending = false;
+                        if (ifaceLoadRetries-- > 0) {
+                            setTimeout(() => loadIfaces(iface, cb), 1000);
+                        }
                     });
                 }
             }
@@ -136,7 +142,6 @@
                 if (ifacesLoaded) {
                     const nodeId = $nodeInputCcuConfig.val();
                     if (nodeId && nodeId !== '__ADD__') {
-                        console.log('loadConfig()');
                         $.getJSON('ccu?type=display&config=' + nodeId + '&iface=' + $nodeInputIface.val(), d => {
                             data = d;
                             autoCompleteChannel();
@@ -148,7 +153,6 @@
             }
 
             $nodeInputCcuConfig.change(() => {
-                console.log('$nodeInputCcuConfig change');
                 loadIfaces(this.iface, () => {
                     ifacesLoaded = true;
                     $nodeInputIface.removeAttr('disabled');
@@ -156,6 +160,10 @@
                 });
             });
 
+            // Node-RED 4.x does not reliably fire the change event on dialog
+            // open - trigger the initial load explicitly (see ROADMAP.md 8.1)
+            $nodeInputCcuConfig.trigger('change');
+
             $nodeInputIface.change(() => {
                 if (ifacesLoaded) {
                     loadConfig();
@@ -198,7 +206,6 @@
                     });
                 }
 
-                console.log('autoCompleteChannel()', arr.length);
                 $nodeInputChannel.autocomplete('option', 'source', arr);
             }
 

package/nodes/ccu-display.js

@@ -31,7 +31,7 @@ module.exports = function (RED) {
                     gruen: '0x84',
                     grün: '0x84',
                     green: '0x84',
-                    blue: '0x85'
+                    blue: '0x85',
                 };
 
                 if (map[col]) {
@@ -87,18 +87,33 @@ module.exports = function (RED) {
                     'signal rot': '0x8B',
                     red: '0x8B',
                     signalred: '0x8B',
-                    'signal red': '0x8B'
+                    'signal red': '0x8B',
                 };
 
                 if (map[ico]) {
                     ico = map[ico];
                 }
 
-                if (!['0x80', '0x81', '0x82', '0x83', '0x84', '0x85', '0x86', '0x87', '0x88', '0x89', '0x8a', '0x8b'].includes(ico)) {
+                if (
+                    ![
+                        '0x80',
+                        '0x81',
+                        '0x82',
+                        '0x83',
+                        '0x84',
+                        '0x85',
+                        '0x86',
+                        '0x87',
+                        '0x88',
+                        '0x89',
+                        '0x8a',
+                        '0x8b',
+                    ].includes(ico)
+                ) {
                     ico = '';
                 }
 
-                return ico ? (',0x13,' + ico) : '';
+                return ico ? ',0x13,' + ico : '';
             }
 
             function convertString(string) {
@@ -117,11 +132,11 @@ module.exports = function (RED) {
                     ä: '0x7B',
                     ö: '0x7C',
                     ü: '0x7D',
-                    ß: '0x5F'
+                    ß: '0x5F',
                 };
                 const res = [];
-                string.split('').forEach(c => {
-                    res.push(charcodes[c] || ('0x' + c.charCodeAt(0).toString(16).toUpperCase()));
+                string.split('').forEach((c) => {
+                    res.push(charcodes[c] || '0x' + c.charCodeAt(0).toString(16).toUpperCase());
                 });
 
                 return ',0x12,' + res.slice(0, 12).join(',');
@@ -163,10 +178,12 @@ module.exports = function (RED) {
 
                 payload += ',0x03';
 
-                this.ccu.setValue(config.iface, config.channel, 'SUBMIT', payload)
+                this.ccu
+                    .setValue(config.iface, config.channel, 'SUBMIT', payload)
                     .then(() => {
                         done();
-                    }).catch(error => {
+                    })
+                    .catch((error) => {
                         done(error);
                     });
             });

package/nodes/ccu-get-value.html

@@ -46,6 +46,7 @@
 
                 let ifacesLoaded = false;
                 let ifacesPending = false;
+                let ifaceLoadRetries = 5;
 
                 if (!this.setProp) {
                     this.setProp = 'payload';
@@ -69,17 +70,17 @@
                 $('.form-row.datapoint').hide();
                 $('.form-row.sysvar').hide();
 
-                const sysvarPropertys = ['value', 'valueEnum', 'ts', 'lc'];
-                const datapointPropertys = ['value', 'ts', 'lc', 'working', 'direction', 'all'];
+                const sysvarProperties = ['value', 'valueEnum', 'ts', 'lc'];
+                const datapointProperties = ['value', 'ts', 'lc', 'working', 'direction', 'all'];
 
-                sysvarPropertys.forEach(val => $nodeInputSysvarProperty.append(
+                sysvarProperties.forEach(val => $nodeInputSysvarProperty.append(
                     $('<option></option>').val(val).text(node._('node-red-contrib-ccu/ccu-connection:common.label.' + val))
                 ));
-                datapointPropertys.forEach(val => $nodeInputDatapointProperty.append(
+                datapointProperties.forEach(val => $nodeInputDatapointProperty.append(
                     $('<option></option>').val(val).text(node._('node-red-contrib-ccu/ccu-connection:common.label.' + val))
                 ));
-                $nodeInputSysvarProperty.val(node.sysvarProperty || sysvarPropertys[0]);
-                $nodeInputDatapointProperty.val(node.datapointProperty || datapointPropertys[0]);
+                $nodeInputSysvarProperty.val(node.sysvarProperty || sysvarProperties[0]);
+                $nodeInputDatapointProperty.val(node.datapointProperty || datapointProperties[0]);
 
                 function loadIfaces(iface, cb) {
                     if (ifacesPending) {
@@ -87,7 +88,6 @@
                     }
 
                     ifacesPending = true;
-                    console.log('loadIfaces()');
 
                     $nodeInputIface.html('');
 
@@ -108,6 +108,12 @@
                                 cb();
                                 ifacesPending = false;
                             }
+                        }).fail(() => {
+                            // config node not (yet) available in the runtime - allow retrying
+                            ifacesPending = false;
+                            if (ifaceLoadRetries-- > 0) {
+                                setTimeout(() => loadIfaces(iface, cb), 1000);
+                            }
                         });
                         $.getJSON('ccu?type=sysvar&config=' + nodeId, data => {
                             $nodeInputSysvar.html('<option></option>');
@@ -117,6 +123,8 @@
                                 });
                             }
                         });
+                    } else {
+                        ifacesPending = false;
                     }
                 }
 
@@ -125,7 +133,6 @@
                         return;
                     }
 
-                    console.log('loadConfig()');
                     const nodeId = $nodeInputCcuConfig.val();
                     const url = 'ccu?config=' + nodeId + '&type=channels&iface=' + $nodeInputIface.val();
                     $.getJSON(url, d => {
@@ -136,13 +143,16 @@
                 }
 
                 $nodeInputCcuConfig.change(() => {
-                    console.log('$nodeInputCcuConfig change');
                     loadIfaces(this.iface, () => {
                         ifacesLoaded = true;
                         loadConfig();
                     });
                 });
 
+                // Node-RED 4.x does not reliably fire the change event on dialog
+                // open - trigger the initial load explicitly (see ROADMAP.md 8.1)
+                $nodeInputCcuConfig.trigger('change');
+
                 $nodeInputChannel.autocomplete({
                     source: [],
                     close: () => {
@@ -203,7 +213,6 @@
                 }
 
                 $nodeInputIface.change(() => {
-                    console.log('$nodeInputIface change');
                     if ($nodeInputIface.val() === 'ReGaHSS') {
                         $('.form-row.datapoint').hide();
                         $('.form-row.sysvar').show();
@@ -313,7 +322,7 @@
                 function getDPProp(dp) {
                     const retVal = [];
 
-                    datapointPropertys.forEach(val => {
+                    datapointProperties.forEach(val => {
                         retVal.push({
                             id: dp.id + '.' + val,
                             label: node._('node-red-contrib-ccu/ccu-connection:common.label.' + val),
@@ -367,7 +376,7 @@
                                     icon: 'fa fa-tags fa-fw',
                                     children: done => {
                                         const retVal = [];
-                                        sysvarPropertys.forEach(val => {
+                                        sysvarProperties.forEach(val => {
                                             retVal.push({
                                                 label: node._('node-red-contrib-ccu/ccu-connection:common.label.' + val),
                                                 icon: 'fa fa-tag fa-fw',
@@ -438,7 +447,7 @@
         <select id="node-input-sysvar" style="width:70%;">
         </select>
     </div>
-    <div class="form-row sysvar">
+    <div class="form-row sysvar property">
         <label for="node-input-sysvarProperty"><i class="icon-tags"></i> Property</label>
         <select id="node-input-sysvarProperty" style="width:70%;">
         </select>
@@ -451,7 +460,7 @@
         <label for="node-input-datapoint"><i class="icon-tag"></i> Datapoint</label>
         <input type="text" id="node-input-datapoint">
     </div>
-    <div class="form-row datapoint">
+    <div class="form-row datapoint property">
         <label for="node-input-datapointProperty"><i class="icon-tags"></i> Property</label>
         <select id="node-input-datapointProperty" style="width:70%;">
         </select>

package/nodes/ccu-get-value.js

@@ -39,17 +39,22 @@ module.exports = function (RED) {
                     }
                 }
 
-                this.status({fill: 'green', shape: 'ring', text: String(value.payload)});
                 if (config.setPropType === 'cmsg') {
                     Object.assign(message, value);
                     send(message);
-
+                    this.status({fill: 'green', shape: 'ring', text: String(value.payload)});
                     done();
                 } else {
-                    if (config.datapointProperty !== 'all') {
+                    if (iface === 'ReGaHSS') {
+                        if (config.sysvarProperty !== 'all') {
+                            value = value[config.sysvarProperty];
+                        }
+                    } else if (config.datapointProperty !== 'all') {
                         value = value[config.datapointProperty];
                     }
 
+                    this.status({fill: 'green', shape: 'ring', text: String(value)});
+
                     if (config.setPropType === 'msg') {
                         RED.util.setMessageProperty(message, config.setProp, value);
                         if (send) {
@@ -61,10 +66,10 @@ module.exports = function (RED) {
                         if (done) {
                             done();
                         }
-                    } else if ((this.setPropType === 'flow') || (this.setPropType === 'global')) {
+                    } else if (this.setPropType === 'flow' || this.setPropType === 'global') {
                         const context = RED.util.parseContextStore(this.setProp);
                         const target = this.context()[this.setPropType];
-                        target.set(context.key, value, context.store, err => {
+                        target.set(context.key, value, context.store, (err) => {
                             if (err) {
                                 done(err);
                             } else {

package/nodes/ccu-mqtt.html

@@ -8,19 +8,19 @@
 
             cache: {value: false},
 
-            topicOutputEvent: {value: 'hm/status/${channelName}/${datapoint}'}, // eslint-disable-line no-template-curly-in-string
-            topicInputSetValue: {value: 'hm/set/${channelNameOrAddress}/${datapoint}'}, // eslint-disable-line no-template-curly-in-string
+            topicOutputEvent: {value: 'hm/status/${channelName}/${datapoint}'},  
+            topicInputSetValue: {value: 'hm/set/${channelNameOrAddress}/${datapoint}'},  
 
-            topicOutputSysvar: {value: 'hm/status/${name}'}, // eslint-disable-line no-template-curly-in-string
-            topicInputSysvar: {value: 'hm/set/${name}'}, // eslint-disable-line no-template-curly-in-string
+            topicOutputSysvar: {value: 'hm/status/${name}'},  
+            topicInputSysvar: {value: 'hm/set/${name}'},  
 
-            topicInputPutParam: {value: 'hm/paramset/${channelNameOrAddress}/${paramset}/${param}'}, // eslint-disable-line no-template-curly-in-string
-            topicInputPutParamset: {value: 'hm/paramset/${channelNameOrAddress}/${paramset}'}, // eslint-disable-line no-template-curly-in-string
+            topicInputPutParam: {value: 'hm/paramset/${channelNameOrAddress}/${paramset}/${param}'},  
+            topicInputPutParamset: {value: 'hm/paramset/${channelNameOrAddress}/${paramset}'},  
 
-            topicInputRpc: {value: 'hm/rpc/${iface}/${method}/${command}/${callid}'}, // eslint-disable-line no-template-curly-in-string
-            topicOutputRpc: {value: 'hm/response/${callid}'}, // eslint-disable-line no-template-curly-in-string
+            topicInputRpc: {value: 'hm/rpc/${iface}/${method}/${command}/${callid}'},  
+            topicOutputRpc: {value: 'hm/response/${callid}'},  
 
-            topicCounters: {value: 'hm/status/counter/${iface}/${rxtx}'}, // eslint-disable-line no-template-curly-in-string
+            topicCounters: {value: 'hm/status/counter/${iface}/${rxtx}'},  
 
             payloadOutput: {value: 'mqsh-extended'}
         },
@@ -37,7 +37,6 @@
             return this.name ? 'node_label_italic' : '';
         },
         oneditsave() {
-            console.log(this);
         }
     });
 </script>

package/nodes/ccu-mqtt.js

@@ -33,19 +33,19 @@ module.exports = function (RED) {
 
             this.ccu.register(this);
 
-            this.on('input', message => {
+            this.on('input', (message) => {
                 this.input(message);
             });
 
-            this.idEventSubscription = this.ccu.subscribe({cache: config.cache}, message => {
+            this.idEventSubscription = this.ccu.subscribe({cache: config.cache}, (message) => {
                 this.event(message);
             });
 
-            this.idSysvarSubscription = this.ccu.subscribeSysvar({cache: config.cache, change: true}, message => {
+            this.idSysvarSubscription = this.ccu.subscribeSysvar({cache: config.cache, change: true}, (message) => {
                 this.sysvarOutput(message);
             });
 
-            this.idProgramSubscription = this.ccu.subscribeProgram({}, message => {
+            this.idProgramSubscription = this.ccu.subscribeProgram({}, (message) => {
                 this.programOutput(message);
             });
 
@@ -53,9 +53,17 @@ module.exports = function (RED) {
 
             if (this.topicCounters) {
                 setTimeout(() => {
-                    this.ccu.enabledIfaces.forEach(iface => {
-                        this.send({topic: this.ccu.topicReplace(this.topicCounters, {iface, rxtx: 'rx'}), payload: '0', retain: true});
-                        this.send({topic: this.ccu.topicReplace(this.topicCounters, {iface, rxtx: 'tx'}), payload: '0', retain: true});
+                    this.ccu.enabledIfaces.forEach((iface) => {
+                        this.send({
+                            topic: this.ccu.topicReplace(this.topicCounters, {iface, rxtx: 'rx'}),
+                            payload: '0',
+                            retain: true,
+                        });
+                        this.send({
+                            topic: this.ccu.topicReplace(this.topicCounters, {iface, rxtx: 'tx'}),
+                            payload: '0',
+                            retain: true,
+                        });
                     });
                 }, 25000);
                 setInterval(() => {
@@ -75,7 +83,7 @@ module.exports = function (RED) {
         }
 
         checkCounters(c) {
-            Object.keys(this.ccu[c]).forEach(iface => {
+            Object.keys(this.ccu[c]).forEach((iface) => {
                 if (this.ccu[c][iface] !== this[c][iface]) {
                     this[c][iface] = this.ccu[c][iface];
                     const topic = this.ccu.topicReplace(this.topicCounters, {iface, rxtx: c.slice(0, 2)});
@@ -98,7 +106,11 @@ module.exports = function (RED) {
                 const messageNotWorking = RED.util.cloneMessage(message);
                 messageNotWorking.datapoint += '_NOTWORKING';
                 messageNotWorking.datapointName += '_NOTWORKING';
-                this.send({topic: this.ccu.topicReplace(this.topicOutputEvent, messageNotWorking), payload: this.output(messageNotWorking), retain: true});
+                this.send({
+                    topic: this.ccu.topicReplace(this.topicOutputEvent, messageNotWorking),
+                    payload: this.output(messageNotWorking),
+                    retain: true,
+                });
             }
         }
 
@@ -119,7 +131,7 @@ module.exports = function (RED) {
                     return {
                         val: message.payload,
                         ts: message.ts,
-                        lc: message.lc
+                        lc: message.lc,
                     };
                 }
 
@@ -128,7 +140,7 @@ module.exports = function (RED) {
                         val: message.payload,
                         ts: message.ts,
                         lc: message.lc,
-                        hm: message
+                        hm: message,
                     };
                     delete payload.hm.topic;
                     delete payload.hm.payload;
@@ -156,21 +168,21 @@ module.exports = function (RED) {
                 sysvar: this.topicInputSysvar,
                 putParam: this.topicInputPutParam,
                 putParamset: this.topicInputPutParamset,
-                rpc: this.topicInputRpc
+                rpc: this.topicInputRpc,
             };
 
             let command;
             let filter;
-            Object.keys(topicList).forEach(key => {
+            Object.keys(topicList).forEach((key) => {
                 if (!command) {
                     const parts = topicList[key].split('/');
                     const patternArray = [];
                     const placeholders = [];
                     for (let i = 0, {length} = parts; i < length; i++) {
                         let match;
-                        if (match = parts[i].match(/^\${([\w-]+)}$/)) { // eslint-disable-line no-cond-assign
+                        if ((match = parts[i].match(/^\${([\w-]+)}$/))) {
                             placeholders.push(match[1]);
-                            patternArray[i] = (i + 1) < length ? '+' : '#';
+                            patternArray[i] = i + 1 < length ? '+' : '#';
                         } else {
                             patternArray[i] = parts[i];
                         }
@@ -180,7 +192,10 @@ module.exports = function (RED) {
                     const match = mw(topic, pattern);
                     if (match && match.length === placeholders.length) {
                         command = key;
-                        filter = Object.assign.apply({}, placeholders.map((v, i) => ({[v]: match[i]})));
+                        filter = Object.assign.apply(
+                            {},
+                            placeholders.map((v, i) => ({[v]: match[i]})),
+                        );
                     }
                 }
             });
@@ -264,10 +279,14 @@ module.exports = function (RED) {
                 return;
             }
 
-            const psName = this.ccu.paramsetName(iface, this.ccu.metadata.devices[iface][filter.channel], filter.paramset);
+            const psName = this.ccu.paramsetName(
+                iface,
+                this.ccu.metadata.devices[iface][filter.channel],
+                filter.paramset,
+            );
             const paramsetDescription = this.ccu.paramsetDescriptions[psName];
             if (paramsetDescription && paramsetDescription[filter.param]) {
-                if (!(paramsetDescription[filter.param].OPERATIONS) && 2) {
+                if (!paramsetDescription[filter.param].OPERATIONS && 2) {
                     this.error('param ' + filter.param + ' not writeable');
                 }
 
@@ -279,8 +298,9 @@ module.exports = function (RED) {
             const paramset = {};
             paramset[filter.param] = payload;
 
-            this.ccu.methodCall(iface, 'putParamset', [filter.channel, filter.paramset, paramset])
-                .catch(error => this.error(error.message));
+            this.ccu
+                .methodCall(iface, 'putParamset', [filter.channel, filter.paramset, paramset])
+                .catch((error) => this.error(error.message));
         }
 
         putParamset(filter, payload) {
@@ -314,14 +334,18 @@ module.exports = function (RED) {
                 return;
             }
 
-            const psName = this.ccu.paramsetName(iface, this.ccu.metadata.devices[iface][filter.channel], filter.paramset);
+            const psName = this.ccu.paramsetName(
+                iface,
+                this.ccu.metadata.devices[iface][filter.channel],
+                filter.paramset,
+            );
             const paramsetDescription = this.ccu.paramsetDescriptions[psName];
 
             const paramset = {};
 
-            Object.keys(payload).forEach(parameter => {
+            Object.keys(payload).forEach((parameter) => {
                 if (paramsetDescription && paramsetDescription[parameter]) {
-                    if (!(paramsetDescription[parameter].OPERATIONS) && 2) {
+                    if (!paramsetDescription[parameter].OPERATIONS && 2) {
                         this.error('param ' + parameter + ' not writeable');
                     }
 
@@ -332,19 +356,21 @@ module.exports = function (RED) {
                 }
             });
 
-            this.ccu.methodCall(iface, 'putParamset', [filter.channel, filter.paramset, paramset])
-                .catch(error => this.error(error.message));
+            this.ccu
+                .methodCall(iface, 'putParamset', [filter.channel, filter.paramset, paramset])
+                .catch((error) => this.error(error.message));
         }
 
         paramCast(value, paramset) {
             switch (paramset && paramset.TYPE) {
                 case 'BOOL':
-                    // Fallthrough by intention
+                // Fallthrough by intention
                 case 'ACTION':
                     // OMG this is so ugly...
                     if (value === 'false') {
                         value = false;
-                    } else if (!isNaN(value)) { // Make sure that the string "0" gets casted to boolean false
+                    } else if (!isNaN(value)) {
+                        // Make sure that the string "0" gets casted to boolean false
                         value = Number(value);
                     }
 
@@ -362,12 +388,12 @@ module.exports = function (RED) {
                     break;
                 case 'ENUM':
                     if (typeof value === 'string') {
-                        if (paramset.ENUM && (paramset.ENUM.includes(value))) {
+                        if (paramset.ENUM && paramset.ENUM.includes(value)) {
                             value = paramset.ENUM.indexOf(value);
                         }
                     }
 
-                    // Fallthrough by intention
+                // Fallthrough by intention
                 case 'INTEGER':
                     value = Number.parseInt(value, 10);
                     if (value < paramset.MIN) {

package/nodes/ccu-program.html

@@ -5,7 +5,7 @@
         defaults: {
             name: {value: ''},
             ccuConfig: {value: 'localhost', type: 'ccu-connection', required: true},
-            topic: {value: 'ReGaHSS/${Name}'} // eslint-disable-line no-template-curly-in-string
+            topic: {value: 'ReGaHSS/${Name}'}  
         },
         inputs: 1,
         outputs: 1,

package/nodes/ccu-program.js

@@ -19,7 +19,7 @@ module.exports = function (RED) {
             this.name = config.name;
 
             if (this.name) {
-                this.idSubscription = this.ccu.subscribeProgram(this.name, message => {
+                this.idSubscription = this.ccu.subscribeProgram(this.name, (message) => {
                     message.topic = this.ccu.topicReplace(config.topic, message);
                     this.send(message);
                 });
@@ -32,27 +32,29 @@ module.exports = function (RED) {
         _input(message, send, done) {
             switch (typeof message.payload) {
                 case 'boolean':
-                    this.ccu.programActive(this.name || message.topic, message.payload)
-                        .then(message_ => {
+                    this.ccu
+                        .programActive(this.name || message.topic, message.payload)
+                        .then((message_) => {
                             send(message_);
 
                             this.status({fill: 'green', shape: 'dot', text: 'connected'});
                             done();
                         })
-                        .catch(error => {
+                        .catch((error) => {
                             this.status({fill: 'red', shape: 'dot', text: 'error'});
                             done(error);
                         });
                     break;
                 default:
-                    this.ccu.programExecute(this.name || message.topic)
-                        .then(message => {
+                    this.ccu
+                        .programExecute(this.name || message.topic)
+                        .then((message) => {
                             send(message);
 
                             this.status({fill: 'green', shape: 'dot', text: 'connected'});
                             done();
                         })
-                        .catch(error => {
+                        .catch((error) => {
                             this.status({fill: 'red', shape: 'dot', text: 'error'});
                             done(error);
                         });