@bldgblocks/node-red-contrib-control 0.1.4

package/nodes/comment-block.html

@@ -0,0 +1,83 @@
+<script type="text/html" data-template-name="comment-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>
+    <div class="form-row">
+        <label for="node-input-comment" title="Comment shown in status when Default is selected (max 100 characters)"><i class="fa fa-comment"></i> Comment</label>
+        <input type="text" id="node-input-comment" placeholder="Enter comment (max 100 chars)" maxlength="100">
+    </div>
+    <div class="form-row">
+        <label for="node-input-statusDisplay" title="Select what to display in the node status"><i class="fa fa-eye"></i> Status Display</label>
+        <select id="node-input-statusDisplay">
+            <option value="default">Comment to status (Default)</option>
+            <option value="name">Name to status</option>
+            <option value="none">No status</option>
+        </select>
+    </div>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType("comment-block", {
+        category: "control",
+        color: "#301934",
+        defaults: {
+            name: { value: "comment" },
+            comment: { value: "No comment", validate: function(v) { return v.length < 100 } },
+            statusDisplay: { value: "default" }
+        },
+        inputs: 1,
+        outputs: 1,
+        inputLabels: ["input"],
+        outputLabels: ["output"],
+        icon: "font-awesome/fa-comment",
+        paletteLabel: "comment",
+        label: function() {
+            return this.name || this.comment || "comment";
+        },
+        oneditsave: function() {
+            // Update status immediately
+            const node = RED.nodes.getNode(this.id);
+            let status = {};
+            switch (node.statusDisplay) {
+                case "default":
+                    status = { fill: "green", shape: "dot", text: node.comment || "No comment set" };
+                    break;
+                case "name":
+                    status = { fill: "green", shape: "dot", text: node.name || "comment" };
+                    break;
+                case "none":
+                    break;
+                default:
+            }
+
+            node.status(status);
+        }
+    });
+</script>
+
+<script type="text/markdown" data-help-name="comment-block">
+Displays a configurable comment, node name, or no status persistently and on input.
+
+### Inputs
+: payload (any) : Passthrough.
+
+### Outputs
+: payload (any) : Passthrough.
+
+### Details
+Displays a status (comment, node name, or none) on node creation, editor saves, and input messages.
+
+Used for flow annotations or debugging without requiring input to trigger status.
+
+### Status
+- Green (dot): Configuration update
+- Blue (dot): State changed
+- Blue (ring): State unchanged
+- Red (ring): Error
+- Yellow: Warning
+
+### References
+- [Node-RED Documentation](https://nodered.org/docs/)
+- [GitHub Repository](https://github.com/BldgBlocks/node-red-contrib-buildingblocks-control.git)
+</script>

package/nodes/comment-block.js

@@ -0,0 +1,53 @@
+module.exports = function(RED) {
+    function CommentBlockNode(config) {
+        RED.nodes.createNode(this, config);
+        const node = this;
+
+        // Initialize properties
+        node.name = config.name;
+        node.comment = config.comment;
+        node.statusDisplay = config.statusDisplay;
+
+        // Ensure comment is within 100 characters
+        if (node.comment.length > 100) {
+            node.comment = node.comment.substring(0, 100);
+        }
+        
+        // Status helper function
+        const updateStatus = function() {
+            switch (node.statusDisplay) {
+                case "default":
+                    return { fill: "green", shape: "dot", text: node.comment || "No comment set" };
+                case "name":
+                    return { fill: "green", shape: "dot", text: node.name || "comment" };
+                case "none":
+                default:
+                    return {};
+            }
+        };
+
+        node.status(updateStatus());
+
+        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: "invalid message" });
+                if (done) done();
+                return;
+            }
+
+            node.status(updateStatus());
+
+            send(msg);
+            if (done) done();
+        });
+
+        node.on("close", function(done) {
+            done();
+        });
+    }
+
+    RED.nodes.registerType("comment-block", CommentBlockNode);
+};

package/nodes/compare-block.html

@@ -0,0 +1,64 @@
+<!-- UI Template Section: Defines the edit dialog -->
+<script type="text/html" data-template-name="compare-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>
+    <div class="form-row">
+        <label for="node-input-setpoint" title="Default setpoint value for comparison (number)"><i class="fa fa-crosshairs"></i> Setpoint</label>
+        <input type="number" id="node-input-setpoint" placeholder="50" step="any">
+    </div>
+</script>
+
+<!-- JavaScript Section: Registers the node and handles editor logic -->
+<script type="text/javascript">
+    RED.nodes.registerType("compare-block", {
+        category: "control",
+        color: "#301934",
+        defaults: {
+            name: { value: "" },
+            setpoint: { value: 50, required: true, validate: function(v) { return !isNaN(+v) && isFinite(+v); } }
+        },
+        inputs: 1,
+        outputs: 3,
+        outputLabels: ["greater than", "equal to", "less than"],
+        inputLabels: ["input"],
+        icon: "font-awesome/fa-balance-scale",
+        paletteLabel: "compare",
+        label: function() {
+            return this.name || "compare";
+        }
+    });
+</script>
+
+<!-- Help Section -->
+<script type="text/markdown" data-help-name="compare-block">
+Compares a numeric input to a setpoint, outputting three boolean signals.
+
+### Inputs
+: context (string) : Configuration commands - setpoint (`"setpoint"`). Unmatched values trigger error.
+: payload (number) : Input number to compare, or setpoint value for config.
+
+### Outputs
+: greater than (boolean) : `true` if input > setpoint, else `false`.
+: equal to (boolean) : `true` if input = setpoint, else `false`.
+: less than (boolean) : `true` if input < setpoint, else `false`.
+
+### Properties
+: setpoint (number) : Value for comparison.
+
+### Details
+Compares `msg.payload` (number) to a `setpoint` (default: 50), outputting three messages to separate ports:
+`true` for greater than, equal to, or less than the setpoint, respectively; `false` otherwise.
+
+### 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/compare-block.js

@@ -0,0 +1,84 @@
+module.exports = function(RED) {
+    function CompareBlockNode(config) {
+        RED.nodes.createNode(this, config);
+        const node = this;
+
+        node.setpoint = Number(config.setpoint);
+
+        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;
+            }
+
+            // Handle context updates
+            if (msg.hasOwnProperty("context")) {
+                if (!msg.hasOwnProperty("payload")) {
+                    node.status({ fill: "red", shape: "ring", text: "missing payload for setpoint" });
+                    if (done) done();
+                    return;
+                }
+
+                if (msg.context === "setpoint") {
+                    const setpointValue = parseFloat(msg.payload);
+                    if (!isNaN(setpointValue) && isFinite(setpointValue)) {
+                        node.setpoint = setpointValue;
+                        node.status({ fill: "green", shape: "dot", text: `setpoint: ${setpointValue.toFixed(2)}` });
+                    } else {
+                        node.status({ fill: "red", shape: "ring", text: "invalid setpoint" });
+                    }
+                    if (done) done();
+                    return;
+                } else {
+                    node.status({ fill: "yellow", shape: "ring", text: "unknown context" });
+                    if (done) done("Unknown context");
+                    return;
+                }
+            }
+
+            // Validate input
+            if (!msg.hasOwnProperty("payload")) {
+                node.status({ fill: "red", shape: "ring", text: "missing input" });
+                if (done) done();
+                return;
+            }
+
+            const inputValue = parseFloat(msg.payload);
+            if (isNaN(inputValue) || !isFinite(inputValue)) {
+                node.status({ fill: "red", shape: "ring", text: "invalid input" });
+                if (done) done();
+                return;
+            }
+
+            // Compare input to setpoint
+            const greater = inputValue > node.setpoint;
+            const equal = inputValue === node.setpoint;
+            const less = inputValue < node.setpoint;
+            const outputs = [
+                { payload: greater },
+                { payload: equal },
+                { payload: less }
+            ];
+
+            node.status({
+                fill: "blue",
+                shape: "dot",
+                text: `in: ${inputValue.toFixed(2)}, sp: ${node.setpoint.toFixed(2)}, out: [${greater}, ${equal}, ${less}]`
+            });
+            
+            send(outputs);
+
+            if (done) done();
+        });
+
+        node.on("close", function(done) {
+            done();
+        });
+    }
+
+    RED.nodes.registerType("compare-block", CompareBlockNode);
+};

package/nodes/contextual-label-block.html

@@ -0,0 +1,67 @@
+<script type="text/html" data-template-name="contextual-label-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>
+    <div class="form-row">
+        <label for="node-input-contextPropertyName" title="Context property to set (e.g., priority, clear, in1)"><i class="fa fa-key"></i> Context Property</label>
+        <input type="text" id="node-input-contextPropertyName" placeholder="e.g., priority">
+    </div>
+    <div class="form-row">
+        <label for="node-input-removeLabel" title="Remove msg.context instead of setting it"><i class="fa fa-trash"></i> Remove Context</label>
+        <input type="checkbox" id="node-input-removeLabel" style="width: auto; vertical-align: middle;">
+    </div>
+</script>
+
+<script type="text/javascript">
+RED.nodes.registerType("contextual-label-block", {
+    category: "control",
+    color: "#301934",
+    defaults: {
+        name: { value: "" },
+        contextPropertyName: { 
+            value: "in1", 
+            required: true, 
+            validate: function(v) { return v && typeof v === "string" && v.trim().length > 0; } 
+        },
+        removeLabel: { value: false }
+    },
+    inputs: 1,
+    outputs: 1,
+    inputLabels: ["input"],
+    outputLabels: ["output"],
+    icon: "font-awesome/fa-tag",
+    paletteLabel: "contextual label",
+    label: function() {
+        if (this.name) return this.name;
+        return this.removeLabel ? "remove context" : `🛈 ${this.contextPropertyName || "context"}`;
+    },
+    oneditprepare: function() {
+        $("#node-input-removeLabel").prop("checked", this.removeLabel || false);
+    }
+});
+</script>
+
+<script type="text/markdown" data-help-name="contextual-label-block">
+Sets or removes the msg.context property in a message.
+
+### Inputs
+: payload (any) : Input message payload, passed through unchanged.
+
+### Outputs
+: context (string) : Configured context property (e.g., `priority`, `clear`, `in1`) if set, or absent if removed.
+: payload (any) : Original message object with context added or deleted.
+
+### Details
+Either sets `msg.context` to a configured property (e.g., `priority`, `clear`, `in1`) or removes `msg.context` based on the `Remove Context` toggle.
+
+### Status
+- Green (dot): Configuration updates
+- Blue (dot): Outputs when input changes
+- Blue (ring): Outputs when input unchanged
+- Red (ring): Errors
+
+### References
+- [Node-RED Documentation](https://nodered.org/docs/)
+- [GitHub Repository](https://github.com/BldgBlocks/node-red-contrib-buildingblocks-control.git)
+</script>

package/nodes/contextual-label-block.js

@@ -0,0 +1,52 @@
+module.exports = function(RED) {
+    function ContextualLabelBlockNode(config) {
+        RED.nodes.createNode(this, config);
+        const node = this;
+
+        node.contextPropertyName = config.contextPropertyName || "in1";
+        node.removeLabel = config.removeLabel || false;
+
+        node.status({
+            fill: "green", 
+            shape: "dot",
+            text: `mode: ${node.removeLabel ? "remove" : "set"}, property: ${node.contextPropertyName}`
+        });
+
+        node.on("input", function(msg, send, done) {
+            send = send || function() { node.send.apply(node, arguments); };
+
+            if (!msg) {
+                node.status({ fill: "red", shape: "ring", text: "missing message" });
+                node.warn("Missing message");
+                if (done) done();
+                return;
+            }
+
+            // Set or remove context property
+            if (node.removeLabel) {
+                delete msg.context;
+                node.status({
+                    fill: "blue",
+                    shape: "dot",
+                    text: `in: ${msg.payload}, out: removed context`
+                });
+            } else {
+                msg.context = node.contextPropertyName;
+                node.status({
+                    fill: "blue",
+                    shape: "dot",
+                    text: `in: ${msg.payload}, out: ${node.contextPropertyName}`
+                });
+            }
+
+            send(msg);
+            if (done) done();
+        });
+
+        node.on("close", function(done) {
+            done();
+        });
+    }
+
+    RED.nodes.registerType("contextual-label-block", ContextualLabelBlockNode);
+};

package/nodes/convert-block.html

@@ -0,0 +1,179 @@
+<script type="text/html" data-template-name="convert-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>
+    <div class="form-row">
+        <label for="node-input-conversion" title="Select the unit conversion to perform"><i class="fa fa-exchange"></i> Conversion</label>
+        <select id="node-input-conversion">
+            <optgroup label="Temperature">
+                <option value="C to F">C to F (Celsius to Fahrenheit)</option>
+                <option value="F to C">F to C (Fahrenheit to Celsius)</option>
+                <option value="K to C">K to C (Kelvin to Celsius)</option>
+                <option value="C to K">C to K (Celsius to Kelvin)</option>
+                <option value="K to F">K to F (Kelvin to Fahrenheit)</option>
+                <option value="F to K">F to K (Fahrenheit to Kelvin)</option>
+                <option value="R to F">R to F (Rankine to Fahrenheit)</option>
+                <option value="F to R">F to R (Fahrenheit to Rankine)</option>
+            </optgroup>
+            <optgroup label="Math">
+                <option value="decimal to %">Decimal to Percent</option>
+                <option value="% to decimal">Percent to Decimal</option>
+                <option value="rad to deg">Radians to Degrees</option>
+                <option value="deg to rad">Degrees to Radians</option>
+            </optgroup>
+            <optgroup label="Pressure">
+                <option value="Pa to inH₂O">Pa to inH₂O (Pascal to Inches of Water)</option>
+                <option value="inH₂O to Pa">inH₂O to Pa (Inches of Water to Pascal)</option>
+                <option value="Pa to inHg">Pa to inHg (Pascal to Inches of Mercury)</option>
+                <option value="inHg to Pa">inHg to Pa (Inches of Mercury to Pascal)</option>
+                <option value="Pa to bar">Pa to bar (Pascal to Bar)</option>
+                <option value="bar to Pa">bar to Pa (Bar to Pascal)</option>
+                <option value="Pa to psi">Pa to psi (Pascal to PSI)</option>
+                <option value="psi to Pa">psi to Pa (PSI to Pascal)</option>
+            </optgroup>
+            <optgroup label="Length">
+                <option value="m to ft">m to ft (Meters to Feet)</option>
+                <option value="ft to m">ft to m (Feet to Meters)</option>
+                <option value="m to in">m to in (Meters to Inches)</option>
+                <option value="in to m">in to m (Inches to Meters)</option>
+                <option value="mm to in">mm to in (Millimeters to Inches)</option>
+                <option value="in to mm">in to mm (Inches to Millimeters)</option>
+            </optgroup>
+            <optgroup label="Mass & Volume">
+                <option value="kg to lb">kg to lb (Kilograms to Pounds)</option>
+                <option value="lb to kg">lb to kg (Pounds to Kilograms)</option>
+                <option value="L to gal">L to gal (Liters to Gallons)</option>
+                <option value="gal to L">gal to L (Gallons to Liters)</option>
+            </optgroup>
+            <optgroup label="Power & Time">
+                <option value="kW to hp">kW to hp (Kilowatts to Horsepower)</option>
+                <option value="hp to kW">hp to kW (Horsepower to Kilowatts)</option>
+                <option value="s to min">s to min (Seconds to Minutes)</option>
+                <option value="min to s">min to s (Minutes to Seconds)</option>
+            </optgroup>
+        </select>
+    </div>
+</script>
+
+<script type="text/javascript">
+    RED.nodes.registerType("convert-block", {
+        category: "control",
+        color: "#301934",
+        defaults: {
+            name: { value: "" },
+            conversion: { value: "C to F", required: true }
+        },
+        inputs: 1,
+        outputs: 1,
+        inputLabels: ["input"],
+        outputLabels: ["converted output"],
+        icon: "font-awesome/fa-exchange",
+        paletteLabel: "convert",
+        label: function() {
+            return this.name || `Convert (${this.conversion})`;
+        },
+        oneditvalidate: function() {
+        const conversion = $("#node-input-conversion").val();
+        const validConversions = [
+            "F to C", 
+            "C to F", 
+            "K to C",
+            "C to K", 
+            "K to F",
+            "F to K",
+            "R to F",
+            "F to R",
+            "decimal to %", 
+            "% to decimal", 
+            "Pa to inH₂O", 
+            "inH₂O to Pa", 
+            "Pa to inHg", 
+            "inHg to Pa", 
+            "Pa to bar", 
+            "bar to Pa", 
+            "Pa to psi", 
+            "psi to Pa",
+            "m to ft",
+            "ft to m",
+            "m to in",
+            "in to m",
+            "mm to in",
+            "in to mm",
+            "kg to lb",
+            "lb to kg",
+            "L to gal",
+            "gal to L",
+            "kW to hp",
+            "hp to kW",
+            "rad to deg",
+            "deg to rad",
+            "s to min",
+            "min to s"
+        ];
+        return validConversions.includes(conversion);
+    }
+});
+</script>
+
+<script type="text/markdown" data-help-name="convert-block">
+Converts numeric input payload between temperature or pressure units.
+
+### Inputs
+: context (string) : Configures the conversion (`"conversion"`). Unmatched values ignored.
+: payload (number) : Numeric value to convert 
+
+### Outputs
+: payload (number) : Converted value (e.g., °C to °F, Pa to inH₂O).
+
+### Details
+Converts `msg.payload` between units based on the selected conversion.
+
+### validConversions = [
+            "F to C", 
+            "C to F", 
+            "K to C",
+            "C to K", 
+            "K to F",
+            "F to K",
+            "R to F",
+            "F to R",
+            "decimal to %", 
+            "% to decimal", 
+            "Pa to inH₂O", 
+            "inH₂O to Pa", 
+            "Pa to inHg", 
+            "inHg to Pa", 
+            "Pa to bar", 
+            "bar to Pa", 
+            "Pa to psi", 
+            "psi to Pa",
+            "m to ft",
+            "ft to m",
+            "m to in",
+            "in to m",
+            "mm to in",
+            "in to mm",
+            "kg to lb",
+            "lb to kg",
+            "L to gal",
+            "gal to L",
+            "kW to hp",
+            "hp to kW",
+            "rad to deg",
+            "deg to rad",
+            "s to min",
+            "min to s"
+        ];
+
+### 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>