smart-nodes 0.3.36 → 0.4.0

package/delay/delay.js

@@ -9,9 +9,22 @@ 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 = {
             on_delay_ms: helper.getTimeInMs(config.on_delay, config.on_delay_unit),
             off_delay_ms: helper.getTimeInMs(config.off_delay, config.off_delay_unit),
@@ -45,16 +58,58 @@ module.exports = function (RED)
             smart_context.del(node.id);
         }
 
-        // dynamic config
+
+        // ##################
+        // # Dynamic config #
+        // ##################
         let delay_only_on_change = config.delay_only_on_change;
 
-        // runtime values
+
+        // ##################
+        // # Runtime values #
+        // ##################
+
+        // Here the setTimeout return value is stored to send the delayed message.
         let timeout = null;
+
+        // Saves the next payload that needs to be send.
+        // This is used to avoid restarting the timeout for the same payload.
         let next_payload = null;
 
+
+        // ###############
+        // # Node events #
+        // ###############
         node.on("input", function (msg)
         {
-            switch (msg.topic)
+            handleTopic(msg);
+
+            // setStatus();
+
+            if (config.save_state)
+                smart_context.set(node.id, node_settings);
+        });
+
+        node.on("close", function ()
+        {
+            if (timeout != null)
+            {
+                clearTimeout(timeout);
+                timeout = null;
+            }
+        });
+
+
+        // #####################
+        // # Private functions #
+        // #####################
+
+        // This is the main function which handles all topics that was received.
+        let handleTopic = msg =>
+        {
+            let real_topic = helper.getTopicName(msg.topic);
+
+            switch (real_topic)
             {
                 case "set_delay_on":
                     node_settings.on_delay_ms = helper.getTimeInMsFromString(msg.payload);
@@ -85,16 +140,7 @@ module.exports = function (RED)
                     send(msg);
                     break;
             }
-        });
-
-        node.on("close", function ()
-        {
-            if (timeout != null)
-            {
-                clearTimeout(timeout);
-                timeout = null;
-            }
-        });
+        }
 
         let send = msg =>
         {
@@ -144,10 +190,7 @@ module.exports = function (RED)
                 node.status({ fill: "yellow", shape: "dot", text: helper.getCurrentTimeForStatus() + ": " + "Sended " + getMessageStatusText(msg) });
                 node_settings.last_message = helper.cloneObject(msg);
 
-                if (config.save_state)
-                    smart_context.set(node.id, node_settings);
-
-                node.send(msg);
+                node.send(node_settings.last_message);
                 return;
             }
 
@@ -159,10 +202,10 @@ module.exports = function (RED)
                 node.status({ fill: "yellow", shape: "dot", text: helper.getCurrentTimeForStatus() + ": " + "Sended " + getMessageStatusText(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.send(msg);
             }, delay_ms);
         }
 
@@ -185,7 +228,7 @@ module.exports = function (RED)
             setTimeout(() =>
             {
                 node.status({ fill: "yellow", shape: "dot", text: helper.getCurrentTimeForStatus() + ": " + "Sended " + getMessageStatusText(node_settings.last_message) });
-                node.send(node_settings.last_message);
+                node.send(helper.cloneObject(node_settings.last_message));
             }, 10000);
         }
     }

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

@@ -0,0 +1,71 @@
+<script type="text/html" data-help-name="smart_delay">
+    <p>Diese Node kann dazu verwendet werden ein Ein- oder Ausschaltsignal zu verzögern.</p>
+    <p>Die Zeit 0 bedeutet keine Verögerung.</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>set_delay_on</code></td>
+                    <td>Setzt die Einschaltverzögerung auf die in <code>msg.payload</code> angegebene Zeit.</td>
+                </tr>
+                <tr>
+                    <td><code>set_delay_off</code></td>
+                    <td>Setzt die Ausschaltverzögerung auf die in <code>msg.payload</code> angegebene Zeit.</td>
+                </tr>
+                <tr>
+                    <td><code>set_delays</code></td>
+                    <td>Setzt die Ein- und Ausschaltverzögerung auf die in <code>msg.payload</code> angegebene Zeit.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+    <p>
+        Beispiel: <code>msg = { "topic": "set_delay_on", "payload": 5000 }</code> oder <code>msg = { "topic": "set_delay_on", "payload": "5s" }</code><br/>
+        Diese Nachricht setzt die Einschaltverzögerung auf 5000 Millisekunden / 5 Sekunden.
+        Ist die Zeit auf 0 eingestellt, wird die Nachricht sofort weitergeleitet.<br/>
+        Als Einheit für die Zeit können folgende Werte verwendet werden:
+        <table>
+            <thead>
+                <tr>
+                    <th>Einheit</th>
+                    <th>Beschreibung</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td><code>ms</code> (default)</td>
+                    <td>Millisekunden</td>
+                </tr>
+                <tr>
+                    <td><code>s</code> oder <code>sec</code></td>
+                    <td>Sekunden</td>
+                </tr>
+                <tr>
+                    <td><code>m</code> oder <code>min</code></td>
+                    <td>Mintun.</td>
+                </tr>
+                <tr>
+                    <td><code>h</code></td>
+                    <td>Stunden</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+    <p>
+        Wenn die Checkbox <b>Nur verzögern, wenn sich <code>msg.payload</code> verändert hat.</b> aktiviert ist
+        und während dem Warten um ein Einschaltsignal weiterzuleiten ein Ausschaltsignal empfangen wird,
+        so wird das Senden des Einschaltsignals abgebrochen. Dies gilt auch für den umgekehrten Fall.<br/>
+        Ist die Checkbox nicht aktiviert, wird jede Nachricht verzögert, sofern nicht bereits eine Verzögerung für den gleichen <code>payload</code> aktiv ist.
+    </p>
+</script>

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

@@ -0,0 +1,19 @@
+{
+    "delay": {
+        "ui": {
+            "name": "Name",
+
+            "on_delay": "Einschalt- verzögerung",
+            "off_delay": "Ausschalt- verzögerung",
+            "delay_only_on_change": "Nur verzögern, wenn sich <code>msg.payload</code> verändert hat.",
+            "system_start": "Systemstart",
+            "save_state": "Zustand speichern",
+            "send_after_start": "Letze Nachricht 10 Sekunden nach dem Start senden",
+
+            "milliseconds": "Millisekunden",
+            "seconds": "Sekunden",
+            "minutes": "Minuten",
+            "hours": "Stunden"
+        }
+    }
+}

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

@@ -0,0 +1,76 @@
+<script type="text/html" data-help-name="smart_delay">
+    <p>This node can be used to delay an on or off signal.</p>
+    <p>The time 0 means no delay.</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 part <code>name</code>. <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>set_delay_on</code></td>
+                    <td>Sets the on delay to the time specified in <code>msg.payload</code>.</td>
+                </tr>
+                <tr>
+                    <td><code>set_delay_off</code></td>
+                    <td>Sets the off delay to the time specified in <code>msg.payload</code>.</td>
+                </tr>
+                <tr>
+                    <td><code>set_delays</code></td>
+                    <td>Sets the on and off delay to the time specified in <code>msg.payload</code> Time.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+    <p>
+        Example: <code>msg = { "topic": "set_delay_on", "payload": 5000 }</code> or <code>msg = { "topic": "set_delay_on", "payload": "5s" }</code><br />
+        This message sets the power-on delay to 5000 milliseconds / 5 seconds.
+        If the time is set to 0, the message is forwarded immediately.<br />
+        The following values can be used as a unit for time:
+        <table>
+            <thead>
+                <tr>
+                    <th>Unit</th>
+                    <th>Description</th>
+                </tr>
+            </thead>
+            <tbody>
+                <tr>
+                    <td><code>ms</code> (default)</td>
+                    <td>Milliseconds</td>
+                </tr>
+                <tr>
+                    <td><code>s</code> or <code>sec</code></td>
+                    <td>Seconds</td>
+                </tr>
+                <tr>
+                    <td><code>m</code> or <code>min</code></td>
+                    <td>Mintun.</td>
+                </tr>
+                <tr>
+                    <td><code>h</code></td>
+                    <td>Hours</td>
+                </tr>
+            </tbody>
+
+        </table>
+
+    </p>
+
+    <p>
+        If the checkbox <b>Only delay if <code>msg.payload</code> has changed.</b> is activated
+        and a shutdown signal is received while waiting to forward a power-on signal,
+        the sending of the power-on signal is aborted. This also applies in the opposite case.<br />
+        If the checkbox is not activated, every message is delayed unless a delay is already active for the same
+        <code>payload</code>.
+
+    </p>
+</script>

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

@@ -0,0 +1,19 @@
+{
+    "delay": {
+        "ui": {
+            "name": "Name",
+
+            "on_delay": "Switch-on delay",
+            "off_delay": "Switch-off- delay",
+            "delay_only_on_change": "Only delay if <code>msg.payload</code> has changed.",
+            "system_start": "System start",
+            "save_state": "Save state",
+            "send_after_start": "Send last message 10 seconds after the start",
+
+            "milliseconds": "Milliseconds",
+            "seconds": "Seconds",
+            "minutes": "Minutes",
+            "hours": "Hours"
+        }
+    }
+}

package/forwarder/forwarder.html

@@ -21,6 +21,8 @@
         },
         oneditprepare: function ()
         {
+            let node = this;
+
             $("#node-input-save_state").on("change", ev =>
             {
                 if (ev.target.checked)
@@ -35,66 +37,33 @@
 
 <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" />
+        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="forwarder.ui.name"></span></label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]forwarder.ui.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>
+        <label for="node-input-enabled" style="width: 200px;"> <span data-i18n="forwarder.ui.enabled"></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>
+        <label for="node-input-forward_last_on_enable" data-i18n="forwarder.ui.forward_last_on_enable"></label>
     </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>
+        <label for="node-input-always_forward_true" data-i18n="[html]forwarder.ui.always_forward_true"></label>
     </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>
+        <label for="node-input-always_forward_false" data-i18n="[html]forwarder.ui.always_forward_false"></label>
     </div>
     <hr/>
-    <h4 style="margin: 0.5rem 0;">Systemstart</h4>
+    <h4 style="margin: 0.5rem 0;" data-i18n="forwarder.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="forwarder.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="forwarder.ui.send_after_start"></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

@@ -7,40 +7,84 @@ 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 = {
             enabled: config.enabled,
             last_message: null,
             last_msg_was_sended: true
         };
 
+        // 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 forward_true = config.always_forward_true;
         let forward_false = config.always_forward_false;
         let forward_last_on_enable = config.forward_last_on_enable;
 
-        // 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 ()
+        {
+            if (timeout != null)
+            {
+                clearTimeout(timeout);
+                timeout = null;
+            }
+        });
+
+
+        // #####################
+        // # Private functions #
+        // #####################
+
+        // This is the main function which handles all topics that was received.
+        let handleTopic = msg =>
+        {
+            let real_topic = helper.getTopicName(msg.topic);
+
             let new_state = null;
-            if (msg.topic == "enable" || (msg.topic == "set_state" && msg.payload))
+            if (real_topic == "enable" || (real_topic == "set_state" && msg.payload))
                 new_state = true;
-            else if (msg.topic == "disable" || (msg.topic == "set_state" && !msg.payload))
+            else if (real_topic == "disable" || (real_topic == "set_state" && !msg.payload))
                 new_state = false;
 
             // Already the correct state
@@ -53,12 +97,9 @@ module.exports = function (RED)
                 case false:
                     node_settings.enabled = new_state;
 
-                    if (config.save_state)
-                        smart_context.set(node.id, node_settings);
-
                     if (node_settings.enabled && forward_last_on_enable && node_settings.last_message != null && !node_settings.last_msg_was_sended)
                     {
-                        node.send(node_settings.last_message);
+                        node.send(helper.cloneObject(node_settings.last_message));
                         node_settings.last_msg_was_sended = true;
                     }
 
@@ -69,7 +110,7 @@ module.exports = function (RED)
                     // Forward if enabled or forced
                     if (node_settings.enabled || (forward_true && msg.payload) || (forward_false && !msg.payload))
                     {
-                        node.send(msg);
+                        node.send(helper.cloneObject(msg));
                         node_settings.last_msg_was_sended = true;
                     }
                     else
@@ -77,10 +118,10 @@ module.exports = function (RED)
                         node_settings.last_msg_was_sended = false;
                     }
 
-                    node_settings.last_message = helper.cloneObject(msg);;
+                    node_settings.last_message = helper.cloneObject(msg);
                     break;
             }
-        });
+        }
 
         let setStatus = () =>
         {
@@ -94,7 +135,7 @@ module.exports = function (RED)
         {
             setTimeout(() =>
             {
-                node.send(node_settings.last_message);
+                node.send(helper.cloneObject(node_settings.last_message));
             }, 10000);
         }
 

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

@@ -0,0 +1,32 @@
+<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/locales/de-DE/forwarder.json

@@ -0,0 +1,15 @@
+{
+    "forwarder": {
+        "ui": {
+            "name": "Name",
+            "enabled": "Aktiviert",
+            "forward_last_on_enable": "Letzte nicht gesendete Nachricht senden, wenn die Node aktiviert wird.",
+            "always_forward_true": "Leite <code>msg.payload = true</code> immer weiter.",
+            "always_forward_false": "Leite <code>msg.payload = false</code> immer weiter.",
+
+            "system_start": "Systemstart",
+            "save_state": "Zustand speichern",
+            "send_after_start": "Letze Nachricht 10 Sekunden nach dem Start senden"
+        }
+    }
+}

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

@@ -0,0 +1,32 @@
+<script type="text/html" data-help-name="smart_forwarder">
+    <p>This node forwards a message if it has been enabled or if permanent forwarding is activated for the message.</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 part <code>name</code>. <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>Enables forwarding.</td>
+                </tr>
+                <tr>
+                    <td><code>disable</code></td>
+                    <td>Disables forwarding.</td>
+                </tr>
+                <tr>
+                    <td><code>set_state</code></td>
+                    <td>Enables forwarding if <code>msg.payload = true</code> or disables forwarding if <code>msg.payload = false</code>.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+</script>

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

@@ -0,0 +1,15 @@
+{
+    "forwarder": {
+        "ui": {
+            "name": "Name",
+            "enabled": "Enabled",
+            "forward_last_on_enable": "Send last unsent message when node is activated.",
+            "always_forward_true": "Always forward <code>msg.payload = true</code> .",
+            "always_forward_false": "Always forward <code>msg.payload = false</code> .",
+
+            "system_start": "System start",
+            "save_state": "Save state",
+            "send_after_start": "Send last message 10 seconds after the start"
+        }
+    }
+}