@mschaeffler/node-red-logic 0.0.2 → 0.0.5

package/README.md

@@ -0,0 +1,64 @@
+# @mschaeffler/node-red-logic
+
+Nodes to perform boolean and arithmetic operations on input signals.
+
+![image of example flow](https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-logic/examples/logic.png)
+
+## Install
+
+```
+$ npm install @mschaeffler/node-red-logic
+```
+
+## Usage
+
+.
+
+### or
+
+.
+
+#### Input
+
+.
+
+|msg.    | type   | description                       |
+|:-------|:-------|:----------------------------------|
+|topic   | string | .|
+|payload | boolean| input value for `topic`.          |
+
+#### Output
+
+.
+
+|msg.    | type   | description                       |
+|:-------|:-------|:----------------------------------|
+|payload | boolean | result of `or` of all input topics.|
+
+#### Parameters
+
+|config| type   | description                       |
+|:-----|:-------|:----------------------------------|
+|  | string | .     |
+
+### and
+
+.
+
+#### Input
+
+#### Output
+
+#### Parameters
+
+## Example Flow
+
+[example flow](https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-logic/examples/logic.json)
+
+## Author
+
+[Mathias Schäffler](https://github.com/m-schaeffler)
+
+## License
+
+LGPL-2.1

package/examples/logic.json

@@ -0,0 +1 @@
+[]

package/logic_and.html

@@ -4,7 +4,8 @@
         color: "#C0DEED",
         defaults: {
             name:{value:""},
-            property:{value:"payload",required:true}
+            property:{value:"payload",required:true},
+            minData:{value:"1",validate:RED.validators.number(),required:true}
         },
         inputs:1,
         outputs:1,
@@ -34,6 +35,10 @@
         <input type="text" id="node-input-property">
         <input type="hidden" id="node-input-property-type">
     </div>
+    <div class="form-row">
+        <label for="node-input-minData"><i class="fa fa-tag"></i> min. Data</label>
+        <input type="text" id="node-input-minData">
+    </div>
 </script>
 
 <script type="text/html" data-help-name="and">

package/logic_and.js

@@ -1,4 +1,5 @@
 module.exports = function(RED) {
+    var tools = require('./tools.js');
 
     function AndNode(config) {
         RED.nodes.createNode(this,config);
@@ -6,26 +7,36 @@ module.exports = function(RED) {
         var node = this;
         var context = this.context();
         this.property = config.property || "payload";
+        this.minData  = Number( config.minData );
 
         node.on('input', function(msg,send,done) {
-            const payload = RED.util.getMessageProperty( msg, node.property );
+            const payload = tools.property2boolean( RED.util.getMessageProperty( msg, node.property ) );
 
             let data = context.get( "data" ) ?? {};
             data[msg.topic] = payload;
             context.set( "data", data );
 
             msg.payload = true;
+            let count   = 0;
             for( const item in data )
             {
+                count++;
                 if( ! data[item] )
                 {
                     msg.payload = false;
-                    break;
                 }
             }
 
-            node.status( msg.payload );
-            send( msg );
+            if( count >= node.minData )
+            {
+                node.status( msg.payload );
+                send( msg );
+            }
+            else
+            {
+                node.status( "waiting for data" );
+            }
+
             done();
         });
     }

package/logic_bool.html

@@ -0,0 +1,46 @@
+<script type="text/javascript">
+    RED.nodes.registerType('tobool',{
+        category: 'function',
+        color: "#C0DEED",
+        defaults: {
+            name:{value:""},
+            property:{value:"payload",required:true}
+        },
+        inputs:1,
+        outputs:1,
+        icon: "font-awesome/fa-check-square-o",
+        label: function() {
+            return this.name||"to bool";
+        },
+        paletteLabel: "to bool",
+        inputLabels: 'input',
+        outputLabels: 'boolean',
+        oneditprepare: function() {
+            $("#node-input-property").typedInput({
+                type:"msg",
+                types:["msg"],
+                typeField: "#node-input-property-type"
+            })
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="tobool">
+    <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>
+</script>
+
+<script type="text/html" data-help-name="tobool">
+    
+    <p>.</p>
+
+    <h3>Input</h3>
+
+</script>

package/logic_bool.js

@@ -0,0 +1,20 @@
+module.exports = function(RED) {
+    var tools = require('./tools.js');
+
+    function BoolNode(config) {
+        RED.nodes.createNode(this,config);
+        //this.config = config;
+        var node = this;
+        this.property = config.property || "payload";
+
+        node.on('input', function(msg,send,done) {
+            msg.payload = tools.property2boolean( RED.util.getMessageProperty( msg, node.property ) );
+
+            node.status( msg.payload );
+            send( msg );
+            done();
+        });
+    }
+
+    RED.nodes.registerType("tobool",BoolNode);
+}

package/logic_or.html

@@ -4,7 +4,8 @@
         color: "#C0DEED",
         defaults: {
             name:{value:""},
-            property:{value:"payload",required:true}
+            property:{value:"payload",required:true},
+            minData:{value:"1",validate:RED.validators.number(),required:true}
         },
         inputs:1,
         outputs:1,
@@ -34,6 +35,10 @@
         <input type="text" id="node-input-property">
         <input type="hidden" id="node-input-property-type">
     </div>
+    <div class="form-row">
+        <label for="node-input-minData"><i class="fa fa-tag"></i> min. Data</label>
+        <input type="text" id="node-input-minData">
+    </div>
 </script>
 
 <script type="text/html" data-help-name="or">

package/logic_or.js

@@ -1,4 +1,5 @@
 module.exports = function(RED) {
+    var tools = require('./tools.js');
 
     function OrNode(config) {
         RED.nodes.createNode(this,config);
@@ -6,26 +7,36 @@ module.exports = function(RED) {
         var node = this;
         var context = this.context();
         this.property = config.property || "payload";
+        this.minData  = Number( config.minData );
 
         node.on('input', function(msg,send,done) {
-            const payload = RED.util.getMessageProperty( msg, node.property );
+            const payload = tools.property2boolean( RED.util.getMessageProperty( msg, node.property ) );
 
             let data = context.get( "data" ) ?? {};
             data[msg.topic] = payload;
             context.set( "data", data );
 
             msg.payload = false;
+            let count   = 0;
             for( const item in data )
             {
+                count++;
                 if( data[item] )
                 {
                     msg.payload = true;
-                    break;
                 }
             }
 
-            node.status( msg.payload );
-            send( msg );
+            if( count >= node.minData )
+            {
+                node.status( msg.payload );
+                send( msg );
+            }
+            else
+            {
+                node.status( "waiting for data" );
+            }
+
             done();
         });
     }

package/math_plus.html

@@ -4,7 +4,8 @@
         color: "#C0DEED",
         defaults: {
             name:{value:""},
-            property:{value:"payload",required:true}
+            property:{value:"payload",required:true},
+            minData:{value:"1",validate:RED.validators.number(),required:true}
         },
         inputs:1,
         outputs:1,
@@ -34,6 +35,10 @@
         <input type="text" id="node-input-property">
         <input type="hidden" id="node-input-property-type">
     </div>
+    <div class="form-row">
+        <label for="node-input-minData"><i class="fa fa-tag"></i> min. Data</label>
+        <input type="text" id="node-input-minData">
+    </div>
 </script>
 
 <script type="text/html" data-help-name="plus">

package/math_plus.js

@@ -6,6 +6,7 @@ module.exports = function(RED) {
         var node = this;
         var context = this.context();
         this.property = config.property || "payload";
+        this.minData  = Number( config.minData );
 
         node.on('input', function(msg,send,done) {
             const payload = Number( RED.util.getMessageProperty( msg, node.property ) );
@@ -15,13 +16,23 @@ module.exports = function(RED) {
             context.set( "data", data );
 
             msg.payload = 0;
+            let count   = 0;
             for( const item in data )
             {
+                count++;
                 msg.payload += data[item];
             }
 
-            node.status( msg.payload );
-            send( msg );
+            if( count >= node.minData )
+            {
+                node.status( msg.payload );
+                send( msg );
+            }
+            else
+            {
+                node.status( "waiting for data" );
+            }
+
             done();
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mschaeffler/node-red-logic",
-  "version": "0.0.2",
+  "version": "0.0.5",
   "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",
@@ -19,6 +19,7 @@
     "nodes": {
       "or":"logic_or.js",
       "and":"logic_and.js",
+      "tobool":"logic_bool.js",
       "plus":"math_plus.js"
     }
   },

package/tools.js

@@ -0,0 +1,22 @@
+// general functions
+
+exports.property2boolean = function(input)
+{
+    switch( input )
+    {
+        case true:
+        case 1:
+        case "1":
+        case "true":
+        case "on":
+            return true;
+        case false:
+        case 0:
+        case "0":
+        case "false":
+        case "off":
+            return false;
+        default:
+            return null;
+    }
+}