node-red-contrib-boolean-logic-ultimate 1.0.51 → 1.0.52

package/CHANGELOG.md

@@ -3,6 +3,11 @@
 
 # CHANGELOG
 
+<p>
+<b>Version 1.0.52</b> Mai 2022<br/>
+- NEW: Railway Switcher Ultimate: new node to switch the input message to an output pin (https://youtu.be/1SjYE7d04u4).</br>
+- Updated README with samples of Railway Switch node.
+</p>
 <p>
 <b>Version 1.0.51</b> February 2022<br/>
 - Blinker Ultimate: fixed minor problem with an orphan timer.</br>

package/README.md

@@ -113,6 +113,8 @@ Resets all inputs to undefined.
 
 # INTERRUPT FLOWS ULTIMATE
 
+The interrupt flows is able to stop the input messages to exiting the node.
+
 **Trigger by topic**
 
 Whenever the node receives a payload = false from this topic,it stops output messages to the flow.<br/>
@@ -125,7 +127,7 @@ The node tries to convert any arbitrary input value to a valid boolean value. It
 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**
+**INPUT MSG WITH "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>
@@ -370,6 +372,43 @@ The pourpose of this node is to toggle between true/false the payload of every i
 
 Any message that arrives on input, will be passwd through to the output with the payload toggled between true and false.
 
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+
+# RAILWAY SWITCH ULTIMATE
+
+The railway switcher, switches the input msg flow to one ot the two output pins (upper or lower).
+
+<img src='https://raw.githubusercontent.com/Supergiovane/node-red-contrib-boolean-logic-ultimate/master/img/railroadSwitchScambio.png' width='80%'>
+
+**Switcher topic**
+
+Whenever the node receives a payload from this **topic**, it switches the input messages to an output PIN.<br/>
+
+**Then** 
+This property, allow you to auto toggle the selected start state after some time.</br>
+</br>
+
+**INPUT MSG WITH "TRIGGER" TOPIC**
+
+Pass <code>msg.payload = false</code> switches the msg input to the UPPER PIN</br>
+Pass <code>msg.payload = true</code> switches the msg input to the LOWER PIN</br>
+
+</br>
+
+See the example below.<br/>
+
+<img src='https://raw.githubusercontent.com/Supergiovane/node-red-contrib-boolean-logic-ultimate/master/img/railwaySwitch.png' width='60%'>
+
+Copy and paste it into your flow
+```javascript
+[{"id":"a6993d5187f05c0a","type":"RailwaySwitchUltimate","z":"e5b506b72b42922e","name":"Railway Switch","triggertopic":"trigger","initializewith":"0","autoToggle":"0","x":490,"y":180,"wires":[["51e7df8da0bd8d67"],["7f33b14e12c91744"]]},{"id":"2e3014226290f678","type":"InjectUltimate","z":"e5b506b72b42922e","name":"Sample message","topic":"Train","curVal":true,"x":180,"y":140,"wires":[["a6993d5187f05c0a"],[],[]]},{"id":"f6f80cd77a65073e","type":"InjectUltimate","z":"e5b506b72b42922e","name":"Railway switcher","topic":"trigger","curVal":true,"x":180,"y":220,"wires":[[],[],["a6993d5187f05c0a"]]},{"id":"51e7df8da0bd8d67","type":"debug","z":"e5b506b72b42922e","name":"Upper railway","active":true,"tosidebar":true,"console":false,"tostatus":true,"complete":"true","targetType":"full","statusVal":"topic","statusType":"msg","x":720,"y":140,"wires":[]},{"id":"7f33b14e12c91744","type":"debug","z":"e5b506b72b42922e","name":"Lower railway","active":true,"tosidebar":true,"console":false,"tostatus":true,"complete":"true","targetType":"full","statusVal":"topic","statusType":"msg","x":720,"y":220,"wires":[]},{"id":"8716120e94a7b6ee","type":"comment","z":"e5b506b72b42922e","name":"Switch between railways","info":"","x":190,"y":80,"wires":[]}]
+```
+
+
 
 
 [license-image]: https://img.shields.io/badge/license-MIT-blue.svg

package/boolean-logic-ultimate/RailwaySwitchUltimate.html

@@ -0,0 +1,92 @@
+<script type="text/javascript">
+	RED.nodes.registerType('RailwaySwitchUltimate', {
+		category: 'boolean logic ultimate',
+		color: '#ff8080',
+		defaults: {
+			name: { value: "Railway Switch" },
+			triggertopic: { value: "trigger" },
+			initializewith: { value: "0" },
+			autoToggle: { value: "0" }
+		},
+		inputs: 1,
+		outputs: 2,
+		outputLabels: function (i) {
+			var ret = "";
+			switch (i) {
+				case 0:
+					return "Upper PIN";
+					break;
+				case 1:
+					return "Lower PIN";
+					break;
+				default:
+					break;
+			}
+		},
+		icon: "font-awesome/fa-train",
+		label:
+			function () {
+				return (this.name || "Switch") + " (" + this.triggertopic + ")";
+			},
+		paletteLabel: function () {
+			return "RailwaySwitchUltimate";
+		}
+	});
+</script>
+
+<script type="text/x-red" data-template-name="RailwaySwitchUltimate">
+	<div class="form-row">
+		<b>Railway Switch 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>
+		&nbsp&nbsp&nbsp<span style="color:red"><i class="fa fa-youtube-play"></i>&nbsp<a target="_blank" href="https://youtu.be/1SjYE7d04u4"><u>Youtube Sample</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-triggertopic"><i class="icon-tag"></i> Switcher topic</label>
+		<input type="text" id="node-input-triggertopic" placeholder="Name">
+		<div><i>An input msg having this topic and payload true or false<br/>will trigger the railway switch between the two output PINs<br/>
+			msg.payload = false switches to the upper PIN<br/>
+			msg.payload = true switches to the lower PIN<br/>
+		</i></div>
+    </div>
+
+	<div class="form-row">
+        <label style="width:160px" for="node-input-initializewith"><i class="fa fa-home"></i> At node-red start</label>
+        <select type="text" id="node-input-initializewith" placeholder="" style="width:250px">
+			<option value="0">Flow messages to the upper PIN</option>
+			<option value="1">Flow messages to the lower PIN</option>			
+		</select>	
+	</div>
+	<div class="form-row">
+		<label style="width:160px" for="node-input-autoToggle"><i class="fa fa-hourglass-o"></i> Then</label>
+		<select type="text" id="node-input-autoToggle" placeholder="" style="width:250px">
+			<option value="0">Nothing</option>
+			<option value="10">Toggle above option after 10 seconds</option>
+			<option value="20">Toggle above option after 20 seconds</option>
+			<option value="30">Toggle above option after 30 seconds</option>
+			<option value="40">Toggle above option after 40 seconds</option>
+			<option value="50">Toggle above option after 50 seconds</option>
+			<option value="60">Toggle above option after 60 seconds</option>
+			<option value="90">Toggle above option after 90 seconds</option>
+			<option value="120">Toggle above option after 120 seconds</option>
+		</select>
+	</div>
+</script>
+
+<script type="text/x-red" data-help-name="RailwaySwitchUltimate">
+	<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/RailwaySwitchUltimate.js

@@ -0,0 +1,103 @@
+module.exports = function (RED) {
+	function RailwaySwitchUltimate(config) {
+		RED.nodes.createNode(this, config);
+		this.config = config;
+		var node = this;
+		node.currentMsg = {}; // Stores current payload
+		node.sTriggerTopic = node.config.triggertopic.replace(/[`~!@#$%^&*()_|+\-=?;:'",.<>\{\}\[\]\\\/]/gi, '') || "trigger"; // Topic controlling the iRailway
+		node.iRailway = Number(node.config.initializewith); // Railway selector
+		node.autoToggle = config.autoToggle === undefined ? 0 : parseInt(config.autoToggle); // Auto toggle the selected "initializewith" after a while (useful for homekit bridged, that sends junk after start)
+		node.timerAutoToggle = null;
+
+		function setNodeStatus({ fill, shape, text }) {
+			let dDate = new Date();
+			node.status({ fill: fill, shape: shape, text: text + " (" + dDate.getDate() + ", " + dDate.toLocaleTimeString() + ")" })
+		}
+
+		node.alignStatus = () => {
+			let sAutoToggle = node.autoToggle > 0 ? " (Autotoggle in " + node.autoToggle + "s)" : "";
+			if (node.iRailway === 0) {
+				setNodeStatus({ fill: "green", shape: "dot", text: "-> UPPER PIN" + sAutoToggle });
+			} else {
+				setNodeStatus({ fill: "blue", shape: "dot", text: "-> LOWER PIN" + sAutoToggle });
+			}
+		}
+
+		if (node.autoToggle > 0) {
+			node.timerAutoToggle = setTimeout(() => {
+				node.autoToggle = 0;
+				node.iRailway === 0 ? node.iRailway = 1 : node.iRailway = 0;
+				node.alignStatus();
+			}, node.autoToggle * 1000);
+		}
+
+		node.alignStatus();
+
+		this.on('input', function (msg) {
+			var sIncomingTopic = "";
+			if (msg.hasOwnProperty("topic")) {
+				// 06/11/2019 
+				if (!msg.hasOwnProperty("topic") || msg.topic === undefined) msg.topic = "NoTopicReceived";
+				sIncomingTopic = msg.topic.replace(/[`~!@#$%^&*()_|+\-=?;:'",.<>\{\}\[\]\\\/]/gi, ''); // Cut unwanted Characters
+				if (sIncomingTopic === node.sTriggerTopic) {
+
+					// 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;
+					}
+
+					msg.payload = ToBoolean(msg.payload); // 15/11/2021 Convert input to boolean.
+
+					// 28/01/2022 Stop autotoggle
+					if (node.timerAutoToggle !== null) clearInterval(node.timerAutoToggle);
+
+					if (msg.payload === false) node.iRailway = 0;
+					if (msg.payload === true) node.iRailway = 1;
+					if (node.iRailway === 0) {
+						setNodeStatus({ fill: "green", shape: "dot", text: "-> UPPER PIN" });
+					} else {
+						setNodeStatus({ fill: "blue", shape: "dot", text: "-> LOWER PIN" });
+					}
+					return; // DONT'S SEND THIS MESSAGE
+				}
+			}
+			node.currentMsg = RED.util.cloneMessage(msg);
+			if (node.iRailway === 0) {
+				node.send([msg, null]);
+			} else {
+				node.send([null, msg]);
+			}
+		});
+
+
+
+
+		function ToBoolean(value) {
+			let res = false;
+			let 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)) {
+					res = parseFloat(value) != 0;
+				}
+				else {
+					res = value.toLowerCase() === "true";
+				}
+			}
+
+			return res;
+		};
+	}
+
+
+	RED.nodes.registerType("RailwaySwitchUltimate", RailwaySwitchUltimate);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-red-contrib-boolean-logic-ultimate",
-    "version": "1.0.51",
+    "version": "1.0.52",
     "description": "A set of Node-RED enhanced boolean logic and utility nodes, flow interruption, blinker, invert, filter, toggle etc.., with persistent values after reboot. Compatible also with Homeassistant ON and OFF values.",
     "author": "Supergiovane (https://github.com/Supergiovane)",
     "dependencies": {
@@ -31,7 +31,8 @@
             "StatusUltimate": "boolean-logic-ultimate/StatusUltimate.js",
             "ImpulseUltimate": "boolean-logic-ultimate/ImpulseUltimate.js",
             "SumUltimate": "boolean-logic-ultimate/SumUltimate.js",
-            "toggleUltimate": "boolean-logic-ultimate/toggleUltimate.js"
+            "toggleUltimate": "boolean-logic-ultimate/toggleUltimate.js",
+            "RailwaySwitchUltimate": "boolean-logic-ultimate/RailwaySwitchUltimate.js"
         }
     }
-}
+}