@bldgblocks/node-red-contrib-control 0.1.34 → 0.1.37

package/nodes/accumulate-block.html

@@ -3,6 +3,10 @@
         <label for="node-input-name" title="Display name shown on the canvas"><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-inputProperty" title="Message property to read input from"><i class="fa fa-folder-open"></i> Input Property</label>
+        <input type="text" id="node-input-inputProperty" placeholder="payload">
+    </div>
     <div class="form-row">
         <label for="node-input-mode" title="Select accumulation mode"><i class="fa fa-cog"></i> Mode</label>
         <select id="node-input-mode">
@@ -19,6 +23,7 @@
         color: "#301934",
         defaults: {
             name: { value: "" },
+            inputProperty: { value: "payload" },
             mode: { value: "true", required: true }
         },
         inputs: 1,
@@ -40,22 +45,27 @@
 </script>
 
 <script type="text/markdown" data-help-name="accumulate-block">
-Counts consecutive inputs based on the selected mode, resetting on specific conditions.
+Counts consecutive inputs from a configured property based on the selected mode, resetting on specific conditions.
 
 ### Inputs
-: context (string) : Configuration commands = reset (`"reset"` to clear count).
-: payload (boolean) : For `Accumulate True`, `true` increments count, `false` resets; for `Accumulate False`, `false` increments count, `true` resets; ignored in `Accumulate Flows`.
+: input-property (boolean, for true/false modes) : Input value to evaluate, read from the configured Input Property.
+: context (string) : Configuration commands (`"reset"` to clear count).
 
 ### Outputs
 : payload (number) : Current count based on mode.
 
+### Properties
+: name (string) : Display name in editor.
+: inputProperty (string) : Message property to read input from (default: `payload`). Supports nested properties (e.g., `data.value`).
+: mode (string) : Accumulation mode (`"true"`, `"false"`, `"flows"`).
+
 ### Details
-Counts inputs according to the selected mode 
-- `Accumulate True` counts consecutive `true` `msg.payload` inputs (reset on `false` or explicit reset)
-- `Accumulate False` counts consecutive `false` `msg.payload` inputs (reset on `true` or explicit reset)
-- `Accumulate Flows` counts all valid input messages (reset only on explicit reset). 
+Counts inputs according to the selected mode, reading from the configured **Input Property** (default: `msg.payload`):
+- **Accumulate True**: counts consecutive `true` values (resets on `false` or explicit reset)
+- **Accumulate False**: counts consecutive `false` values (resets on `true` or explicit reset)
+- **Accumulate Flows**: counts all valid input messages (resets only on explicit reset)
 
-Reset via `msg.context = "reset"` with `msg.payload = true` applies immediately;
+Reset via `msg.context = "reset"` with `msg.payload = true`.
 
 Used to track sustained events or message frequency.
 

package/nodes/accumulate-block.js

@@ -1,95 +1,90 @@
 module.exports = function(RED) {
+    const utils = require("./utils")(RED);
+
     function AccumulateBlockNode(config) {
         RED.nodes.createNode(this, config);
         const node = this;
 
         // Initialize runtime state
-        node.runtime = {
-            name: config.name,
-            mode: config.mode,
-            count: 0,
-            lastCount: null
-        };
+        // Initialize state
+        node.name = config.name;
+        node.inputProperty = config.inputProperty || "payload";
+        node.mode = config.mode;
+        node.count = 0;
+        node.lastCount = null;
 
         // Set initial status
-        node.status({
-            fill: "green",
-            shape: "dot",
-            text: `mode: ${node.runtime.mode}, name: ${node.runtime.name || node.runtime.mode + " accumulate"}`
-        });
+        utils.setStatusOK(node, `mode: ${node.mode}, name: ${node.name || node.mode + " accumulate"}`);
 
         node.on("input", function(msg, send, done) {
             send = send || function() { node.send.apply(node, arguments); };
 
             // Guard against invalid msg
             if (!msg) {
-                node.status({ fill: "red", shape: "ring", text: "missing message" });
+                utils.setStatusError(node, "missing message");
                 node.warn("Missing message");
                 if (done) done();
                 return;
             }
 
-            // Handle reset command with intentional payload requirement
             if (msg.context === "reset") {
                 if (msg.payload === true) {
-                    node.runtime.count = 0;
-                    updateStatus();
+                    node.count = 0;
+                    utils.setStatusWarn(node, "reset");
                     if (done) done();
                     return;
                 }
-                // payload !== true: treat as normal message, don't reset
             }
 
             // Process input based on mode
-            if (node.runtime.mode !== "flows") {
-                // Check for missing payload
-                if (!msg.hasOwnProperty("payload")) {
-                    node.status({ fill: "red", shape: "ring", text: "missing payload" });
-                    node.warn("Missing payload");
-                    if (done) done();
-                    return;
+            if (node.mode !== "flows") {
+                // Get input value from configured property
+                let inputValue;
+                try {
+                    inputValue = RED.util.getMessageProperty(msg, node.inputProperty);
+                } catch (err) {
+                    inputValue = undefined;
                 }
-
-                // Validate input
-                const inputValue = msg.payload;
-                if (typeof inputValue !== "boolean") {
-                    node.status({ fill: "red", shape: "ring", text: "invalid input" });
-                    node.warn("Invalid input: non-boolean payload");
+                const boolVal = utils.validateBoolean(inputValue);
+                if (!boolVal.valid) {
+                    utils.setStatusError(node, boolVal.error);
+                    node.warn("Invalid input: non-boolean value");
                     if (done) done();
                     return;
                 }
+                inputValue = boolVal.value;
 
-                // Prevent extended time running isues
-                if (node.runtime.count > 9999) {
-                    node.runtime.count = 0;
+                // Prevent extended time running issues
+                if (node.count > 9999) {
+                    node.count = 0;
                 }
 
                 // Accumulate or reset count
-                if (node.runtime.mode === "true") {
+                if (node.mode === "true") {
                     if (inputValue === true) {
-                        node.runtime.count++;
+                        node.count++;
                     } else {
-                        node.runtime.count = 0;
+                        node.count = 0;
                     }
-                } else if (node.runtime.mode === "false") {
+                } else if (node.mode === "false") {
                     if (inputValue === false) {
-                        node.runtime.count++;
+                        node.count++;
                     } else {
-                        node.runtime.count = 0;
+                        node.count = 0;
                     }
                 }
             } else {
                 // flows mode: count all valid messages
-                node.runtime.count++;
+                node.count++;
             }
 
             // Output only if count changed
-            if (node.runtime.lastCount !== node.runtime.count) {
-                node.runtime.lastCount = node.runtime.count;
-                node.status({ fill: "blue", shape: "dot", text: `out: ${node.runtime.count}` });
-                send({ payload: node.runtime.count });
+            if (node.lastCount !== node.count) {
+                node.lastCount = node.count;
+                utils.setStatusChanged(node, `out: ${node.count}`);
+                send({ payload: node.count });
             } else {
-                node.status({ fill: "blue", shape: "ring", text: `out: ${node.runtime.count}` });
+                utils.setStatusUnchanged(node, `out: ${node.count}`);
             }
 
             if (done) done();

package/nodes/add-block.html

@@ -59,7 +59,7 @@ Outputs sum for each valid slot update.
 - Blue (dot): State changed
 - Blue (ring): State unchanged
 - Red (ring): Error
-- Yellow: Warning
+- Yellow (ring): Warning
 
 ### References
 - [Node-RED Documentation](https://nodered.org/docs/)

package/nodes/add-block.js

@@ -1,4 +1,6 @@
 module.exports = function(RED) {
+    const utils = require('./utils')(RED);
+
     function AddBlockNode(config) {
         RED.nodes.createNode(this, config);
         const node = this;
@@ -14,20 +16,20 @@ module.exports = function(RED) {
 
             // Guard against invalid msg
             if (!msg) {
-                node.status({ fill: "red", shape: "ring", text: "invalid message" });
+                utils.setStatusError(node, "invalid message");
                 if (done) done();
                 return;
             }
 
             // Check for required properties
             if (!msg.hasOwnProperty("context")) {
-                node.status({ fill: "red", shape: "ring", text: "missing context" });
+                utils.setStatusError(node, "missing context");
                 if (done) done();
                 return;
             }
 
             if (!msg.hasOwnProperty("payload")) {
-                node.status({ fill: "red", shape: "ring", text: "missing payload" });
+                utils.setStatusError(node, "missing payload");
                 if (done) done();
                 return;
             }
@@ -35,40 +37,40 @@ module.exports = function(RED) {
             // Handle configuration messages
             if (msg.context === "reset") {
                 if (typeof msg.payload !== "boolean") {
-                    node.status({ fill: "red", shape: "ring", text: "invalid reset" });
+                    utils.setStatusError(node, "invalid reset");
                     if (done) done();
                     return;
                 }
                 if (msg.payload === true) {
                     node.inputs = Array(node.slots).fill(0);
                     lastSum = null;
-                    node.status({ fill: "green", shape: "dot", text: "state reset" });
+                    utils.setStatusOK(node, "state reset");
                     if (done) done();
                     return;
                 }
             } else if (msg.context === "slots") {
                 let newSlots = parseInt(msg.payload);
                 if (isNaN(newSlots) || newSlots < 1) {
-                    node.status({ fill: "red", shape: "ring", text: "invalid slots" });
+                    utils.setStatusError(node, "invalid slots");
                     if (done) done();
                     return;
                 }
                 node.slots = newSlots;
                 node.inputs = Array(newSlots).fill(0);
                 lastSum = null;
-                node.status({ fill: "green", shape: "dot", text: `slots: ${node.slots}` });
+                utils.setStatusOK(node, `slots: ${node.slots}`);
                 if (done) done();
                 return;
             } else if (msg.context.startsWith("in")) {
                 let slotIndex = parseInt(msg.context.slice(2)) - 1;
                 if (isNaN(slotIndex) || slotIndex < 0 || slotIndex >= node.slots) {
-                    node.status({ fill: "red", shape: "ring", text: `invalid input slot ${msg.context}` });
+                    utils.setStatusError(node, `invalid input slot ${msg.context}`);
                     if (done) done();
                     return;
                 }
                 let newValue = parseFloat(msg.payload);
                 if (isNaN(newValue)) {
-                    node.status({ fill: "red", shape: "ring", text: "invalid input" });
+                    utils.setStatusError(node, "invalid input");
                     if (done) done();
                     return;
                 }
@@ -76,13 +78,18 @@ module.exports = function(RED) {
                 // Calculate sum
                 const sum = node.inputs.reduce((acc, val) => acc + val, 0);
                 const isUnchanged = sum === lastSum;
-                node.status({ fill: "blue", shape: isUnchanged ? "ring" : "dot", text: `${msg.context}: ${newValue.toFixed(2)}, sum: ${sum.toFixed(2)}` });
+                const statusText = `${msg.context}: ${newValue.toFixed(2)}, sum: ${sum.toFixed(2)}`;
+                if (isUnchanged) {
+                    utils.setStatusUnchanged(node, statusText);
+                } else {
+                    utils.setStatusChanged(node, statusText);
+                }
                 lastSum = sum;
                 send({ payload: sum });
                 if (done) done();
                 return;
             } else {
-                node.status({ fill: "yellow", shape: "ring", text: "unknown context" });
+                utils.setStatusWarn(node, "unknown context");
                 if (done) done();
                 return;
             }

package/nodes/alarm-collector.html

@@ -0,0 +1,260 @@
+<script type="text/html" data-template-name="alarm-collector">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Node Name</label>
+        <input type="text" id="node-input-name" placeholder="e.g., Temperature High">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-alarmConfig"><i class="fa fa-cog"></i> Alarm Registry</label>
+        <input type="text" id="node-input-alarmConfig">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-sourceNode"><i class="fa fa-link"></i> Data Source</label>
+        <input type="text" id="node-input-sourceNode">
+        <input type="hidden" id="node-input-sourceNodeType">
+    </div>
+
+    <div class="form-row" id="input-field-row" style="display: none;">
+        <label for="node-input-inputField"><i class="fa fa-folder-open"></i> Input Property</label>
+        <input type="text" id="node-input-inputField" placeholder="payload">
+        <input type="hidden" id="node-input-inputFieldType">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-inputMode"><i class="fa fa-sliders"></i> Input Mode</label>
+        <select id="node-input-inputMode">
+            <option value="boolean">Boolean Trigger</option>
+            <option value="value">Numeric Threshold</option>
+        </select>
+    </div>
+
+    <!-- Boolean mode options (hidden by default) -->
+    <div id="boolean-options" style="display: none;">
+        <div class="form-row">
+            <label for="node-input-alarmWhenTrue"><i class="fa fa-check"></i> Alarm When</label>
+            <select id="node-input-alarmWhenTrue">
+                <option value="true">True</option>
+                <option value="false">False</option>
+            </select>
+        </div>
+    </div>
+
+    <!-- Value mode options (hidden by default) -->
+    <div id="value-options" style="display: none;">
+        <div class="form-row">
+            <label for="node-input-highThreshold"><i class="fa fa-arrow-up"></i> High Threshold</label>
+            <input type="number" id="node-input-highThreshold" placeholder="85" step="0.1">
+        </div>
+        <div class="form-row">
+            <label for="node-input-lowThreshold"><i class="fa fa-arrow-down"></i> Low Threshold</label>
+            <input type="number" id="node-input-lowThreshold" placeholder="68" step="0.1">
+        </div>
+        <div class="form-row">
+            <label for="node-input-compareMode"><i class="fa fa-code-branch"></i> Compare Mode</label>
+            <select id="node-input-compareMode">
+                <option value="either">Either (High OR Low)</option>
+                <option value="high-only">High Only</option>
+                <option value="low-only">Low Only</option>
+            </select>
+        </div>
+        <div class="form-row">
+            <label for="node-input-hysteresisMagnitude"><i class="fa fa-arrows-h"></i> Hysteresis Magnitude</label>
+            <input type="number" id="node-input-hysteresisMagnitude" placeholder="2" step="0.1" min="0">
+        </div>
+    </div>
+
+    <!-- Shared hysteresis time option -->
+    <div class="form-row">
+        <label for="node-input-hysteresisTime"><i class="fa fa-hourglass-start"></i> Hysteresis Time</label>
+        <input type="number" id="node-input-hysteresisTime" placeholder="500" step="50" min="0">
+    </div>
+
+    <!-- Alarm Message Properties -->
+    <hr style="margin: 15px 0;">
+
+    <div class="form-row">
+        <label for="node-input-priority"><i class="fa fa-exclamation-triangle"></i> Priority</label>
+        <select id="node-input-priority">
+            <option value="urgent">Urgent</option>
+            <option value="high">High</option>
+            <option value="normal">Normal</option>
+            <option value="low">Low</option>
+        </select>
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-topic"><i class="fa fa-folder-open"></i> Topic</label>
+        <input type="text" id="node-input-topic" placeholder="Alarms_HVAC">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-title"><i class="fa fa-font"></i> Title</label>
+        <input type="text" id="node-input-title" placeholder="Temperature Out of Range">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-message"><i class="fa fa-comment"></i> Message</label>
+        <input type="text" id="node-input-message" placeholder="Zone exceeds setpoint">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-tags"><i class="fa fa-tags"></i> Tags</label>
+        <input type="text" id="node-input-tags" placeholder="hvac,temperature,building_a">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-units"><i class="fa fa-thermometer"></i> Units</label>
+        <input type="text" id="node-input-units" placeholder="°F">
+    </div>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType("alarm-collector", {
+        category: "bldgblocks alarms",
+        color: "#800020",
+        defaults: {
+            name: { value: "" },
+            alarmConfig: { value: null, type: "alarm-config" },
+            sourceNode: { value: "" },
+            sourceNodeType: { value: "wired" },
+            inputField: { value: "payload" },
+            inputFieldType: { value: "msg" },
+            inputMode: { value: "value", required: true },
+            alarmWhenTrue: { value: true },
+            highThreshold: { value: 85 },
+            lowThreshold: { value: 68 },
+            compareMode: { value: "either" },
+            hysteresisTime: { value: 500 },
+            hysteresisMagnitude: { value: 2 },
+            priority: { value: "high" },
+            topic: { value: "Alarms_Default" },
+            title: { value: "Alarm" },
+            message: { value: "Condition triggered" },
+            tags: { value: "" },
+            units: { value: "°F" }
+        },
+        inputs: 1,
+        outputs: 1,
+        inputLabels: ["input"],
+        outputLabels: ["alarm"],
+        icon: "font-awesome/fa-bell-o",
+        paletteLabel: "alarm collector",
+        label: function() {
+            return this.name || "alarm collector";
+        },
+        oneditprepare: function() {
+            const node = this;
+
+            // Build searchable list of global-setter nodes
+            var candidateNodes = [];
+            RED.nodes.eachNode(function(n) {
+                if (n.type === 'global-setter') {
+                    let displayPath = n.path || "No Path";
+                    if (displayPath.startsWith("#") && displayPath.includes(":")) {
+                        displayPath = displayPath.substring(displayPath.indexOf(":") + 1);
+                    }
+                    candidateNodes.push({
+                        value: n.id,
+                        label: displayPath + (n.name ? ` (${n.name})` : ""),
+                        path: displayPath
+                    });
+                }
+            });
+            candidateNodes.sort((a, b) => a.label.localeCompare(b.label));
+
+            // Setup typedInput: "wired" mode or "setter" searchable list
+            $("#node-input-sourceNode").typedInput({
+                types: [
+                    {
+                        value: "wired",
+                        label: "wired input",
+                        hasValue: false,
+                        icon: "fa fa-arrow-right"
+                    },
+                    {
+                        value: "setter",
+                        icon: "fa fa-crosshairs",
+                        label: "global variable",
+                        options: candidateNodes
+                    }
+                ],
+                typeField: "#node-input-sourceNodeType"
+            }).typedInput("type", node.sourceNodeType || "wired").typedInput("value", node.sourceNode || "");
+
+            // Show/hide Input Field based on sourceNodeType
+            const updateInputFieldDisplay = () => {
+                let sourceType = $("#node-input-sourceNode").typedInput("type");
+                $("#input-field-row").toggle(sourceType === "wired");
+            };
+
+            $("#node-input-sourceNode").on("change", updateInputFieldDisplay);
+            updateInputFieldDisplay();
+
+            // Setup inputField typedInput with only msg type
+            $("#node-input-inputField").typedInput({
+                types: ["msg"],
+                typeField: "#node-input-inputFieldType"
+            }).typedInput("type", node.inputFieldType || "msg").typedInput("value", node.inputField || "payload");
+
+            // Show/hide sections based on inputMode
+            const updateDisplay = () => {
+                let mode = $("#node-input-inputMode").val();
+                $("#boolean-options").toggle(mode === "boolean");
+                $("#value-options").toggle(mode === "value");
+            };
+
+            $("#node-input-inputMode").on("change", updateDisplay);
+            updateDisplay();
+        }
+    });
+</script>
+
+<script type="text/markdown" data-help-name="alarm-collector">
+Monitors a condition and emits alarm events on state transitions.
+
+### Inputs
+- **payload** (number | boolean): Sensor value or trigger boolean
+
+### Outputs
+- **payload** (boolean): true=alarmed, false=cleared
+- **alarm** (object): Full alarm event data with metadata
+
+### Configuration
+
+**Alarm Registry**: Reference an alarm-config node to register this alarm. The registry displays all active alarms and allows quick navigation to collectors.
+
+**Data Source (Optional)**: Select a network-point-register to auto-subscribe, or use wired input messages.
+
+### Modes
+
+**Boolean Trigger**: msg.payload = true/false triggers alarm after hysteresis time
+
+**Numeric Threshold**: msg.payload = number, evaluated against high/low thresholds with time + magnitude hysteresis
+
+### Hysteresis
+
+**Time-based**: Condition must persist for N milliseconds before triggering alarm or clearing it
+- Prevents false alarms from sensor noise
+- Configurable delay (default 500ms)
+
+**Magnitude-based** (numeric mode only): Additional deadband before clearing alarm
+- Requires sensor to move away from threshold to prevent chatter
+- Example: highThreshold=85, magnitude=2 requires cool to 83°F to clear (not 84°F)
+
+### Event Emission
+
+Emits `bldgblocks:alarms:state-change` event only on **state transitions** (false→true or true→false)
+- Registers/updates alarm in the registry with current status
+- Service listens to these events and relays downstream
+- Can be wired directly to notification/storage nodes
+
+### Status
+- **Green dot**: No alarm, condition not met
+- **Yellow ring**: Condition met, waiting for hysteresis timer to expire
+- **Red ring**: Alarm active (condition has persisted past hysteresis window)
+
+### References
+- Pair with [alarm-service] for event relay
+- Route output to [ntfy], [InfluxDB], [Slack], etc. for notifications and storage
+</script>