smart-nodes 0.1.0

package/forwarder/forwarder.html

@@ -0,0 +1,100 @@
+<script type="text/javascript">
+    RED.nodes.registerType("smart_forwarder", {
+        category: "Smart Nodes",
+        paletteLabel: "Forwarder",
+        color: "#E2D96E",
+        defaults: {
+            name: { value: "" },
+            enabled: { value: true },
+            always_forward_true: { value: false },
+            always_forward_false: { value: false },
+            forward_last_on_enable: { value: false },
+            save_state: { value: true },
+            resend_on_start: { value: true }
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: "font-awesome/fa-forward",
+        label: function ()
+        {
+            return this.name || "Forwarder";
+        },
+        oneditprepare: function ()
+        {
+            $("#node-input-save_state").on("change", ev =>
+            {
+                if (ev.target.checked)
+                    $("#resend_on_start_row").show();
+                else
+                    $("#resend_on_start_row").hide();
+            });
+            $("#node-input-save_state").trigger("change");
+        },
+    });
+</script>
+
+<script type="text/html" data-template-name="smart_forwarder">
+    <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" />
+    </div>
+    <div class="form-row">
+        <input type="checkbox" id="node-input-enabled" style="width: 20px;" />
+        <span for="node-input-enabled" style="width: 200px;"> Aktiviert</span>
+    </div>
+    <div class="form-row">
+        <input type="checkbox" id="node-input-forward_last_on_enable" style="width: 20px;" />
+        <span for="node-input-forward_last_on_enable">Letzte nicht gesendete Nachricht senden, wenn die Node aktiviert wird.</span>
+    </div>
+    <div class="form-row">
+        <input type="checkbox" id="node-input-always_forward_true" style="width: 20px;" />
+        <span for="node-input-always_forward_true"><code>msg.payload = true</code> immer weiterleiten</span>
+    </div>
+    <div class="form-row">
+        <input type="checkbox" id="node-input-always_forward_false" style="width: 20px;" />
+        <span for="node-input-always_forward_false"><code>msg.payload = false</code> immer weiterleiten</span>
+    </div>
+    <hr/>
+    <h4 style="margin: 0.5rem 0;">Systemstart</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>
+    </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>
+    </div>
+</script>
+
+<script type="text/html" data-help-name="smart_forwarder">
+    <p>Diese Node leitet eine Nachricht weiter, wenn er enabled wurde oder das dauerhafte Weiterleiten für die Nachricht aktiviert ist.</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 das Weiterleiten.</td>
+                </tr>
+                <tr>
+                    <td><code>disable</code></td>
+                    <td>Deaktiviert das Weiterleiten.</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>
+            </tbody>
+        </table>
+    </p>
+</script>

package/forwarder/forwarder.js

@@ -0,0 +1,95 @@
+module.exports = function (RED)
+{
+    function ForwarderNode(config)
+    {
+        const node = this;
+        RED.nodes.createNode(node, config);
+
+        const smartContext = require("../persistence.js")(RED);
+        const helper = require("../smart_helper.js");
+
+        var nodeSettings = {
+            enabled: config.enabled,
+            lastMessage: null,
+            last_msg_was_sended: true
+        };
+
+        if (config.save_state)
+        {
+            // load old saved values
+            nodeSettings = Object.assign(nodeSettings, smartContext.get(node.id));
+        }
+        else
+        {
+            // delete old saved values
+            smartContext.del(node.id);
+        }
+
+        // dynamic config
+        let forwardTrue = config.always_forward_true;
+        let forwardFalse = config.always_forward_false;
+        let forward_last_on_enable = config.forward_last_on_enable;
+
+        // runtime values
+
+
+        node.on("input", function (msg)
+        {
+            let newState = null;
+            if (msg.topic == "enable" || (msg.topic == "set_state" && msg.payload))
+                newState = true;
+            else if (msg.topic == "disable" || (msg.topic == "set_state" && !msg.payload))
+                newState = false;
+
+            // Already the correct state
+            if (newState != null && nodeSettings.enabled == newState)
+                return;
+
+            switch (newState)
+            {
+                case true:
+                case false:
+                    nodeSettings.enabled = newState;
+
+                    if (config.save_state)
+                        smartContext.set(node.id, nodeSettings);
+
+                    if (nodeSettings.enabled && forward_last_on_enable && nodeSettings.lastMessage != null && !nodeSettings.last_msg_was_sended)
+                    {
+                        node.send(nodeSettings.lastMessage);
+                        nodeSettings.last_msg_was_sended = true;
+                    }
+
+                    setStatus();
+                    break;
+
+                default:
+                    // Forward if enabled or forced
+                    if (nodeSettings.enabled || (forwardTrue && msg.payload) || (forwardFalse && !msg.payload))
+                    {
+                        node.send(msg);
+                        nodeSettings.last_msg_was_sended = true;
+                    }
+                    else
+                    {
+                        nodeSettings.last_msg_was_sended = false;
+                    }
+
+                    nodeSettings.lastMessage = msg;
+                    break;
+            }
+        });
+
+        let setStatus = () =>
+        {
+            if (nodeSettings.enabled)
+                node.status({ fill: "green", shape: "dot", text: "Forwarding enabled" });
+            else
+                node.status({ fill: "red", shape: "dot", text: "Forwarding disabled" });
+        }
+
+        setStatus();
+    }
+
+    RED.nodes.registerType("smart_forwarder", ForwarderNode);
+}

package/hysteresis/hysteresis.html

@@ -0,0 +1,152 @@
+<script type="text/javascript">
+    RED.nodes.registerType("smart_hysteresis", {
+        category: "Smart Nodes",
+        paletteLabel: "Hysteresis",
+        color: "#E2D96E",
+        defaults: {
+            name: { value: "" },
+            setpoint: { value: 10 },
+            hysteresis: { value: 1 },
+            out_higher: { value: '{"topic": ""}' },
+            out_higher_type: { value: 'json' },
+            out_lower: { value: '{"topic": ""}' },
+            out_lower_type: { value: 'json' },
+            save_state: { value: true },
+            resend_on_start: { value: true }
+        },
+        inputs: 1,
+        outputs: 2,
+        outputLabels: ["Über", "Unter"],
+        icon: "font-awesome/fa-arrows-v",
+        label: function ()
+        {
+            return this.name || this.comparator || "Hysteresis";
+        },
+        oneditprepare: function ()
+        {
+            $("#node-input-setpoint").typedInput({
+                type: "num",
+                types: ["num"]
+            });
+
+            $("#node-input-hysteresis").typedInput({
+                type: "num",
+                types: ["num"]
+            });
+
+            $("#node-input-out_higher").typedInput({
+                type: "json",
+                types: ["json", {
+                    value: "null",
+                    label: "Originalnachricht",
+                    icon: "fa fa-times",
+                    hasValue: false,
+                }],
+                typeField: "#node-input-out_higher_type"
+            });
+
+            $("#node-input-out_lower").typedInput({
+                type: "json",
+                types: ["json", {
+                    value: "null",
+                    label: "Originalnachricht",
+                    icon: "fa fa-times",
+                    hasValue: false,
+                }],
+                typeField: "#node-input-out_lower_type"
+            });
+
+            $("#node-input-save_state").on("change", ev =>
+            {
+                if (ev.target.checked)
+                    $("#resend_on_start_row").show();
+                else
+                    $("#resend_on_start_row").hide();
+            });
+            $("#node-input-save_state").trigger("change");
+        },
+        oneditsave: function ()
+        {
+            this.setpoint = parseFloat(this.setpoint);
+            this.hysteresis = parseFloat(this.hysteresis);
+        }
+    });
+</script>
+
+<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" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-setpoint"><i class="fa fa-sign-out"></i> Sollwert</label>
+        <input id="node-input-setpoint" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-hysteresis"><i class="fa fa-sort"></i> Hysterese</label>
+        <input id="node-input-hysteresis" />
+    </div>
+    <hr/>
+    <h4 style="margin: 0.5rem 0;">Ausgangsnachrichten</h4>
+    <div class="form-row">
+        <label for="node-input-out_higher"><i class="fa fa-arrow-up"></i> Über</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>
+        <input type="text" id="node-input-out_lower" />
+        <input type="hidden" id="node-input-out_lower_type">
+    </div>
+    <hr/>
+    <h4 style="margin: 0.5rem 0;">Systemstart</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>
+    </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>
+    </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>
+                <tr>
+                    <td><code>resend</code></td>
+                    <td>Sendet den aktuellen Zustand erneut.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+    <p>
+        Die einkommende Nachricht wird mit den angegebenen Ausgangsnachrichten ergänzt, sofern nicht Originalnachricht ausgewählt wurde.
+    </p>
+</script>

package/hysteresis/hysteresis.js

@@ -0,0 +1,146 @@
+
+module.exports = function (RED)
+{
+    function HysteresisNode(config)
+    {
+        const node = this;
+        RED.nodes.createNode(node, config);
+
+        const smartContext = require("../persistence.js")(RED);
+        const helper = require("../smart_helper.js");
+
+        var nodeSettings = {
+            active: null,
+            lastMessage: null,
+        };
+
+        if (config.save_state)
+        {
+            // load old saved values
+            nodeSettings = Object.assign(nodeSettings, smartContext.get(node.id));
+
+            switch (nodeSettings.active)
+            {
+                case true:
+                    node.status({ fill: "yellow", shape: "ring", text: "Load last state: Higher" });
+                    break;
+
+                case false:
+                    node.status({ fill: "yellow", shape: "ring", text: "Load last state: Lower" });
+                    break;
+
+                default:
+                    node.status({ fill: "yellow", shape: "ring", text: "No last state available" });
+                    break;
+            }
+        }
+        else
+        {
+            // delete old saved values
+            node.status({});
+            smartContext.del(node.id);
+        }
+
+        // dynamic config
+        let setpoint = parseFloat(config.setpoint);
+        let hysteresis = parseFloat(config.hysteresis);
+        let out_higher = helper.evaluateNodeProperty(RED, config.out_higher, config.out_higher_type);
+        let out_lower = helper.evaluateNodeProperty(RED, config.out_lower, config.out_lower_type);
+
+        // runtime values
+
+        node.on("input", function (msg)
+        {
+            let value = parseFloat(msg.payload);
+            let realTopic = helper.getTopicName(msg.topic);
+
+            if (isNaN(value) && realTopic !== "resend")
+            {
+                // node.error("Invalid payload: " + msg.payload);
+                return;
+            }
+
+            switch (realTopic)
+            {
+                case "setpoint":
+                    setpoint = value;
+                    node.status({ fill: "yellow", shape: "ring", text: "New setpoint: " + value });
+
+                    if (config.save_state)
+                        smartContext.set(node.id, nodeSettings);
+                    break;
+
+                case "hysteresis":
+                    hysteresis = value;
+                    node.status({ fill: "yellow", shape: "ring", text: "New hysteresis: " + value });
+
+                    if (config.save_state)
+                        smartContext.set(node.id, nodeSettings);
+                    break;
+
+                case "resend":
+                    if (nodeSettings.active === true && nodeSettings.lastMessage != null)
+                    {
+                        node.status({ fill: "green", shape: "dot", text: "Resend higher value " });
+                        node.send([nodeSettings.lastMessage, null]);
+                    }
+                    else if (nodeSettings.active === false && nodeSettings.lastMessage != null)
+                    {
+                        node.status({ fill: "green", shape: "dot", text: "Resend lower value " });
+                        node.send([null, nodeSettings.lastMessage]);
+                    }
+                    else
+                    {
+                        node.status({ fill: "green", shape: "dot", text: "No resend, state is unknown" });
+                    }
+                    break;
+
+                default:
+                    if (value >= setpoint + hysteresis && nodeSettings.active !== true)
+                    {
+                        node.status({ fill: "green", shape: "dot", text: "Turned higher by value " + value });
+                        nodeSettings.active = true;
+                        nodeSettings.lastMessage = out_higher ?? msg;
+
+                        if (config.save_state)
+                            smartContext.set(node.id, nodeSettings);
+
+                        node.send([nodeSettings.lastMessage, null]);
+                    }
+                    else if (value <= setpoint - hysteresis && nodeSettings.active !== false)
+                    {
+                        node.status({ fill: "green", shape: "dot", text: "Turned lower by value " + value });
+                        nodeSettings.active = false;
+                        nodeSettings.lastMessage = out_lower ?? msg;
+
+                        if (config.save_state)
+                            smartContext.set(node.id, nodeSettings);
+
+                        node.send([null, nodeSettings.lastMessage]);
+                    }
+                    else
+                    {
+                        node.status({ fill: "yellow", shape: "ring", text: "No change by value " + value });
+                    }
+                    break;
+            }
+        });
+
+        node.on("close", function ()
+        {
+        });
+
+        if (config.save_state && config.resend_on_start && nodeSettings.active && nodeSettings.lastMessage != null)
+        {
+            setTimeout(() =>
+            {
+                if (nodeSettings.active)
+                    node.send([nodeSettings.lastMessage, null]);
+                else
+                    node.send([null, nodeSettings.lastMessage]);
+            }, 10000);
+        }
+    }
+
+    RED.nodes.registerType("smart_hysteresis", HysteresisNode);
+}