@bldgblocks/node-red-contrib-control 0.1.32 → 0.1.33

package/nodes/history-collector.js

@@ -0,0 +1,150 @@
+module.exports = function(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 || '';
+        const node = this;
+
+        // Parse tags into key-value object
+        function parseTags(tagsString) {
+            if (!tagsString) return {};
+            const tags = {};
+            const pairs = tagsString.split(',').map(t => t.trim());
+            tags["historyGroup"] = node.historyConfig.name;
+            pairs.forEach((pair, index) => {
+                if (pair.includes('=') || pair.includes(':')) {
+                    const [key, value] = pair.includes('=') ? pair.split('=') : pair.split(':');
+                    if (key && value) tags[key.trim()] = value.trim();
+                } else {
+                    tags[`tag${index}`] = pair;
+                }
+            });
+            return tags;
+        }
+
+        node.on('input', function(msg) {
+            // Guard against invalid message
+            if (!msg) {
+                node.status({ fill: "red", shape: "ring", text: "invalid message" });
+                node.error('Invalid message received');
+                return;
+            }
+
+            // Validate configuration
+            if (!node.historyConfig) {
+                node.status({ fill: "red", shape: "ring", text: "missing history config" });
+                node.error('Missing history configuration', msg);
+                return;
+            }
+            if (!node.seriesName) {
+                node.status({ fill: "red", shape: "ring", text: "missing series name" });
+                node.error('Missing series name', msg);
+                return;
+            }
+            if (!node.historyConfig.name) {
+                node.status({ fill: "red", shape: "ring", text: "missing bucket name" });
+                node.error('Missing bucket name in history configuration', msg);
+                return;
+            }
+
+            // Validate payload
+            let payloadValue = msg.payload;
+            let formattedValue;
+            if (typeof payloadValue === 'number') {
+                formattedValue = isNaN(payloadValue) ? null : payloadValue;
+            } else if (typeof payloadValue === 'boolean') {
+                formattedValue = payloadValue;
+            } else if (typeof payloadValue === 'string') {
+                formattedValue = payloadValue;
+                if (payloadValue.endsWith('i') && !isNaN(parseInt(payloadValue))) {
+                    formattedValue = parseInt(payloadValue); // Handle InfluxDB integer format
+                }
+            } else {
+                node.status({ fill: "red", shape: "ring", text: "invalid payload" });
+                node.warn(`Invalid payload type: ${typeof payloadValue}`);
+                return;
+            }
+
+            if (formattedValue === null) {
+                node.status({ fill: "red", shape: "ring", text: "invalid payload" });
+                node.warn(`Invalid payload value: ${msg.payload}`);
+                return;
+            }
+
+            // Construct line protocol
+            const escapedMeasurementName = node.seriesName.replace(/[, =]/g, '\\$&');
+            const msNow = Date.now();
+            const timestamp = msNow * 1e6;
+            const tagsObj = parseTags(node.tags);
+            const tagsString = Object.entries(tagsObj)
+                .map(([k, v]) => `${k.replace(/[, =]/g, '\\$&')}=${v.replace(/[, =]/g, '\\$&')}`)
+                .join(',');
+            const valueString = typeof formattedValue === 'string' ? `"${formattedValue}"` : formattedValue;
+            const line = `${escapedMeasurementName}${tagsString ? ',' + tagsString : ''} value=${valueString} ${timestamp}`;
+
+            // Set initial status
+            node.status({ fill: "green", shape: "dot", text: "configuration received" });
+
+            // Handle storage type
+            if (node.storageType === 'memory') {
+                const contextKey = `history_data_${node.historyConfig.name}`;
+                let bucketData = node.context().global.get(contextKey) || [];
+                bucketData.push(line);
+
+                const maxMemoryBytes = (node.historyConfig.maxMemoryMb || 10) * 1024 * 1024;
+                let totalSize = Buffer.byteLength(JSON.stringify(bucketData), 'utf8');
+                while (totalSize > maxMemoryBytes && bucketData.length > 0) {
+                    bucketData.shift();
+                    totalSize = Buffer.byteLength(JSON.stringify(bucketData), 'utf8');
+                }
+
+                node.context().global.set(contextKey, bucketData);
+                node.status({ fill: "blue", shape: "dot", text: `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}` });
+            } else if (node.storageType === 'object') {
+                msg.measurement = escapedMeasurementName;
+                msg.payload = {
+                    measurement: escapedMeasurementName,
+                    tags: Object.entries(tagsObj).map(([k, v]) => `${k}=${v}`),
+                    value: formattedValue,
+                    timestamp: timestamp
+                };
+                node.send(msg);
+                node.status({ fill: "blue", shape: "dot", text: `sent: ${valueString}` });
+            } else if (node.storageType === 'objectArray') {
+                msg.measurement = escapedMeasurementName;
+                msg.timestamp = timestamp;
+                msg.payload = [
+                    { 
+                        value: formattedValue 
+                    },
+                    tagsObj
+                ]
+                node.send(msg);
+                node.status({ fill: "blue", shape: "dot", text: `sent: ${valueString}` });
+            } else if (node.storageType === 'batchObject') {
+                msg.payload = {
+                    measurement: escapedMeasurementName,
+                    timestamp: timestamp,
+                    fields: { 
+                        value: formattedValue 
+                    },
+                    tags: tagsObj
+                }
+                node.send(msg);
+                node.status({ fill: "blue", shape: "dot", text: `sent: ${valueString}` });
+            }
+        });
+
+        node.on("close", function(done) {
+            done();
+        });
+    }
+    RED.nodes.registerType("history-collector", HistoryCollectorNode);
+};

package/nodes/history-config.html

@@ -0,0 +1,236 @@
+<script type="text/html" data-template-name="history-config">
+    <div class="form-row">
+        <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-config-input-name" placeholder="History Config">
+    </div>
+
+    <div class="form-row">
+        <label><i class="fa fa-tags"></i> Tags</label>
+        <div style="margin-top: 10px;">
+            <table id="node-config-tags-table" style="width:100%;">
+                <thead>
+                    <tr>
+                        <th>Key</th>
+                        <th>Value</th>
+                        <th></th>
+                    </tr>
+                </thead>
+                <tbody></tbody>
+            </table>
+            <button id="node-config-add-tag" type="button" style="margin-top: 10px;">Add Tag</button>
+        </div>
+    </div>
+
+    <div class="form-row">
+        <label><i class="fa fa-list"></i> Series Configurations</label>
+        <div style="margin-top: 10px;">
+            <table id="node-config-series-table" style="width:100%;">
+                <thead>
+                    <tr>
+                        <th>Series Name</th>
+                        <th>Units</th>
+                        <th></th>
+                    </tr>
+                </thead>
+                <tbody></tbody>
+            </table>
+            <button id="node-config-add-series" type="button" style="margin-top: 10px;">Add Series</button>
+        </div>
+    </div>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('history-config', {
+        category: 'config',
+        defaults: {
+            series: { value: [], required: true },
+            name: { value: "default", required: true },
+            tags: { value: [], required: true }
+        },
+        label: function() {
+            return this.name || "History Config";
+        },
+        paletteLabel: "History Config",
+        oneditprepare: function() {
+            const node = this;
+            const tableBody = $("#node-config-series-table tbody");
+            const tagsTableBody = $("#node-config-tags-table tbody");
+            const addTagButton = $("#node-config-add-tag");
+            const nameInput = $("#node-config-input-name");
+            node.tags = node.tags || [];
+            node.series = node.series || [];
+
+            // --- Naming Logic ---
+            function sanitizeName(input, fallback) {
+                const safeInput = (input || "").toString(); 
+                const cleaned = safeInput.trim().replace(/[^a-zA-Z0-9_]/g, '_');
+                return cleaned || fallback;
+            }
+
+            function handleNameInput() {
+                const cleanName = sanitizeName(nameInput.val());
+                nameInput.val(cleanName);
+            }
+
+            nameInput.val(sanitizeName(node.name));
+            nameInput.on("change", function() {
+                const cleanName = sanitizeName(nameInput.val());
+                nameInput.val(cleanName);
+            });
+
+            // --- Tags Table Logic ---
+            
+            // Helper to ensure tags are always tag0, tag1, tag2...
+            function renumberTags() {
+                tagsTableBody.find("tr").each(function(index) {
+                    $(this).find(".node-config-tag-label").text("tag" + index);
+                });
+            }
+
+            function addTagRow(data = {}) {
+                // Determine label based on current row count (though renumberTags fixes it anyway)
+                const currentIndex = tagsTableBody.find("tr").length;
+                
+                const row = $(`
+                    <tr>
+                        <td style="vertical-align: middle; text-align: center;">
+                            <span class="node-config-tag-label" style="font-weight: bold; color: #666;">tag${currentIndex}</span>
+                        </td>
+                        <td>
+                            <input type="text" class="node-config-tag-value" value="${data.tagValue || ''}" style="width: 100%;" placeholder="value" required>
+                        </td>
+                        <td>
+                            <button type="button" class="node-config-remove-tag" style="color: white; background-color: red; border-radius: 2px; border: none; padding: 2px 8px; cursor: pointer;">Remove</button>
+                        </td>
+                    </tr>
+                `);
+
+                tagsTableBody.append(row);
+                
+                row.find(".node-config-remove-tag").on("click", () => {
+                    row.remove();
+                    renumberTags();
+                });
+                
+                renumberTags(); // Ensure specific ordering
+            }
+
+            // Initialize tags table
+            (node.tags || []).forEach(addTagRow);
+            if (node.tags.length === 0) {
+                addTagRow({tagValue: "virtual"});
+                addTagRow({tagValue: "physical"});
+                addTagRow({tagValue: "input"});
+                addTagRow({tagValue: "output"});
+            }
+
+            addTagButton.on("click", () => addTagRow());
+
+            // --- Series Table Logic ---
+            
+            function addRow(data = {}) {
+                const row = $(`
+                    <tr>
+                        <td><input type="text" class="node-config-series-name" value="${data.seriesName || ''}" style="width: 100%;" required></td>
+                        <td><input type="text" class="node-config-series-units" value="${data.seriesUnits || ''}" style="width: 100%;"></td>
+                        <td><button type="button" class="node-config-remove-row" style="color: white; background-color: red; border-radius: 2px; border: none; padding: 2px 8px; cursor: pointer;">Remove</button></td>
+                    </tr>
+                `);
+
+                row.find(".node-config-series-name").on("change", function() {
+                    $(this).val(sanitizeName($(this).val(), ""));
+                });
+
+                tableBody.append(row);
+                row.find(".node-config-remove-row").on("click", () => row.remove());
+                row.find(".node-config-remove-row").hover(
+                    function() { $(this).css("background-color", "#cc0000"); },
+                    function() { $(this).css("background-color", "red"); }
+                );
+            }
+
+            (node.series || []).forEach(addRow);
+            if (node.series.length === 0) {
+                addRow({seriesName: "OutsideTemp", seriesUnits: "°F"});
+            }
+
+            $("#node-config-add-series").on("click", () => addRow());
+        },
+        oneditsave: function() {            
+            function cleanSaveStr(str) {
+                return (str || "").toString().trim().replace(/[^a-zA-Z0-9_]/g, '_');
+            }
+
+            let hasTagError = false;
+            // Save Tags
+            const tagsTableBody = $("#node-config-tags-table tbody");
+            const tags = [];
+            
+            tagsTableBody.find("tr").each(function(index) {
+                const tagName = "tag" + index; 
+                const tagValue = $(this).find(".node-config-tag-value").val().trim();
+                
+                if (!tagValue) {
+                    RED.notify(`Tag Value is required for ${tagName}`, "error");
+                    hasTagError = true;
+                    return false; // Break the loop
+                }
+
+                tags.push({
+                    tagName: tagName,
+                    tagValue: tagValue
+                });
+            });
+
+            // Stop save if tags are invalid
+            if (hasTagError) {
+                throw new Error("Tag validation failed");
+            }
+
+            this.tags = tags;
+
+            // Save Series
+            const tableBody = $("#node-config-series-table tbody");
+            const series = [];
+            const seriesNames = new Set();
+
+            let hasError = false;
+            tableBody.find("tr").each(function() {
+                const rawName = $(this).find(".node-config-series-name").val();
+                const seriesName = cleanSaveStr(rawName);
+
+                if (!seriesName) {
+                    RED.notify("Series Name is required for all series", "error");
+                    hasError = true;
+                    return false;
+                }
+                if (seriesNames.has(seriesName)) {
+                    RED.notify(`Duplicate Series Name: ${seriesName}`, "error");
+                    hasError = true;
+                    return false;
+                }
+                seriesNames.add(seriesName);
+                series.push({
+                    seriesName: seriesName,
+                    seriesUnits: $(this).find(".node-config-series-units").val(),
+                });
+            });
+
+            if (hasError) {
+                throw new Error("Validation failed");
+            }
+            if (series.length === 0) {
+                RED.notify("At least one valid series is required", "error");
+                throw new Error("No valid series");
+            }
+            this.series = series;
+            this.name = cleanSaveStr($("#node-config-input-name").val()) || 'default';
+        }
+    });
+</script>
+
+<script type="text/markdown" data-help-name="history-config">
+Store configuration for history series selections.
+
+
+</script>

package/nodes/history-config.js

@@ -0,0 +1,8 @@
+module.exports = function(RED) {
+    function HistoryConfigNode(n) {
+        RED.nodes.createNode(this, n);
+        this.series = n.series || [];
+        this.name = n.name ? n.name.replace(/[^a-zA-Z0-9_]/g, '_') : 'default';
+    }
+    RED.nodes.registerType("history-config", HistoryConfigNode);
+};

package/nodes/hysteresis-block.html

@@ -30,7 +30,7 @@
 <!-- JavaScript Section: Registers the node and handles editor logic -->
 <script type="text/javascript">
     RED.nodes.registerType("hysteresis-block", {
-    category: "control",
+    category: "bldgblocks control",
     color: "#301934",
     defaults: {
         name: { value: "" },

package/nodes/interpolate-block.html

@@ -11,7 +11,7 @@
 
 <script type="text/javascript">
     RED.nodes.registerType("interpolate-block", {
-        category: "control",
+        category: "bldgblocks control",
         color: "#301934",
         defaults: {
             name: { value: "" },

package/nodes/latch-block.html

@@ -9,7 +9,7 @@
 <!-- JavaScript Section -->
 <script type="text/javascript">
     RED.nodes.registerType("latch-block", {
-        category: "control",
+        category: "bldgblocks control",
         color: "#301934",
         defaults: {
             name: { value: "" },

package/nodes/load-sequence-block.html

@@ -49,7 +49,7 @@
 <!-- JavaScript Section: Registers the node and handles editor logic -->
 <script type="text/javascript">
     RED.nodes.registerType("load-sequence-block", {
-        category: "control",
+        category: "bldgblocks control",
         color: "#301934",
         defaults: {
             name: { value: "" },

package/nodes/max-block.html

@@ -14,7 +14,7 @@
 <!-- JavaScript Section: Registers the node and handles editor logic -->
 <script type="text/javascript">
     RED.nodes.registerType("max-block", {
-        category: "control",
+        category: "bldgblocks control",
         color: "#301934",
         defaults: {
             name: { value: "" },

package/nodes/memory-block.html

@@ -22,7 +22,7 @@
 <!-- JavaScript Section -->
 <script type="text/javascript">
     RED.nodes.registerType("memory-block", {
-        category: "control",
+        category: "bldgblocks control",
         color: "#301934",
         defaults: {
             name: { value: "" },

package/nodes/min-block.html

@@ -14,7 +14,7 @@
 <!-- JavaScript Section: Registers the node and handles editor logic -->
 <script type="text/javascript">
     RED.nodes.registerType("min-block", {
-        category: "control",
+        category: "bldgblocks control",
         color: "#301934",
         defaults: {
             name: { value: "" },

package/nodes/minmax-block.html

@@ -19,7 +19,7 @@
 <!-- JavaScript Section: Registers the node and handles editor logic -->
 <script type="text/javascript">
     RED.nodes.registerType("minmax-block", {
-        category: "control",
+        category: "bldgblocks control",
         color: "#301934",
         defaults: {
             name: { value: "" },

package/nodes/modulo-block.html

@@ -13,7 +13,7 @@
 <!-- JavaScript Section -->
 <script type="text/javascript">
     RED.nodes.registerType("modulo-block", {
-        category: "control",
+        category: "bldgblocks control",
         color: "#301934",
         defaults: {
             name: { value: "" },

package/nodes/multiply-block.html

@@ -11,7 +11,7 @@
 
 <script type="text/javascript">
     RED.nodes.registerType("multiply-block", {
-        category: "control",
+        category: "bldgblocks control",
         color: "#301934",
         defaults: {
             name: { value: "" },

package/nodes/negate-block.html

@@ -7,7 +7,7 @@
 
 <script type="text/javascript">
     RED.nodes.registerType("negate-block", {
-        category: "control",
+        category: "bldgblocks control",
         color: "#301934",
         defaults: {
             name: { value: "" }

package/nodes/network-point-registry.html

@@ -0,0 +1,86 @@
+<script type="text/html" data-template-name="network-point-registry">
+    <div class="form-row">
+        <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-config-input-name" placeholder="Main Registry">
+    </div>
+    <div class="form-tips">
+        <p><b>Point Registry</b></p>
+        <p>This node maintains the mapping between Network Point IDs (integers) and Global Variables.</p>
+    </div>
+
+    <div class="form-row">
+        <label><i class="fa fa-list-ul"></i> Points</label>
+        <div id="node-input-point-list-div"
+             style="
+                 border:1px solid #ccc;
+                 height:200px;          /* set a fixed height */
+                 overflow-y:auto;       /* enable vertical scrolling */
+                 padding:5px;
+                 box-sizing:border-box;">
+            <!-- The list will be injected by the JavaScript below -->
+            <ul id="node-input-point-list" style="margin:0;padding-left:1.2em;"></ul>
+        </div>
+    </div>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType('network-point-registry', {
+        category: 'config',
+        defaults: {
+            name: { value: "" }
+        },
+        label: function() {
+            return this.name || "Point Registry";
+        },
+        oneditprepare: function() {
+            const node = this;
+            const $list = $("#node-input-point-list");
+
+            function loadPoints() {
+                $.getJSON(`/network-point-registry/list/${node.id}`, function(data) {
+                    $list.empty();
+                    if (!data.length) return $list.append('<li>No points defined</li>');
+
+                    
+                data.sort((a, b) => parseInt(a.id, 10) - parseInt(b.id, 10));
+
+                data.forEach(pt => {
+                    const li = $('<li>').css({ display:'flex', alignItems:'center' });
+
+                    // Text part: ID + path
+                    const txt = $('<span>')
+                        .text(`ID ${pt.id}: ${pt.path ?? 'not set'}`)
+                        .css({ flexGrow:1 });          // push button to the right
+
+                    // Button part
+                    const btn = $('<button type="button" class="editor-button">')
+                        .attr('title','Find node')
+                        .html('<i class="fa fa-search"></i>')
+                        .on('click', function (e) {
+                            e.stopPropagation();
+
+                            RED.view.reveal(pt.nodeId);
+                        });
+
+                    li.append(txt, btn);
+                    $list.append(li);
+                });
+                }).fail(function() {
+                    $list.html('<li style="color:red;">Could not load points</li>');
+                });
+            }
+
+            loadPoints();
+        }
+    });
+</script>
+
+<script type="text/markdown" data-help-name="network-point-registry">
+Central database mapping Point IDs to Global Variables.
+
+### Details
+
+**API for Developers:**
+* `register(id, meta)`: Claim an ID.
+* `lookup(id)`: Find the path/store for an ID.
+</script>