@mschaeffler/node-red-logic 0.3.0 → 0.4.2

package/README.md

@@ -186,6 +186,90 @@ The message property to be used as payload can be defined with the `Property` pr
 
 #### Algorithms
 
+
+## fallingEdge
+
+Message is only forwarded, if the payload falls below a threshold value.
+
+Each `topic` is treated seperatly.
+
+### Input
+
+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
+
+Trigger message, in case a falling edge is detected.
+
+### Parameter
+
+|config| type   | description                       |
+|:-----|:-------|:----------------------------------|
+|Property| string | defines the message property to be used as payload.|
+|Threshold|number|threshold value for the edge detection.|
+|Status|boolean|shows the actual value as a node status.|
+
+## raisingEdge
+
+Message is only forwarded, if the payload raises above a threshold value.
+
+Each `topic` is treated seperatly.
+
+### Input
+
+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
+
+Trigger message, in case a raising edge is detected.
+
+### Parameter
+
+|config| type   | description                       |
+|:-----|:-------|:----------------------------------|
+|Property| string | defines the message property to be used as payload.|
+|Threshold|number|threshold value for the edge detection.|
+|Status|boolean|shows the actual value as a node status.|
+
+## hysteresis
+
+Message is only forwarded, if the payload raises above an upper limit or falls below a lower limit.
+
+Each `topic` is treated seperatly.
+
+### Input
+
+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
+
+Trigger message, in case an edge is detected.
+
+### Parameter
+
+|config| type   | description                       |
+|:-----|:-------|:----------------------------------|
+|Property| string | defines the message property to be used as payload.|
+|up Threshold|number|threshold value for the raising edge detection.|
+|d(ow)n Threshold|number|threshold value for the falling edge detection.|
+|1st message|string|initial behaviour (None, Rising, Falling, Any).|
+|Status|boolean|shows the actual value as a node status.|
+
 ## Example Flow
 
 [example flow](https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-logic/examples/logic.json)
@@ -194,6 +278,11 @@ The message property to be used as payload can be defined with the `Property` pr
 
 [Mathias Schäffler](https://github.com/m-schaeffler)
 
+## Contributors
+
+for `falling edge`, `raising edge` and `hysteresis`:
+* [Eugene Schava](https://github.com/eschava/node-red-contrib-edge-trigger)
+
 ## License
 
 LGPL-2.1

package/counter.js

@@ -12,6 +12,9 @@ module.exports = function(RED) {
             {
                 msg.count = 0;
             }
+            else if( msg.query || msg.topic==="query" )
+            {
+            }
             else
             {
                 msg.count++;

package/logic_and.js

@@ -11,34 +11,42 @@ module.exports = function(RED) {
         this.minData  = Number( config.minData );
 
         node.on('input', function(msg,send,done) {
-            const payload = tools.property2boolean( RED.util.getMessageProperty( msg, node.property ) );
-
-            if( payload !== null )
+            if( msg.reset || msg.topic==="init" )
+            {
+                context.set( "data", {} );
+                node.status( "" );
+            }
+            else
             {
-                let data = context.get( "data" ) ?? {};
-                data[msg.topic] = payload;
-                context.set( "data", data );
+                const payload = tools.property2boolean( RED.util.getMessageProperty( msg, node.property ) );
 
-                msg.topic = node.topic;
-                msg.payload = true;
-                msg.count   = 0;
-                for( const item in data )
+                if( payload !== null )
                 {
-                    msg.count++;
-                    if( ! data[item] )
+                    let data = context.get( "data" ) ?? {};
+                    data[msg.topic] = payload;
+                    context.set( "data", data );
+
+                    msg.topic = node.topic;
+                    msg.payload = true;
+                    msg.count   = 0;
+                    for( const item in data )
                     {
-                         msg.payload = false;
+                        msg.count++;
+                        if( ! data[item] )
+                        {
+                             msg.payload = false;
+                        }
                     }
-                }
 
-                if( msg.count >= node.minData )
-                {
-                    node.status( msg.payload );
-                    send( msg );
-                }
-                else
-                {
-                    node.status( "waiting for data" );
+                    if( msg.count >= node.minData )
+                    {
+                        node.status( msg.payload );
+                        send( msg );
+                    }
+                    else
+                    {
+                        node.status( "waiting for data" );
+                    }
                 }
             }
 

package/logic_bool.html

@@ -37,7 +37,7 @@
         <input type="hidden" id="node-input-property-type">
     </div>
     <div class="form-row">
-        <label for="node-input-showStatus"><i class="fa-star-o"></i> Status</label>
+        <label for="node-input-showStatus"><i class="fa fa-star-o"></i> Status</label>
         <input type="checkbox" id="node-input-showState" style="display:inline-block; width:20px; vertical-align:baseline;">
     </div>
 </script>

package/logic_or.js

@@ -11,34 +11,42 @@ module.exports = function(RED) {
         this.minData  = Number( config.minData );
 
         node.on('input', function(msg,send,done) {
-            const payload = tools.property2boolean( RED.util.getMessageProperty( msg, node.property ) );
-
-            if( payload !== null )
+            if( msg.reset || msg.topic==="init" )
+            {
+                context.set( "data", {} );
+                node.status( "" );
+            }
+            else
             {
-                let data = context.get( "data" ) ?? {};
-                data[msg.topic] = payload;
-                context.set( "data", data );
+                const payload = tools.property2boolean( RED.util.getMessageProperty( msg, node.property ) );
 
-                msg.topic = node.topic;
-                msg.payload = false;
-                msg.count   = 0;
-                for( const item in data )
+                if( payload !== null )
                 {
-                    msg.count++;
-                    if( data[item] )
+                    let data = context.get( "data" ) ?? {};
+                    data[msg.topic] = payload;
+                    context.set( "data", data );
+
+                    msg.topic = node.topic;
+                    msg.payload = false;
+                    msg.count   = 0;
+                    for( const item in data )
                     {
-                        msg.payload = true;
+                        msg.count++;
+                        if( data[item] )
+                        {
+                            msg.payload = true;
+                        }
                     }
-                }
 
-                if( msg.count >= node.minData )
-                {
-                     node.status( msg.payload );
-                     send( msg );
-                }
-                else
-                {
-                    node.status( "waiting for data" );
+                    if( msg.count >= node.minData )
+                    {
+                         node.status( msg.payload );
+                         send( msg );
+                    }
+                    else
+                    {
+                        node.status( "waiting for data" );
+                    }
                 }
             }
 

package/math_falling.html

@@ -0,0 +1,81 @@
+<script type="text/javascript">
+    RED.nodes.registerType('fallingEdge',{
+        category: 'function',
+        color: "#C0DEED",
+        defaults: {
+            name:{value:""},
+            property:{value:"payload",required:true},
+            threshold:{value:"",required:true,validate:RED.validators.number()},
+            showState:{value:false}
+        },
+        inputs:1,
+        outputs:1,
+        icon: "falling-edge.png",
+        label: function() {
+            return this.name||"falling";
+        },
+        paletteLabel: "falling edge",
+        inputLabels: 'input',
+        outputLabels: 'edge trigger',
+        oneditprepare: function() {
+            $("#node-input-property").typedInput({
+                type:"msg",
+                types:["msg"],
+                typeField: "#node-input-property-type"
+            })
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="fallingEdge">
+    <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-threshold"><i class="fa fa-chevron-down"></i> Threshold</label>
+        <input type="text" id="node-input-threshold">
+    </div>
+    <div class="form-row">
+        <label for="node-input-showStatus"><i class="fa fa-star-o"></i> Status</label>
+        <input type="checkbox" id="node-input-showState" style="display:inline-block; width:20px; vertical-align:baseline;">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="fallingEdge">
+    
+    <p>Message is only forwarded, if the payload falls below a threshold value.</p>
+    <p>Each <code>topic</code> is treated seperatly.</p>
+
+    <h3>Input</h3>
+    
+    <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"></span></dt>
+        <dd> input value for <code>topic</code>.</dd>
+    </dl>
+    
+    <h3>Output</h3>
+
+    <p>Trigger message, in case a falling edge is detected.</p>    
+    
+    <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>Threshold <span class="property-type">number</span></dt>
+        <dd> threshold value for the edge detection.</dd>
+        <dt>Status <span class="property-type">boolean</span></dt>
+        <dd> shows the actual value as a node status.</dd>
+    </dl>
+    
+</script>

package/math_falling.js

@@ -0,0 +1,51 @@
+module.exports = function(RED) {
+
+    function FallingEdgeNode(config) {
+        RED.nodes.createNode(this,config);
+        //this.config = config;
+        var node = this;
+        var context = this.context();
+        this.property  = config.property ?? "payload";
+        this.threshold = config.threshold;
+        this.showState = config.showState;
+
+        node.on('input', function(msg,send,done) {
+            if( msg.reset || msg.topic==="init" )
+            {
+                context.set( "data", {} );
+                node.status( "" );
+            }
+            else
+            {
+                msg.payload = Number( RED.util.getMessageProperty( msg, node.property ) );
+                let status = { fill:"gray", shape:"dot", text:msg.payload };
+
+                if( ! isNaN( msg.payload ) )
+                {
+                    let   data = context.get( "data" ) ?? {};
+                    const last = data[msg.topic] ?? Number.MIN_SAFE_INTEGER;
+                    if( msg.payload < this.threshold && this.threshold <= last )
+                    {
+                        status.fill = "green";
+                        send( msg );
+                    }
+                    data[msg.topic] = msg.payload;
+                    context.set( "data", data );
+                }
+                else
+                {
+                    status.fill = "red";
+                    status.text = "not a Number";
+                }
+
+                if( node.showState )
+                {
+                    node.status( status );
+                }
+            }
+            done();
+        });
+    }
+
+    RED.nodes.registerType("fallingEdge",FallingEdgeNode);
+}

package/math_hysteresis.html

@@ -0,0 +1,103 @@
+<script type="text/javascript">
+    RED.nodes.registerType('hysteresisEdge',{
+        category: 'function',
+        color: "#C0DEED",
+        defaults: {
+            name:{value:""},
+            property:{value:"payload",required:true},
+            threshold_raise:{value:"",required:true,validate:RED.validators.number()},
+            threshold_fall:{value:"",required:true,validate:function(v){
+                const raise = $("#node-input-threshold_raise").length ? $("#node-input-threshold_raise").val() : this.threshold_raise;
+                return v!=='' && !isNaN(v) && Number(v)<raise;}
+            },
+            initial:{value:"none"},
+            showState:{value:false}
+        },
+        inputs:1,
+        outputs:1,
+        icon: "hysteresis.png",
+        label: function() {
+            return this.name||"hysteresis";
+        },
+        paletteLabel: "hysteresis",
+        inputLabels: 'input',
+        outputLabels: 'hysteresis trigger',
+        oneditprepare: function() {
+            $("#node-input-property").typedInput({
+                type:"msg",
+                types:["msg"],
+                typeField: "#node-input-property-type"
+            })
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="hysteresisEdge">
+    <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-threshold_raise"><i class="fa fa-chevron-up"></i> up threshold</label>
+        <input type="text" id="node-input-threshold_raise">
+    </div>
+    <div class="form-row">
+        <label for="node-input-threshold_fall"><i class="fa fa-chevron-down"></i> dn threshold</label>
+        <input type="text" id="node-input-threshold_fall">
+    </div>
+    <div class="form-row">
+        <label for="node-input-initial"><i class="fa fa-play"></i> 1st message</label>
+        <select id="node-input-initial">
+            <option value="none">None</option>
+            <option value="rising">Rising</option>
+            <option value="falling">Falling</option>
+            <option value="any">Any</option>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-showStatus"><i class="fa fa-star-o"></i> Status</label>
+        <input type="checkbox" id="node-input-showState" style="display:inline-block; width:20px; vertical-align:baseline;">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="hysteresisEdge">
+    
+    <p>Message is only forwarded, if the payload raises above an upper limit or falls below a lower limit.</p>
+    <p>Each <code>topic</code> is treated seperatly.</p>
+
+    <h3>Input</h3>
+    
+    <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"></span></dt>
+        <dd> input value for <code>topic</code>.</dd>
+    </dl>
+    
+    <h3>Output</h3>
+
+    <p>Trigger message, in case an edge is detected.</p>    
+    
+    <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>up Threshold <span class="property-type">number</span></dt>
+        <dd> threshold value for the raising edge detection.</dd>
+        <dt>d(ow)n Threshold <span class="property-type">number</span></dt>
+        <dd> threshold value for the falling edge detection.</dd>
+        <dt>1st message <span class="property-type">string</span></dt>
+        <dd> initial behaviour (None, Rising, Falling, Any).</dd>
+        <dt>Status <span class="property-type">boolean</span></dt>
+        <dd> shows the actual value as a node status.</dd>
+    </dl>
+    
+</script>

package/math_hysteresis.js

@@ -0,0 +1,81 @@
+module.exports = function(RED) {
+
+    function HysteresisEdgeNode(config) {
+        RED.nodes.createNode(this,config);
+        //this.config = config;
+        var node = this;
+        var context = this.context();
+        this.property        = config.property ?? "payload";
+        this.threshold_raise = config.threshold_raise;
+        this.threshold_fall  = config.threshold_fall;
+        this.initial         = config.initial;
+        this.showState       = config.showState;
+
+        node.on('input', function(msg,send,done) {
+
+            if( msg.reset || msg.topic==="init" )
+            {
+                context.set( "data", {} );
+                node.status( "" );
+            }
+            else
+            {
+                msg.payload = Number( RED.util.getMessageProperty( msg, node.property ) );
+                let status = { fill:"gray", shape:"dot", text:msg.payload };
+
+                if( ! isNaN( msg.payload ) )
+                {
+                    let   data = context.get( "data" ) ?? {};
+                    const last = data[msg.topic];
+
+                    function sendMsg(edge)
+                    {
+                        status.fill = "green";
+                        data[msg.topic].edge = edge;
+                        msg.edge = edge;
+                        send( msg );
+                    }
+
+                    if( last )
+                    {
+                        if( msg.payload > this.threshold_raise && this.threshold_raise >= last.value && last.edge != 'rising')
+                        {
+                            sendMsg( 'rising' );
+                        }
+                        else if( msg.payload < this.threshold_fall && this.threshold_fall <= last.value && last.edge != 'falling')
+                        {
+                            sendMsg( 'falling' );
+                        }
+                    }
+                    else
+                    {
+                        data[msg.topic] = {};
+                        if( ( this.initial == 'any' || this.initial == 'rising' ) && msg.payload > this.threshold_raise )
+                        {
+                            sendMsg( 'rising' );
+                        }
+                        else if( ( this.initial == 'any' || this.initial == 'falling' ) && msg.payload < this.threshold_fall )
+                        {
+                            sendMsg( 'falling' );
+                        }
+                    }
+                    data[msg.topic].value = msg.payload;
+                    context.set( "data", data );
+                }
+                else
+                {
+                    status.fill = "red";
+                    status.text = "not a Number";
+                }
+
+                if( node.showState )
+                {
+                    node.status( status );
+                }
+            }
+            done();
+        });
+    }
+
+    RED.nodes.registerType("hysteresisEdge",HysteresisEdgeNode);
+}

package/math_number.html

@@ -37,7 +37,7 @@
         <input type="hidden" id="node-input-property-type">
     </div>
     <div class="form-row">
-        <label for="node-input-showStatus"><i class="fa-star-o"></i> Status</label>
+        <label for="node-input-showStatus"><i class="fa fa-star-o"></i> Status</label>
         <input type="checkbox" id="node-input-showState" style="display:inline-block; width:20px; vertical-align:baseline;">
     </div>
 </script>

package/math_raising.html

@@ -0,0 +1,81 @@
+<script type="text/javascript">
+    RED.nodes.registerType('raisingEdge',{
+        category: 'function',
+        color: "#C0DEED",
+        defaults: {
+            name:{value:""},
+            property:{value:"payload",required:true},
+            threshold:{value:"",required:true,validate:RED.validators.number()},
+            showState:{value:false}
+        },
+        inputs:1,
+        outputs:1,
+        icon: "raising-edge.png",
+        label: function() {
+            return this.name||"raising";
+        },
+        paletteLabel: "raising edge",
+        inputLabels: 'input',
+        outputLabels: 'edge trigger',
+        oneditprepare: function() {
+            $("#node-input-property").typedInput({
+                type:"msg",
+                types:["msg"],
+                typeField: "#node-input-property-type"
+            })
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="raisingEdge">
+    <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-threshold"><i class="fa fa-chevron-up"></i> Threshold</label>
+        <input type="text" id="node-input-threshold">
+    </div>
+    <div class="form-row">
+        <label for="node-input-showStatus"><i class="fa fa-star-o"></i> Status</label>
+        <input type="checkbox" id="node-input-showState" style="display:inline-block; width:20px; vertical-align:baseline;">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="raisingEdge">
+    
+    <p>Message is only forwarded, if the payload raises above a threshold value.</p>
+    <p>Each <code>topic</code> is treated seperatly.</p>
+
+    <h3>Input</h3>
+    
+    <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"></span></dt>
+        <dd> input value for <code>topic</code>.</dd>
+    </dl>
+    
+    <h3>Output</h3>
+
+    <p>Trigger message, in case a raising edge is detected.</p>    
+    
+    <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>Threshold <span class="property-type">number</span></dt>
+        <dd> threshold value for the edge detection.</dd>
+        <dt>Status <span class="property-type">boolean</span></dt>
+        <dd> shows the actual value as a node status.</dd>
+    </dl>
+    
+</script>

package/math_raising.js

@@ -0,0 +1,51 @@
+module.exports = function(RED) {
+
+    function RaisingEdgeNode(config) {
+        RED.nodes.createNode(this,config);
+        //this.config = config;
+        var node = this;
+        var context = this.context();
+        this.property  = config.property ?? "payload";
+        this.threshold = config.threshold;
+        this.showState = config.showState;
+
+        node.on('input', function(msg,send,done) {
+            if( msg.reset || msg.topic==="init" )
+            {
+                context.set( "data", {} );
+                node.status( "" );
+            }
+            else
+            {
+                msg.payload = Number( RED.util.getMessageProperty( msg, node.property ) );
+                let status = { fill:"gray", shape:"dot", text:msg.payload };
+
+                if( ! isNaN( msg.payload ) )
+                {
+                    let   data = context.get( "data" ) ?? {};
+                    const last = data[msg.topic] ?? Number.MAX_SAFE_INTEGER;
+                    if( msg.payload > this.threshold && this.threshold >= last )
+                    {
+                        status.fill = "green";
+                        send( msg );
+                    }
+                    data[msg.topic] = msg.payload;
+                    context.set( "data", data );
+                }
+                else
+                {
+                    status.fill = "red";
+                    status.text = "not a Number";
+                }
+
+                if( node.showState )
+                {
+                    node.status( status );
+                }
+            }
+            done();
+        });
+    }
+
+    RED.nodes.registerType("raisingEdge",RaisingEdgeNode);
+}

package/math_reduce.html

@@ -42,6 +42,7 @@
                 types:["msg"],
                 typeField: "#node-input-property-type"
             });
+            /*
             $("#node-input-algo").typedInput({
                 types:[{
                     value:"algo",
@@ -53,7 +54,7 @@
                         { value: "max", label: "Maximum" }
                     ]
                 }]
-            })
+            })*/
         }
     });
 </script>
@@ -86,7 +87,13 @@
     </div>
     <div class="form-row">
         <label for="node-input-algo"><i class="fa fa-flask"></i> Algorithm</label>
-        <input type="text" id="node-input-algo">
+        <select type="text" id="node-input-algo">
+            <option value="add">Adition</option>
+            <option value="mean">Mean Value</option>
+            <option value="prod">Product</option>
+            <option value="min">Minimum</option>
+            <option value="max">Maximum</option>
+        </select>
     </div>
 </script>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mschaeffler/node-red-logic",
-  "version": "0.3.0",
+  "version": "0.4.2",
   "description": "nodes for simple mathematical operations.",
   "license": "LGPL-2.1",
   "homepage": "https://github.com/m-schaeffler/node-red-my-nodes/tree/main/node-red-logic",
@@ -22,6 +22,9 @@
       "tonumber":"math_number.js",
       "or":"logic_or.js",
       "and":"logic_and.js",
+      "fallingEdge":"math_falling.js",
+      "raisingEdge":"math_raising.js",
+      "hysteresisEdge":"math_hysteresis.js",
       "reduce":"math_reduce.js"
     }
   },