@mschaeffler/node-red-logic 0.6.2 → 0.7.1

package/README.md

@@ -202,6 +202,45 @@ The message property to be used as payload can be defined with the `Property` pr
 |min      |gets the minimal value of the `topic` channels|
 |max      |gets the maximal value of the `topic` channels|
 
+### statistics
+
+Calculate statistical values of one or more data streams.
+
+Each stream can be debounced by arithmatic mean.
+
+If the msg property `invalid` is present in the message, all nodes ignore the message.
+
+#### Input
+
+The different inputs are differentiated by topics.
+
+The message property to be used as payload can be defined with the `Property` property.
+
+|msg.    | type   | description                       |
+|:-------|:-------|:----------------------------------|
+|topic   | string | name of the input channel.        |
+|payload | number | input value for `topic`.          |
+
+#### Output
+
+|msg.    | type   | description                       |
+|:-------|:-------|:----------------------------------|
+|payload | | same as in input message.|
+|stats.count | number | number of data elements.|
+|stats.min number | number | minimal value.|
+|stats.max number | number | maximal value.|
+|stats.average number | number | average value.|
+|stats.deviation number | number | standard deviation.|
+|stats.variation number | number | coefficient of variation.|
+
+#### Parameters
+
+|config| type   | description                       |
+|:-----|:-------|:----------------------------------|
+|Property| string | defines the message property to be used as payload.|
+|delta time|number|time frame to collect the data for the analysis.|
+|min. Data|number|min. amount of data points to generate an output.|
+
 ## Edge Nodes
 
 ![image of example flow](https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-logic/examples/edge.png)

package/examples/statistics.json

@@ -0,0 +1,64 @@
+[
+    {
+        "id": "8b8b9dd67621a97e",
+        "type": "statistics",
+        "z": "3c59326457645408",
+        "name": "",
+        "property": "payload",
+        "deltaTime": "10",
+        "minData": "2",
+        "x": 360,
+        "y": 2100,
+        "wires": [
+            [
+                "1a6086132fd93e1a"
+            ]
+        ]
+    },
+    {
+        "id": "1a6086132fd93e1a",
+        "type": "debug",
+        "z": "3c59326457645408",
+        "name": "debug 15",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "true",
+        "targetType": "full",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 540,
+        "y": 2100,
+        "wires": []
+    },
+    {
+        "id": "40735ba7d52d0d38",
+        "type": "inject",
+        "z": "3c59326457645408",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "topic",
+                "vt": "str"
+            }
+        ],
+        "repeat": "1",
+        "crontab": "",
+        "once": true,
+        "onceDelay": 0.1,
+        "topic": "random",
+        "payload": "$random()*100",
+        "payloadType": "jsonata",
+        "x": 190,
+        "y": 2100,
+        "wires": [
+            [
+                "8b8b9dd67621a97e"
+            ]
+        ]
+    }
+]

package/math_reduce.html

@@ -45,19 +45,6 @@
                 types:["msg"],
                 typeField: "#node-input-property-type"
             });
-            /*
-            $("#node-input-algo").typedInput({
-                types:[{
-                    value:"algo",
-                    options: [
-                        { value: "add", label: "Addition"},
-                        { value: "mean", label: "Mean Value"},
-                        { value: "prod", label: "Product"},
-                        { value: "min", label: "Minimum" },
-                        { value: "max", label: "Maximum" }
-                    ]
-                }]
-            })*/
         }
     });
 </script>

package/math_statistics.html

@@ -0,0 +1,103 @@
+<script type="text/javascript">
+    RED.nodes.registerType('statistics',{
+        category: 'function',
+        color: "#C0DEED",
+        defaults: {
+            name:{value:""},
+            property:{value:"payload", required:true},
+            deltaTime:{value:"60", required:true, validate:function(v){
+                return v!=='' && !isNaN(v) && Number(v)>0;}
+            },
+            minData:{value:"1", required:true, validate:function(v){
+                return v!=='' && !isNaN(v) && Number(v)>0;}
+            }
+        },
+        inputs:1,
+        outputs:1,
+        icon:"font-awesome/fa-arrows-alt",
+        label: function() {
+            return this.name||"statistics";
+        },
+        labelStyle: function() {
+            return this.name?"node_label_italic":"";
+        },
+        inputLabels: 'input',
+        outputLabels: 'output',
+        oneditprepare: function() {
+            $("#node-input-property").typedInput({
+                type:"msg",
+                types:["msg"],
+                typeField: "#node-input-property-type"
+            });
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="statistics">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-input"><i class="fa fa-ellipsis-h"></i> Eigenschaft</label>
+        <input type="text" id="node-input-property">
+        <input type="hidden" id="node-input-property-type">
+    </div>
+    <div class="form-row">
+       <label for="node-input-minMean"><i class="fa fa-hourglass-o"></i> Zeitspanne</label>
+       <input type="text" id="node-input-deltaTime">
+    </div>
+    <div class="form-row">
+        <label for="node-input-minData"><i class="fa fa-check-square-o "></i> min. Data</label>
+        <input type="text" id="node-input-minData">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="statistics">
+    
+    <p>Calculate statistical values of one or more data streams.</p>
+    <p>Each stream can be debounced by arithmatic mean.</p>
+    <p>If the msg property <code>invalid</code> is present in the message, all nodes ignore the message.</p>
+
+    <h3>Input</h3>
+    
+    <p>The different inputs are differentiated by topics.</p>
+    <p>The message property to be used as payload can be defined with the <code>Property</code> property.</p>
+    
+    <dl class="message-properties">
+        <dt>topic <span class="property-type">string</span></dt>
+        <dd> name of the input channel.</dd>
+        <dt>payload <span class="property-type">number</span></dt>
+        <dd> input value for <code>topic</code>.</dd>
+    </dl>
+    
+    <h3>Output</h3>
+    
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">number</span></dt>
+        <dd> same as in input message.</dd>
+        <dt>stats.count <span class="property-type">number</span></dt>
+        <dd> number of data elements.</dd>
+        <dt>stats.min <span class="property-type">number</span></dt>
+        <dd> minimal value.</dd>
+        <dt>stats.max <span class="property-type">number</span></dt>
+        <dd> maximal value.</dd>
+        <dt>stats.average <span class="property-type">number</span></dt>
+        <dd> average value.</dd>
+        <dt>stats.deviation <span class="property-type">number</span></dt>
+        <dd> standard deviation.</dd>
+        <dt>stats.variation <span class="property-type">number</span></dt>
+        <dd> coefficient of variation.</dd>
+    </dl>
+    
+    <h3>Parameter</h3>
+
+    <dl class="message-properties">
+        <dt>Property <span class="property-type">string</span></dt>
+        <dd> defines the message property to be used as payload.</dd>
+        <dt>delta time <span class="property-type">number</span></dt>
+        <dd> time frame to collect the data for the analysis.</dd>
+        <dt>min. Data <span class="property-type">number</span></dt>
+        <dd> min. amount of data points to generate an output.</dd>
+    </dl>
+</script>

package/math_statistics.js

@@ -0,0 +1,83 @@
+module.exports = function(RED) {
+
+    function StatsNode(config) {
+        RED.nodes.createNode(this,config);
+        //this.config = config;
+        var node      = this;
+        var context   = this.context();
+        this.property = config.property || "payload";
+        this.deltaTime= Number( config.deltaTime )*1000;
+        this.minData  = Number( config.minData );
+
+        node.on('input', function(msg,send,done) {
+            if( msg.invalid )
+            {
+                return null;
+            }
+            if( msg.reset || msg.topic==="init" )
+            {
+                context.set( "data", {} );
+                node.status( "" );
+            }
+            else
+            {
+                const now     = Date.now();
+                const payload = Number( RED.util.getMessageProperty( msg, node.property ) );
+                if( ! isNaN( payload ) )
+                {
+                    let data = context.get( "data" ) ?? {};
+                    let item = data[msg.topic] ?? [];
+                    item.push( { time:now, value:payload } );
+                    while( item[0].time < now - this.deltaTime )
+                    {
+                        item.shift();
+                    }
+                    data[msg.topic] = item;
+                    context.set( "data", data );
+
+                    if( item.length >= this.minData )
+                    {
+                        msg.stat = {
+                            count: item.length,
+                            min:   Number.MAX_SAFE_INTEGER,
+                            max:   Number.MIN_SAFE_INTEGER };
+                        let sum = 0;
+                        for( const value of item )
+                        {
+                            sum += value.value;
+                            if( value.value < msg.stat.min )
+                            {
+                                msg.stat.min = value.value;
+                            }
+                            if( value.value > msg.stat.max )
+                            {
+                                msg.stat.max = value.value;
+                            }
+                        }
+                        msg.stat.average = sum/msg.stat.count;
+                        let varianz = 0;
+                        for( const value of item )
+                        {
+                            varianz += ( value.value - msg.stat.average ) ** 2;
+                        }
+                        msg.stat.deviation = Math.sqrt( varianz / msg.stat.count );
+                        msg.stat.variation = msg.stat.deviation / msg.stat.average;
+                        node.status({fill:"green",shape:"dot",text:msg.stat.count});
+                        send( msg );
+                    }
+                    else
+                    {
+                        node.status({fill:"gray",shape:"dot",text:"to less data"});
+                    }
+                }
+                else
+                {
+                    node.status({fill:"red",shape:"dot",text:"payload is NaN"});
+                }
+            }
+            done();
+        });
+    }
+
+    RED.nodes.registerType("statistics",StatsNode);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mschaeffler/node-red-logic",
-  "version": "0.6.2",
+  "version": "0.7.1",
   "description": "nodes for simple operations.",
   "license": "LGPL-2.1",
   "homepage": "https://github.com/m-schaeffler/node-red-my-nodes/tree/main/node-red-logic",
@@ -25,7 +25,8 @@
       "reduce":"math_reduce.js",
       "fallingEdge":"math_falling.js",
       "raisingEdge":"math_raising.js",
-      "hysteresisEdge":"math_hysteresis.js"
+      "hysteresisEdge":"math_hysteresis.js",
+      "statistics":"math_statistics.js"
     }
   },
   "author": {