smart-nodes 0.3.37 → 0.4.1

package/forwarder/forwarder.js

@@ -7,40 +7,84 @@ 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");
 
+
+        // #####################
+        // # persistent values #
+        // #####################
         var node_settings = {
             enabled: config.enabled,
             last_message: null,
             last_msg_was_sended: true
         };
 
+        // load or delete saved values
         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
+
+        // ##################
+        // # Dynamic config #
+        // ##################
         let forward_true = config.always_forward_true;
         let forward_false = config.always_forward_false;
         let forward_last_on_enable = config.forward_last_on_enable;
 
-        // runtime values
+
+        // ##################
+        // # Runtime values #
+        // ##################
 
 
+        // ###############
+        // # Node events #
+        // ###############
         node.on("input", function (msg)
         {
+            handleTopic(msg);
+
+            setStatus();
+
+            if (config.save_state)
+                smart_context.set(node.id, node_settings);
+        });
+
+        node.on("close", function ()
+        {
+            if (timeout != null)
+            {
+                clearTimeout(timeout);
+                timeout = null;
+            }
+        });
+
+
+        // #####################
+        // # 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 new_state = null;
-            if (msg.topic == "enable" || (msg.topic == "set_state" && msg.payload))
+            if (real_topic == "enable" || (real_topic == "set_state" && msg.payload))
                 new_state = true;
-            else if (msg.topic == "disable" || (msg.topic == "set_state" && !msg.payload))
+            else if (real_topic == "disable" || (real_topic == "set_state" && !msg.payload))
                 new_state = false;
 
             // Already the correct state
@@ -53,12 +97,9 @@ module.exports = function (RED)
                 case false:
                     node_settings.enabled = new_state;
 
-                    if (config.save_state)
-                        smart_context.set(node.id, node_settings);
-
                     if (node_settings.enabled && forward_last_on_enable && node_settings.last_message != null && !node_settings.last_msg_was_sended)
                     {
-                        node.send(node_settings.last_message);
+                        node.send(helper.cloneObject(node_settings.last_message));
                         node_settings.last_msg_was_sended = true;
                     }
 
@@ -69,7 +110,7 @@ module.exports = function (RED)
                     // Forward if enabled or forced
                     if (node_settings.enabled || (forward_true && msg.payload) || (forward_false && !msg.payload))
                     {
-                        node.send(msg);
+                        node.send(helper.cloneObject(msg));
                         node_settings.last_msg_was_sended = true;
                     }
                     else
@@ -77,10 +118,10 @@ module.exports = function (RED)
                         node_settings.last_msg_was_sended = false;
                     }
 
-                    node_settings.last_message = helper.cloneObject(msg);;
+                    node_settings.last_message = helper.cloneObject(msg);
                     break;
             }
-        });
+        }
 
         let setStatus = () =>
         {
@@ -94,7 +135,7 @@ module.exports = function (RED)
         {
             setTimeout(() =>
             {
-                node.send(node_settings.last_message);
+                node.send(helper.cloneObject(node_settings.last_message));
             }, 10000);
         }
 

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

@@ -0,0 +1,32 @@
+<script type="text/html" data-help-name="smart_forwarder">
+    <p>Diese Node leitet eine Nachricht weiter, wenn er enabled wurde oder das dauerhafte Weiterleiten für die Nachricht aktiviert ist.</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>enable</code></td>
+                    <td>Aktiviert das Weiterleiten.</td>
+                </tr>
+                <tr>
+                    <td><code>disable</code></td>
+                    <td>Deaktiviert das Weiterleiten.</td>
+                </tr>
+                <tr>
+                    <td><code>set_state</code></td>
+                    <td>Aktiviert das Weiterleiten, wenn <code>msg.payload = true</code> oder deaktiviert das Weiterleiten, wenn <code>msg.payload = false</code>.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+</script>

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

@@ -0,0 +1,15 @@
+{
+    "forwarder": {
+        "ui": {
+            "name": "Name",
+            "enabled": "Aktiviert",
+            "forward_last_on_enable": "Letzte nicht gesendete Nachricht senden, wenn die Node aktiviert wird.",
+            "always_forward_true": "Leite <code>msg.payload = true</code> immer weiter.",
+            "always_forward_false": "Leite <code>msg.payload = false</code> immer weiter.",
+
+            "system_start": "Systemstart",
+            "save_state": "Zustand speichern",
+            "send_after_start": "Letze Nachricht 10 Sekunden nach dem Start senden"
+        }
+    }
+}

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

@@ -0,0 +1,32 @@
+<script type="text/html" data-help-name="smart_forwarder">
+    <p>This node forwards a message if it has been enabled or if permanent forwarding is activated for the message.</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>enable</code></td>
+                    <td>Enables forwarding.</td>
+                </tr>
+                <tr>
+                    <td><code>disable</code></td>
+                    <td>Disables forwarding.</td>
+                </tr>
+                <tr>
+                    <td><code>set_state</code></td>
+                    <td>Enables forwarding if <code>msg.payload = true</code> or disables forwarding if <code>msg.payload = false</code>.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+</script>

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

@@ -0,0 +1,15 @@
+{
+    "forwarder": {
+        "ui": {
+            "name": "Name",
+            "enabled": "Enabled",
+            "forward_last_on_enable": "Send last unsent message when node is activated.",
+            "always_forward_true": "Always forward <code>msg.payload = true</code> .",
+            "always_forward_false": "Always forward <code>msg.payload = false</code> .",
+
+            "system_start": "System start",
+            "save_state": "Save state",
+            "send_after_start": "Send last message 10 seconds after the start"
+        }
+    }
+}

package/heating-curve/heating-curve.html

@@ -1,8 +1,6 @@
 <script type="text/javascript">
     (function ()
     {
-        let node;
-
         RED.nodes.registerType("smart_heating-curve", {
             category: "Smart Nodes",
             paletteLabel: "Heating Curve",
@@ -24,7 +22,7 @@
             },
             oneditprepare: function ()
             {
-                node = this;
+                let node = this;
 
                 $("#node-input-room_setpoint")
                     .spinner({
@@ -278,69 +276,30 @@
 
 <script type="text/html" data-template-name="smart_heating-curve">
     <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="heating.ui.name"></span></label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]heating.ui.name" />
     </div>
     <div class="form-row">
-        <label for="node-input-room_setpoint"><i class="fa fa-thermometer-three-quarters"></i> Raum Soll</label>
+        <label for="node-input-room_setpoint"><i class="fa fa-thermometer-three-quarters"></i> <span data-i18n="heating.ui.room_setpoint"></span></label>
         <input id="node-input-room_setpoint" value="0" /> °C [15 - 25]
     </div>
     <div class="form-row">
-        <label for="node-input-slope"><i class="fa fa-expand"></i> Steilheit</label>
+        <label for="node-input-slope"><i class="fa fa-expand"></i> <span data-i18n="heating.ui.slope"></span></label>
         <input id="node-input-slope" value="0" /> [0,05 - 4]
     </div>
     <div class="form-row">
-        <label for="node-input-offset"><i class="fa fa-arrows-v"></i> Verschiebung</label>
+        <label for="node-input-offset"><i class="fa fa-arrows-v"></i> <span data-i18n="heating.ui.offset"></span></label>
         <input id="node-input-offset" value="0" />
     </div>
     <div class="form-row">
-        <label for="node-input-flow_max"><i class="fa fa-arrow-up"></i> Max Soll</label>
-        <input id="node-input-flow_max" value="0" />
+        <label for="node-input-flow_min"><i class="fa fa-arrow-down"></i> <span data-i18n="heating.ui.min_setpoint"></span></label>
+        <input id="node-input-flow_min" value="0" />
     </div>
     <div class="form-row">
-        <label for="node-input-flow_min"><i class="fa fa-arrow-down"></i> Min Soll</label>
-        <input id="node-input-flow_min" value="0" />
+        <label for="node-input-flow_max"><i class="fa fa-arrow-up"></i> <span data-i18n="heating.ui.max_setpoint"></span></label>
+        <input id="node-input-flow_max" value="0" />
     </div>
     <div class="form-row">
         <canvas id="heating-curve-diagram" width="450" height="300"></canvas>
     </div>
-</script>
-
-<script type="text/html" data-help-name="smart_heating-curve">
-    <p>
-        Diese Node berechnet anhand den eingestellten Werten, die Vorlaufsolltemperatur. Diese kann verwendet werden um ein Mischventil anzusteuern.
-    </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>room_setpoint</code></td>
-                    <td>Überschreibt die Raum-Solltemperatur.</td>
-                </tr>
-                <tr>
-                    <td><code>flow_min</code></td>
-                    <td>Überschreibt die minimale Vorlaufsolltemperatur.</td>
-                </tr>
-                <tr>
-                    <td><code>flow_max</code></td>
-                    <td>Überschreibt die maximale Vorlaufsolltemperatur.</td>
-                </tr>
-                <tr>
-                    <td><code>temperature_outside</code></td>
-                    <td>Setzt die aktuelle Außentemperatur.</td>
-                </tr>
-            </tbody>
-        </table>
-    </p>
 </script>

package/heating-curve/heating-curve.js

@@ -7,11 +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");
 
-        // persistent values
-        var node_settings = Object.assign({}, {
+
+        // #####################
+        // # persistent values #
+        // #####################
+        var node_settings = helper.cloneObject({
             room_setpoint: config.room_setpoint,
             flow_min: config.flow_min,
             flow_max: config.flow_max,
@@ -19,17 +30,30 @@ module.exports = function (RED)
             last_flow_temperature: null
         }, smart_context.get(node.id));
 
-        // dynamic config
+
+        // ##################
+        // # Dynamic config #
+        // ##################
         let slope = config.slope;
         let offset = config.offset;
 
-        // runtime values
 
+        // ##################
+        // # Runtime values #
+        // ##################
+
+
+        // ###############
+        // # Node events #
+        // ###############
         node.on("input", function (msg)
         {
             handleTopic(msg);
+
             sendResult();
             setStatus();
+
+            smart_context.set(node.id, node_settings);
         });
 
         node.on("close", function ()
@@ -37,6 +61,11 @@ module.exports = function (RED)
         });
 
 
+        // #####################
+        // # Private functions #
+        // #####################
+
+        // This is the main function which handles all topics that was received.
         let handleTopic = msg =>
         {
             let real_topic = helper.getTopicName(msg.topic);
@@ -46,48 +75,44 @@ module.exports = function (RED)
                     let new_setpoint = parseFloat(msg.payload);
                     if (isNaN(new_setpoint) && !isFinite(new_setpoint))
                     {
-                        // node.error("Invalid payload: " + msg.payload);
+                        // helper.warn(this, "Invalid payload: " + msg.payload);
                         return;
                     }
 
                     node_settings.room_setpoint = msg.payload;
-                    smart_context.set(node.id, node_settings);
                     break;
 
                 case "temperature_outside":
                     let new_temp = parseFloat(msg.payload);
                     if (isNaN(new_temp) && !isFinite(new_temp))
                     {
-                        // node.error("Invalid payload: " + msg.payload);
+                        // helper.warn(this, "Invalid payload: " + msg.payload);
                         return;
                     }
 
                     node_settings.temperature_outside = msg.payload;
-                    smart_context.set(node.id, node_settings);
                     break;
 
                 case "flow_min":
                     let new_flow_min = parseFloat(msg.payload);
                     if (isNaN(new_flow_min) && !isFinite(new_flow_min))
                     {
-                        // node.error("Invalid payload: " + msg.payload);
+                        // helper.warn(this, "Invalid payload: " + msg.payload);
                         return;
                     }
 
                     node_settings.flow_min = msg.payload;
-                    smart_context.set(node.id, node_settings);
                     break;
 
                 case "flow_max":
                     let new_flow_max = parseFloat(msg.payload);
                     if (isNaN(new_flow_max) && !isFinite(new_flow_max))
                     {
-                        // node.error("Invalid payload: " + msg.payload);
+                        // helper.warn(this, "Invalid payload: " + msg.payload);
                         return;
                     }
 
                     node_settings.flow_max = msg.payload;
-                    smart_context.set(node.id, node_settings);
                     break;
 
                 default:
@@ -121,11 +146,11 @@ module.exports = function (RED)
 
         let setStatus = () =>
         {
-            node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Out: " + node_settings.temperature_outside.toFixed(1) + "°C, Flow: " + node_settings.last_flow_temperature?.toFixed(1) + "°C" });
+            node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Out: " + node_settings.temperature_outside?.toFixed(1) + "°C, Flow: " + node_settings.last_flow_temperature?.toFixed(1) + "°C" });
         }
 
         if (node_settings.last_flow_temperature !== null)
-            setTimeout(sendResult, 10 * 1000);
+            setTimeout(sendResult, 10000);
 
         setStatus();
     }

package/heating-curve/locales/de-DE/heating-curve.html

@@ -0,0 +1,38 @@
+<script type="text/html" data-help-name="smart_heating-curve">
+    <p>
+        Diese Node berechnet anhand den eingestellten Werten, die Vorlaufsolltemperatur. Diese kann verwendet werden um ein Mischventil anzusteuern.
+    </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>room_setpoint</code></td>
+                    <td>Überschreibt die Raum-Solltemperatur.</td>
+                </tr>
+                <tr>
+                    <td><code>flow_min</code></td>
+                    <td>Überschreibt die minimale Vorlaufsolltemperatur.</td>
+                </tr>
+                <tr>
+                    <td><code>flow_max</code></td>
+                    <td>Überschreibt die maximale Vorlaufsolltemperatur.</td>
+                </tr>
+                <tr>
+                    <td><code>temperature_outside</code></td>
+                    <td>Setzt die aktuelle Außentemperatur.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+</script>

package/heating-curve/locales/de-DE/heating-curve.json

@@ -0,0 +1,12 @@
+{
+    "heating": {
+        "ui": {
+            "name": "Name",
+            "room_setpoint": "Raum Soll",
+            "slope": "Steilheit",
+            "offset": "Verschiebung",
+            "min_setpoint": "Min Soll",
+            "max_setpoint": "Max Soll"
+        }
+    }
+}

package/heating-curve/locales/en-US/heating-curve.html

@@ -0,0 +1,38 @@
+<script type="text/html" data-help-name="smart_heating-curve">
+    <p>
+        This node calculates the target flow temperature based on the set values. This can be used to control a mixing valve.
+    </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>room_setpoint</code></td>
+                    <td>Overwrites the room setpoint temperature.</td>
+                </tr>
+                <tr>
+                    <td><code>flow_min</code></td>
+                    <td>Overwrites the minimum flow setpoint temperature.</td>
+                </tr>
+                <tr>
+                    <td><code>flow_max</code></td>
+                    <td>Overwrites the maximum flow setpoint temperature.</td>
+                </tr>
+                <tr>
+                    <td><code>temperature_outside</code></td>
+                    <td>Sets the current outside temperature.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+</script>

package/heating-curve/locales/en-US/heating-curve.json

@@ -0,0 +1,12 @@
+{
+    "heating": {
+        "ui": {
+            "name": "Name",
+            "room_setpoint": "Room setpoint",
+            "slope": "Slope",
+            "offset": "Offset",
+            "min_setpoint": "Min setpoint",
+            "max_setpoint": "Max setpoint"
+        }
+    }
+}