node-red-contrib-knx-ultimate 2.4.21 → 2.4.22

package/CHANGELOG.md

@@ -6,6 +6,10 @@
 
 # CHANGELOG
 
+**Version 2.4.22** - April 2024<br/>
+- Warning: this version uses the Node-Red plugin system; the  Node-Red version must be **equals or major than 3.1.1**<br/>
+- HUE button node: NEW: now you can select the value and the dim direction to be transmitted, when Toggle Status is set to unchecked. Thanks @cybersmart-eu for the suggestion.<br/>
+
 **Version 2.4.21** - April 2024<br/>
 - Warning: this version uses the Node-Red plugin system; the  Node-Red version must be **equals or major than 3.1.1**<br/>
 - Home Assistant translator node: fixed an issue where user added translations does not work.<br/>

package/nodes/knxUltimateHueButton.html

@@ -23,7 +23,10 @@
             dptshort_releaseStatus: { value: "1.001" },
 
             toggleValues: { value: true },
-            hueDevice: { value: "" }
+            hueDevice: { value: "" },
+
+            switchSend: { value: true },
+            dimSend: { value: "up" },
         },
         inputs: 0,
         outputs: 1,
@@ -64,6 +67,33 @@
                 } catch (error) { }
             });
 
+            $("#node-input-toggleValues").change(function () {
+                if ($("#node-input-toggleValues").is(":checked")) {
+
+                    $("#divFixedValue").hide();
+                    $("#divStatus").show();
+                } else {
+                    $("#divFixedValue").show();
+                    $("#divStatus").hide();
+                }
+            });
+
+            // Testing typedInput how it works
+            $("#node-input-switchSend").typedInput({
+                type: 'bool',
+                types: ['bool']
+            })
+            $("#node-input-dimSend").typedInput({
+                type: "direction", types: [{
+                    value: "direction",
+                    options: [
+                        { value: "up", label: "Up" },
+                        { value: "down", label: "Down" },
+                        { value: "stop", label: "Stop" },
+                    ]
+                }]
+            })
+
             // 31/03/2020 Search Helper
             function fullSearch(sourceText, searchString) {
                 // This searches for all words in a string
@@ -360,7 +390,7 @@
         <label for="node-input-nameshort_release" style="width:50px; margin-left: 0px; text-align: right;">Name</label>
         <input type="text" id="node-input-nameshort_release" style="width:200px;margin-left: 5px; text-align: left;">
     </div>
-    <div class="form-row">
+    <div class="form-row" id="divStatus">
         <label style="width:100px;"><i class="fa fa-question-circle"></i> Switch Status</label>
 
         <label for="node-input-GAshort_releaseStatus" style="width:20px;">GA</label>
@@ -371,10 +401,8 @@
     
         <label for="node-input-nameshort_releaseStatus" style="width:50px; margin-left: 0px; text-align: right;">Name</label>
         <input type="text" id="node-input-nameshort_releaseStatus" style="width:200px;margin-left: 5px; text-align: left;">
+        <br/>  
     </div>
-    <br/>
-    <br/>
-
     <div class="form-row">
         <label style="width:100px;"><i class="fa fa-play-circle-o"></i> Dim</span></label>
 
@@ -388,8 +416,6 @@
         <input type="text" id="node-input-nameDim" style="width:200px;margin-left: 5px; text-align: left;">
     </div>
     <br/>
-    <br/>
-
     <div class="form-row">
         <input type="checkbox" id="node-input-toggleValues" style="display:inline-block; width:auto; vertical-align:top;" />
         <label style="width:auto" for="node-input-toggleValues">
@@ -398,13 +424,21 @@
             Toggle values
         </label>
     </div>
-        
-
-<br/>
+    <div id="divFixedValue" hidden>
+        <div class="form-row" >
+            <label for="node-input-switchSend" style="width:100px;"><i class="fa fa-play-circle-o"></i> Switch send</span></label>
+            <input type="text" id="node-input-switchSend">
+        </div>
+        <div class="form-row" >
+            <label for="node-input-dimSend" style="width:100px;"><i class="fa fa-play-circle-o"></i> Dim send</span></label>
+            <input type="text" id="node-input-dimSend">
+        </div>
+    </div>
 <br/>
 <br/>
 
 
+
 </script>
 
 <script type="text/markdown" data-help-name="knxUltimateHueButton">
@@ -431,7 +465,9 @@ This allows the internal logic to be aware of external devices, like wall switch
 | Switch | As soon as you quickly press and release your HUE button, this event fires |
 | Switch Status | To allow internal logic to take care of the external KNX devices, for example an external wall switch, you should set this group address |
 | Dim | This event is used either to send DIM (increase/decrease) or true/false commands to the KNX group address |
-| Toggle values | Enable or disable toggling values. If enabled, all values toggles, otherwise, all values are sent as *true* or *increase dim*, to the selected KNX group address |
+| Toggle values | Enable or disable toggling values. If enabled, all values toggles, otherwise, all values are sent as *true* or *increase dim*, to the selected KNX group address. If unchecked, you'll able to select the payload to be sent to KNX bus every time you press the button. |
+| Switch send | Only visible when *Toggle values* is *false*. Set the value to be sent when pushing the button. |
+| Dim send | Only visible when *Toggle values* is *false*. Set the dimming direction to be sent when dimming. |
 
 ### Outputs
 

package/nodes/knxUltimateHueButton.js

@@ -29,6 +29,14 @@ module.exports = function (RED) {
     node.hueDevice = config.hueDevice;
     node.initializingAtStart = false;
 
+    // When toggle status is disabled, uses these values
+    node.switchSend = config.switchSend === undefined ? 'true' : config.switchSend;
+    node.switchSend = node.switchSend === 'true'; // The typedvalue in the html returns a string, so i convert it to bool
+    node.dimSend = config.dimSend === undefined ? 'up' : config.dimSend;
+    if (node.dimSend === 'up') node.dimSend = { decr_incr: 1, data: 3 };
+    if (node.dimSend === 'down') node.dimSend = { decr_incr: 0, data: 3 };
+    if (node.dimSend === 'stop') node.dimSend = { decr_incr: 0, data: 0 };
+
     // Used to call the status update from the config node.
     node.setNodeStatus = ({
       fill, shape, text, payload,
@@ -47,7 +55,6 @@ module.exports = function (RED) {
 
     // This function is called by the knx-ultimate config node, to output a msg.payload.
     node.handleSend = (msg) => {
-      const state = {};
       try {
         switch (msg.knx.destination) {
           case config.GAshort_releaseStatus:
@@ -90,7 +97,7 @@ module.exports = function (RED) {
           switch (_event.button.last_event) {
             case 'initial_press':
               if (node.initial_pressValue === undefined) node.initial_pressValue = false;
-              node.initial_pressValue = config.toggleValues ? !node.initial_pressValue : true;
+              node.initial_pressValue = config.toggleValues ? !node.initial_pressValue : node.switchSend;
               flowMsgPayload = node.initial_pressValue;
               break;
             case 'long_release':
@@ -104,16 +111,16 @@ module.exports = function (RED) {
               break;
             case 'double_short_release':
               if (node.double_short_releaseValue === undefined) node.double_short_releaseValue = false;
-              node.double_short_releaseValue = config.toggleValues ? !node.double_short_releaseValue : true;
+              node.double_short_releaseValue = config.toggleValues ? !node.double_short_releaseValue : node.switchSend;
               flowMsgPayload = node.double_short_releaseValue;
               break;
             case 'long_press':
               if (node.long_pressValue === undefined) node.long_pressValue = false;
-              node.long_pressValue = config.toggleValues ? !node.long_pressValue : true;
+              node.long_pressValue = config.toggleValues ? !node.long_pressValue : node.dimSend;
               flowMsgPayload = node.long_pressValue;
               break;
             case 'short_release':
-              node.short_releaseValue = config.toggleValues ? !node.short_releaseValue : true;
+              node.short_releaseValue = config.toggleValues ? !node.short_releaseValue : node.switchSend;
               flowMsgPayload = node.short_releaseValue;
               if (config.GAshort_release !== undefined && config.GAshort_release !== '') {
                 knxMsgPayload.topic = config.GAshort_release;
@@ -133,13 +140,17 @@ module.exports = function (RED) {
               }
               break;
             case 'repeat':
-              flowMsgPayload = true;
+              flowMsgPayload = node.long_pressValue;
               if (config.GArepeat !== undefined && config.GArepeat !== '') {
                 if (node.isTimerDimStopRunning === false) {
                   // Set KNX Dim up/down start
                   knxMsgPayload.topic = config.GArepeat;
                   knxMsgPayload.dpt = config.dptrepeat;
-                  knxMsgPayload.payload = node.long_pressValue ? { decr_incr: 0, data: 3 } : { decr_incr: 1, data: 3 }; // If the light is turned on, the initial DIM direction must be down, otherwise, up
+                  if (typeof (node.long_pressValue) === 'object') {
+                    knxMsgPayload.payload = node.long_pressValue; // Send fixed value when toggleValues is false
+                  } else {
+                    knxMsgPayload.payload = node.long_pressValue ? { decr_incr: 0, data: 3 } : { decr_incr: 1, data: 3 }; // If the light is turned on, the initial DIM direction must be down, otherwise, up
+                  }
                   // Send to KNX bus
                   if (knxMsgPayload.topic !== '' && knxMsgPayload.topic !== undefined) {
                     node.server.writeQueueAdd({

package/package.json

@@ -3,7 +3,7 @@
   "engines": {
     "node": ">=16.0.0"
   },
-  "version": "2.4.21",
+  "version": "2.4.22",
   "description": "Control your KNX intallation via Node-Red! A bunch of KNX nodes, with integrated Philips HUE control and ETS group address importer. Easy to use and highly configurable.",
   "dependencies": {
     "binary-parser": "2.2.1",

package/.vscode/launch.json

@@ -1,17 +0,0 @@
-{
-    // Usare IntelliSense per informazioni sui possibili attributi.
-    // Al passaggio del mouse vengono visualizzate le descrizioni degli attributi esistenti.
-    // Per altre informazioni, visitare: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "Avvia programma",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            "program": "${workspaceFolder}/nodes/knxUltimateWatchDog.js"
-        }
-    ]
-}