node-red-contrib-knx-ultimate 2.1.36 → 2.1.38

package/CHANGELOG.md

@@ -6,9 +6,18 @@
 
 # CHANGELOG
 
+<p>
+<b>Version 2.1.38</b> - August 2023<br/>
+- Strenghten HUE eventsource resiliency.<br/>
+- Implemented standard logging on all HUE nodes (there was temporary console.log statements).<br/>
+</p>
+<p>
+<b>Version 2.1.37</b> - July 2023<br/>
+- Load control: added msg.shedding to force shed/unshed.<br/>
+</p>
 <p>
 <b>Version 2.1.36</b> - July 2023<br/>
-- Bugfix: in some cases, the eventsource lost the connection while in idle for more than 15 minutes. Fixed.<br/>
+- HUE Server bugfix: in some cases, the eventsource lost the connection while in idle for more than 15 minutes; fixed.<br/>
 </p>
 <p>
 <b>Version 2.1.35</b> - July 2023<br/>

package/nodes/hue-config.js

@@ -1,6 +1,6 @@
 
 const dptlib = require('./../KNXEngine/src/dptlib')
-const hueClass = require('./utils/hueUtils').classHUE
+const hueClass = require('./utils/hueEngine').classHUE
 const loggerEngine = require('./utils/sysLogger.js')
 // Helpers
 const sortBy = (field) => (a, b) => {
@@ -64,7 +64,7 @@ module.exports = (RED) => {
     node.name = (config.name === undefined || config.name === '') ? node.host : config.name // 12/08/2021
 
     // Init HUE Utility
-    node.hueManager = new hueClass(node.host, node.credentials.username, node.credentials.clientkey, config.bridgeid)
+    node.hueManager = new hueClass(node.host, node.credentials.username, node.credentials.clientkey, config.bridgeid, node.sysLogger)
 
     // Event clip V2
     node.hueManager.on('event', _event => {

package/nodes/knxUltimateLoadControl.html

@@ -350,4 +350,75 @@
 </br>
 </br>
 </br>
-</script>
+</script>
+
+
+<script type="text/markdown" data-help-name="knxUltimateLoadControl">
+<p>With the Load Control node you can automatically manage the disconnection of loads (washing machine, oven, etc.) when the current consumption exceeds a certain threshold.  
+
+The devices are turned off intelligently, checking the possible consumption of the device to determine whether to turn it off together with others. <br/>
+The node can automatically reactivate the loads. <br/>
+The node turns off one device (or multiple devices) at a time, based on the order you have selected.<br/>
+
+**General**
+
+|Property|Description|
+|--|--|
+| Gateway | KNX gateway. It is also possible not to select any gateway; in this case, only incoming messages to the node will be considered. |
+| Monitor Wh | Group address representing the total consumption of your building. |
+| Limit Wh | Maximum threshold that your electricity meter can withstand. When this threshold is exceeded, the node starts to turn off the devices. |
+| Delay switch off (s) | Expressed in seconds, indicates how often the node will evaluate consumption and switch off each device. |
+| Delay switch on (s) | Expressed in seconds, indicates how often the node will evaluate consumption and turn on each device that was turned off. |
+
+<br/>
+
+**LOAD CONTROL**
+
+Here you can add devices to turn off in case of overload. <br/>
+Choose the device to turn off. Enter the device name or its group address. <br/>
+Enter any group address that indicates the consumption of the device chosen in the first line. ** This is an optional parameter **. If the device is consuming more than a certain number of Watts, it means that it is in use. If it consumes less, the device will be considered "not in use" and both this and the next will be turned off at once.<br/>
+If *Automatic recovery* is enabled, the device is automatically reactivated when the "reset delay" expires.
+
+### Inputs
+
+|Property|Description|
+|--|--|
+| `msg.readstatus = true` | Force the reading of the values from the KNX BUS of each device in the list. ***The node already does everything by itself***, but if necessary, it is possible to use this command to force a re-reading of the current values in watt.|
+| `msg.enable = true` | Enable the load control.|
+| `msg.disable = true` | Disable the load control.|
+| `msg.reset = true` | Reset node states and turn all devices back on.|
+| `msg.shedding` | String. *shed* to start the formward shedding sequence, *unshed* to start reverse shedding. Use this msg to force the shedding timer to start/stop, ignoring the **Monitor Wh** group address. Set *auto* to enable again the **Monitor Wh** group address monitoring. |
+
+
+### Outputs
+
+1. Standard output
+: payload (string|object) : the standard output of the command.
+
+### Details
+
+```javascript
+
+msg = {
+  "topic": "Home Total Consumption", // Node Name
+  "operation": "Increase Shedding" or "Decrease Shedding" or operation reflecting the input message (disable, enable, reset), // Operation
+  "device": "Washing machine", // Device shedded
+  "ga": "", // Group address of the shedded device
+  "totalPowerConsumption": 3100, // Current power consumption
+  "wattLimit": 3000, // Limit you set in the config window
+  "payload": 1, // Current shedding stage
+}
+
+```
+
+### Sample
+
+<a href="https://github.com/Supergiovane/node-red-contrib-knx-ultimate/wiki/SampleLoadControl">CLICK HERE FOR THE EXAMPLE</a>
+
+<br/>
+
+[Find it useful?](https://www.paypal.me/techtoday)
+
+<br/>
+
+    </script>

package/nodes/knxUltimateLoadControl.js

@@ -1,6 +1,6 @@
 
 module.exports = function (RED) {
-  function knxUltimateLoadControl (config) {
+  function knxUltimateLoadControl(config) {
     // const Address = require('./../KNXEngine/src/protocol/KNXAddress')
 
     RED.nodes.createNode(this, config)
@@ -169,7 +169,7 @@ module.exports = function (RED) {
             }
           }
         }
-      }, 10000)
+      }, 20000)
     }
 
     // Start the timer
@@ -338,6 +338,25 @@ module.exports = function (RED) {
       if ((msg.hasOwnProperty('readstatus') && msg.readstatus === true)) {
         node.initialReadAllDevicesInRules()
       }
+
+      // 'shed', 'unshed', 'auto'
+      // | `msg.shedding` | String. *shed* to start the formward shedding sequence, *unshed* to start reverse shedding. Use this msg to force the shedding timer to start/stop, ignoring the **Monitor Wh** group address. Set *auto* to enable again the **Monitor Wh** group address monitoring. |
+      if (msg.shedding !== undefined) {
+        switch (msg.shedding) {
+          case 'shed':
+            node.wattLimit = 1 // Faking to shed
+            break;
+          case 'unshed':
+            node.wattLimit = 100000 // Faking to unshed
+            break;
+          case 'auto':
+            node.wattLimit = config.wattLimit === undefined ? 3000 : Number(config.wattLimit)
+            break;
+          default:
+            break;
+        }
+      }
+
     })
 
     node.on('close', function (done) {

package/nodes/utils/{hueUtils.js → hueEngine.js}

@@ -5,19 +5,20 @@ const http = require('./http.js')
 const EventSource = require('eventsource');
 
 class classHUE extends EventEmitter {
-  constructor(_hueBridgeIP, _username, _clientkey, _bridgeid) {
+  constructor(_hueBridgeIP, _username, _clientkey, _bridgeid, _sysLogger) {
     super()
-    this.setup(_hueBridgeIP, _username, _clientkey, _bridgeid)
+    this.setup(_hueBridgeIP, _username, _clientkey, _bridgeid, _sysLogger)
   }
 
-  setup = async (_hueBridgeIP, _username, _clientkey, _bridgeid) => {
+  setup = async (_hueBridgeIP, _username, _clientkey, _bridgeid, _sysLogger) => {
     this.hueBridgeIP = _hueBridgeIP
     this.username = _username
     this.clientkey = _clientkey
     this.bridgeid = _bridgeid
     this.commandQueue = []
     this.closePushEventStream = false
-    this.timerwriteQueueAdd = setTimeout(this.handleQueue, 3000) // First start
+    this.timerwriteQueueAdd = setTimeout(this.handleQueue, 5000) // First start
+    this.sysLogger = _sysLogger
 
     // #############################################
     const options = {
@@ -25,8 +26,8 @@ class classHUE extends EventEmitter {
         'hue-application-key': this.username,
       },
       https: {
-        rejectUnauthorized: false,
-      },
+        rejectUnauthorized: false
+      }
     };
 
     // Connect
@@ -47,25 +48,21 @@ class classHUE extends EventEmitter {
             })
           }
         } catch (error) {
-          console.log('KNXUltimateHUEUtils: classHUE: this.es.onmessage: ' + error.message)
+          if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error('KNXUltimatehueEngine: classHUE: this.es.onmessage: ' + error.message)
         }
 
       };
 
       this.es.onopen = () => {
-        //console.log('KNXUltimateHUEUtils: classHUE: SSE-Connected')
+        //if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error('KNXUltimatehueEngine: classHUE: SSE-Connected')
         //this.emit('connected');   
       }
 
       this.es.onerror = (error) => {
         try {
-          if (this.timerReconnect !== undefined) clearTimeout(this.timerReconnect)
-          this.timerReconnect = setTimeout(() => {
-            this.connect()
-          }, 5000)
           this.es.close()
           this.es = null
-          console.log('KNXUltimateHUEUtils: classHUE: request.on(error): ' + error.message)
+          if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error('KNXUltimatehueEngine: classHUE: request.on(error): ' + error.message)
         } catch (error) {
         }
         //this.emit('error', err)
@@ -83,12 +80,20 @@ class classHUE extends EventEmitter {
         this.hueAllRooms = await this.hueApiV2.get('/resource/room')
         this.hueAllDevices = await this.hueApiV2.get('/resource/device')
       } catch (error) {
-        if (this.timerReconnect !== undefined) clearTimeout(this.timerReconnect)
-        this.timerReconnect = setTimeout(() => {
-          this.connect()
-        }, 5000)
-        console.log('KNXUltimateHUEUtils: classHUE: this.hueApiV2 = await http.use: ' + error.message)
+        if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error('KNXUltimatehueEngine: classHUE: this.hueApiV2 = await http.use: ' + error.message)
       }
+
+      // 31/07/2023 Every now and then, restart the connection to the eventsource, because it can goes down without knowing that
+      if (this.timerReconnect !== undefined) clearInterval(this.timerReconnect)
+      this.timerReconnect = setInterval(() => {
+        try {
+          this.es.close()
+          this.es = null
+        } catch (error) {
+        }
+        this.connect()
+      }, 120000)
+
     }
     // First connection
     this.connect()
@@ -108,14 +113,14 @@ class classHUE extends EventEmitter {
           try {
             const ok = await this.hueApiV2.put('/resource/light/' + jRet._lightID, jRet._state)
           } catch (error) {
-            console.log('KNXUltimateHUEUtils: classHUE: handleQueue: setLight light: ' + error.message)
+            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.info('KNXUltimatehueEngine: classHUE: handleQueue: setLight light: ' + error.message)
           }
           break
         case 'setGroupedLight':
           try {
             const ok = await this.hueApiV2.put('/resource/grouped_light/' + jRet._lightID, jRet._state)
           } catch (error) {
-            console.log('KNXUltimateHUEUtils: classHUE: handleQueue: setLight grouped_light: ' + error.message)
+            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.info('KNXUltimatehueEngine: classHUE: handleQueue: setLight grouped_light: ' + error.message)
           }
           break
         case 'getLight':
@@ -123,7 +128,7 @@ class classHUE extends EventEmitter {
             const jReturn = await this.hueApiV2.get('/resource/light/' + jRet._lightID)
             jRet._callback(jReturn[0]) // Need to call the callback, because the event is absolutely async
           } catch (error) {
-            console.log('KNXUltimateHUEUtils: classHUE: handleQueue: getLight light: ' + error.message)
+            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.info('KNXUltimatehueEngine: classHUE: handleQueue: getLight light: ' + error.message)
           }
           break
         case 'getGroupedLight':
@@ -131,7 +136,7 @@ class classHUE extends EventEmitter {
             const jReturn = await this.hueApiV2.get('/resource/grouped_light/' + jRet._lightID)
             jRet._callback(jReturn[0]) // Need to call the callback, because the event is absolutely async
           } catch (error) {
-            console.log('KNXUltimateHUEUtils: classHUE: handleQueue: getLight grouped_light: ' + error.message)
+            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.info('KNXUltimatehueEngine: classHUE: handleQueue: getLight grouped_light: ' + error.message)
           }
           break
         case 'setScene':
@@ -139,7 +144,7 @@ class classHUE extends EventEmitter {
             const sceneID = jRet._lightID
             const ok = await this.hueApiV2.put('/resource/scene/' + sceneID, jRet._state)
           } catch (error) {
-            console.log('KNXUltimateHUEUtils: classHUE: handleQueue: setScene: ' + error.message)
+            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.info('KNXUltimatehueEngine: classHUE: handleQueue: setScene: ' + error.message)
           }
           break
         case 'stopScene':
@@ -152,7 +157,7 @@ class classHUE extends EventEmitter {
               this.writeHueQueueAdd(light.rid, jRet._state, 'setLight')
             });
           } catch (error) {
-            console.log('KNXUltimateHUEUtils: classHUE: handleQueue: stopScene: ' + error.message)
+            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error('KNXUltimatehueEngine: classHUE: handleQueue: stopScene: ' + error.message)
           }
           break
         case 'getBattery':
@@ -160,14 +165,14 @@ class classHUE extends EventEmitter {
             const jReturn = await this.hueApiV2.get('/resource/device_power/' + jRet._lightID)
             jRet._callback(jReturn[0]) // Need to call the callback, because the event is absolutely async
           } catch (error) {
-            console.log('KNXUltimateHUEUtils: classHUE: handleQueue: getBattery: ' + error.message)
+            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error('KNXUltimatehueEngine: classHUE: handleQueue: getBattery: ' + error.message)
           }
         case 'getLightLevel':
           try {
             const jReturn = await this.hueApiV2.get('/resource/light_level/' + jRet._lightID)
             jRet._callback(jReturn[0]) // Need to call the callback, because the event is absolutely async
           } catch (error) {
-            console.log('KNXUltimateHUEUtils: classHUE: handleQueue: getLightLevel: ' + error.message)
+            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error('KNXUltimatehueEngine: classHUE: handleQueue: getLightLevel: ' + error.message)
           }
           break
         case 'getTemperature':
@@ -175,7 +180,7 @@ class classHUE extends EventEmitter {
             const jReturn = await this.hueApiV2.get('/resource/temperature/' + jRet._lightID)
             jRet._callback(jReturn[0]) // Need to call the callback, because the event is absolutely async
           } catch (error) {
-            console.log('KNXUltimateHUEUtils: classHUE: handleQueue: getTemperature: ' + error.message)
+            if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error('KNXUltimatehueEngine: classHUE: handleQueue: getTemperature: ' + error.message)
           }
           break
         default:
@@ -274,7 +279,7 @@ class classHUE extends EventEmitter {
       }
       return { devices: retArray }
     } catch (error) {
-      console.log('KNXUltimateHue: HueUtils: classHUE: getDevices: error ' + error.message)
+      if (this.sysLogger !== undefined && this.sysLogger !== null) this.sysLogger.error('KNXUltimateHue: hueEngine: classHUE: getDevices: error ' + error.message)
       return ({ devices: error.message })
     }
   }
@@ -282,6 +287,7 @@ class classHUE extends EventEmitter {
   close = async () => {
     return new Promise((resolve, reject) => {
       try {
+        if (this.timerReconnect !== undefined) clearInterval(this.timerReconnect)
         this.closePushEventStream = true
         if (this.es !== null) this.es.close();
         this.es = null;

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "version": "2.1.36",
+  "version": "2.1.38",
   "description": "Control your KNX intallation via Node-Red! Single Node KNX IN/OUT with optional ETS group address importer. Easy to use and highly configurable. With integrated Philips HUE devices handling.",
   "dependencies": {
     "mkdirp": "3.0.1",