node-red-contrib-pwm 1.0.0

package/README.md

@@ -0,0 +1,33 @@
+# node-red-contrib-rpo-pwm
+
+A Node-RED node: **PWM**
+
+Converts a duty cycle (0–100 %) into a PWM signal by toggling a 0/1 output at the configured frequency.
+
+## Install
+
+```bash
+npm install node-red-contrib-rpo-pwm
+```
+
+Or via the Node-RED Palette Manager.
+
+## Inputs
+
+- **payload** (number): Duty cycle 0–100 %
+- **msg.bypass** (boolean): If true, pass raw value through
+
+## Outputs
+
+- **Output 1**: 1 (ON) or 0 (OFF) according to PWM cycle
+
+## Configuration
+
+| Parameter | Description |
+|-----------|-------------|
+| Frequency (Hz) | PWM switching frequency |
+| Min ON time (ms) | Minimum pulse width to avoid very short pulses |
+
+## License
+
+MIT

package/locales/de/pwm.json

@@ -0,0 +1,14 @@
+{
+  "pwm": {
+    "label": "PWM",
+    "frequency": "Frequenz (Hz)",
+    "minOnTime": "Min. Einschaltdauer (ms)",
+    "tip": "Payload 0–100 setzt den Tastgrad. msg.bypass=true leitet Rohwert weiter.",
+    "input": {
+      "payload": "Tastgrad 0–100 % (Zahl)"
+    },
+    "output": {
+      "payload": "1 (EIN) oder 0 (AUS) entsprechend dem PWM-Zyklus"
+    }
+  }
+}

package/locales/en/pwm.json

@@ -0,0 +1,14 @@
+{
+  "pwm": {
+    "label": "PWM",
+    "frequency": "Frequency (Hz)",
+    "minOnTime": "Min ON time (ms)",
+    "tip": "Payload 0–100 sets duty cycle. msg.bypass=true outputs raw value.",
+    "input": {
+      "payload": "Duty cycle 0–100 % (number)"
+    },
+    "output": {
+      "payload": "1 (ON) or 0 (OFF) according to PWM cycle"
+    }
+  }
+}

package/locales/es/pwm.json

@@ -0,0 +1,14 @@
+{
+  "pwm": {
+    "label": "PWM",
+    "frequency": "Frecuencia (Hz)",
+    "minOnTime": "Tiempo mín. ON (ms)",
+    "tip": "Payload 0–100 establece el ciclo de trabajo. msg.bypass=true pasa el valor directo.",
+    "input": {
+      "payload": "Ciclo de trabajo 0–100 % (número)"
+    },
+    "output": {
+      "payload": "1 (ON) o 0 (OFF) según ciclo PWM"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "node-red-contrib-pwm",
+  "version": "1.0.0",
+  "description": "PWM generator - converts 0-100% analog value to digital pulse-width signal",
+  "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": [
+    "pwm.js",
+    "pwm.html",
+    "locales",
+    "examples"
+  ],
+  "keywords": [
+    "node-red",
+    "pwm",
+    "pulse",
+    "duty-cycle",
+    "automation"
+  ],
+  "author": "sr.rpo",
+  "license": "MIT",
+  "node-red": {
+    "version": "1.0.0",
+    "nodes": {
+      "pwm": "pwm.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/pwm.html

@@ -0,0 +1,60 @@
+<script type="text/javascript">
+    RED.nodes.registerType('pwm', {
+        category: 'rpo',
+        color: '#D4600A',
+        defaults: {
+                "name": {
+                        "value": ""
+                },
+                "period": {
+                        "value": 10
+                },
+                "periodUnit": {
+                        "value": "s"
+                },
+                "invert": {
+                        "value": false
+                }
+        },
+        inputs: 1,
+        outputs: 1,
+        icon: 'font-awesome/fa-signal',
+        label: function() { return this.name || 'pwm'; },
+        labelStyle: function() { return this.name ? 'node_label_italic' : ''; }
+    });
+</script>
+
+<script type="text/html" data-template-name="pwm">
+    <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-period"><i class="fa fa-clock-o"></i> Period</label>
+        <input type="number" id="node-input-period" min="1" style="width:50%">
+        <select id="node-input-periodUnit" 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-invert"><i class="fa fa-exchange"></i> Invert</label>
+        <input type="checkbox" id="node-input-invert" style="width:auto;margin-top:4px">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="pwm">
+    <p>PWM generator: converts a 0–100% analog value to a digital pulse-width modulation signal.</p>
+    <h3>Input</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">number</span></dt><dd>Duty cycle 0–100%</dd>
+        <dt class="optional">bypass <span class="property-type">boolean</span></dt><dd>Force ON/OFF</dd>
+        <dt class="optional">clearBypass <span class="property-type">boolean</span></dt><dd>Return to PWM</dd>
+    </dl>
+    <h3>Output</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">boolean</span></dt><dd>PWM state (fires on state change only)</dd>
+        <dt>pwm <span class="property-type">object</span></dt><dd>{ input, output, dutyOn, dutyOff, period, bypass, inverted }</dd>
+    </dl>
+</script>

package/pwm.js

@@ -0,0 +1,95 @@
+module.exports = function(RED) {
+    function PWMNode(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+
+        var pRaw   = parseFloat(config.period) || 10;
+        var pUnit  = config.periodUnit || 's';
+        node.period = pUnit === 'min' ? pRaw * 60000 : pUnit === 'ms' ? pRaw : pRaw * 1000;
+        node.invert = config.invert === true;
+        node.input  = 0;
+        node.bypass = null;
+        node.output = false;
+        node.timer  = null;
+
+        node.status({ fill:'grey', shape:'dot', text:'OFF 0%' });
+        scheduleCycle(node);
+
+        node.on('input', function(msg) {
+            if (msg.clearBypass === true) { node.bypass = null; return; }
+            if (msg.bypass !== undefined) {
+                node.bypass = (msg.bypass === true || msg.bypass === 'true') ? true : false;
+                updateStatus(node);
+                return;
+            }
+            var val = parseFloat(msg.payload);
+            if (isNaN(val)) { node.warn('Input is not a number: ' + msg.payload); return; }
+            node.input = Math.max(0, Math.min(100, val));
+            if (node.timer) clearTimeout(node.timer);
+            scheduleCycle(node);
+        });
+
+        node.on('close', function() {
+            if (node.timer) clearTimeout(node.timer);
+        });
+
+        function scheduleCycle(n) {
+            var pct     = n.input / 100;
+            var onTime  = pct * n.period;
+            var offTime = n.period - onTime;
+            var bypass  = n.bypass;
+
+            if (bypass !== null) {
+                setOutput(n, bypass, onTime, offTime);
+                n.timer = setTimeout(function() { scheduleCycle(n); }, n.period);
+                return;
+            }
+
+            if (pct <= 0) {
+                setOutput(n, false, onTime, offTime);
+                n.timer = setTimeout(function() { scheduleCycle(n); }, n.period);
+            } else if (pct >= 1) {
+                setOutput(n, true, onTime, offTime);
+                n.timer = setTimeout(function() { scheduleCycle(n); }, n.period);
+            } else {
+                setOutput(n, true, onTime, offTime);
+                n.timer = setTimeout(function() {
+                    setOutput(n, false, onTime, offTime);
+                    n.timer = setTimeout(function() { scheduleCycle(n); }, offTime);
+                }, onTime);
+            }
+        }
+
+        function setOutput(n, rawState, onTime, offTime) {
+            var state = n.invert ? !rawState : rawState;
+            if (state === n.output) return;
+            n.output = state;
+            var msg = {
+                payload: state ? 1 : 0,
+                pwm: {
+                    input:    n.input,
+                    output:   state,
+                    dutyOn:   Math.round(onTime),
+                    dutyOff:  Math.round(offTime),
+                    period:   n.period,
+                    bypass:   n.bypass !== null ? n.bypass : false,
+                    inverted: n.invert
+                }
+            };
+            updateStatus(n);
+            n.send(msg);
+        }
+
+        function updateStatus(n) {
+            if (n.bypass !== null) {
+                n.status({ fill:'yellow', shape:'dot', text:'BYPASS ' + (n.bypass ? 'ON' : 'OFF') });
+            } else if (n.output) {
+                n.status({ fill:'green', shape:'dot', text:'ON ' + n.input + '%' });
+            } else {
+                n.status({ fill:'grey',  shape:'dot', text:'OFF ' + n.input + '%' });
+            }
+        }
+    }
+
+    RED.nodes.registerType('pwm', PWMNode);
+};