node-red-contrib-comparator 1.0.0

package/README.md

@@ -0,0 +1,36 @@
+# node-red-contrib-comparator
+
+A Node-RED node that compares two numeric values identified by msg.topic and outputs a boolean result.
+
+## Installation
+
+```bash
+npm install node-red-contrib-comparator
+```
+
+## Inputs
+
+- **payload** `number`: Value for input A or B (identified by msg.topic).
+- **topic** `string`: Set to Topic A or Topic B name.
+- **operator** _(optional)_ `string`: Override operator: > < >= <= == !=
+- **reset** _(optional)_ `boolean`: Clear stored A and B values.
+
+## Outputs
+
+- **payload** `boolean`: Comparison result.
+- **comparator** `object`: { a, b, operator, result, tolerance }
+
+## Configuration
+
+- **Topic A/B**: msg.topic identifiers (default: a / b).
+- **Operator**: Comparison operator (default: >).
+- **Tolerance**: Dead band for == and != comparisons (default: 0.01).
+
+## Tips
+
+- Output fires when both A and B are known.
+- Tolerance applies only to == and != operators.
+
+## License
+
+MIT (c) sr.rpo

package/comparator.html

@@ -0,0 +1,88 @@
+<script type="text/javascript">
+    RED.nodes.registerType('comparator', {
+        category:  'rpo',
+        color:     '#D4600A',
+        defaults: {
+            name:      { value: '' },
+            topicA:    { value: 'a' },
+            topicB:    { value: 'b' },
+            operator:  { value: '>' },
+            tolerance: { value: 0.01 }
+        },
+        inputs:  1,
+        outputs: 1,
+        icon:    'font-awesome/fa-balance-scale',
+        label:   function() { return this.name || ('A ' + (this.operator || '>') + ' B'); },
+        labelStyle: function() { return this.name ? 'node_label_italic' : ''; },
+        oneditprepare: function() {
+            function toggleTolerance() {
+                var op = $('#node-input-operator').val();
+                var row = $('#node-input-tolerance').closest('.form-row');
+                if (op === '==' || op === '!=') { row.show(); } else { row.hide(); }
+            }
+            $('#node-input-operator').on('change', toggleTolerance);
+            toggleTolerance();
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="comparator">
+    <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-topicA"><i class="fa fa-font"></i> <span data-i18n="comparator.label.topicA"></span></label>
+        <input type="text" id="node-input-topicA" style="width:70%">
+    </div>
+    <div class="form-row">
+        <label for="node-input-topicB"><i class="fa fa-font"></i> <span data-i18n="comparator.label.topicB"></span></label>
+        <input type="text" id="node-input-topicB" style="width:70%">
+    </div>
+    <div class="form-row">
+        <label for="node-input-operator"><i class="fa fa-code"></i> <span data-i18n="comparator.label.operator"></span></label>
+        <select id="node-input-operator" style="width:70%">
+            <option value=">">&gt;  (A greater than B)</option>
+            <option value="<">&lt;  (A less than B)</option>
+            <option value=">=">&gt;= (A greater or equal B)</option>
+            <option value="<=">&lt;= (A less or equal B)</option>
+            <option value="==">== (A equals B)</option>
+            <option value="!=">!= (A not equals B)</option>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-tolerance"><i class="fa fa-arrows-h"></i> <span data-i18n="comparator.label.tolerance"></span></label>
+        <input type="number" id="node-input-tolerance" min="0" step="0.001" style="width:70%">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="comparator">
+    <p>Compares two numeric values identified by <code>msg.topic</code> and outputs a boolean result.</p>
+
+    <h3>Input</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">number</span></dt>
+        <dd>Numeric value for input A or B (identified by <code>msg.topic</code>).</dd>
+        <dt>topic <span class="property-type">string</span></dt>
+        <dd>Set to the configured Topic A or Topic B name.</dd>
+        <dt class="optional">operator <span class="property-type">string</span></dt>
+        <dd>Override operator for this message: <code>&gt;</code> <code>&lt;</code> <code>&gt;=</code> <code>&lt;=</code> <code>==</code> <code>!=</code></dd>
+        <dt class="optional">reset <span class="property-type">boolean</span></dt>
+        <dd>Set to <code>true</code> to clear stored A and B values.</dd>
+    </dl>
+
+    <h3>Output</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">boolean</span></dt>
+        <dd>Result of the comparison.</dd>
+        <dt>comparator <span class="property-type">object</span></dt>
+        <dd><code>{ a, b, operator, result, tolerance }</code></dd>
+    </dl>
+
+    <h3>Tips</h3>
+    <ul>
+        <li>Output fires every time a new value arrives <strong>and both A and B are known</strong>.</li>
+        <li>Tolerance applies only to <code>==</code> and <code>!=</code> operators.</li>
+        <li>Send <code>msg.reset = true</code> to clear stored values.</li>
+    </ul>
+</script>

package/comparator.js

@@ -0,0 +1,78 @@
+module.exports = function(RED) {
+    function ComparatorNode(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+
+        node.topicA    = config.topicA    || 'a';
+        node.topicB    = config.topicB    || 'b';
+        node.operator  = config.operator  || '>';
+        node.tolerance = parseFloat(config.tolerance) || 0.01;
+
+        node.valueA = undefined;
+        node.valueB = undefined;
+
+        updateStatus(node);
+
+        node.on('input', function(msg) {
+            if (msg.reset === true) {
+                node.valueA = undefined;
+                node.valueB = undefined;
+                updateStatus(node);
+                return;
+            }
+
+            var op  = msg.operator  !== undefined ? msg.operator  : node.operator;
+            var tol = msg.tolerance !== undefined ? parseFloat(msg.tolerance) : node.tolerance;
+            var topic = (msg.topic !== undefined) ? String(msg.topic) : '';
+
+            if (topic === node.topicA) {
+                var val = parseFloat(msg.payload);
+                if (isNaN(val)) { node.warn('Input A is not a number: ' + msg.payload); return; }
+                node.valueA = val;
+            } else if (topic === node.topicB) {
+                var val = parseFloat(msg.payload);
+                if (isNaN(val)) { node.warn('Input B is not a number: ' + msg.payload); return; }
+                node.valueB = val;
+            } else {
+                node.warn('Unknown topic: ' + topic + ' (expected "' + node.topicA + '" or "' + node.topicB + '")');
+                return;
+            }
+
+            if (node.valueA === undefined) { node.status({ fill: 'grey', shape: 'ring', text: 'Waiting for A...' }); return; }
+            if (node.valueB === undefined) { node.status({ fill: 'grey', shape: 'ring', text: 'Waiting for B...' }); return; }
+
+            var a = node.valueA, b = node.valueB;
+            var result;
+
+            switch (op) {
+                case '>':  result = a > b;                      break;
+                case '<':  result = a < b;                      break;
+                case '>=': result = a >= b;                     break;
+                case '<=': result = a <= b;                     break;
+                case '==': result = Math.abs(a - b) <= tol;     break;
+                case '!=': result = Math.abs(a - b) > tol;      break;
+                default:   node.warn('Unknown operator: ' + op); return;
+            }
+
+            msg.payload    = result;
+            msg.comparator = { a: a, b: b, operator: op, result: result, tolerance: tol };
+
+            if (result) {
+                node.status({ fill: 'green', shape: 'dot', text: a + ' ' + op + ' ' + b + ' → true' });
+            } else {
+                node.status({ fill: 'grey',  shape: 'dot', text: a + ' ' + op + ' ' + b + ' → false' });
+            }
+
+            node.send(msg);
+        });
+
+        function updateStatus(n) {
+            if (n.valueA === undefined || n.valueB === undefined) {
+                var waiting = (n.valueA === undefined) ? 'A' : 'B';
+                n.status({ fill: 'grey', shape: 'ring', text: 'Waiting for ' + waiting + '...' });
+            }
+        }
+    }
+
+    RED.nodes.registerType('comparator', ComparatorNode);
+};

package/locales/de/comparator.json

@@ -0,0 +1,10 @@
+{
+  "comparator": {
+    "label": {
+      "topicA": "Topic A",
+      "topicB": "Topic B",
+      "operator": "Operator",
+      "tolerance": "Toleranz (für == / !=)"
+    }
+  }
+}

package/locales/en/comparator.json

@@ -0,0 +1,10 @@
+{
+  "comparator": {
+    "label": {
+      "topicA": "Topic A",
+      "topicB": "Topic B",
+      "operator": "Operator",
+      "tolerance": "Tolerance (for == / !=)"
+    }
+  }
+}

package/locales/es/comparator.json

@@ -0,0 +1,10 @@
+{
+  "comparator": {
+    "label": {
+      "topicA": "Tema A",
+      "topicB": "Tema B",
+      "operator": "Operador",
+      "tolerance": "Tolerancia (para == / !=)"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "node-red-contrib-comparator",
+  "version": "1.0.0",
+  "description": "Compares two numeric values with configurable operator and outputs boolean result",
+  "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": [
+    "comparator.js",
+    "comparator.html",
+    "locales",
+    "examples"
+  ],
+  "keywords": [
+    "node-red",
+    "compare",
+    "comparator",
+    "greater",
+    "less",
+    "equal",
+    "boolean"
+  ],
+  "author": "sr.rpo",
+  "license": "MIT",
+  "node-red": {
+    "version": "1.0.0",
+    "nodes": {
+      "comparator": "comparator.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"
+  }
+}