node-red-contrib-freya-nodes 0.2.1 → 0.2.3

package/nodes/humidity-controller/humidity-controller-node.html

@@ -29,7 +29,7 @@
     },
     inputs:1,
     outputs:2,
-    outputLabels:["actuator commands", "status"],
+    outputLabels:["control (actuators)", "status"],
     icon: "font-awesome/fa-tint",
     label: function() {
       return this.name || "Humidity Controller";
@@ -125,11 +125,13 @@
   
   <h3>Outputs</h3>
   <dl class="message-properties">
-    <dt>Output 1: Actuator Commands <span class="property-type">object</span></dt>
-    <dd>Commands for actuators: <code>{humidifier: "on/off", dehumidifier: "on/off"}</code></dd>
-    
+    <dt>Output 1: Control <span class="property-type">object</span></dt>
+    <dd><code>msg.payload</code> is <code>{ humidifier: "on"/"off", dehumidifier: "on"/"off" }</code>
+    with <code>msg.topic = "actuators"</code>.</dd>
+
     <dt>Output 2: Status <span class="property-type">object</span></dt>
-    <dd>Controller status including state, readings, safety overrides, and deadband</dd>
+    <dd><code>msg.payload</code> contains <code>state</code>, <code>timestamp</code>, and optional
+    context fields. <code>msg.topic = "status"</code>. Emitted only on state changes.</dd>
   </dl>
   
   <h3>Control Logic</h3>
@@ -156,4 +158,13 @@
     <li><strong>Auto Recovery:</strong> Resumes normal control immediately when sensor returns</li>
     <li><strong>Status Alerts:</strong> Emits configurable severity alerts on watchdog trigger</li>
   </ul>
+
+  <h3>Status Messages</h3>
+  <p>Status messages are emitted on output 2 only when the state changes:</p>
+  <ul>
+    <li><strong>idle</strong> — at target or awaiting inputs</li>
+    <li><strong>humidifying</strong> — humidifier is active (includes <code>target</code>, <code>reading</code>, <code>deadband</code>, <code>safetyOverride</code>)</li>
+    <li><strong>dehumidifying</strong> — dehumidifier is active (includes <code>target</code>, <code>reading</code>, <code>deadband</code>, <code>safetyOverride</code>)</li>
+    <li><strong>error</strong> — open-loop mode, watchdog triggered (includes <code>severity</code>, <code>message</code>)</li>
+  </ul>
 </script>

package/nodes/humidity-controller/humidity-controller-node.js

@@ -11,7 +11,22 @@ const humidityController = (RED) => {
         const state = {
             currentState: 'idle',
             safetyOverride: null,
-            openLoopMode: false
+            openLoopMode: false,
+            previousStatusState: null
+        };
+        const emitStatus = (newState, optionalFields) => {
+            if (newState === state.previousStatusState) {
+                return null;
+            }
+            state.previousStatusState = newState;
+            const statusPayload = {
+                state: newState,
+                timestamp: Date.now()
+            };
+            if (optionalFields) {
+                Object.assign(statusPayload, optionalFields);
+            }
+            return { payload: statusPayload, topic: 'status' };
         };
         const startWatchdog = () => {
             if (state.watchdogTimer) {
@@ -19,6 +34,7 @@ const humidityController = (RED) => {
             }
             state.watchdogTimer = setTimeout(() => {
                 state.openLoopMode = true;
+                state.previousStatusState = 'error';
                 node.send([
                     {
                         payload: {
@@ -29,10 +45,10 @@ const humidityController = (RED) => {
                     },
                     {
                         payload: {
+                            state: 'error',
+                            timestamp: Date.now(),
                             severity: node.watchdogSeverity,
-                            message: `No sensor feedback for ${node.watchdogTimeout}s`,
-                            state: 'open-loop',
-                            timestamp: new Date().toISOString()
+                            message: `No sensor feedback for ${node.watchdogTimeout}s`
                         },
                         topic: 'status'
                     }
@@ -114,6 +130,12 @@ const humidityController = (RED) => {
         };
         const _executeControlLoop = () => {
             const control = calculateControl();
+            const statusMsg = emitStatus(control.state, {
+                target: state.targetHumidity,
+                reading: state.currentHumidity,
+                deadband: this.deadband,
+                safetyOverride: control.override || null
+            });
             node.send([
                 {
                     payload: {
@@ -122,17 +144,7 @@ const humidityController = (RED) => {
                     },
                     topic: 'actuators'
                 },
-                {
-                    payload: {
-                        state: control.state,
-                        target: state.targetHumidity,
-                        reading: state.currentHumidity,
-                        safetyOverride: control.override || null,
-                        deadband: this.deadband,
-                        openLoopMode: state.openLoopMode
-                    },
-                    topic: 'status'
-                }
+                statusMsg
             ]);
             updateStatus(control);
         };
@@ -168,6 +180,7 @@ const humidityController = (RED) => {
             stopWatchdog();
         });
         node.status({ fill: 'yellow', shape: 'dot', text: 'awaiting inputs' });
+        emitStatus('idle');
     }
     RED.nodes.registerType('humidity controller', HumidityControllerNode);
 };

package/nodes/lighting-controller/lighting-controller-node.html

@@ -30,7 +30,7 @@
     },
     inputs:1,
     outputs:2,
-    outputLabels:["control", "status"],
+    outputLabels:["control (actuators)", "status"],
     icon: "font-awesome/fa-lightbulb-o",
     label: function() {
       return this.name || "Lighting Controller";
@@ -139,8 +139,20 @@
   </ul>
   
   <h3>Outputs</h3>
+  <dl class="message-properties">
+    <dt>Output 1: Control <span class="property-type">object</span></dt>
+    <dd><code>msg.payload</code> contains the lighting command (analog: <code>{ lighting: 0.0–100.0 }</code>,
+    digital: <code>{ lighting: "on"/"off" }</code>). <code>msg.topic = "actuators"</code>.</dd>
+
+    <dt>Output 2: Status <span class="property-type">object</span></dt>
+    <dd><code>msg.payload</code> contains <code>state</code>, <code>timestamp</code>, and optional
+    context fields. <code>msg.topic = "status"</code>. Emitted on every input.</dd>
+  </dl>
+
+  <h3>Status Messages</h3>
+  <p>Status messages are emitted on output 2 on every input, reflecting the current brightness and state:</p>
   <ul>
-    <li><strong>Output 1:</strong> Actuator command with formatted lighting value</li>
-    <li><strong>Output 2:</strong> Status message for the status aggregator</li>
+    <li><strong>idle</strong> — lighting is off (brightness = 0)</li>
+    <li><strong>active</strong> — lighting is on (includes <code>brightness</code> %, <code>mode</code>, <code>scheduleActive</code>)</li>
   </ul>
 </script>

package/nodes/lighting-controller/lighting-controller-node.js

@@ -9,6 +9,16 @@ const lightingController = (RED) => {
         this.scheduleTime1 = config.scheduleTime1 || '';
         this.scheduleTime2 = config.scheduleTime2 || '';
         this.scheduleMode = config.scheduleMode || 'allowed';
+        const buildStatus = (currentState, optionalFields) => {
+            const statusPayload = {
+                state: currentState,
+                timestamp: Date.now()
+            };
+            if (optionalFields) {
+                Object.assign(statusPayload, optionalFields);
+            }
+            return { payload: statusPayload, topic: 'status' };
+        };
         const isWithinSchedule = () => {
             if (!this.scheduleTime1 || !this.scheduleTime2) {
                 return true;
@@ -96,9 +106,15 @@ const lightingController = (RED) => {
                     node.status({ fill: 'grey', shape: 'dot', text: statusText });
                 }
             }
+            const currentState = finalValue > 0 ? 'active' : 'idle';
+            const statusMsg = buildStatus(currentState, {
+                brightness: finalValue,
+                mode: this.mode,
+                scheduleActive
+            });
             send([
                 { payload: outputPayload, topic: 'actuators' },
-                { payload: Object.assign(Object.assign({}, outputPayload), { scheduleActive, gain: this.gain, bottomCutOff: this.bottomCutOff, mode: this.mode }), topic: 'status' }
+                statusMsg
             ]);
             done === null || done === void 0 ? void 0 : done();
         });

package/nodes/precipitation-controller/precipitation-controller-node.html

@@ -26,9 +26,9 @@
       tickInterval: {value: 60, required: true, validate: function(v) { return RED.validators.number()(v) && parseInt(v) >= 1; }}
     },
     inputs:1,
-    outputs:1,
+    outputs:2,
     inputLabels:["parameter update"],
-    outputLabels:["actuator command"],
+    outputLabels:["control (actuators)", "status"],
     icon: "font-awesome/fa-tint",
     label: function() {
       return this.name || "Precipitation Controller";
@@ -69,19 +69,28 @@
     <dt>msg.topic = "duration" <span class="property-type">number</span></dt>
     <dd><code>msg.payload</code> sets the pump duration in seconds, overriding the configured default</dd>
 
+    <dt>msg.topic = "nightDisable" <span class="property-type">boolean</span></dt>
+    <dd><code>msg.payload</code> enables (<code>true</code>) or disables (<code>false</code>) the
+    nighttime pause feature at runtime. Defaults to <code>false</code> on deploy.
+    Switching from <code>true</code> to <code>false</code> while paused resumes normal operation immediately.</dd>
+
     <dt>msg.topic = "night" <span class="property-type">boolean</span></dt>
     <dd><code>msg.payload</code> signals nighttime (<code>true</code>) or daytime (<code>false</code>).
+    Only effective when nighttime disable has been enabled via the <code>nightDisable</code> topic.
     During nighttime no new precipitation events are started. If the pump is already active
     when night begins, the current cycle finishes normally.</dd>
   </dl>
   <p>Messages with unrecognised topics are ignored.</p>
 
-  <h3>Output</h3>
+  <h3>Outputs</h3>
   <dl class="message-properties">
-    <dt>msg.payload <span class="property-type">object</span></dt>
-    <dd><code>{ pump: "on" }</code> when the pump turns on, <code>{ pump: "off" }</code> when it turns off.
-    <code>msg.topic</code> is set to <code>"actuators"</code>.
-    Two messages are sent per precipitation event.</dd>
+    <dt>Output 1: Control <span class="property-type">object</span></dt>
+    <dd><code>msg.payload</code> is <code>{ pump: "on" }</code> or <code>{ pump: "off" }</code>
+    with <code>msg.topic = "actuators"</code>. Two messages are sent per precipitation event.</dd>
+
+    <dt>Output 2: Status <span class="property-type">object</span></dt>
+    <dd><code>msg.payload</code> contains <code>state</code>, <code>timestamp</code>, and optional
+    context fields. <code>msg.topic = "status"</code>. Emitted only on state changes.</dd>
   </dl>
 
   <h3>Details</h3>
@@ -89,7 +98,7 @@
   precipitation is due:</p>
   <ul>
     <li>If the pump is already running the tick is skipped (no overlapping cycles).</li>
-    <li>If nighttime is signalled, the tick is skipped.</li>
+    <li>If nighttime disable is enabled and night is signalled, the tick is skipped.</li>
     <li>If this is the first tick after deploy, or the configured interval has elapsed
         since the last event, the pump is turned on for the configured duration and then
         automatically turned off.</li>
@@ -99,6 +108,23 @@
   <p>On redeploy or shutdown the node clears all timers and forces the pump off
   to prevent it from getting stuck on.</p>
 
+  <h3>Nighttime Disable</h3>
+  <p>The nighttime disable feature is controlled at runtime via <code>msg.topic = "nightDisable"</code>.
+  On deploy it defaults to off (precipitation runs 24/7). When enabled, the node tracks a
+  night/day state updated via <code>msg.topic = "night"</code>. During nighttime no new
+  precipitation events are started. If the pump is already active when night begins, the
+  current cycle is allowed to finish normally. Switching nighttime disable off while paused
+  causes the node to resume normal tick evaluation immediately.</p>
+
+  <h3>Status Messages</h3>
+  <p>Status messages are emitted on output 2 only when the state changes:</p>
+  <ul>
+    <li><strong>idle</strong> — initial state after deploy, no evaluation yet</li>
+    <li><strong>active</strong> — pump is on (includes <code>duration</code> in ms)</li>
+    <li><strong>waiting</strong> — pump off, counting down (includes <code>remaining</code> in ms)</li>
+    <li><strong>paused</strong> — nighttime, precipitation suppressed</li>
+  </ul>
+
   <h3>Configuration</h3>
   <ul>
     <li><strong>Interval:</strong> Time between precipitation events in minutes (default: 60)</li>
@@ -106,7 +132,7 @@
     <li><strong>Tick Interval:</strong> How often to evaluate whether precipitation is due in seconds (default: 60)</li>
   </ul>
 
-  <h3>Status</h3>
+  <h3>Node Status</h3>
   <ul>
     <li><strong>idle</strong> (grey/ring) — initial state before first tick</li>
     <li><strong>pump on</strong> (blue/dot) — pump is running, shows duration</li>

package/nodes/precipitation-controller/precipitation-controller-node.js

@@ -22,34 +22,62 @@ const precipitationController = (RED) => {
             pumpActive: false,
             intervalMs: (node.interval || 60) * 60000,
             durationMs: (node.duration || 30) * 1000,
-            night: false
+            nightDisable: false,
+            night: false,
+            previousState: null
+        };
+        const emitStatus = (newState, optionalFields) => {
+            if (newState === state.previousState) {
+                return;
+            }
+            state.previousState = newState;
+            const statusPayload = {
+                state: newState,
+                timestamp: Date.now()
+            };
+            if (optionalFields) {
+                Object.assign(statusPayload, optionalFields);
+            }
+            node.send([null, { payload: statusPayload, topic: 'status' }]);
         };
         const evaluatePrecipitation = () => {
             if (state.pumpActive) {
                 return;
             }
-            if (state.night) {
+            if (state.nightDisable && state.night) {
                 node.status({ fill: 'grey', shape: 'ring', text: 'paused (night)' });
+                emitStatus('paused');
                 return;
             }
             const now = Date.now();
             if (state.lastPrecipitation === null || (now - state.lastPrecipitation) >= state.intervalMs) {
                 state.pumpActive = true;
                 state.lastPrecipitation = now;
-                node.send({ payload: { pump: 'on' }, topic: 'actuators' });
                 node.status({ fill: 'blue', shape: 'dot', text: `pump on (${formatDuration(state.durationMs)})` });
+                state.previousState = 'active';
+                node.send([
+                    { payload: { pump: 'on' }, topic: 'actuators' },
+                    { payload: { state: 'active', timestamp: now, duration: state.durationMs }, topic: 'status' }
+                ]);
                 state.offTimer = setTimeout(() => {
                     state.pumpActive = false;
                     state.offTimer = undefined;
-                    node.send({ payload: { pump: 'off' }, topic: 'actuators' });
-                    const timeStr = new Date().toLocaleTimeString('en-GB', { hour12: false });
+                    const offNow = Date.now();
+                    const timeStr = new Date(offNow).toLocaleTimeString('en-GB', { hour12: false });
                     node.status({ fill: 'grey', shape: 'ring', text: `last: ${timeStr}` });
+                    const remaining = state.intervalMs - (offNow - (state.lastPrecipitation || offNow));
+                    state.previousState = 'waiting';
+                    node.send([
+                        { payload: { pump: 'off' }, topic: 'actuators' },
+                        { payload: { state: 'waiting', timestamp: offNow, remaining: Math.max(0, remaining) }, topic: 'status' }
+                    ]);
                 }, state.durationMs);
             }
             else {
                 const elapsed = now - state.lastPrecipitation;
                 const remaining = state.intervalMs - elapsed;
                 node.status({ fill: 'green', shape: 'ring', text: `next in ${formatDuration(remaining)}` });
+                emitStatus('waiting', { remaining });
             }
         };
         const startTickInterval = () => {
@@ -70,6 +98,14 @@ const precipitationController = (RED) => {
                 state.durationMs = msg.payload * 1000;
                 node.log(`Duration updated: ${msg.payload} seconds`);
             }
+            else if (msg.topic === 'nightDisable' && typeof msg.payload === 'boolean') {
+                const wasEnabled = state.nightDisable;
+                state.nightDisable = msg.payload;
+                node.log(`Nighttime disable updated: ${msg.payload}`);
+                if (wasEnabled && !msg.payload && state.night && !state.pumpActive) {
+                    evaluatePrecipitation();
+                }
+            }
             else if (msg.topic === 'night' && typeof msg.payload === 'boolean') {
                 state.night = msg.payload;
                 node.log(`Night state updated: ${msg.payload}`);
@@ -87,11 +123,12 @@ const precipitationController = (RED) => {
             }
             if (state.pumpActive) {
                 state.pumpActive = false;
-                node.send({ payload: { pump: 'off' }, topic: 'actuators' });
+                node.send([{ payload: { pump: 'off' }, topic: 'actuators' }, null]);
             }
             done();
         });
         node.status({ fill: 'grey', shape: 'ring', text: 'idle' });
+        emitStatus('idle');
         startTickInterval();
     }
     RED.nodes.registerType('precipitation controller', PrecipitationControllerNode);

package/nodes/temperature-controller/temperature-controller-node.html

@@ -29,7 +29,7 @@
     },
     inputs:1,
     outputs:2,
-    outputLabels:["actuator commands", "status"],
+    outputLabels:["control (actuators)", "status"],
     icon: "font-awesome/fa-thermometer-half",
     label: function() {
       return this.name||"Temperature Controller";
@@ -97,10 +97,15 @@
   </dl>
   
   <h3>Outputs</h3>
-  <ul>
-    <li><strong>Output 1 (Actuators):</strong> <code>msg.payload</code> (object) - actuator commands: <code>{ heater: "on/off", cooler: "on/off" }</code></li>
-    <li><strong>Output 2 (Status):</strong> Status information for aggregation</li>
-  </ul>
+  <dl class="message-properties">
+    <dt>Output 1: Control <span class="property-type">object</span></dt>
+    <dd><code>msg.payload</code> is <code>{ heater: "on"/"off", cooler: "on"/"off" }</code>
+    with <code>msg.topic = "actuators"</code>.</dd>
+
+    <dt>Output 2: Status <span class="property-type">object</span></dt>
+    <dd><code>msg.payload</code> contains <code>state</code>, <code>timestamp</code>, and optional
+    context fields. <code>msg.topic = "status"</code>. Emitted only on state changes.</dd>
+  </dl>
   
   <h3>Control Logic</h3>
   <ul>
@@ -122,4 +127,13 @@
     <li><strong>Auto Recovery:</strong> Resumes normal control immediately when sensor returns</li>
     <li><strong>Status Alerts:</strong> Emits configurable severity alerts on watchdog trigger</li>
   </ul>
+
+  <h3>Status Messages</h3>
+  <p>Status messages are emitted on output 2 only when the state changes:</p>
+  <ul>
+    <li><strong>idle</strong> — at target or awaiting inputs</li>
+    <li><strong>heating</strong> — heater is active (includes <code>target</code>, <code>reading</code>, <code>deadband</code>, <code>safetyOverride</code>)</li>
+    <li><strong>cooling</strong> — cooler is active (includes <code>target</code>, <code>reading</code>, <code>deadband</code>, <code>safetyOverride</code>)</li>
+    <li><strong>error</strong> — open-loop mode, watchdog triggered (includes <code>severity</code>, <code>message</code>)</li>
+  </ul>
 </script>

package/nodes/temperature-controller/temperature-controller-node.js

@@ -11,7 +11,22 @@ const temperatureController = (RED) => {
         const state = {
             currentState: 'idle',
             safetyOverride: null,
-            openLoopMode: false
+            openLoopMode: false,
+            previousStatusState: null
+        };
+        const emitStatus = (newState, optionalFields) => {
+            if (newState === state.previousStatusState) {
+                return null;
+            }
+            state.previousStatusState = newState;
+            const statusPayload = {
+                state: newState,
+                timestamp: Date.now()
+            };
+            if (optionalFields) {
+                Object.assign(statusPayload, optionalFields);
+            }
+            return { payload: statusPayload, topic: 'status' };
         };
         const startWatchdog = () => {
             if (state.watchdogTimer) {
@@ -19,6 +34,7 @@ const temperatureController = (RED) => {
             }
             state.watchdogTimer = setTimeout(() => {
                 state.openLoopMode = true;
+                state.previousStatusState = 'error';
                 node.send([
                     {
                         payload: {
@@ -29,10 +45,10 @@ const temperatureController = (RED) => {
                     },
                     {
                         payload: {
+                            state: 'error',
+                            timestamp: Date.now(),
                             severity: node.watchdogSeverity,
-                            message: `No sensor feedback for ${node.watchdogTimeout}s`,
-                            state: 'open-loop',
-                            timestamp: new Date().toISOString()
+                            message: `No sensor feedback for ${node.watchdogTimeout}s`
                         },
                         topic: 'status'
                     }
@@ -114,6 +130,12 @@ const temperatureController = (RED) => {
         };
         const _executeControlLoop = () => {
             const control = calculateControl();
+            const statusMsg = emitStatus(control.state, {
+                target: state.targetTemperature,
+                reading: state.currentTemperature,
+                deadband: this.deadband,
+                safetyOverride: control.override || null
+            });
             node.send([
                 {
                     payload: {
@@ -122,17 +144,7 @@ const temperatureController = (RED) => {
                     },
                     topic: 'actuators'
                 },
-                {
-                    payload: {
-                        state: control.state,
-                        target: state.targetTemperature,
-                        reading: state.currentTemperature,
-                        safetyOverride: control.override || null,
-                        deadband: this.deadband,
-                        openLoopMode: state.openLoopMode
-                    },
-                    topic: 'status'
-                }
+                statusMsg
             ]);
             updateStatus(control);
         };
@@ -168,6 +180,7 @@ const temperatureController = (RED) => {
             stopWatchdog();
         });
         node.status({ fill: 'yellow', shape: 'dot', text: 'awaiting inputs' });
+        emitStatus('idle');
     }
     RED.nodes.registerType('temperature controller', TemperatureControllerNode);
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-freya-nodes",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Custom nodes for Freya Vivarium Control System",
   "author": "Sanne 'SpuQ' Santens",
   "license": "GPL-3.0",