node-red-contrib-boolean-logic-ultimate 1.0.47 → 1.0.48

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # 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.48</b> February 2022<br/>
+- NEW: SUM node: this new node makes sum, average and measurement count.</br>
+</p>
 <p>
 <b>Version 1.0.47</b> February 2022<br/>
 - NEW: Interrupt Flow: the node now stores the last message, even if in the "stop" state.</br>

package/README.md

@@ -323,6 +323,40 @@ Pass <code>msg.payload = false</code> to the node to stop the running sequence</
 
 - Output: the node outputs a message you specified in the command textbox<br/>
 
+<br/>
+<br/>
+<br/>
+<br/>
+<br/>
+
+# SUM ULTIMATE
+
+The pourpose of this node is to sum the incoming values. Each incoming message MUST HAVE OWN TOPIC.<br />
+
+<img src='https://raw.githubusercontent.com/Supergiovane/node-red-contrib-boolean-logic-ultimate/master/img/sum.png' width='60%'>
+<details><summary>CLICK HERE, copy and paste it into your flow</summary>
+<code>
+[{"id":"05b6ce0cb476abd5","type":"SumUltimate","z":"d8fbf871e381cf2c","name":"Sum","property":"payload","x":550,"y":160,"wires":[["567aa6a9719e463e","34fbca5daf8b9fab","e3c2a45a0b77af8f"]]},{"id":"6744e01b88d820b9","type":"inject","z":"d8fbf871e381cf2c","name":"","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"Watt Table Lamp","payload":"10","payloadType":"num","x":250,"y":140,"wires":[["05b6ce0cb476abd5"]]},{"id":"75823dbc7db78c3c","type":"inject","z":"d8fbf871e381cf2c","name":"","props":[{"p":"payload"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"Watt Washing machine","payload":"20","payloadType":"num","x":270,"y":180,"wires":[["05b6ce0cb476abd5"]]},{"id":"567aa6a9719e463e","type":"debug","z":"d8fbf871e381cf2c","name":"Sum","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"payload","targetType":"msg","statusVal":"","statusType":"auto","x":690,"y":160,"wires":[]},{"id":"1793931ba218bc1d","type":"inject","z":"d8fbf871e381cf2c","name":"Reset","props":[{"p":"reset","v":"","vt":"date"},{"p":"topic","vt":"str"}],"repeat":"","crontab":"","once":false,"onceDelay":0.1,"topic":"","x":210,"y":240,"wires":[["05b6ce0cb476abd5"]]},{"id":"0b3277af03f546d4","type":"comment","z":"d8fbf871e381cf2c","name":"Getting Sum, Average etc. from the SUM node.","info":"","x":320,"y":100,"wires":[]},{"id":"34fbca5daf8b9fab","type":"debug","z":"d8fbf871e381cf2c","name":"Average","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"average","targetType":"msg","statusVal":"","statusType":"auto","x":700,"y":200,"wires":[]},{"id":"e3c2a45a0b77af8f","type":"debug","z":"d8fbf871e381cf2c","name":"Measurements","active":true,"tosidebar":true,"console":false,"tostatus":false,"complete":"measurements","targetType":"msg","statusVal":"","statusType":"auto","x":720,"y":240,"wires":[]}]
+</code>
+</details>
+
+**INPUT**<br />
+
+<br /><b>msg.reset</b><br />
+resets the values to zero.
+
+<br />
+
+- Output: the node outputs a message as follows:<br/>
+
+<pre>
+{
+  "payload": 30, // This is the SUM
+  "topic": "Sum", // Node  Topic
+  "average": 15, // This is the AVERAVE
+  "measurements": 2 // This is the number of topics that have been evaluated
+}
+</pre>
 
 [license-image]: https://img.shields.io/badge/license-MIT-blue.svg
 [license-url]: https://github.com/Supergiovane/node-red-contrib-boolean-logic-ultimate/master/LICENSE

package/boolean-logic-ultimate/SumUltimate.html

@@ -0,0 +1,54 @@
+<script type="text/javascript">
+    RED.nodes.registerType('SumUltimate', {
+        category: 'boolean logic ultimate',
+        color: '#ff8080',
+        defaults: {
+            name: {
+                value: "Sum"
+            },
+            property: {
+                value: "payload"
+            }
+            
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: "font-awesome/fa-plus",
+        label:
+            function () {
+                return this.name || "Sum";
+            },
+        paletteLabel: function () {
+            return "SumUltimate";
+        }
+    });
+</script>
+
+<script type="text/x-red" data-template-name="SumUltimate">
+	<div class="form-row">
+		<b>Status 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>
+		<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-property"><i class="icon-tag"></i> Sum msg.</label>
+        <input type="text" id="node-input-property" placeholder="payload">
+    </div>
+</script>
+
+<script type="text/x-red" data-help-name="SumUltimate">
+	<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/SumUltimate.js

@@ -0,0 +1,88 @@
+module.exports = function (RED) {
+	function SumUltimate(config) {
+		RED.nodes.createNode(this, config);
+		this.config = config;
+		var node = this;
+		this.topics = {};
+
+		function setNodeStatus({ fill, shape, text }) {
+			var 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];
+		}
+
+		this.on('input', function (msg) {
+
+			// handle reset
+			if (msg.hasOwnProperty("reset")) {
+				node.topics = {};
+				setNodeStatus({ fill: "grey", shape: "ring", text: "Reset" });
+				return;
+			}
+
+			if (!msg.hasOwnProperty("topic")) {
+				setNodeStatus({ fill: "red", shape: "ring", text: "Incoming msg without topic! Please set the topic." });
+				return;
+			}
+
+			try {
+				let props = [] = this.config.property.split(".");
+				let ret = fetchFromObject(msg, this.config.property);
+				if (ret !== undefined) {
+
+					ret = Number(ret);
+
+					// Sum
+					if (!isNaN(ret) && isFinite(ret)) {
+						node.topics[msg.topic.toString()] = ret;
+
+						var quantita = 0;
+						var somma = Object.keys(node.topics).reduce(function (a, b) {
+							++quantita;
+							return a + node.topics[b];
+						}, 0);
+
+						msg.payload = somma; // Sum
+						msg.average = somma / quantita; // Average
+						msg.measurements = quantita; // Topics
+
+						// overwrite topic if configured
+						if (config.name) {
+							msg.topic = config.name;
+						}
+					}
+
+					// everything else
+					else {
+						setNodeStatus({ fill: "red", shape: "ring", text: "Not a number" });
+					}
+
+				} else {
+					setNodeStatus({ fill: "red", shape: "ring", text: this.config.property + " is undefined." });
+				}
+			} catch (error) {
+				setNodeStatus({ fill: "red", shape: "ring", text: error.message });
+			}
+			setNodeStatus({ fill: "green", shape: "dot", text: "Sum " + msg.payload });
+			node.send(msg);
+		});
+
+	}
+
+	RED.nodes.registerType("SumUltimate", SumUltimate);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "node-red-contrib-boolean-logic-ultimate",
-    "version": "1.0.47",
+    "version": "1.0.48",
     "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": {
@@ -29,7 +29,8 @@
             "SimpleOutputUltimate": "boolean-logic-ultimate/SimpleOutputUltimate.js",
             "InjectUltimate": "boolean-logic-ultimate/InjectUltimate.js",
             "StatusUltimate": "boolean-logic-ultimate/StatusUltimate.js",
-            "ImpulseUltimate": "boolean-logic-ultimate/ImpulseUltimate.js"
+            "ImpulseUltimate": "boolean-logic-ultimate/ImpulseUltimate.js",
+            "SumUltimate": "boolean-logic-ultimate/SumUltimate.js"
         }
     }
 }