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

package/nodes/history-collector.html

@@ -11,6 +11,11 @@
         <label for="node-input-seriesName" title="Specify the measurement series name"><i class="fa fa-list"></i> Series</label>
         <input type="text" id="node-input-seriesName">
     </div>
+    <div class="form-row">
+        <label for="node-input-inputProperty" title="Source for value extraction (msg property or jsonata expression)"><i class="fa fa-folder-open"></i> Input Value</label>
+        <input type="text" id="node-input-inputProperty" placeholder="payload">
+        <input type="hidden" id="node-input-inputPropertyType">
+    </div>
     <div class="form-row">
         <label for="node-input-tags"><i class="fa fa-tags"></i> Tags</label>
         <input type="hidden" id="node-input-tags">
@@ -49,12 +54,14 @@
         defaults: {
             historyConfig: { value: "", type: "history-config", required: true },
             seriesName: { value: "", required: true },
+            inputProperty: { value: "payload" },
+            inputPropertyType: { value: "msg" },
             tags: { value: "" },
             storageType: { value: "batchObject" },
             name: { value: "" }
         },
         inputs: 1,
-        outputs: 1,
+        outputs: 0,
         icon: "file.png",
         paletteLabel: "history collector",
         label: function() {
@@ -67,6 +74,17 @@
             const tagContainer = $("#node-input-tag-container");
             const hiddenTagInput = $("#node-input-tags");
 
+            // Initialize typed input for input property (msg or jsonata)
+            try {
+                $("#node-input-inputProperty").typedInput({
+                    default: "msg",
+                    types: ["msg", "jsonata"],
+                    typeField: "#node-input-inputPropertyType"
+                }).typedInput("type", node.inputPropertyType || "msg").typedInput("value", node.inputProperty);
+            } catch (err) {
+                console.error("Error initializing inputProperty typedInput:", err);
+            }
+
             // Initialize empty typedInputs first
             seriesInput.typedInput({
                 types: [{ value: "series", options: [] }]
@@ -147,7 +165,10 @@
         },
         oneditsave: function() {
             const seriesInput = $("#node-input-seriesName");
+            const inputProperty = $("#node-input-inputProperty");
             this.seriesName = seriesInput.typedInput('value');
+            this.inputProperty = inputProperty.typedInput('value');
+            this.inputPropertyType = inputProperty.typedInput('type');
             this.storageType = $("#node-input-storageType").val();
             // tags are already in the hidden input thanks to the checkbox change handler
         }
@@ -275,6 +296,13 @@ The node supports five `storageType` options, each producing a unique output for
 - Timestamp: Generated as nanoseconds (ms * 1e6) for InfluxDB v2 precision.
 - Error Handling: Invalid configurations or payloads trigger warnings and status updates (red ring).
 
+### Status
+- Green (dot): Configuration update
+- Blue (dot): Data collected successfully
+- Blue (ring): No state change
+- Red (ring): Configuration error or invalid payload
+- Yellow (ring): Warning (validation issue)
+
 ### References
 - [Node-RED Documentation](https://nodered.org/docs/)
 - [GitHub Repository](https://github.com/BldgBlocks/node-red-contrib-buildingblocks-control)

package/nodes/history-collector.js

@@ -1,10 +1,14 @@
 module.exports = function(RED) {
+    const utils = require("./utils")(RED);
+
     function HistoryCollectorNode(config) {
         RED.nodes.createNode(this, config);
         this.historyConfig = RED.nodes.getNode(config.historyConfig);
         this.seriesName = config.seriesName;
         this.storageType = config.storageType || 'memory';
         this.tags = config.tags || '';
+        this.inputProperty = config.inputProperty || "payload";
+        this.inputPropertyType = config.inputPropertyType || "msg";
         const node = this;
 
         // Parse tags into key-value object
@@ -24,33 +28,48 @@ module.exports = function(RED) {
             return tags;
         }
 
-        node.on('input', function(msg) {
+        node.on('input', async function(msg, send, done) {
+            send = send || function() { node.send.apply(node, arguments); };
+
             // Guard against invalid message
             if (!msg) {
-                node.status({ fill: "red", shape: "ring", text: "invalid message" });
+                utils.setStatusError(node, "invalid message");
                 node.error('Invalid message received');
+                if (done) done();
                 return;
             }
 
             // Validate configuration
             if (!node.historyConfig) {
-                node.status({ fill: "red", shape: "ring", text: "missing history config" });
+                utils.setStatusError(node, "missing history config");
                 node.error('Missing history configuration', msg);
+                if (done) done();
                 return;
             }
             if (!node.seriesName) {
-                node.status({ fill: "red", shape: "ring", text: "missing series name" });
+                utils.setStatusError(node, "missing series name");
                 node.error('Missing series name', msg);
+                if (done) done();
                 return;
             }
             if (!node.historyConfig.name) {
-                node.status({ fill: "red", shape: "ring", text: "missing bucket name" });
+                utils.setStatusError(node, "missing bucket name");
                 node.error('Missing bucket name in history configuration', msg);
+                if (done) done();
+                return;
+            }
+
+            // Evaluate input property (msg or jsonata)
+            let payloadValue;
+            try {
+                payloadValue = await utils.evaluateNodeProperty(node.inputProperty, node.inputPropertyType, node, msg);
+            } catch (err) {
+                utils.setStatusError(node, "input evaluation error");
+                if (done) done();
                 return;
             }
 
             // Validate payload
-            let payloadValue = msg.payload;
             let formattedValue;
             if (typeof payloadValue === 'number') {
                 formattedValue = isNaN(payloadValue) ? null : payloadValue;
@@ -62,14 +81,14 @@ module.exports = function(RED) {
                     formattedValue = parseInt(payloadValue); // Handle InfluxDB integer format
                 }
             } else {
-                node.status({ fill: "red", shape: "ring", text: "invalid payload" });
-                node.warn(`Invalid payload type: ${typeof payloadValue}`);
+                utils.setStatusError(node, "invalid payload");
+                if (done) done();
                 return;
             }
 
             if (formattedValue === null) {
-                node.status({ fill: "red", shape: "ring", text: "invalid payload" });
-                node.warn(`Invalid payload value: ${msg.payload}`);
+                utils.setStatusError(node, "invalid payload");
+                if (done) done();
                 return;
             }
 
@@ -85,7 +104,7 @@ module.exports = function(RED) {
             const line = `${escapedMeasurementName}${tagsString ? ',' + tagsString : ''} value=${valueString} ${timestamp}`;
 
             // Set initial status
-            node.status({ fill: "green", shape: "dot", text: "configuration received" });
+            utils.setStatusOK(node, "configuration received");
 
             // Handle storage type
             if (node.storageType === 'memory') {
@@ -101,12 +120,12 @@ module.exports = function(RED) {
                 }
 
                 node.context().global.set(contextKey, bucketData);
-                node.status({ fill: "blue", shape: "dot", text: `stored: ${valueString}` });
+                utils.setStatusChanged(node, `stored: ${valueString}`);
             } else if (node.storageType === 'lineProtocol') {
                 msg.measurement = escapedMeasurementName;
                 msg.payload = line;
                 node.send(msg);
-                node.status({ fill: "blue", shape: "dot", text: `sent: ${valueString}` });
+                utils.setStatusChanged(node, `sent: ${valueString}`);
             } else if (node.storageType === 'object') {
                 msg.measurement = escapedMeasurementName;
                 msg.payload = {
@@ -116,7 +135,7 @@ module.exports = function(RED) {
                     timestamp: timestamp
                 };
                 node.send(msg);
-                node.status({ fill: "blue", shape: "dot", text: `sent: ${valueString}` });
+                utils.setStatusChanged(node, `sent: ${valueString}`);
             } else if (node.storageType === 'objectArray') {
                 msg.measurement = escapedMeasurementName;
                 msg.timestamp = timestamp;
@@ -127,7 +146,7 @@ module.exports = function(RED) {
                     tagsObj
                 ]
                 node.send(msg);
-                node.status({ fill: "blue", shape: "dot", text: `sent: ${valueString}` });
+                utils.setStatusChanged(node, `sent: ${valueString}`);
             } else if (node.storageType === 'batchObject') {
                 msg.payload = {
                     measurement: escapedMeasurementName,
@@ -138,8 +157,10 @@ module.exports = function(RED) {
                     tags: tagsObj
                 }
                 node.send(msg);
-                node.status({ fill: "blue", shape: "dot", text: `sent: ${valueString}` });
+                utils.setStatusChanged(node, `sent: ${valueString}`);
             }
+
+            if (done) done();
         });
 
         node.on("close", function(done) {

package/nodes/history-config.html

@@ -230,7 +230,19 @@
 </script>
 
 <script type="text/markdown" data-help-name="history-config">
-Store configuration for history series selections.
+Configuration node for the History Collector. Defines storage behavior and data retention policies.
 
+### Details
 
+This node does not process messages directly. It serves as a configuration reference for one or more History Collector nodes. The properties you set here determine how data is collected, stored, and aged out of the history buffer.
+
+Configure the node in the editor panel on the right.
+
+### Status
+- Green (dot): Configuration valid
+- Red (ring): Error in configuration
+
+### References
+- [Node-RED Documentation](https://nodered.org/docs/)
+- [GitHub Repository](https://github.com/BldgBlocks/node-red-contrib-buildingblocks-control.git)
 </script>

package/nodes/history-service.html

@@ -0,0 +1,84 @@
+<script type="text/html" data-template-name="history-service">
+    <div class="form-row">
+        <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-historyConfig" title="History configuration to relay events from"><i class="fa fa-database"></i> History Config</label>
+        <input type="text" id="node-input-historyConfig">
+    </div>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType("history-service", {
+        category: "bldgblocks history",
+        color: "#b9f2ff",
+        defaults: {
+            name: { value: "" },
+            historyConfig: {
+                value: "",
+                required: true,
+                type: "history-config"
+            }
+        },
+        inputs: 0,
+        outputs: 1,
+        outputLabels: ["records"],
+        icon: "font-awesome/fa-database",
+        paletteLabel: "history-service",
+        label: function() {
+            const historyNode = RED.nodes.node(this.historyConfig);
+            const configName = historyNode ? historyNode.name : "unknown";
+            return this.name ? `${this.name} (${configName})` : `history-service (${configName})`;
+        }
+    });
+</script>
+
+<script type="text/markdown" data-help-name="history-service">
+Event relay for history collectors.
+
+### Purpose
+Receives events emitted by **history-collector** nodes and outputs them as individual records. Acts as an event-to-message bridge, allowing collectors to emit data without needing output wires.
+
+### Configuration
+- **History Config**: The history-config node to relay events from
+
+### Outputs
+: payload (object) : History record object containing:
+  - `measurement` (string): Measurement name
+  - `timestamp` (number): Nanosecond Unix timestamp
+  - `fields` (object): Values (typically `{value: number}`)
+  - `tags` (object): Metadata tags including `historyGroup`
+  - `lineProtocol` (string): Pre-formatted InfluxDB line protocol
+  - `seriesName` (string): Original series name from collector
+  - `historyConfigId` (string): Config ID
+  - `historyConfigName` (string): Config name
+
+### Details
+This node listens for events emitted by all **history-collector** nodes configured with the same history-config. Each incoming record is output immediately.
+
+**Typical wiring**:
+```
+[history-collector] ──(event)──> [history-service] ──> [join] ──> [influxdb batch]
+                                                          (batches)
+```
+
+Use the **join** node to batch records if needed:
+- Set join mode: "Custom"
+- Build: "Array"
+- Count: number of records to batch (e.g., 5000)
+- Or timeout: seconds to wait before sending partial batch
+
+This design decouples collection from storage and lets you choose batching strategy.
+
+### Status
+- Green (dot): Ready and listening
+- Blue (dot): Just relayed a record
+- Red (ring): Configuration error
+
+### References
+- [history-collector](history-collector.html) - Emits events to this service
+- [history-config](history-config.html) - Configuration node
+- [Node-RED join node](https://nodered.org/docs/nodes/core/flow/join) - For batching
+- [Node-RED Documentation](https://nodered.org/docs/)
+</script>

package/nodes/history-service.js

@@ -0,0 +1,52 @@
+module.exports = function(RED) {
+    const utils = require("./utils")(RED);
+
+    function HistoryServiceNode(config) {
+        RED.nodes.createNode(this, config);
+        this.historyConfig = RED.nodes.getNode(config.historyConfig);
+        const node = this;
+
+        // Validate configuration
+        if (!node.historyConfig) {
+            utils.setStatusError(node, "missing history config");
+            return;
+        }
+
+        // Generate matching event name based on history-config ID
+        const eventName = `bldgblocks:history:${node.historyConfig.id}`;
+
+        // Listen for events from history-collector nodes with this config
+        const eventListener = (eventData) => {
+            // Guard against invalid event data
+            if (!eventData || typeof eventData !== 'object') {
+                utils.setStatusError(node, "invalid event data");
+                node.warn("Invalid event data received");
+                return;
+            }
+
+            // Create output message with the event data as payload
+            // Preserve topic if it exists in the event data
+            const msg = { 
+                payload: eventData,
+                topic: eventData.topic
+            };
+            
+            node.send(msg);
+            
+            // Update status
+            utils.setStatusChanged(node, `relayed: ${eventData.seriesName || 'data'}`);
+        };
+
+        // Subscribe to events
+        RED.events.on(eventName, eventListener);
+        utils.setStatusOK(node, `listening on ${node.historyConfig.name}`);
+
+        node.on("close", function(done) {
+            // Unsubscribe from events on close
+            RED.events.off(eventName, eventListener);
+            done();
+        });
+    }
+
+    RED.nodes.registerType("history-service", HistoryServiceNode);
+};

package/nodes/hysteresis-block.html

@@ -4,6 +4,10 @@
         <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-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-upperLimit"><i class="fa fa-arrow-up"></i> Upper Limit (turn on)</label>
         <input type="text" id="node-input-upperLimit" placeholder="50">
@@ -34,6 +38,7 @@
     color: "#301934",
     defaults: {
         name: { value: "" },
+        inputProperty: { value: "payload" },
         upperLimit: { value: 50, required: true },
         upperLimitType: { value: "num" },
         lowerLimit: { value: 30, required: true },

package/nodes/hysteresis-block.js

@@ -5,6 +5,7 @@ module.exports = function(RED) {
         RED.nodes.createNode(this, config);
         const node = this;
         node.name = config.name;
+        node.inputProperty = config.inputProperty || "payload";
         node.state = "within";
         node.isBusy = false;
         node.upperLimit = parseFloat(config.upperLimit);
@@ -16,7 +17,7 @@ module.exports = function(RED) {
             send = send || function() { node.send.apply(node, arguments); };
 
             if (!msg) {
-                node.status({ fill: "red", shape: "ring", text: "invalid message" });
+                utils.setStatusError(node, "invalid message");
                 if (done) done();
                 return;
             }
@@ -27,7 +28,7 @@ module.exports = function(RED) {
                 // Check busy lock
                 if (node.isBusy) {
                     // Update status to let user know they are pushing too fast
-                    node.status({ fill: "yellow", shape: "ring", text: "busy - dropped msg" });
+                    utils.setStatusBusy(node, "busy - dropped msg");
                     if (done) done(); 
                     return;
                 }
@@ -107,27 +108,27 @@ module.exports = function(RED) {
                     const value = parseFloat(msg.payload);
                     if (!isNaN(value) && value >= 0) {
                         node.upperLimitThreshold = value;
-                        node.status({ fill: "green", shape: "dot", text: `upperLimitThreshold: ${value}` });
+                        utils.setStatusOK(node, `upperLimitThreshold: ${value}`);
                     }
                 } else if (msg.context === "lowerLimitThreshold") {
                     const value = parseFloat(msg.payload);
                     if (!isNaN(value) && value >= 0) {
                         node.lowerLimitThreshold = value;
-                        node.status({ fill: "green", shape: "dot", text: `lowerLimitThreshold: ${value}` });
+                        utils.setStatusOK(node, `lowerLimitThreshold: ${value}`);
                     }
                 }
                 if (done) done();
                 return;
             }
 
-            if (!msg.hasOwnProperty("payload")) {
-                node.status({ fill: "red", shape: "ring", text: "missing payload" });
-                if (done) done();
-                return;
+            let inputValue;
+            try {
+                inputValue = parseFloat(RED.util.getMessageProperty(msg, node.inputProperty));
+            } catch (err) {
+                inputValue = NaN;
             }
-            const inputValue = parseFloat(msg.payload);
             if (isNaN(inputValue)) {
-                node.status({ fill: "red", shape: "ring", text: "invalid payload" });
+                utils.setStatusError(node, "invalid input");
                 if (done) done();
                 return;
             }
@@ -140,7 +141,7 @@ module.exports = function(RED) {
 
             // Add validation to ensure numbers
             if (isNaN(upperTurnOn) || isNaN(upperTurnOff) || isNaN(lowerTurnOn) || isNaN(lowerTurnOff)) {
-                node.status({ fill: "red", shape: "ring", text: "invalid limits calculation" });
+                utils.setStatusError(node, "invalid limits calculation");
                 if (done) done();
                 return;
             }
@@ -179,11 +180,7 @@ module.exports = function(RED) {
                 { payload: newState === "below" }
             ];
 
-            node.status({
-                fill: "blue",
-                shape: "dot",
-                text: `in: ${inputValue.toFixed(2)}, state: ${newState}`
-            });
+            utils.setStatusChanged(node, `in: ${inputValue.toFixed(2)}, state: ${newState}`);
 
             node.state = newState;
             send(output);

package/nodes/interpolate-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-points" title="Default points table for interpolation (array of {x, y} objects, ≥2 points)"><i class="fa fa-table"></i> Points</label>
         <textarea id="node-input-points" placeholder='[{"x": 0, "y": 0}, {"x": 100, "y": 100}]' style="height: 100px;"></textarea>
@@ -15,6 +19,7 @@
         color: "#301934",
         defaults: {
             name: { value: "" },
+            inputProperty: { value: "payload" },
             points: {
                 value: JSON.stringify([{ x: 0, y: 0 }, { x: 100, y: 100 }], null, 2),
                 required: true,
@@ -43,11 +48,24 @@
 </script>
 
 <script type="text/markdown" data-help-name="interpolate-block">
-Linearly interpolates a numeric input using a configurable points table.
+Linearly interpolates numeric input from a configured property using a points table.
 
 ### Inputs
+: input-property (number) : Numeric value to interpolate, read from the configured Input Property.
 : context (string) : Configures points table (`"points"`).
-: payload (number | array) : Number for interpolation, or array of `{x, y}` objects for points configuration.
+: payload (array, for context) : Array of `{x, y}` objects for points configuration.
+
+### Outputs
+: payload (number) : Interpolated output value.
+
+### Properties
+: name (string) : Display name in editor.
+: inputProperty (string) : Message property to read input from (default: `payload`). Supports nested properties (e.g., `data.value`).
+: points (array) : Array of `{x, y}` objects defining the interpolation curve (minimum 2 points).
+
+### Details
+Linearly interpolates numeric input (read from the configured **Input Property**, default: `msg.payload`) using a configurable points table.
+Points can be updated dynamically via `msg.context = "points"` with an array of `{x, y}` objects in `msg.payload`.
 
 ### Outputs
 : payload (number) : Interpolated output value.