node-red-contrib-boolean-logic-ultimate 1.0.63 → 1.1.0

package/boolean-logic-ultimate/Comparator.html

@@ -17,7 +17,7 @@
             },
             topic2: {
                 value: "", required: true
-            },
+            }           
         },
         inputs: 1,
         outputs: 1,
@@ -31,7 +31,7 @@
         },
         oneditprepare: function () {
             if ($("#node-input-property").val() === "") $("#node-input-property").val("payload");
-            $("#node-input-property").typedInput({ default: 'msg', types: ['msg'] });            
+            $("#node-input-property").typedInput({ default: 'msg', types: ['msg'] });
         }
     });
 </script>
@@ -70,6 +70,7 @@
         <label for="node-input-topic2"><i class="icon-tag"></i> Topic 2</label>
         <input type="text" id="node-input-topic2" placeholder="For example, topic 2">
     </div>
+    
 </script>
 
 <script type="text/markdown" data-help-name="Comparator">

package/boolean-logic-ultimate/Comparator.js

@@ -6,7 +6,7 @@ module.exports = function (RED) {
     node.math = config.math === undefined ? "===" : config.math;
     node.topic1Value = undefined;
     node.topic2Value = undefined;
-
+    
     function setNodeStatus({ fill, shape, text }) {
       let dDate = new Date();
       node.status({

package/boolean-logic-ultimate/FilterUltimate.html

@@ -6,7 +6,8 @@
 			name: {
 				value: "Filter"
 			},
-			payloadPropName: { value: "payload", required: false }
+			payloadPropName: { value: "payload", required: false },
+			translatorConfig: { type: "translator-config", required: false }
 		},
 		inputs: 1,
 		outputs: 2,
@@ -31,14 +32,14 @@
 		paletteLabel: function () {
 			return "FilterUltimate";
 		},
-		oneditprepare: function () {
+		oneditprepare: function () {			
 			if ($("#node-input-payloadPropName").val() === "") $("#node-input-payloadPropName").val("payload");
 			$("#node-input-payloadPropName").typedInput({ default: 'msg', types: ['msg'] });
 		}
 	});
 </script>
 
-<script type="text/x-red" data-template-name="FilterUltimate">
+<script type="text/html" data-template-name="FilterUltimate">
 	<div class="form-row">
 		<b>Filter 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/DXfpXRM-LJA"><u>Youtube Sample</u></a></span>
@@ -53,6 +54,16 @@
         <label for="node-input-payloadPropName"><i class="fa fa-ellipsis-h"></i> Input</label>
 		<input type="text" id="node-input-payloadPropName">
     </div>
+
+	<div class="form-row">
+		<br />
+		<b>Translator</b>
+		<br/>
+		<label for="node-input-translatorConfig" >
+			<font color="green" size="4px"><i class="fa fa-sign-in" aria-hidden="true"></i></font> Input
+		</label>
+		<input type="text" id="node-input-translatorConfig" />
+	</div>
 </script>
 
 <script type="text/markdown" data-help-name="FilterUltimate">
@@ -67,6 +78,7 @@ The input message is preserved and passed to the output, changing only the topic
 |Property|Description|
 |--|--|
 | Input | It's the msg property to be evaluated. *By default, it is "payload", but you can also specify other properties, for example "payload.value"* |
+| Translator Input | Translates the incoming <code>payload</code> value, to true/false. This allows the compatibility with, for example, **HomeAssistant** nodes. |
 
 <br/>
 

package/boolean-logic-ultimate/FilterUltimate.js

@@ -1,55 +1,76 @@
 module.exports = function (RED) {
-	function FilterUltimate(config) {
-		RED.nodes.createNode(this, config);
-		this.config = config;
-		var node = this;
+  function FilterUltimate(config) {
+    RED.nodes.createNode(this, config);
+    this.config = config;
+    var node = this;
 
-		function setNodeStatus({ fill, shape, text }) {
-			let dDate = new Date();
-			node.status({ fill: fill, shape: shape, text: text + " (" + dDate.getDate() + ", " + dDate.toLocaleTimeString() + ")" })
-		}
+    function setNodeStatus({ fill, shape, text }) {
+      let 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) {
+      const utils = require("./utils.js");
+      let sPayload = utils.fetchFromObject(
+        msg,
+        config.payloadPropName || "payload"
+      );
 
-		setNodeStatus({ fill: "grey", shape: "dot", text: "Waiting" });
-		this.on('input', function (msg) {
+      // 15/11/2021 inform user about undefined topic or payload
+      if (sPayload === undefined) {
+        setNodeStatus({
+          fill: "red",
+          shape: "dot",
+          text: "Received invalid payload from " + msg.topic || "",
+        });
+        return;
+      }
 
-			const utils = require("./utils.js");
-			let sPayload = utils.fetchFromObject(msg, config.payloadPropName || "payload");
+      var bRes = null;
+      try {
+        bRes = utils.ToBoolean(
+          sPayload,
+          RED.nodes.getNode(config.translatorConfig) // Retrieve the config node. It can be null, but it's handled in utils.js
+        );
+      } catch (error) {}
 
-			// 15/11/2021 inform user about undefined topic or payload
-			if (sPayload=== undefined ) {
-				setNodeStatus({ fill: "red", shape: "dot", text: "Received invalid payload from " + msg.topic || "" });
-				return;
-			}
+      if (bRes === undefined || bRes === null) {
+        setNodeStatus({
+          fill: "red",
+          shape: "dot",
+          text:
+            "Received non convertible boolean value " +
+            sPayload +
+            " from " +
+            msg.topic,
+        });
+        return;
+      }
 
-			
-			var bRes = null;
-			try {
-				bRes = utils.ToBoolean(sPayload);
-			} catch (error) {
-			}
+      // 24/01/2020 Clone input message and replace only payload
+      var msgOut = RED.util.cloneMessage(msg);
+      msgOut.payload = bRes;
 
-			if (bRes === undefined || bRes === null) {
-				setNodeStatus({ fill: "red", shape: "dot", text: "Received non convertible boolean value " + sPayload + " from " + msg.topic });
-				return;
-			}
+      if (bRes === true) {
+        setNodeStatus({ fill: "green", shape: "dot", text: "(Send) true" });
+        node.send([msgOut, null]);
+      } else if (bRes === false) {
+        setNodeStatus({ fill: "green", shape: "dot", text: "(Send) false" });
+        node.send([null, msgOut]);
+      }
+    });
+  }
 
-			// 24/01/2020 Clone input message and replace only payload
-			var msgOut = RED.util.cloneMessage(msg);
-			msgOut.payload = bRes;
-
-			if (bRes === true) {
-				setNodeStatus({ fill: "green", shape: "dot", text: "(Send) true" });
-				node.send([msgOut, null]);
-			} else if (bRes === false) {
-				setNodeStatus({ fill: "green", shape: "dot", text: "(Send) false" });
-				node.send([null, msgOut]);
-			}
-
-		});
-
-	}
-
-
-	RED.nodes.registerType("FilterUltimate", FilterUltimate);
-}
+  RED.nodes.registerType("FilterUltimate", FilterUltimate);
+};

package/boolean-logic-ultimate/InterruptFlowUltimate.html

@@ -7,7 +7,8 @@
 			triggertopic: { value: "trigger" },
 			initializewith: { value: "1" },
 			autoToggle: { value: "0" },
-			payloadPropName: { value: "payload", required: false }
+			payloadPropName: { value: "payload", required: false },
+			translatorConfig: { type: "translator-config", required: false }
 		},
 		inputs: 1,
 		outputs: 1,
@@ -39,7 +40,7 @@
 	});
 </script>
 
-<script type="text/x-red" data-template-name="InterruptFlowUltimate">
+<script type="text/html" data-template-name="InterruptFlowUltimate">
 	<div class="form-row">
 		<b>Interrupt Flow 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/1T1g0HCeYA8"><u>Youtube Sample</u></a></span>
@@ -84,6 +85,16 @@
 			<option value="120">Toggle above option after 120 seconds</option>
 		</select>
 	</div>
+
+	<div class="form-row">
+		<br />
+		<b>Translator</b>
+		<br/>
+		<label for="node-input-translatorConfig" >
+			<font color="green" size="4px"><i class="fa fa-sign-in" aria-hidden="true"></i></font> Input
+		</label>
+		<input type="text" id="node-input-translatorConfig" />
+	</div>
 </script>
 
 <script type="text/markdown" data-help-name="InterruptFlowUltimate">
@@ -96,6 +107,7 @@
 | Trigger by topic | Whenever the node receives a payload = false from this 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. 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. The node will clear the current stored message, as soon as it receives a ***msg.reset = true*** from this topic. |
 | With Input | It's the msg property to be evaluated. *By default, it is "payload", but you can also specify other properties, for example "payload.value"* |
 | 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.|
+| Translator Input | Translates the incoming <code>payload</code> value, to true/false. This allows the compatibility with, for example, **HomeAssistant** nodes. |
 
 <br/>
 

package/boolean-logic-ultimate/InterruptFlowUltimate.js

@@ -1,101 +1,163 @@
 module.exports = function (RED) {
-	function InterruptFlowUltimate(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 bInviaMessaggio
-		node.bInviaMessaggio = (node.config.initializewith === undefined || node.config.initializewith === "1") ? true : false; // Send the message or not
-		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 InterruptFlowUltimate(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 bInviaMessaggio
+    node.bInviaMessaggio =
+      node.config.initializewith === undefined ||
+      node.config.initializewith === "1"
+        ? true
+        : false; // Send the message or not
+    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() + ")" })
-		}
-		setNodeStatus({ fill: "green", shape: "ring", text: "-> pass" });
+    function setNodeStatus({ fill, shape, text }) {
+      let dDate = new Date();
+      node.status({
+        fill: fill,
+        shape: shape,
+        text:
+          text +
+          " (" +
+          dDate.getDate() +
+          ", " +
+          dDate.toLocaleTimeString() +
+          ")",
+      });
+    }
+    setNodeStatus({ fill: "green", shape: "ring", text: "-> pass" });
 
+    node.alignStatus = () => {
+      let sAutoToggle =
+        node.autoToggle > 0 ? " (Autotoggle in " + node.autoToggle + "s)" : "";
+      if (node.bInviaMessaggio) {
+        setNodeStatus({
+          fill: "green",
+          shape: "dot",
+          text: "-> pass" + sAutoToggle,
+        });
+      } else {
+        setNodeStatus({
+          fill: "red",
+          shape: "dot",
+          text: "|| stop" + sAutoToggle,
+        });
+      }
+    };
 
-		node.alignStatus = () => {
-			let sAutoToggle = node.autoToggle > 0 ? " (Autotoggle in " + node.autoToggle + "s)" : "";
-			if (node.bInviaMessaggio) {
-				setNodeStatus({ fill: "green", shape: "dot", text: "-> pass" + sAutoToggle });
-			} else {
-				setNodeStatus({ fill: "red", shape: "dot", text: "|| stop" + sAutoToggle });
-			}
-		}
+    if (node.autoToggle > 0) {
+      node.timerAutoToggle = setTimeout(() => {
+        node.autoToggle = 0;
+        node.bInviaMessaggio = !node.bInviaMessaggio;
+        node.alignStatus();
+      }, node.autoToggle * 1000);
+    }
 
-		if (node.autoToggle > 0) {
-			node.timerAutoToggle = setTimeout(() => {
-				node.autoToggle = 0;
-				node.bInviaMessaggio = !node.bInviaMessaggio;
-				node.alignStatus();
-			}, node.autoToggle * 1000);
-		}
+    node.alignStatus();
 
-		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) {
+          const utils = require("./utils.js");
+          let sPayload = utils.fetchFromObject(
+            msg,
+            config.payloadPropName || "payload"
+          );
+          // 15/11/2021 inform user about undefined topic or payload
+          if (sPayload === undefined) {
+            setNodeStatus({
+              fill: "red",
+              shape: "dot",
+              text: "Received invalid payload from " + msg.topic || "",
+            });
+            return;
+          }
+          msg.payload = utils.ToBoolean(
+            sPayload,
+            RED.nodes.getNode(config.translatorConfig) // Retrieve the config node. It can be null, but it's handled in utils.js; // 15/11/2021 Convert input to boolean.
+          );
+          if (msg.payload === undefined) return null;
+          if (node.timerAutoToggle !== null)
+            // 28/01/2022 Stop autotoggle
+            clearInterval(node.timerAutoToggle);
 
-		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) {
+          if (msg.hasOwnProperty("play")) {
+            if (node.currentMsg.payload !== undefined) {
+              node.currentMsg.isReplay = true;
+              setNodeStatus({
+                fill: "yellow",
+                shape: "dot",
+                text: "-> replay",
+              });
+              // Restore previous status
+              let t = 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;
+            setNodeStatus({ fill: "green", shape: "dot", text: "-> pass" });
+            return;
+          } else if (msg.payload === false) {
+            node.bInviaMessaggio = false;
+            setNodeStatus({
+              fill: "red",
+              shape: "dot",
+              text: "|| stop (stored last msg)",
+            });
+            return;
+          }
+        }
+      }
+      node.currentMsg = RED.util.cloneMessage(msg);
+      if (node.bInviaMessaggio) {
+        node.send(msg);
+      }
+    });
+  }
 
-					const utils = require("./utils.js");
-					let sPayload = utils.fetchFromObject(msg, config.payloadPropName || "payload");
-					// 15/11/2021 inform user about undefined topic or payload
-					if (sPayload === undefined ) {
-						setNodeStatus({ fill: "red", shape: "dot", text: "Received invalid payload from " + msg.topic || "" });
-						return;
-					}
-					msg.payload = utils.ToBoolean(sPayload); // 15/11/2021 Convert input to boolean.
-
-					// 28/01/2022 Stop autotoggle
-					if (node.timerAutoToggle !== null) clearInterval(node.timerAutoToggle);
-
-					if (msg.hasOwnProperty("play")) {
-						if (node.currentMsg.payload !== undefined) {
-							node.currentMsg.isReplay = true;
-							setNodeStatus({ fill: "yellow", shape: "dot", text: "-> replay" });
-							// Restore previous status
-							let t = 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;
-						setNodeStatus({ fill: "green", shape: "dot", text: "-> pass" });
-						return;
-					} else if (msg.payload === false) {
-						node.bInviaMessaggio = false;
-						setNodeStatus({ fill: "red", shape: "dot", text: "|| stop (stored last msg)" });
-						return;
-					}
-				}
-			}
-			node.currentMsg = RED.util.cloneMessage(msg);
-			if (node.bInviaMessaggio) {
-				node.send(msg);
-			}
-		});
-
-
-	}
-
-
-	RED.nodes.registerType("InterruptFlowUltimate", InterruptFlowUltimate);
-}
+  RED.nodes.registerType("InterruptFlowUltimate", InterruptFlowUltimate);
+};

package/boolean-logic-ultimate/InvertUltimate.html

@@ -6,7 +6,8 @@
 			name: { 
 				value: "Invert"
 			},
-			payloadPropName: { value: "payload", required: false }			
+			payloadPropName: { value: "payload", required: false },
+			translatorConfig: { type: "translator-config", required: false }			
         },
         inputs:1,
         outputs:1,
@@ -25,7 +26,7 @@
     });
 </script>
 
-<script type="text/x-red" data-template-name="InvertUltimate">
+<script type="text/html" data-template-name="InvertUltimate">
 	<div class="form-row">
 		<b>Invert 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/A41x8VevZD8"><u>Youtube Sample</u></a></span>
@@ -40,6 +41,15 @@
         <label for="node-input-payloadPropName"><i class="fa fa-ellipsis-h"></i> Input</label>
 		<input type="text" id="node-input-payloadPropName">
     </div>
+	<div class="form-row">
+		<br />
+		<b>Translator</b>
+		<br />
+		<label for="node-input-translatorConfig">
+			<font color="green" size="4px"><i class="fa fa-sign-in" aria-hidden="true"></i></font> Input
+		</label>
+		<input type="text" id="node-input-translatorConfig" />
+	</div>
 </script>
 
 <script type="text/markdown" data-help-name="InvertUltimate">
@@ -50,11 +60,10 @@ The input message is preserved and passed to the output, changing only the topic
 |Property|Description|
 |--|--|
 | Input | It's the msg property to be evaluated. *By default, it is "payload", but you can also specify other properties, for example "payload.value"* |
+| Translator Input | Translates the incoming <code>payload</code> value, to true/false. This allows the compatibility with, for example, **HomeAssistant** nodes. |
 
 <br/>
 
-[SEE THE README FOR FULL HELP AND SAMPLES](https://github.com/Supergiovane/node-red-contrib-boolean-logic-ultimate)
-
 [Find it useful?](https://www.paypal.me/techtoday)
 
 </script>