smart-nodes 0.3.37 → 0.4.1

package/logic/logic.js

@@ -7,28 +7,38 @@ 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 = {
             input_states: Array.from({ length: config.logic_inputs }).fill(false),
             last_result: 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 logic = config.logic;
         let out_true = helper.evaluateNodeProperty(RED, config.out_true, config.out_true_type || "json");
         let out_false = helper.evaluateNodeProperty(RED, config.out_false, config.out_false_type || "json");
@@ -38,29 +48,59 @@ module.exports = function (RED)
         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)
         {
-            if (typeof msg.topic === "undefined")
-            {
-                node.error("Topic not set");
-                return;
-            }
-            let input = helper.getTopicNumber(msg.topic);
+            handleTopic(msg);
+
+            setStatus();
+
+            if (config.save_state)
+                smart_context.set(node.id, node_settings);
+        });
 
-            if (input == null || input < 1 || input > logic_inputs)    
+        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);
+
+            let real_topic_number = helper.getTopicNumber(msg.topic);
+
+            if (real_topic_number == null || real_topic_number < 1 || real_topic_number > logic_inputs)    
             {
                 node.error("Topic has to be >= 1 and <= " + logic_inputs + ", send: " + msg.topic);
                 return;
             }
 
-            if (inverts.includes(input))
-                node_settings.input_states[input - 1] = !msg.payload;
+            if (inverts.includes(real_topic_number))
+                node_settings.input_states[real_topic_number - 1] = !msg.payload;
             else
-                node_settings.input_states[input - 1] = !!msg.payload; // !! => Convert to boolean
+                node_settings.input_states[real_topic_number - 1] = !!msg.payload; // !! => Convert to boolean
 
             let result = getResult();
+
+            helper.log("getResult:");
+            helper.log(result);
+            helper.log(node_settings);
+
             let out_msg = null;
 
             setStatus();
@@ -72,12 +112,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)
@@ -103,13 +143,7 @@ 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);
-        });
-
-        node.on("close", function ()
-        {
-        });
+        }
 
         let getResult = () =>
         {
@@ -187,7 +221,7 @@ module.exports = function (RED)
         {
             setTimeout(() =>
             {
-                node.send(node_settings.last_message);
+                node.send(helper.cloneObject(node_settings.last_message));
             }, 10000);
         }
 

package/long-press/locales/de-DE/long-press.html

@@ -0,0 +1,5 @@
+<script type="text/html" data-help-name="smart_long-press-control">
+    <p>Diese Node kann unterscheiden, wie lange ein Taster gedrückt wurde. Die Zeit, ab wann ein Tastendruck als lang gilt, kann in den Eigenschaften der Node eingestellt werden.</p>
+    <p>Ein langer Tastendruck wird sofort ausgelöst, wenn die maximal Zeit überschritten wurde.</p>
+    <p>Die Node misst die Zeit zwischen <code>msg.payload = true;</code> und <code>msg.payload = false;</code> und gibt eine entsprechende Nachricht aus.</p>
+</script>

package/long-press/locales/de-DE/long-press.json

@@ -0,0 +1,13 @@
+{
+    "long-press": {
+        "ui": {
+            "name": "Name",
+            "time_for_long": "Zeit für lang",
+            "time_for_long_placeholder": "Zeit in ms für einen langen Druck",
+            "milliseconds": "Millisekunden",
+            "output_messages": "Ausgangsnachrichten",
+            "short": "Kurz",
+            "long": "Lang"
+        }
+    }
+}

package/long-press/locales/en-US/long-press.html

@@ -0,0 +1,5 @@
+<script type="text/html" data-help-name="smart_long-press-control">
+    <p>This node can distinguish how long a button has been pressed. The time from which a button press is considered long can be set in the properties of the node.</p>
+    <p>A long button press is triggered immediately if the maximum time has been exceeded.</p>
+    <p>The node measures the time between <code>msg.payload = true;</code> and <code>msg.payload = false;</code> and outputs a corresponding message.</p>
+</script>

package/long-press/locales/en-US/long-press.json

@@ -0,0 +1,13 @@
+{
+    "long-press": {
+        "ui": {
+            "name": "Name",
+            "time_for_long": "Time for long",
+            "time_for_long_placeholder": "Time in ms for a long press",
+            "milliseconds": "Milliseconds",
+            "output_messages": "Output messages",
+            "short": "Short",
+            "long": "Long"
+        }
+    }
+}

package/{long-press-control/long-press-control.html → long-press/long-press.html}

@@ -19,6 +19,8 @@
         },
         oneditprepare: function ()
         {
+            let node = this;
+
             $("#node-input-long_press_ms").spinner({
                 min: 1,
                 change: function (event, ui)
@@ -47,28 +49,22 @@
 
 <script type="text/html" data-template-name="smart_long-press-control">
     <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="long-press.ui.name"></span></label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]long-press.ui.name" />
     </div>
     <div class="form-row">
-        <label for="node-input-long_press_ms"><i class="fa fa-clock-o"></i> Zeit für lang</label>
-        <input id="node-input-long_press_ms" placeholder="Zeit in ms für einen langen Druck" />
-        <span> Millisekunden</span>
+        <label for="node-input-long_press_ms"><i class="fa fa-clock-o"></i><span data-i18n="long-press.ui.time_for_long"></span></label>
+        <input id="node-input-long_press_ms" data-i18n="[placeholder]long-press.ui.time_for_long_placeholder" />
+        <span data-i18n="long-press.ui.milliseconds"></span>
     </div>
     <hr/>
-    <h4 style="margin: 0.5rem 0;">Ausgangsnachrichten</h4>
+    <h4 style="margin: 0.5rem 0;" data-i18n="long-press.ui.output_messages"></h4>
     <div class="form-row">
-        <label for="node-input-short"><i class="fa fa-hand-o-up"></i> Kurz</label>
+        <label for="node-input-short"><i class="fa fa-hand-o-up"></i> <span data-i18n="long-press.ui.short"></span></label>
         <input type="text" id="node-input-short" />
     </div>
     <div class="form-row">
-        <label for="node-input-long"><i class="fa fa-hand-o-up"></i> Lang</label>
+        <label for="node-input-long"><i class="fa fa-hand-o-up"></i> <span data-i18n="long-press.ui.long"></span></label>
         <input type="text" id="node-input-long" />
     </div>
-</script>
-
-<script type="text/html" data-help-name="smart_long-press-control">
-    <p>Diese Node kann unterscheiden, wie lange ein Taster gedrückt wurde. Die Zeit, ab wann ein Tastendruck als lang gilt, kann in den Eigenschaften der Node eingestellt werden.</p>
-    <p>Ein langer Tastendruck wird sofort ausgelöst, wenn die maximal Zeit überschritten wurde.</p>
-    <p>Die Node misst die Zeit zwischen <code>msg.payload = true;</code> und <code>msg.payload = false;</code> und gibt eine entsprechende Nachricht aus.</p>
 </script>

package/long-press/long-press.js

@@ -0,0 +1,163 @@
+module.exports = function (RED)
+{
+    "use strict";
+
+    function LongPressControlNode(config)
+    {
+        const node = this;
+        RED.nodes.createNode(node, config);
+
+
+        // ###################
+        // # Class constants #
+        // ###################
+        const ACTION_SHORT = 0;
+        const ACTION_LONG = 1;
+
+
+        // #######################
+        // # Global help objects #
+        // #######################
+        const smart_context = require("../persistence.js")(RED);
+        const helper = require("../smart_helper.js");
+
+
+        // ##################
+        // # Dynamic config #
+        // ##################
+        let long_press_ms = parseInt(config.long_press_ms || 1000, 10);
+        let short = helper.evaluateNodeProperty(RED, config.short, "json");
+        let long = helper.evaluateNodeProperty(RED, config.long, "json");
+
+
+        // ##################
+        // # Runtime values #
+        // ##################
+
+        // The date when the button was pressed
+        let on_time = null;
+
+        // Here the setTimeout return value is stored to detect a long press.
+        let timeout = null;
+
+        // Save the last state of the long press, this isn't needed as persistant value
+        let last_action = null;
+
+
+        // ###############
+        // # Node events #
+        // ###############
+        node.on("input", function (msg)
+        {
+            handleTopic(msg);
+
+            setStatus();
+            // smart_context.set(node.id, node_settings);
+        });
+
+        node.on("close", function ()
+        {
+            stopAutoOff();
+        });
+
+        // #####################
+        // # Private functions #
+        // #####################
+
+        /**
+         * This is the main function which handles all topics that was received.
+         */
+        let handleTopic = msg =>
+        {
+            if (msg.payload)
+            {
+                on_time = Date.now();
+                startAutoLongPress();
+            }
+            else if (on_time != null)
+            {
+                const pressTime = Date.now() - on_time;
+                on_time = null;
+
+                // Stop if any timeout is set
+                stopAutoOff();
+
+                if (pressTime < long_press_ms)
+                {
+                    last_action = ACTION_SHORT;
+                    if (short != null)
+                        node.send([helper.cloneObject(short), null]);
+                }
+                else
+                {
+                    last_action = ACTION_LONG;
+                    if (long != null)
+                        node.send([null, helper.cloneObject(long)]);
+                }
+            }
+        }
+
+        /**
+         * Start timer to detect a long press
+         */
+        let startAutoLongPress = () =>
+        {
+            stopAutoOff();
+            timeout = setTimeout(() =>
+            {
+                last_action = ACTION_LONG;
+                on_time = null;
+                timeout = null;
+
+                node.send([null, helper.cloneObject(long)]);
+
+                setStatus();
+            }, long_press_ms);
+        };
+
+        /**
+         * Stop current runnting timer
+         */
+        let stopAutoOff = () =>
+        {
+            if (timeout != null)
+            {
+                clearTimeout(timeout);
+                timeout = null;
+            }
+        };
+
+
+        /**
+         * Set the current node status
+         */
+        let setStatus = () =>
+        {
+            if (timeout != null)
+            {
+                node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": Wait for button release..." });
+            }
+            else
+            {
+                switch (last_action)
+                {
+                    case ACTION_SHORT:
+                        node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Last was short" });
+                        break;
+
+                    case ACTION_LONG:
+                        node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Last was long" });
+                        break;
+
+                    default:
+                    case null:
+                        node.status({});
+                        break;
+                }
+
+            }
+        }
+    }
+
+    RED.nodes.registerType("smart_long-press-control", LongPressControlNode);
+}

package/mixing-valve/locales/de-DE/mixing-valve.html

@@ -0,0 +1,65 @@
+<script type="text/html" data-help-name="smart_mixing-valve">
+    <p>
+        Diese Node steuert einen Heizungsmischer. Dieser kann sowohl fürs Heizen als auch fürs Kühlen verwendet werden.
+        Nach der eingestellten Abtastzeit wird geprüft, ob die Position des Mischers korrigiert werden muss.
+    </p>
+    <p>
+        Beim ersten Verwenden wird eine Kalibrierungsfahrt gestartet. D.h. der Mischer schließt für die eingestellte Laufzeit und befindet sich dann auf 0%.
+        Danach kann der Mischvorgang starten. Die zuletzt angefahrene Position wird persistent gespeichert, wodurch weitere Kalibrierungsfahrten in der Regel nicht mehr notwending sind.
+    </p>
+    <p>
+        <b>Hinweis:</b> Smart Nodes verwenden Topics im Format <code>name#nummer</code>, damit können verschiedene Smart Nodes mit dem gleichen Topic angesteuert werden.<br/>
+        Diese Node verwendet nur den Teil <code>name</code>. <code>#</code> und <code>nummer</code> sind dabei optional.
+    </p>
+    <p>
+        Folgende topics werden akzeptiert:
+        <table>
+            <thead>
+                <tr>
+                    <th>Topic</th>
+                    <th>Beschreibung</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td><code>enable</code></td>
+                    <td>Aktiviert die Mischeransteuerung.</td>
+                </tr>
+                <tr>
+                    <td><code>disable</code></td>
+                    <td>Deaktiviert die Mischeransteuerung und fährt die Position an, die als Aus-Modus festgelegt ist.</td>
+                </tr>
+                <tr>
+                    <td><code>set_state</code></td>
+                    <td>Aktiviert das Weiterleiten, wenn <code>msg.payload = true</code> oder deaktiviert das Weiterleiten, wenn <code>msg.payload = false</code>.</td>
+                </tr>
+                <tr>
+                    <td><code>setpoint</code></td>
+                    <td>Überschreibt den Sollwert mit <code>msg.payload</code> °C.</td>
+                </tr>
+                <tr>
+                    <td><code>off_mode</code></td>
+                    <td>
+                        Überschreibt den Aus-Modus mit <code>msg.payload</code>.
+                        Gültige Werte für <code>msg.payload</code> sind <code>"NOTHING"</code>, <code>"OPEN"</code> und <code>"CLOSE"</code>.
+                    </td>
+                </tr>
+                <tr>
+                    <td><code>valve_mode</code></td>
+                    <td>
+                        Überschreibt den Modus mit <code>msg.payload</code>.
+                        Gültige Werte für <code>msg.payload</code> sind <code>"HEATING"</code> und <code>"COOLING"</code>.
+                    </td>
+                </tr>
+                <tr>
+                    <td><code>current_temperature</code></td>
+                    <td>Setzt die aktuelle Temperatur auf <code>msg.payload</code> °C.</td>
+                </tr>
+                <tr>
+                    <td><code>calibrate</code></td>
+                    <td>Erzwingt eine Kalibrierungsfahrt.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+</script>

package/mixing-valve/locales/de-DE/mixing-valve.json

@@ -0,0 +1,19 @@
+{
+    "mixing-valve": {
+        "ui": {
+            "name": "Name",
+            "enabled": "Aktiviert",
+            "setpoint": "Sollwert",
+            "runtime": "Laufzeit",
+            "sampling": "Abtastzeit",
+            "power_off": "Aus-Modus",
+            "mode": "Modus",
+
+            "nothing": "Nichts",
+            "open": "Öffnen (100%)",
+            "close": "Schließen (0%)",
+            "heating": "Heizen (normal)",
+            "cooling": "Kühlen (invertiert)"
+        }
+    }
+}

package/mixing-valve/locales/en-US/mixing-valve.html

@@ -0,0 +1,66 @@
+<script type="text/html" data-help-name="smart_mixing-valve">
+    <p>
+        This node controls a heating mixer. This can be used for both heating and cooling.
+        After the set sampling time, a check is made to see whether the position of the mixer needs to be corrected.
+    </p>
+    <p>
+        When used for the first time, a calibration run is started. This means that the mixer closes for the set running time and is then at 0%.
+        The mixing process can then start. The last position reached is saved persistently, which means that further calibration runs are generally no longer necessary.
+    </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>name</code> part. <code>#</code> and <code>number</code> are optional.
+    </p>
+    <p>
+        The following topics are accepted:
+        <table>
+            <thead>
+                <tr>
+                    <th>Topic</th>
+                    <th>Description</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td><code>enable</code></td>
+                    <td>Activates the mixer control.</td>
+                </tr>
+                <tr>
+                    <td><code>disable</code></td>
+                    <td>Deactivates the mixer control and moves to the position that is set as the off mode.</td>
+                </tr>
+                <tr>
+                    <td><code>set_state</code></td>
+                    <td>Activates forwarding if <code>msg.payload = true</code> or deactivates forwarding if
+                        <code>msg.payload = false</code>.</td>
+                </tr>
+                <tr>
+                    <td><code>setpoint</code></td>
+                    <td>Overrides the setpoint with <code>msg.payload</code> °C.</td>
+                </tr>
+                <tr>
+                    <td><code>off_mode</code></td>
+                    <td>
+                        Overrides the off mode with <code>msg.payload</code>.
+                        Valid values for <code>msg.payload</code> are <code>"NOTHING"</code>, <code>"OPEN"</code> and <code>"CLOSE"</code>.
+                    </td>
+                </tr>
+                <tr>
+                    <td><code>valve_mode</code></td>
+                    <td>
+                        Overrides the mode with <code>msg.payload</code>.
+                        Valid values for <code>msg.payload</code> are <code>"HEATING"</code> and <code>"COOLING"</code>.
+                    </td>
+                </tr>
+                <tr>
+                    <td><code>current_temperature</code></td>
+                    <td>Sets the current temperature to <code>msg.payload</code> °C.</td>
+                </tr>
+                <tr>
+                    <td><code>calibrate</code></td>
+                    <td>Forces a calibration run.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+</script>

package/mixing-valve/locales/en-US/mixing-valve.json

@@ -0,0 +1,19 @@
+{
+    "mixing-valve": {
+        "ui": {
+            "name": "Name",
+            "enabled": "Enabled",
+            "setpoint": "Setpoint",
+            "runtime": "Runtime",
+            "sampling": "Sampling",
+            "power_off": "Off mode",
+            "mode": "Mode",
+
+            "nothing": "Nothing",
+            "open": "Open (100%)",
+            "close": "Close (0%)",
+            "heating": "Heating (normal)",
+            "cooling": "Cooling (inverted)"
+        }
+    }
+}