node-red-contrib-ccu 3.4.1 → 4.0.0

package/examples/system-variable.json

@@ -0,0 +1,60 @@
+[
+  {
+    "id": "sysvar-watch",
+    "type": "ccu-sysvar",
+    "name": "Presence",
+    "ccuConfig": "ccu-conn-example",
+    "topic": "${CCU}/SysVar/${Name}",
+    "change": true,
+    "cache": true,
+    "x": 340,
+    "y": 100,
+    "wires": [["debug-sysvar"]]
+  },
+  {
+    "id": "debug-sysvar",
+    "type": "debug",
+    "name": "sysvar",
+    "active": true,
+    "tosidebar": true,
+    "complete": "payload",
+    "x": 550,
+    "y": 100,
+    "wires": []
+  },
+  {
+    "id": "inject-set",
+    "type": "inject",
+    "name": "set true",
+    "props": [
+      {
+        "p": "payload"
+      }
+    ],
+    "payload": "true",
+    "payloadType": "bool",
+    "x": 140,
+    "y": 100,
+    "wires": [["sysvar-watch"]]
+  },
+  {
+    "id": "ccu-conn-example",
+    "type": "ccu-connection",
+    "name": "CCU",
+    "host": "ccu3-hostname-or-ip",
+    "regaEnabled": true,
+    "bcrfEnabled": true,
+    "iprfEnabled": true,
+    "virtEnabled": false,
+    "bcwiEnabled": false,
+    "cuxdEnabled": false,
+    "jackEnabled": false,
+    "regaPoll": true,
+    "regaInterval": "30",
+    "rpcPingTimeout": "60",
+    "rpcInitAddress": "",
+    "rpcServerHost": "",
+    "rpcBinPort": "2047",
+    "rpcXmlPort": "2048"
+  }
+]

package/nodes/ccu-alexa.html

@@ -21,7 +21,6 @@
             return this.name ? 'node_label_italic' : '';
         },
         oneditprepare() {
-            console.log(this);
 
             const $nodeInputIface = $('#node-input-iface');
             const $nodeInputCcuConfig = $('#node-input-ccuConfig');
@@ -30,6 +29,7 @@
             let data;
             let ifacesLoaded = false;
             let ifacesPending = false;
+            let ifaceLoadRetries = 5;
 
             function loadIfaces(iface, cb) {
                 if (ifacesPending) {
@@ -37,7 +37,6 @@
                 }
 
                 ifacesPending = true;
-                console.log('loadIfaces()');
                 $nodeInputIface.html('<option value=""></option>');
                 const nodeId = $nodeInputCcuConfig.val();
                 if (nodeId === '_ADD_') {
@@ -57,6 +56,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);
+                        }
                     });
                 }
             }
@@ -66,18 +71,15 @@
                     return;
                 }
 
-                console.log('loadConfig()');
                 const nodeId = $nodeInputCcuConfig.val();
                 const url = 'ccu?config=' + nodeId + '&type=channels&iface=' + $nodeInputIface.val();
                 $.getJSON(url, d => {
                     data = d;
-                    console.log(d);
                     autocompleteChannel();
                 });
             }
 
             $nodeInputCcuConfig.change(() => {
-                console.log('$nodeInputCcuConfig change');
                 loadIfaces(this.iface, () => {
                     ifacesLoaded = true;
                     $nodeInputIface.removeAttr('disabled');
@@ -85,6 +87,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');
+
             $nodeInputChannel.autocomplete({
                 source: [],
                 close: () => {
@@ -122,7 +128,6 @@
             }
 
             $nodeInputIface.change(() => {
-                console.log('$nodeInputIface change');
                 loadConfig();
             });
         },
@@ -172,7 +177,7 @@
 
 </script>
 
-<script type="text/x-red" data-template-name="ccu-alexa">
+<script type="text/x-red" data-help-name="ccu-alexa" lang="de">
     <p>Homematic Geräte mit node-red-contrib-alexa-smart-home verbinden. Am Eingang den Node "alexa smart home v3"
     anschließen, am Ausgang "alexa smart home v3 state".</p>
 </script>

package/nodes/ccu-alexa.js

@@ -36,21 +36,21 @@ module.exports = function (RED) {
                 change: true,
                 stable: true,
                 iface: config.iface,
-                channel: String(config.channel).split(' ')[0]
+                channel: String(config.channel).split(' ')[0],
             };
 
             const payload = {
                 acknowledge: true,
-                state: {}
+                state: {},
             };
 
-            this.idSubscription = this.ccu.subscribe(filter, message => {
+            this.idSubscription = this.ccu.subscribe(filter, (message) => {
                 let change = false;
                 switch (channelType) {
                     case 'SHUTTER_CONTACT':
                     case 'ROTARY_HANDLE_SENSOR':
                         if (message.datapoint === 'STATE') {
-                            payload.state.contact = message.payload ? 'NOT_DETECTED' : 'DETECTED';
+                            payload.state.contact = message.payload ? 'DETECTED' : 'NOT_DETECTED';
                             change = true;
                         }
 
@@ -145,18 +145,31 @@ module.exports = function (RED) {
                         return;
                 }
 
-                if (Object.keys(payload.state).length > 0) {
+                const keys = Object.keys(payload.state);
+
+                if (keys.length > 0) {
                     if (change) {
                         this.debug(JSON.stringify(payload));
-                        this.send({payload});
-                        this.status({fill: 'green', shape: 'ring', text: JSON.stringify(payload.state).replace(/^{/, '').replace(/}$/, '')});
+                        this.status({
+                            fill: 'green',
+                            shape: 'ring',
+                            text: JSON.stringify(payload.state).replace(/^{/, '').replace(/}$/, ''),
+                        });
+                        keys.forEach((key) => {
+                            const distinctPayload = {
+                                acknowledge: true,
+                                state: {},
+                            };
+                            distinctPayload.state[key] = payload.state[key];
+                            this.send({payload: distinctPayload});
+                        });
                     }
                 } else {
                     this.debug('empty state object');
                 }
             });
 
-            this.on('input', message => {
+            this.on('input', (message) => {
                 this.debug('alexa > ' + JSON.stringify(message));
 
                 if (!this.iface) {
@@ -173,7 +186,12 @@ module.exports = function (RED) {
                     case 'TurnOn':
                     case 'TurnOff':
                         if (channelType.startsWith('DIMMER')) {
-                            this.ccu.setValueQueued(this.iface, this.channel, 'LEVEL', message.payload === 'ON' ? 1 : 0);
+                            this.ccu.setValueQueued(
+                                this.iface,
+                                this.channel,
+                                'LEVEL',
+                                message.payload === 'ON' ? 1 : 0,
+                            );
                         } else {
                             this.ccu.setValueQueued(this.iface, this.channel, 'STATE', message.payload === 'ON');
                         }
@@ -191,7 +209,12 @@ module.exports = function (RED) {
 
                     case 'AdjustBrightness':
                         if (channelType.startsWith('DIMMER')) {
-                            this.ccu.setValueQueued(this.iface, this.channel, 'LEVEL', (this.values.brightness + message.payload) / 100);
+                            this.ccu.setValueQueued(
+                                this.iface,
+                                this.channel,
+                                'LEVEL',
+                                (this.values.brightness + message.payload) / 100,
+                            );
                         } else {
                             this.ccu.setValueQueued(this.iface, this.channel, 'STATE', message.payload > 0);
                         }
@@ -206,7 +229,12 @@ module.exports = function (RED) {
                                 break;
 
                             case 'HEATING_CLIMATECONTROL_TRANSCEIVER':
-                                this.ccu.setValueQueued(this.iface, this.channel, 'SET_POINT_TEMPERATURE', message.payload);
+                                this.ccu.setValueQueued(
+                                    this.iface,
+                                    this.channel,
+                                    'SET_POINT_TEMPERATURE',
+                                    message.payload,
+                                );
                                 break;
 
                             default:
@@ -226,10 +254,10 @@ module.exports = function (RED) {
 
                         break;
 
-                        // Todo case 'SetColor':
-                        // Todo case 'SetColorTemperature':
-                        // Todo case 'AdjustTargetTemperature':
-                        // todo case 'SetThermostatMode':
+                    // Todo case 'SetColor':
+                    // Todo case 'SetColorTemperature':
+                    // Todo case 'AdjustTargetTemperature':
+                    // todo case 'SetThermostatMode':
 
                     default:
                         this.warn('unknown command ' + message.command);

package/nodes/ccu-connection.html

@@ -11,6 +11,8 @@
             virtEnabled: {value: true},
             bcwiEnabled: {value: false},
             cuxdEnabled: {value: false},
+            jackEnabled: {value: false},
+            jackPort: {value: 2121},
 
             regaPoll: {value: true},
             regaInterval: {value: 30},
@@ -80,6 +82,7 @@
                                 $('#node-config-input-virtEnabled').prop('checked', ccu.interfaces.VirtualDevices);
                                 $('#node-config-input-bcwiEnabled').prop('checked', ccu.interfaces['BidCos-Wired']);
                                 $('#node-config-input-cuxdEnabled').prop('checked', ccu.interfaces.CuXD);
+                                $('#node-config-input-jackEnabled').prop('checked', ccu.interfaces['CCU-Jack']);
                             }
                         });
                     },
@@ -116,6 +119,8 @@
         }
     });
 
+    // called from the inline onclick attribute of the authentication checkbox
+    // eslint-disable-next-line no-unused-vars
     function TLSSSL(){        
         if (document.getElementById('node-config-input-authentication').checked && !document.getElementById('node-config-input-tls').checked){
             document.getElementById('node-config-input-tls').checked = true
@@ -168,7 +173,9 @@
             <label class="ccu-checkbox"><input type="checkbox" id="node-config-input-bcwiEnabled"> BidCos-Wired</label><br>
             <label class="ccu-checkbox"><input type="checkbox" id="node-config-input-iprfEnabled"> HmIP-RF</label><br>
             <label class="ccu-checkbox"><input type="checkbox" id="node-config-input-virtEnabled"> VirtualDevices</label><br>
-            <label class="ccu-checkbox"><input type="checkbox" id="node-config-input-cuxdEnabled"> CUxD</label>
+            <label class="ccu-checkbox"><input type="checkbox" id="node-config-input-cuxdEnabled"> CUxD</label><br>
+            <label class="ccu-checkbox"><input type="checkbox" id="node-config-input-jackEnabled"> CCU-Jack</label>
+            <input type="text" id="node-config-input-jackPort" style="width: 70px;" placeholder="2121">
         </div>
     </div>
     <div class="form-row">
@@ -254,6 +261,7 @@
                         <li>HmIP-RF: Homematic-IP Funk</li>
                         <li>VirtualDevices: Heizungsgruppen, in CCU eingebundene Systeme wie Osram Lightify</li>
                         <li>CUxD</li>
+                        <li>CCU-Jack: XMLRPC-Schnittstelle des <a href="https://github.com/mdzio/ccu-jack" target="_blank">CCU-Jack</a> Addons (Port konfigurierbar, Standard 2121 bzw. 2122 mit TLS)</li>
                     </ul>
 
                 </li>