@mschaeffler/node-red-logic 0.3.0 → 0.4.4

package/README.md

@@ -2,7 +2,7 @@
 
 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)
+![image of nodes](https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-logic/examples/logic.png)
 
 ## Install
 
@@ -10,17 +10,9 @@ Nodes to perform boolean and arithmetic operations on input signals.
 $ npm install @mschaeffler/node-red-logic
 ```
 
-## Usage
+## Boolean Nodes
 
-### counter
-
-A node that just count the messages.
-
-#### Output
-
-|msg.    | type   | description                       |
-|:-------|:-------|:----------------------------------|
-|count | number | number of messages.|
+![image of example flow](https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-logic/examples/bool.png)
 
 ### to bool
 
@@ -124,6 +116,20 @@ The message property to be used as payload can be defined with the `Property` pr
 |Property| string | defines the message property to be used as payload.|
 |min. Data|number|min. amount of topics to generate an output.|
 
+## Integer Nodes
+
+![image of example flow](https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-logic/examples/math.png)
+
+### counter
+
+A node that just count the messages.
+
+#### Output
+
+|msg.    | type   | description                       |
+|:-------|:-------|:----------------------------------|
+|count | number | number of messages.|
+
 ### to number
 
 Converts payload to a number.
@@ -186,14 +192,118 @@ The message property to be used as payload can be defined with the `Property` pr
 
 #### Algorithms
 
-## Example Flow
+|algorithm|description|
+|:--------|:----------|
+|add      |ads up the `topic` channels|
+|mean     |averages the `topic` channels|
+|prod     |multiplies the `topic` channels|
+|min      |gets the minimal value of the `topic` channels|
+|max      |gets the maximal value of the `topic` channels|
+
+## Edge Nodes
+
+![image of example flow](https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-logic/examples/edge.png)
+
+### 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.
+
+#### Parameters
+
+|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.
 
-[example flow](https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-logic/examples/logic.json)
+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.
+
+#### Parameters
+
+|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.
+
+#### Parameters
+
+|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 Flows
+
+[boolean nodes](https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-logic/examples/bool.json)
+
+[integer nodes](https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-logic/examples/math.json)
+
+[edge nodes](https://github.com/m-schaeffler/node-red-my-nodes/raw/main/node-red-logic/examples/edge.json)
 
 ## Author
 
 [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/examples/bool.json

@@ -0,0 +1,289 @@
+[
+    {
+        "id": "874e3c59e7510080",
+        "type": "tab",
+        "label": "Flow 2",
+        "disabled": false,
+        "info": "",
+        "env": []
+    },
+    {
+        "id": "3638e932e6cd704e",
+        "type": "tobool",
+        "z": "874e3c59e7510080",
+        "name": "",
+        "property": "payload",
+        "showState": false,
+        "x": 310,
+        "y": 120,
+        "wires": [
+            [
+                "59187eb10a59d119"
+            ]
+        ]
+    },
+    {
+        "id": "7d8ce3c91fad2f4c",
+        "type": "or",
+        "z": "874e3c59e7510080",
+        "name": "",
+        "topic": "",
+        "property": "payload",
+        "minData": "1",
+        "x": 310,
+        "y": 200,
+        "wires": [
+            [
+                "c9d4c13317184fd5"
+            ]
+        ]
+    },
+    {
+        "id": "59a5371d04a4ad46",
+        "type": "and",
+        "z": "874e3c59e7510080",
+        "name": "",
+        "topic": "",
+        "property": "payload",
+        "minData": "1",
+        "x": 310,
+        "y": 280,
+        "wires": [
+            [
+                "1b5361bc5d9fa406"
+            ]
+        ]
+    },
+    {
+        "id": "59187eb10a59d119",
+        "type": "debug",
+        "z": "874e3c59e7510080",
+        "name": "",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": true,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "payload",
+        "statusType": "auto",
+        "x": 490,
+        "y": 120,
+        "wires": []
+    },
+    {
+        "id": "71b5ad607d2a4667",
+        "type": "inject",
+        "z": "874e3c59e7510080",
+        "name": "reset",
+        "props": [
+            {
+                "p": "reset",
+                "v": "true",
+                "vt": "bool"
+            },
+            {
+                "p": "topic",
+                "vt": "str"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "",
+        "x": 150,
+        "y": 320,
+        "wires": [
+            [
+                "59a5371d04a4ad46",
+                "7d8ce3c91fad2f4c"
+            ]
+        ]
+    },
+    {
+        "id": "308f4479c5fe35b5",
+        "type": "inject",
+        "z": "874e3c59e7510080",
+        "name": "",
+        "props": [
+            {
+                "p": "topic",
+                "vt": "str"
+            },
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "A",
+        "payload": "invalid",
+        "payloadType": "str",
+        "x": 140,
+        "y": 80,
+        "wires": [
+            [
+                "3638e932e6cd704e"
+            ]
+        ]
+    },
+    {
+        "id": "93b191eedfb167ba",
+        "type": "inject",
+        "z": "874e3c59e7510080",
+        "name": "",
+        "props": [
+            {
+                "p": "topic",
+                "vt": "str"
+            },
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "A",
+        "payload": "on",
+        "payloadType": "str",
+        "x": 150,
+        "y": 120,
+        "wires": [
+            [
+                "3638e932e6cd704e",
+                "7d8ce3c91fad2f4c",
+                "59a5371d04a4ad46"
+            ]
+        ]
+    },
+    {
+        "id": "bc22906368cc9ebd",
+        "type": "inject",
+        "z": "874e3c59e7510080",
+        "name": "",
+        "props": [
+            {
+                "p": "topic",
+                "vt": "str"
+            },
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "A",
+        "payload": "off",
+        "payloadType": "str",
+        "x": 150,
+        "y": 160,
+        "wires": [
+            [
+                "3638e932e6cd704e",
+                "7d8ce3c91fad2f4c",
+                "59a5371d04a4ad46"
+            ]
+        ]
+    },
+    {
+        "id": "c9d4c13317184fd5",
+        "type": "debug",
+        "z": "874e3c59e7510080",
+        "name": "",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": true,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "payload",
+        "statusType": "auto",
+        "x": 490,
+        "y": 200,
+        "wires": []
+    },
+    {
+        "id": "1b5361bc5d9fa406",
+        "type": "debug",
+        "z": "874e3c59e7510080",
+        "name": "",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": true,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "payload",
+        "statusType": "auto",
+        "x": 490,
+        "y": 280,
+        "wires": []
+    },
+    {
+        "id": "49a9351d2c03c622",
+        "type": "inject",
+        "z": "874e3c59e7510080",
+        "name": "",
+        "props": [
+            {
+                "p": "topic",
+                "vt": "str"
+            },
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "B",
+        "payload": "0",
+        "payloadType": "num",
+        "x": 150,
+        "y": 260,
+        "wires": [
+            [
+                "59a5371d04a4ad46",
+                "7d8ce3c91fad2f4c"
+            ]
+        ]
+    },
+    {
+        "id": "2b32172c0bd9fa07",
+        "type": "inject",
+        "z": "874e3c59e7510080",
+        "name": "",
+        "props": [
+            {
+                "p": "topic",
+                "vt": "str"
+            },
+            {
+                "p": "payload"
+            }
+        ],
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "topic": "B",
+        "payload": "5",
+        "payloadType": "num",
+        "x": 150,
+        "y": 220,
+        "wires": [
+            [
+                "7d8ce3c91fad2f4c",
+                "59a5371d04a4ad46"
+            ]
+        ]
+    }
+]