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

package/nodes/comment-block.js

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

package/nodes/compare-block.html

@@ -4,7 +4,11 @@
         <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">
+    <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-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>
@@ -17,6 +21,7 @@
         color: "#301934",
         defaults: {
             name: { value: "" },
+            inputProperty: { value: "payload" },
             setpoint: { value: 50, required: true, validate: function(v) { return !isNaN(+v) && isFinite(+v); } }
         },
         inputs: 1,
@@ -36,21 +41,26 @@
 Compares a numeric input to a setpoint, outputting three boolean signals.
 
 ### Inputs
+: input-property (number) : Input number to compare, read from the configured Input Property.
 : 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
+: name (string) : Display name in editor.
+: inputProperty (string) : Message property to read input from (default: `payload`). Supports nested properties (e.g., `data.value`).
 : setpoint (number) : Value for comparison.
 
 ### Details
-Compares `msg.payload` (number) to a `setpoint` (default: 50), outputting three messages to separate ports:
+Compares a numeric input (read from the configured **Input Property**, default: `msg.payload`) 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.
 
+Output is always written to `msg.payload` in each output message.
+
+Setpoint configurable via editor or `msg.context = "setpoint"` with numeric `msg.payload`.
+
 ### Status
 - Green (dot): Configuration update
 - Blue (dot): State changed

package/nodes/compare-block.js

@@ -1,8 +1,11 @@
 module.exports = function(RED) {
+    const utils = require('./utils')(RED);
+
     function CompareBlockNode(config) {
         RED.nodes.createNode(this, config);
         const node = this;
 
+        node.inputProperty = config.inputProperty || "payload";
         node.setpoint = Number(config.setpoint);
 
         node.on("input", function(msg, send, done) {
@@ -10,7 +13,7 @@ module.exports = function(RED) {
 
             // Guard against invalid message
             if (!msg) {
-                node.status({ fill: "red", shape: "ring", text: "invalid message" });
+                utils.setStatusError(node, "invalid message");
                 if (done) done();
                 return;
             }
@@ -18,38 +21,44 @@ module.exports = function(RED) {
             // Handle context updates
             if (msg.hasOwnProperty("context")) {
                 if (!msg.hasOwnProperty("payload")) {
-                    node.status({ fill: "red", shape: "ring", text: "missing payload for setpoint" });
+                    utils.setStatusError(node, "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)}` });
+                    const numVal = utils.validateNumericPayload(msg.payload);
+                    if (numVal.valid) {
+                        node.setpoint = numVal.value;
+                        utils.setStatusOK(node, `setpoint: ${numVal.value.toFixed(2)}`);
                     } else {
-                        node.status({ fill: "red", shape: "ring", text: "invalid setpoint" });
+                        utils.setStatusError(node, "invalid setpoint");
                     }
                     if (done) done();
                     return;
                 } else {
-                    node.status({ fill: "yellow", shape: "ring", text: "unknown context" });
+                    utils.setStatusWarn(node, "unknown context");
                     if (done) done("Unknown context");
                     return;
                 }
             }
 
-            // Validate input
-            if (!msg.hasOwnProperty("payload")) {
-                node.status({ fill: "red", shape: "ring", text: "missing input" });
+            // Get input from configured property
+            let input;
+            try {
+                input = RED.util.getMessageProperty(msg, node.inputProperty);
+            } catch (err) {
+                input = undefined;
+            }
+            if (input === undefined) {
+                utils.setStatusError(node, "missing or invalid input property");
                 if (done) done();
                 return;
             }
 
-            const inputValue = parseFloat(msg.payload);
+            const inputValue = parseFloat(input);
             if (isNaN(inputValue) || !isFinite(inputValue)) {
-                node.status({ fill: "red", shape: "ring", text: "invalid input" });
+                utils.setStatusError(node, "invalid input");
                 if (done) done();
                 return;
             }
@@ -64,11 +73,7 @@ module.exports = function(RED) {
                 { payload: less }
             ];
 
-            node.status({
-                fill: "blue",
-                shape: "dot",
-                text: `in: ${inputValue.toFixed(2)}, sp: ${node.setpoint.toFixed(2)}, out: [${greater}, ${equal}, ${less}]`
-            });
+            utils.setStatusOK(node, `in: ${inputValue.toFixed(2)}, sp: ${node.setpoint.toFixed(2)}, out: [${greater}, ${equal}, ${less}]`);
             
             send(outputs);
 

package/nodes/contextual-label-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 label 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-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">
@@ -19,6 +23,7 @@ RED.nodes.registerType("contextual-label-block", {
     color: "#301934",
     defaults: {
         name: { value: "" },
+        inputProperty: { value: "payload" },
         contextPropertyName: { 
             value: "in1", 
             required: true, 

package/nodes/contextual-label-block.js

@@ -1,4 +1,6 @@
 module.exports = function(RED) {
+    const utils = require('./utils')(RED);
+
     function ContextualLabelBlockNode(config) {
         RED.nodes.createNode(this, config);
         const node = this;
@@ -6,17 +8,13 @@ module.exports = function(RED) {
         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}`
-        });
+        utils.setStatusOK(node, `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" });
+                utils.setStatusError(node, "missing message");
                 node.warn("Missing message");
                 if (done) done();
                 return;
@@ -25,18 +23,10 @@ module.exports = function(RED) {
             // Set or remove context property
             if (node.removeLabel) {
                 delete msg.context;
-                node.status({
-                    fill: "blue",
-                    shape: "dot",
-                    text: `in: ${msg.payload}, out: removed context`
-                });
+                utils.setStatusChanged(node, `in: ${msg.payload}, out: removed context`);
             } else {
                 msg.context = node.contextPropertyName;
-                node.status({
-                    fill: "blue",
-                    shape: "dot",
-                    text: `in: ${msg.payload}, out: ${node.contextPropertyName}`
-                });
+                utils.setStatusChanged(node, `in: ${msg.payload}, out: ${node.contextPropertyName}`);
             }
 
             send(msg);

package/nodes/convert-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-conversion" title="Select the unit conversion to perform"><i class="fa fa-exchange"></i> Conversion</label>
         <select id="node-input-conversion">
@@ -62,6 +66,7 @@
         color: "#301934",
         defaults: {
             name: { value: "" },
+            inputProperty: { value: "payload" },
             conversion: { value: "C to F", required: true }
         },
         inputs: 1,
@@ -117,54 +122,35 @@
 </script>
 
 <script type="text/markdown" data-help-name="convert-block">
-Converts numeric input payload between temperature or pressure units.
+Converts numeric input from a configured property between various units.
 
 ### Inputs
+: input-property (number) : Numeric value to convert, read from the configured Input Property.
 : 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).
 
+### Properties
+: name (string) : Display name in editor.
+: inputProperty (string) : Message property to read input from (default: `payload`). Supports nested properties (e.g., `data.value`).
+: conversion (string) : Conversion type to apply (e.g., "F to C", "Pa to inH₂O").
+
 ### Details
-Converts `msg.payload` between units based on the selected conversion.
+Converts numeric input (read from the configured **Input Property**, default: `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"
-        ];
+Supported conversions include:
+- Temperature: F to C, C to F, K to C, C to K, K to F, F to K, R to F, F to R
+- Percentage: decimal to %, % to decimal
+- Pressure: 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
+- Distance: m to ft, ft to m, m to in, in to m, mm to in, in to mm
+- Weight: kg to lb, lb to kg
+- Volume: L to gal, gal to L
+- Power: kW to hp, hp to kW
+- Angle: rad to deg, deg to rad
+- Time: s to min, min to s
+
+Output is always written to `msg.payload`.
 
 ### Status
 - Green (dot): Configuration update

package/nodes/convert-block.js

@@ -1,4 +1,6 @@
 module.exports = function(RED) {
+    const utils = require('./utils')(RED);
+
     function ConvertBlockNode(config) {
         RED.nodes.createNode(this, config);
         const node = this;
@@ -41,16 +43,16 @@ module.exports = function(RED) {
         ];
 
         // Initialize runtime state
-        node.runtime = {
-            conversion: validConversions.includes(config.conversion) ? config.conversion : "C to F"
-        };
+        // Initialize state
+        node.inputProperty = config.inputProperty || "payload";
+        node.conversion = validConversions.includes(config.conversion) ? config.conversion : "C to F";
 
         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: "missing message" });
+                utils.setStatusError(node, "missing message");
                 if (done) done();
                 return;
             }
@@ -58,18 +60,18 @@ module.exports = function(RED) {
             // Handle configuration messages
             if (msg.hasOwnProperty("context")) {
                 if (typeof msg.context !== "string") {
-                    node.status({ fill: "yellow", shape: "ring", text: "unknown context" });
+                    utils.setStatusWarn(node, "unknown context");
                     if (done) done();
                     return;
                 }
                 if (msg.context === "conversion") {
                     if (!msg.hasOwnProperty("payload") || !validConversions.includes(msg.payload)) {
-                        node.status({ fill: "red", shape: "ring", text: "invalid conversion" });
+                        utils.setStatusError(node, "invalid conversion");
                         if (done) done();
                         return;
                     }
-                    node.runtime.conversion = msg.payload;
-                    node.status({ fill: "green", shape: "dot", text: `conversion: ${node.runtime.conversion}` });
+                    node.conversion = msg.payload;
+                    utils.setStatusOK(node, `conversion: ${node.conversion}`);
                     if (done) done();
                     return;
                 }
@@ -78,23 +80,29 @@ module.exports = function(RED) {
                 return;
             }
 
-            // Validate input payload
-            if (!msg.hasOwnProperty("payload")) {
-                node.status({ fill: "red", shape: "ring", text: "missing payload" });
+            // Get input from configured property
+            let input;
+            try {
+                input = RED.util.getMessageProperty(msg, node.inputProperty);
+            } catch (err) {
+                input = undefined;
+            }
+            if (input === undefined) {
+                utils.setStatusError(node, "missing or invalid input property");
                 if (done) done();
                 return;
             }
 
-            const inputValue = parseFloat(msg.payload);
+            const inputValue = parseFloat(input);
             if (isNaN(inputValue) || !isFinite(inputValue)) {
-                node.status({ fill: "red", shape: "ring", text: `Invalid payload` });
+                utils.setStatusError(node, "invalid input");
                 if (done) done();
                 return;
             }
 
             // Perform conversion
             let output, inUnit, outUnit;
-            switch (node.runtime.conversion) {
+            switch (node.conversion) {
                 case "F to C":
                     output = (inputValue - 32) * 5 / 9;
                     inUnit = "°F";
@@ -268,11 +276,18 @@ module.exports = function(RED) {
             }
 
             // Format status numbers
-            const inDisplay = msg.payload % 1 === 0 ? msg.payload : msg.payload.toFixed(2);
+            let num = Number(msg.payload);
+            let inDisplay = 0
+            if (isNaN(num)) {
+                inDisplay = 0;
+            } else {
+                inDisplay = num % 1 === 0 ? num : num.toFixed(2);
+                msg.payload = inDisplay;
+            }
             const outDisplay = output % 1 === 0 ? output : output.toFixed(2);
 
             // Update status and send output
-            node.status({ fill: "blue", shape: "dot", text: `${inDisplay} ${inUnit} → ${outDisplay} ${outUnit}` });
+            utils.setStatusOK(node, `${inDisplay} ${inUnit} → ${outDisplay} ${outUnit}`);
 
             msg.payload = output;
             send(msg);

package/nodes/count-block.html

@@ -4,6 +4,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>
 </script>
 
 <!-- JavaScript Section: Registers the node and handles editor logic -->
@@ -12,7 +16,8 @@
         category: "bldgblocks control",
         color: "#301934",
         defaults: {
-            name: { value: "" }
+            name: { value: "" },
+            inputProperty: { value: "payload" }
         },
         inputs: 1,
         outputs: 1,
@@ -28,21 +33,22 @@
 
 <!-- Help Section -->
 <script type="text/markdown" data-help-name="count-block">
-Counts boolean rising edges in the input.
+Counts boolean rising edges from a configured property.
 
 ### Inputs
+: input-property (boolean) : Boolean value to detect rising edges, read from the configured Input Property.
 : context (string) : Resets count (`"reset"`). Unmatched values trigger error.
-: payload (boolean) : Input boolean to detect rising edges.
 
 ### Outputs
 : payload (number) : Current count of rising edges.
 
 ### Properties
 : name (string) : Display name in editor.
+: inputProperty (string) : Message property to read input from (default: `payload`). Supports nested properties (e.g., `data.value`).
 
 ### Details
-Counts rising edges (false-to-true transitions) in `msg.payload` (boolean), incrementing the count on each transition. 
-Resets count to 0 via `msg.context = "reset"` with `msg.payload = true`. 
+Counts rising edges (false-to-true transitions) in the configured **Input Property** (default: `msg.payload`), incrementing the count on each transition.
+Resets count to 0 via `msg.context = "reset"` with `msg.payload = true`.
 
 ### Status
 - Green (dot): Configuration update

package/nodes/count-block.js

@@ -1,21 +1,23 @@
 module.exports = function(RED) {
+    const utils = require('./utils')(RED);
+
     function CountBlockNode(config) {
         RED.nodes.createNode(this, config);
         const node = this;
 
         // Initialize runtime state
-        node.runtime = {
-            name: config.name,
-            count: 0,
-            prevState: false
-        };
+        // Initialize state
+        node.name = config.name;
+        node.inputProperty = config.inputProperty || "payload";
+        node.count = 0;
+        node.prevState = false;
 
         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" });
+                utils.setStatusError(node, "invalid message");
                 if (done) done();
                 return;
             }
@@ -23,62 +25,62 @@ module.exports = function(RED) {
             // Handle context updates
             if (msg.hasOwnProperty("context")) {
                 if (!msg.hasOwnProperty("payload")) {
-                    node.status({ fill: "red", shape: "ring", text: "missing payload for reset" });
+                    utils.setStatusError(node, "missing payload for reset");
                     if (done) done();
                     return;
                 }
                 if (msg.context === "reset") {
-                    if (typeof msg.payload !== "boolean") {
-                        node.status({ fill: "red", shape: "ring", text: "invalid reset" });
+                    const boolVal = utils.validateBoolean(msg.payload);
+                    if (!boolVal.valid) {
+                        utils.setStatusError(node, boolVal.error);
                         if (done) done();
                         return;
                     }
-                    if (msg.payload === true) {
-                        node.runtime.count = 0;
-                        node.runtime.prevState = false;
-                        node.status({ fill: "green", shape: "dot", text: "state reset" });
-                        send({ payload: node.runtime.count });
+                    if (boolVal.value === true) {
+                        node.count = 0;
+                        node.prevState = false;
+                        utils.setStatusOK(node, "state reset");
+                        send({ payload: node.count });
                     }
                     if (done) done();
                     return;
                 } else {
-                    node.status({ fill: "yellow", shape: "ring", text: "unknown context" });
+                    utils.setStatusWarn(node, "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;
+            // Get input value from configured property
+            let inputValue;
+            try {
+                inputValue = RED.util.getMessageProperty(msg, node.inputProperty);
+            } catch (err) {
+                inputValue = undefined;
             }
-
-            const inputValue = msg.payload;
             if (typeof inputValue !== "boolean") {
-                node.status({ fill: "red", shape: "ring", text: "invalid input" });
+                utils.setStatusError(node, "missing or invalid input property");
                 if (done) done();
                 return;
             }
 
             // Prevent integer overflow
-            if (node.runtime.count > Number.MAX_SAFE_INTEGER - 100000) {
-                node.runtime.count = 0;
-                node.status({ fill: "yellow", shape: "ring", text: "count overflow reset" });
+            if (node.count > Number.MAX_SAFE_INTEGER - 100000) {
+                node.count = 0;
+                utils.setStatusWarn(node, "count overflow reset");
             }
 
             // Increment on false → true transition
-            if (!node.runtime.prevState && inputValue === true) {
-                node.runtime.count++;
-                node.status({ fill: "blue", shape: "dot", text: `count: ${node.runtime.count}` });
-                send({ payload: node.runtime.count });
+            if (!node.prevState && inputValue === true) {
+                node.count++;
+                utils.setStatusChanged(node, `count: ${node.count}`);
+                send({ payload: node.count });
             } else {
-                node.status({ fill: "blue", shape: "ring", text: `count: ${node.runtime.count}` });
+                utils.setStatusUnchanged(node, `count: ${node.count}`);
             }
 
             // Update prevState
-            node.runtime.prevState = inputValue;
+            node.prevState = inputValue;
 
             if (done) done();
         });