smart-nodes 0.3.37 → 0.4.0

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(RED._("compare.errors.wrong_topic") + 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.json

@@ -1,8 +1,5 @@
 {
     "compare": {
-        "errors": {
-            "wrong_topic": "Topic muss 1 oder 2 sein, gesendet: "
-        },
         "ui": {
             "name": "Name",
             "compare": "Vergleich",
@@ -14,12 +11,13 @@
             "false": "Falsch",
             "send": "Senden",
             "outputs": "Ausgänge",
-            "note": "Hinweis",
-            "note_payload": "wird automatisch auf das Vergleichs-Ergebnis gesetzt, sofern es nicht bereits hier in der Konfiguration gesetzt wurde.",
-            "note_comperator": "wird automatisch auf den Vergleichs-Operator gesetzt, sofern es nicht bereits hier in der Konfiguration gesetzt wurde.",
+            "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",
@@ -28,7 +26,7 @@
             "greater": "> Größer",
             "no_value": "Kein Wert",
             "send_nothing": "Nichts senden",
-            "only_on_change": "Nur bei Änderung",
+            "send_only_change": "Nur bei Änderung",
             "always": "Immer",
             "common_output": "Gemeinsamer Ausgang",
             "separate_output": "Separate Ausgänge"

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

@@ -1,12 +1,9 @@
 {
     "compare": {
-        "errors": {
-            "wrong_topic": "Topic has to be 1 or 2, sended: "
-        },
         "ui": {
             "name": "Name",
             "compare": "Compare",
-            "note_default_values": "Default values ​​are set here and can be overwritten by incoming messages.",
+            "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",
@@ -14,12 +11,25 @@
             "false": "False",
             "send": "Send",
             "outputs": "Outputs",
-            "note": "Note",
-            "note_payload": "is automatically set to the comparison result, unless it has already been set here in the configuration.",
-            "note_comperator": "is automatically set to the comparison operator if it has not already been set here in the configuration.",
+            "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"
+            "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"
         }
     }
 }

package/counter/counter.html

@@ -23,11 +23,54 @@
         },
         oneditprepare: function ()
         {
+            let node = this;
+
+            $("#node-input-start")
+                .spinner({
+                    change: function (event, ui)
+                    {
+                        var value = parseFloat(this.value);
+                        value = isNaN(value) ? 0 : value;
+                        if (value !== this.value) $(this).spinner("value", value);
+                    },
+                }).css("max-width", "4rem");
+
+            $("#node-input-step")
+                .spinner({
+                    change: function (event, ui)
+                    {
+                        var value = parseFloat(this.value);
+                        value = isNaN(value) ? 0 : value;
+                        if (value !== this.value) $(this).spinner("value", value);
+                    },
+                }).css("max-width", "4rem");
+
+            $("#node-input-min")
+                .spinner({
+                    change: function (event, ui)
+                    {
+                        var value = parseFloat(this.value);
+                        value = isNaN(value) ? 0 : value;
+                        if (value !== this.value) $(this).spinner("value", value);
+                    },
+                }).css("max-width", "4rem");
+
+            $("#node-input-max")
+                .spinner({
+                    change: function (event, ui)
+                    {
+                        var value = parseFloat(this.value);
+                        value = isNaN(value) ? 0 : value;
+                        if (value !== this.value) $(this).spinner("value", value);
+                    },
+                }).css("max-width", "4rem");
+
+
             $("#node-input-out_message").typedInput({
                 type: "json",
                 types: ["json", {
-                    value: "null",
-                    label: this._("default"),
+                    value: "NOTHING",
+                    label: node._("default"),
                     icon: "fa fa-times",
                     hasValue: false,
                 }],
@@ -42,6 +85,14 @@
                     $("#resend_on_start_row").hide();
             });
             $("#node-input-save_state").trigger("change");
+
+            // Backward compatibility
+            if (this.out_message_type == "null")
+            {
+                this.out_message_type = "NOTHING";
+                $("#node-input-out_message_type").val("NOTHING");
+            }
+
         }
     });
 </script>
@@ -53,43 +104,39 @@
     </div>
     <div class="form-row">
         <label for="node-input-start"><i class="fa fa-cog"></i> <span data-i18n="counter.ui.start"></label>
-        <input type="number" id="node-input-start"  data-i18n="[placeholder]counter.ui.start">
+        <input id="node-input-start"  data-i18n="[placeholder]counter.ui.start">
     </div>
     <div class="form-row">
         <label for="node-input-step"><i class="fa fa-forward"></i> <span data-i18n="counter.ui.step"></label>
-        <input type="number" id="node-input-step"  data-i18n="[placeholder]counter.ui.step">
+        <input id="node-input-step"  data-i18n="[placeholder]counter.ui.step">
     </div>
     <div class="form-row">
         <label for="node-input-min"><i class="fa fa-arrow-down"></i> <span data-i18n="counter.ui.min"></label>
-        <input type="number" id="node-input-min"  data-i18n="[placeholder]counter.ui.min">
+        <input id="node-input-min"  data-i18n="[placeholder]counter.ui.min">
     </div>
     <div class="form-row">
         <label for="node-input-max"><i class="fa fa-arrow-up"></i> <span data-i18n="counter.ui.max"></label>
-        <input type="number" id="node-input-max"  data-i18n="[placeholder]counter.ui.max">
+        <input id="node-input-max"  data-i18n="[placeholder]counter.ui.max">
     </div>
     <hr/>
-    <h4 style="margin: 0.5rem 0;">Ausgangsnachricht</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_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="counter.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="counter.ui.note"></strong></div>
+        <div data-i18n="[html]counter.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>

package/counter/counter.js

@@ -7,41 +7,67 @@ 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 = {
             value: 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
-        let start = config.start;
-        let step = config.step;
-        let min = config.min;
-        let max = config.max;
+
+        // ##################
+        // # Dynamic config #
+        // ##################
+        let start = parseInt(config.start, 10);
+        let step = parseInt(config.step, 10);
+        let min = parseInt(config.min, 10);
+        let max = parseInt(config.max, 10);
         let out_message = helper.evaluateNodeProperty(RED, config.out_message, config.out_message_type);
 
-        // runtime values
+
+        // ##################
+        // # Runtime values #
+        // ##################
+        // Not used by this node
 
         node.on("input", function (msg)
         {
             handleTopic(msg);
+
             sendResult();
+
             setStatus();
+            smart_context.set(node.id, node_settings);
         });
 
+        node.on("close", function ()
+        {
+        });
+
+
+        // #####################
+        // # Private functions #
+        // #####################
+
+        // This is the main function which handles all topics that was received.
         let handleTopic = msg =>
         {
             let real_topic = helper.getTopicName(msg.topic);
@@ -93,6 +119,9 @@ module.exports = function (RED)
             node_settings.value = Math.min(max, Math.max(min, node_settings.value));
         }
 
+        /**
+         * Send the result to the output
+         */
         let sendResult = () =>
         {
             // Nothing changed, nothing to do
@@ -101,19 +130,13 @@ module.exports = function (RED)
 
             // if out_message is set, use this instead of the default message
             if (out_message)
-                node_settings.last_message = Object.assign({}, out_message, { payload: node_settings.value });
+                node_settings.last_message = helper.cloneObject(out_message, { payload: node_settings.value });
             else
                 node_settings.last_message = { payload: node_settings.value };
 
-            smart_context.set(node.id, node_settings);
-
             node.send(node_settings.last_message);
         }
 
-        node.on("close", function ()
-        {
-        });
-
         // updates the status
         let setStatus = () =>
         {
@@ -127,7 +150,7 @@ module.exports = function (RED)
         {
             setTimeout(() =>
             {
-                node.send(node_settings.last_message);
+                node.send(helper.cloneObject(node_settings.last_message));
             }, 10000);
         }
 

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

@@ -1,24 +1,21 @@
 {
     "counter": {
-        "errors": {
-            "wrong_topic": "Topic muss 1 oder 2 sein, gesendet: "
-        },
         "ui": {
             "name": "Name",
             "start": "Start",
             "step": "Schritt",
             "min": "Min",
             "max": "Max",
+            "output_messages": "Ausgangsnachrichten",
+            "message": "Nachricht",
+            "note": "Hinweis:",
+            "note_text": "<code>msg.payload</code> wird immer automatisch auf den Ergebnis-Wert gesetzt.",
 
             "system_start": "Systemstart",
             "save_state": "Zustand speichern",
             "send_after_start": "Letze Nachricht 10 Sekunden nach dem Start senden",
-            "no_value": "Kein Wert",
-            "send_nothing": "Nichts senden",
-            "only_on_change": "Nur bei Änderung",
-            "always": "Immer",
-            "common_output": "Gemeinsamer Ausgang",
-            "separate_output": "Separate Ausgänge"
+
+            "default": "Standard"
         }
     }
 }

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

@@ -1,25 +1,21 @@
 {
     "counter": {
-        "errors": {
-            "wrong_topic": "Topic has to be 1 or 2, sended: "
-        },
         "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_payload": "is automatically set to the comparison result, unless it has already been set here in the configuration.",
-            "note_comperator": "is automatically set to the comparison operator if it has not already been set here in the configuration.",
+            "start": "Start",
+            "step": "Step",
+            "min": "Min",
+            "max": "Max",
+            "output_messages": "Output messages",
+            "message": "Message",
+            "note": "Note:",
+            "note_text": "<code>msg.payload</code> is always automatically set to the result value.",
+
             "system_start": "System start",
             "save_state": "Save state",
-            "send_after_start": "Send last message 10 seconds after the start"
+            "send_after_start": "Send last message 10 seconds after start",
+
+            "default": "Default"
         }
     }
 }