node-red-contrib-limit-counter 1.0.0

package/README.md

@@ -0,0 +1,35 @@
+# node-red-contrib-rpo-limit-counter
+
+A Node-RED node: **Limit Counter**
+
+Counts rising-edge crossings of a threshold (with hysteresis) and triggers an alarm when a configurable count is reached.
+
+## Install
+
+```bash
+npm install node-red-contrib-rpo-limit-counter
+```
+
+Or via the Node-RED Palette Manager.
+
+## Inputs
+
+- **payload** (number): Value to compare against threshold
+- **msg.reset=true**: Reset counter
+
+## Outputs
+
+- **Output 1**: Current crossing count
+- **Output 2**: `true` when alarm count reached, `false` otherwise
+
+## Configuration
+
+| Parameter | Description |
+|-----------|-------------|
+| Threshold | Crossing trigger level |
+| Hysteresis | Dead-band to prevent chatter |
+| Alarm count | Count at which alarm fires |
+
+## License
+
+MIT

package/limit-counter.html

@@ -0,0 +1,65 @@
+<script type="text/javascript">
+    RED.nodes.registerType('limit-counter', {
+        category: 'rpo',
+        color: '#D4600A',
+        defaults: {
+                "name": {
+                        "value": ""
+                },
+                "threshold": {
+                        "value": 0
+                },
+                "limit": {
+                        "value": 3
+                },
+                "hysteresis": {
+                        "value": 0
+                },
+                "persistent": {
+                        "value": false
+                }
+        },
+        inputs: 1,
+        outputs: 2,
+        icon: 'font-awesome/fa-exclamation-triangle',
+        outputLabels: ["Count + info","Alarm boolean"],
+        label: function() { return this.name || 'limit-counter'; },
+        labelStyle: function() { return this.name ? 'node_label_italic' : ''; }
+    });
+</script>
+
+<script type="text/html" data-template-name="limit-counter">
+    <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-threshold"><i class="fa fa-level-up"></i> Threshold</label>
+        <input type="number" id="node-input-threshold" style="width:70%">
+    </div>
+    <div class="form-row">
+        <label for="node-input-limit"><i class="fa fa-exclamation-triangle"></i> Alarm Limit</label>
+        <input type="number" id="node-input-limit" min="1" style="width:70%">
+    </div>
+    <div class="form-row">
+        <label for="node-input-hysteresis"><i class="fa fa-arrows-h"></i> Hysteresis</label>
+        <input type="number" id="node-input-hysteresis" min="0" step="0.1" style="width:70%">
+    </div>
+    <div class="form-row">
+        <label for="node-input-persistent"><i class="fa fa-hdd-o"></i> Persistent</label>
+        <input type="checkbox" id="node-input-persistent" style="width:auto;margin-top:4px">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="limit-counter">
+    <p>Counts threshold crossings and outputs an alarm when the count reaches the configured limit.</p>
+    <h3>Output 1</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">number</span></dt><dd>Current crossing count</dd>
+        <dt>limitCounter <span class="property-type">object</span></dt><dd>{ count, limit, threshold, hysteresis, alarm, lastValue }</dd>
+    </dl>
+    <h3>Output 2</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">boolean</span></dt><dd>true = alarm (count >= limit)</dd>
+    </dl>
+</script>

package/limit-counter.js

@@ -0,0 +1,88 @@
+module.exports = function(RED) {
+    function LimitCounterNode(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+
+        node.threshold  = parseFloat(config.threshold) || 0;
+        node.limit      = parseInt(config.limit, 10)   || 3;
+        var _hy         = parseFloat(config.hysteresis);
+        node.hysteresis = isNaN(_hy) ? 0 : _hy;
+        node.persistent = config.persistent === true;
+
+        if (node.persistent) {
+            node.count         = node.context().get('count') || 0;
+            node.aboveThreshold = node.context().get('aboveThreshold') || false;
+        } else {
+            node.count          = 0;
+            node.aboveThreshold = false;
+        }
+
+        updateStatus(node);
+
+        node.on('input', function(msg) {
+            if (msg.reset === true) {
+                node.count          = 0;
+                node.aboveThreshold = false;
+                if (node.persistent) {
+                    node.context().set('count', 0);
+                    node.context().set('aboveThreshold', false);
+                }
+                updateStatus(node);
+                sendOutputs(node, msg);
+                return;
+            }
+
+            var val = parseFloat(msg.payload);
+            if (isNaN(val)) { node.warn('Input is not a number: ' + msg.payload); return; }
+
+            var wasAbove = node.aboveThreshold;
+            var isAbove  = val >= node.threshold;
+            // Hysteresis: to go from above to below, must drop below (threshold - hysteresis)
+            if (wasAbove && val >= (node.threshold - node.hysteresis)) {
+                isAbove = true;
+            }
+            node.aboveThreshold = isAbove;
+
+            // Rising edge detection
+            if (!wasAbove && isAbove) {
+                node.count++;
+                if (node.persistent) node.context().set('count', node.count);
+            }
+
+            if (node.persistent) node.context().set('aboveThreshold', node.aboveThreshold);
+
+            updateStatus(node);
+            sendOutputs(node, msg);
+        });
+
+        function sendOutputs(n, msg) {
+            var alarm = n.count >= n.limit;
+            var out1  = Object.assign({}, msg, {
+                payload:      n.count,
+                limitCounter: {
+                    count:      n.count,
+                    limit:      n.limit,
+                    threshold:  n.threshold,
+                    hysteresis: n.hysteresis,
+                    alarm:      alarm,
+                    lastValue:  parseFloat(msg.payload) || 0
+                }
+            });
+            var out2 = { payload: alarm };
+            n.send([out1, out2]);
+        }
+
+        function updateStatus(n) {
+            var alarm = n.count >= n.limit;
+            if (alarm) {
+                n.status({ fill:'red',    shape:'dot', text:'ALARM Count: '+n.count+'/'+n.limit });
+            } else if (n.count > 0) {
+                n.status({ fill:'yellow', shape:'dot', text:'Count: '+n.count+'/'+n.limit+' (threshold: '+n.threshold+')' });
+            } else {
+                n.status({ fill:'green',  shape:'dot', text:'Count: 0/'+n.limit+' (threshold: '+n.threshold+')' });
+            }
+        }
+    }
+
+    RED.nodes.registerType('limit-counter', LimitCounterNode);
+};

package/locales/de/limit-counter.json

@@ -0,0 +1,18 @@
+{
+  "limit-counter": {
+    "label": "Grenzzähler",
+    "threshold": "Schwellenwert",
+    "hysteresis": "Hysterese",
+    "alarmCount": "Alarmzähler",
+    "tip": "Zählt steigende Flanken-Schwellenwertüberschreitungen und löst bei Alarmzähler aus.",
+    "input": {
+      "payload": "Numerischer Wert zum Vergleich mit dem Schwellenwert"
+    },
+    "output1": {
+      "payload": "Aktueller Überschreitungszähler"
+    },
+    "output2": {
+      "payload": "true wenn Alarmzähler erreicht, sonst false"
+    }
+  }
+}

package/locales/en/limit-counter.json

@@ -0,0 +1,18 @@
+{
+  "limit-counter": {
+    "label": "Limit Counter",
+    "threshold": "Threshold",
+    "hysteresis": "Hysteresis",
+    "alarmCount": "Alarm count",
+    "tip": "Counts rising-edge threshold crossings and triggers alarm at alarm count.",
+    "input": {
+      "payload": "Numeric value to compare against threshold"
+    },
+    "output1": {
+      "payload": "Current crossing count"
+    },
+    "output2": {
+      "payload": "true when alarm count reached, false otherwise"
+    }
+  }
+}

package/locales/es/limit-counter.json

@@ -0,0 +1,18 @@
+{
+  "limit-counter": {
+    "label": "Contador de límite",
+    "threshold": "Umbral",
+    "hysteresis": "Histéresis",
+    "alarmCount": "Conteo de alarma",
+    "tip": "Cuenta cruces de umbral por flanco ascendente y activa alarma al conteo de alarma.",
+    "input": {
+      "payload": "Valor numérico a comparar con el umbral"
+    },
+    "output1": {
+      "payload": "Conteo de cruces actual"
+    },
+    "output2": {
+      "payload": "true cuando se alcanza el conteo de alarma, false si no"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "node-red-contrib-limit-counter",
+  "version": "1.0.0",
+  "description": "Limit counter - counts threshold crossings and outputs alarm at configured limit",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Wobi848/node-red-contrib-rpo-suite.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Wobi848/node-red-contrib-rpo-suite/issues"
+  },
+  "files": [
+    "limit-counter.js",
+    "limit-counter.html",
+    "locales",
+    "examples"
+  ],
+  "keywords": [
+    "node-red",
+    "counter",
+    "limit",
+    "alarm",
+    "threshold"
+  ],
+  "author": "sr.rpo",
+  "license": "MIT",
+  "node-red": {
+    "version": "1.0.0",
+    "nodes": {
+      "limit-counter": "limit-counter.js"
+    }
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "scripts": {
+    "test": "mocha \"test/**/*_spec.js\" --exit"
+  },
+  "devDependencies": {
+    "mocha": "^10.2.0",
+    "node-red": "^3.1.0",
+    "node-red-node-test-helper": "^0.3.6"
+  }
+}