smart-nodes 0.3.22 → 0.3.26

package/shutter-complex-control/shutter-complex-control.js

@@ -1,11 +1,13 @@
 module.exports = function (RED)
 {
+    "use strict";
+
     function ShutterComplexControlNode(config)
     {
         const node = this;
         RED.nodes.createNode(node, config);
 
-        const smartContext = require("../persistence.js")(RED);
+        const smart_context = require("../persistence.js")(RED);
         const helper = require("../smart_helper.js");
 
         // used from text-exec node
@@ -15,10 +17,10 @@ module.exports = function (RED)
             node.exec_text_names = [];
 
         // persistent values
-        var nodeSettings = Object.assign({}, {
+        var node_settings = Object.assign({}, {
             last_position: 0,        // 0 = opened, 100 = closed
             last_direction_up: true, // remember last direction for toggle action
-        }, smartContext.get(node.id));
+        }, smart_context.get(node.id));
 
         // dynamic config
         let max_time = parseInt(config.max_time || 60);
@@ -47,7 +49,7 @@ module.exports = function (RED)
         {
             handleTopic(msg);
 
-            smartContext.set(node.id, nodeSettings);
+            smart_context.set(node.id, node_settings);
         });
 
         node.on("close", function ()
@@ -62,56 +64,56 @@ module.exports = function (RED)
             var resultDown = false;
             var resultStop = false;
 
-            let realTopic = helper.getTopicName(msg.topic);
+            let real_topic = helper.getTopicName(msg.topic);
 
             // set default topic if invalid value is send
-            if (!["up", "up_stop", "down", "down_stop", "stop", "toggle", "up_down", "position", "alarm"].includes(realTopic))
-                realTopic = "toggle";
+            if (!["up", "up_stop", "down", "down_stop", "stop", "toggle", "up_down", "position", "alarm"].includes(real_topic))
+                real_topic = "toggle";
 
             // skip if button is released
-            if (msg.payload === false && ["up", "up_stop", "down", "down_stop", "stop", "toggle"].includes(realTopic))
+            if (msg.payload === false && ["up", "up_stop", "down", "down_stop", "stop", "toggle"].includes(real_topic))
                 return;
 
             // Convert up_down from HA UI to next command
-            if (realTopic == "up_down")
+            if (real_topic == "up_down")
             {
                 if (msg.payload)
-                    realTopic = "down";
+                    real_topic = "down";
                 else
-                    realTopic = "up";
+                    real_topic = "up";
             }
 
             // Correct next topic to avoid handling up_stop, down_stop or toggle separately.
-            if (max_time_timeout != null && (realTopic == "up_stop" || realTopic == "down_stop" || realTopic == "toggle"))
+            if (max_time_timeout != null && (real_topic == "up_stop" || real_topic == "down_stop" || real_topic == "toggle"))
             {
-                realTopic = "stop";
+                real_topic = "stop";
             }
             else if (max_time_timeout == null)
             {
                 // shutter is not running, set next command depending on topic
-                if (realTopic == "up_stop")
-                    realTopic = "up";
-                else if (realTopic == "down_stop")
-                    realTopic = "down";
-                else if (nodeSettings.last_direction_up && realTopic == "toggle")
-                    realTopic = "down";
-                else if (!nodeSettings.last_direction_up && realTopic == "toggle")
-                    realTopic = "up";
+                if (real_topic == "up_stop")
+                    real_topic = "up";
+                else if (real_topic == "down_stop")
+                    real_topic = "down";
+                else if (node_settings.last_direction_up && real_topic == "toggle")
+                    real_topic = "down";
+                else if (!node_settings.last_direction_up && real_topic == "toggle")
+                    real_topic = "up";
             }
 
-            // console.log("Convert topic to: " + realTopic);
+            // console.log("Convert topic to: " + real_topic);
 
-            switch (realTopic)
+            switch (real_topic)
             {
                 case "up":
                     if (max_time_timeout != null)
                     {
                         // Nothing todo
-                        if (nodeSettings.last_direction_up)
+                        if (node_settings.last_direction_up)
                             return;
 
                         // Runs down at the moment, so stop first
-                        if (nodeSettings.last_direction_up == false)
+                        if (node_settings.last_direction_up == false)
                         {
                             // console.log("--- Sub topic ---");
                             handleTopic({ topic: "stop" });
@@ -123,7 +125,7 @@ module.exports = function (RED)
                     resultUp = true;
                     startAutoOff(false, helper.getTimeInMsFromString(msg.time_on) || null);
                     if (!alarm_active)
-                        node.status({ fill: "green", shape: "dot", text: (new Date()).toLocaleString() + ": Up" });
+                        node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Up" });
                     break;
 
                 case "stop":
@@ -134,25 +136,25 @@ module.exports = function (RED)
                     if (max_time_timeout != null)
                     {
                         const change_percentage = (Date.now() - on_time) / 1000 / max_time * 100;
-                        if (nodeSettings.last_direction_up)
-                            nodeSettings.last_position = Math.max(0, nodeSettings.last_position - change_percentage);
+                        if (node_settings.last_direction_up)
+                            node_settings.last_position = Math.max(0, node_settings.last_position - change_percentage);
                         else
-                            nodeSettings.last_position = Math.min(100, nodeSettings.last_position + change_percentage);
+                            node_settings.last_position = Math.min(100, node_settings.last_position + change_percentage);
                     }
                     off_time = Date.now();
                     stopAutoOff();
-                    node.status({ fill: "red", shape: "dot", text: (new Date()).toLocaleString() + ": Stopped at " + Math.round(nodeSettings.last_position) + "%" });
+                    node.status({ fill: "red", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Stopped at " + Math.round(node_settings.last_position) + "%" });
                     break;
 
                 case "down":
                     if (max_time_timeout != null)
                     {
                         // Nothing todo
-                        if (nodeSettings.last_direction_up == false)
+                        if (node_settings.last_direction_up == false)
                             return;
 
                         // Runs up at the moment, so stop first
-                        if (nodeSettings.last_direction_up)
+                        if (node_settings.last_direction_up)
                         {
                             // console.log("--- Sub topic ---");
                             handleTopic({ topic: "stop" });
@@ -164,7 +166,7 @@ module.exports = function (RED)
                     resultDown = true;
                     startAutoOff(true, helper.getTimeInMsFromString(msg.time_on) || null);
                     if (!alarm_active)
-                        node.status({ fill: "green", shape: "dot", text: (new Date()).toLocaleString() + ": Down" });
+                        node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Down" });
                     break;
 
                 case "position":
@@ -183,21 +185,21 @@ module.exports = function (RED)
                         // Change position while running,
                         // Calculate current position first
                         const change_percentage = (now - on_time) / 1000 / max_time * 100;
-                        if (nodeSettings.last_direction_up)
-                            nodeSettings.last_position = Math.max(0, nodeSettings.last_position - change_percentage);
+                        if (node_settings.last_direction_up)
+                            node_settings.last_position = Math.max(0, node_settings.last_position - change_percentage);
                         else
-                            nodeSettings.last_position = Math.min(100, nodeSettings.last_position + change_percentage);
+                            node_settings.last_position = Math.min(100, node_settings.last_position + change_percentage);
 
-                        node.status({ fill: "gray", shape: "dot", text: (new Date()).toLocaleString() + ": Update current position to " + nodeSettings.last_position + "%" });
+                        node.status({ fill: "gray", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Update current position to " + node_settings.last_position + "%" });
 
                         // Runs in the wrong direction at the moment, so stop first
-                        if (nodeSettings.last_direction_up && value > nodeSettings.last_position)
+                        if (node_settings.last_direction_up && value > node_settings.last_position)
                         {
                             // console.log("--- Sub topic ---");
                             handleTopic({ topic: "stop" });
                             // console.log("-----------------");
                         }
-                        else if (nodeSettings.last_direction_up == false && value < nodeSettings.last_position)
+                        else if (node_settings.last_direction_up == false && value < node_settings.last_position)
                         {
                             // console.log("--- Sub topic ---");
                             handleTopic({ topic: "stop" });
@@ -207,17 +209,17 @@ module.exports = function (RED)
 
                     on_time = now;
 
-                    if (value < nodeSettings.last_position)
+                    if (value < node_settings.last_position)
                     {
                         // Go up
                         resultUp = true;
-                        startAutoOff(false, (nodeSettings.last_position - value) / 100 * max_time * 1000, value);
+                        startAutoOff(false, (node_settings.last_position - value) / 100 * max_time * 1000, value);
                     }
-                    else if (value > nodeSettings.last_position)
+                    else if (value > node_settings.last_position)
                     {
                         // Go down
                         resultDown = true;
-                        startAutoOff(true, (value - nodeSettings.last_position) / 100 * max_time * 1000, value);
+                        startAutoOff(true, (value - node_settings.last_position) / 100 * max_time * 1000, value);
                     }
                     else
                     {
@@ -226,7 +228,7 @@ module.exports = function (RED)
                         return;
                     }
 
-                    node.status({ fill: "green", shape: "dot", text: (new Date()).toLocaleString() + ": Set position from " + nodeSettings.last_position + "%  to " + value + "%" });
+                    node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Set position from " + node_settings.last_position + "%  to " + value + "%" });
                     break;
 
                 case "alarm":
@@ -234,7 +236,7 @@ module.exports = function (RED)
 
                     if (alarm_active)
                     {
-                        node.status({ fill: "red", shape: "dot", text: (new Date()).toLocaleString() + ": ALARM is active" });
+                        node.status({ fill: "red", shape: "dot", text: helper.getCurrentTimeForStatus() + ": ALARM is active" });
 
                         switch (alarm_action)
                         {
@@ -277,32 +279,30 @@ module.exports = function (RED)
             if (wait_time_ms == null)
             {
                 if (down)
-                    wait_time_ms = (100 - nodeSettings.last_position) * max_time / 100 * 1000;
+                    wait_time_ms = (100 - node_settings.last_position) * max_time / 100 * 1000;
                 else
-                    wait_time_ms = nodeSettings.last_position * max_time / 100 * 1000;
+                    wait_time_ms = node_settings.last_position * max_time / 100 * 1000;
 
                 // Run at least for 5 seconds
                 if (wait_time_ms < 5000)
                     wait_time_ms = 5000;
             }
 
-            max_time_on = parseInt(wait_time_ms / 1000);
-
             if (wait_time_ms < 0)
             {
-                node.status({ fill: "red", shape: "dot", text: (new Date()).toLocaleString() + ": time_on value has to be greater than 0" });
+                node.status({ fill: "red", shape: "dot", text: helper.getCurrentTimeForStatus() + ": time_on value has to be greater than 0" });
                 return;
             }
 
             if (!alarm_active)
-                node.status({ fill: "yellow", shape: "ring", text: (new Date()).toLocaleString() + ": " + (down ? "Down" : "Up") + ", wait " + helper.formatMsToStatus(max_time_on, "until") + " for auto off" });
+                node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": " + (down ? "Down" : "Up") + ", wait " + helper.formatMsToStatus(wait_time_ms, "until") + " for auto off" });
 
             max_time_timeout = setTimeout(() =>
             {
                 handleTopic({ topic: "stop" });
                 if (new_position != null)
-                    nodeSettings.last_position = new_position;
-                smartContext.set(node.id, nodeSettings);
+                    node_settings.last_position = new_position;
+                smart_context.set(node.id, node_settings);
             }, wait_time_ms);
         };
 
@@ -312,7 +312,7 @@ module.exports = function (RED)
             {
                 // console.log("stopAutoOff");
                 if (!alarm_active)
-                    node.status({ fill: "green", shape: "dot", text: (new Date()).toLocaleString() + ": Stopped at " + Math.round(nodeSettings.last_position) + "%" });
+                    node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Stopped at " + Math.round(node_settings.last_position) + "%" });
                 clearTimeout(max_time_timeout);
                 off_time = Date.now();
                 max_time_timeout = null;
@@ -333,7 +333,7 @@ module.exports = function (RED)
             if (off_time + revert_time_ms > now)
             {
                 // Output has to possibly wait until the revert time has passed
-                if ((nodeSettings.last_direction_up && down) || (nodeSettings.last_direction_up == false && up))
+                if ((node_settings.last_direction_up && down) || (node_settings.last_direction_up == false && up))
                 {
                     // console.log("Start wait timeout for " + (off_time + revert_time_ms - now) + "ms");
 
@@ -360,8 +360,8 @@ module.exports = function (RED)
             {
                 if (!alarm_active || alarm_action === "UP")
                 {
-                    nodeSettings.last_direction_up = true;
-                    node.send([{ payload: true }, { payload: false }, { payload: nodeSettings.last_position }]);
+                    node_settings.last_direction_up = true;
+                    node.send([{ payload: true }, { payload: false }, { payload: node_settings.last_position }]);
                     notifyCentral(true);
                 }
             }
@@ -369,14 +369,14 @@ module.exports = function (RED)
             {
                 if (!alarm_active || alarm_action === "DOWN")
                 {
-                    nodeSettings.last_direction_up = false;
-                    node.send([{ payload: false }, { payload: true }, { payload: nodeSettings.last_position }]);
+                    node_settings.last_direction_up = false;
+                    node.send([{ payload: false }, { payload: true }, { payload: node_settings.last_position }]);
                     notifyCentral(true);
                 }
             }
             else if (stop && !alarm_active)
             {
-                node.send([{ payload: false }, { payload: false }, { payload: nodeSettings.last_position }]);
+                node.send([{ payload: false }, { payload: false }, { payload: node_settings.last_position }]);
                 notifyCentral(false);
             }
         };
@@ -397,8 +397,8 @@ module.exports = function (RED)
         // For security reason, stop shutter at node start
         setTimeout(() =>
         {
-            node.send([{ payload: false }, { payload: false }, { payload: nodeSettings.last_position }]);
-            node.status({ fill: "red", shape: "dot", text: (new Date()).toLocaleString() + ": Stopped at " + Math.round(nodeSettings.last_position) + "%" });
+            node.send([{ payload: false }, { payload: false }, { payload: node_settings.last_position }]);
+            node.status({ fill: "red", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Stopped at " + Math.round(node_settings.last_position) + "%" });
             notifyCentral(false);
         }, 10000);
     }

package/shutter-control/shutter-control.js

@@ -1,11 +1,13 @@
 module.exports = function (RED)
 {
+    "use strict";
+
     function ShutterControlNode(config)
     {
         const node = this;
         RED.nodes.createNode(node, config);
 
-        const smartContext = require("../persistence.js")(RED);
+        const smart_context = require("../persistence.js")(RED);
         const helper = require("../smart_helper.js");
 
         // used from text-exec node
@@ -15,10 +17,10 @@ module.exports = function (RED)
             node.exec_text_names = [];
 
         // persistent values
-        var nodeSettings = Object.assign({}, {
+        var node_settings = Object.assign({}, {
             last_position: 0,        // 0 = opened, 100 = closed
             last_direction_up: true, // remember last direction for toggle action
-        }, smartContext.get(node.id));
+        }, smart_context.get(node.id));
 
         // dynamic config
 
@@ -34,13 +36,13 @@ module.exports = function (RED)
         }
         RED.events.on(event, handler);
 
-        node.status({ fill: "red", shape: "dot", text: (new Date()).toLocaleString() + ": Stopped at " + Math.round(nodeSettings.last_position) + "%" });
+        node.status({ fill: "red", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Stopped at " + Math.round(node_settings.last_position) + "%" });
 
         node.on("input", function (msg)
         {
             handleTopic(msg);
 
-            smartContext.set(node.id, nodeSettings);
+            smart_context.set(node.id, node_settings);
         });
 
         node.on("close", function ()
@@ -55,64 +57,64 @@ module.exports = function (RED)
             var resultStop = null;
             var resultPosition = null;
 
-            var realTopic = helper.getTopicName(msg.topic);
+            var real_topic = helper.getTopicName(msg.topic);
 
             // set default topic
-            if (!["status", "status_position", "up_down", "up", "up_stop", "down", "down_stop", "stop", "toggle", "position"].includes(realTopic))
-                realTopic = "toggle";
+            if (!["status", "status_position", "up_down", "up", "up_stop", "down", "down_stop", "stop", "toggle", "position"].includes(real_topic))
+                real_topic = "toggle";
 
             // skip if button is released
-            if (msg.payload === false && ["up", "up_stop", "down", "down_stop", "stop", "toggle"].includes(realTopic))
+            if (msg.payload === false && ["up", "up_stop", "down", "down_stop", "stop", "toggle"].includes(real_topic))
                 return;
 
             // Correct next topic to avoid handling up_stop, down_stop or toggle separately.
-            if ((max_time_on_timeout != null || is_running) && (realTopic == "up_stop" || realTopic == "down_stop" || realTopic == "toggle"))
+            if ((max_time_on_timeout != null || is_running) && (real_topic == "up_stop" || real_topic == "down_stop" || real_topic == "toggle"))
             {
-                realTopic = "stop";
+                real_topic = "stop";
             }
             else if (max_time_on_timeout == null && !is_running)
             {
                 // shutter is not running, set next command depending on topic
-                if (realTopic == "up_stop")
-                    realTopic = "up";
-                else if (realTopic == "down_stop")
-                    realTopic = "down";
-                else if (nodeSettings.last_direction_up && realTopic == "toggle")
-                    realTopic = "down";
-                else if (!nodeSettings.last_direction_up && realTopic == "toggle")
-                    realTopic = "up";
+                if (real_topic == "up_stop")
+                    real_topic = "up";
+                else if (real_topic == "down_stop")
+                    real_topic = "down";
+                else if (node_settings.last_direction_up && real_topic == "toggle")
+                    real_topic = "down";
+                else if (!node_settings.last_direction_up && real_topic == "toggle")
+                    real_topic = "up";
             }
 
 
-            switch (realTopic)
+            switch (real_topic)
             {
                 case "status":
                 case "status_position":
-                    nodeSettings.last_direction_up = nodeSettings.last_position > msg.payload;
-                    nodeSettings.last_position = msg.payload;
+                    node_settings.last_direction_up = node_settings.last_position > msg.payload;
+                    node_settings.last_position = msg.payload;
 
                     if (is_running && (msg.payload == 0 || msg.payload == 100))
                         is_running = false;
 
-                    node.status({ fill: "yellow", shape: "ring", text: (new Date()).toLocaleString() + ": Position status received: " + msg.payload + "%" });
+                    node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": Position status received: " + msg.payload + "%" });
                     return;
 
                 // This is only used to track starting of the shutter
                 case "up_down":
-                    nodeSettings.last_direction_up = !msg.payload;
+                    node_settings.last_direction_up = !msg.payload;
                     is_running = true;
 
-                    if (nodeSettings.last_direction_up)
-                        node.status({ fill: "green", shape: "dot", text: (new Date()).toLocaleString() + ": Up" });
+                    if (node_settings.last_direction_up)
+                        node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Up" });
                     else
-                        node.status({ fill: "green", shape: "dot", text: (new Date()).toLocaleString() + ": Down" });
+                        node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Down" });
                     return;
 
                 case "up":
-                    nodeSettings.last_direction_up = true;
+                    node_settings.last_direction_up = true;
                     is_running = true;
                     resultUpDown = false;
-                    node.status({ fill: "green", shape: "dot", text: (new Date()).toLocaleString() + ": Up" });
+                    node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Up" });
                     startAutoOffIfNeeded(msg);
                     break;
 
@@ -120,14 +122,14 @@ module.exports = function (RED)
                     is_running = false;
                     resultStop = true;
                     stopAutoOff();
-                    node.status({ fill: "green", shape: "dot", text: (new Date()).toLocaleString() + ": Stopped" });
+                    node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Stopped" });
                     break;
 
                 case "down":
-                    nodeSettings.last_direction_up = false;
+                    node_settings.last_direction_up = false;
                     is_running = true;
                     resultUpDown = true;
-                    node.status({ fill: "green", shape: "dot", text: (new Date()).toLocaleString() + ": Down" });
+                    node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Down" });
                     startAutoOffIfNeeded(msg);
                     break;
 
@@ -138,7 +140,7 @@ module.exports = function (RED)
                     if (value > 100) value = 100;
                     // is_running = true; // Not guaranteed that the shutter starts running.
                     resultPosition = value;
-                    node.status({ fill: "green", shape: "dot", text: (new Date()).toLocaleString() + ": Set position to " + value + "%" });
+                    node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Set position to " + value + "%" });
                     break;
             }
 
@@ -166,23 +168,23 @@ module.exports = function (RED)
             let timeMs = helper.getTimeInMsFromString(msg.time_on);
             if (isNaN(timeMs))
             {
-                node.status({ fill: "red", shape: "dot", text: (new Date()).toLocaleString() + ": Invalid time_on value send: " + msg.time_on });
+                node.status({ fill: "red", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Invalid time_on value send: " + msg.time_on });
                 return;
             }
 
             if (timeMs <= 0)
             {
-                node.status({ fill: "red", shape: "dot", text: (new Date()).toLocaleString() + ": time_on value has to be greater than 0" });
+                node.status({ fill: "red", shape: "dot", text: helper.getCurrentTimeForStatus() + ": time_on value has to be greater than 0" });
                 return;
             }
 
             // Stop if any timeout is set
             stopAutoOff();
 
-            node.status({ fill: "yellow", shape: "ring", text: (new Date()).toLocaleString() + ": Wait " + (timeMs / 1000).toFixed(1) + " sec for auto off" });
+            node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": Wait " + (timeMs / 1000).toFixed(1) + " sec for auto off" });
             max_time_on_timeout = setTimeout(() =>
             {
-                node.status({ fill: "green", shape: "dot", text: (new Date()).toLocaleString() + ": Stopped" });
+                node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": Stopped" });
                 is_running = false;
                 node.send([null, { payload: true }, null]);
                 notifyCentral(false);