node-red-contrib-rate-limiter 1.0.0

package/README.md

@@ -0,0 +1,32 @@
+# node-red-contrib-rpo-rate-limiter
+
+A Node-RED node: **Rate Limiter**
+
+Limits the maximum rate of change of a numeric value. Useful for slowly ramping setpoints or protecting actuators.
+
+## Install
+
+```bash
+npm install node-red-contrib-rpo-rate-limiter
+```
+
+Or via the Node-RED Palette Manager.
+
+## Inputs
+
+- **payload** (number): Input value
+
+## Outputs
+
+- **Output 1**: Rate-limited numeric value
+
+## Configuration
+
+| Parameter | Description |
+|-----------|-------------|
+| Max rate | Maximum allowed change per time unit |
+| Unit | /s, /min, or /h |
+
+## License
+
+MIT

package/locales/de/rate-limiter.json

@@ -0,0 +1,19 @@
+{
+  "rate-limiter": {
+    "label": "Ratenbegren­zung",
+    "maxRate": "Maximale Rate",
+    "unit": "Einheit",
+    "unit_opt": {
+      "per_s": "/s",
+      "per_min": "/min",
+      "per_h": "/h"
+    },
+    "tip": "Begrenzt die maximale Änderungsrate pro Zeiteinheit.",
+    "input": {
+      "payload": "Numerischer Eingabewert"
+    },
+    "output": {
+      "payload": "Ratenbegrenzter numerischer Wert"
+    }
+  }
+}

package/locales/en/rate-limiter.json

@@ -0,0 +1,19 @@
+{
+  "rate-limiter": {
+    "label": "Rate Limiter",
+    "maxRate": "Max rate",
+    "unit": "Unit",
+    "unit_opt": {
+      "per_s": "/s",
+      "per_min": "/min",
+      "per_h": "/h"
+    },
+    "tip": "Limits the maximum rate of change per time unit.",
+    "input": {
+      "payload": "Numeric value to rate-limit"
+    },
+    "output": {
+      "payload": "Rate-limited numeric value"
+    }
+  }
+}

package/locales/es/rate-limiter.json

@@ -0,0 +1,19 @@
+{
+  "rate-limiter": {
+    "label": "Limitador de tasa",
+    "maxRate": "Tasa máxima",
+    "unit": "Unidad",
+    "unit_opt": {
+      "per_s": "/s",
+      "per_min": "/min",
+      "per_h": "/h"
+    },
+    "tip": "Limita la tasa máxima de cambio por unidad de tiempo.",
+    "input": {
+      "payload": "Valor numérico de entrada"
+    },
+    "output": {
+      "payload": "Valor numérico con tasa limitada"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "node-red-contrib-rate-limiter",
+  "version": "1.0.0",
+  "description": "Rate limiter - limits rate of change of numeric values per second/min/hour",
+  "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": [
+    "rate-limiter.js",
+    "rate-limiter.html",
+    "locales",
+    "examples"
+  ],
+  "keywords": [
+    "node-red",
+    "rate",
+    "limiter",
+    "ramp",
+    "dynamics"
+  ],
+  "author": "sr.rpo",
+  "license": "MIT",
+  "node-red": {
+    "version": "1.0.0",
+    "nodes": {
+      "rate-limiter": "rate-limiter.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"
+  }
+}

package/rate-limiter.html

@@ -0,0 +1,54 @@
+<script type="text/javascript">
+    RED.nodes.registerType('rate-limiter', {
+        category: 'rpo',
+        color: '#D4600A',
+        defaults: {
+                "name": {
+                        "value": ""
+                },
+                "maxRate": {
+                        "value": 1
+                },
+                "maxRateUnit": {
+                        "value": "per_s"
+                },
+                "decimals": {
+                        "value": 2
+                }
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: 'font-awesome/fa-tachometer',
+        label: function() { return this.name || 'rate-limiter'; },
+        labelStyle: function() { return this.name ? 'node_label_italic' : ''; }
+    });
+</script>
+
+<script type="text/html" data-template-name="rate-limiter">
+    <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-maxRate"><i class="fa fa-tachometer"></i> Max Rate</label>
+        <input type="number" id="node-input-maxRate" min="0" step="0.1" style="width:50%">
+        <select id="node-input-maxRateUnit" style="width:18%; margin-left:4px">
+            <option value="per_s">per s</option>
+            <option value="per_min">per min</option>
+            <option value="per_h">per h</option>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-decimals"><i class="fa fa-sort-numeric-asc"></i> Decimal Places</label>
+        <input type="number" id="node-input-decimals" min="0" max="4" style="width:70%">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="rate-limiter">
+    <p>Limits the rate of change of a numeric value. Output cannot change faster than the configured maximum rate.</p>
+    <h3>Output</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">number</span></dt><dd>Rate-limited value</dd>
+        <dt>rateLimiter <span class="property-type">object</span></dt><dd>{ input, output, lastOutput, maxRate, dt, limited, decimals }</dd>
+    </dl>
+</script>

package/rate-limiter.js

@@ -0,0 +1,76 @@
+module.exports = function(RED) {
+    function RateLimiterNode(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+
+        var rRaw  = parseFloat(config.maxRate);
+        node.maxRate  = isNaN(rRaw) ? 1.0 : rRaw;
+        var rUnit = config.maxRateUnit || 'per_s';
+        node.maxRatePerS = rUnit === 'per_min' ? node.maxRate / 60 : rUnit === 'per_h' ? node.maxRate / 3600 : node.maxRate;
+
+        node.decimals   = parseInt(config.decimals, 10);
+        if (isNaN(node.decimals) || node.decimals < 0) node.decimals = 2;
+
+        node.lastOutput = undefined;
+        node.lastTime   = undefined;
+
+        node.status({ fill:'grey', shape:'ring', text:'Waiting...' });
+
+        node.on('input', function(msg) {
+            if (msg.reset === true) {
+                node.lastOutput = undefined;
+                node.lastTime   = undefined;
+                node.status({ fill:'grey', shape:'ring', text:'Waiting...' });
+                return;
+            }
+
+            var x = parseFloat(msg.payload);
+            if (isNaN(x)) { node.warn('Input is not a number: ' + msg.payload); return; }
+
+            var maxRatePerS = (msg.maxRate !== undefined) ? parseFloat(msg.maxRate) : node.maxRatePerS;
+
+            var now = Date.now();
+            var output, limited;
+
+            if (node.lastOutput === undefined) {
+                output  = x;
+                limited = false;
+            } else {
+                var dt    = (now - node.lastTime) / 1000;
+                var maxDelta = maxRatePerS * dt;
+                var delta    = x - node.lastOutput;
+                if (Math.abs(delta) > maxDelta) {
+                    output  = node.lastOutput + (delta > 0 ? 1 : -1) * maxDelta;
+                    limited = true;
+                } else {
+                    output  = x;
+                    limited = false;
+                }
+            }
+
+            output          = parseFloat(output.toFixed(node.decimals));
+            node.lastOutput = output;
+            node.lastTime   = now;
+
+            msg.payload     = output;
+            msg.rateLimiter = {
+                input:      x,
+                output:     output,
+                lastOutput: node.lastOutput,
+                maxRate:    node.maxRate,
+                dt:         node.lastTime ? Math.round((now - now) * 100) / 100 : 0,
+                limited:    limited,
+                decimals:   node.decimals
+            };
+
+            if (limited) {
+                node.status({ fill:'yellow', shape:'dot', text:output + ' → ' + x + ' (limited)' });
+            } else {
+                node.status({ fill:'green',  shape:'dot', text:output + ' (at target)' });
+            }
+            node.send(msg);
+        });
+    }
+
+    RED.nodes.registerType('rate-limiter', RateLimiterNode);
+};