node-red-contrib-event-calc 3.3.3 → 3.3.15

package/examples/throughput-test.json

@@ -0,0 +1,293 @@
+[
+    {
+        "id": "throughput-test-flow",
+        "type": "tab",
+        "label": "Throughput Test",
+        "disabled": false,
+        "info": "Measures end-to-end throughput with per-stage breakdown.\n\nEach message carries a birth timestamp through the full pipeline:\ninject → generator → event-in → cache → calc → counter\n\nReports: total time, msg/sec, and per-message avg latency."
+    },
+    {
+        "id": "cache-tp",
+        "type": "event-cache",
+        "name": "TP Cache",
+        "maxEntries": "10000",
+        "ttl": "0"
+    },
+    {
+        "id": "comment-tp-e2e",
+        "type": "comment",
+        "z": "throughput-test-flow",
+        "name": "--- End-to-End Pipeline: inject → event-in → cache → calc → measure ---",
+        "info": "",
+        "x": 300,
+        "y": 40,
+        "wires": []
+    },
+    {
+        "id": "inject-e2e-1k",
+        "type": "inject",
+        "z": "throughput-test-flow",
+        "name": "Burst 1,000",
+        "props": [
+            { "p": "payload" }
+        ],
+        "payload": "1000",
+        "payloadType": "num",
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "x": 130,
+        "y": 100,
+        "wires": [["e2e-generator"]]
+    },
+    {
+        "id": "inject-e2e-10k",
+        "type": "inject",
+        "z": "throughput-test-flow",
+        "name": "Burst 10,000",
+        "props": [
+            { "p": "payload" }
+        ],
+        "payload": "10000",
+        "payloadType": "num",
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "x": 130,
+        "y": 160,
+        "wires": [["e2e-generator"]]
+    },
+    {
+        "id": "inject-e2e-50k",
+        "type": "inject",
+        "z": "throughput-test-flow",
+        "name": "Burst 50,000",
+        "props": [
+            { "p": "payload" }
+        ],
+        "payload": "50000",
+        "payloadType": "num",
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "x": 130,
+        "y": 220,
+        "wires": [["e2e-generator"]]
+    },
+    {
+        "id": "e2e-generator",
+        "type": "function",
+        "z": "throughput-test-flow",
+        "name": "Generator (stamps birthTime)",
+        "func": "const count = msg.payload || 1000;\nconst batchStart = Date.now();\n\n// Reset all counters\nconst resetMsg = { payload: 'reset', _batch: { count: count, startTime: batchStart } };\nnode.send([null, null, resetMsg]);\n\n// Generate messages with birth timestamps\nfor (let i = 0; i < count; i++) {\n    node.send([{\n        topic: 'tp/sensor',\n        payload: 20 + Math.random() * 10,\n        _birthTime: Date.now(),\n        _seq: i\n    }, null, null]);\n}\n\nconst genElapsed = Date.now() - batchStart;\nnode.send([null, {\n    payload: {\n        stage: 'generator',\n        messages: count,\n        elapsed_ms: genElapsed,\n        rate_per_sec: Math.round(count / (genElapsed / 1000))\n    }\n}, null]);\n\nreturn null;",
+        "outputs": 3,
+        "x": 390,
+        "y": 160,
+        "wires": [["event-in-tp-e2e"], ["debug-tp-result"], ["e2e-simple-counter", "e2e-complex-counter", "e2e-passthru-counter"]]
+    },
+    {
+        "id": "event-in-tp-e2e",
+        "type": "event-in",
+        "z": "throughput-test-flow",
+        "name": "event-in",
+        "cache": "cache-tp",
+        "topicField": "topic",
+        "valueField": "payload",
+        "x": 610,
+        "y": 100,
+        "wires": [["e2e-passthru-counter"]]
+    },
+    {
+        "id": "calc-e2e-simple",
+        "type": "event-calc",
+        "z": "throughput-test-flow",
+        "name": "Simple: a * 2",
+        "cache": "cache-tp",
+        "inputMappings": [
+            { "name": "a", "pattern": "tp/sensor" }
+        ],
+        "expression": "a * 2",
+        "triggerOn": "any",
+        "outputTopic": "tp/result_simple",
+        "x": 610,
+        "y": 180,
+        "wires": [["e2e-simple-counter"], []]
+    },
+    {
+        "id": "calc-e2e-complex",
+        "type": "event-calc",
+        "z": "throughput-test-flow",
+        "name": "Complex: round + hasChanged + prev",
+        "cache": "cache-tp",
+        "inputMappings": [
+            { "name": "a", "pattern": "tp/sensor" }
+        ],
+        "expression": "round(a, 2) + (hasChanged('a') ? 1 : 0) + (prev('a') || 0)",
+        "triggerOn": "any",
+        "outputTopic": "tp/result_complex",
+        "x": 660,
+        "y": 250,
+        "wires": [["e2e-complex-counter"], []]
+    },
+    {
+        "id": "e2e-passthru-counter",
+        "type": "function",
+        "z": "throughput-test-flow",
+        "name": "Pass-thru Counter (event-in only)",
+        "func": "const ctx = context.get('state') || { count: 0, batch: null };\n\nif (msg.payload === 'reset') {\n    ctx.count = 0;\n    ctx.batch = msg._batch;\n    context.set('state', ctx);\n    return null;\n}\n\nctx.count++;\n\nif (ctx.batch && ctx.count >= ctx.batch.count) {\n    const elapsed = Date.now() - ctx.batch.startTime;\n    const rate = Math.round(ctx.count / (elapsed / 1000));\n    const report = {\n        payload: {\n            stage: 'event-in pass-thru (no calc)',\n            messages: ctx.count,\n            elapsed_ms: elapsed,\n            rate_per_sec: rate\n        }\n    };\n    ctx.count = 0;\n    ctx.batch = null;\n    context.set('state', ctx);\n    return report;\n}\n\ncontext.set('state', ctx);\nreturn null;",
+        "outputs": 1,
+        "x": 910,
+        "y": 100,
+        "wires": [["debug-tp-result"]]
+    },
+    {
+        "id": "e2e-simple-counter",
+        "type": "function",
+        "z": "throughput-test-flow",
+        "name": "Simple Calc Counter",
+        "func": "const ctx = context.get('state') || { count: 0, batch: null };\n\nif (msg.payload === 'reset') {\n    ctx.count = 0;\n    ctx.batch = msg._batch;\n    context.set('state', ctx);\n    return null;\n}\n\nctx.count++;\n\nif (ctx.batch && ctx.count >= ctx.batch.count) {\n    const elapsed = Date.now() - ctx.batch.startTime;\n    const rate = Math.round(ctx.count / (elapsed / 1000));\n    const report = {\n        payload: {\n            stage: 'simple calc (a * 2)',\n            messages: ctx.count,\n            elapsed_ms: elapsed,\n            rate_per_sec: rate\n        }\n    };\n    ctx.count = 0;\n    ctx.batch = null;\n    context.set('state', ctx);\n    return report;\n}\n\ncontext.set('state', ctx);\nreturn null;",
+        "outputs": 1,
+        "x": 880,
+        "y": 180,
+        "wires": [["debug-tp-result"]]
+    },
+    {
+        "id": "e2e-complex-counter",
+        "type": "function",
+        "z": "throughput-test-flow",
+        "name": "Complex Calc Counter",
+        "func": "const ctx = context.get('state') || { count: 0, batch: null };\n\nif (msg.payload === 'reset') {\n    ctx.count = 0;\n    ctx.batch = msg._batch;\n    context.set('state', ctx);\n    return null;\n}\n\nctx.count++;\n\nif (ctx.batch && ctx.count >= ctx.batch.count) {\n    const elapsed = Date.now() - ctx.batch.startTime;\n    const rate = Math.round(ctx.count / (elapsed / 1000));\n    const report = {\n        payload: {\n            stage: 'complex calc (round + hasChanged + prev)',\n            messages: ctx.count,\n            elapsed_ms: elapsed,\n            rate_per_sec: rate\n        }\n    };\n    ctx.count = 0;\n    ctx.batch = null;\n    context.set('state', ctx);\n    return report;\n}\n\ncontext.set('state', ctx);\nreturn null;",
+        "outputs": 1,
+        "x": 890,
+        "y": 250,
+        "wires": [["debug-tp-result"]]
+    },
+    {
+        "id": "debug-tp-result",
+        "type": "debug",
+        "z": "throughput-test-flow",
+        "name": "Throughput Results",
+        "active": true,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": true,
+        "complete": "payload",
+        "targetType": "msg",
+        "statusVal": "payload.rate_per_sec",
+        "statusType": "auto",
+        "x": 1140,
+        "y": 180,
+        "wires": []
+    },
+    {
+        "id": "comment-tp-compare",
+        "type": "comment",
+        "z": "throughput-test-flow",
+        "name": "Results show: generator speed, event-in passthru speed, simple calc speed, complex calc speed",
+        "info": "Compare the rates to see where time is spent.\nGenerator = raw message creation\nPass-thru = event-in + cache write only\nSimple = cache write + simple expression\nComplex = cache write + expression with hasChanged/prev lookups",
+        "x": 370,
+        "y": 320,
+        "wires": []
+    },
+    {
+        "id": "comment-tp-sustained",
+        "type": "comment",
+        "z": "throughput-test-flow",
+        "name": "--- Sustained Rate Test: continuous stream with interval ---",
+        "info": "",
+        "x": 270,
+        "y": 400,
+        "wires": []
+    },
+    {
+        "id": "inject-sustained-start",
+        "type": "inject",
+        "z": "throughput-test-flow",
+        "name": "Start (10ms interval)",
+        "props": [
+            { "p": "payload" },
+            { "p": "topic", "vt": "str" }
+        ],
+        "topic": "tp/sensor_b",
+        "payload": "",
+        "payloadType": "date",
+        "repeat": "0.01",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "x": 160,
+        "y": 460,
+        "wires": [["sustained-value"]]
+    },
+    {
+        "id": "inject-sustained-stop",
+        "type": "inject",
+        "z": "throughput-test-flow",
+        "name": "Report & Reset",
+        "props": [
+            { "p": "payload" }
+        ],
+        "payload": "report",
+        "payloadType": "str",
+        "repeat": "",
+        "crontab": "",
+        "once": false,
+        "onceDelay": 0.1,
+        "x": 140,
+        "y": 520,
+        "wires": [["sustained-counter"]]
+    },
+    {
+        "id": "sustained-value",
+        "type": "function",
+        "z": "throughput-test-flow",
+        "name": "Random Value",
+        "func": "msg.payload = Math.random() * 100;\nreturn msg;",
+        "outputs": 1,
+        "x": 370,
+        "y": 460,
+        "wires": [["event-in-tp-sustained"]]
+    },
+    {
+        "id": "event-in-tp-sustained",
+        "type": "event-in",
+        "z": "throughput-test-flow",
+        "name": "",
+        "cache": "cache-tp",
+        "topicField": "topic",
+        "valueField": "payload",
+        "x": 570,
+        "y": 460,
+        "wires": [[]]
+    },
+    {
+        "id": "calc-tp-sustained",
+        "type": "event-calc",
+        "z": "throughput-test-flow",
+        "name": "Sustained: hasChanged + prev",
+        "cache": "cache-tp",
+        "inputMappings": [
+            { "name": "b", "pattern": "tp/sensor_b" }
+        ],
+        "expression": "ifelse(hasChanged('b'), round(b - prev('b'), 2), 0)",
+        "triggerOn": "any",
+        "outputTopic": "tp/result_sustained",
+        "x": 620,
+        "y": 530,
+        "wires": [["sustained-counter"], []]
+    },
+    {
+        "id": "sustained-counter",
+        "type": "function",
+        "z": "throughput-test-flow",
+        "name": "Sustained Counter",
+        "func": "const ctx = context.get('state') || { count: 0, startTime: Date.now() };\n\nif (msg.payload === 'report') {\n    const elapsed = Date.now() - ctx.startTime;\n    const rate = elapsed > 0 ? Math.round(ctx.count / (elapsed / 1000)) : 0;\n    const report = {\n        payload: {\n            stage: 'sustained (hasChanged + prev + ifelse)',\n            messages: ctx.count,\n            elapsed_ms: elapsed,\n            elapsed_sec: Math.round(elapsed / 100) / 10,\n            rate_per_sec: rate\n        }\n    };\n    context.set('state', { count: 0, startTime: Date.now() });\n    return report;\n}\n\nctx.count++;\ncontext.set('state', ctx);\nreturn null;",
+        "outputs": 1,
+        "x": 880,
+        "y": 520,
+        "wires": [["debug-tp-result"]]
+    }
+]

package/nodes/event-alarm.html

@@ -0,0 +1,252 @@
+<style>
+    .event-alarm-white-text { fill: #ffffff !important; }
+    .red-ui-palette-node[data-palette-type="event-alarm"] .red-ui-palette-label { color: #ffffff !important; }
+</style>
+
+<script type="text/javascript">
+    RED.nodes.registerType('event-alarm', {
+        category: 'event calc',
+        color: '#C44040',
+        defaults: {
+            name: { value: "" },
+            cache: { value: "", type: "event-cache", required: true },
+            conditionId: { value: "" },
+            conditionName: { value: "" },
+            inputMappings: { value: [] },
+            condition: { value: "" },
+            severity: { value: 500, validate: function(v) { var n = parseInt(v); return !isNaN(n) && n >= 0 && n <= 1000; } },
+            outputTopic: { value: "alarm/event" }
+        },
+        inputs: 1,
+        outputs: 4,
+        outputLabels: ["raised", "acknowledged", "cleared", "resolved"],
+        icon: "font-awesome/fa-bell",
+        label: function() {
+            return this.name || this.conditionName || "event alarm";
+        },
+        paletteLabel: "event alarm",
+        labelStyle: function() { return (this.name ? "node_label_italic" : "") + " event-alarm-white-text"; },
+        oneditprepare: function() {
+            var node = this;
+            var cachedTopics = [];
+
+            function fetchTopics() {
+                var cacheId = $("#node-input-cache").val();
+                if (cacheId) {
+                    $.getJSON("event-cache/" + cacheId + "/topics", function(topics) {
+                        cachedTopics = topics || [];
+                        $(".input-topic").each(function() {
+                            $(this).autocomplete("option", "source", cachedTopics);
+                        });
+                    });
+                }
+            }
+
+            $("#node-input-cache").on("change", fetchTopics);
+            setTimeout(fetchTopics, 100);
+
+            // Input mappings editable list
+            var inputList = $("#node-input-inputMappings-list").css({
+                'min-height': '150px',
+                'min-width': '450px'
+            }).editableList({
+                addItem: function(container, i, data) {
+                    var row = $('<div/>', { style: "display:flex; align-items:center; gap:5px;" }).appendTo(container);
+
+                    $('<input/>', {
+                        type: "text",
+                        placeholder: "var (e.g. 'temp')",
+                        class: "input-name"
+                    })
+                    .css({ width: "25%", flex: "0 0 auto" })
+                    .val(data.name || "")
+                    .appendTo(row);
+
+                    $('<span/>', { style: "flex: 0 0 auto;" }).text(" = ").appendTo(row);
+
+                    var topicInput = $('<input/>', {
+                        type: "text",
+                        placeholder: "topic (type to search cached topics)",
+                        class: "input-topic"
+                    })
+                    .css({ flex: "1 1 auto" })
+                    .val(data.topic || data.pattern || "")
+                    .appendTo(row);
+
+                    topicInput.autocomplete({
+                        source: cachedTopics,
+                        minLength: 0,
+                        delay: 0
+                    }).on("focus", function() {
+                        if (!$(this).val()) {
+                            $(this).autocomplete("search", "");
+                        }
+                    });
+                },
+                removable: true,
+                sortable: true,
+                addButton: true
+            });
+
+            if (node.inputMappings && node.inputMappings.length > 0) {
+                node.inputMappings.forEach(function(input) {
+                    inputList.editableList('addItem', input);
+                });
+            } else {
+                inputList.editableList('addItem', { name: 'val', pattern: '' });
+            }
+        },
+        oneditsave: function() {
+            var node = this;
+            node.inputMappings = [];
+
+            $("#node-input-inputMappings-list").editableList('items').each(function() {
+                var name = $(this).find(".input-name").val().trim();
+                var topic = $(this).find(".input-topic").val().trim();
+                if (name && topic) {
+                    node.inputMappings.push({ name: name, topic: topic });
+                }
+            });
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="event-alarm">
+    <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-cache"><i class="fa fa-database"></i> Cache</label>
+        <input type="text" id="node-input-cache">
+    </div>
+    <div class="form-row">
+        <label for="node-input-conditionId"><i class="fa fa-key"></i> Condition ID</label>
+        <input type="text" id="node-input-conditionId" placeholder="Unique alarm identifier (defaults to node ID)">
+    </div>
+    <div class="form-row">
+        <label for="node-input-conditionName"><i class="fa fa-bookmark"></i> Condition Name</label>
+        <input type="text" id="node-input-conditionName" placeholder="Human readable alarm name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-severity"><i class="fa fa-exclamation-triangle"></i> Severity</label>
+        <input type="number" id="node-input-severity" min="0" max="1000" placeholder="0-1000">
+        <div class="form-tips">Severity scale: 0 (lowest) to 1000 (highest)</div>
+    </div>
+    <div class="form-row">
+        <label style="width:100%;"><i class="fa fa-sign-in"></i> Input Variables</label>
+        <ol id="node-input-inputMappings-list"></ol>
+        <div class="form-tips">
+            Map variable names to UNS topics. These variables are used in the condition expression.
+        </div>
+    </div>
+    <div class="form-row">
+        <label for="node-input-condition"><i class="fa fa-code"></i> Condition</label>
+        <input type="text" id="node-input-condition" placeholder="e.g. temp > 80, pressure > 100 && flow < 10">
+        <div class="form-tips">
+            JavaScript expression that evaluates to true (alarm active) or false (normal).
+            Use the variable names defined above.
+        </div>
+    </div>
+    <div class="form-row">
+        <label for="node-input-outputTopic"><i class="fa fa-bell"></i> Output Topic</label>
+        <input type="text" id="node-input-outputTopic" placeholder="alarm/event">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="event-alarm">
+    <p>Alarm management node with ISA-18.2 lifecycle tracking. Subscribes to UNS topics,
+    evaluates a condition expression, and manages the full alarm lifecycle with stateful tracking.</p>
+
+    <h3>Properties</h3>
+    <dl class="message-properties">
+        <dt>Condition ID</dt>
+        <dd>Unique alarm identifier used as the state key. Defaults to the node ID.</dd>
+        <dt>Condition Name</dt>
+        <dd>Human-readable alarm name included in all output messages.</dd>
+        <dt>Severity</dt>
+        <dd>Alarm severity on a 0-1000 scale.</dd>
+        <dt>Input Variables</dt>
+        <dd>Map variable names to UNS topics (same as event-calc). These variables are available in the condition expression.</dd>
+        <dt>Condition</dt>
+        <dd>JavaScript expression that evaluates to <code>true</code> (alarm active) or <code>false</code> (normal).
+        Example: <code>temp > 80</code>, <code>pressure > 100 && flow < 10</code></dd>
+        <dt>Output Topic</dt>
+        <dd>Topic for output alarm event messages.</dd>
+    </dl>
+
+    <h3>Alarm Lifecycle (ISA-18.2)</h3>
+    <pre>
+    NORMAL ──condition true──► UNACK_ALM (Active + Unacknowledged)
+                                  │                    │
+                              ack │              condition false
+                                  ▼                    ▼
+                              ACK_ALM          UNACK_RTN
+                          (Active + Acked)  (Inactive + Unacked)
+                                  │                    │
+                        condition false            ack │
+                                  │                    │
+                                  ▼                    ▼
+                              NORMAL ◄─────────── NORMAL
+                           (Resolved)          (Resolved)
+    </pre>
+
+    <h3>Outputs</h3>
+    <p>The node has four outputs, one for each state transition:</p>
+    <ol>
+        <li><b>Raised</b> - Alarm activated (Active + Unacknowledged)</li>
+        <li><b>Acknowledged</b> - Alarm acknowledged by operator (Active + Acknowledged)</li>
+        <li><b>Cleared</b> - Condition cleared but not yet acknowledged (Inactive + Unacknowledged)</li>
+        <li><b>Resolved</b> - Alarm fully resolved, removed from state dictionary</li>
+    </ol>
+
+    <h4>Output Payload</h4>
+    <dl class="message-properties">
+        <dt>condition_id <span class="property-type">string</span></dt>
+        <dd>Unique alarm identifier</dd>
+        <dt>condition_name <span class="property-type">string</span></dt>
+        <dd>Human-readable alarm name</dd>
+        <dt>source <span class="property-type">string</span></dt>
+        <dd>The topic that triggered the alarm</dd>
+        <dt>source_node <span class="property-type">string</span></dt>
+        <dd>The node ID of the alarm node</dd>
+        <dt>active_state <span class="property-type">string</span></dt>
+        <dd>"Active" or "Inactive"</dd>
+        <dt>acked_state <span class="property-type">string</span></dt>
+        <dd>"Acknowledged" or "Unacknowledged"</dd>
+        <dt>severity <span class="property-type">number</span></dt>
+        <dd>0-1000 severity scale</dd>
+        <dt>retain <span class="property-type">boolean</span></dt>
+        <dd>true = still interesting, false = fully resolved</dd>
+        <dt>ts <span class="property-type">number</span></dt>
+        <dd>Event timestamp</dd>
+        <dt>lifecycle <span class="property-type">object</span></dt>
+        <dd>Timestamps for each lifecycle event: raised_ts, acked_ts, cleared_ts, resolved_ts</dd>
+    </dl>
+
+    <h3>Inputs</h3>
+    <p>Send messages to control alarm state:</p>
+    <dl class="message-properties">
+        <dt>payload.action = "ack" <span class="property-type">string</span></dt>
+        <dd>Acknowledge a specific alarm. Requires <code>payload.source</code> to identify which alarm.</dd>
+        <dt>payload.action = "ack_all" <span class="property-type">string</span></dt>
+        <dd>Acknowledge all active alarms.</dd>
+        <dt>payload.action = "list" <span class="property-type">string</span></dt>
+        <dd>List all active alarms (sent on output 4).</dd>
+    </dl>
+
+    <h3>State Persistence</h3>
+    <p>Alarm state is stored in node context and persists across Node-RED restarts.
+    Each alarm is keyed by the source topic that triggered it. When the alarm lifecycle
+    completes (resolved), the entry is removed from the state dictionary.</p>
+
+    <h3>Examples</h3>
+    <h4>High Temperature Alarm</h4>
+    <p>Map <code>temp</code> to <code>plant/reactor1/temperature</code>, set condition to <code>temp > 80</code></p>
+
+    <h4>Combined Condition</h4>
+    <p>Map <code>pressure</code> and <code>flow</code> to their topics, set condition to <code>pressure > 100 && flow < 10</code></p>
+
+    <h4>Acknowledging an Alarm</h4>
+    <p>Send: <code>{"payload": {"action": "ack", "source": "plant/reactor1/temperature"}}</code></p>
+</script>