smart-nodes 0.3.36 → 0.4.0

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

@@ -0,0 +1,29 @@
+{
+    "statistic": {
+        "ui": {
+            "name": "Name",
+            "operation": "Operation",
+            "count": "Anzahl",
+            "message": "Nachricht",
+
+            "note": "Hinweis:",
+            "note_text": "<code>msg.payload</code> wird immer automatisch auf den Ergebnis-Wert gesetzt.",
+
+            "output_messages": "Ausgangsnachrichten",
+            "system_start": "Systemstart",
+            "save_state": "Zustand speichern",
+            "send_after_start": "Letze Nachricht 10 Sekunden nach dem Start senden",
+
+            "minimum": "Minimum",
+            "maximum": "Maximum",
+            "sum": "Summe",
+            "difference": "Differenz",
+            "absolute_value": "Absoluter Wert",
+            "absolute_difference": "Absolute Differenz",
+            "average": "Durchschnitt",
+            "moving_average": "Gleitender Mittelwert",
+
+            "default": "Standard"
+        }
+    }
+}

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

@@ -0,0 +1,10 @@
+<script type="text/html" data-help-name="smart_statistic">
+    <p>This node calculates the minimum, maximum, sum, difference, absolute value, absolute difference, average and moving average of different values.</p>
+    <p>Each value must be sent with its own topic. If a second value comes with the same topic, the corresponding value is overwritten.</p>
+    <p>In the case of MIN, MAX and ABS, the corresponding topic that came with the values is also output. SUM, DIFF, AVG and MOV_AVG are combined results, which is why Topic is always not set here.</p>
+    <p>The topic is not important for the absolute value and the moving average; every value that is received is used for the calculation.</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 <code>number</code> part. <code>name</code> and <code>#</code> are optional.
+    </p>
+</script>

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

@@ -0,0 +1,29 @@
+{
+    "statistic": {
+        "ui": {
+            "name": "Name",
+            "operation": "Operation",
+            "count": "Count",
+            "message": "Message",
+
+            "note": "Note:",
+            "note_text": "<code>msg.payload</code> is always automatically set to the result value.",
+
+            "output_messages": "Output messages",
+            "system_start": "System start",
+            "save_state": "Save state",
+            "send_after_start": "Send last message 10 seconds after start",
+
+            "minimum": "Minimum",
+            "maximum": "Maximum",
+            "sum": "Sum",
+            "difference": "Difference",
+            "absolute_value": "Absolute value",
+            "absolute_difference": "Absolute difference",
+            "average": "Average",
+            "moving_average": "Moving average",
+
+            "default": "Default"
+        }
+    }
+}

package/statistic/statistic.html

@@ -21,23 +21,24 @@
         },
         oneditprepare: function ()
         {
+            let node = this;
+
             $("#node-input-operation")
                 .typedInput({
-                    types: [
-                        {
-                            default: "MIN",
-                            options: [
-                                { value: "MIN", label: "Minimum" },
-                                { value: "MAX", label: "Maximum" },
-                                { value: "SUM", label: "Summe" },
-                                { value: "DIFF", label: "Differenz" },
-                                { value: "ABS", label: "Absoluter Wert" },
-                                { value: "ABS_DIFF", label: "Absolute Differenz" },
-                                { value: "AVG", label: "Durchschnitt" },
-                                { value: "MOV_AVG", label: "Gleitender Mittelwert" }
-                            ],
-                        },
-                    ],
+                    types: [{
+                        default: "MIN",
+                        value: "operation",
+                        options: [
+                            { value: "MIN", label: node._("statistic.ui.minimum") },
+                            { value: "MAX", label: node._("statistic.ui.maximum") },
+                            { value: "SUM", label: node._("statistic.ui.sum") },
+                            { value: "DIFF", label: node._("statistic.ui.difference") },
+                            { value: "ABS", label: node._("statistic.ui.absolute_value") },
+                            { value: "ABS_DIFF", label: node._("statistic.ui.absolute_difference") },
+                            { value: "AVG", label: node._("statistic.ui.average") },
+                            { value: "MOV_AVG", label: node._("statistic.ui.moving_average") }
+                        ],
+                    }],
                 });
 
             $("#node-input-count").css("max-width", "4rem").spinner({
@@ -63,8 +64,8 @@
             $("#node-input-out_message").typedInput({
                 type: "json",
                 types: ["json", {
-                    value: "null",
-                    label: "Standard",
+                    value: "DEFAULT",
+                    label: node._("statistic.ui.default"),
                     icon: "fa fa-times",
                     hasValue: false,
                 }],
@@ -79,57 +80,51 @@
                     $("#resend_on_start_row").hide();
             });
             $("#node-input-save_state").trigger("change");
+
+
+            // Backward compatibility
+            if (this.out_message_type == "null")
+            {
+                this.out_message_type = "DEFAULT";
+                $("#node-input-out_message_type").val("DEFAULT");
+            }
+
         }
     });
 </script>
 
 <script type="text/html" data-template-name="smart_statistic">
     <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="statistic.ui.name"></span></label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]statistic.ui.name" />
     </div>
     <div class="form-row">
-        <label for="node-input-operation"><i class="fa fa-sort"></i> Operation</label>
+        <label for="node-input-operation"><i class="fa fa-sort"></i> <span data-i18n="statistic.ui.operation"></span></label>
         <input id="node-input-operation" />
     </div>
     <div class="form-row statistic-moving-average-row" style="display: none;">
-        <label for="node-input-count"><i class="fa fa-hashtag"></i> Anzahl</label>
+        <label for="node-input-count"><i class="fa fa-hashtag"></i> <span data-i18n="statistic.ui.count"></span></label>
         <input id="node-input-count" />
     </div>
     <hr/>
-    <h4 style="margin: 0.5rem 0;">Ausgangsnachricht</h4>
+    <h4 style="margin: 0.5rem 0;" data-i18n="statistic.ui.output_messages"></h4>
     <div class="form-row">
-        <label for="node-input-out_message"><i class="fa fa-check-circle"></i> Nachricht</label>
+        <label for="node-input-out_message"><i class="fa fa-check-circle"></i> <span data-i18n="statistic.ui.message"></span></label>
         <input type="text" id="node-input-out_message"/>
         <input type="hidden" id="node-input-out_message_type">
     </div>
     <div class="form-row">
-        <span><strong>Hinweis:</strong></span>
-    </div>
-    <div class="form-row">
-        <span>
-            <code>msg.payload</code> wird immer automatisch auf den Ergebnis-Wert gesetzt.
-        </span>
+        <div><strong data-i18n="statistic.ui.note"></strong></div>
+        <div data-i18n="[html]statistic.ui.note_text"></div>
     </div>
     <hr/>
-    <h4 style="margin: 0.5rem 0;">Systemstart</h4>
+    <h4 style="margin: 0.5rem 0;" data-i18n="statistic.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="statistic.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="statistic.ui.send_after_start"></label>
     </div>
-</script>
-
-<script type="text/html" data-help-name="smart_statistic">
-    <p>Dieser Knoten berechnet das Minimum, Maximum, die Summe, die Differenz, den absoluten Wert, die absolute Differenz, den Durchschnitt sowie den gleitenden Mittelwert verschiedener Werte.</p>
-    <p>Jeder Wert muss mit einem eigenen Topic gesendet werden. Kommt ein zweiter Wert mit dem gleichen Topic, wird der entsprechende Wert überschrieben.</p>
-    <p>Im Falle von MIN, MAX und ABS wird das entsprechende Topic, welches mit den Werten kam, mit ausgegeben. Bei SUM, DIFF, AVG und MOV_AVG handelt es sich um kombinierte Ergebnisse, weshalb Topic hier immer nicht gesetzt ist.</p>
-    <p>Für den absoluten Wert sowie den gleitenden Mittelwert spielt das Topic keine Rolle, jeder Wert der empfangen wird, wird für die Berechnung verwendet.</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>nummer</code>. <code>name</code> und <code>#</code> sind dabei optional.
-    </p>
 </script>

package/statistic/statistic.js

@@ -7,44 +7,80 @@ 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 = {
             values: [],
-            lastMessage: null,
+            last_message: null,
         };
 
+
+        // 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 operation = config.operation
         let out_message = helper.evaluateNodeProperty(RED, config.out_message, config.out_message_type);
         let count = config.count;
 
-        // 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 ()
+        {
+        });
+
+
+        // #####################
+        // # Private functions #
+        // #####################
+
+        // This is the main function which handles all topics that was received.
+        let handleTopic = msg =>
         {
             if (isNaN(parseFloat(msg.payload)))
             {
-                // node.error("Invalid payload: " + msg.payload);
+                console.warn("Invalid payload: " + msg.payload);
                 return;
             }
 
-            let real_topic = helper.getTopicNumber(msg.topic) || 0;
-            // real_topic should be sended with 1-based, but internally 0-based is needed
-            real_topic--;
+            let real_topic_number = helper.getTopicNumber(msg.topic) || 0;
+
+            // real_topic_number should be sended with 1-based, but internally 0-based is needed
+            real_topic_number--;
 
             if (operation === "MOV_AVG")
             {
@@ -59,7 +95,7 @@ module.exports = function (RED)
                     node.error("Topic not set");
                     return;
                 }
-                node_settings.values[real_topic] = parseFloat(msg.payload);
+                node_settings.values[real_topic_number] = parseFloat(msg.payload);
             }
 
             msg = getResult(msg);
@@ -69,19 +105,12 @@ module.exports = function (RED)
             {
                 // if out_message is set, use this instead of the default message
                 if (out_message)
-                    msg = Object.assign({}, out_message, { payload: msg.payload });
+                    msg = helper.cloneObject(out_message, { payload: msg.payload });
 
-                node_settings.lastMessage = msg;
-                node.send(msg);
+                node_settings.last_message = helper.cloneObject(msg);
+                node.send(node_settings.last_message);
             }
-
-            if (config.save_state)
-                smart_context.set(node.id, node_settings);
-        });
-
-        node.on("close", function ()
-        {
-        });
+        }
 
         let getResult = (msg) =>
         {
@@ -188,15 +217,15 @@ module.exports = function (RED)
                 node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": " + operation + "(" + Object.entries(node_settings.values).map(v => v[1]).join(", ") + ") => " + msg.payload });
         }
 
-        if (config.save_state && config.resend_on_start && node_settings.lastMessage != null)
+        if (config.save_state && config.resend_on_start && node_settings.last_message != null)
         {
             setTimeout(() =>
             {
-                node.send(node_settings.lastMessage);
+                node.send(helper.cloneObject(node_settings.last_message));
             }, 10000);
         }
 
-        setStatus(node_settings.lastMessage);
+        setStatus(node_settings.last_message);
     }
 
     RED.nodes.registerType("smart_statistic", StatisticNode);

package/text-exec/locales/de-DE/text-exec.html

@@ -0,0 +1,18 @@
+<script type="text/html" data-help-name="smart_text-exec">
+    <p>
+        Diese Node nimmt einen Text entgegen, zerlegt ihn und führt die Kommandos auf den ausgewählten und passenden Nodes aus.
+    </p>
+    <p>
+        <strong>Beispiele:</strong><br/><br/>
+        <strong>Schalte das Licht im Wohnzimmer ein.</strong><br/>
+        Alle Light-controls und Scene-controls die das Wort <strong>Wohnzimmer</strong> enthalten bekommen eine Nachricht mit dem topic <code>on</code>.<br/><br/>
+        
+        <strong>Schalte das Büro ein und die Küche aus.</strong><br/>
+        Alle Light-controls und Scene-controls die das Wort <strong>Büro</strong> enthalten bekommen eine Nachricht mit dem topic <code>on</code> und
+        alle Light-controls und Scene-controls die das Wort <strong>Küche</strong> enthalten bekommen eine Nachricht mit dem topic <code>off</code>.<br/><br/>
+        
+        <strong>Schließe die Rollladen im Wohnzimmer und schalte das Licht in der Küche an.</strong><br/>
+        Alle Schutter-controls und Shutter-complex-controls die das Wort <strong>Wohnzimmer</strong> enthalten bekommen eine Nachricht mit dem topic <code>down</code> und
+        alle Light-controls und Scene-controls die das Wort <strong>Küche</strong> enthalten bekommen eine Nachricht mit dem topic <code>on</code>.<br/><br/>
+    </p>
+</script>

package/text-exec/locales/de-DE/text-exec.json

@@ -0,0 +1,7 @@
+{
+    "text-exec": {
+        "ui": {
+            "name": "Name"
+        }
+    }
+}

package/text-exec/locales/en-US/text-exec.html

@@ -0,0 +1,18 @@
+<script type="text/html" data-help-name="smart_text-exec">
+    <p>
+        This node accepts a text, breaks it down and executes the commands on the selected and appropriate nodes.
+    </p>
+    <p>
+        <strong>Examples:</strong><br/><br/>
+        <strong>Turn on the light in the living room.</strong><br/>
+        All light controls and scene controls that contain the word <strong>living room</strong> receive a message with the topic <code>on</code>.<br/><br/>
+        
+        <strong>Turn on the office and turn off the kitchen.</strong><br/>
+        All light controls and scene controls that contain the word <strong>office</strong> receive a message with the topic <code>on</code> and
+        all light controls and scene controls that contain the word <strong>kitchen</strong> receive a message with the topic <code>off</code>.<br/><br/>
+        
+        <strong>Close the shutters in the living room and turn on the light in the kitchen.</strong><br/>
+        All shutter controls and shutter complex controls that contain the word <strong>living room</strong> receive a message with the topic <code>down</code> and
+        all light controls and scene controls that contain the word <strong>kitchen</strong> receive a message with the topic <code>on</code>.<br/><br/>
+    </p>
+</script>

package/text-exec/locales/en-US/text-exec.json

@@ -0,0 +1,7 @@
+{
+    "text-exec": {
+        "ui": {
+            "name": "Name"
+        }
+    }
+}

package/text-exec/text-exec.html

@@ -264,11 +264,14 @@
             },
             oneditprepare: function ()
             {
-                // console.log("Here");
+                let node = this;
+
                 onEditPrepare(this, ["smart_light-control", "smart_scene-control", "smart_shutter-complex-control", "smart_shutter-control"]);
             },
             oneditsave: function ()
             {
+                let node = this;
+
                 onEditSave(this);
             },
             onadd: onAdd,
@@ -279,30 +282,11 @@
 
 <script type="text/html" data-template-name="smart_text-exec">
     <div class="form-row">
-        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
-        <input type="text" id="node-input-name" />
+        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="text-exec.ui.name"></span></label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]text-exec.ui.name" />
+    </div>
+    <div class="node-input-link-rows" style="position:relative; height: 30px; text-align: right;">
+        <div style="display:inline-block"><input type="text" id="node-input-link-target-filter" /></div>
     </div>
-    <div class="node-input-link-rows" style="position:relative; height: 30px; text-align: right;"
-        ><div style="display:inline-block"><input type="text" id="node-input-link-target-filter" /></div
-    ></div>
     <div class="form-row node-input-link-row node-input-link-rows"></div>
-</script>
-
-<script type="text/html" data-help-name="smart_text-exec">
-    <p>
-        Diese Node nimmt einen Text entgegen, zerlegt ihn und führt die Kommandos auf den ausgewählten und passenden Nodes aus.
-    </p>
-    <p>
-        <strong>Beispiele:</strong><br/><br/>
-        <strong>Schalte das Licht im Wohnzimmer ein.</strong><br/>
-        Alle Light-controls und Scene-controls die das Wort <strong>Wohnzimmer</strong> enthalten bekommen eine Nachricht mit dem topic <code>on</code>.<br/><br/>
-        
-        <strong>Schalte das Büro ein und die Küche aus.</strong><br/>
-        Alle Light-controls und Scene-controls die das Wort <strong>Büro</strong> enthalten bekommen eine Nachricht mit dem topic <code>on</code> und
-        alle Light-controls und Scene-controls die das Wort <strong>Küche</strong> enthalten bekommen eine Nachricht mit dem topic <code>off</code>.<br/><br/>
-        
-        <strong>Schließe die Rollladen im Wohnzimmer und schalte das Licht in der Küche an.</strong><br/>
-        Alle Schutter-controls und Shutter-complex-controls die das Wort <strong>Wohnzimmer</strong> enthalten bekommen eine Nachricht mit dem topic <code>down</code> und
-        alle Light-controls und Scene-controls die das Wort <strong>Küche</strong> enthalten bekommen eine Nachricht mit dem topic <code>on</code>.<br/><br/>
-    </p>
 </script>

package/text-exec/text-exec.js

@@ -7,15 +7,52 @@ 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");
 
-        node.status({});
 
-        let log = [];
+        // #####################
+        // # persistent values #
+        // #####################
+
+
+        // ##################
+        // # Dynamic config #
+        // ##################
+
+
+        // ##################
+        // # Runtime values #
+        // ##################
+
+        // Here the ouput message for logging purposes is saved.
+        // It will be cleared with every new node input
+        let log;
+
+        // Holds a list with all room names, sorted from the longest to the shortest
+        // Format: Index => RoomName
         let rooms = [];
 
+        // Holds references to the nodes to access them by room name
+        // Format: RoomName => [Node1, Node2, ..., NodeX]
         let lookup = [];
 
+
+        node.status({});
+
+
+        // ###############
+        // # Node events #
+        // ###############
         node.on("input", function (msg)
         {
             let mode = "light"; // light || shutter
@@ -216,6 +253,10 @@ module.exports = function (RED)
             node.send(log);
         });
 
+        node.on("close", function ()
+        {
+        });
+
         /**
          * This function prepares a list of the rooms as well as the lookup tables for lights and shutters
          */