node-red-contrib-edge-filter 1.0.0

package/README.md

@@ -0,0 +1,34 @@
+# node-red-contrib-rpo-edge-filter
+
+A Node-RED node: **Edge Filter**
+
+Passes the first message in a time window and blocks all subsequent messages until the window expires.
+
+## Install
+
+```bash
+npm install node-red-contrib-rpo-edge-filter
+```
+
+Or via the Node-RED Palette Manager.
+
+## Inputs
+
+- **payload**: Any value
+- **msg.reset=true**: Reset the filter immediately
+
+## Outputs
+
+- **Output 1**: First value within the time window
+
+## Configuration
+
+| Parameter | Description |
+|-----------|-------------|
+| Window size | Duration of the blocking window |
+| Window unit | ms, s, or min |
+| Filter mode | Time window or on-change |
+
+## License
+
+MIT

package/edge-filter.html

@@ -0,0 +1,58 @@
+<script type="text/javascript">
+    RED.nodes.registerType('edge-filter', {
+        category: 'rpo',
+        color: '#D4600A',
+        defaults: {
+                "name": {
+                        "value": ""
+                },
+                "window": {
+                        "value": 5
+                },
+                "windowUnit": {
+                        "value": "s"
+                },
+                "mode": {
+                        "value": "time"
+                }
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: 'font-awesome/fa-hand-stop-o',
+        label: function() { return this.name || 'edge-filter'; },
+        labelStyle: function() { return this.name ? 'node_label_italic' : ''; }
+    });
+</script>
+
+<script type="text/html" data-template-name="edge-filter">
+    <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-window"><i class="fa fa-clock-o"></i> Window</label>
+        <input type="number" id="node-input-window" min="1" style="width:50%">
+        <select id="node-input-windowUnit" style="width:18%; margin-left:4px">
+            <option value="ms">ms</option>
+            <option value="s">s</option>
+            <option value="min">min</option>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-mode"><i class="fa fa-sliders"></i> Mode</label>
+        <select id="node-input-mode" style="width:70%">
+            <option value="time">Time window</option>
+            <option value="changed">Changed value only</option>
+        </select>
+    </div>
+</script>
+
+<script type="text/html" data-help-name="edge-filter">
+    <p>Forwards only the first event within a configurable time window. Subsequent events are blocked (re-trigger protection).</p>
+    <h3>Modes</h3>
+    <ul>
+        <li><b>Time</b>: first message forwarded, rest blocked for window duration</li>
+        <li><b>Changed</b>: additionally blocks if value hasn't changed</li>
+    </ul>
+    <p>Send <code>msg.reset = true</code> to immediately reopen the window.</p>
+</script>

package/edge-filter.js

@@ -0,0 +1,58 @@
+module.exports = function(RED) {
+    function EdgeFilterNode(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+
+        var wRaw    = parseFloat(config.window) || 5;
+        var wUnit   = config.windowUnit || 's';
+        node.window = wUnit === 'min' ? wRaw * 60000 : wUnit === 'ms' ? wRaw : wRaw * 1000;
+        node.mode   = config.mode || 'time';
+
+        node.blocked   = false;
+        node.timer     = null;
+        node.lastValue = undefined;
+
+        node.status({ fill:'green', shape:'dot', text:'Ready (window: ' + wRaw + wUnit + ')' });
+
+        node.on('input', function(msg) {
+            if (msg.reset === true) {
+                node.blocked = false;
+                if (node.timer) { clearTimeout(node.timer); node.timer = null; }
+                node.lastValue = undefined;
+                node.status({ fill:'green', shape:'dot', text:'Ready (reset)' });
+                return;
+            }
+
+            if (node.mode === 'changed') {
+                var cur = msg.payload;
+                var changed = (node.lastValue === undefined) ||
+                    (typeof cur === 'object' ? JSON.stringify(cur) !== JSON.stringify(node.lastValue) : cur !== node.lastValue);
+                if (!changed) {
+                    node.status({ fill:'grey', shape:'dot', text:'Blocked (no change)' });
+                    return;
+                }
+                node.lastValue = cur;
+            }
+
+            if (node.blocked) {
+                node.status({ fill:'red', shape:'dot', text:'Blocked (window active)' });
+                return;
+            }
+
+            node.blocked = true;
+            node.status({ fill:'green', shape:'dot', text:'Forwarded (window: ' + wRaw + wUnit + ')' });
+            node.send(msg);
+
+            node.timer = setTimeout(function() {
+                node.blocked = false;
+                node.status({ fill:'green', shape:'dot', text:'Ready (window: ' + wRaw + wUnit + ')' });
+            }, node.window);
+        });
+
+        node.on('close', function() {
+            if (node.timer) clearTimeout(node.timer);
+        });
+    }
+
+    RED.nodes.registerType('edge-filter', EdgeFilterNode);
+};

package/locales/de/edge-filter.json

@@ -0,0 +1,24 @@
+{
+  "edge-filter": {
+    "label": "Flankenfilter",
+    "window": "Fenstergröße",
+    "windowUnit": "Fenstereinheit",
+    "windowUnit_opt": {
+      "ms": "ms",
+      "s": "s",
+      "min": "min"
+    },
+    "mode": "Filtermodus",
+    "mode_opt": {
+      "time": "Zeitfenster",
+      "changed": "Bei Änderung"
+    },
+    "tip": "Blockiert wiederholte Nachrichten innerhalb des Fensters.",
+    "input": {
+      "payload": "Beliebiger Wert"
+    },
+    "output": {
+      "payload": "Weitergeleiteter Wert (erster im Fenster)"
+    }
+  }
+}

package/locales/en/edge-filter.json

@@ -0,0 +1,24 @@
+{
+  "edge-filter": {
+    "label": "Edge Filter",
+    "window": "Window size",
+    "windowUnit": "Window unit",
+    "windowUnit_opt": {
+      "ms": "ms",
+      "s": "s",
+      "min": "min"
+    },
+    "mode": "Filter mode",
+    "mode_opt": {
+      "time": "Time window",
+      "changed": "On change"
+    },
+    "tip": "Blocks repeated messages within the window. Changed mode also blocks identical values.",
+    "input": {
+      "payload": "Any value"
+    },
+    "output": {
+      "payload": "Forwarded value (first within window)"
+    }
+  }
+}

package/locales/es/edge-filter.json

@@ -0,0 +1,24 @@
+{
+  "edge-filter": {
+    "label": "Filtro de flanco",
+    "window": "Tamaño de ventana",
+    "windowUnit": "Unidad de ventana",
+    "windowUnit_opt": {
+      "ms": "ms",
+      "s": "s",
+      "min": "min"
+    },
+    "mode": "Modo de filtro",
+    "mode_opt": {
+      "time": "Ventana de tiempo",
+      "changed": "Al cambiar"
+    },
+    "tip": "Bloquea mensajes repetidos dentro de la ventana.",
+    "input": {
+      "payload": "Cualquier valor"
+    },
+    "output": {
+      "payload": "Valor reenviado (primero en ventana)"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "node-red-contrib-edge-filter",
+  "version": "1.0.0",
+  "description": "Edge filter - forwards only first event in a time window (re-trigger protection)",
+  "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": [
+    "edge-filter.js",
+    "edge-filter.html",
+    "locales",
+    "examples"
+  ],
+  "keywords": [
+    "node-red",
+    "edge",
+    "filter",
+    "window",
+    "retrigger"
+  ],
+  "author": "sr.rpo",
+  "license": "MIT",
+  "node-red": {
+    "version": "1.0.0",
+    "nodes": {
+      "edge-filter": "edge-filter.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"
+  }
+}