node-red-contrib-ccu 3.4.2 → 4.0.0

package/nodes/ccu-rpc.html

@@ -14,7 +14,7 @@
                     return false;
                 }
             }},
-            topic: {value: '${CCU}/${Interface}/${Method}'} // eslint-disable-line no-template-curly-in-string
+            topic: {value: '${CCU}/${Interface}/${Method}'}  
         },
         inputs: 1,
         outputs: 1,
@@ -34,6 +34,7 @@
 
             let ifacesLoaded = false;
             let ifacesPending = false;
+            let ifaceLoadRetries = 5;
 
             function loadIfaces(iface, cb) {
                 if (ifacesPending) {
@@ -41,7 +42,6 @@
                 }
 
                 ifacesPending = true;
-                console.log('loadIfaces()');
                 $nodeInputIface.html('<option></option>');
                 const nodeId = $nodeInputCcuConfig.val();
                 if (nodeId === '_ADD_') {
@@ -59,12 +59,17 @@
                             cb();
                             ifacesPending = false;
                         }
+                    }).fail(() => {
+                        // config node not (yet) available in the runtime - allow retrying
+                        ifacesPending = false;
+                        if (ifaceLoadRetries-- > 0) {
+                            setTimeout(() => loadIfaces(iface, cb), 1000);
+                        }
                     });
                 }
             }
 
             $nodeInputCcuConfig.change(() => {
-                console.log('$nodeInputCcuConfig change');
                 loadIfaces(this.iface, () => {
                     ifacesLoaded = true;
                     $nodeInputIface.removeAttr('disabled');
@@ -72,6 +77,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');
+
             $('#node-input-method').autocomplete({
                 source: [],
                 close: () => {
@@ -83,7 +92,6 @@
 
             $('#node-input-iface').change(() => {
                 if (ifacesLoaded) {
-                    console.log('#node-input-iface change');
                     autocompleteMethods();
                 }
             });
@@ -116,7 +124,6 @@
                         methods = [];
                 }
 
-                console.log('autocompleteMethods', iface, methods.length);
                 $('#node-input-method').autocomplete('option', 'source', methods);
             }
         }

package/nodes/ccu-rpc.js

@@ -37,27 +37,29 @@ module.exports = function (RED) {
                 } else if (method === 'putParamset') {
                     let [address, paramset, values] = parameters;
                     values = values || {};
-                    Object.keys(values).forEach(parameter => {
+                    Object.keys(values).forEach((parameter) => {
                         values[parameter] = this.ccu.paramCast(iface, address, paramset, parameter, values[parameter]);
                     });
                     parameters[2] = values;
                 }
 
-                this.ccu.methodCall(iface, method, parameters)
-                    .then(res => {
+                this.ccu
+                    .methodCall(iface, method, parameters)
+                    .then((res) => {
                         const message = {
                             ccu: this.ccu.host,
                             iface,
                             topic: config.topic,
                             payload: res,
-                            ts: (new Date()).getTime(),
-                            method
+                            ts: new Date().getTime(),
+                            method,
                         };
                         message.topic = this.ccu.topicReplace(config.topic, message);
                         send(message);
 
                         done();
-                    }).catch(error => {
+                    })
+                    .catch((error) => {
                         done(error);
                     });
             });

package/nodes/ccu-script.html

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

package/nodes/ccu-script.js

@@ -21,8 +21,9 @@ module.exports = function (RED) {
         _input(message, send, done) {
             let script = this.script || message.payload;
             script += '\n\nvar nr_script_call_success = true;\n';
-            this.ccu.script(script)
-                .then(message => {
+            this.ccu
+                .script(script)
+                .then((message) => {
                     message.iface = this.iface;
                     message.ccu = this.ccu.host;
                     message.topic = this.ccu.topicReplace(this.topic, message);
@@ -36,7 +37,7 @@ module.exports = function (RED) {
                         done(new Error('Script call failed'));
                     }
                 })
-                .catch(error => {
+                .catch((error) => {
                     this.status({fill: 'red', shape: 'dot', text: 'error'});
                     done(error);
                 });

package/nodes/ccu-set-value.html

@@ -49,6 +49,7 @@
 
             let ifacesLoaded = false;
             let ifacesPending = false;
+            let ifaceLoadRetries = 5;
 
             $('#node-input-force-dropdown').val(String(Boolean(this.force)));
 
@@ -96,7 +97,6 @@
                 }
 
                 ifacesPending = true;
-                console.log('loadIfaces()');
                 $nodeInputIface.html('<option value="">*</option>');
                 const nodeId = $nodeInputCcuConfig.val();
                 if (nodeId === '_ADD_') {
@@ -116,6 +116,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);
+                        }
                     });
                 }
             }
@@ -128,15 +134,17 @@
                 });
             });
 
+            // 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');
+
             function loadConfig() {
                 if (ifacesLoaded) {
-                    console.log('loadConfig');
                     const nodeId = $nodeInputCcuConfig.val();
                     const url = 'ccu?config=' + nodeId;
                     $.getJSON(url, d => {
                         data = d;
                         processChannelAssignments();
-                        console.log('data', data);
                         autocomplete();
                     });
                 }
@@ -150,7 +158,6 @@
                 data.nameChannels = {};
                 data.nameDevices = {};
 
-                console.log(data);
 
                 Object.keys(data.channelRooms).forEach(channel => {
                     const room = data.channelRooms[channel];
@@ -236,7 +243,6 @@
                 const channelNames = $('#node-input-channelName').val() ? [$('#node-input-channelName').val()] : [];
                 const channelTypes = $('#node-input-channelType').val() ? [$('#node-input-channelType').val()] : [];
                 //const channelIndexes = $('#node-input-channelIndex').val() ? [$('#node-input-channelIndex').val()] : [];
-                const datapoints = $('#node-input-datapoint').val() ? [$('#node-input-datapoint').val()] : [];
 
                 const lists = {
                     device: [],
@@ -292,7 +298,6 @@
                         }
                     }
 
-                    console.log('autocomplete', {iface, rooms, funcs, devices, deviceNames, deviceTypes, channels, channelNames, channelTypes, datapoints});
 
                     function checkDatapoint(datapoint) {
                         let deviceCheck = false;
@@ -476,7 +481,6 @@
                     });
                 }
 
-                console.log('lists', lists);
 
                 Object.keys(lists).forEach(key => {
                     if (key === 'channelIndex') {

package/nodes/ccu-set-value.js

@@ -37,13 +37,13 @@ module.exports = function (RED) {
                 channelIndexRx: config.channelIndexRx,
                 channelNameRx: config.channelNameRx,
                 datapointRx: config.datapointRx,
-                force: config.force
+                force: config.force,
             };
 
             this.blacklist = new Set();
             this.whitelist = new Set();
 
-            this.on('input', message => {
+            this.on('input', (message) => {
                 this.setValues(message);
             });
 
@@ -66,7 +66,7 @@ module.exports = function (RED) {
         setValues(message) {
             const {config} = this;
             let dynamicConfig = false;
-            Object.keys(config).forEach(key => {
+            Object.keys(config).forEach((key) => {
                 if (!config[key]) {
                     if (key in message) {
                         dynamicConfig = true;
@@ -81,12 +81,12 @@ module.exports = function (RED) {
             }
 
             let count = 0;
-            Object.keys(this.ccu.metadata.devices).forEach(iface => {
+            Object.keys(this.ccu.metadata.devices).forEach((iface) => {
                 if (config.iface && iface !== config.iface) {
                     return;
                 }
 
-                Object.keys(this.ccu.metadata.devices[iface]).forEach(address => {
+                Object.keys(this.ccu.metadata.devices[iface]).forEach((address) => {
                     if (this.blacklist.has(address)) {
                         return;
                     }
@@ -130,12 +130,18 @@ module.exports = function (RED) {
                                 return;
                             }
 
-                            if (config.deviceNameRx === 'str' && this.ccu.channelNames[channel.PARENT] !== config.deviceName) {
+                            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))) {
+                            if (
+                                config.deviceNameRx === 're' &&
+                                !this.ccu.channelNames[channel.PARENT].match(new RegExp(config.deviceName))
+                            ) {
                                 this.blacklist.add(address);
                                 return;
                             }
@@ -171,7 +177,10 @@ module.exports = function (RED) {
                                 return;
                             }
 
-                            if (config.channelIndexRx === 're' && !address.split(':')[1].match(new RegExp(String(config.channelIndex)))) {
+                            if (
+                                config.channelIndexRx === 're' &&
+                                !address.split(':')[1].match(new RegExp(String(config.channelIndex)))
+                            ) {
                                 this.blacklist.add(address);
                                 return;
                             }
@@ -183,12 +192,18 @@ module.exports = function (RED) {
                                 return;
                             }
 
-                            if (config.channelNameRx === 'str' && this.ccu.channelNames[address] !== config.channelName) {
+                            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))) {
+                            if (
+                                config.channelNameRx === 're' &&
+                                !this.ccu.channelNames[address].match(new RegExp(config.channelName))
+                            ) {
                                 this.blacklist.add(address);
                                 return;
                             }
@@ -207,7 +222,7 @@ module.exports = function (RED) {
 
                             if (config.roomsRx === 're') {
                                 let match = false;
-                                this.ccu.channelRooms[address].forEach(room => {
+                                this.ccu.channelRooms[address].forEach((room) => {
                                     if (room.match(new RegExp(config.rooms))) {
                                         match = true;
                                     }
@@ -225,14 +240,17 @@ module.exports = function (RED) {
                                 return;
                             }
 
-                            if (config.functionsRx === 'str' && !this.ccu.channelFunctions[address].includes(config.functions)) {
+                            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 => {
+                                this.ccu.channelFunctions[address].forEach((func) => {
                                     if (func.match(new RegExp(config.functions))) {
                                         match = true;
                                     }
@@ -250,7 +268,7 @@ module.exports = function (RED) {
                     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 => {
+                        Object.keys(this.ccu.paramsetDescriptions[psKey]).forEach((dp) => {
                             if (config.datapointRx === 'str' && dp !== config.datapoint) {
                                 return;
                             }
@@ -262,8 +280,14 @@ module.exports = function (RED) {
                             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(() => {});
+                            if (
+                                dp.startsWith('PRESS_') ||
+                                typeof currentValue === 'undefined' ||
+                                currentValue !== message.payload
+                            ) {
+                                this.ccu
+                                    .setValueQueued(iface, address, dp, message.payload, false, config.force)
+                                    .catch(() => {});
                             }
                         });
                     }

package/nodes/ccu-signal.html

@@ -151,6 +151,7 @@
 
             let ifacesLoaded = false;
             let ifacesPending = false;
+            let ifaceLoadRetries = 5;
 
             function loadIfaces(iface, cb) {
                 if (ifacesPending) {
@@ -158,7 +159,6 @@
                 }
 
                 ifacesPending = true;
-                console.log('loadIfaces()');
                 $nodeInputIface.html('');
                 const nodeId = $nodeInputCcuConfig.val();
                 if (nodeId === '_ADD_') {
@@ -178,6 +178,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);
+                        }
                     });
                 }
             }
@@ -186,7 +192,6 @@
                 if (ifacesLoaded) {
                     const nodeId = $nodeInputCcuConfig.val();
                     if (nodeId && nodeId !== '__ADD__') {
-                        console.log('loadConfig()');
                         $.getJSON('ccu?type=signal&config=' + nodeId + '&iface=' + $nodeInputIface.val(), d => {
                             data = d;
                             autoCompleteChannel();
@@ -198,7 +203,6 @@
             }
 
             $nodeInputCcuConfig.change(() => {
-                console.log('$nodeInputCcuConfig change');
                 loadIfaces(this.iface, () => {
                     ifacesLoaded = true;
                     $nodeInputIface.removeAttr('disabled');
@@ -206,6 +210,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();
@@ -258,7 +266,6 @@
                     });
                 }
 
-                console.log('autoCompleteChannel()', arr.length);
                 $nodeInputChannel.autocomplete('option', 'source', arr);
 
                 if (!data[$nodeInputChannel.val().split(' ')[0]]) {
@@ -417,7 +424,6 @@
                     $('#node-input-dimmer-container').editableList('items').each(function () {
                         dimmerList.push({color: $(this).find('select.color').val(), ontime: $(this).find('select.ontime').val()});
                     });
-                    console.log(dimmerList);
                     this.dimmerList = dimmerList;
                     break;
                 }

package/nodes/ccu-signal.js

@@ -29,16 +29,19 @@ module.exports = function (RED) {
                     .then(() => this.getValue(values, 'repeat', message))
                     .then(() => this.getValue(values, 'volume', message))
                     .then(() => this.getValue(values, 'soundLevel', message))
-                    .catch(error => {
+                    .catch((error) => {
                         this.error(error.message);
                     })
                     .then(() => {
-                        this.sendCommand({...this.config, ...values}).then(() => {
-                            done();
-                        }).catch(error => {
-                            done(error);
-                        });
-                    }).catch(() => {});
+                        this.sendCommand({...this.config, ...values})
+                            .then(() => {
+                                done();
+                            })
+                            .catch((error) => {
+                                done(error);
+                            });
+                    })
+                    .catch(() => {});
             });
         }
 
@@ -56,12 +59,16 @@ module.exports = function (RED) {
                     payload = ['1', config.repeat, 108000, ...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', [config.channel, 'VALUES', {
-                        ACOUSTIC_ALARM_SELECTION: config.acousticAlarmSelection,
-                        DURATION_UNIT: config.durationUnit,
-                        DURATION_VALUE: Number.parseInt(config.durationValue, 10) || 0,
-                        OPTICAL_ALARM_SELECTION: config.opticalAlarmSelection
-                    }]);
+                    return this.ccu.methodCall(config.iface, 'putParamset', [
+                        config.channel,
+                        'VALUES',
+                        {
+                            ACOUSTIC_ALARM_SELECTION: config.acousticAlarmSelection,
+                            DURATION_UNIT: config.durationUnit,
+                            DURATION_VALUE: Number.parseInt(config.durationValue, 10) || 0,
+                            OPTICAL_ALARM_SELECTION: config.opticalAlarmSelection,
+                        },
+                    ]);
                 case 'DIMMER_VIRTUAL_RECEIVER': {
                     const parameters = {
                         LEVEL: config.dimmerLevel / 100,
@@ -70,7 +77,7 @@ 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: config.dimmerList.length,
                     };
                     config.dimmerList.forEach((item, i) => {
                         const index = i + 1;
@@ -81,14 +88,18 @@ module.exports = function (RED) {
                 }
 
                 case 'BSL_DIMMER_VIRTUAL_RECEIVER': {
-                    return this.ccu.methodCall(config.iface, 'putParamset', [config.channel, 'VALUES', {
-                        LEVEL: config.dimmerLevel / 100,
-                        RAMP_TIME_UNIT: config.rampTimeUnit,
-                        RAMP_TIME_VALUE: Number(config.rampTimeValue),
-                        DURATION_UNIT: config.durationUnit,
-                        DURATION_VALUE: Number.parseInt(config.durationValue, 10) || 0,
-                        COLOR: Number(config.dimmerColor)
-                    }]);
+                    return this.ccu.methodCall(config.iface, 'putParamset', [
+                        config.channel,
+                        'VALUES',
+                        {
+                            LEVEL: config.dimmerLevel / 100,
+                            RAMP_TIME_UNIT: config.rampTimeUnit,
+                            RAMP_TIME_VALUE: Number(config.rampTimeValue),
+                            DURATION_UNIT: config.durationUnit,
+                            DURATION_VALUE: Number.parseInt(config.durationValue, 10) || 0,
+                            COLOR: Number(config.dimmerColor),
+                        },
+                    ]);
                 }
 
                 case 'ACOUSTIC_SIGNAL_VIRTUAL_RECEIVER': {
@@ -99,7 +110,7 @@ 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: config.soundList.length,
                     };
                     config.soundList.forEach((item, i) => {
                         const index = i + 1;

package/nodes/ccu-switch.html

@@ -113,6 +113,7 @@
 
                 let ifacesLoaded = false;
                 let ifacesPending = false;
+                let ifaceLoadRetries = 5;
 
                 $('.form-row.datapoint').hide();
                 $('.form-row.sysvar').hide();
@@ -134,7 +135,6 @@
                         return;
                     }
                     ifacesPending = true;
-                    console.log('loadIfaces()');
 
                     $nodeInputIface.html('');
 
@@ -154,6 +154,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('');
@@ -163,6 +169,8 @@
                                 });
                             }
                         });
+                    } else {
+                        ifacesPending = false;
                     }
                 }
 
@@ -170,7 +178,6 @@
                     if (!ifacesLoaded) {
                         return;
                     }
-                    console.log('loadConfig()');
                     const nodeId = $nodeInputCcuConfig.val();
                     const url = 'ccu?config=' + nodeId + '&type=channels&iface=' + $nodeInputIface.val();
                     $.getJSON(url, d => {
@@ -181,13 +188,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: () => {
@@ -247,7 +257,6 @@
                 }
 
                 $nodeInputIface.change(() => {
-                    console.log('$nodeInputIface change');
                     if ($nodeInputIface.val() === 'ReGaHSS') {
                         $('.form-row.datapoint').hide();
                         $('.form-row.sysvar').show();
@@ -531,7 +540,6 @@
                 }
 
                 $configLookupTree.on('treelistselect', (event, item) => {
-                    console.log(item);
                     if (item && item.iface && item.channel && item.datapoint && item.property) {
                         $('.form-row.sysvar').hide();
                         $('.form-row.datapoint').show();

package/nodes/ccu-sysvar.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}'},  
             change: {value: true},
             cache: {value: true}
         },

package/nodes/ccu-sysvar.js

@@ -28,11 +28,14 @@ module.exports = function (RED) {
             this.name = config.name;
             this.topic = config.topic;
 
-            this.idSubscription = this.ccu.subscribeSysvar({name: this.name, cache: config.cache, change: config.change}, message => {
-                this.status({fill: 'green', shape: 'ring', text: String(message.payload)});
-                message.topic = this.ccu.topicReplace(config.topic, message);
-                this.send(message);
-            });
+            this.idSubscription = this.ccu.subscribeSysvar(
+                {name: this.name, cache: config.cache, change: config.change},
+                (message) => {
+                    this.status({fill: 'green', shape: 'ring', text: String(message.payload)});
+                    message.topic = this.ccu.topicReplace(config.topic, message);
+                    this.send(message);
+                },
+            );
 
             this.on('input', this._input);
             this.on('close', this._destructor);
@@ -41,12 +44,13 @@ module.exports = function (RED) {
         _input(message, send, done) {
             const name = this.name || message.topic;
             const value = message.payload;
-            this.ccu.setVariable(name, value)
+            this.ccu
+                .setVariable(name, value)
                 .then(() => {
                     this.status({fill: 'green', shape: 'ring', text: String(value)});
                     done();
                 })
-                .catch(error => {
+                .catch((error) => {
                     this.currentStatus = 'red';
                     this.status({fill: 'red', shape: 'dot', text: 'error'});
                     done(error);