smart-nodes 0.3.15 → 0.3.26

package/smart_helper.js

@@ -1,10 +1,19 @@
 module.exports = {
+
+    /**
+     * This functions converts a value into the given type.
+     * If a type is unknown the NodeRed function is used for conversation.
+     * 
+     * Known types are:
+     * - null, which will return always null
+     */
     evaluateNodeProperty(RED, value, type)
     {
         try
         {
             switch (type)
             {
+                case null:
                 case "null":
                     return null;
 
@@ -14,10 +23,19 @@ module.exports = {
         }
         catch (error)
         {
+            console.error(value);
+            console.error(type);
             console.error(error);
             return null;
         }
     },
+
+    /**
+     * This functions returns the name that is set in a smart topic.
+     * The format is name#number
+     * 
+     * If no name is found null is returned.
+     */
     getTopicName(topic)
     {
         if (typeof topic == "undefined" || topic == null || topic == "" || typeof topic != "string")
@@ -28,6 +46,13 @@ module.exports = {
 
         return topic.substring(0, topic.indexOf("#"));
     },
+
+    /**
+     * This functions returns the number that is set in a smart topic.
+     * The format is name#number
+     * 
+     * If no number is found null is returned.
+     */
     getTopicNumber(topic)
     {
         if (typeof topic == "undefined" || topic == null || topic == "")
@@ -45,6 +70,16 @@ module.exports = {
 
         return result;
     },
+
+    /**
+     * This function converts the given value with the given unit into milli seconds.
+     * 
+     * This units are available:
+     *  - ms
+     *  - s or sec
+     *  - m or min
+     *  - h
+     */
     getTimeInMs(value, unit)
     {
         value = parseInt(value, 10);
@@ -67,6 +102,16 @@ module.exports = {
                 return value * 3600 * 1000;
         }
     },
+
+    /**
+     * This function converts the given value with the given unit into seconds.
+     * 
+     * This units are available:
+     *  - ms
+     *  - s or sec
+     *  - m or min
+     *  - h
+     */
     getTimeInS(value, unit)
     {
         value = parseInt(value, 10);
@@ -88,6 +133,19 @@ module.exports = {
                 return value * 3600;
         }
     },
+
+    /**
+     * This function is parsing the given value and returns the time in milli seconds.
+     * 
+     * The string can have a number followed by an optional unit.
+     * If no unit is given, the default is ms.
+     * 
+     * This units are available:
+     *  - ms
+     *  - s or sec
+     *  - m or min
+     *  - h
+     */
     getTimeInMsFromString(value)
     {
         // default in ms
@@ -115,17 +173,63 @@ module.exports = {
         // Something went wrong
         return 0;
     },
-    formatMsToStatus(value, timeConcatWord = null)
+
+    /**
+     * This function returns a string that represents the remaining time given in time_ms.
+     * If a timeConcatWord it set, it returns also this word including the target time.
+     */
+    formatMsToStatus(time_ms, time_concat_word = null)
     {
         let result = "";
 
-        if (timeConcatWord)
+        if (time_concat_word)
         {
-            let date = (new Date(Date.now() + value));
-            result = " " + timeConcatWord + " " + date.getHours() + ":" + ("" + date.getMinutes()).padStart(2, "0") + ":" + ("" + date.getSeconds()).padStart(2, "0");
+            let date = (new Date(Date.now() + time_ms));
+            result = " " + time_concat_word + " " + date.getHours() + ":" + ("" + date.getMinutes()).padStart(2, "0") + ":" + ("" + date.getSeconds()).padStart(2, "0");
         }
 
-        if (value == 0)
+        if (time_ms == 0)
+            return "0:00" + result;
+
+        // value in sec
+        time_ms = parseInt(time_ms / 1000, 10);
+        result = (time_ms % 60) + result;
+        if (time_ms % 60 < 10)
+            result = "0" + result;
+
+        // value in min
+        time_ms = parseInt(time_ms / 60, 10);
+        result = (time_ms % 60) + ":" + result;
+        if (time_ms % 60 < 10)
+            result = "0" + result;
+
+        // value in hour
+        time_ms = parseInt(time_ms / 60, 10);
+        result = (time_ms % 24) + ":" + result;
+        if (time_ms % 24 < 10)
+            result = "0" + result;
+
+        // value in days
+        time_ms = parseInt(time_ms / 24, 10);
+        if (time_ms > 0)
+            result = time_ms + "." + result;
+
+        return result;
+    },
+
+    /**
+     * This function returns a string that represents the remaining time until the given date.
+     * If a time_concat_word it set, it returns also this word including the target time.
+     */
+    formatDateToStatus(date, time_concat_word = null)
+    {
+        let result = "";
+
+        if (time_concat_word)
+            result = " " + time_concat_word + " " + date.getHours() + ":" + ("" + date.getMinutes()).padStart(2, "0") + ":" + ("" + date.getSeconds()).padStart(2, "0");
+
+        let value = date - new Date();
+        if (value <= 0)
             return "0:00" + result;
 
         // value in sec
@@ -152,5 +256,52 @@ module.exports = {
             result = value + "." + result;
 
         return result;
+    },
+
+    /**
+     * This function converts a number from a specific range into another range
+     * E.g:
+     *  Input range = 0 to 10
+     *  Target range = 100 to 200
+     * 
+     *  current number = 0
+     *  scale(5, 0, 10, 100, 200) => 100
+     * 
+     *  current number = 5
+     *  scale(5, 0, 10, 100, 200) => 150
+     * 
+     *  current number = 10
+     *  scale(5, 0, 10, 100, 200) => 200
+     * 
+     *  current number = 20 (out of input range!)
+     *  scale(5, 0, 10, 100, 200) => 300 (out of output range!)
+     */
+    scale(number, inMin, inMax, outMin, outMax)
+    {
+        return (number - inMin) * (outMax - outMin) / (inMax - inMin) + outMin;
+    },
+
+    /**
+     * This function returns a short string that represents the current date and time.
+     */
+    getCurrentDateForStatus()
+    {
+        let date = new Date();
+        return date.getDate().toString().padStart(2, "0") + "." +
+            (date.getMonth() + 1).toString().padStart(2, "0") + " - " +
+            date.getHours().toString().padStart(2, "0") + ":" +
+            date.getMinutes().toString().padStart(2, "0") + ":" +
+            date.getSeconds().toString().padStart(2, "0");
+    },
+
+    /**
+     * This function returns a short string that represents the current time.
+     */
+    getCurrentTimeForStatus()
+    {
+        let date = new Date();
+        return date.getHours().toString().padStart(2, "0") + ":" +
+            date.getMinutes().toString().padStart(2, "0") + ":" +
+            date.getSeconds().toString().padStart(2, "0");
     }
 };

package/statistic/statistic.js

@@ -1,14 +1,16 @@
 module.exports = function (RED)
 {
+    "use strict";
+
     function StatisticNode(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");
 
-        var nodeSettings = {
+        var node_settings = {
             values: [],
             lastMessage: null,
         };
@@ -16,12 +18,12 @@ module.exports = function (RED)
         if (config.save_state)
         {
             // load old saved values
-            nodeSettings = Object.assign(nodeSettings, smartContext.get(node.id));
+            node_settings = Object.assign(node_settings, smart_context.get(node.id));
         }
         else
         {
             // delete old saved values
-            smartContext.del(node.id);
+            smart_context.del(node.id);
         }
 
         // dynamic config
@@ -39,15 +41,15 @@ module.exports = function (RED)
                 return;
             }
 
-            let realTopic = helper.getTopicNumber(msg.topic) || 0;
-            // realTopic should be sended with 1-based, but internally 0-based is needed
-            realTopic--;
+            let real_topic = helper.getTopicNumber(msg.topic) || 0;
+            // real_topic should be sended with 1-based, but internally 0-based is needed
+            real_topic--;
 
             if (operation === "MOV_AVG")
             {
-                nodeSettings.values.push(parseFloat(msg.payload));
-                if (nodeSettings.values.length > count)
-                    nodeSettings.values.splice(0, 1);
+                node_settings.values.push(parseFloat(msg.payload));
+                if (node_settings.values.length > count)
+                    node_settings.values.splice(0, 1);
             }
             else if (operation != "ABS")
             {
@@ -56,7 +58,7 @@ module.exports = function (RED)
                     node.error("Topic not set");
                     return;
                 }
-                nodeSettings.values[realTopic] = parseFloat(msg.payload);
+                node_settings.values[real_topic] = parseFloat(msg.payload);
             }
 
             msg = getResult(msg);
@@ -64,12 +66,12 @@ module.exports = function (RED)
 
             if (msg)
             {
-                nodeSettings.lastMessage = msg;
+                node_settings.lastMessage = msg;
                 node.send(msg);
             }
 
             if (config.save_state)
-                smartContext.set(node.id, nodeSettings);
+                smart_context.set(node.id, node_settings);
         });
 
         node.on("close", function ()
@@ -81,7 +83,7 @@ module.exports = function (RED)
             let length;
             if (operation !== "MOV_AVG" && operation !== "ABS") 
             {
-                length = Object.entries(nodeSettings.values).length;
+                length = Object.entries(node_settings.values).length;
                 if (length == 0)
                     return null;
             }
@@ -90,7 +92,7 @@ module.exports = function (RED)
             switch (operation)
             {
                 case "MIN":
-                    result = Object.entries(nodeSettings.values).reduce((v1, v2) =>
+                    result = Object.entries(node_settings.values).reduce((v1, v2) =>
                     {
                         if (v1[1] <= v2[1])
                             return v1;
@@ -99,7 +101,7 @@ module.exports = function (RED)
                     break;
 
                 case "MAX":
-                    result = Object.entries(nodeSettings.values).reduce((v1, v2) =>
+                    result = Object.entries(node_settings.values).reduce((v1, v2) =>
                     {
                         if (v1[1] >= v2[1])
                             return v1;
@@ -108,18 +110,18 @@ module.exports = function (RED)
                     break;
 
                 case "SUM":
-                    result = Object.entries(nodeSettings.values).reduce((v1, v2) =>
+                    result = Object.entries(node_settings.values).reduce((v1, v2) =>
                     {
                         return [null, v1[1] + v2[1]];
                     });
                     break;
 
                 case "DIFF":
-                    if (nodeSettings.values.length >= 2)
+                    if (node_settings.values.length >= 2)
                     {
                         result = [
                             null,
-                            nodeSettings.values[0] - nodeSettings.values[1]
+                            node_settings.values[0] - node_settings.values[1]
                         ];
                     }
                     break;
@@ -129,17 +131,17 @@ module.exports = function (RED)
                     return msg;
 
                 case "ABS_DIFF":
-                    if (nodeSettings.values.length >= 2)
+                    if (node_settings.values.length >= 2)
                     {
                         result = [
                             null,
-                            Math.abs(nodeSettings.values[0] - nodeSettings.values[1])
+                            Math.abs(node_settings.values[0] - node_settings.values[1])
                         ];
                     }
                     break;
 
                 case "AVG":
-                    let value = Object.entries(nodeSettings.values).reduce((v1, v2) =>
+                    let value = Object.entries(node_settings.values).reduce((v1, v2) =>
                     {
                         return [null, v1[1] + v2[1]];
                     });
@@ -149,7 +151,7 @@ module.exports = function (RED)
                     };
 
                 case "MOV_AVG":
-                    msg.payload = nodeSettings.values.reduce((v1, v2) => v1 + v2) / nodeSettings.values.length;
+                    msg.payload = node_settings.values.reduce((v1, v2) => v1 + v2) / node_settings.values.length;
                     return msg;
             }
 
@@ -176,20 +178,20 @@ module.exports = function (RED)
                 return;
 
             if (operation === "ABS")
-                node.status({ fill: "yellow", shape: "ring", text: (new Date()).toLocaleString() + ": " + operation + " => " + msg.payload });
+                node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": " + operation + " => " + msg.payload });
             else
-                node.status({ fill: "yellow", shape: "ring", text: (new Date()).toLocaleString() + ": " + operation + "(" + Object.entries(nodeSettings.values).map(v => v[1]).join(",") + ") => " + msg.payload });
+                node.status({ fill: "yellow", shape: "ring", text: helper.getCurrentTimeForStatus() + ": " + operation + "(" + Object.entries(node_settings.values).map(v => v[1]).join(",") + ") => " + msg.payload });
         }
 
-        if (config.save_state && config.resend_on_start && nodeSettings.lastMessage != null)
+        if (config.save_state && config.resend_on_start && node_settings.lastMessage != null)
         {
             setTimeout(() =>
             {
-                node.send(nodeSettings.lastMessage);
+                node.send(node_settings.lastMessage);
             }, 10000);
         }
 
-        setStatus(nodeSettings.lastMessage);
+        setStatus(node_settings.lastMessage);
     }
 
     RED.nodes.registerType("smart_statistic", StatisticNode);

package/text-exec/text-exec.js

@@ -1,5 +1,7 @@
 module.exports = function (RED)
 {
+    "use strict";
+
     function TextExecNode(config)
     {
         const node = this;
@@ -37,7 +39,7 @@ module.exports = function (RED)
                 return;
             }
 
-            node.status({ fill: "green", shape: "dot", text: (new Date()).toLocaleString() + ": " + message });
+            node.status({ fill: "green", shape: "dot", text: helper.getCurrentTimeForStatus() + ": " + message });
             log = {
                 lookup: lookup,
                 actions: []
@@ -286,12 +288,12 @@ module.exports = function (RED)
         {
             if (action != null && affectedNodes.length > 0)
             {
-                for (const node of affectedNodes)
+                for (const targetNode of affectedNodes)
                 {
-                    if (mode == "light" && !["smart_light-control", "smart_scene-control"].includes(node.type))
+                    if (mode == "light" && !["smart_light-control", "smart_scene-control"].includes(targetNode.type))
                         continue;
 
-                    if (mode == "shutter" && !["smart_shutter-control", "smart_shutter-complex-control"].includes(node.type))
+                    if (mode == "shutter" && !["smart_shutter-control", "smart_shutter-complex-control"].includes(targetNode.type))
                         continue;
 
                     // node.log("Notify node " + node.id);
@@ -299,11 +301,17 @@ module.exports = function (RED)
                     {
                         // console.log({ "topic": action, "payload": number });
                         if (number != null)
-                            RED.events.emit("node:" + node.id, { "topic": action, "payload": number });
+                        {
+                            // console.log(node.id + " -> " + targetNode.id);
+                            // console.log({ "topic": action, "payload": number });
+                            RED.events.emit("node:" + targetNode.id, { "topic": action, "payload": number });
+                        }
                     }
                     else
                     {
-                        RED.events.emit("node:" + node.id, { "topic": action });
+                        // console.log(node.id + " -> " + targetNode.id);
+                        // console.log({ "topic": action });
+                        RED.events.emit("node:" + targetNode.id, { "topic": action });
                     }
                 }
 

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 BergenSoft
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.