smart-nodes 0.3.37 → 0.4.1

package/{scene-control/scene-control.js → scene/scene.js}

@@ -7,29 +7,62 @@ 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");
 
-        // used from text-exec node
+
+        // ############################
+        // # Used from text-exec node #
+        // ############################
         if (typeof config.exec_text_names == "string")
             node.exec_text_names = config.exec_text_names.split(",").map(n => n.trim().toLowerCase());
         else
             node.exec_text_names = [];
 
-        // persistent values
-        var node_settings = Object.assign({}, {
+
+        // #####################
+        // # persistent values #
+        // #####################
+        var node_settings = helper.cloneObject({
             last_values: [], // light is on or off for a scene
         }, smart_context.get(node.id));
 
-        // dynamic config
+
+        // ##################
+        // # Dynamic config #
+        // ##################
         let max_time_on = helper.getTimeInMs(config.max_time_on, config.max_time_on_unit);
 
-        // runtime values
-        let max_time_on_timeout = null;
+        // ##################
+        // # Runtime values #
+        // ##################
+
+        // Here the setTimeout return value is stored to turn off the light.
+        // That means if it is null, the light will not be turned off automatically.
+        let timeout = null;
+
+        // If isPermanent is true, then a default on time value is ignored
+        // Also if the motion sensor turns off, no timeout is started.
         let isPermanent = false;
-        let current_timeout_ms = 0;
 
-        // central handling
+
+        // Here the date is stored, when the light should go off.
+        // This is used to calculate the node status.
+        let timeout_end_date = null;
+
+
+        // #########################
+        // # Central node handling #
+        // #########################
         var event = "node:" + config.id;
         var handler = function (msg)
         {
@@ -38,14 +71,14 @@ module.exports = function (RED)
         RED.events.on(event, handler);
 
 
+        // Per default expect that all outputs are off
         if (node_settings.last_values.length != config.scenes.length)
-        {
-            // Per default expect that all outputs are off
             node_settings.last_values = new Array(config.outputs).fill(false);
-        }
 
-        node.status({});
 
+        // ###############
+        // # Node events #
+        // ###############
         node.on("input", function (msg)
         {
             handleTopic(msg);
@@ -54,7 +87,7 @@ module.exports = function (RED)
             if (getCurrentScene() != 0)
                 startAutoOffIfNeeded(helper.getTimeInMsFromString(msg.time_on ?? max_time_on));
 
-            status();
+            setStatus();
             smart_context.set(node.id, node_settings);
         });
 
@@ -64,6 +97,12 @@ module.exports = function (RED)
             RED.events.off(event, handler);
         });
 
+
+        // #####################
+        // # Private functions #
+        // #####################
+
+        // This is the main function which handles all topics that was received.
         let handleTopic = msg =>
         {
             let currentScene = getCurrentScene();
@@ -211,7 +250,16 @@ module.exports = function (RED)
                 timeMs = max_time_on;
             }
 
-            current_timeout_ms = timeMs;
+            // calculate end date for status message
+            if (timeMs > 0)
+            {
+                timeout_end_date = new Date();
+                timeout_end_date.setMilliseconds(timeout_end_date.getMilliseconds() + timeMs);
+            }
+            else
+            {
+                timeout_end_date = null;
+            }
 
             // Stop if any timeout is set
             stopAutoOff();
@@ -220,35 +268,36 @@ module.exports = function (RED)
             if (timeMs <= 0 || isPermanent || getCurrentScene() == 0)
                 return;
 
-            max_time_on_timeout = setTimeout(() =>
+            timeout = setTimeout(() =>
             {
+                timeout = null;
                 node_settings.last_values = new Array(config.outputs).fill(false);
                 node.send(node_settings.last_values.map(val => { return { payload: val }; }));
                 notifyCentral();
 
-                status();
+                setStatus();
                 smart_context.set(node.id, node_settings);
             }, timeMs);
         }
 
         let stopAutoOff = () =>
         {
-            if (max_time_on_timeout != null)
+            if (timeout != null)
             {
-                clearTimeout(max_time_on_timeout);
-                max_time_on_timeout = null;
+                clearTimeout(timeout);
+                timeout = null;
             }
         }
 
-        let status = () =>
+        let setStatus = () =>
         {
             let scene = getCurrentScene();
             if (scene != 0)
             {
-                if (isPermanent || current_timeout_ms <= 0)
+                if (isPermanent || timeout_end_date == null)
                     node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Scene " + scene + " active" });
-                else if (max_time_on_timeout)
-                    node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": Scene " + scene + " active, wait " + helper.formatMsToStatus(current_timeout_ms, "until") + " for auto off" });
+                else if (timeout)
+                    node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": Scene " + scene + " active, wait " + helper.formatDateToStatus(timeout_end_date, "until") + " for auto off" });
             }
             else
             {
@@ -265,8 +314,8 @@ module.exports = function (RED)
 
             config.links.forEach(link =>
             {
-                // console.log(node.id + " -> " + link);
-                // console.log({ source: node.id, state: state });
+                helper.log(node.id + " -> " + link);
+                helper.log({ source: node.id, state: state });
                 RED.events.emit("node:" + link, { source: node.id, state: state });
             });
         }
@@ -275,7 +324,8 @@ module.exports = function (RED)
         if (getCurrentScene() != 0)
             startAutoOffIfNeeded(helper.getTimeInMsFromString(max_time_on));
 
-        status();
+        setStatus();
     }
+
     RED.nodes.registerType("smart_scene-control", SceneControlNode);
 };

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

@@ -0,0 +1,30 @@
+<script type="text/html" data-help-name="smart_scheduler">
+    <p>
+        Diese Node sendet zu den angegebenen Zeitpunkten die entsprechenden Nachrichten an den Ausgang.
+    </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 den Scheduler.</td>
+                </tr>
+                <tr>
+                    <td><code>disable</code></td>
+                    <td>Deaktiviert den Scheduler.</td>
+                </tr>
+                <tr>
+                    <td><code>set_state</code></td>
+                    <td>Aktiviert den Scheduler, wenn <code>msg.payload = true</code> oder deaktiviert den Scheduler, wenn <code>msg.payload = false</code>.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+</script>

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

@@ -0,0 +1,21 @@
+{
+    "scheduler": {
+        "ui": {
+            "name": "Name",
+            "scheduler_enabled": "Scheduler aktiviert",
+            "schedules": "Schedules",
+
+            "system_start": "Systemstart",
+            "save_state": "Zustand speichern",
+            "send_after_start": "Letze Nachricht 10 Sekunden nach dem Start senden",
+
+            "monday": "Montag",
+            "tuesday": "Dienstag",
+            "wednesday": "Mittwoch",
+            "thursday": "Donnerstag",
+            "friday": "Freitag",
+            "saturday": "Samstag",
+            "sunday": "Sonntag"
+        }
+    }
+}

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

@@ -0,0 +1,30 @@
+<script type="text/html" data-help-name="smart_scheduler">
+    <p>
+        This node sends the corresponding messages to the output at the specified times.
+    </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 the scheduler.</td>
+                </tr>
+                <tr>
+                    <td><code>disable</code></td>
+                    <td>Disables the scheduler.</td>
+                </tr>
+                <tr>
+                    <td><code>set_state</code></td>
+                    <td>Enables the scheduler if <code>msg.payload = true</code> or disables the scheduler if <code>msg.payload = false</code>.</td>
+                </tr>
+            </tbody>
+        </table>
+    </p>
+</script>

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

@@ -0,0 +1,21 @@
+{
+    "scheduler": {
+        "ui": {
+            "name": "Name",
+            "scheduler_enabled": "Scheduler enabled",
+            "schedules": "Schedules",
+
+            "system_start": "System start",
+            "save_state": "Save state",
+            "send_after_start": "Send last message 10 seconds after start",
+
+            "monday": "Monday",
+            "tuesday": "Tuesday",
+            "wednesday": "Wednesday",
+            "thursday": "Thursday",
+            "friday": "Friday",
+            "saturday": "Saturday",
+            "sunday": "Sunday"
+        }
+    }
+}

package/scheduler/scheduler.html

@@ -1,31 +1,3 @@
-<script type="text/html" data-template-name="smart_scheduler">
-    <div class="form-row">
-        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="node-red:common.label.name"></span></label>
-        <input type="text" id="node-input-name" data-i18n="[placeholder]node-red:common.label.name" />
-    </div>
-    <div class="form-row">
-        <label for="node-input-enabled"></label>
-        <input type="checkbox" id="node-input-enabled" style="width: 20px;" />
-        <label for="node-input-enabled" style="width: 200px;">Scheduler aktiviert</label>
-    </div>
-    <div class="form-row" style="margin-bottom: 2px;">
-        <p class="text-center"><i class="fa fa-list"></i>&nbsp;<strong>Schedules</strong></p>
-    </div>
-    <div class="form-row node-scheduler-schedules-row">
-        <ol id="node-scheduler-schedules"></ol>
-    </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-template-scheduler-row="">
     <div>
         <div style="display: inline-block; width: 30px; margin-left: 10px;">
@@ -224,13 +196,13 @@
                                 default: "",
                                 multiple: true,
                                 options: [
-                                    { value: "1", label: "Montag" },
-                                    { value: "2", label: "Dienstag" },
-                                    { value: "3", label: "Mittwoch" },
-                                    { value: "4", label: "Donnerstag" },
-                                    { value: "5", label: "Freitag" },
-                                    { value: "6", label: "Samstag" },
-                                    { value: "0", label: "Sonntag" }
+                                    { value: "1", label: node._("scheduler.ui.monday") },
+                                    { value: "2", label: node._("scheduler.ui.tuesday") },
+                                    { value: "3", label: node._("scheduler.ui.wednesday") },
+                                    { value: "4", label: node._("scheduler.ui.thursday") },
+                                    { value: "5", label: node._("scheduler.ui.friday") },
+                                    { value: "6", label: node._("scheduler.ui.saturday") },
+                                    { value: "0", label: node._("scheduler.ui.sunday") }
                                 ],
                             },
                         ],
@@ -296,6 +268,7 @@
         oneditsave: function ()
         {
             let node = this;
+            
             node.schedules = [];
 
             let scheduleList = $("#node-scheduler-schedules");
@@ -327,33 +300,30 @@
     });
 </script>
 
-<script type="text/html" data-help-name="smart_scheduler">
-    <p>
-        Diese Node sendet zu den angegebenen Zeitpunkten die entsprechenden Nachrichten an den Ausgang.
-        <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 den Scheduler.</td>
-                    </tr>
-                    <tr>
-                        <td><code>disable</code></td>
-                        <td>Deaktiviert den Scheduler.</td>
-                    </tr>
-                    <tr>
-                        <td><code>set_state</code></td>
-                        <td>Aktiviert den Scheduler, wenn <code>msg.payload = true</code> oder deaktiviert den Scheduler, wenn <code>msg.payload = false</code>.</td>
-                    </tr>
-                </tbody>
-            </table>
-        </p>
-        </p>
+<script type="text/html" data-template-name="smart_scheduler">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="scheduler.ui.name"></span></label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]scheduler.ui.name" />
+    </div>
+    <div class="form-row">
+        <label for="node-input-enabled"></label>
+        <input type="checkbox" id="node-input-enabled" style="width: 20px;" />
+        <label for="node-input-enabled" style="width: 200px;" data-i18n="scheduler.ui.scheduler_enabled"></label>
+    </div>
+    <div class="form-row" style="margin-bottom: 2px;">
+        <p class="text-center"><i class="fa fa-list"></i> <strong data-i18n="scheduler.ui.schedules"></strong></p>
+    </div>
+    <div class="form-row node-scheduler-schedules-row">
+        <ol id="node-scheduler-schedules"></ol>
+    </div>
+    <hr/>
+    <h4 style="margin: 0.5rem 0;" data-i18n="scheduler.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);" data-i18n="scheduler.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);" data-i18n="scheduler.ui.send_after_start"></label>
+    </div>
 </script>

package/scheduler/scheduler.js

@@ -7,29 +7,52 @@ 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,
-            lastMessage: 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 #
+        // ##################
+
+
+        // ##################
+        // # Runtime values #
+        // ##################
+
+        // Here the setTimeout return value is stored when the next timeout should happen
         let timeout = null;
+
+        // This is date when the next event schould be raised
         let nextEvent = null;
 
-        // prepare schedules
+
+        // Initially prepare schedules config object
         setTimeout(() =>
         {
             for (let i = 0; i < config.schedules.length; i++)
@@ -47,48 +70,17 @@ module.exports = function (RED)
         }, 1000);
 
 
+        // ###############
+        // # Node events #
+        // ###############
         node.on("input", function (msg)
         {
-            switch (helper.getTopicName(msg.topic))
-            {
-                case "enable":
-                    if (node_settings.enabled)
-                        return;
-
-                    node_settings.enabled = true;
-                    if (config.save_state)
-                        smart_context.set(node.id, node_settings);
-                    break;
-
-                case "disable":
-                    if (!node_settings.enabled)
-                        return;
-
-                    node_settings.enabled = false;
-                    if (config.save_state)
-                        smart_context.set(node.id, node_settings);
-                    break;
-
-                case "set_state":
-                    if (node_settings.enabled == !!msg.payload)
-                        return;
-
-                    node_settings.enabled = !!msg.payload;
-                    if (config.save_state)
-                        smart_context.set(node.id, node_settings);
-                    break;
-
-                default:
-                    return;
-            }
-
-            if (node_settings.enabled)
-                initTimeouts();
-            else
-                clearTimeouts();
+            handleTopic(msg);
 
             setStatus();
-            smart_context.set(node.id, node_settings);
+
+            if (config.save_state)
+                smart_context.set(node.id, node_settings);
         });
 
         node.on("close", function ()
@@ -100,6 +92,33 @@ module.exports = function (RED)
             }
         });
 
+
+        // #####################
+        // # Private functions #
+        // #####################
+
+        // This is the main function which handles all topics that was received.
+        let handleTopic = msg =>
+        {
+            let real_topic = helper.getTopicName(msg.topic);
+
+            if (real_topic == "set_state")
+                real_topic = (!!msg.payload) ? "enable" : "disable";
+
+            switch (real_topic)
+            {
+                case "enable":
+                    node_settings.enabled = true;
+                    initNextTimeout();
+                    break;
+
+                case "disable":
+                    node_settings.enabled = false;
+                    break;
+            }
+        }
+
+        // calculate which event should occur nect
         let initNextTimeout = () =>
         {
             let minIndex = null;
@@ -120,16 +139,28 @@ module.exports = function (RED)
                 return;
             }
 
+            // Stop timeout if any
+            if (timeout != null)
+            {
+                clearTimeout(timeout);
+                timeout = null;
+            }
+
             nextEvent = config.schedules[minIndex].nextEvent;
             let waitTime = nextEvent.getTime() - (new Date()).getTime();
-            timeout = setTimeout(raiseEvent, waitTime, minIndex);
+            timeout = setTimeout(() =>
+            {
+                timeout = null;
+                raiseEvent(minIndex);
+            }, waitTime);
         }
 
+        // calculates the next time when the scheduled i-th entry should run.
         let calcNextEvent = i =>
         {
             const schedule = config.schedules[i];
 
-            // If no day is checked then we cannot it is never raised
+            // If no day is checked it is never raised
             if (!schedule.days || schedule.days.length == 0)
                 return null;
 
@@ -174,7 +205,7 @@ module.exports = function (RED)
                 schedule.second
             );
 
-            // console.log({
+            // helper.log({
             //     i,
             //     findNextDay,
             //     nextEvent
@@ -183,6 +214,7 @@ module.exports = function (RED)
             return nextEvent;
         }
 
+        // Send the i-th entry to the output
         let raiseEvent = i =>
         {
             const schedule = config.schedules[i];
@@ -191,8 +223,8 @@ module.exports = function (RED)
                 return;
 
             timeout = null;
-            node.send(schedule.message);
-            node_settings.lastMessage = schedule.message;
+            node.send(helper.cloneObject(schedule.message));
+            node_settings.last_message = schedule.message;
 
             if (config.save_state)
                 smart_context.set(node.id, node_settings);
@@ -233,11 +265,11 @@ module.exports = function (RED)
             }
         }
 
-        if (config.save_state && config.resend_on_start && node_settings.lastMessage != null)
+        if (config.save_state && config.resend_on_start && node_settings.last_message != null)
         {
             setTimeout(() =>
             {
-                node.send(node_settings.lastMessage);
+                node.send(helper.cloneObject(node_settings.last_message));
             }, 10000);
         }
     }