smart-nodes 0.3.22 → 0.3.26

package/LICENSE.md

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 
-Copyright (c) 2023 Samuel Bergen
+Copyright (c) 2024 BergenSoft
 
 > Permission is hereby granted, free of charge, to any person obtaining a copy
 > of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,7 +1,7 @@
 # General information
 
 The smart nodes was created to control smart home devices like lights, power outlets shutter and some more.
-This controls are designed to work with the [node-red-contrib-knx-ultimate](https://github.com/Supergiovane/node-red-contrib-knx-ultimate) but it could also work with other smart technologies.
+This nodes are designed to work with the [node-red-contrib-knx-ultimate](https://github.com/Supergiovane/node-red-contrib-knx-ultimate) but it could also work with other smart technologies.
 
 The knx binary input and output/switching modules should be configured very stupid. Closing a binary input should output 1 and releasing 0.
 Same for the output/switching modules, 1 should turn on and 0 turn out. That makes it easy to count the presses or check for short and long presses.
@@ -62,8 +62,8 @@ This node can control multiple light/scene controls or shutter controls at the s
 
 ## 5. Long press control
 
-This control is used to detect a short or a long press.
-The time can be configured in this control.
+This node is used to detect a short or a long press.
+The time can be configured in this node.
 
 ### **Features:**
 
@@ -71,8 +71,8 @@ The time can be configured in this control.
 
 ## 6. Multi press control
 
-This control is used to detect multiple presses on a button.
-The max wait time between presses can be configured in this control.
+This node is used to detect multiple presses on a button.
+The max wait time between presses can be configured in this node.
 You can also choose 2-4 press detection.
 
 ### **Features:**
@@ -81,7 +81,7 @@ You can also choose 2-4 press detection.
 
 ## 7. Hysteresis
 
-This control is checking if the input value reachs a defined value until the upper message is send. When the lower level is reached, the lower masssage will be send
+This node is checking if the input value reachs a defined value until the upper message is send. When the lower level is reached, the lower masssage will be send
 
 ### **Features:**
 
@@ -90,7 +90,7 @@ This control is checking if the input value reachs a defined value until the upp
 
 ## 8. Logic
 
-This control can be used for AND, OR and XOR logics.
+This node can be used for AND, OR and XOR logics.
 
 ### **Features:**
 
@@ -102,7 +102,7 @@ This control can be used for AND, OR and XOR logics.
 
 ## 9. Statistic
 
-This control can be used for getting the following types of values: Minimum, Maximum, Sum, Difference, Absolute Value, Absolute Difference, Average and Running average.
+This node can be used for getting the following types of values: Minimum, Maximum, Sum, Difference, Absolute Value, Absolute Difference, Average and Running average.
 
 ### **Features:**
 
@@ -113,7 +113,7 @@ This control can be used for getting the following types of values: Minimum, Max
 
 ## 10. Compare
 
-This control can compare 2 values with the following operators: < <= == >= > !=
+This node can compare 2 values with the following operators: < <= == >= > !=
 
 ### **Features:**
 
@@ -123,7 +123,7 @@ This control can compare 2 values with the following operators: < <= == >= > !=
 
 ## 11. Delay
 
-This control can delay incomming messages.
+This node can delay incomming messages.
 
 ### **Features:**
 
@@ -134,7 +134,7 @@ This control can delay incomming messages.
 
 ## 12. Forwarder
 
-This control can control if an incomming message should be forwarded or not.
+This node can control if an incomming message should be forwarded or not.
 
 ### **Features:**
 
@@ -144,7 +144,7 @@ This control can control if an incomming message should be forwarded or not.
 
 ## 13. Scheduler
 
-This control can send a defined message on defined times.
+This node can send a defined message on defined times.
 
 ### **Features:**
 
@@ -156,20 +156,50 @@ This control can send a defined message on defined times.
 
 ## 14. Text execution
 
-This control parses a text and performs actions to the selected and matching smart nodes
+This node parses a text and performs actions to the selected and matching smart nodes
 
 ### **Features:**
 
--   Control light and scenes (only on or off) in german and english
--   Control shutter in german and english
+-   Control light and scenes (only on or off) in german and english.
+-   Control shutter in german and english.
 
 ### Examples
 
 [ text ] is optional
 
--   Turn on [the light in] the living room and the kitchen off
--   Open [the shutter in] the kitchen and turn studio off
--   Close [the shutter in the] sleeping room
--   Living room to 10 %
--   Turn on living room except the couch light
--   Sends debug message to output
+-   Turn on [the light in] the living room and the kitchen off.
+-   Open [the shutter in] the kitchen and turn studio off.
+-   Close [the shutter in the] sleeping room.
+-   Living room to 10 %.
+-   Turn on living room except the couch light.
+-   Sends debug message to output.
+
+## 15. Mixing valve
+
+This node can control a mixing valve to get the required tput temperature. It is working for heating and cooling.
+
+### **Features:**
+
+-   Define target temperature.
+-   Support heating and cooling.
+-   Define off mode to do nothing, open or close the valve.
+
+## 16. Heating curve
+
+This node calculates the needed flow temperature regarding to the target room temperature and the current outside temperature.
+
+### **Features:**
+
+-   Define slope and offset values.
+-   Limit flow temperature with min and max values.
+-   Preview of different curves in the node editor.
+
+## 17. Counter
+
+This node countes up and down within a specified range.
+
+### **Features:**
+
+-   Define min, max and step values.
+-   Set to a specific value
+-   Increment and decrement by default or by a given value.

package/central/central.js

@@ -1,5 +1,7 @@
 module.exports = function (RED)
 {
+    "use strict";
+
     function CentralControlNode(config)
     {
         const node = this;
@@ -33,7 +35,7 @@ module.exports = function (RED)
         node.on("input", function (msg)
         {
             // copy message, so original message stays unchanged
-            let newMsg = Object.assign({}, msg);
+            let new_msg = Object.assign({}, msg);
 
             // make connected nodes behavior homogenous
             switch (config.mode)
@@ -42,16 +44,16 @@ module.exports = function (RED)
                     if (msg.topic == "up_stop")
                     {
                         if (isAllOff())
-                            newMsg.topic = "up";
+                            new_msg.topic = "up";
                         else
-                            newMsg.topic = "stop";
+                            new_msg.topic = "stop";
                     }
                     else if (msg.topic == "down_stop")
                     {
                         if (isAllOff())
-                            newMsg.topic = "down";
+                            new_msg.topic = "down";
                         else
-                            newMsg.topic = "stop";
+                            new_msg.topic = "stop";
                     }
                     break;
 
@@ -59,9 +61,9 @@ module.exports = function (RED)
                     if (msg.topic == "toggle")
                     {
                         if (isAllOff())
-                            newMsg.topic = "on";
+                            new_msg.topic = "on";
                         else
-                            newMsg.topic = "off";
+                            new_msg.topic = "off";
                     }
                     break;
             }
@@ -71,7 +73,7 @@ module.exports = function (RED)
             {
                 // console.log(node.id + " -> " + link);
                 // console.log(newMsg);
-                RED.events.emit("node:" + link, newMsg);
+                RED.events.emit("node:" + link, new_msg);
             });
         });
 

package/compare/compare.html

@@ -3,6 +3,7 @@
         category: "Smart Nodes",
         paletteLabel: "Compare",
         color: "#E2D96E",
+        color: "#E2D96E",
         defaults: {
             name: { value: "" },
             comparator: { value: "EQUAL" }, // EQUAL, GREATER, GREATER_EQUAL, SMALLER, SMALLER_EQUAL, UNEQUAL
@@ -10,6 +11,10 @@
             value1_type: { value: "null" },
             value2: { value: "" },
             value2_type: { value: "null" },
+            out_false: { value: '{"topic": ""}' },
+            out_false_type: { value: 'json' },
+            out_true: { value: '{"topic": ""}' },
+            out_true_type: { value: 'json' },
             save_state: { value: true },
             resend_on_start: { value: true }
         },
@@ -60,6 +65,28 @@
                 typeField: "#node-input-value2_type"
             });
 
+            $("#node-input-out_true").typedInput({
+                type: "json",
+                types: ["json", {
+                    value: "null",
+                    label: "Nichts senden",
+                    icon: "fa fa-times",
+                    hasValue: false,
+                }],
+                typeField: "#node-input-out_true_type"
+            });
+
+            $("#node-input-out_false").typedInput({
+                type: "json",
+                types: ["json", {
+                    value: "null",
+                    label: "Nichts senden",
+                    icon: "fa fa-times",
+                    hasValue: false,
+                }],
+                typeField: "#node-input-out_false_type"
+            });
+
             $("#node-input-save_state").on("change", ev =>
             {
                 if (ev.target.checked)
@@ -95,6 +122,27 @@
         <input type="hidden" id="node-input-value2_type">
     </div>
     <hr/>
+    <h4 style="margin: 0.5rem 0;">Ausgangsnachrichten</h4>
+    <div class="form-row">
+        <label for="node-input-out_true"><i class="fa fa-check-circle"></i> Wahr</label>
+        <input type="text" id="node-input-out_true"/>
+        <input type="hidden" id="node-input-out_true_type">
+    </div>
+    <div class="form-row">
+        <label for="node-input-out_false"><i class="fa fa-times-circle"></i> Falsch</label>
+        <input type="text" id="node-input-out_false" />
+        <input type="hidden" id="node-input-out_false_type">
+    </div>
+    <div class="form-row">
+        <span><strong>Hinweis:</strong></span>
+    </div>
+    <div class="form-row">
+        <span>
+            <code>msg.payload</code> wird automatisch auf das Logik-Ergebnis gesetzt.<br/>
+            <code>msg.comperator</code> wird automatisch auf den Logik-Operator gesetzt.
+        </span>
+    </div>
+    <hr/>
     <h4 style="margin: 0.5rem 0;">Systemstart</h4>
     <div class="form-row">
         <input type="checkbox" id="node-input-save_state" style="width: 20px;" />

package/compare/compare.js

@@ -1,34 +1,38 @@
 module.exports = function (RED)
 {
+    "use strict";
+
     function CompareNode(config)
     {
         const node = this;
         RED.nodes.createNode(node, config);
 
-        const smartContext = require("../persistence.js")(RED);
+        const smart_context = require("../persistence.js")(RED);
         const helper = require("../smart_helper.js");
 
-        var nodeSettings = {
+        var node_settings = {
             values: [
                 helper.evaluateNodeProperty(RED, config.value1, config.value1_type),
                 helper.evaluateNodeProperty(RED, config.value2, config.value2_type)
             ],
-            lastResult: null,
+            last_message: null,
         };
 
         if (config.save_state)
         {
             // load old saved values
-            nodeSettings = Object.assign(nodeSettings, smartContext.get(node.id));
+            node_settings = Object.assign(node_settings, smart_context.get(node.id));
         }
         else
         {
             // delete old saved values
-            smartContext.del(node.id);
+            smart_context.del(node.id);
         }
 
         // dynamic config
         let comparator = config.comparator;
+        let out_true = helper.evaluateNodeProperty(RED, config.out_true, config.out_true_type);
+        let out_false = helper.evaluateNodeProperty(RED, config.out_false, config.out_false_type);
 
         // runtime values
 
@@ -51,47 +55,59 @@ module.exports = function (RED)
             }
 
             // Save new value
-            nodeSettings.values[input - 1] = num;
+            node_settings.values[input - 1] = num;
 
             let result = getResult();
             setStatus(result);
 
             if (result != null)
             {
-                nodeSettings.lastResult = result;
+                let msg = result ? out_true : out_false;
+
+                if (msg != null)
+                {
+                    msg = Object.assign(
+                        {},
+                        msg,
+                        { payload: result, comparator: comparator }
+                    );
+                }
+
+                node_settings.last_message = msg;
 
                 if (config.save_state)
-                    smartContext.set(node.id, nodeSettings);
+                    smart_context.set(node.id, node_settings);
 
-                node.send({ payload: result, comparator: comparator });
+                if (msg != null)
+                    node.send(msg);
             }
         });
 
         let getResult = () =>
         {
             // Wait until both values are set
-            if (nodeSettings.values[0] == null || nodeSettings.values[1] == null)
+            if (node_settings.values[0] == null || node_settings.values[1] == null)
                 return null;
 
             switch (comparator)
             {
                 case "SMALLER":
-                    return nodeSettings.values[0] < nodeSettings.values[1];
+                    return node_settings.values[0] < node_settings.values[1];
 
                 case "SMALLER_EQUAL":
-                    return nodeSettings.values[0] <= nodeSettings.values[1];
+                    return node_settings.values[0] <= node_settings.values[1];
 
                 case "EQUAL":
-                    return nodeSettings.values[0] === nodeSettings.values[1];
+                    return node_settings.values[0] === node_settings.values[1];
 
                 case "UNEQUAL":
-                    return nodeSettings.values[0] !== nodeSettings.values[1];
+                    return node_settings.values[0] !== node_settings.values[1];
 
                 case "GREATER_EQUAL":
-                    return nodeSettings.values[0] >= nodeSettings.values[1];
+                    return node_settings.values[0] >= node_settings.values[1];
 
                 case "GREATER":
-                    return nodeSettings.values[0] > nodeSettings.values[1];
+                    return node_settings.values[0] > node_settings.values[1];
             }
 
             return null;
@@ -129,22 +145,22 @@ module.exports = function (RED)
             if (result == null)
                 node.status({});
             else
-                node.status({ fill: "yellow", shape: "ring", text: (new Date()).toLocaleString() + ": " + nodeSettings.values.join(" " + getComparatorSign() + " ") + " => " + result });
+                node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": " + node_settings.values.join(" " + getComparatorSign() + " ") + " => " + result });
         }
 
         node.on("close", function ()
         {
         });
 
-        if (config.save_state && config.resend_on_start && nodeSettings.lastResult != null)
+        if (config.save_state && config.resend_on_start && node_settings.last_message != null)
         {
             setTimeout(() =>
             {
-                node.send({ payload: nodeSettings.lastResult, comparator: comparator });
+                node.send(node_settings.last_message);
             }, 10000);
         }
 
-        setStatus(nodeSettings.lastResult);
+        setStatus(node_settings.last_message?.payload);
     }
 
     RED.nodes.registerType("smart_compare", CompareNode);

package/counter/counter.html

@@ -0,0 +1,104 @@
+<script type="text/javascript">
+    RED.nodes.registerType("smart_counter", {
+        category: "Smart Nodes",
+        paletteLabel: "Counter",
+        color: "#6EE2D9",
+        defaults: {
+            name: { value: "" },
+            start: { value: 0 },
+            step: { value: 1 },
+            min: { value: 0 },
+            max: { value: 10 },
+            save_state: { value: true },
+            resend_on_start: { value: true }
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: "smart_counter.png",
+        label: function ()
+        {
+            return this.name || "Counter";
+        },
+        oneditprepare: function ()
+        {
+            $("#node-input-save_state").on("change", ev =>
+            {
+                if (ev.target.checked)
+                    $("#resend_on_start_row").show();
+                else
+                    $("#resend_on_start_row").hide();
+            });
+            $("#node-input-save_state").trigger("change");
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="smart_counter">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-start"><i class="fa fa-cog"></i> Start</label>
+        <input type="number" id="node-input-start" placeholder="Startwert">
+    </div>
+    <div class="form-row">
+        <label for="node-input-step"><i class="fa fa-forward"></i> Schritt</label>
+        <input type="number" id="node-input-step" placeholder="Schrittweite">
+    </div>
+    <div class="form-row">
+        <label for="node-input-min"><i class="fa fa-arrow-down"></i> Min</label>
+        <input type="number" id="node-input-min" placeholder="Min">
+    </div>
+    <div class="form-row">
+        <label for="node-input-max"><i class="fa fa-arrow-up"></i> Max</label>
+        <input type="number" id="node-input-max" placeholder="Max">
+    </div>
+    <hr/>
+    <h4 style="margin: 0.5rem 0;">Systemstart</h4>
+    <div class="form-row">
+        <input type="checkbox" id="node-input-save_state" style="width: 20px;" />
+        <label for="node-input-save_state" style="width: calc(100% - 30px);">Zustand speichern</label>
+    </div>
+    <div class="form-row" id="resend_on_start_row">
+        <input type="checkbox" id="node-input-resend_on_start" style="width: 20px;" />
+        <label for="node-input-resend_on_start" style="width: calc(100% - 30px);">Letze Nachricht 10 Sekunden nach dem Start senden</label>
+    </div>
+</script>
+
+<script type="text/html" data-help-name="smart_counter">
+    <p>Diese Node kann verwendet werden um nach oben oder unten zu zählen.</p>
+    <p>
+        Die Standardschrittweite kann vorgegeben oder durch einkommende Nachrichten temporär überschrieben werden.
+        Es sind auch Kommazahlen möglich.
+    </p>
+    <p>
+        <b>Hinweis:</b> Smart Nodes verwenden Topics im Format <code>name#nummer</code>, damit können verschiedene Smart Nodes mit dem gleichen Topic angesteuert werden.<br/>
+        Diese Node verwendet nur den Teil <code>name</code>. <code>#</code> und <code>nummer</code> sind dabei optional.
+    </p>
+    <p>
+        Folgende topics werden akzeptiert:
+        <table>
+            <thead>
+                <tr>
+                    <th>Topic</th>
+                    <th>Beschreibung</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td><code>up</code></td>
+                    <td>Erhöht den Wert um <code>msg.payload</code> oder falls nicht gesetzt (oder <code>null</code>) um die konfigurierte Schrittweite. Der neue Wert ist dabei immer innerhalb der Min- und Max-Werte.</td>
+                </tr>
+                <tr>
+                    <td><code>down</code></td>
+                    <td>Verringert den Wert um <code>msg.payload</code> oder falls nicht gesetzt (oder <code>null</code>) um die konfigurierte Schrittweite. Der neue Wert ist dabei immer innerhalb der Min- und Max-Werte.</td>
+                </tr>
+                <tr>
+                    <td><code>reset</code></td>
+                    <td>Setzt den Wert auf <code>msg.payload</code> oder falls nicht gesetzt (oder <code>null</code>) auf den Startwert zurück. Der neue Wert ist dabei immer innerhalb der Min- und Max-Werte.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+</script>

package/counter/counter.js

@@ -0,0 +1,120 @@
+module.exports = function (RED)
+{
+    "use strict";
+
+    function CounterNode(config)
+    {
+        const node = this;
+        RED.nodes.createNode(node, config);
+
+        const smart_context = require("../persistence.js")(RED);
+        const helper = require("../smart_helper.js");
+
+        var node_settings = {
+            value: null,
+            last_message: null,
+        };
+
+        if (config.save_state)
+        {
+            // load old saved values
+            node_settings = Object.assign(node_settings, smart_context.get(node.id));
+        }
+        else
+        {
+            // delete old saved values
+            smart_context.del(node.id);
+        }
+
+        // dynamic config
+        let start = config.start;
+        let step = config.step;
+        let min = config.min;
+        let max = config.max;
+
+        // runtime values
+
+        node.on("input", function (msg)
+        {
+            handleTopic(msg);
+            sendResult();
+            setStatus();
+        });
+
+        let handleTopic = msg =>
+        {
+            let real_topic = helper.getTopicName(msg.topic);
+            let temp_value;
+            switch (real_topic)
+            {
+                case "up":
+                    temp_value = parseFloat(msg.payload);
+                    if (isNaN(temp_value) && !isFinite(temp_value))
+                        temp_value = step;
+
+                    node_settings.value += temp_value;
+                    break;
+
+                case "down":
+                    temp_value = parseFloat(msg.payload);
+                    if (isNaN(temp_value) && !isFinite(temp_value))
+                        temp_value = step;
+
+                    node_settings.value -= temp_value;
+                    break;
+
+                case "reset":
+                    temp_value = parseFloat(msg.payload);
+                    if (isNaN(temp_value) && !isFinite(temp_value))
+                        temp_value = start;
+
+                    node_settings.value = temp_value;
+                    break;
+
+                default:
+                    node.error("Invalid topic: " + real_topic);
+                    return;
+            }
+
+            // Check value is in range
+            node_settings.value = Math.min(max, Math.max(min, node_settings.value));
+        }
+
+        let sendResult = () =>
+        {
+            // Nothing changed, nothing to do
+            if (node_settings.value == node_settings.last_message?.payload)
+                return;
+
+            node_settings.last_message = { payload: node_settings.value };
+            smart_context.set(node.id, node_settings);
+
+            node.send(node_settings.last_message);
+        }
+
+        node.on("close", function ()
+        {
+        });
+
+        // updates the status
+        let setStatus = () =>
+        {
+            if (node_settings.value == null)
+                node.status({});
+            else
+                node.status({ fill: "yellow", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Value = " + node_settings.value });
+        }
+
+        if (config.save_state && config.resend_on_start && node_settings.last_message != null)
+        {
+            setTimeout(() =>
+            {
+                node.send(node_settings.last_message);
+            }, 10000);
+        }
+
+        setStatus();
+    }
+
+    RED.nodes.registerType("smart_counter", CounterNode);
+}