node-red-contrib-pt1 1.0.0

package/README.md

@@ -0,0 +1,38 @@
+# node-red-contrib-pt1
+
+A Node-RED PT1 first-order low-pass filter for smoothing noisy measurement values.
+
+Formula: y(t) = y(t-1) + (dt / (T1 + dt)) * (x(t) - y(t-1))
+
+## Installation
+
+```bash
+npm install node-red-contrib-pt1
+```
+
+## Inputs
+
+- **payload** `number`: Raw measurement value to filter.
+- **T1** _(optional)_ `number`: Override T1 in seconds for this message only.
+- **reset** _(optional)_ `boolean`: Reset filter state; next input passes through directly.
+
+## Outputs
+
+- **payload** `number`: Filtered (smoothed) value.
+- **pt1** `object`: { input, output, T1, dt, decimals, initialized }
+
+## Configuration
+
+- **Time Constant T1**: Smoothing constant with unit s/min/h. Larger = more smoothing, slower response.
+- **Decimal Places**: Output precision 0-4 (default: 2).
+
+## Tips
+
+- First message always passes through unfiltered (initialization).
+- T1 = 0 disables filtering (passthrough mode).
+- Uses actual elapsed time between messages - no fixed interval required.
+- Tip: use the 24h moving average as input for best predictive results.
+
+## License
+
+MIT (c) sr.rpo

package/locales/de/pt1.json

@@ -0,0 +1,8 @@
+{
+  "pt1": {
+    "label": {
+      "T1": "Zeitkonstante T1",
+      "decimals": "Dezimalstellen"
+    }
+  }
+}

package/locales/en/pt1.json

@@ -0,0 +1,8 @@
+{
+  "pt1": {
+    "label": {
+      "T1": "Time Constant T1",
+      "decimals": "Decimal Places"
+    }
+  }
+}

package/locales/es/pt1.json

@@ -0,0 +1,8 @@
+{
+  "pt1": {
+    "label": {
+      "T1": "Constante de tiempo T1",
+      "decimals": "Decimales"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "node-red-contrib-pt1",
+  "version": "1.0.0",
+  "description": "PT1 first-order low-pass filter for smoothing noisy measurement values",
+  "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": [
+    "pt1.js",
+    "pt1.html",
+    "locales",
+    "examples"
+  ],
+  "keywords": [
+    "node-red",
+    "pt1",
+    "low-pass",
+    "filter",
+    "smooth",
+    "lag",
+    "measurement"
+  ],
+  "author": "sr.rpo",
+  "license": "MIT",
+  "node-red": {
+    "version": "1.0.0",
+    "nodes": {
+      "pt1": "pt1.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/pt1.html

@@ -0,0 +1,70 @@
+<script type="text/javascript">
+    RED.nodes.registerType('pt1', {
+        category:  'rpo',
+        color:     '#D4600A',
+        defaults: {
+            name:     { value: '' },
+            T1:       { value: 60 },
+            T1Unit:   { value: 's' },
+            decimals: { value: 2 }
+        },
+        inputs:  1,
+        outputs: 1,
+        icon:    'font-awesome/fa-filter',
+        label:   function() { return this.name || ('PT1 T1=' + this.T1 + this.T1Unit); },
+        labelStyle: function() { return this.name ? 'node_label_italic' : ''; }
+    });
+</script>
+
+<script type="text/html" data-template-name="pt1">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> <span data-i18n="node-red:common.label.name"></span></label>
+        <input type="text" id="node-input-name" data-i18n="[placeholder]node-red:common.label.name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-T1"><i class="fa fa-clock-o"></i> <span data-i18n="pt1.label.T1"></span></label>
+        <input type="number" id="node-input-T1" min="0" style="width:50%">
+        <select id="node-input-T1Unit" style="width:18%; margin-left:4px">
+            <option value="s">s</option>
+            <option value="min">min</option>
+            <option value="h">h</option>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-decimals"><i class="fa fa-sort-numeric-asc"></i> <span data-i18n="pt1.label.decimals"></span></label>
+        <input type="number" id="node-input-decimals" min="0" max="4" style="width:70%">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="pt1">
+    <p>PT1 first-order low-pass filter. Smooths noisy measurement values with a configurable time constant <strong>T1</strong>.</p>
+
+    <h3>Formula</h3>
+    <pre>y(t) = y(t-1) + (dt / (T1 + dt)) × (x(t) - y(t-1))</pre>
+
+    <h3>Input</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">number</span></dt>
+        <dd>Raw measurement value to filter.</dd>
+        <dt class="optional">T1 <span class="property-type">number</span></dt>
+        <dd>Override time constant (in seconds) for this message only.</dd>
+        <dt class="optional">reset <span class="property-type">boolean</span></dt>
+        <dd>Set to <code>true</code> to reset filter state — next input passes through directly.</dd>
+    </dl>
+
+    <h3>Output</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">number</span></dt>
+        <dd>Filtered (smoothed) value.</dd>
+        <dt>pt1 <span class="property-type">object</span></dt>
+        <dd><code>{ input, output, T1, dt, decimals, initialized }</code></dd>
+    </dl>
+
+    <h3>Tips</h3>
+    <ul>
+        <li>The first message always passes through unfiltered (no previous state).</li>
+        <li>Set T1 = 0 to disable filtering (passthrough mode).</li>
+        <li>Larger T1 = more smoothing but slower response to changes.</li>
+        <li>The node uses actual elapsed time (dt) between messages — no fixed interval needed.</li>
+    </ul>
+</script>

package/pt1.js

@@ -0,0 +1,77 @@
+module.exports = function(RED) {
+    function PT1Node(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+
+        var _T1raw = parseFloat(config.T1);
+        var T1raw  = isNaN(_T1raw) ? 60 : _T1raw;
+        var unit   = config.T1Unit || 's';
+        node.decimals = parseInt(config.decimals, 10);
+        if (isNaN(node.decimals) || node.decimals < 0) node.decimals = 2;
+
+        // Convert T1 to seconds
+        node.T1 = toSeconds(T1raw, unit);
+
+        node.lastOutput = undefined;
+        node.lastTime   = undefined;
+
+        node.status({ fill: 'grey', shape: 'ring', text: 'Initializing...' });
+
+        node.on('input', function(msg) {
+            if (msg.reset === true) {
+                node.lastOutput = undefined;
+                node.lastTime   = undefined;
+                node.status({ fill: 'grey', shape: 'ring', text: 'Initializing...' });
+                return;
+            }
+
+            var x = parseFloat(msg.payload);
+            if (isNaN(x)) { node.warn('Input is not a number: ' + msg.payload); return; }
+
+            var T1 = (msg.T1 !== undefined) ? parseFloat(msg.T1) : node.T1;
+            if (isNaN(T1) || T1 < 0) T1 = node.T1;
+
+            var now = Date.now();
+            var output;
+            var initialized = true;
+
+            if (node.lastOutput === undefined || node.lastTime === undefined) {
+                output          = x;
+                initialized     = false;
+            } else {
+                var dt = (now - node.lastTime) / 1000;
+                if (T1 === 0) {
+                    output = x;
+                } else {
+                    var alpha = dt / (T1 + dt);
+                    output    = node.lastOutput + alpha * (x - node.lastOutput);
+                }
+            }
+
+            output          = parseFloat(output.toFixed(node.decimals));
+            node.lastOutput = output;
+            node.lastTime   = now;
+
+            msg.payload = output;
+            msg.pt1     = {
+                input:       x,
+                output:      output,
+                T1:          T1,
+                dt:          node.lastTime ? Math.round((now - (node.lastTime === now ? now : node.lastTime)) / 10) / 100 : 0,
+                decimals:    node.decimals,
+                initialized: initialized
+            };
+
+            node.status({ fill: 'green', shape: 'dot', text: 'in: ' + x + ' → out: ' + output + ' (T1: ' + T1 + 's)' });
+            node.send(msg);
+        });
+
+        function toSeconds(val, unit) {
+            if (unit === 'min') return val * 60;
+            if (unit === 'h')   return val * 3600;
+            return val;
+        }
+    }
+
+    RED.nodes.registerType('pt1', PT1Node);
+};