smart-nodes 0.3.37 → 0.4.0

package/hysteresis/hysteresis.html

@@ -29,6 +29,8 @@
         },
         oneditprepare: function ()
         {
+            let node = this;
+
             $("#node-input-setpoint").typedInput({
                 type: "num",
                 types: ["num"]
@@ -45,13 +47,13 @@
                 type: "json",
                 types: ["json",
                     {
-                        value: "null",
-                        label: "Nichts senden",
+                        value: "NOTHING",
+                        label: node._("hysteresis.ui.send_nothing"),
                         icon: "fa fa-times",
                         hasValue: false,
                     }, {
-                        value: "original",
-                        label: "Originalnachricht",
+                        value: "ORIGINAL",
+                        label: node._("hysteresis.ui.original_message"),
                         icon: "fa fa-arrow-right",
                         hasValue: false,
                     }
@@ -63,13 +65,13 @@
                 type: "json",
                 types: ["json",
                     {
-                        value: "null",
-                        label: "Nichts senden",
+                        value: "NOTHING",
+                        label: node._("hysteresis.ui.send_nothing"),
                         icon: "fa fa-times",
                         hasValue: false,
                     }, {
-                        value: "original",
-                        label: "Originalnachricht",
+                        value: "ORIGINAL",
+                        label: node._("hysteresis.ui.original_message"),
                         icon: "fa fa-arrow-right",
                         hasValue: false,
                     }
@@ -82,8 +84,8 @@
                 types: [{
                     value: "send_only_change",
                     options: [
-                        { value: "true", label: "Nur bei Änderung" },
-                        { value: "false", label: "Immer" },
+                        { value: "true", label: node._("hysteresis.ui.send_only_change") },
+                        { value: "false", label: node._("hysteresis.ui.always") },
                     ]
                 }]
             });
@@ -93,8 +95,8 @@
                 types: [{
                     value: "outputs",
                     options: [
-                        { value: "1", label: "Gemeinsamer Ausgang" },
-                        { value: "2", label: "Separate Ausgänge" },
+                        { value: "1", label: node._("hysteresis.ui.common_output") },
+                        { value: "2", label: node._("hysteresis.ui.separate_output") },
                     ]
                 }]
             });
@@ -109,9 +111,24 @@
                     $("#resend_on_start_row").hide();
             });
             $("#node-input-save_state").trigger("change");
+
+            // Backward compatibility
+            if (this.out_higher_type == "null")
+            {
+                this.out_higher_type = "NOTHING";
+                $("#node-input-out_higher_type").val("NOTHING");
+            }
+
+            if (this.out_lower_type == "null")
+            {
+                this.out_lower_type = "NOTHING";
+                $("#node-input-out_lower_type").val("NOTHING");
+            }
         },
         oneditsave: function ()
         {
+            let node = this;
+
             this.setpoint = parseFloat(this.setpoint);
             this.hysteresis = parseFloat(this.hysteresis);
         }
@@ -120,88 +137,49 @@
 
 <script type="text/html" data-template-name="smart_hysteresis">
     <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" />
+        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="hysteresis.ui.name"></span></label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]hysteresis.ui.name" />
     </div>
     <div class="form-row">
-        <label for="node-input-setpoint"><i class="fa fa-sign-out"></i> Sollwert</label>
+        <label for="node-input-setpoint"><i class="fa fa-sign-out"></i> <span data-i18n="hysteresis.ui.setpoint"></span></label>
         <input id="node-input-setpoint" />
     </div>
     <div class="form-row">
-        <label for="node-input-hysteresis"><i class="fa fa-sort"></i> Hysterese</label>
+        <label for="node-input-hysteresis"><i class="fa fa-sort"></i> <span data-i18n="hysteresis.ui.hysteresis"></span></label>
         <input id="node-input-hysteresis" />
     </div>
     <hr/>
-    <h4 style="margin: 0.5rem 0;">Ausgangsnachrichten</h4>
+    <h4 style="margin: 0.5rem 0;" data-i18n="hysteresis.ui.output_messages"></h4>
     <div class="form-row">
-        <label for="node-input-out_higher"><i class="fa fa-arrow-up"></i> Über</label>
+        <label for="node-input-out_higher"><i class="fa fa-arrow-up"></i> <span data-i18n="hysteresis.ui.over"></span></label>
         <input type="text" id="node-input-out_higher"/>
         <input type="hidden" id="node-input-out_higher_type">
     </div>
     <div class="form-row">
-        <label for="node-input-out_lower"><i class="fa fa-arrow-down"></i> Unter</label>
+        <label for="node-input-out_lower"><i class="fa fa-arrow-down"></i> <span data-i18n="hysteresis.ui.under"></span></label>
         <input type="text" id="node-input-out_lower" />
         <input type="hidden" id="node-input-out_lower_type">
     </div>
     <div class="form-row">
-        <label for="node-input-send_only_change"><i class="fa fa-repeat"></i> Senden</label>
+        <label for="node-input-send_only_change"><i class="fa fa-repeat"></i> <span data-i18n="hysteresis.ui.send"></span></label>
         <input id="node-input-send_only_change" />
     </div>
     <div class="form-row">
-        <label for="node-input-outputs"><i class="fa fa-hashtag"></i> Ausgänge</label>
+        <label for="node-input-outputs"><i class="fa fa-hashtag"></i> <span data-i18n="hysteresis.ui.outputs"></span></label>
         <input id="node-input-outputs" />
     </div>
     <div class="form-row">
-        <div><strong>Hinweis:</strong></div>
-        <div><code>msg.payload</code> wird automatisch auf das Hystere-Ergebnis gesetzt,</div>
-        <div>sofern es nicht bereits hier in der Konfiguration gesetzt wurde.</div>
-        <div><code>true</code>, wenn höher, <code>false</code> wenn niedriger.</div>
+        <div><strong data-i18n="hysteresis.ui.note"></strong></div>
+        <div data-i18n="[html]hysteresis.ui.note_text"></div>
     </div>
     <hr/>
-    <h4 style="margin: 0.5rem 0;">Systemstart</h4>
+    <h4 style="margin: 0.5rem 0;" data-i18n="hysteresis.ui.system_start"></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>
+        <label for="node-input-save_state" style="width: calc(100% - 30px);" data-i18n="hysteresis.ui.save_state"></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>
+        <label for="node-input-resend_on_start" style="width: calc(100% - 30px);" data-i18n="hysteresis.ui.send_after_start"></label>
     </div>
-</script>
-
-<script type="text/html" data-help-name="smart_hysteresis">
-    <p>
-        Diese Node sendet die einkommende Nachricht an den Ausgang <code>Über</code>, wenn der einkommende Wert größer gleich dem Sollwert plus Hysterese ist und
-        die einkommende Nachricht an den Ausgang <code>Unter</code>, wenn der einkommende Wert kleiner gleich dem Sollwert minus Hysterese ist.<br/>
-        Die Nachricht wird dabei nur einmalig bei über- bzw. unterschreiten des Grenzwertes weitergeleitet.<br/>
-        Die Note behält den aktuellen Zustand auch nach dem Deploy bei.
-    </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>setpoint</code></td>
-                    <td>Überschreibt den Sollwert mit <code>msg.payload</code>.</td>
-                </tr>
-                <tr>
-                    <td><code>hysteresis</code></td>
-                    <td>Überschreibt die Hysterese mit <code>msg.payload</code>.</td>
-                </tr>
-            </tbody>
-        </table>
-    </p>
-    <p>
-        Die einkommende Nachricht wird mit den angegebenen Ausgangsnachrichten ergänzt, sofern nicht Originalnachricht ausgewählt wurde.
-    </p>
 </script>

package/hysteresis/hysteresis.js

@@ -7,10 +7,22 @@ module.exports = function (RED)
         const node = this;
         RED.nodes.createNode(node, config);
 
+
+        // ###################
+        // # Class constants #
+        // ###################
+
+
+        // #######################
+        // # Global help objects #
+        // #######################
         const smart_context = require("../persistence.js")(RED);
         const helper = require("../smart_helper.js");
 
-        // persistant values
+
+        // #####################
+        // # persistent values #
+        // #####################
         var node_settings = {
             last_value: null,
             last_result: null,
@@ -46,22 +58,52 @@ module.exports = function (RED)
             smart_context.del(node.id);
         }
 
-        // dynamic config
+
+        // ##################
+        // # Dynamic config #
+        // ##################
         let out_higher = helper.evaluateNodeProperty(RED, config.out_higher, config.out_higher_type);
         let out_lower = helper.evaluateNodeProperty(RED, config.out_lower, config.out_lower_type);
         let send_only_change = helper.evaluateNodeProperty(RED, config.send_only_change, "bool");
         let outputs = helper.evaluateNodeProperty(RED, config.outputs, "num");
 
-        // runtime values
 
+        // ##################
+        // # Runtime values #
+        // ##################
+
+
+        // ###############
+        // # Node events #
+        // ###############
         node.on("input", function (msg)
         {
-            let value = parseFloat(msg.payload);
+            handleTopic(msg);
+
+            setStatus();
+
+            if (config.save_state)
+                smart_context.set(node.id, node_settings);
+        });
+
+        node.on("close", function ()
+        {
+        });
+
+
+        // #####################
+        // # Private functions #
+        // #####################
+
+        // This is the main function which handles all topics that was received.
+        let handleTopic = msg =>
+        {
             let real_topic = helper.getTopicName(msg.topic);
+            let value = parseFloat(msg.payload);
 
             if (isNaN(value))
             {
-                // node.error("Invalid payload: " + msg.payload);
+                console.warn("Invalid payload: " + msg.payload);
                 return;
             }
 
@@ -69,67 +111,51 @@ module.exports = function (RED)
             {
                 case "setpoint":
                     node_settings.setpoint = value;
-                    node.status({ fill: node_settings.last_result ? "green" : "red", shape: "ring", text: helper.getCurrentTimeForStatus() + ": New setpoint: " + value + "" });
-
-                    if (config.save_state)
-                        smart_context.set(node.id, node_settings);
                     break;
 
                 case "hysteresis":
                     node_settings.hysteresis = value;
-                    node.status({ fill: node_settings.last_result ? "green" : "red", shape: "ring", text: helper.getCurrentTimeForStatus() + ": New hysteresis: " + value + "" });
-
-                    if (config.save_state)
-                        smart_context.set(node.id, node_settings);
                     break;
 
                 default:
-                    let result = getResult(value);
-                    let out_msg = null;
-
-                    // No change, nothing to send
-                    if (result !== null)
-                    {
-                        // Get custom output message
-                        if (result)
-                            out_msg = createMessage(out_higher, config.out_higher_type, msg, value);
-                        else
-                            out_msg = createMessage(out_lower, config.out_lower_type, msg, value);
-
-                        // Overwrite automatic values, if not already defined
-                        if (typeof out_msg.payload === "undefined")
-                            out_msg.payload = result ?? node_settings.last_result;
-
-                        // Separate outputs if needed
-                        if (outputs == 2)
-                        {
-                            if (result)
-                                out_msg = [out_msg, null];
-                            else
-                                out_msg = [null, out_msg];
-                        }
-
-                        // Send only if needed
-                        if (send_only_change == false || node_settings.last_result != result)
-                            node.send(out_msg);
-
-                        node_settings.last_result = result;
-                        node_settings.last_message = out_msg;
-                    }
-
-                    node_settings.last_value = value;
-
-                    setStatus(result === null);
-
-                    if (config.save_state)
-                        smart_context.set(node.id, node_settings);
+                    node_settings.last_value = value
                     break;
             }
-        });
 
-        node.on("close", function ()
-        {
-        });
+            // Always calculate new result
+            let result = getResult(node_settings.last_value);
+            let out_msg = null;
+
+            // No change, nothing to send
+            if (result === null)
+                return;
+
+            // Get custom output message
+            if (result)
+                out_msg = createMessage(out_higher, config.out_higher_type, msg, node_settings.last_value);
+            else
+                out_msg = createMessage(out_lower, config.out_lower_type, msg, node_settings.last_value);
+
+            // Overwrite automatic values, if not already defined
+            if (typeof out_msg.payload === "undefined")
+                out_msg.payload = result ?? node_settings.last_result;
+
+            // Separate outputs if needed
+            if (outputs == 2)
+            {
+                if (result)
+                    out_msg = [out_msg, null];
+                else
+                    out_msg = [null, out_msg];
+            }
+
+            // Send only if needed
+            if (send_only_change == false || node_settings.last_result != result)
+                node.send(out_msg);
+
+            node_settings.last_result = result;
+            node_settings.last_message = out_msg;
+        }
 
         let getResult = value =>
         {
@@ -145,19 +171,17 @@ module.exports = function (RED)
             return node_settings.last_result;
         }
 
-        let setStatus = noChange =>
+        let setStatus = () =>
         {
-            if (noChange)
-                node.status({ fill: node_settings.last_result ? "green" : "red", shape: "ring", text: helper.getCurrentTimeForStatus() + ": No change by value " + node_settings.last_value + "" });
-            else if (node_settings.last_result === true)
-                node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Turned higher by value " + node_settings.last_value + "" });
-            else if (node_settings.last_result === false)
-                node.status({ fill: "red", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Turned lower by value " + node_settings.last_value + "" });
+            if (node_settings.last_result == null)
+                node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": ❓ S: " + node_settings.setpoint + " - H: " + node_settings.hysteresis + " - V: null" });
+            else
+                node.status({ fill: node_settings.last_result ? "green" : "red", shape: "dot", text: helper.getCurrentTimeForStatus() + ": " + (node_settings.last_result ? "⬆️" : "⬇️") + " S: " + node_settings.setpoint + " - H: " + node_settings.hysteresis + " - V: " + node_settings.last_value.toFixed(2) });
         }
 
         let createMessage = (out_msg, out_type, msg, value) =>
         {
-            return Object.assign({}, out_type == "original" ? msg : out_msg, {
+            return helper.cloneObject(out_type == "ORIGINAL" ? msg : out_msg, {
                 smart_info: {
                     last_result: node_settings.last_result,
                     hysteresis: node_settings.hysteresis,
@@ -165,7 +189,7 @@ module.exports = function (RED)
                     last_value: node_settings.last_value,
                     value: value
                 }
-            })
+            });
         };
 
         if (config.save_state && config.resend_on_start && node_settings.last_result !== null && node_settings.last_message !== null)
@@ -175,16 +199,18 @@ module.exports = function (RED)
                 if (outputs == 2)
                 {
                     if (node_settings.last_result)
-                        node.send([node_settings.last_message, null]);
+                        node.send([helper.cloneObject(node_settings.last_message), null]);
                     else
-                        node.send([null, node_settings.last_message]);
+                        node.send([null, helper.cloneObject(node_settings.last_message)]);
                 }
                 else
                 {
-                    node.send(node_settings.last_message);
+                    node.send(helper.cloneObject(node_settings.last_message));
                 }
             }, 10000);
         }
+
+        setStatus();
     }
 
     RED.nodes.registerType("smart_hysteresis", HysteresisNode);

package/hysteresis/locales/de-DE/hysteresis.html

@@ -0,0 +1,36 @@
+<script type="text/html" data-help-name="smart_hysteresis">
+    <p>
+        Diese Node sendet die einkommende Nachricht an den Ausgang <code>Über</code>, wenn der einkommende Wert größer gleich dem Sollwert plus Hysterese ist und
+        die einkommende Nachricht an den Ausgang <code>Unter</code>, wenn der einkommende Wert kleiner gleich dem Sollwert minus Hysterese ist.<br/>
+        Die Nachricht wird dabei nur einmalig bei über- bzw. unterschreiten des Grenzwertes weitergeleitet.<br/>
+        Die Node behält den aktuellen Zustand auch nach dem Deploy bei.
+    </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>setpoint</code></td>
+                    <td>Überschreibt den Sollwert mit <code>msg.payload</code>.</td>
+                </tr>
+                <tr>
+                    <td><code>hysteresis</code></td>
+                    <td>Überschreibt die Hysterese mit <code>msg.payload</code>.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+    <p>
+        Die einkommende Nachricht wird mit den angegebenen Ausgangsnachrichten ergänzt, sofern nicht Originalnachricht ausgewählt wurde.
+    </p>
+</script>

package/hysteresis/locales/de-DE/hysteresis.json

@@ -0,0 +1,27 @@
+{
+    "hysteresis": {
+        "ui": {
+            "name": "Name",
+            "setpoint": "Sollwert",
+            "hysteresis": "Hysterese",
+            "output_messages": "Ausgangsnachrichten",
+            "over": "Über",
+            "under": "Unter",
+            "send": "Senden",
+            "outputs": "Ausgänge",
+
+            "note": "Hinweis:",
+            "note_text": "<code>msg.payload</code> wird automatisch auf das Hystere-Ergebnis gesetzt,<br/>sofern es nicht bereits hier in der Konfiguration gesetzt wurde.<br/><code>true</code> wenn höher, <code>false</code> wenn niedriger",
+            "system_start": "Systemstart",
+            "save_state": "Zustand speichern",
+            "send_after_start": "Letze Nachricht 10 Sekunden nach dem Start senden",
+
+            "send_nothing": "Nichts senden",
+            "original_message": "Originalnachricht",
+            "send_only_change": "Nur bei Änderung",
+            "always": "Immer",
+            "common_output": "Gemeinsamer Ausgang",
+            "separate_output": "Separate Ausgänge"
+        }
+    }
+}

package/hysteresis/locales/en-US/hysteresis.html

@@ -0,0 +1,36 @@
+<script type="text/html" data-help-name="smart_hysteresis">
+    <p>
+        This node sends the incoming message to the output <code>Over</code> if the incoming value is greater than or equal to the setpoint plus hysteresis and
+        the incoming message to the output <code>Under</code> if the incoming value is less than or equal to the setpoint minus hysteresis.<br />
+        The message is only forwarded once when the limit is exceeded or not reached.<br />
+        The node retains the current state even after deployment.
+    </p>
+    <p>
+        <b>Note:</b> Smart nodes use topics in the format <code>name#number</code>, so that different smart nodes can be controlled with the same topic.<br />
+        This node only uses the part <code>name</code>. <code>#</code> and <code>number</code> are optional.
+    </p>
+    <p>
+        The following topics are accepted:
+        <table>
+            <thead>
+                <tr>
+                    <th>Topic</th>
+                    <th>Description</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td><code>setpoint</code></td>
+                    <td>Overwrites the setpoint with <code>msg.payload</code>.</td>
+                </tr>
+                <tr>
+                    <td><code>hysteresis</code></td>
+                    <td>Overwrites the hysteresis with <code>msg.payload</code>.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+    <p>
+        The incoming message is supplemented with the specified outgoing messages, unless the original message was selected.
+    </p>
+</script>

package/hysteresis/locales/en-US/hysteresis.json

@@ -0,0 +1,27 @@
+{
+    "hysteresis": {
+        "ui": {
+            "name": "Name",
+            "setpoint": "Setpoint",
+            "hysteresis": "Hysteresis",
+            "output_messages": "Output messages",
+            "over": "Over",
+            "under": "Under",
+            "send": "Send",
+            "outputs": "Outputs",
+
+            "note": "Note:",
+            "note_text": "<code>msg.payload</code> is automatically set to the hysteresis result,<br/>if it has not already been set here in the configuration.<br/><code>true</code> if higher, <code>false</code> if lower",
+            "system_start": "System start",
+            "save_state": "Save state",
+            "send_after_start": "Send last message 10 seconds after start",
+
+            "send_nothing": "Send nothing",
+            "original_message": "Original message",
+            "send_only_change": "Only when changed",
+            "always": "Always",
+            "common_output": "Common output",
+            "separate_output": "Separate outputs"
+        }
+    }
+}