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

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 # 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.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%'>

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;
@@ -79,7 +87,7 @@ module.exports = function (RED) {
 				}
 			}
 			if (node.bInviaMessaggio) {
-				node.currentMsg = msg;
+				node.currentMsg = RED.util.cloneMessage(msg);
 				node.send(msg);
 			}
 		});

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-red-contrib-boolean-logic-ultimate",
-    "version": "1.0.45",
+    "version": "1.0.46",
     "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": {