node-red-contrib-boolean-logic-ultimate 1.0.39 → 1.0.43

package/.vscode/launch.json

@@ -0,0 +1,17 @@
+{
+    // Usare IntelliSense per informazioni sui possibili attributi.
+    // Al passaggio del mouse vengono visualizzate le descrizioni degli attributi esistenti.
+    // Per altre informazioni, visitare: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "pwa-node",
+            "request": "launch",
+            "name": "Launch Program",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "program": "${workspaceFolder}/boolean-logic-ultimate/BooleanLogicUltimate.js"
+        }
+    ]
+}

package/CHANGELOG.md

@@ -1,6 +1,19 @@
 # node-red-contrib-boolean-logic-ultimate
 [![Donate via PayPal](https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square)](https://www.paypal.me/techtoday) 
 
+<p>
+<b>Version 1.0.44</b> February 2022<br/>
+- Boolean Logic Ultimate: Added the "d" indication, in the node's name, when the delay option is enabled.</br>
+- Boolean Logic Ultimate: Refined the UI.</br>
+</p>
+<p>
+<b>Version 1.0.41</b> January 2022<br/>
+- Boolean Logic Ultimate: UI optimization and remove warning triangle if the delay is not set.</br>
+</p>
+<p>
+<b>Version 1.0.40</b> January 2022<br/>
+- NEW: Boolean Logic Ultimate: Delay option added. See the readme on gitHub.</br>
+</p>
 <p>
 <b>Version 1.0.39</b> November 2021<br/>
 - FIX a possible issue when msg.payload is numeric.</br>

package/README.md

@@ -15,9 +15,15 @@ A set of Node-RED enhanced boolean logic, with persisten values after reboot and
 > Wellcome! First of all thank you for your interest in my nodes. This is a set of logic nodes, to overcome the simplicity of the default node-red boolean logic nodes.
 Hope you enjoy that and if you're in trouble, please ask!
 
+<br/>
+<br/>
+
 ## CHANGELOG
 * See <a href="https://github.com/Supergiovane/node-red-contrib-boolean-logic-ultimate/blob/master/CHANGELOG.md">here the changelog</a>
 
+<br/>
+<br/>
+
 # BOOLEAN LOGIC
 
 <img src='https://raw.githubusercontent.com/Supergiovane/node-red-contrib-boolean-logic-ultimate/master/img/bl1.png' width='60%'>
@@ -63,7 +69,7 @@ Set the number of different topics to be evaluated. The node will output a messa
 *Remember: each input topic must be different. For example, if you set this field to 3, the node expects 3 different topics.*
 
 
-**Filter output result**
+**Filter output**
 
 - Output both 'true' and 'false' results: Standard behaviour, the node will output <b>true</b> and <b>false</b> whenever it receives an input and calculate the boolean logics as output.
 - Output only 'true' results: whenever the node receives an input, it outputs a payload <b>true</b> only if the result of the logic is true. <b>False</b> results are filtered out.
@@ -88,6 +94,12 @@ Every time you modify the node's config, <b>the retained values are cleared</b>.
 
 If checked, the node will accept only boolean true/false values. Otherwise, it will try to convert the payload to a logic value true/false (including "on" and "off" values, sent, for example, from HomeAssistant).<br/>
 
+**Delay evaluation (ms)**
+
+Delays the evaluation until this time (in milliseconds) is elapsed. Each time a message or "topic trigger message" (see **Trigger mode**) arrives, the delay is restarted.<br/>
+This option is useful for debouncing pourposes or simply for adding some delay.<br/>
+For example, you can turn on a light if the room is occupied for a long time, allowing people to fast transit repeatedly, without the need of turning the light on.<br/>
+Another example, if you have many sensors changing state rapidly, you can wait until these sensor reach a quiet state, then evaluate the inputs.<br/>
 
 **INPUT MSG TO THE NODE**
 

package/boolean-logic-ultimate/BooleanLogicUltimate.html

@@ -33,7 +33,8 @@
 						return v !== undefined && v.length > 0;
 					}
 			},
-			restrictinputevaluation:{ value: true }
+			restrictinputevaluation: { value: true },
+			delayEvaluation: { value: 0 }
 		},
 		inputs: 1,
 		outputs: 3,
@@ -60,8 +61,14 @@
 				let label = "";
 				let filtered = this.filtertrue == "both" ? "" : "f";
 				let trigger = "";
-				if (typeof this.outputtriggeredby !== "undefined") trigger = this.outputtriggeredby == "all" ? "" : "t (" + this.triggertopic + ")";
-				label = this.inputCount + ((filtered + trigger) == "" ? " Boolean Logic" : (filtered + trigger));
+				let delayEvaluation = "";
+				if (this.delayEvaluation === 0 || this.delayEvaluation === "0" || this.delayEvaluation === "" || this.delayEvaluation === undefined) {
+					delayEvaluation = "";
+				} else {
+					delayEvaluation = "d(" + this.delayEvaluation + ")";
+				}
+				if (typeof this.outputtriggeredby !== "undefined") trigger = this.outputtriggeredby === "all" ? "" : "t(" + this.triggertopic + ")";
+				label = "Gate " + this.inputCount + filtered + delayEvaluation + trigger;
 				if (this.name !== undefined && this.name.length > 0) {
 					label += " (" + this.name + ")";
 				}
@@ -117,9 +124,9 @@
 
 	<div class="form-row">
         <label for="node-input-inputCount"><i class="fa fa-step-forward"></i> Inputs count</label>
-		<input type="text" id="node-input-inputCount" placeholder="Inputs count, for example: 2">
+		<input style="width:100px" type="text" id="node-input-inputCount" placeholder="Inputs count, for example: 2">
 	</div>
-	<div class="form-tips" style="margin-top: 8px;background-color:lightgrey;text-align:center">Option above: the node waits for this number of <i>different</i> msg topics before evaluating the outputs.</div>
+	<div class="form-tips" style="margin-top: 8px;background-color:lightgreen;text-align:center">Inputs count: each incoming msg.topic represents one input.</div>
 <br/>
 	<div class="form-row">
         <label for="node-input-name"><i class="icon-tag"></i> Name</label>
@@ -130,7 +137,7 @@
         <input type="text" id="node-input-topic" placeholder="Node's own topic">
 	</div>
     <div class="form-row">
-        <label for="node-input-filtertrue"><i class="fa fa-filter"></i> Filter output result</label>
+        <label for="node-input-filtertrue"><i class="fa fa-filter"></i> Filter output</label>
         <select type="text" id="node-input-filtertrue" placeholder="Filter">
 			<option value="both">Output both 'true' and 'false' results</option>
 			<option value="onlytrue">Output only 'true' results</option>
@@ -148,8 +155,8 @@
         <input type="text" id="node-input-triggertopic" placeholder="Input topic">
 	</div>
 	<div class="form-row">
-        <label for="node-input-sInitializeWith"><i class="fa fa-home"></i> If input states are undefined at boot</label>
-        <select type="text" id="node-input-sInitializeWith" placeholder="">
+        <label style="width:250px" for="node-input-sInitializeWith"><i class="fa fa-home"></i> If input states are undefined at boot</label>
+        <select style="width:170px" type="text" id="node-input-sInitializeWith" placeholder="">
 			<option value="WaitForPayload">Leave undefined</option>
 			<option value="false">Initialize all with False</option>
 			<option value="true">Initialize all with True</option>
@@ -165,7 +172,14 @@
 		<input type="checkbox" id="node-input-restrictinputevaluation" style="display:inline-block; width:auto; vertical-align:top;">
 		&nbsp<label style="width:auto" for="node-input-restrictinputevaluation"> Reject non boolean (true/false) input values</label>
 	</div>
-
+	<div class="form-row">
+        <label style="width:160px" for="node-input-delayEvaluation"><i class="fa fa-hourglass-o"></i> Delay evaluation (ms)</label>
+		<input style="width:150px" type="text" id="node-input-delayEvaluation" placeholder="Set 0 for no delay">
+	</div>
+	
+	<br/>
+	<br/>
+	<br/>
 </script>
 
 <script type="text/x-red" data-help-name="BooleanLogicUltimate">

package/boolean-logic-ultimate/BooleanLogicUltimate.js

@@ -10,6 +10,11 @@ module.exports = function (RED) {
 		node.sInitializeWith = typeof node.config.sInitializeWith === "undefined" ? "WaitForPayload" : node.config.sInitializeWith;
 		node.persistPath = path.join(RED.settings.userDir, "booleanlogicultimatepersist"); // 26/10/2020 Contains the path for the states dir.
 		node.restrictinputevaluation = config.restrictinputevaluation === undefined ? false : config.restrictinputevaluation;
+		node.delayEvaluation = config.delayEvaluation === undefined ? 0 : config.delayEvaluation; // 26/01/2022 Starts evaluating the inputs only after this amount of time is elapsed, after the last msg input or trigger
+		if (isNaN(parseInt(node.delayEvaluation)) || parseInt(node.delayEvaluation) < 0) node.delayEvaluation = 0;
+		if (typeof node.delayEvaluation === "string") node.delayEvaluation = parseInt(node.delayEvaluation);
+		node.timerDelayEvaluation = null;
+		node.inputMessage = {}; // 26/01/2022 input message is stored here.
 
 		function setNodeStatus({ fill, shape, text }) {
 			var dDate = new Date();
@@ -63,6 +68,13 @@ module.exports = function (RED) {
 			setNodeStatus({ fill: "yellow", shape: "dot", text: "Waiting for input states" });
 		}
 
+		// Starts the evaluation delay timer, if needed
+		node.startTimerDelayEvaluation = () => {
+			if (node.timerDelayEvaluation !== null) clearTimeout(node.timerDelayEvaluation);
+			node.timerDelayEvaluation = setTimeout(() => {
+				outputResult();
+			}, node.delayEvaluation);
+		}
 
 		// 14/08/2019 If some inputs are to be initialized, create a dummy items in the array
 		initUndefinedInputs();
@@ -128,21 +140,21 @@ module.exports = function (RED) {
 					RED.log.error("BooleanLogicUltimate: unable to write to the filesystem. Check wether the user running node-red, has write permission to the filesysten. " + error.message);
 				}
 			}
+			node.inputMessage = msg; // 26/01/2022 Store MSG to be used in the outputResult function.
 
 			// Do we have as many inputs as we expect?
 			var keyCount = Object.keys(node.jSonStates).length;
-
 			if (keyCount == node.config.inputCount) {
 
-				var resAND = CalculateResult("AND");
-				var resOR = CalculateResult("OR");
-				var resXOR = CalculateResult("XOR");
+				// var resAND = CalculateResult("AND");
+				// var resOR = CalculateResult("OR");
+				// var resXOR = CalculateResult("XOR");
 
-				if (node.config.filtertrue == "onlytrue") {
-					if (!resAND) { resAND = null };
-					if (!resOR) { resOR = null };
-					if (!resXOR) { resXOR = null };
-				}
+				// if (node.config.filtertrue == "onlytrue") {
+				// 	if (!resAND) { resAND = null };
+				// 	if (!resOR) { resOR = null };
+				// 	if (!resXOR) { resXOR = null };
+				// }
 
 				// Operation mode evaluation
 				if (node.config.outputtriggeredby == "onlyonetopic") {
@@ -150,12 +162,22 @@ module.exports = function (RED) {
 						&& node.config.triggertopic !== ""
 						&& msg.hasOwnProperty("topic") && msg.topic !== ""
 						&& node.config.triggertopic === msg.topic) {
-						SetResult(resAND, resOR, resXOR, node.config.topic, msg);
+						if (node.delayEvaluation > 0) {
+							node.startTimerDelayEvaluation();
+							setNodeStatus({ fill: "blue", shape: "ring", text: "Delay Eval " + node.delayEvaluation + "ms" });
+						} else {
+							outputResult();
+						}
 					} else {
 						setNodeStatus({ fill: "grey", shape: "ring", text: "Saved (" + (msg.hasOwnProperty("topic") ? msg.topic : "empty input topic") + ") " + value });
 					}
 				} else {
-					SetResult(resAND, resOR, resXOR, node.config.topic, msg);
+					if (node.delayEvaluation > 0) {
+						node.startTimerDelayEvaluation();
+						setNodeStatus({ fill: "blue", shape: "ring", text: "Delay Eval " + node.delayEvaluation + "ms" });
+					} else {
+						outputResult();
+					}
 				}
 			}
 			else if (keyCount > node.config.inputCount) {
@@ -280,30 +302,41 @@ module.exports = function (RED) {
 			return res;
 		};
 
-		function SetResult(_valueAND, _valueOR, _valueXOR, optionalTopic, _msg) {
-			setNodeStatus({ fill: "green", shape: "dot", text: "(AND)" + (_valueAND !== null ? _valueAND : "---") + " (OR)" + (_valueOR !== null ? _valueOR : "---") + " (XOR)" + (_valueXOR !== null ? _valueXOR : "---") });
+		function outputResult() {
+			let optionalTopic = node.config.topic;
+			let calculatedValueAND = CalculateResult("AND");
+			let calculatedValueOR = CalculateResult("OR");
+			let calculatedValueXOR = CalculateResult("XOR");
+
+			if (node.config.filtertrue == "onlytrue") {
+				if (!calculatedValueAND) { calculatedValueAND = null };
+				if (!calculatedValueOR) { calculatedValueOR = null };
+				if (!calculatedValueXOR) { calculatedValueXOR = null };
+			}
+
+			setNodeStatus({ fill: "green", shape: "dot", text: "(AND)" + (calculatedValueAND !== null ? calculatedValueAND : "---") + " (OR)" + (calculatedValueOR !== null ? calculatedValueOR : "---") + " (XOR)" + (calculatedValueXOR !== null ? calculatedValueXOR : "---") });
 
 			var msgAND = null;
-			if (_valueAND != null) {
-				msgAND = RED.util.cloneMessage(_msg);
+			if (calculatedValueAND != null) {
+				msgAND = RED.util.cloneMessage(node.inputMessage);
 				msgAND.topic = optionalTopic === undefined ? "result" : optionalTopic;
 				msgAND.operation = "AND";
-				msgAND.payload = _valueAND;
+				msgAND.payload = calculatedValueAND;
 
 			}
 			var msgOR = null;
-			if (_valueOR != null) {
-				msgOR = RED.util.cloneMessage(_msg);
+			if (calculatedValueOR != null) {
+				msgOR = RED.util.cloneMessage(node.inputMessage);
 				msgOR.topic = optionalTopic === undefined ? "result" : optionalTopic;
 				msgOR.operation = "OR";
-				msgOR.payload = _valueOR;
+				msgOR.payload = calculatedValueOR;
 			}
 			var msgXOR = null;
-			if (_valueXOR != null) {
-				msgXOR = RED.util.cloneMessage(_msg);
+			if (calculatedValueXOR != null) {
+				msgXOR = RED.util.cloneMessage(node.inputMessage);
 				msgXOR.topic = optionalTopic === undefined ? "result" : optionalTopic;
 				msgXOR.operation = "XOR";
-				msgXOR.payload = _valueXOR;
+				msgXOR.payload = calculatedValueXOR;
 			}
 			node.send([msgAND, msgOR, msgXOR]);
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-red-contrib-boolean-logic-ultimate",
-    "version": "1.0.39",
+    "version": "1.0.43",
     "description": "A set of Node-RED enhanced boolean logic node, flow interruption node, blinker node, invert node, filter node, with persisten values after reboot and more.",
     "author": "Supergiovane (https://github.com/Supergiovane)",
     "dependencies": {