@bldgblocks/node-red-contrib-control 0.1.27 → 0.1.28

package/nodes/changeover-block.html

@@ -5,10 +5,8 @@
     </div>
     <div class="form-row">
         <label for="node-input-algorithm" title="Control algorithm type"><i class="fa fa-cog"></i> Algorithm</label>
-        <select id="node-input-algorithm">
-            <option value="single">Single Setpoint</option>
-            <option value="split">Split Setpoints</option>
-        </select>
+        <input type="text" id="node-input-algorithm" class="node-input-typed" placeholder="single">
+        <input type="hidden" id="node-input-algorithmType">
     </div>
     <div class="form-row single-only">
         <label for="node-input-setpoint" title="Target temperature setpoint (number from num, msg, flow, or global)"><i class="fa fa-thermometer-half"></i> Setpoint</label>
@@ -50,6 +48,18 @@
             Invalid
         </div>
     </div>
+
+    <div class="form-row specified-only" style="display: none;">
+        <label for="node-input-coolingOn" title="Temperature to turn cooling on (number from num, msg, flow, or global)"><i class="fa fa-snowflake-o"></i> Cooling On</label>
+        <input type="text" id="node-input-coolingOn" placeholder="74">
+        <input type="hidden" id="node-input-coolingOnType">
+    </div>
+    <div class="form-row specified-only" style="display: none;">
+        <label for="node-input-heatingOn" title="Temperature to turn heating on (number from num, msg, flow, or global)"><i class="fa fa-fire"></i> Heating On</label>
+        <input type="text" id="node-input-heatingOn" placeholder="66">
+        <input type="hidden" id="node-input-heatingOnType">
+    </div>
+
     <div class="form-row">
         <label for="node-input-swapTime" title="Minimum time before mode change (seconds, minimum 60, from num, msg, flow, or global)"><i class="fa fa-clock-o"></i> Swap Time</label>
         <input type="text" id="node-input-swapTime" class="node-input-typed" placeholder="300">
@@ -76,11 +86,8 @@
     </div>
     <div class="form-row">
         <label for="node-input-operationMode" title="Operation mode"><i class="fa fa-cogs"></i> Operation Mode</label>
-        <select id="node-input-operationMode">
-            <option value="auto">Auto</option>
-            <option value="heat">Heat</option>
-            <option value="cool">Cool</option>
-        </select>
+        <input type="text" id="node-input-operationMode" placeholder="auto">
+        <input type="hidden" id="node-input-operationModeType">
     </div>
 </script>
 
@@ -91,6 +98,7 @@
         defaults: {
             name: { value: "" },
             algorithm: { value: "single" },
+            algorithmType: { value: "dropdown" },
             setpoint: { value: "70" },
             setpointType: { value: "num" },
             deadband: { value: "2" },
@@ -98,6 +106,10 @@
             heatingSetpointType: { value: "num" },
             coolingSetpoint: { value: "74" },
             coolingSetpointType: { value: "num" },
+            coolingOn: { value: "74" },
+            coolingOnType: { value: "num" },
+            heatingOn: { value: "66" },
+            heatingOnType: { value: "num" },
             extent: { value: "1" },
             swapTime: { value: "300" },
             swapTimeType: { value: "num" },
@@ -106,7 +118,8 @@
             maxTempSetpoint: { value: "90" },
             maxTempSetpointType: { value: "num"},
             initWindow: { value: "10" },
-            operationMode: { value: "auto" }
+            operationMode: { value: "auto" },
+            operationModeType: { value: "dropdown" },
         },
         inputs: 1,
         outputs: 1,
@@ -122,9 +135,37 @@
             const $algorithm = $("#node-input-algorithm");
             const $singleFields = $(".single-only");
             const $splitFields = $(".split-only");
+            const $specifiedFields = $(".specified-only");
 
             try {
                 // Initialize typed inputs
+                
+                $("#node-input-operationMode").typedInput({
+                    default: "dropdown",
+                    types: [{
+                        value: "dropdown",
+                        options: [
+                            { value: "auto", label: "Auto"},
+                            { value: "heat", label: "Heat"},
+                            { value: "cool", label: "Cool"},
+                        ]
+                    }, "msg", "flow", "global"],
+                    typeField: "#node-input-operationModeType"
+                }).typedInput("type", node.operationModeType).typedInput("value", node.operationMode);
+                
+                $("#node-input-algorithm").typedInput({
+                    default: "dropdown",
+                    types: [{
+                        value: "dropdown",
+                        options: [
+                            { value: "single", label: "Single"},
+                            { value: "split", label: "Split"},
+                            { value: "specified", label: "Specified"},
+                        ]
+                    }, "msg", "flow", "global"],
+                    typeField: "#node-input-algorithmType"
+                }).typedInput("type", node.algorithmType).typedInput("value", node.algorithm);
+
                 $("#node-input-setpoint").typedInput({
                     default: "num",
                     types: ["num", "msg", "flow", "global"],
@@ -143,6 +184,18 @@
                     typeField: "#node-input-coolingSetpointType"
                 }).typedInput("type", node.coolingSetpointType || "num").typedInput("value", node.coolingSetpoint);
 
+                $("#node-input-heatingOn").typedInput({
+                    default: "num",
+                    types: ["num", "msg", "flow", "global"],
+                    typeField: "#node-input-heatingOnType"
+                }).typedInput("type", node.heatingOnType || "num").typedInput("value", node.heatingOn);
+
+                $("#node-input-coolingOn").typedInput({
+                    default: "num",
+                    types: ["num", "msg", "flow", "global"],
+                    typeField: "#node-input-coolingOnType"
+                }).typedInput("type", node.coolingOnType || "num").typedInput("value", node.coolingOn);
+
                 $("#node-input-swapTime").typedInput({
                     default: "num",
                     types: ["num", "msg", "flow", "global"],
@@ -178,9 +231,20 @@
                     if ($algorithm.val() === "single") {
                         $singleFields.show();
                         $splitFields.hide();
-                    } else {
+                        $specifiedFields.hide();
+                    } else if ($algorithm.val() === "split") {
                         $singleFields.hide();
                         $splitFields.show();
+                        $specifiedFields.hide();
+                    } else if ($algorithm.val() === "specified") {
+                        $singleFields.hide();
+                        $splitFields.hide();
+                        $specifiedFields.show();
+                    } else {
+                        $algorithm.val("single");
+                        $singleFields.show();
+                        $splitFields.hide();
+                        $specifiedFields.hide();
                     }
                 }
 
@@ -188,7 +252,7 @@
                 toggleFields();
                 
             } catch (err) {
-                console.error("Error in changeover-block oneditprepare:", err);
+                console.error("Error in oneditprepare:", err);
             }
         }
     });

package/nodes/changeover-block.js

@@ -10,10 +10,7 @@ module.exports = function(RED) {
         // Initialize runtime state
         node.runtime = {
             name: config.name,
-            algorithm: config.algorithm,
-            operationMode: config.operationMode,
             initWindow: parseFloat(config.initWindow),
-            currentMode: (config.operationMode === "cool" ? "cooling" : "heating"),
             lastTemperature: null,
             lastModeChange: 0
         };
@@ -27,7 +24,10 @@ module.exports = function(RED) {
             node.runtime.deadband = parseFloat(RED.util.evaluateNodeProperty( config.deadband, config.deadbandType, node ));
             node.runtime.extent = parseFloat(RED.util.evaluateNodeProperty( config.extent, config.extentType, node ));
             node.runtime.minTempSetpoint = parseFloat(RED.util.evaluateNodeProperty( config.minTempSetpoint, config.minTempSetpointType, node ));
-            node.runtime.maxTempSetpoint = parseFloat(RED.util.evaluateNodeProperty( config.maxTempSetpoint, config.maxTempSetpointType, node ));            
+            node.runtime.maxTempSetpoint = parseFloat(RED.util.evaluateNodeProperty( config.maxTempSetpoint, config.maxTempSetpointType, node ));  
+            node.runtime.algorithm = RED.util.evaluateNodeProperty( config.algorithm, config.algorithmType, node );
+            node.runtime.operationMode = RED.util.evaluateNodeProperty( config.operationMode, config.operationModeType, node );
+            node.runtime.currentMode = node.runtime.operationMode === "cool" ? "cooling" : "heating";          
         } catch (err) {
             node.error(`Error evaluating properties: ${err.message}`);
             if (done) done();
@@ -74,7 +74,14 @@ module.exports = function(RED) {
                 }
                 if (utils.requiresEvaluation(config.maxTempSetpointType)) {
                     node.runtime.maxTempSetpoint = parseFloat(RED.util.evaluateNodeProperty( config.maxTempSetpoint, config.maxTempSetpointType, node, msg )); 
-                }             
+                }
+                if (utils.requiresEvaluation(config.algorithmType)) {
+                    node.runtime.algorithm = RED.util.evaluateNodeProperty( config.algorithm, config.algorithmType, node, msg );          
+                }    
+                if (utils.requiresEvaluation(config.operationModeType)) {
+                    node.runtime.operationMode = RED.util.evaluateNodeProperty( config.operationMode, config.operationModeType, node, msg );
+                    node.runtime.currentMode = node.runtime.operationMode === "cool" ? "cooling" : "heating";          
+                }
             } catch (err) {
                 node.error(`Error evaluating properties: ${err.message}`);
                 if (done) done();
@@ -277,9 +284,12 @@ module.exports = function(RED) {
                 if (node.runtime.algorithm === "single") {
                     heatingThreshold = node.runtime.setpoint - node.runtime.deadband / 2;
                     coolingThreshold = node.runtime.setpoint + node.runtime.deadband / 2;
-                } else {
+                } else if (node.runtime.algorithm === "split") {
                     heatingThreshold = node.runtime.heatingSetpoint - node.runtime.extent;
                     coolingThreshold = node.runtime.coolingSetpoint + node.runtime.extent;
+                } else if (node.runtime.algorithm === "specified") {
+                    heatingThreshold = node.runtime.heatingOn - node.runtime.extent;
+                    coolingThreshold = node.runtime.coolingOn + node.runtime.extent;
                 }
 
                 if (temp < heatingThreshold) {
@@ -311,9 +321,12 @@ module.exports = function(RED) {
                 if (node.runtime.algorithm === "single") {
                     heatingThreshold = node.runtime.setpoint - node.runtime.deadband / 2;
                     coolingThreshold = node.runtime.setpoint + node.runtime.deadband / 2;
-                } else {
+                } else if (node.runtime.algorithm === "split") {
                     heatingThreshold = node.runtime.heatingSetpoint - node.runtime.extent;
                     coolingThreshold = node.runtime.coolingSetpoint + node.runtime.extent;
+                } else if (node.runtime.algorithm === "specified") {
+                    heatingThreshold = node.runtime.heatingOn - node.runtime.extent;
+                    coolingThreshold = node.runtime.coolingOn + node.runtime.extent;
                 }
 
                 let desiredMode = node.runtime.currentMode;
@@ -352,9 +365,12 @@ module.exports = function(RED) {
             if (node.runtime.algorithm === "single") {
                 effectiveHeatingSetpoint = node.runtime.setpoint - node.runtime.deadband / 2;
                 effectiveCoolingSetpoint = node.runtime.setpoint + node.runtime.deadband / 2;
-            } else {
+            } else if (node.runtime.algorithm === "split") {
                 effectiveHeatingSetpoint = node.runtime.heatingSetpoint;
                 effectiveCoolingSetpoint = node.runtime.coolingSetpoint;
+            } else if (node.runtime.algorithm === "specified") {
+                effectiveHeatingSetpoint = node.runtime.heatingOn;
+                effectiveCoolingSetpoint = node.runtime.coolingOn;
             }
 
             return [

package/nodes/delay-block.html

@@ -70,7 +70,7 @@
                 }).typedInput("type", node.delayOffType || "num").typedInput("value", node.delayOff);
 
             } catch (err) {
-                console.error("Error in hysteresis-block oneditprepare:", err);
+                console.error("Error in oneditprepare:", err);
             }
         }
     });

package/nodes/hysteresis-block.js

@@ -84,7 +84,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 boundary calculation" });
+                node.status({ fill: "red", shape: "ring", text: "invalid limits calculation" });
                 if (done) done();
                 return;
             }

package/nodes/latch-block.html

@@ -0,0 +1,55 @@
+<!-- UI Template Section -->
+<script type="text/html" data-template-name="latch-block">
+    <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>
+</script>
+
+<!-- JavaScript Section -->
+<script type="text/javascript">
+    RED.nodes.registerType("latch-block", {
+        category: "control",
+        color: "#301934",
+        defaults: {
+            name: { value: "" },
+            state: { value: false }
+        },
+        inputs: 1,
+        outputs: 1,
+        inputLabels: ["input"],
+        outputLabels: ["output"],
+        icon: "font-awesome/fa-toggle-on",
+        paletteLabel: "latch",
+        label: function() {
+            return this.name || "latch";
+        }
+    });
+</script>
+
+<!-- Help Section -->
+<script type="text/markdown" data-help-name="latch-block">
+Latch output based on control messages.
+
+### Inputs
+: context (string) : Configuration commands (`set`, `reset`).
+: payload (boolean) : `true` to set latch, `false` to reset latch when paired with appropriate `context`.
+
+### Outputs
+: output (msg) : `msg.payload` `true` or `false` based on latch state.
+
+### Details
+Set or reset the latch state based on input messages. `msg.context` = `"set"` with `msg.payload` = `true` 
+sets the latch `true`, while `msg.context` = `"reset"` with `msg.payload` = `true` resets it to `false`.
+
+### Status
+- Green (dot): Configuration update
+- Blue (dot): State changed
+- Blue (ring): State unchanged
+- Red (ring): Error
+- Yellow (ring): Warning
+
+### References
+- [Node-RED Documentation](https://nodered.org/docs/)
+- [GitHub Repository](https://github.com/BldgBlocks/node-red-contrib-buildingblocks-control.git)
+</script>

package/nodes/latch-block.js

@@ -0,0 +1,77 @@
+module.exports = function(RED) {
+    function LatchBlockNode(config) {
+        RED.nodes.createNode(this, config);
+
+        const node = this;
+
+        // Initialize state from config
+        node.state = config.state;
+
+        // Set initial status
+        node.status({
+            fill: "green",
+            shape: "dot",
+            text: `state: ${node.state}`
+        });
+
+        node.on("input", 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" });
+                if (done) done();
+                return;
+            }
+
+            // Validate context
+            if (!msg.hasOwnProperty("context") || typeof msg.context !== "string") {
+                node.status({ fill: "red", shape: "ring", text: "missing or invalid context" });
+                if (done) done();
+                return;
+            }
+
+            // Handle context commands
+            switch (msg.context) {
+                case "set":
+                    if (node.state) {
+                        node.status({ fill: "blue", shape: "ring", text: `state: ${node.state}` });
+                    } else {
+                        if (msg.payload) {
+                            node.state = true;
+                            node.status({ fill: "blue", shape: "dot", text: `state: ${node.state}` });
+                        } else {
+                            node.status({ fill: "blue", shape: "ring", text: `state: ${node.state}` });
+                        }
+                    }
+                    // Output latch value regardless
+                    send({ payload: node.state });
+                    break;
+                case "reset":
+                    if (node.state === false) {
+                        node.status({ fill: "blue", shape: "ring", text: `state: ${node.state}` });
+                    } else {
+                        if (msg.payload) {
+                            node.state = false;
+                            node.status({ fill: "blue", shape: "dot", text: `state: ${node.state}` });
+                        } else {
+                            node.status({ fill: "blue", shape: "ring", text: `state: ${node.state}` });
+                        }
+                    }
+                    send({ payload: node.state });
+                    break;
+                default:
+                    node.status({ fill: "yellow", shape: "ring", text: "unknown context" });
+                    if (done) done("Unknown context");
+                    return;
+            }
+            if (done) done();
+        });
+
+        node.on("close", function(done) {
+            done();
+        });
+    }
+
+    RED.nodes.registerType("latch-block", LatchBlockNode);
+};

package/nodes/on-change-block.html

@@ -64,7 +64,6 @@ differs from the last output value. When `period > 0`, outputs the first message
 Supports complex payloads (objects, arrays) via deep comparison. 
 Configuration
 - `msg.context = "period"` Sets period (ms), no output.
-- `msg.context = "status"` Outputs `{ period, periodType }`.
 
 ### Status
 - Green (dot): Configuration update

package/nodes/on-change-block.js

@@ -70,16 +70,6 @@ module.exports = function(RED) {
                     if (done) done();
                     return;
                 }
-                if (msg.context === "status") {
-                    send({
-                        payload: {
-                            period: node.runtime.period,
-                            periodType: node.runtime.periodType
-                        }
-                    });
-                    if (done) done();
-                    return;
-                }
                 // Ignore unknown context
             }
 
@@ -115,7 +105,7 @@ module.exports = function(RED) {
                 node.status({
                     fill: "blue",
                     shape: "ring",
-                    text: `filtered: ${JSON.stringify(currentValue).slice(0, 20)}`
+                    text: `filtered: ${JSON.stringify(currentValue).slice(0, 20)} |`
                 });
                 if (done) done();
                 return;
@@ -139,7 +129,7 @@ module.exports = function(RED) {
                     node.status({
                         fill: "blue",
                         shape: "ring",
-                        text: `Filter period expired`
+                        text: `filtered: ${JSON.stringify(currentValue).slice(0, 20)}` // remove ' |' to indicate end of filter period
                     });
                 }, node.runtime.period);
             }