node-red-contrib-difference 1.0.0

package/README.md

@@ -0,0 +1,82 @@
+# node-red-contrib-difference
+
+Node-RED Difference Calculator - calculates the difference between two numeric input values.
+
+## Features
+
+- Calculates A - B from two input values
+- Configurable topic names for inputs
+- Absolute value mode (|A - B|)
+- Configurable decimal places (0-10)
+- Outputs detailed input info
+
+## Behavior
+
+- Input A identified by configurable topic (default: "a")
+- Input B identified by configurable topic (default: "b")
+- Result = A - B
+- Output triggered on every new message once both values are known
+
+## Example
+
+```
+topic="a", payload=24.5  → stored as A
+topic="b", payload=18.2  → stored as B
+Output: 24.5 - 18.2 = 6.3
+```
+
+## Configuration
+
+| Property | Description | Default |
+|----------|-------------|---------|
+| Topic A | Topic name for input A | "a" |
+| Topic B | Topic name for input B | "b" |
+| Absolute | Output absolute value | false |
+| Decimals | Number of decimal places | 2 |
+
+## Input
+
+- `msg.payload` - Numeric value
+- `msg.topic` - **Required** - Must match Topic A or Topic B
+
+### Runtime Override
+
+| Property | Description |
+|----------|-------------|
+| `msg.reset` | `true` = reset both values |
+
+## Output
+
+```json
+{
+  "payload": 6.3,
+  "inputs": {
+    "a": { "topic": "a", "value": 24.5 },
+    "b": { "topic": "b", "value": 18.2 },
+    "result": 6.3,
+    "absolute": false
+  }
+}
+```
+
+## Use Cases
+
+| Application | Description |
+|-------------|-------------|
+| Temperature | Difference between two sensors |
+| Energy | Consumption difference between readings |
+| Level | Water level difference |
+
+## Node Status
+
+- **a(24.5) - b(18.2) = 6.3** - Result calculated
+- **Waiting for a...** - Input A missing
+- **Waiting for a and b...** - Both inputs missing
+
+## Author
+
+sr.rpo
+
+## License
+
+MIT

package/difference.html

@@ -0,0 +1,137 @@
+<script type="text/javascript">
+  RED.nodes.registerType("difference", {
+    category: "function",
+    color: "#D4600A",
+    defaults: {
+      name: { value: "" },
+      topicA: { value: "a" },
+      topicB: { value: "b" },
+      absolute: { value: false },
+      decimals: { value: 2 },
+    },
+    inputs: 1,
+    outputs: 1,
+    icon: "font-awesome/fa-minus",
+    label: function () {
+      return this.name || "difference";
+    },
+    paletteLabel: "difference",
+  });
+</script>
+
+<script type="text/html" data-template-name="difference">
+  <div class="form-row">
+    <label for="node-input-name"
+      ><i class="fa fa-tag"></i>
+      <span data-i18n="difference.label.name">Name</span></label
+    >
+    <input
+      type="text"
+      id="node-input-name"
+      data-i18n="[placeholder]difference.label.name"
+    />
+  </div>
+  <div class="form-row">
+    <label for="node-input-topicA"
+      ><i class="fa fa-tag"></i>
+      <span data-i18n="difference.label.topicA">Topic A</span></label
+    >
+    <input type="text" id="node-input-topicA" style="width: 150px;" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-topicB"
+      ><i class="fa fa-tag"></i>
+      <span data-i18n="difference.label.topicB">Topic B</span></label
+    >
+    <input type="text" id="node-input-topicB" style="width: 150px;" />
+  </div>
+  <div class="form-row">
+    <label for="node-input-absolute"
+      ><i class="fa fa-calculator"></i>
+      <span data-i18n="difference.label.absolute">Absolute</span></label
+    >
+    <input
+      type="checkbox"
+      id="node-input-absolute"
+      style="width: auto; margin-left: 0;"
+    />
+    <span data-i18n="difference.label.absoluteHint" style="margin-left: 5px; color: #888;">
+      Output |A - B|
+    </span>
+  </div>
+  <div class="form-row">
+    <label for="node-input-decimals"
+      ><i class="fa fa-hashtag"></i>
+      <span data-i18n="difference.label.decimals">Decimals</span></label
+    >
+    <input
+      type="number"
+      id="node-input-decimals"
+      min="0"
+      max="10"
+      style="width: 60px;"
+    />
+  </div>
+</script>
+
+<script type="text/html" data-help-name="difference">
+  <p>Calculates the difference between two numeric input values.</p>
+
+  <h3>Behavior</h3>
+  <ul>
+    <li>Input A identified by configurable topic (default: "a")</li>
+    <li>Input B identified by configurable topic (default: "b")</li>
+    <li>Result = A - B</li>
+    <li>Output triggered on every new message once both values are known</li>
+  </ul>
+
+  <h3>Example</h3>
+  <pre>
+topic="a", payload=24.5  → stored as A
+topic="b", payload=18.2  → stored as B
+Output: 24.5 - 18.2 = 6.3</pre>
+
+  <h3>Inputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">number</span></dt>
+    <dd>Numeric value for A or B</dd>
+    <dt>topic <span class="property-type">string</span></dt>
+    <dd><b>Required</b> - Must match Topic A or Topic B</dd>
+    <dt>reset <span class="property-type">boolean</span></dt>
+    <dd><i>(optional)</i> <code>true</code> = reset both values</dd>
+  </dl>
+
+  <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>payload <span class="property-type">number</span></dt>
+    <dd>The calculated difference (A - B)</dd>
+    <dt>inputs <span class="property-type">object</span></dt>
+    <dd>Detailed info: { a: {...}, b: {...}, result, absolute }</dd>
+  </dl>
+
+  <h3>Configuration</h3>
+  <dl class="message-properties">
+    <dt>Topic A</dt>
+    <dd>Topic name for input A (default: "a")</dd>
+    <dt>Topic B</dt>
+    <dd>Topic name for input B (default: "b")</dd>
+    <dt>Absolute</dt>
+    <dd>Output absolute value |A - B| (default: off)</dd>
+    <dt>Decimals</dt>
+    <dd>Number of decimal places (0-10, default: 2)</dd>
+  </dl>
+
+  <h3>Use Cases</h3>
+  <ul>
+    <li><b>Temperature:</b> Difference between two sensors</li>
+    <li><b>Energy:</b> Consumption difference between readings</li>
+    <li><b>Level:</b> Water level difference</li>
+  </ul>
+
+  <h3>Node Status</h3>
+  <ul>
+    <li><b>a(24.5) - b(18.2) = 6.3</b> - Result calculated</li>
+    <li><b>Waiting for a...</b> - Input A missing</li>
+    <li><b>Waiting for a and b...</b> - Both inputs missing</li>
+  </ul>
+</script>

package/difference.js

@@ -0,0 +1,118 @@
+module.exports = function(RED) {
+    function DifferenceNode(config) {
+        RED.nodes.createNode(this, config);
+        var node = this;
+
+        this.topicA = config.topicA || "a";
+        this.topicB = config.topicB || "b";
+        this.absolute = config.absolute === true || config.absolute === "true";
+        this.decimals = parseInt(config.decimals);
+        if (isNaN(this.decimals) || this.decimals < 0) {
+            this.decimals = 2;
+        }
+        if (this.decimals > 10) {
+            this.decimals = 10;
+        }
+
+        this.valueA = null;
+        this.valueB = null;
+
+        updateStatus(node);
+
+        node.on('input', function(msg, send, done) {
+            // Handle reset
+            if (msg.reset === true) {
+                node.valueA = null;
+                node.valueB = null;
+                updateStatus(node);
+                if (done) done();
+                return;
+            }
+
+            // Check for topic
+            if (!msg.topic || msg.topic === "") {
+                node.warn("msg.topic is required");
+                if (done) done();
+                return;
+            }
+
+            // Check if topic matches A or B
+            var isTopicA = msg.topic === node.topicA;
+            var isTopicB = msg.topic === node.topicB;
+
+            if (!isTopicA && !isTopicB) {
+                node.warn("Topic '" + msg.topic + "' not configured (expected '" + node.topicA + "' or '" + node.topicB + "')");
+                if (done) done();
+                return;
+            }
+
+            // Validate payload is numeric
+            var value = parseFloat(msg.payload);
+            if (isNaN(value)) {
+                node.warn("Payload is not a valid number: " + msg.payload);
+                if (done) done();
+                return;
+            }
+
+            // Store value
+            if (isTopicA) {
+                node.valueA = value;
+            } else {
+                node.valueB = value;
+            }
+
+            // Check if we have both values
+            if (node.valueA !== null && node.valueB !== null) {
+                var result = node.valueA - node.valueB;
+
+                if (node.absolute) {
+                    result = Math.abs(result);
+                }
+
+                // Round to decimals
+                result = parseFloat(result.toFixed(node.decimals));
+
+                msg.payload = result;
+                msg.inputs = {
+                    a: { topic: node.topicA, value: node.valueA },
+                    b: { topic: node.topicB, value: node.valueB },
+                    result: result,
+                    absolute: node.absolute
+                };
+
+                send(msg);
+            }
+
+            updateStatus(node);
+            if (done) done();
+        });
+
+        node.on('close', function() {
+            node.valueA = null;
+            node.valueB = null;
+        });
+    }
+
+    function updateStatus(node) {
+        if (node.valueA === null && node.valueB === null) {
+            node.status({ fill: "yellow", shape: "ring", text: "Waiting for " + node.topicA + " and " + node.topicB + "..." });
+        } else if (node.valueA === null) {
+            node.status({ fill: "yellow", shape: "ring", text: "Waiting for " + node.topicA + "..." });
+        } else if (node.valueB === null) {
+            node.status({ fill: "yellow", shape: "ring", text: "Waiting for " + node.topicB + "..." });
+        } else {
+            var result = node.valueA - node.valueB;
+            if (node.absolute) {
+                result = Math.abs(result);
+            }
+            result = parseFloat(result.toFixed(node.decimals));
+            node.status({
+                fill: "green",
+                shape: "dot",
+                text: node.topicA + "(" + node.valueA + ") - " + node.topicB + "(" + node.valueB + ") = " + result
+            });
+        }
+    }
+
+    RED.nodes.registerType("difference", DifferenceNode);
+}

package/locales/de/difference.html

@@ -0,0 +1,61 @@
+<script type="text/html" data-help-name="difference">
+    <p>Berechnet die Differenz zwischen zwei numerischen Eingabewerten.</p>
+
+    <h3>Verhalten</h3>
+    <ul>
+        <li>Input A identifiziert durch konfigurierbares Topic (Standard: "a")</li>
+        <li>Input B identifiziert durch konfigurierbares Topic (Standard: "b")</li>
+        <li>Ergebnis = A - B</li>
+        <li>Output bei jeder neuen Nachricht, sobald beide Werte bekannt sind</li>
+    </ul>
+
+    <h3>Beispiel</h3>
+    <pre>
+topic="a", payload=24.5  → gespeichert als A
+topic="b", payload=18.2  → gespeichert als B
+Ausgabe: 24.5 - 18.2 = 6.3</pre>
+
+    <h3>Eingaben</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">number</span></dt>
+        <dd>Numerischer Wert für A oder B</dd>
+        <dt>topic <span class="property-type">string</span></dt>
+        <dd><b>Erforderlich</b> - Muss Topic A oder Topic B entsprechen</dd>
+        <dt>reset <span class="property-type">boolean</span></dt>
+        <dd><i>(optional)</i> <code>true</code> = beide Werte zurücksetzen</dd>
+    </dl>
+
+    <h3>Ausgaben</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">number</span></dt>
+        <dd>Die berechnete Differenz (A - B)</dd>
+        <dt>inputs <span class="property-type">object</span></dt>
+        <dd>Detaillierte Info: { a: {...}, b: {...}, result, absolute }</dd>
+    </dl>
+
+    <h3>Konfiguration</h3>
+    <dl class="message-properties">
+        <dt>Topic A</dt>
+        <dd>Topic-Name für Input A (Standard: "a")</dd>
+        <dt>Topic B</dt>
+        <dd>Topic-Name für Input B (Standard: "b")</dd>
+        <dt>Absolut</dt>
+        <dd>Absoluten Wert |A - B| ausgeben (Standard: aus)</dd>
+        <dt>Dezimalstellen</dt>
+        <dd>Anzahl der Dezimalstellen (0-10, Standard: 2)</dd>
+    </dl>
+
+    <h3>Anwendungsbeispiele</h3>
+    <ul>
+        <li><b>Temperatur:</b> Differenz zwischen zwei Sensoren</li>
+        <li><b>Energie:</b> Verbrauchsdifferenz zwischen Ablesungen</li>
+        <li><b>Füllstand:</b> Wasserstandsdifferenz</li>
+    </ul>
+
+    <h3>Node Status</h3>
+    <ul>
+        <li><b>a(24.5) - b(18.2) = 6.3</b> - Ergebnis berechnet</li>
+        <li><b>Warte auf a...</b> - Input A fehlt</li>
+        <li><b>Warte auf a und b...</b> - Beide Inputs fehlen</li>
+    </ul>
+</script>

package/locales/de/difference.json

@@ -0,0 +1,12 @@
+{
+  "difference": {
+    "label": {
+      "name": "Name",
+      "topicA": "Topic A",
+      "topicB": "Topic B",
+      "absolute": "Absolut",
+      "absoluteHint": "Ausgabe |A - B|",
+      "decimals": "Dezimalstellen"
+    }
+  }
+}

package/locales/en/difference.json

@@ -0,0 +1,12 @@
+{
+  "difference": {
+    "label": {
+      "name": "Name",
+      "topicA": "Topic A",
+      "topicB": "Topic B",
+      "absolute": "Absolute",
+      "absoluteHint": "Output |A - B|",
+      "decimals": "Decimals"
+    }
+  }
+}

package/locales/es/difference.html

@@ -0,0 +1,61 @@
+<script type="text/html" data-help-name="difference">
+    <p>Calcula la diferencia entre dos valores de entrada numéricos.</p>
+
+    <h3>Comportamiento</h3>
+    <ul>
+        <li>Input A identificado por topic configurable (por defecto: "a")</li>
+        <li>Input B identificado por topic configurable (por defecto: "b")</li>
+        <li>Resultado = A - B</li>
+        <li>Salida en cada nuevo mensaje una vez que ambos valores son conocidos</li>
+    </ul>
+
+    <h3>Ejemplo</h3>
+    <pre>
+topic="a", payload=24.5  → almacenado como A
+topic="b", payload=18.2  → almacenado como B
+Salida: 24.5 - 18.2 = 6.3</pre>
+
+    <h3>Entradas</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">number</span></dt>
+        <dd>Valor numérico para A o B</dd>
+        <dt>topic <span class="property-type">string</span></dt>
+        <dd><b>Requerido</b> - Debe coincidir con Topic A o Topic B</dd>
+        <dt>reset <span class="property-type">boolean</span></dt>
+        <dd><i>(opcional)</i> <code>true</code> = restablecer ambos valores</dd>
+    </dl>
+
+    <h3>Salidas</h3>
+    <dl class="message-properties">
+        <dt>payload <span class="property-type">number</span></dt>
+        <dd>La diferencia calculada (A - B)</dd>
+        <dt>inputs <span class="property-type">object</span></dt>
+        <dd>Info detallada: { a: {...}, b: {...}, result, absolute }</dd>
+    </dl>
+
+    <h3>Configuración</h3>
+    <dl class="message-properties">
+        <dt>Topic A</dt>
+        <dd>Nombre del topic para Input A (por defecto: "a")</dd>
+        <dt>Topic B</dt>
+        <dd>Nombre del topic para Input B (por defecto: "b")</dd>
+        <dt>Absoluto</dt>
+        <dd>Salida valor absoluto |A - B| (por defecto: desactivado)</dd>
+        <dt>Decimales</dt>
+        <dd>Número de decimales (0-10, por defecto: 2)</dd>
+    </dl>
+
+    <h3>Casos de uso</h3>
+    <ul>
+        <li><b>Temperatura:</b> Diferencia entre dos sensores</li>
+        <li><b>Energía:</b> Diferencia de consumo entre lecturas</li>
+        <li><b>Nivel:</b> Diferencia de nivel de agua</li>
+    </ul>
+
+    <h3>Estado del Nodo</h3>
+    <ul>
+        <li><b>a(24.5) - b(18.2) = 6.3</b> - Resultado calculado</li>
+        <li><b>Esperando a...</b> - Input A falta</li>
+        <li><b>Esperando a y b...</b> - Ambos inputs faltan</li>
+    </ul>
+</script>

package/locales/es/difference.json

@@ -0,0 +1,12 @@
+{
+  "difference": {
+    "label": {
+      "name": "Nombre",
+      "topicA": "Topic A",
+      "topicB": "Topic B",
+      "absolute": "Absoluto",
+      "absoluteHint": "Salida |A - B|",
+      "decimals": "Decimales"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "node-red-contrib-difference",
+  "version": "1.0.0",
+  "description": "Node-RED difference calculator - calculates the difference between two numeric inputs",
+  "files": [
+    "difference.js",
+    "difference.html",
+    "locales"
+  ],
+  "keywords": [
+    "node-red",
+    "difference",
+    "subtract",
+    "minus",
+    "math",
+    "calculator"
+  ],
+  "author": "sr.rpo",
+  "license": "MIT",
+  "node-red": {
+    "nodes": {
+      "difference": "difference.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"
+  }
+}