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

package/CHANGELOG.md

@@ -3,6 +3,10 @@
 
 # CHANGELOG
 
+<p>
+<b>Version 1.0.63</b> September 2023<br/>
+- NEW: Comparator node. Compare the values from 2 input messages.</br>
+</p>
 <p>
 <b>Version 1.0.62</b> August 2023<br/>
 - Math node: added "subtract option".</br>

package/README.md

@@ -84,7 +84,7 @@ The node can convert arbitrary input values to true/false. It supports Homeassis
 |Property|Description|
 |--|--|
 | Inputs count | Set the number of different topics to be evaluated. The node will output a message to the flow, after this number of *different* topics arrives. *Remember: each input topic must be different. For example, if you set this field to 3, the node expects 3 different topics.* |
-| Evaluate | Set the property where the input payload is. *By default, it is "payload", but you can also specify other properties, for example "payload.value"* |
+| Evaluate | It's the msg property to be evaluated. *By default, it is "payload", but you can also specify other properties, for example "payload.value"* |
 | Filter output | **Output both 'true' and 'false'** results: Standard behaviour, the node will output <b>true</b> and <b>false</b> whenever it receives an input and calculate the boolean logics as output. **Output only 'true'** results: whenever the node receives an input, it outputs a payload <b>true</b> only if the result of the logic is true. <b>False</b> results are filtered out. |
 | Trigger mode | **All topics**: standard behaviour, the node will evaluate each input topic and ouputs the values. At each input change, it will output a msg on the flow. **Single topic + eval other inputs**: the node evaluates all the input topics, but only whenever it receives a msg input with the **specified topic**, it  outputs a msg to the flow.|
 | If input states are undefined | Every time you create a node or modify the node, all inputs are set to undefined. This means that the node will wait the arrive of all topics (for example 3 topics, if you've selected 3 topics in the option), before it can output a payload. This can be a problem if your logic must be operative as soon as you deploy the flow. To overcome this problem, you can "initialize" all the undefined inputs with True or False. **Leave undefined**: Standard behaviour, the node will wait all the "undefined" topics to arrive, then starts a flow with the result. **True or False**: The node is immediately operative, by force the initialization of the "undefined" inputs with "true" or "false".|
@@ -118,7 +118,7 @@ The interrupt flows is able to stop the input messages to exiting the node.
 |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.|
 
 
@@ -190,7 +190,7 @@ 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"* |
 
 <br/>
 
@@ -212,7 +212,7 @@ 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"* |
 
 <br/>
 
@@ -234,7 +234,7 @@ output2 : outputs the inverted value false/true<br/>
 
 |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"* |
 
 <br/>
 
@@ -270,7 +270,7 @@ This is useful if you need to simply send a true or false payload.
 
 |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"* |
 
 <br/>
 
@@ -344,7 +344,7 @@ The pourpose of this node is to send a sequence of pulsed commands to for exampl
 
 |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"* |
 
 <br/>
 
@@ -389,7 +389,7 @@ The pourpose of this node is to do maths on the incoming values. Each incoming m
 
 |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"* |
 
 <br/>
 
@@ -427,7 +427,7 @@ The pourpose of this node is to toggle between true/false, everytime an inboud m
 
 |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"* |
 
 <br/>
 
@@ -452,7 +452,7 @@ The railway switcher, switches the input msg flow to one ot the two outputs (upp
 |Property|Description|
 |--|--|
 | Switcher topic | Whenever the node receives a payload from this **topic**, it switches the input messages to an output. |
-| 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 after some time. |
 
 <br/>

package/boolean-logic-ultimate/BlinkerUltimate.html

@@ -86,7 +86,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"* |
 
 <br/>
 

package/boolean-logic-ultimate/BooleanLogicUltimate.html

@@ -218,7 +218,7 @@
 |Property|Description|
 |--|--|
 | Inputs count | Set the number of different topics to be evaluated. The node will output a message to the flow, after this number of *different* topics arrives. *Remember: each input topic must be different. For example, if you set this field to 3, the node expects 3 different topics.* |
-| Evaluate | Set the property where the input payload is. *By default, it is "payload", but you can also specify other properties, for example "payload.value"* |
+| Evaluate | It's the msg property to be evaluated. *By default, it is "payload", but you can also specify other properties, for example "payload.value"* |
 
 <br/>
 

package/boolean-logic-ultimate/Comparator.html

@@ -0,0 +1,101 @@
+<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

@@ -66,7 +66,7 @@ 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"* |
 
 <br/>
 

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

@@ -94,7 +94,7 @@
 |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.|
 
 <br/>

package/boolean-logic-ultimate/InvertUltimate.html

@@ -49,7 +49,7 @@ 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"* |
 
 <br/>
 

package/boolean-logic-ultimate/RailwaySwitchUltimate.html

@@ -93,7 +93,7 @@
 |Property|Description|
 |--|--|
 | Switcher topic | Whenever the node receives a payload from this **topic**, it switches the input messages to an output. |
-| 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 after some time. |
 
 * Input messages

package/boolean-logic-ultimate/SimpleOutputUltimate.html

@@ -53,7 +53,7 @@ This is useful if you need to simply send a true or false payload.
 
 |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"* |
 
 <br/>
 

package/boolean-logic-ultimate/SumUltimate.html

@@ -61,7 +61,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"* |
 | Operation | Operation to be performed. |
 
 <br/>

package/boolean-logic-ultimate/toggleUltimate.html

@@ -64,7 +64,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"* |
 
 * Input message
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-red-contrib-boolean-logic-ultimate",
-    "version": "1.0.62",
+    "version": "1.0.63",
     "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 values.",
     "author": "Supergiovane (https://github.com/Supergiovane)",
     "dependencies": {
@@ -32,7 +32,8 @@
             "ImpulseUltimate": "boolean-logic-ultimate/ImpulseUltimate.js",
             "SumUltimate": "boolean-logic-ultimate/SumUltimate.js",
             "toggleUltimate": "boolean-logic-ultimate/toggleUltimate.js",
-            "RailwaySwitchUltimate": "boolean-logic-ultimate/RailwaySwitchUltimate.js"
+            "RailwaySwitchUltimate": "boolean-logic-ultimate/RailwaySwitchUltimate.js",
+            "Comparator": "boolean-logic-ultimate/Comparator.js"
         }
     }
 }