smart-nodes 0.3.36 → 0.4.0

package/compare/compare.html

@@ -3,14 +3,13 @@
         category: "Smart Nodes",
         paletteLabel: "Compare",
         color: "#E2D96E",
-        color: "#E2D96E",
         defaults: {
             name: { value: "" },
             comparator: { value: "EQUAL" }, // EQUAL, GREATER, GREATER_EQUAL, SMALLER, SMALLER_EQUAL, UNEQUAL
             value1: { value: "" },
-            value1_type: { value: "null" },
+            value1_type: { value: "NOTHING" },
             value2: { value: "" },
-            value2_type: { value: "null" },
+            value2_type: { value: "NOTHING" },
             out_false: { value: '{"topic": ""}' },
             out_false_type: { value: 'json' },
             out_true: { value: '{"topic": ""}' },
@@ -33,27 +32,28 @@
         },
         oneditprepare: function ()
         {
+            let node = this;
+
             $("#node-input-comparator").typedInput({
-                types: [
-                    {
-                        default: "EQUAL",
-                        options: [
-                            { value: "SMALLER", label: "< Kleiner" },
-                            { value: "SMALLER_EQUAL", label: "<= Kleiner oder gleich" },
-                            { value: "EQUAL", label: "== Gleich" },
-                            { value: "UNEQUAL", label: "!= Ungleich" },
-                            { value: "GREATER_EQUAL", label: ">= Größer oder gleich" },
-                            { value: "GREATER", label: "> Größer" }
-                        ],
-                    },
-                ],
+                types: [{
+                    default: "EQUAL",
+                    value: "comperator",
+                    options: [
+                        { value: "SMALLER", label: node._("compare.ui.smaller") },
+                        { value: "SMALLER_EQUAL", label: node._("compare.ui.smaller_equal") },
+                        { value: "EQUAL", label: node._("compare.ui.equal") },
+                        { value: "UNEQUAL", label: node._("compare.ui.unequal") },
+                        { value: "GREATER_EQUAL", label: node._("compare.ui.greater_equal") },
+                        { value: "GREATER", label: node._("compare.ui.greater") },
+                    ],
+                }],
             });
 
             $("#node-input-value1").typedInput({
                 type: "num",
                 types: ["str", "num", "bool", {
-                    value: "null",
-                    label: "Kein Wert",
+                    value: "NOTHING",
+                    label: node._("compare.ui.no_value"),
                     icon: "fa fa-times",
                     hasValue: false,
                 }],
@@ -63,8 +63,8 @@
             $("#node-input-value2").typedInput({
                 type: "num",
                 types: ["str", "num", "bool", {
-                    value: "null",
-                    label: "Kein Wert",
+                    value: "NOTHING",
+                    label: node._("compare.ui.no_value"),
                     icon: "fa fa-times",
                     hasValue: false,
                 }],
@@ -76,8 +76,8 @@
             $("#node-input-out_true").typedInput({
                 type: "json",
                 types: ["json", {
-                    value: "null",
-                    label: "Nichts senden",
+                    value: "NOTHING",
+                    label: node._("compare.ui.send_nothing"),
                     icon: "fa fa-times",
                     hasValue: false,
                 }],
@@ -87,8 +87,8 @@
             $("#node-input-out_false").typedInput({
                 type: "json",
                 types: ["json", {
-                    value: "null",
-                    label: "Nichts senden",
+                    value: "NOTHING",
+                    label: node._("compare.ui.send_nothing"),
                     icon: "fa fa-times",
                     hasValue: false,
                 }],
@@ -99,9 +99,10 @@
                 type: "bool",
                 types: [{
                     value: "1",
+                    value: "send_only_change",
                     options: [
-                        { value: "true", label: "Nur bei Änderung" },
-                        { value: "false", label: "Immer" },
+                        { value: "true", label: node._("compare.ui.send_only_change") },
+                        { value: "false", label: node._("compare.ui.always") },
                     ]
                 }]
             });
@@ -110,9 +111,10 @@
                 type: "num",
                 types: [{
                     value: "1",
+                    value: "outputs",
                     options: [
-                        { value: "1", label: "Gemeinsamer Ausgang" },
-                        { value: "2", label: "Separate Ausgänge" },
+                        { value: "1", label: node._("compare.ui.common_output") },
+                        { value: "2", label: node._("compare.ui.separate_output") },
                     ]
                 }]
             });
@@ -127,105 +129,80 @@
                     $("#resend_on_start_row").hide();
             });
             $("#node-input-save_state").trigger("change");
+
+
+
+            // Backward compatibility
+            if (this.value1_type == "null")
+            {
+                this.value1_type = "NOTHING";
+                $("#node-input-value1_type").val("NOTHING");
+            }
+
+            if (this.value2_type == "null")
+            {
+                this.value2_type = "NOTHING";
+                $("#node-input-value2_type").val("NOTHING");
+            }
+
         },
     });
 </script>
 
 <script type="text/html" data-template-name="smart_compare">
     <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="compare.ui.name"></span></label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]compare.ui.name"/>
     </div>
     <div class="form-row">
-        <label for="node-input-comparator"><i class="fa fa-sort"></i> Vergleich</label>
+        <label for="node-input-comparator"><i class="fa fa-sort"></i> <span data-i18n="compare.ui.compare"></span></label>
         <input id="node-input-comparator" />
     </div>
-    <div class="form-row">
-        <div>Defaultwerte werden hier gesetzt und können durch</div>
-        <div>die einkommenden Nachrichten überschrieben werden.</div>
+    <div class="form-row" style="max-width: 28rem">
+        <span data-i18n="compare.ui.note_default_values"></span>
     </div>
     <div class="form-row">
-        <label for="node-input-value1"><i class="fa fa-hashtag"></i> Wert 1</label>
+        <label for="node-input-value1"><i class="fa fa-hashtag"></i> <span data-i18n="compare.ui.value_1"></span></label>
         <input type="text" id="node-input-value1">
         <input type="hidden" id="node-input-value1_type">
     </div>
     <div class="form-row">
-        <label for="node-input-value2"><i class="fa fa-hashtag"></i> Wert 2</label>
+        <label for="node-input-value2"><i class="fa fa-hashtag"></i> <span data-i18n="compare.ui.value_2"></span></label>
         <input type="text" id="node-input-value2"/>
         <input type="hidden" id="node-input-value2_type">
     </div>
     <hr/>
-    <h4 style="margin: 0.5rem 0;">Ausgangsnachrichten</h4>
+    <h4 style="margin: 0.5rem 0;"><span data-i18n="compare.ui.output_messages"></span></h4>
     <div class="form-row">
-        <label for="node-input-out_true"><i class="fa fa-check-circle"></i> Wahr</label>
+        <label for="node-input-out_true"><i class="fa fa-check-circle"></i> <span data-i18n="compare.ui.true"></span></label>
         <input type="text" id="node-input-out_true"/>
         <input type="hidden" id="node-input-out_true_type">
     </div>
     <div class="form-row">
-        <label for="node-input-out_false"><i class="fa fa-times-circle"></i> Falsch</label>
+        <label for="node-input-out_false"><i class="fa fa-times-circle"></i> <span data-i18n="compare.ui.false"></span></label>
         <input type="text" id="node-input-out_false" />
         <input type="hidden" id="node-input-out_false_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="compare.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="compare.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 Vergleichs-Ergebnis gesetzt,</div>
-        <div>sofern es nicht bereits hier in der Konfiguration gesetzt wurde.</div>
-        <div><code>msg.comperator</code> wird automatisch auf den Vergleichs-Operator gesetzt,</div>
-        <div>sofern es nicht bereits hier in der Konfiguration gesetzt wurde.</div>
+    <div class="form-row" style="max-width: 28rem">
+        <div><strong data-i18n="compare.ui.note"></strong></div>
+        <div data-i18n="[html]compare.ui.note_text"></div>
     </div>
     <hr/>
-    <h4 style="margin: 0.5rem 0;">Systemstart</h4>
+    <h4 style="margin: 0.5rem 0;"><span data-i18n="compare.ui.system_start"></span></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);"><span data-i18n="compare.ui.save_state"></span></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);"><span data-i18n="compare.ui.send_after_start"></span></label>
     </div>
-</script>
-
-<script type="text/html" data-help-name="smart_compare">
-    <p>Diese Node führt verschiedene Vergleiche aus. Dabei können nicht nur Zahlen, sondern auch Texte verglichen werden.</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>
-    <p>
-        Folgende topics werden akzeptiert:
-        <table>
-            <thead>
-                <tr>
-                    <th>Topic</th>
-                    <th>Beschreibung</th>
-                </tr>
-            </thead>
-            <tbody>
-                <tr>
-                    <td><code>1</code></td>
-                    <td>Setzt den linken zu vergleichenden Wert</td>
-                </tr>
-                <tr>
-                    <td><code>2</code></td>
-                    <td>Setzt den rechten zu vergleichenden Wert</td>
-                </tr>
-            </tbody>
-        </table>
-    </p>
-    <p>Texte werden anhand ihres Ascii-Codes verglichen.<code>"c" &lt; "b"</code> ergibt <code>false</code><code>"C" &lt; "b"</code> ergibt <code>true</code>.</p>
-    <p>
-        <strong>Hinweis:</strong><br/>
-        <code>msg.payload</code> wird automatisch auf das Vergleichs-Ergebnis gesetzt,
-        sofern es nicht bereits in der Konfiguration gesetzt wurde.<br/>
-        <code>msg.comperator</code> wird automatisch auf den Vergleichs-Operator gesetzt,
-        sofern es nicht bereits in der Konfiguration gesetzt wurde.
-    </p>
 </script>

package/compare/compare.js

@@ -7,10 +7,21 @@ 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 = {
             values: [
                 helper.evaluateNodeProperty(RED, config.value1, config.value1_type),
@@ -20,33 +31,61 @@ module.exports = function (RED)
             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 comparator = config.comparator;
         let out_true = helper.evaluateNodeProperty(RED, config.out_true, config.out_true_type);
         let out_false = helper.evaluateNodeProperty(RED, config.out_false, config.out_false_type);
         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)
         {
+            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 =>
+        {
+            helper.log("handle topic:");
+            helper.log(msg);
+
             // Check if topic has a valid value
-            let input = helper.getTopicNumber(msg.topic);
-            if (input == null || input < 1 || input > 2)    
+            let real_topic_number = helper.getTopicNumber(msg.topic);
+            if (real_topic_number == null || real_topic_number < 1 || real_topic_number > 2)    
             {
-                node.error("Topic has to be 1 or 2, send: " + msg.topic);
+                console.warn("Topic has to be 1 or 2, sended: " + msg.topic);
                 return;
             }
 
@@ -54,17 +93,20 @@ module.exports = function (RED)
             let num = parseFloat(msg.payload);
             if (Number.isNaN(num))
             {
-                // node.error("Payload has to be numeric");
+                console.warn("Payload has to be numeric: " + msg.payload);
                 return;
             }
 
             // Save new value
-            node_settings.values[input - 1] = num;
+            node_settings.values[real_topic_number - 1] = num;
 
             let result = getResult();
-            let out_msg = null;
 
-            setStatus(result);
+            helper.log("getResult:");
+            helper.log(result);
+            helper.log(node_settings);
+
+            let out_msg = null;
 
             if (result != null)
             {
@@ -72,12 +114,12 @@ module.exports = function (RED)
                 if (result)
                 {
                     if (out_true !== null)
-                        out_msg = Object.assign({}, out_true);
+                        out_msg = helper.cloneObject(out_true);
                 }
                 else
                 {
                     if (out_false !== null)
-                        out_msg = Object.assign({}, out_false);
+                        out_msg = helper.cloneObject(out_false);
                 }
 
                 if (out_msg !== null)
@@ -105,12 +147,13 @@ module.exports = function (RED)
 
                 node_settings.last_result = result;
                 node_settings.last_message = out_msg;
-
-                if (config.save_state)
-                    smart_context.set(node.id, node_settings);
             }
-        });
+        }
 
+        /**
+         * Do the configured comparison and return the result
+         * @returns The comparison result
+         */
         let getResult = () =>
         {
             // Wait until both values are set
@@ -168,23 +211,20 @@ module.exports = function (RED)
         }
 
         // updates the status
-        let setStatus = (result) =>
+        let setStatus = () =>
         {
-            if (result == null)
+            if (node_settings.last_result === null)
                 node.status({});
             else
-                node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": " + node_settings.values.join(" " + getComparatorSign() + " ") + " => " + result });
+                node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": " + node_settings.values.join(" " + getComparatorSign() + " ") + " => " + node_settings.last_result });
         }
 
-        node.on("close", function ()
-        {
-        });
 
         if (config.save_state && config.resend_on_start && node_settings.last_message != null)
         {
             setTimeout(() =>
             {
-                node.send(node_settings.last_message);
+                node.send(helper.cloneObject(node_settings.last_message));
             }, 10000);
         }
 

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

@@ -0,0 +1,36 @@
+<script type="text/html" data-help-name="smart_compare">
+    <p>Diese Node führt verschiedene Vergleiche aus. Dabei können nicht nur Zahlen, sondern auch Texte verglichen werden.</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>
+    <p>
+        Folgende topics werden akzeptiert:
+        <table>
+            <thead>
+                <tr>
+                    <th>Topic</th>
+                    <th>Beschreibung</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td><code>1</code></td>
+                    <td>Setzt den linken zu vergleichenden Wert</td>
+                </tr>
+                <tr>
+                    <td><code>2</code></td>
+                    <td>Setzt den rechten zu vergleichenden Wert</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+    <p>Texte werden anhand ihres Ascii-Codes verglichen.<code>"c" &lt; "b"</code> ergibt <code>false</code><code>"C" &lt; "b"</code> ergibt <code>true</code>.</p>
+    <p>
+        <strong>Hinweis:</strong><br/>
+        <code>msg.payload</code> wird automatisch auf das Vergleichs-Ergebnis gesetzt,
+        sofern es nicht bereits in der Konfiguration gesetzt wurde.<br/>
+        <code>msg.comperator</code> wird automatisch auf den Vergleichs-Operator gesetzt,
+        sofern es nicht bereits in der Konfiguration gesetzt wurde.
+    </p>
+</script>

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

@@ -0,0 +1,35 @@
+{
+    "compare": {
+        "ui": {
+            "name": "Name",
+            "compare": "Vergleich",
+            "note_default_values": "Defaultwerte werden hier gesetzt und können durch die einkommenden Nachrichten überschrieben werden.",
+            "value_1": "Wert 1",
+            "value_2": "Wert 2",
+            "output_messages": "Ausgangsnachrichten",
+            "true": "Wahr",
+            "false": "Falsch",
+            "send": "Senden",
+            "outputs": "Ausgänge",
+            "note": "Hinweis:",
+            "note_text": "<code>msg.payload</code> wird automatisch auf das Vergleichs-Ergebnis gesetzt,<br/>sofern es nicht bereits hier in der Konfiguration gesetzt wurde.<br/><code>msg.comperator</code> wird automatisch auf den Vergleichs-Operator gesetzt,<br/>sofern es nicht bereits hier in der Konfiguration gesetzt wurde.",
+
+            "system_start": "Systemstart",
+            "save_state": "Zustand speichern",
+            "send_after_start": "Letze Nachricht 10 Sekunden nach dem Start senden",
+
+            "smaller": "< Kleiner",
+            "smaller_equal": "<= Kleiner oder gleich",
+            "equal": "== Gleich",
+            "unequal": "!= Ungleich",
+            "greater_equal": ">= Größer oder gleich",
+            "greater": "> Größer",
+            "no_value": "Kein Wert",
+            "send_nothing": "Nichts senden",
+            "send_only_change": "Nur bei Änderung",
+            "always": "Immer",
+            "common_output": "Gemeinsamer Ausgang",
+            "separate_output": "Separate Ausgänge"
+        }
+    }
+}

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

@@ -0,0 +1,36 @@
+<script type="text/html" data-help-name="smart_compare">
+    <p>This node performs various comparisons. Not only numbers, but also texts can be compared.</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>
+    <p>
+        The following topics are accepted:
+        <table>
+            <thead>
+                <tr>
+                    <th>Topic</th>
+                    <th>Description</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td><code>1</code></td>
+                    <td>Sets the left value to compare</td>
+                </tr>
+                <tr>
+                    <td><code>2</code></td>
+                    <td>Sets the right value to compare</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+    <p>Texts are compared based on their ASCII code.<code>"c" &lt; "b"</code> returns <code>false</code><code>"C" &lt; "b"</code> results in <code>true</code>.</p>
+    <p>
+        <strong>Note:</strong><br/>
+        <code>msg.payload</code> is automatically set to the comparison result,
+        if it has not already been set in the configuration.<br/>
+        <code>msg.comperator</code> is automatically set to the comparison operator,
+        if it has not already been set in the configuration.
+    </p>
+</script>

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

@@ -0,0 +1,35 @@
+{
+    "compare": {
+        "ui": {
+            "name": "Name",
+            "compare": "Compare",
+            "note_default_values": "Default values are set here and can be overwritten by incoming messages.",
+            "value_1": "Value 1",
+            "value_2": "Value 2",
+            "output_messages": "Output message",
+            "true": "True",
+            "false": "False",
+            "send": "Send",
+            "outputs": "Outputs",
+            "note": "Note:",
+            "note_text": "<code>msg.payload</code> is automatically set to the comparison result,<br/>if it has not already been set here in the configuration.<br/><code>msg.comperator</code> is automatically set to the comparison operator,<br/>if it has not already been set here in the configuration.",
+
+            "system_start": "System start",
+            "save_state": "Save state",
+            "send_after_start": "Send last message 10 seconds after the start",
+
+            "smaller": "< Smaller",
+            "smaller_equal": "<= Smaller or equal",
+            "equal": "== Equal",
+            "unequal": "!= Not equal",
+            "greater_equal": ">= Greater or equal",
+            "greater": "> Greater",
+            "no_value": "No value",
+            "send_nothing": "Send nothing",
+            "send_only_change": "Only on change",
+            "always": "Always",
+            "common_output": "Common output",
+            "separate_output": "Separate outputs"
+        }
+    }
+}