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

package/nodes/network-service-write.js

@@ -0,0 +1,83 @@
+module.exports = function(RED) {
+    const utils = require('./utils')(RED);
+    function NetworkServiceWriteNode(config) {
+        RED.nodes.createNode(this, config);
+        const node = this;
+        node.registry = RED.nodes.getNode(config.registry);
+
+        node.on("input", async function(msg, send, done) {
+            send = send || function() { node.send.apply(node, arguments); };
+
+            try {
+                // Validation
+                if (!msg || !msg.pointId || !msg.priority || msg.value === undefined) {
+                    return utils.sendError(node, msg, done, "Invalid msg properties", msg?.pointId);
+                }
+
+                // Registry Lookup
+                const entry = node.registry.lookup(msg.pointId);
+                if (!entry?.path) {
+                    const store = entry?.store ?? "unknown";
+                    return utils.sendError(node, msg, done, `Unknown ID: (${store})::${msg.pointId}`, msg.pointId);
+                }
+
+                const { store = "default", path, writable } = entry;
+
+                if (!writable) {
+                    return utils.sendError(node, msg, done, `Not Writable: (${store})::${path}::${msg.pointId}`, msg.pointId);
+                }
+
+                // Get State (Async)
+                let state = await utils.getGlobalState(node, path, store);
+
+                if (!state || !state.priority) {
+                    return utils.sendError(node, msg, done, `Point Not Found: (${store})::${path}`, msg.pointId);
+                }
+
+                // Type Check
+                let newValue = msg.value === "null" || msg.value === null ? null : msg.value;
+                if (newValue !== null) {
+                    const dataType = state.metadata?.type;
+                    if (dataType && typeof newValue !== dataType) {
+                        return utils.sendError(node, msg, done, `Type Mismatch: Expected ${dataType}`, msg.pointId);
+                    }
+                }
+
+                // Update Priority Logic
+                if (msg.priority === 'default') {
+                    state.defaultValue = newValue ?? state.defaultValue;
+                } else {
+                    const priority = parseInt(msg.priority, 10);
+                    if (isNaN(priority) || priority < 1 || priority > 16) {
+                        return utils.sendError(node, msg, done, `Invalid Priority: ${msg.priority}`, msg.pointId);
+                    }
+                    state.priority[msg.priority] = newValue;
+                }
+
+                // Calculate Winner
+                const result = utils.getHighestPriority(state);
+                state.value = result.value;
+                state.activePriority = result.priority;
+                state.metadata.lastSet = new Date().toISOString();
+
+                // Save (Async) & Emit
+                await utils.setGlobalState(node, path, store, state);
+
+                const prefixReq = msg.priority === 'default' ? '' : 'P';
+                const prefixAct = state.activePriority === 'default' ? '' : 'P';
+                const statusMsg = `Wrote: ${prefixReq}${msg.priority}:${newValue} > Active: ${prefixAct}${state.activePriority}:${state.value}`;
+
+                msg = { ...state, status: null }; 
+                
+                RED.events.emit("bldgblocks:global:value-changed", { key: path, store: store, data: state });
+
+                utils.sendSuccess(node, msg, done, statusMsg, msg.pointId, "ring");
+
+            } catch (err) {
+                node.error(err);
+                utils.sendError(node, msg, done, `Internal Error: ${err.message}`, msg?.pointId);
+            }
+        });
+    }
+    RED.nodes.registerType("network-service-write", NetworkServiceWriteNode);
+}

package/nodes/nullify-block.js

@@ -1,17 +1,15 @@
 module.exports = function(RED) {
+    const utils = require('./utils')(RED);
     function NullifyBlockNode(config) {
         RED.nodes.createNode(this, config);
         const node = this;
 
-        // Initialize runtime state
-        node.runtime = {
-            name: config.name,
-            rules: config.rules
-        };
+        // Initialize state
+        node.rules = config.rules || [];
 
         // Validate configuration
         let valid = true;
-        node.runtime.rules = node.runtime.rules.map(rule => {
+        node.rules = node.rules.map(rule => {
             if (rule.propertyType !== "msg" || !rule.property || typeof rule.property !== "string" || !rule.property.trim()) {
                 valid = false;
                 return { property: "payload", propertyType: "msg" };
@@ -19,9 +17,9 @@ module.exports = function(RED) {
             return rule;
         });
         if (!valid) {
-            node.status({ fill: "red", shape: "ring", text: "invalid rules, using defaults" });
+            utils.setStatusError(node, "invalid rules, using defaults");
         } else {
-            node.status({ fill: "green", shape: "dot", text: `rules: ${node.runtime.rules.map(r => r.property).join(", ")}` });
+            utils.setStatusOK(node, `rules: ${node.rules.map(r => r.property).join(", ")}`);
         }
 
         node.on("input", function(msg, send, done) {
@@ -29,7 +27,7 @@ module.exports = function(RED) {
 
             // Guard against invalid message
             if (!msg) {
-                node.status({ fill: "red", shape: "ring", text: "missing message" });
+                utils.setStatusError(node, "missing message");
                 if (done) done();
                 return;
             }
@@ -37,18 +35,18 @@ module.exports = function(RED) {
             // Handle configuration messages
             if (msg.context) {
                 if (typeof msg.context !== "string" || !msg.context.trim()) {
-                    node.status({ fill: "yellow", shape: "ring", text: "unknown context" });
+                    utils.setStatusWarn(node, "unknown context");
                     if (done) done();
                     return;
                 }
                 if (msg.context === "rules") {
                     if (!msg.hasOwnProperty("payload") || !Array.isArray(msg.payload) || !msg.payload.every(r => r.property && typeof r.property === "string" && r.propertyType === "msg")) {
-                        node.status({ fill: "red", shape: "ring", text: "invalid rules" });
+                        utils.setStatusError(node, "invalid rules");
                         if (done) done();
                         return;
                     }
-                    node.runtime.rules = msg.payload;
-                    node.status({ fill: "green", shape: "dot", text: `rules: ${node.runtime.rules.map(r => r.property).join(", ")}` });
+                    node.rules = msg.payload;
+                    utils.setStatusOK(node, `rules: ${node.rules.map(r => r.property).join(", ")}`);
                     if (done) done();
                     return;
                 }
@@ -57,13 +55,13 @@ module.exports = function(RED) {
             // Apply nullification rules
             const outputMsg = RED.util.cloneMessage(msg);
             const nullified = [];
-            node.runtime.rules.forEach(rule => {
+            node.rules.forEach(rule => {
                 RED.util.setMessageProperty(outputMsg, rule.property, null);
                 nullified.push(rule.property);
             });
 
             // Update status and send output
-            node.status({ fill: "blue", shape: "dot", text: `nullified: ${nullified.join(", ")}` });
+            utils.setStatusOK(node, `nullified: ${nullified.join(", ")}`);
             send(outputMsg);
 
             if (done) done();

package/nodes/on-change-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>
     <div class="form-row">
         <label for="node-input-period" title="Filter period in milliseconds (non-negative number from msg, flow, global, or static value)"><i class="fa fa-clock-o"></i> Filter Period (ms)</label>
         <input type="text" id="node-input-period" placeholder="0">
@@ -18,6 +22,7 @@
         color: "#301934",
         defaults: {
             name: { value: "" },
+            inputProperty: { value: "payload" },
             period: { value: 0 },
             periodType: { value: "num" }
         },
@@ -42,10 +47,10 @@
 
 <!-- Help Section -->
 <script type="text/markdown" data-help-name="on-change-block">
-Filters redundant messages based on value changes and a configurable period.
+Filters redundant messages based on value changes from a configured property.
 
 ### Inputs
-: payload (any) : Input value to compare.
+: input-property (any) : Value to monitor for changes, read from the configured Input Property.
 : context (string, optional) : Configures period (`"period"`) or queries state (`"status"`).
 : payload (number | any, for `context`) : Non-negative number for `"period"` (ms), any for `"status"`.
 
@@ -54,16 +59,19 @@ Filters redundant messages based on value changes and a configurable period.
 : payload (object, for `msg.context = "status"`) : `{ period, periodType }`.
 
 ### Properties
-: name (string) : Display name in editor. Default "" (shows "on change").
-: period (number) : Filter period in milliseconds (≥ 0, static or from `msg`, `flow`, `global`). Default 0.
+: name (string) : Display name in editor.
+: inputProperty (string) : Message property to monitor for changes (default: `payload`). Supports nested properties (e.g., `data.value`).
+: period (number) : Filter period in milliseconds (≥ 0). Default 0.
 : periodType (string) : Source of period (`"num"`, `"msg"`, `"flow"`, `"global"`). Default `"num"`.
 
 ### Details
-Filters messages based on value changes (deep comparison) and a filter period. When `period = 0`, outputs the input message only if `msg.payload` 
-differs from the last output value. When `period > 0`, outputs the first message, suppresses all messages during the period (including blips). 
-Supports complex payloads (objects, arrays) via deep comparison. 
-Configuration
-- `msg.context = "period"` Sets period (ms), no output.
+Filters messages based on value changes (deep comparison) to the input property and an optional filter period.
+When `period = 0`, outputs the input message only if the input property differs from the last output value.
+When `period > 0`, outputs the first message, then suppresses all messages during the period.
+
+Supports complex payloads (objects, arrays) via deep comparison.
+
+Configuration via `msg.context = "period"` with numeric `msg.payload` sets the filter period in milliseconds (no output).
 
 ### Status
 - Green (dot): Configuration update

package/nodes/on-change-block.js

@@ -1,5 +1,5 @@
 module.exports = function(RED) {
-    const utils = require('./utils')(RED);
+    const utils = require("./utils")(RED);
 
     function OnChangeBlockNode(config) {
         RED.nodes.createNode(this, config);
@@ -7,19 +7,19 @@ module.exports = function(RED) {
         node.isBusy = false;
 
         // Initialize runtime state
-        node.runtime = {
-            name: config.name,
-            lastValue: null,
-            blockTimer: null,
-            period: parseFloat(config.period),
-        };
+        // Initialize state
+        node.name = config.name;
+        node.inputProperty = config.inputProperty || "payload";
+        node.lastValue = null;
+        node.blockTimer = null;
+        node.period = parseFloat(config.period);
 
         node.on("input", async function(msg, send, done) {
             send = send || function() { node.send.apply(node, arguments); };
 
             // Guard against invalid message
             if (!msg) {
-                node.status({ fill: "red", shape: "ring", text: "invalid message" });
+                utils.setStatusError(node, "invalid message");
                 if (done) done();
                 return;
             }
@@ -30,7 +30,7 @@ module.exports = function(RED) {
                 // Check busy lock
                 if (node.isBusy) {
                     // Update status to let user know they are pushing too fast
-                    node.status({ fill: "yellow", shape: "ring", text: "busy - dropped msg" });
+                    utils.setStatusBusy(node, "busy - dropped msg");
                     if (done) done(); 
                     return;
                 }
@@ -45,13 +45,13 @@ module.exports = function(RED) {
                     utils.requiresEvaluation(config.periodType) 
                         ? utils.evaluateNodeProperty(config.period, config.periodType, node, msg)
                             .then(val => parseFloat(val))
-                        : Promise.resolve(node.runtime.period),
+                        : Promise.resolve(node.period),
                 );
 
                 const results = await Promise.all(evaluations);   
 
                 // Update runtime with evaluated values
-                if (!isNaN(results[0])) node.runtime.period = results[0];       
+                if (!isNaN(results[0])) node.period = results[0];       
             } catch (err) {
                 node.error(`Error evaluating properties: ${err.message}`);
                 if (done) done();
@@ -62,32 +62,28 @@ module.exports = function(RED) {
             }
 
             // Acceptable fallbacks
-            if (isNaN(node.runtime.period) || node.runtime.period < 0) {
-                node.runtime.period = config.period;
-                node.status({ fill: "red", shape: "ring", text: "invalid period, using 0" });
+            if (isNaN(node.period) || node.period < 0) {
+                node.period = config.period;
+                utils.setStatusError(node, "invalid period, using 0");
             }
 
             // Handle context updates
             if (msg.hasOwnProperty("context") && typeof msg.context === "string") {
                 if (msg.context === "period") {
                     if (!msg.hasOwnProperty("payload")) {
-                        node.status({ fill: "red", shape: "ring", text: "missing payload for period" });
+                        utils.setStatusError(node, "missing payload for period");
                         if (done) done();
                         return;
                     }
                     const newPeriod = parseFloat(msg.payload);
                     if (isNaN(newPeriod) || newPeriod < 0) {
-                        node.status({ fill: "red", shape: "ring", text: "invalid period" });
+                        utils.setStatusError(node, "invalid period");
                         if (done) done();
                         return;
                     }
-                    node.runtime.period = newPeriod;
-                    node.runtime.periodType = "num";
-                    node.status({
-                        fill: "green",
-                        shape: "dot",
-                        text: `period: ${node.runtime.period.toFixed(0)} ms`
-                    });
+                    node.period = newPeriod;
+                    node.periodType = "num";
+                    utils.setStatusOK(node, `period: ${node.period.toFixed(0)} ms`);
                     if (done) done();
                     return;
                 }
@@ -96,13 +92,26 @@ module.exports = function(RED) {
 
             // Validate input payload
             if (!msg.hasOwnProperty("payload")) {
-                node.status({ fill: "red", shape: "ring", text: "missing payload" });
+                utils.setStatusError(node, "missing payload");
                 send(msg);
                 if (done) done();
                 return;
             }
 
-            const currentValue = msg.payload;
+            let inputValue;
+            try {
+                inputValue = RED.util.getMessageProperty(msg, node.inputProperty);
+            } catch (err) {
+                inputValue = undefined;
+            }
+            if (inputValue === undefined) {
+                utils.setStatusError(node, "missing or invalid input property");
+                send(msg);
+                if (done) done();
+                return;
+            }
+
+            const currentValue = inputValue;
 
             // Deep comparison function
             function isEqual(a, b) {
@@ -122,46 +131,40 @@ module.exports = function(RED) {
             }
 
             // Block if in filter period
-            if (node.runtime.blockTimer) {
-                node.status({
-                    fill: "blue",
-                    shape: "ring",
-                    text: `filtered: ${JSON.stringify(currentValue).slice(0, 20)} |`
-                });
+            if (node.blockTimer) {
+                const filteredText = `filtered: ${JSON.stringify(currentValue).slice(0, 20)} |`;
+                utils.setStatusUnchanged(node, filteredText);
                 if (done) done();
                 return;
             }
 
             // period === 0 means only ever on change, not equal outside of filter period sends an update message
-            if (isEqual(currentValue, node.runtime.lastValue)) {
-                if (node.runtime.period === 0) {
+            if (isEqual(currentValue, node.lastValue)) {
+                if (node.period === 0) {
                     if (done) done();
                     return;
                 }
             }
 
-            node.runtime.lastValue = currentValue;
+            node.lastValue = currentValue;
             send(msg);
 
             // Start filter period if applicable
-            if (node.runtime.period > 0) {
-                node.runtime.blockTimer = setTimeout(() => {
-                    node.runtime.blockTimer = null;
-                    node.status({
-                        fill: "blue",
-                        shape: "ring",
-                        text: `filtered: ${JSON.stringify(currentValue).slice(0, 20)}` // remove ' |' to indicate end of filter period
-                    });
-                }, node.runtime.period);
+            if (node.period > 0) {
+                node.blockTimer = setTimeout(() => {
+                    node.blockTimer = null;
+                    const endFilterText = `filtered: ${JSON.stringify(currentValue).slice(0, 20)}`;
+                    utils.setStatusUnchanged(node, endFilterText);
+                }, node.period);
             }
 
             if (done) done();
         });
 
         node.on("close", function(done) {
-            if (node.runtime.blockTimer) {
-                clearTimeout(node.runtime.blockTimer);
-                node.runtime.blockTimer = null;
+            if (node.blockTimer) {
+                clearTimeout(node.blockTimer);
+                node.blockTimer = null;
             }
             done();
         });

package/nodes/oneshot-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-duration" title="Duration of true pulse (positive number)"><i class="fa fa-clock-o"></i> Duration</label>
         <input type="number" id="node-input-duration" placeholder="1000" min="0" step="any">
         <select id="node-input-durationUnits">
@@ -30,6 +34,7 @@
         color: "#301934",
         defaults: {
             name: { value: "" },
+            inputProperty: { value: "payload" },
             duration: { 
                 value: 1000, 
                 required: true, 
@@ -53,9 +58,10 @@
 
 <!-- Help Section -->
 <script type="text/markdown" data-help-name="oneshot-block">
-Outputs a true pulse for a configurable duration when triggered with `msg.payload = true`, then false, and locks until reset.
+Outputs a true pulse for a configurable duration when triggered, then locks until reset.
 
 ### Inputs
+: input-property (boolean) : Trigger signal to initiate pulse, read from the configured Input Property.
 : context (string) : Configures node (`"reset"`, `"duration"`). Unmatched values trigger error.
 : payload (boolean | number) : `true` triggers pulse if not locked; number for `"duration"`; boolean for `"reset"`.
 : units (string) : Units for `"duration"` (`"milliseconds"`, `"seconds"`, `"minutes"`).
@@ -65,23 +71,20 @@ Outputs a true pulse for a configurable duration when triggered with `msg.payloa
 
 ### Properties
 : name (string) : Display name in editor.
+: inputProperty (string) : Message property to read trigger signal from (default: `payload`). Supports nested properties (e.g., `data.value`).
 : duration (number) : Pulse duration (positive number).
 : durationUnits (string) : Units for duration (`"milliseconds"`, `"seconds"`, `"minutes"`).
 : resetRequireTrue (boolean) : Require `msg.payload = true` for reset.
 : resetOnComplete (boolean) : Automatically reset (unlock) after pulse duration.
 
 ### Details
-Generates a `true` pulse for `duration` when triggered with `msg.payload = true`, 
-then outputs `false`. 
-
-Locks until reset via `msg.context = "reset"` (requires `msg.payload = true` if `resetRequireTrue = true`) or 
-automatically if `resetOnComplete = true`. Non-`true` payloads are ignored with no output. 
+Generates a `true` pulse for `duration` when triggered with input property = true (read from configured **Input Property**, default: `msg.payload`), then outputs `false`.
 
-Duration configurable via editor or `msg.context = "duration"` with `msg.units` (`"milliseconds"`, `"seconds"`, `"minutes"`). 
+Locks until reset via `msg.context = "reset"` (requires `msg.payload = true` if `resetRequireTrue = true`) or automatically if `resetOnComplete = true`. 
 
-Tracks `triggerCount` (number of triggers) and displays in status. 
+Non-`true` inputs are ignored with no output. Duration configurable via editor or `msg.context = "duration"` with `msg.units` (`"milliseconds"`, `"seconds"`, `"minutes"`).
 
-Outputs new `{ payload boolean }` messages for every trigger (`true` then `false`), reset, or locked input. 
+Outputs are written to `msg.payload` as boolean values.
 
 ### Status
 - Green (dot): Configuration update