smart-nodes 0.3.36 → 0.4.0

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);
+                        console.warn("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);
+                        console.warn("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);
+                        console.warn("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);
+                        console.warn("Invalid payload: " + msg.payload);
                         return;
                     }
 
                     node_settings.flow_max = msg.payload;
-                    smart_context.set(node.id, node_settings);
                     break;
 
                 default:
@@ -125,7 +150,7 @@ module.exports = function (RED)
         }
 
         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"
+        }
+    }
+}

package/hysteresis/hysteresis.html

@@ -29,6 +29,8 @@
         },
         oneditprepare: function ()
         {
+            let node = this;
+
             $("#node-input-setpoint").typedInput({
                 type: "num",
                 types: ["num"]
@@ -45,16 +47,17 @@
                 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,
-                    }],
+                    }
+                ],
                 typeField: "#node-input-out_higher_type"
             });
 
@@ -62,26 +65,27 @@
                 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,
-                    }],
+                    }
+                ],
                 typeField: "#node-input-out_lower_type"
             });
 
             $("#node-input-send_only_change").typedInput({
                 type: "bool",
                 types: [{
-                    value: "1",
+                    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") },
                     ]
                 }]
             });
@@ -89,10 +93,10 @@
             $("#node-input-outputs").typedInput({
                 type: "num",
                 types: [{
-                    value: "1",
+                    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") },
                     ]
                 }]
             });
@@ -107,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);
         }
@@ -118,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>