node-red-contrib-boolean-logic-ultimate 1.0.45 → 1.0.49

package/CHANGELOG.md

@@ -1,6 +1,23 @@
 # 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.48</b> February 2022<br/>
+- NEW: TOGGLE node: Simple toggle node.</br>
+</p>
+<p>
+<b>Version 1.0.48</b> February 2022<br/>
+- NEW: SUM node: this new node makes sum, average and measurement count.</br>
+</p>
+<p>
+<b>Version 1.0.47</b> February 2022<br/>
+- NEW: Interrupt Flow: the node now stores the last message, even if in the "stop" state.</br>
+</p>
+<p>
+<b>Version 1.0.46</b> February 2022<br/>
+- NEW: Interrupt Flow: msg.reset will delete the stored message.</br>
+- Updated the README file with samples.</br>
+</p>
 <p>
 <b>Version 1.0.45</b> February 2022<br/>
 - NEW: Interrupt Flow: Now you can auto-toggle the startup behavior selection (to stop or to pass telegrams) after some pre-defined delays.</br>

package/README.md

@@ -116,9 +116,41 @@ Resets all inputs to undefined.
 
 # INTERRUPT FLOWS ULTIMATE
 
-Whenever this node receives a payload = false from a specific topic, it stops output messages to the flow. As soon it receives payload = true from this topic, the output messages start to flow out again.<br/>
+**Trigger by topic**
+
+Whenever the node receives a payload = false from this topic,it stops output messages to the flow.<br/>
+As soon it receives payload = true from this topic, the output messages start to flow out again. <br/>
+The node will output the current stored message plus an added property "isReplay = true", as soon as it receives a ***msg.play = true*** from this topic.<br/>
+The node will clear the current stored message, as soon as it receives a ***msg.reset = true*** from this topic.<br/>
 The node tries to convert any arbitrary input value to a valid boolean value. It converts Homeassistant ***"on"*** and ***"off"*** to true/false values as well.<br/>
-The *Then* option, allow you to auto toggle the selected start state (pass or block) after a timer has elapsed. You can choose from some pre-defined delays. If you have, for example, an Homekit-Bridged nodeset with a thermostat node or security system node in your flow, once node-red restarts, these homekit nodes output a default message to the flow. Just put an InterruptFlow node with a "block at start" behaviour and a toggle delay enabled behind homekit nodes, to temporary stop the chained nodes to receive the unwanted startup message.</br>
+
+**Then** 
+This property, allow you to auto toggle the selected start state (pass or block) after a timer has elapsed. You can choose from some pre-defined delays. If you have, for example, an Homekit-Bridged nodeset with a thermostat node or security system node in your flow, once node-red restarts, these homekit nodes output a default message to the flow. Just put an InterruptFlow node with a "block at start" behaviour and a toggle delay enabled behind homekit nodes, to temporary stop the chained nodes to receive the unwanted startup message.</br>
+</br>
+
+**INPUT MSG HWITH "TRIGGER" TOPIC**
+
+Pass <code>msg.payload = true</code> to allow messages to pass through</br>
+Pass <code>msg.payload = false</code> to prevent messages from passing through</br>
+Pass <code>msg.play = true</code> from a message having the "trigger" topic, to replay the last stored message</br>
+Pass <code>msg.reset = true</code> from a message having the "trigger" topic, to clear the last stored message</br>
+
+<code>
+// Assume you set the "trigger by topic" field to "trigger" 
+// This code replays the last message and adds the property msg.isReplay = true to the output message.
+msg.topic = "trigger"
+msg.play = true;
+</code>
+
+<code>
+// Assume you set the "trigger by topic" field to "trigger" 
+// This code clears the last stored message
+msg.topic = "trigger"
+msg.reset = true;
+</code>
+
+</br>
+
 See the example below.<br/>
 
 <img src='https://raw.githubusercontent.com/Supergiovane/node-red-contrib-boolean-logic-ultimate/master/img/if0.png' width='60%'>
@@ -291,6 +323,57 @@ Pass <code>msg.payload = false</code> to the node to stop the running sequence</
 
 - Output: the node outputs a message you specified in the command textbox<br/>
 
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+
+# SUM ULTIMATE
+
+The pourpose of this node is to sum the incoming values. Each incoming message MUST HAVE OWN TOPIC.<br />
+
+<img src='https://raw.githubusercontent.com/Supergiovane/node-red-contrib-boolean-logic-ultimate/master/img/sum.png' width='60%'>
+<details><summary>CLICK HERE, copy and paste it into your flow</summary>
+<code>
+[{"id":"05b6ce0cb476abd5","type":"SumUltimate","z":"d8fbf871e381cf2c","name":"Sum","property":"payload","x":550,"y":160,"wires":[["567aa6a9719e463e","34fbca5daf8b9fab","e3c2a45a0b77af8f"]]},{"id":"6744e01b88d820b9","type":"inject","z":"d8fbf871e381cf2c","name":"","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"Watt Table Lamp","payload":"10","payloadType":"num","x":250,"y":140,"wires":[["05b6ce0cb476abd5"]]},{"id":"75823dbc7db78c3c","type":"inject","z":"d8fbf871e381cf2c","name":"","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"Watt Washing machine","payload":"20","payloadType":"num","x":270,"y":180,"wires":[["05b6ce0cb476abd5"]]},{"id":"567aa6a9719e463e","type":"debug","z":"d8fbf871e381cf2c","name":"Sum","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":690,"y":160,"wires":[]},{"id":"1793931ba218bc1d","type":"inject","z":"d8fbf871e381cf2c","name":"Reset","props":[{"p":"reset","v":"","vt":"date"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","x":210,"y":240,"wires":[["05b6ce0cb476abd5"]]},{"id":"0b3277af03f546d4","type":"comment","z":"d8fbf871e381cf2c","name":"Getting Sum, Average etc. from the SUM node.","info":"","x":320,"y":100,"wires":[]},{"id":"34fbca5daf8b9fab","type":"debug","z":"d8fbf871e381cf2c","name":"Average","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"average","targetType":"msg","statusVal":"","statusType":"auto","x":700,"y":200,"wires":[]},{"id":"e3c2a45a0b77af8f","type":"debug","z":"d8fbf871e381cf2c","name":"Measurements","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"measurements","targetType":"msg","statusVal":"","statusType":"auto","x":720,"y":240,"wires":[]}]
+</code>
+</details>
+
+**INPUT**<br />
+
+<br /><b>msg.reset</b><br />
+resets the values to zero.
+
+<br />
+
+- Output: the node outputs a message as follows:<br/>
+
+<pre>
+{
+  "payload": 30, // This is the SUM
+  "topic": "Sum", // Node  Topic
+  "average": 15, // This is the AVERAVE
+  "measurements": 2 // This is the number of topics that have been evaluated
+}
+</pre>
+
+br/>
+<br/>
+<br/>
+<br/>
+<br/>
+
+# TOGGLE ULTIMATE
+
+The pourpose of this node is to toggle between true/false the payload of every incoming message.<br />
+
+
+**INPUT**<br />
+
+Any message that arrives on input, will be passwd through to the output with the payload toggled between true and false.
+
+
 
 [license-image]: https://img.shields.io/badge/license-MIT-blue.svg
 [license-url]: https://github.com/Supergiovane/node-red-contrib-boolean-logic-ultimate/master/LICENSE

package/boolean-logic-ultimate/InterruptFlowUltimate.html

@@ -49,7 +49,8 @@
         <label for="node-input-triggertopic"><i class="icon-tag"></i> Trigger by topic</label>
 		<input type="text" id="node-input-triggertopic" placeholder="Name">
 		<div><i>Whenever the node receives a payload = false from this topic,<br/> it stops output messages to the flow.<br/>As soon it receives payload = true from this topic,<br/>the output messages start to flow out again.
-		<br/>The node will output the current stored message<br/>plus an added property "isReplay = true",<br/>as soon as it receives a "play" = true from this topic.
+		<br/>The node will output the current stored message<br/>plus an added property "isReplay = true",<br/>as soon as it receives a "play" = true from this topic.</br>
+		The node will clear the current stored message, as soon as it receives a "msg.reset = true" from this topic.
 	</i></div>
     </div>
 

package/boolean-logic-ultimate/InterruptFlowUltimate.js

@@ -55,17 +55,25 @@ module.exports = function (RED) {
 					if (node.timerAutoToggle !== null) clearInterval(node.timerAutoToggle);
 
 					if (msg.hasOwnProperty("play")) {
-						node.currentMsg.isReplay = true;
-						setNodeStatus({ fill: "yellow", shape: "dot", text: "-> replay" });
-						// Restore previous status
-						setTimeout(() => {
-							if (node.bInviaMessaggio) {
-								setNodeStatus({ fill: "green", shape: "dot", text: "-> pass" });
-							} else {
-								setNodeStatus({ fill: "red", shape: "dot", text: "|| stop (stored last msg)" });
-							}
-						}, 1000)
-						node.send(node.currentMsg);
+						if (node.currentMsg.payload !== undefined) {
+							node.currentMsg.isReplay = true;
+							setNodeStatus({ fill: "yellow", shape: "dot", text: "-> replay" });
+							// Restore previous status
+							setTimeout(() => {
+								if (node.bInviaMessaggio) {
+									setNodeStatus({ fill: "green", shape: "dot", text: "-> pass" });
+								} else {
+									setNodeStatus({ fill: "red", shape: "dot", text: "|| stop (stored last msg)" });
+								}
+							}, 1000)
+							node.send(node.currentMsg);
+						} else {
+							setNodeStatus({ fill: "grey", shape: "dot", text: "Nothing to replay" });
+						}
+						return;
+					} else if (msg.hasOwnProperty("reset")) {
+						node.currentMsg = {};
+						setNodeStatus({ fill: "yellow", shape: "dot", text: "Deleted stored msg" });
 						return;
 					} else if (msg.payload === true) {
 						node.bInviaMessaggio = true;
@@ -78,8 +86,8 @@ module.exports = function (RED) {
 					}
 				}
 			}
+			node.currentMsg = RED.util.cloneMessage(msg);
 			if (node.bInviaMessaggio) {
-				node.currentMsg = msg;
 				node.send(msg);
 			}
 		});

package/boolean-logic-ultimate/SumUltimate.html

@@ -0,0 +1,54 @@
+<script type="text/javascript">
+    RED.nodes.registerType('SumUltimate', {
+        category: 'boolean logic ultimate',
+        color: '#ff8080',
+        defaults: {
+            name: {
+                value: "Sum"
+            },
+            property: {
+                value: "payload"
+            }
+            
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: "font-awesome/fa-plus",
+        label:
+            function () {
+                return this.name || "Sum";
+            },
+        paletteLabel: function () {
+            return "SumUltimate";
+        }
+    });
+</script>
+
+<script type="text/x-red" data-template-name="SumUltimate">
+	<div class="form-row">
+		<b>Status Ultimate</b>&nbsp&nbsp&nbsp&nbsp<span style="color:red"><i class="fa fa-question-circle"></i>&nbsp<a target="_blank" href="https://github.com/Supergiovane/node-red-contrib-boolean-logic-ultimate"><u>Help online</u></a></span>
+		<br/>
+		<br/>        
+	</div>
+    <div class="form-row">
+        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-property"><i class="icon-tag"></i> Sum msg.</label>
+        <input type="text" id="node-input-property" placeholder="payload">
+    </div>
+</script>
+
+<script type="text/x-red" data-help-name="SumUltimate">
+	<p>
+        SEE THE README FOR HELP CONFIGURING THE NODE
+    </p>
+
+	<p>
+		<a href="https://github.com/Supergiovane/node-red-contrib-boolean-logic-ultimate" target="_blank">Click here to learn how to configure the node.</a>
+	</p>
+
+	<a href="https://www.paypal.me/techtoday" target="_blank"><img src='https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square' width='30%'></a>
+    
+</script>

package/boolean-logic-ultimate/SumUltimate.js

@@ -0,0 +1,88 @@
+module.exports = function (RED) {
+	function SumUltimate(config) {
+		RED.nodes.createNode(this, config);
+		this.config = config;
+		var node = this;
+		this.topics = {};
+
+		function setNodeStatus({ fill, shape, text }) {
+			var dDate = new Date();
+			node.status({ fill: fill, shape: shape, text: text + " (" + dDate.getDate() + ", " + dDate.toLocaleTimeString() + ")" })
+		}
+
+		setNodeStatus({ fill: "grey", shape: "dot", text: "" });
+
+		function fetchFromObject(obj, prop) {
+
+			if (obj === undefined) {
+				return undefined;
+			}
+
+			var _index = prop.indexOf('.')
+			if (_index > -1) {
+				return fetchFromObject(obj[prop.substring(0, _index)], prop.substr(_index + 1));
+			}
+
+			return obj[prop];
+		}
+
+		this.on('input', function (msg) {
+
+			// handle reset
+			if (msg.hasOwnProperty("reset")) {
+				node.topics = {};
+				setNodeStatus({ fill: "grey", shape: "ring", text: "Reset" });
+				return;
+			}
+
+			if (!msg.hasOwnProperty("topic")) {
+				setNodeStatus({ fill: "red", shape: "ring", text: "Incoming msg without topic! Please set the topic." });
+				return;
+			}
+
+			try {
+				let props = [] = this.config.property.split(".");
+				let ret = fetchFromObject(msg, this.config.property);
+				if (ret !== undefined) {
+
+					ret = Number(ret);
+
+					// Sum
+					if (!isNaN(ret) && isFinite(ret)) {
+						node.topics[msg.topic.toString()] = ret;
+
+						var quantita = 0;
+						var somma = Object.keys(node.topics).reduce(function (a, b) {
+							++quantita;
+							return a + node.topics[b];
+						}, 0);
+
+						msg.payload = somma; // Sum
+						msg.average = somma / quantita; // Average
+						msg.measurements = quantita; // Topics
+
+						// overwrite topic if configured
+						if (config.name) {
+							msg.topic = config.name;
+						}
+					}
+
+					// everything else
+					else {
+						setNodeStatus({ fill: "red", shape: "ring", text: "Not a number" });
+					}
+
+				} else {
+					setNodeStatus({ fill: "red", shape: "ring", text: this.config.property + " is undefined." });
+				}
+			} catch (error) {
+				setNodeStatus({ fill: "red", shape: "ring", text: error.message });
+			}
+			setNodeStatus({ fill: "green", shape: "dot", text: "Sum " + msg.payload });
+			node.send(msg);
+		});
+
+	}
+
+	RED.nodes.registerType("SumUltimate", SumUltimate);
+}

package/boolean-logic-ultimate/toggleUltimate.html

@@ -0,0 +1,63 @@
+<script type="text/javascript">
+	RED.nodes.registerType('toggleUltimate', {
+		category: 'boolean logic ultimate',
+		color: '#ff8080',
+		defaults: {
+			name: {
+				value: "Toggle"
+			},
+			valueToToggle: { value: "true" }
+		},
+		inputs: 1,
+		outputs: 1,
+		icon: "serial.png",
+		label:
+			function () {
+				return this.name || "Toggle";
+			},
+		paletteLabel: function () {
+			return "toggleUltimate";
+		}
+	});
+</script>
+
+<script type="text/x-red" data-template-name="toggleUltimate">
+	<div class="form-row">
+		<b>Toggle Ultimate</b>&nbsp&nbsp&nbsp&nbsp<span style="color:red"><i class="fa fa-question-circle"></i>&nbsp<a target="_blank" href="https://github.com/Supergiovane/node-red-contrib-boolean-logic-ultimate"><u>Help online</u></a></span>
+		<br/>
+		<br/>        
+	</div>
+    <div class="form-row">
+        <label for="node-input-name"><i class="icon-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+	<div class="form-row">
+		<label style="width:160px" for="node-input-valueToToggle"><i class="fa fa-toggle-on"></i> Initial value</label>
+		<select type="text" id="node-input-valueToToggle" placeholder="">
+			<option value="true">Initialize wiht True</option>
+			<option value="false">Initialize with False</option>			
+		</select>
+	</div>
+	<!-- <div class="form-row">
+		<input type="checkbox" id="node-input-homeAssitantBoolean" style="display:inline-block; width:auto; vertical-align:top;">
+		&nbsp;		
+		<label style="width:85%" for="node-input-homeAssitantBoolean">
+			<i class="fa fa-home"></i>&nbsp;Output Home Assistant "on"/"off" instead of true/false
+		</label>
+	</div> -->
+	
+	
+</script>
+
+<script type="text/x-red" data-help-name="toggleUltimate">
+    <p>
+        SEE THE README FOR HELP CONFIGURING THE NODE
+    </p>
+
+	<p>
+		<a href="https://github.com/Supergiovane/node-red-contrib-boolean-logic-ultimate" target="_blank">Click here to learn how to configure the node.</a>
+	</p>
+
+	<a href="https://www.paypal.me/techtoday" target="_blank"><img src='https://img.shields.io/badge/Donate-PayPal-blue.svg?style=flat-square' width='30%'></a>
+
+</script>

package/boolean-logic-ultimate/toggleUltimate.js

@@ -0,0 +1,71 @@
+module.exports = function (RED) {
+	function toggleUltimate(config) {
+		RED.nodes.createNode(this, config);
+		this.config = config;
+		var node = this;
+		node.valueToToggle = config.valueToToggle === undefined ? true : ToBoolean(config.valueToToggle);
+
+		function setNodeStatus({ fill, shape, text }) {
+			var dDate = new Date();
+			node.status({ fill: fill, shape: shape, text: text + " (" + dDate.getDate() + ", " + dDate.toLocaleTimeString() + ")" })
+		}
+
+		setNodeStatus({ fill: "grey", shape: "dot", text: "Waiting" });
+
+		this.on('input', function (msg) {
+
+
+			// 15/11/2021 inform user about undefined topic or payload
+			if (!msg.hasOwnProperty("payload") || msg.payload === undefined || msg.payload === null) {
+				setNodeStatus({ fill: "red", shape: "dot", text: "Received invalid payload from " + msg.topic || "" });
+				return;
+			}
+
+			node.valueToToggle = !node.valueToToggle;
+			
+			var msgOUT = RED.util.cloneMessage(msg);
+			try {
+				msgOUT.payload = node.valueToToggle;
+				setNodeStatus({ fill: "green", shape: "dot", text: "(Send) " + msgOUT.payload });
+				node.send(msgOUT);
+			} catch (error) {
+				setNodeStatus({ fill: "red", shape: "dot", text: "Unable to invert the input payload " + bRes });
+			}
+
+		});
+
+
+
+		function ToBoolean(value) {
+			var res = false;
+			var decimal = /^\s*[+-]{0,1}\s*([\d]+(\.[\d]*)*)\s*$/
+
+			if (typeof value === 'boolean') {
+				res = value;
+			}
+			else if (typeof value === 'number' || typeof value === 'string') {
+
+				if (typeof value === "string" && value.toLowerCase() === "on") return true;
+				if (typeof value === "string" && value.toLowerCase() === "off") return false;
+
+				// Is it formated as a decimal number?
+				if (decimal.test(value)) {
+					var v = parseFloat(value);
+					res = v != 0;
+				}
+				else {
+					res = value.toLowerCase() === "true";
+				}
+			}
+
+			return res;
+		};
+
+
+
+	}
+
+
+
+	RED.nodes.registerType("toggleUltimate", toggleUltimate);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-red-contrib-boolean-logic-ultimate",
-    "version": "1.0.45",
+    "version": "1.0.49",
     "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": {
@@ -29,7 +29,9 @@
             "SimpleOutputUltimate": "boolean-logic-ultimate/SimpleOutputUltimate.js",
             "InjectUltimate": "boolean-logic-ultimate/InjectUltimate.js",
             "StatusUltimate": "boolean-logic-ultimate/StatusUltimate.js",
-            "ImpulseUltimate": "boolean-logic-ultimate/ImpulseUltimate.js"
+            "ImpulseUltimate": "boolean-logic-ultimate/ImpulseUltimate.js",
+            "SumUltimate": "boolean-logic-ultimate/SumUltimate.js",
+            "toggleUltimate": "boolean-logic-ultimate/toggleUltimate.js"
         }
     }
 }