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

package/boolean-logic-ultimate/Comparator.html

@@ -0,0 +1,102 @@
+<script type="text/javascript">
+    RED.nodes.registerType('Comparator', {
+        category: 'boolean logic ultimate',
+        color: '#ff8080',
+        defaults: {
+            name: {
+                value: "Comparator"
+            },
+            property: {
+                value: "payload"
+            },
+            math: {
+                value: "==="
+            },
+            topic1: {
+                value: "", required: true
+            },
+            topic2: {
+                value: "", required: true
+            }           
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: "font-awesome/fa-arrows-v",
+        label:
+            function () {
+                return this.name || "Comparator";
+            },
+        paletteLabel: function () {
+            return "ComparatorUltimate";
+        },
+        oneditprepare: function () {
+            if ($("#node-input-property").val() === "") $("#node-input-property").val("payload");
+            $("#node-input-property").typedInput({ default: 'msg', types: ['msg'] });
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="Comparator">
+	<div class="form-row">
+		<b>Comparator</b>&nbsp&nbsp&nbsp&nbsp<span style="color:red"><i class="fa fa-youtube-play"></i>&nbsp<a target="_blank" href="https://youtu.be/fDRsQPu3bG4"><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="Topic">
+    </div>
+    <hr/>
+    <div class="form-row">
+        <label for="node-input-property"><i class="icon-tag"></i> Input</label>
+        <input type="text" id="node-input-property" placeholder="payload">
+    </div>
+    <div class="form-row">
+        <label for="node-input-topic1"><i class="icon-tag"></i> Topic 1</label>
+        <input type="text" id="node-input-topic1" placeholder="For example, topic 1">
+    </div>
+    <div class="form-row">
+		<label for="node-input-math"><i class="icon-tag"></i> Operation</label>
+		<select type="text" id="node-input-math" placeholder="">
+			<option value="===">=== (equals)</option>
+            <option value="!==">!== (not equals)</option>
+            <option value=">=">></option>
+            <option value="<="><</option>
+			<option value=">=">>=</option>
+            <option value="<="><=</option>            
+		</select>
+	</div>
+    <div class="form-row">
+        <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">
+<p>The Comparator, compares two msg values and outputs true/false.</p>
+
+|Property|Description|
+|--|--|
+| Name | It's the node name. This will be also the output topic. |
+| 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"*. It **must** be a numeric value. The node will try to automatically convert numeric values expressed as strings, to real numbers. |
+| Topic 1 | It's the topic to be evaluated against the second topic. |
+| Comparator | It's the comparator. It compares the Topic 1 against the Topic 2. |
+| Topic 2 | It's the second topic to be evaluated against the first topic. |
+
+<br/>
+
+### Outputs
+
+1. Standard output
+: payload (boolean) : the standard output of the command.
+
+### Details
+
+`msg.payload` is used as the payload of the published message. I'ts true or false based on the result of the compare operation.  
+
+<br/>
+
+[Find it useful?](https://www.paypal.me/techtoday)
+
+</script>

package/boolean-logic-ultimate/Comparator.js

@@ -0,0 +1,99 @@
+module.exports = function (RED) {
+  function Comparator(config) {
+    RED.nodes.createNode(this, config);
+    var node = this;
+    node.config = config;
+    node.math = config.math === undefined ? "===" : config.math;
+    node.topic1Value = undefined;
+    node.topic2Value = undefined;
+    
+    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: "" });
+
+    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];
+    }
+
+    node.on("input", function (msg) {
+      if (!msg.hasOwnProperty("topic")) {
+        setNodeStatus({
+          fill: "red",
+          shape: "ring",
+          text: "Incoming msg without topic! Please set the topic.",
+        });
+        return;
+      }
+
+      try {
+        let props = ([] = node.config.property.split("."));
+        let ret = fetchFromObject(msg, node.config.property);
+        if (ret !== undefined) {
+          ret = Number(ret);
+
+          // Sum
+          if (!isNaN(ret) && isFinite(ret)) {
+            if (msg.topic === node.config.topic1) node.topic1Value = ret;
+            if (msg.topic === node.config.topic2) node.topic2Value = ret;
+
+            if (
+              node.topic1Value === undefined ||
+              node.topic2Value === undefined
+            ) {
+              setNodeStatus({
+                fill: "blue",
+                shape: "ring",
+                text: "Waiting for valid topics.",
+              });
+              return;
+            }
+
+            if (eval(node.topic1Value + node.math + node.topic2Value)) {
+              //msg.inputmsg = RED.util.cloneMessage(msg);
+              msg.topic = node.config.name;
+              msg.payload = true;
+            } else {
+              msg.payload = false;
+            }
+            msg.topic = node.config.name;
+            node.send(msg);
+            setNodeStatus({
+              fill: "green",
+              shape: "dot",
+              text: "Done " + msg.payload,
+            });
+          }
+        }
+      } catch (error) {
+        setNodeStatus({ fill: "red", shape: "ring", text: error.message });
+      }
+    });
+  }
+
+  RED.nodes.registerType("Comparator", Comparator);
+};

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">
@@ -66,7 +77,8 @@ The input message is preserved and passed to the output, changing only the topic
 
 |Property|Description|
 |--|--|
-| Input | Set the property where the input payload is. *By default, it is "payload", but you can also specify other properties, for example "payload.value"* |
+| 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/ImpulseUltimate.html

@@ -88,7 +88,7 @@
 
 |Property|Description|
 |--|--|
-| Input | Set the property where the input payload is. *By default, it is "payload", but you can also specify other properties, for example "payload.value"* |
+| 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"* |
 
 * Avaiable Commands
 

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">
@@ -94,8 +105,9 @@
 |Property|Description|
 |--|--|
 | 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 | Set the property where the input payload is. *By default, it is "payload", but you can also specify other properties, for example "payload.value"* |
+| 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/>