Compare commits
2 Commits
main
...
2a82b7d7dc
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
2a82b7d7dc | ||
|
|
2a6a0bc34b |
49
CONTRACT.md
Normal file
49
CONTRACT.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# monster — Contract
|
||||
|
||||
Hand-maintained for Phase 6; the `## Inputs` table is generated from
|
||||
`src/commands/index.js` (see Phase 9 generator). Keep ≤ 80 lines.
|
||||
|
||||
## Inputs (msg.topic on Port 0)
|
||||
|
||||
| Canonical | Aliases (deprecated) | Payload | Effect |
|
||||
|---|---|---|---|
|
||||
| `cmd.start` | `i_start` | truthy/falsy | Sets `source.i_start`. On the next tick a sampling run begins if flow bounds validate. |
|
||||
| `set.schedule` | `monsternametijden` | array of AQUON rows (`SAMPLE_NAME`, `DESCRIPTION`, `SAMPLED_DATE`, `START_DATE`, `END_DATE`) | Stores the schedule and recomputes `nextDate` + `daysPerYear` for the configured `aquonSampleName`. |
|
||||
| `set.rain` | `rain_data` | per-location rain forecast (Open-Meteo shape) | Aggregates hourly precipitation into `sumRain` / `avgRain`; feeds the rain-scaled flow prediction. |
|
||||
| `data.flow` | `input_q` | `{ value: number, unit: string }` | Converts to m³/h and pushes into `flow.manual.atequipment`. Blends with measured-child flow in `getEffectiveFlow()`. |
|
||||
| `set.mode` | `setMode` | string | Delegated to `source.setMode()` if defined. Reserved for future use. |
|
||||
| `set.model-prediction` | `model_prediction` | numeric | Delegated to `source.setModelPrediction()` if defined. Reserved for future use. |
|
||||
|
||||
Aliases log a one-time deprecation warning the first time they fire.
|
||||
|
||||
## Outputs (msg.topic on Port 0/1/2)
|
||||
|
||||
- **Port 0 (process):** `msg.topic = config.general.name`. Payload built
|
||||
by `outputUtils.formatMsg(..., 'process')` from `getOutput()`. Delta-
|
||||
compressed — only changed fields are emitted. Carries `pulse`, `running`,
|
||||
`bucketVol`, `sumPuls`, `predFlow`, `m3PerPuls`, `q`, `timeLeft`,
|
||||
`targetVolumeM3`, `targetProgressPct`, `targetDeltaL`, `predictedRateM3h`,
|
||||
`sumRain`, `avgRain`, `nextDate`, plus the flat measurements snapshot.
|
||||
- **Port 1 (InfluxDB telemetry):** same shape as Port 0, formatted with the
|
||||
`'influxdb'` formatter.
|
||||
- **Port 2 (registration):** at startup the node sends one
|
||||
`{ topic: 'child.register', payload: <node.id>, positionVsParent, distance }`
|
||||
to its parent.
|
||||
|
||||
## Events emitted by `source.measurements.emitter`
|
||||
|
||||
The `MeasurementContainer` fires `<type>.measured.<position>` whenever a
|
||||
matching series receives a new value. monster writes:
|
||||
|
||||
- `flow.manual.atequipment` — operator-supplied manual flow.
|
||||
- `flow.measured.<position>` — re-emitted when a child measurement fires
|
||||
(one of `flow.measured.upstream`, `flow.measured.downstream`,
|
||||
`flow.measured.atequipment`).
|
||||
|
||||
## Children accepted
|
||||
|
||||
`measurement` only. The router subscribes to a child's
|
||||
`flow.measured.<position>` events when the child's `config.asset.type` is
|
||||
`'flow'` (or missing). Other asset types are ignored. monster has no
|
||||
position-based filtering — all three positions are wired and the latest
|
||||
value wins for each.
|
||||
@@ -4,7 +4,10 @@
|
||||
"description": "Control module Monsternamekast",
|
||||
"main": "monster.js",
|
||||
"scripts": {
|
||||
"test": "node --test test/basic/*.test.js test/integration/*.test.js test/edge/*.test.js"
|
||||
"test": "node --test test/basic/*.test.js test/integration/*.test.js test/edge/*.test.js",
|
||||
"wiki:contract": "node ../generalFunctions/scripts/wikiGen.js contract ./src/commands/index.js --write ./wiki/Home.md",
|
||||
"wiki:datamodel": "node ../generalFunctions/scripts/wikiGen.js datamodel ./src/specificClass.js --write ./wiki/Home.md",
|
||||
"wiki:all": "npm run wiki:contract && npm run wiki:datamodel"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
|
||||
42
src/commands/handlers.js
Normal file
42
src/commands/handlers.js
Normal file
@@ -0,0 +1,42 @@
|
||||
'use strict';
|
||||
|
||||
// Handlers for monster input topics. Each is a pure function over the
|
||||
// domain (source). Unit conversion for incoming flow happens in the
|
||||
// handler (the legacy nodeClass did it inline) — anything else inbound
|
||||
// is passed straight through to source.handleInput.
|
||||
|
||||
const { convert } = require('generalFunctions');
|
||||
|
||||
exports.cmdStart = (source, msg) => {
|
||||
source.handleInput('i_start', Boolean(msg.payload));
|
||||
};
|
||||
|
||||
exports.setSchedule = (source, msg) => {
|
||||
source.handleInput('monsternametijden', msg.payload);
|
||||
};
|
||||
|
||||
exports.setRain = (source, msg) => {
|
||||
source.handleInput('rain_data', msg.payload);
|
||||
};
|
||||
|
||||
exports.dataFlow = (source, msg, ctx) => {
|
||||
const log = ctx?.logger || source.logger;
|
||||
const value = Number(msg.payload?.value);
|
||||
const unit = msg.payload?.unit;
|
||||
if (!Number.isFinite(value) || !unit) {
|
||||
log?.warn?.('data.flow payload must include numeric value and unit.');
|
||||
return;
|
||||
}
|
||||
let converted = value;
|
||||
try { converted = convert(value).from(unit).to('m3/h'); }
|
||||
catch (err) { log?.warn?.(`data.flow unit conversion failed: ${err.message}`); return; }
|
||||
source.handleInput('input_q', { value: converted, unit: 'm3/h' });
|
||||
};
|
||||
|
||||
exports.setMode = (source, msg) => {
|
||||
if (typeof source.setMode === 'function') source.setMode(msg.payload);
|
||||
};
|
||||
|
||||
exports.setModelPrediction = (source, msg) => {
|
||||
if (typeof source.setModelPrediction === 'function') source.setModelPrediction(msg.payload);
|
||||
};
|
||||
47
src/commands/index.js
Normal file
47
src/commands/index.js
Normal file
@@ -0,0 +1,47 @@
|
||||
'use strict';
|
||||
|
||||
// monster command registry. Canonical names follow CONTRACTS.md §1.
|
||||
// Legacy names (i_start, monsternametijden, rain_data, input_q, setMode,
|
||||
// model_prediction) are surfaced as aliases — they log a one-time
|
||||
// deprecation warning on first use and are removed in Phase 7.
|
||||
|
||||
const handlers = require('./handlers');
|
||||
|
||||
module.exports = [
|
||||
{
|
||||
topic: 'cmd.start',
|
||||
aliases: ['i_start'],
|
||||
payloadSchema: { type: 'any' },
|
||||
handler: handlers.cmdStart,
|
||||
},
|
||||
{
|
||||
topic: 'set.schedule',
|
||||
aliases: ['monsternametijden'],
|
||||
payloadSchema: { type: 'any' },
|
||||
handler: handlers.setSchedule,
|
||||
},
|
||||
{
|
||||
topic: 'set.rain',
|
||||
aliases: ['rain_data'],
|
||||
payloadSchema: { type: 'any' },
|
||||
handler: handlers.setRain,
|
||||
},
|
||||
{
|
||||
topic: 'data.flow',
|
||||
aliases: ['input_q'],
|
||||
payloadSchema: { type: 'object' },
|
||||
handler: handlers.dataFlow,
|
||||
},
|
||||
{
|
||||
topic: 'set.mode',
|
||||
aliases: ['setMode'],
|
||||
payloadSchema: { type: 'any' },
|
||||
handler: handlers.setMode,
|
||||
},
|
||||
{
|
||||
topic: 'set.model-prediction',
|
||||
aliases: ['model_prediction'],
|
||||
payloadSchema: { type: 'any' },
|
||||
handler: handlers.setModelPrediction,
|
||||
},
|
||||
];
|
||||
59
src/flow/flowTracker.js
Normal file
59
src/flow/flowTracker.js
Normal file
@@ -0,0 +1,59 @@
|
||||
'use strict';
|
||||
|
||||
// Flow tracking — manual override + measured-child fan-in + effective
|
||||
// blend (mean of the two when both present). Wraps the
|
||||
// MeasurementContainer so the domain stays read-only on flow state.
|
||||
|
||||
const POSITIONS = ['upstream', 'downstream', 'atequipment'];
|
||||
|
||||
class FlowTracker {
|
||||
constructor({ measurements, logger }) {
|
||||
this.measurements = measurements;
|
||||
this.logger = logger;
|
||||
this.manualFlow = null;
|
||||
}
|
||||
|
||||
updateManualFlow(payload = {}) {
|
||||
const value = Number(payload.value);
|
||||
if (!Number.isFinite(value)) return;
|
||||
const unit = payload.unit || 'm3/h';
|
||||
this.manualFlow = value;
|
||||
this.measurements.type('flow').variant('manual').position('atequipment')
|
||||
.value(value, Date.now(), unit);
|
||||
}
|
||||
|
||||
handleMeasuredFlow(eventData) {
|
||||
const value = Number(eventData?.value);
|
||||
if (!Number.isFinite(value)) return;
|
||||
const position = String(eventData.position || 'atequipment').toLowerCase();
|
||||
const unit = eventData.unit || 'm3/h';
|
||||
this.measurements.type('flow').variant('measured').position(position)
|
||||
.value(value, eventData.timestamp || Date.now(), unit);
|
||||
}
|
||||
|
||||
getMeasuredFlow() {
|
||||
const values = [];
|
||||
for (const pos of POSITIONS) {
|
||||
const v = this.measurements.type('flow').variant('measured').position(pos).getCurrentValue();
|
||||
if (Number.isFinite(v)) values.push(v);
|
||||
}
|
||||
if (!values.length) return null;
|
||||
return values.reduce((s, c) => s + c, 0) / values.length;
|
||||
}
|
||||
|
||||
getManualFlow() {
|
||||
const v = this.measurements.type('flow').variant('manual').position('atequipment').getCurrentValue();
|
||||
return Number.isFinite(v) ? v : null;
|
||||
}
|
||||
|
||||
getEffectiveFlow() {
|
||||
const measured = this.getMeasuredFlow();
|
||||
const manual = this.getManualFlow();
|
||||
if (measured != null && manual != null) return (measured + manual) / 2;
|
||||
if (measured != null) return measured;
|
||||
if (manual != null) return manual;
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = FlowTracker;
|
||||
70
src/io/output.js
Normal file
70
src/io/output.js
Normal file
@@ -0,0 +1,70 @@
|
||||
'use strict';
|
||||
|
||||
// Output formatter — assembles the snapshot shape getOutput returns each
|
||||
// tick. Heavy on derived fields (timeToNextPulse, targetDelta, ...) but
|
||||
// every value is read-only on the domain, so this can stay a pure function.
|
||||
|
||||
const params = require('../parameters/parameters');
|
||||
|
||||
function buildOutput(m) {
|
||||
const output = m.measurements.getFlattenedOutput();
|
||||
const flowRate = Number(m.q) || 0;
|
||||
const m3PerPulse = Number(m.m3PerPuls) || 0;
|
||||
const pulseFraction = Number(m.temp_pulse) || 0;
|
||||
const targetVolumeL = Number(m.targetVolume) > 0 ? m.targetVolume : 0;
|
||||
const targetVolumeM3 = targetVolumeL > 0 ? targetVolumeL / 1000 : 0;
|
||||
const flowToNextPulseM3 = m3PerPulse > 0 ? Math.max(0, (1 - pulseFraction) * m3PerPulse) : 0;
|
||||
const timeToNextPulseSec = flowRate > 0 && flowToNextPulseM3 > 0
|
||||
? Math.round((flowToNextPulseM3 / (flowRate / 3600)) * 100) / 100
|
||||
: 0;
|
||||
const targetProgressPct = targetVolumeL > 0
|
||||
? Math.round((m.bucketVol / targetVolumeL) * 10000) / 100
|
||||
: 0;
|
||||
const targetDeltaL = targetVolumeL > 0
|
||||
? Math.round((m.bucketVol - targetVolumeL) * 100) / 100
|
||||
: 0;
|
||||
const targetDeltaM3 = targetVolumeL > 0
|
||||
? Math.round((targetDeltaL / 1000) * 10000) / 10000
|
||||
: 0;
|
||||
|
||||
Object.assign(output, {
|
||||
pulse: m.pulse,
|
||||
running: m.running,
|
||||
bucketVol: m.bucketVol,
|
||||
bucketWeight: m.bucketWeight,
|
||||
sumPuls: m.sumPuls,
|
||||
predFlow: m.predFlow,
|
||||
predM3PerSec: m.predM3PerSec,
|
||||
timePassed: m.timePassed,
|
||||
timeLeft: m.timeLeft,
|
||||
m3Total: m.m3Total,
|
||||
q: m.q,
|
||||
nominalFlowMin: m.nominalFlowMin,
|
||||
flowMax: m.flowMax,
|
||||
invalidFlowBounds: m.invalidFlowBounds,
|
||||
minSampleIntervalSec: m.minSampleIntervalSec,
|
||||
missedSamples: m.missedSamples,
|
||||
sampleCooldownMs: params.getSampleCooldownMs(m),
|
||||
maxVolume: m.maxVolume,
|
||||
minVolume: m.minVolume,
|
||||
nextDate: m.nextDate,
|
||||
daysPerYear: m.daysPerYear,
|
||||
m3PerPuls: m.m3PerPuls,
|
||||
m3PerPulse: m.m3PerPuls,
|
||||
pulsesRemaining: Math.max(0, (m.targetPuls || 0) - (m.sumPuls || 0)),
|
||||
pulseFraction,
|
||||
flowToNextPulseM3,
|
||||
timeToNextPulseSec,
|
||||
targetVolumeM3,
|
||||
targetProgressPct,
|
||||
targetDeltaL,
|
||||
targetDeltaM3,
|
||||
predictedRateM3h: params.getPredictedFlowRate(m),
|
||||
sumRain: m.rainAggregator?.sumRain ?? 0,
|
||||
avgRain: m.rainAggregator?.avgRain ?? 0,
|
||||
});
|
||||
|
||||
return output;
|
||||
}
|
||||
|
||||
module.exports = { buildOutput };
|
||||
28
src/io/statusBadge.js
Normal file
28
src/io/statusBadge.js
Normal file
@@ -0,0 +1,28 @@
|
||||
'use strict';
|
||||
|
||||
// Status-badge composition. Three states the editor cares about:
|
||||
// - red ring : config error (flow bounds invalid)
|
||||
// - yellow ring: sampling but cooldown is gating the next pulse
|
||||
// - green dot : sampling normally
|
||||
// - grey ring : idle
|
||||
// Shape mirrors the legacy nodeClass._updateNodeStatus output verbatim.
|
||||
|
||||
const { statusBadge } = require('generalFunctions');
|
||||
const params = require('../parameters/parameters');
|
||||
|
||||
function buildStatusBadge(m) {
|
||||
if (m.invalidFlowBounds) {
|
||||
return statusBadge.error(`Config error: nominalFlowMin (${m.nominalFlowMin}) >= flowMax (${m.flowMax})`);
|
||||
}
|
||||
if (m.running) {
|
||||
const levelText = `${m.bucketVol}/${m.maxVolume} L`;
|
||||
const cooldownMs = params.getSampleCooldownMs(m);
|
||||
if (cooldownMs > 0) {
|
||||
return statusBadge.compose([`SAMPLING (${Math.ceil(cooldownMs / 1000)}s)`, levelText], { fill: 'yellow', shape: 'ring' });
|
||||
}
|
||||
return statusBadge.compose([`AI: RUNNING`, levelText], { fill: 'green', shape: 'dot' });
|
||||
}
|
||||
return statusBadge.idle('AI: IDLE');
|
||||
}
|
||||
|
||||
module.exports = { buildStatusBadge };
|
||||
240
src/nodeClass.js
240
src/nodeClass.js
@@ -1,51 +1,19 @@
|
||||
/**
|
||||
* node class.js
|
||||
*
|
||||
* Encapsulates all node logic in a reusable class. In future updates we can split this into multiple generic classes and use the config to specifiy which ones to use.
|
||||
* This allows us to keep the Node-RED node clean and focused on wiring up the UI and event handlers.
|
||||
*/
|
||||
const { outputUtils, configManager, convert } = require('generalFunctions');
|
||||
const Specific = require('./specificClass');
|
||||
'use strict';
|
||||
|
||||
class nodeClass {
|
||||
/**
|
||||
* Create a Node.
|
||||
* @param {object} uiConfig - Node-RED node configuration.
|
||||
* @param {object} RED - Node-RED runtime API.
|
||||
* @param {object} nodeInstance - The Node-RED node instance.
|
||||
* @param {string} nameOfNode - The name of the node.
|
||||
*/
|
||||
constructor(uiConfig, RED, nodeInstance, nameOfNode) {
|
||||
this.node = nodeInstance;
|
||||
this.RED = RED;
|
||||
this.name = nameOfNode;
|
||||
this.source = null;
|
||||
this.config = null;
|
||||
const { BaseNodeAdapter } = require('generalFunctions');
|
||||
const Monster = require('./specificClass');
|
||||
const commands = require('./commands');
|
||||
|
||||
// Load default & UI config
|
||||
this._loadConfig(uiConfig);
|
||||
class nodeClass extends BaseNodeAdapter {
|
||||
static DomainClass = Monster;
|
||||
static commands = commands;
|
||||
// Tick-driven: sampling integrator (m3PerTick → temp_pulse) needs
|
||||
// wall-clock delta-time once per second.
|
||||
static tickInterval = 1000;
|
||||
static statusInterval = 1000;
|
||||
|
||||
// Instantiate core class
|
||||
this._setupSpecificClass(uiConfig);
|
||||
|
||||
// Wire up event and lifecycle handlers
|
||||
this._bindEvents();
|
||||
this._registerChild();
|
||||
this._startTickLoop();
|
||||
this._attachInputHandler();
|
||||
this._attachCloseHandler();
|
||||
}
|
||||
|
||||
/**
|
||||
* Load and merge default config with user-defined settings.
|
||||
* Uses ConfigManager.buildConfig() for base sections, then adds monster-specific domain config.
|
||||
* @param {object} uiConfig - Raw config from Node-RED UI.
|
||||
*/
|
||||
_loadConfig(uiConfig) {
|
||||
const cfgMgr = new configManager();
|
||||
|
||||
// Build config: base sections + monster-specific domain config
|
||||
this.config = cfgMgr.buildConfig(this.name, uiConfig, this.node.id, {
|
||||
buildDomainConfig(uiConfig) {
|
||||
return {
|
||||
constraints: {
|
||||
samplingtime: Number(uiConfig.samplingtime) || 0,
|
||||
minVolume: Number(uiConfig.minvolume ?? uiConfig.minVolume) || 5,
|
||||
@@ -55,186 +23,14 @@ class nodeClass {
|
||||
maxRainRef: Number(uiConfig.maxRainRef) || 10,
|
||||
minSampleIntervalSec: Number(uiConfig.minSampleIntervalSec) || 60,
|
||||
},
|
||||
});
|
||||
|
||||
this.config.functionality = {
|
||||
...this.config.functionality,
|
||||
role: 'samplingCabinet',
|
||||
aquonSampleName: uiConfig.aquon_sample_name || undefined,
|
||||
functionality: { role: 'samplingCabinet', aquonSampleName: uiConfig.aquon_sample_name || undefined },
|
||||
asset: { emptyWeightBucket: Number(uiConfig.emptyWeightBucket) || 3 },
|
||||
};
|
||||
|
||||
this.config.asset = {
|
||||
...this.config.asset,
|
||||
emptyWeightBucket: Number(uiConfig.emptyWeightBucket) || 3,
|
||||
};
|
||||
|
||||
// Utility for formatting outputs
|
||||
this._output = new outputUtils();
|
||||
}
|
||||
|
||||
/**
|
||||
* Instantiate the core logic and store as source.
|
||||
*/
|
||||
_setupSpecificClass(uiConfig) {
|
||||
this.source = new Specific(this.config);
|
||||
|
||||
if (uiConfig?.aquon_sample_name) {
|
||||
this.source.aquonSampleName = uiConfig.aquon_sample_name;
|
||||
}
|
||||
|
||||
this.node.source = this.source;
|
||||
}
|
||||
|
||||
/**
|
||||
* Bind events to Node-RED status updates.
|
||||
*/
|
||||
_bindEvents() {}
|
||||
|
||||
_updateNodeStatus() {
|
||||
const m = this.source;
|
||||
try {
|
||||
const bucketVol = m.bucketVol;
|
||||
const maxVolume = m.maxVolume;
|
||||
const state = m.running;
|
||||
const mode = 'AI';
|
||||
const flowMin = m.nominalFlowMin;
|
||||
const flowMax = m.flowMax;
|
||||
|
||||
if (m.invalidFlowBounds) {
|
||||
return {
|
||||
fill: 'red',
|
||||
shape: 'ring',
|
||||
text: `Config error: nominalFlowMin (${flowMin}) >= flowMax (${flowMax})`,
|
||||
};
|
||||
}
|
||||
|
||||
if (state) {
|
||||
const levelText = `${bucketVol}/${maxVolume} L`;
|
||||
const cooldownMs = typeof m.getSampleCooldownMs === 'function'
|
||||
? m.getSampleCooldownMs()
|
||||
: 0;
|
||||
|
||||
if (cooldownMs > 0) {
|
||||
const cooldownSec = Math.ceil(cooldownMs / 1000);
|
||||
return { fill: 'yellow', shape: 'ring', text: `SAMPLING (${cooldownSec}s) ${levelText}` };
|
||||
}
|
||||
|
||||
return { fill: 'green', shape: 'dot', text: `${mode}: RUNNING ${levelText}` };
|
||||
}
|
||||
|
||||
return { fill: 'grey', shape: 'ring', text: `${mode}: IDLE` };
|
||||
} catch (error) {
|
||||
this.node.error(`Error in updateNodeStatus: ${error.message}`);
|
||||
return { fill: 'red', shape: 'ring', text: 'Status Error' };
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Register this node as a child upstream and downstream.
|
||||
* Delayed to avoid Node-RED startup race conditions.
|
||||
*/
|
||||
_registerChild() {
|
||||
setTimeout(() => {
|
||||
this.node.send([
|
||||
null,
|
||||
null,
|
||||
{ topic: 'registerChild', payload: this.config.general.id, positionVsParent: this.config?.functionality?.positionVsParent || 'atEquipment' },
|
||||
]);
|
||||
}, 100);
|
||||
}
|
||||
|
||||
/**
|
||||
* Start the periodic tick loop.
|
||||
*/
|
||||
_startTickLoop() {
|
||||
setTimeout(() => {
|
||||
this._tickInterval = setInterval(() => this._tick(), 1000);
|
||||
this._statusInterval = setInterval(() => {
|
||||
this.node.status(this._updateNodeStatus());
|
||||
}, 1000);
|
||||
}, 1000);
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute a single tick: update measurement, format and send outputs.
|
||||
*/
|
||||
_tick() {
|
||||
this.source.tick();
|
||||
|
||||
const raw = this.source.getOutput();
|
||||
const processMsg = this._output.formatMsg(raw, this.source.config, 'process');
|
||||
const influxMsg = this._output.formatMsg(raw, this.source.config, 'influxdb');
|
||||
|
||||
this.node.send([processMsg, influxMsg]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Attach the node's input handler, routing control messages to the class.
|
||||
*/
|
||||
_attachInputHandler() {
|
||||
this.node.on('input', (msg, send, done) => {
|
||||
const m = this.source;
|
||||
try {
|
||||
switch (msg.topic) {
|
||||
case 'input_q': {
|
||||
const value = Number(msg.payload?.value);
|
||||
const unit = msg.payload?.unit;
|
||||
if (!Number.isFinite(value) || !unit) {
|
||||
this.node.warn('input_q payload must include numeric value and unit.');
|
||||
break;
|
||||
}
|
||||
let converted = value;
|
||||
try {
|
||||
converted = convert(value).from(unit).to('m3/h');
|
||||
} catch (error) {
|
||||
this.node.warn(`input_q unit conversion failed: ${error.message}`);
|
||||
break;
|
||||
}
|
||||
m.handleInput('input_q', { value: converted, unit: 'm3/h' });
|
||||
break;
|
||||
}
|
||||
case 'i_start':
|
||||
case 'monsternametijden':
|
||||
case 'rain_data':
|
||||
m.handleInput(msg.topic, msg.payload);
|
||||
break;
|
||||
case 'registerChild': {
|
||||
const childId = msg.payload;
|
||||
const childObj = this.RED.nodes.getNode(childId);
|
||||
if (childObj?.source) {
|
||||
m.childRegistrationUtils.registerChild(childObj.source, msg.positionVsParent);
|
||||
}
|
||||
break;
|
||||
}
|
||||
case 'setMode':
|
||||
m.setMode(msg.payload);
|
||||
break;
|
||||
case 'model_prediction':
|
||||
if (typeof m.setModelPrediction === 'function') {
|
||||
m.setModelPrediction(msg.payload);
|
||||
}
|
||||
break;
|
||||
default:
|
||||
m.logger?.warn(`Unknown topic: ${msg.topic}`);
|
||||
break;
|
||||
}
|
||||
} catch (error) {
|
||||
this.node.error(`Error handling input (${msg?.topic}): ${error?.message || error}`);
|
||||
} finally {
|
||||
if (typeof done === 'function') done();
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Clean up timers and intervals when Node-RED stops the node.
|
||||
*/
|
||||
_attachCloseHandler() {
|
||||
this.node.on('close', (done) => {
|
||||
clearInterval(this._tickInterval);
|
||||
clearInterval(this._statusInterval);
|
||||
if (typeof done === 'function') done();
|
||||
});
|
||||
extraSetup() {
|
||||
const uiSampleName = this.config?.functionality?.aquonSampleName;
|
||||
if (uiSampleName) this.source.aquonSampleName = uiSampleName;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
56
src/parameters/parameters.js
Normal file
56
src/parameters/parameters.js
Normal file
@@ -0,0 +1,56 @@
|
||||
'use strict';
|
||||
|
||||
// Sampling-cabinet boundary + target math + rain-scaled flow prediction.
|
||||
// All operations are pure given a domain handle — the domain owns the
|
||||
// mutable fields (maxVolume, targetPuls, …) so legacy tests that read
|
||||
// `monster.maxVolume` keep working.
|
||||
|
||||
const RAIN_STALE_MS = 2 * 60 * 60 * 1000;
|
||||
|
||||
function applyBoundsAndTargets(m) {
|
||||
m.maxVolume = m.maxWeight - m.emptyWeightBucket;
|
||||
m.minPuls = Math.round(m.minVolume / m.volume_pulse);
|
||||
m.maxPuls = Math.round(m.maxVolume / m.volume_pulse);
|
||||
m.absMaxPuls = Math.round(m.cap_volume / m.volume_pulse);
|
||||
m.targetVolume = m.minVolume * Math.sqrt(m.maxVolume / m.minVolume);
|
||||
m.targetPuls = Math.round(m.targetVolume / m.volume_pulse);
|
||||
}
|
||||
|
||||
function validateFlowBounds(m) {
|
||||
const min = Number(m.nominalFlowMin);
|
||||
const max = Number(m.flowMax);
|
||||
const valid = Number.isFinite(min) && Number.isFinite(max) && min >= 0 && max > 0 && min < max;
|
||||
m.invalidFlowBounds = !valid;
|
||||
if (!valid) m.logger.warn(`Invalid flow bounds. nominalFlowMin=${m.nominalFlowMin}, flowMax=${m.flowMax}`);
|
||||
return valid;
|
||||
}
|
||||
|
||||
function getRainIndex(m) {
|
||||
if (!m.lastRainUpdate) return 0;
|
||||
if (Date.now() - m.lastRainUpdate > RAIN_STALE_MS) return 0;
|
||||
return Number.isFinite(m.avgRain) ? m.avgRain : 0;
|
||||
}
|
||||
|
||||
function getPredictedFlowRate(m) {
|
||||
const min = Number(m.nominalFlowMin);
|
||||
const max = Number(m.flowMax);
|
||||
if (!Number.isFinite(min) || !Number.isFinite(max) || min < 0 || max <= 0 || min >= max) return 0;
|
||||
const rainIndex = getRainIndex(m);
|
||||
const scale = Math.max(0, Math.min(1, m.rainMaxRef > 0 ? rainIndex / m.rainMaxRef : 0));
|
||||
return min + (max - min) * scale;
|
||||
}
|
||||
|
||||
function getSampleCooldownMs(m) {
|
||||
if (!m.lastSampleTime) return 0;
|
||||
const remaining = (m.minSampleIntervalSec * 1000) - (Date.now() - m.lastSampleTime);
|
||||
return Math.max(0, remaining);
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
applyBoundsAndTargets,
|
||||
validateFlowBounds,
|
||||
getRainIndex,
|
||||
getPredictedFlowRate,
|
||||
getSampleCooldownMs,
|
||||
RAIN_STALE_MS,
|
||||
};
|
||||
58
src/rain/rainAggregator.js
Normal file
58
src/rain/rainAggregator.js
Normal file
@@ -0,0 +1,58 @@
|
||||
'use strict';
|
||||
|
||||
// Rain-data aggregator — sums per-location hourly precipitation, weighted
|
||||
// by per-hour probability, and stores both the raw and probability-weighted
|
||||
// values keyed by timestamp. sumRain/avgRain feed parameters.getRainIndex
|
||||
// which scales the predicted flow rate between nominalFlowMin and flowMax.
|
||||
|
||||
class RainAggregator {
|
||||
constructor({ logger } = {}) {
|
||||
this.logger = logger;
|
||||
this.aggregatedOutput = {};
|
||||
this.sumRain = 0;
|
||||
this.avgRain = 0;
|
||||
}
|
||||
|
||||
// Returns the aggregated per-location object so callers can chain.
|
||||
// Mutates this.aggregatedOutput / sumRain / avgRain in place.
|
||||
update(value) {
|
||||
if (!value) return this.aggregatedOutput;
|
||||
|
||||
const totalRaw = {};
|
||||
const totalProb = {};
|
||||
let numberOfLocations = 0;
|
||||
|
||||
Object.entries(value).forEach(([locationKey, location]) => {
|
||||
numberOfLocations++;
|
||||
const slot = (this.aggregatedOutput[locationKey] = {
|
||||
tag: { latitude: location.latitude, longitude: location.longitude },
|
||||
precipationRaw: {},
|
||||
precipationProb: {},
|
||||
});
|
||||
|
||||
Object.entries(location.hourly.time).forEach(([key, time]) => {
|
||||
const currTimestamp = new Date(time).getTime();
|
||||
let probability = 100;
|
||||
if (typeof location.hourly.precipitation_probability !== 'undefined') {
|
||||
probability = location.hourly.precipitation_probability[key];
|
||||
}
|
||||
if (probability > 0) probability /= 100;
|
||||
|
||||
if (totalRaw[currTimestamp] === undefined) totalRaw[currTimestamp] = 0;
|
||||
if (totalProb[currTimestamp] === undefined) totalProb[currTimestamp] = 0;
|
||||
|
||||
totalRaw[currTimestamp] += location.hourly.precipitation[key];
|
||||
totalProb[currTimestamp] += location.hourly.precipitation[key] * probability;
|
||||
|
||||
slot.precipationRaw[key] = { val: location.hourly.precipitation[key], time: currTimestamp };
|
||||
slot.precipationProb[key] = { val: probability, time: currTimestamp };
|
||||
});
|
||||
});
|
||||
|
||||
this.sumRain = Object.values(totalProb).reduce((s, v) => s + v, 0);
|
||||
this.avgRain = numberOfLocations > 0 ? this.sumRain / numberOfLocations : 0;
|
||||
return this.aggregatedOutput;
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = RainAggregator;
|
||||
113
src/sampling/samplingProgram.js
Normal file
113
src/sampling/samplingProgram.js
Normal file
@@ -0,0 +1,113 @@
|
||||
'use strict';
|
||||
|
||||
// Sampling program — the time-driven core. Each tick:
|
||||
// 1. on i_start or scheduled date → init a sampling run (m3PerPuls, stop_time)
|
||||
// 2. while running: integrate m3PerTick into temp_pulse; emit a pulse when
|
||||
// it crosses 1 unless the cooldown guard blocks it
|
||||
// 3. after stop_time: clear running state.
|
||||
// flowCalc derives m3PerTick from the latest q (m3/h) and the wall-clock
|
||||
// delta since the last call — runs once per tick before sampling_program.
|
||||
|
||||
const params = require('../parameters/parameters');
|
||||
const { regNextDate } = require('../schedule/schedule');
|
||||
|
||||
function getModelPrediction(m) {
|
||||
const samplingHours = Number(m.sampling_time) || 0;
|
||||
const predictedRate = params.getPredictedFlowRate(m);
|
||||
const fallbackRate = m.flowTracker.getEffectiveFlow();
|
||||
const flowM3PerHour = predictedRate > 0 ? predictedRate : fallbackRate;
|
||||
m.predFlow = Math.max(0, flowM3PerHour * samplingHours);
|
||||
return m.predFlow;
|
||||
}
|
||||
|
||||
function flowCalc(m) {
|
||||
const timePassed = m.flowTime > 0 ? (Date.now() - m.flowTime) / 1000 : 0;
|
||||
m.m3PerTick = (m.q / 60 / 60) * timePassed;
|
||||
m.flowTime = Date.now();
|
||||
}
|
||||
|
||||
function _beginRun(m) {
|
||||
m.running = true;
|
||||
m.temp_pulse = 0;
|
||||
m.pulse = false;
|
||||
m.updateBucketVol(0);
|
||||
m.sumPuls = 0;
|
||||
m.m3Total = 0;
|
||||
m.timePassed = 0;
|
||||
m.timeLeft = 0;
|
||||
m.predM3PerSec = 0;
|
||||
|
||||
getModelPrediction(m);
|
||||
m.m3PerPuls = Math.round(m.predFlow / m.targetPuls);
|
||||
m.predM3PerSec = m.predFlow / m.sampling_time / 60 / 60;
|
||||
m.start_time = Date.now();
|
||||
m.stop_time = Date.now() + (m.sampling_time * 60 * 60 * 1000);
|
||||
|
||||
regNextDate(m, m.monsternametijden);
|
||||
m.i_start = false;
|
||||
}
|
||||
|
||||
function _endRun(m) {
|
||||
m.m3PerPuls = 0;
|
||||
m.temp_pulse = 0;
|
||||
m.pulse = false;
|
||||
m.updateBucketVol(0);
|
||||
m.sumPuls = 0;
|
||||
m.timePassed = 0;
|
||||
m.timeLeft = 0;
|
||||
m.predFlow = 0;
|
||||
m.predM3PerSec = 0;
|
||||
m.m3Total = 0;
|
||||
m.running = false;
|
||||
}
|
||||
|
||||
function _maybeEmitPulse(m) {
|
||||
if (!(m.temp_pulse >= 1 && m.sumPuls < m.absMaxPuls)) {
|
||||
if (m.pulse) m.pulse = false;
|
||||
return;
|
||||
}
|
||||
|
||||
const now = Date.now();
|
||||
const cooldownMs = m.minSampleIntervalSec * 1000;
|
||||
const blocked = m.lastSampleTime && (now - m.lastSampleTime) < cooldownMs;
|
||||
|
||||
if (blocked) {
|
||||
m.missedSamples++;
|
||||
m.pulse = false;
|
||||
m.temp_pulse = Math.min(m.temp_pulse, 1);
|
||||
if (!m.lastSampleWarnTime || (now - m.lastSampleWarnTime) > cooldownMs) {
|
||||
m.lastSampleWarnTime = now;
|
||||
m.logger.warn(`Sampling too fast. Cooldown active for ${Math.ceil((cooldownMs - (now - m.lastSampleTime)) / 1000)}s.`);
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
m.temp_pulse -= 1;
|
||||
m.pulse = true;
|
||||
m.lastSampleTime = now;
|
||||
m.sumPuls++;
|
||||
m.updateBucketVol(Math.round(m.sumPuls * m.volume_pulse * 100) / 100);
|
||||
}
|
||||
|
||||
function samplingProgram(m) {
|
||||
if (((m.i_start) || (Date.now() >= m.nextDate)) && !m.running) {
|
||||
if (!params.validateFlowBounds(m)) {
|
||||
m.running = false;
|
||||
m.i_start = false;
|
||||
return;
|
||||
}
|
||||
_beginRun(m);
|
||||
}
|
||||
|
||||
if (m.stop_time > Date.now()) {
|
||||
m.timePassed = Math.round((Date.now() - m.start_time) / 1000);
|
||||
m.timeLeft = Math.round((m.stop_time - Date.now()) / 1000);
|
||||
m.temp_pulse += m.m3PerTick / m.m3PerPuls;
|
||||
m.m3Total += m.m3PerTick;
|
||||
_maybeEmitPulse(m);
|
||||
} else if (m.running) {
|
||||
_endRun(m);
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { samplingProgram, flowCalc, getModelPrediction };
|
||||
42
src/schedule/schedule.js
Normal file
42
src/schedule/schedule.js
Normal file
@@ -0,0 +1,42 @@
|
||||
'use strict';
|
||||
|
||||
// AQUON sample schedule helpers. updateMonsternametijden validates the
|
||||
// row shape before storing; regNextDate walks the rows to find the next
|
||||
// future START_DATE for the configured aquonSampleName and counts how
|
||||
// many of those fall in the current calendar year.
|
||||
|
||||
function updateMonsternametijden(m, value) {
|
||||
if (!m.init || !value || Object.keys(value).length === 0) return;
|
||||
if (
|
||||
typeof value[0]?.SAMPLE_NAME !== 'undefined' &&
|
||||
typeof value[0]?.DESCRIPTION !== 'undefined' &&
|
||||
typeof value[0]?.SAMPLED_DATE !== 'undefined' &&
|
||||
typeof value[0]?.START_DATE !== 'undefined' &&
|
||||
typeof value[0]?.END_DATE !== 'undefined'
|
||||
) {
|
||||
m.monsternametijden = value;
|
||||
regNextDate(m, value);
|
||||
}
|
||||
}
|
||||
|
||||
function regNextDate(m, monsternametijden) {
|
||||
let next_date = new Date(new Date().setFullYear(new Date().getFullYear() + 1));
|
||||
let n_days_remaining = 0;
|
||||
|
||||
if (typeof monsternametijden !== 'undefined') {
|
||||
Object.values(monsternametijden).forEach((line) => {
|
||||
if (line.START_DATE === 'NULL') return;
|
||||
const curr_date_conv = new Date(line.START_DATE);
|
||||
const curr_date = curr_date_conv.getTime();
|
||||
if (line.SAMPLE_NAME === m.aquonSampleName && curr_date > Date.now()) {
|
||||
if (curr_date < next_date) next_date = curr_date;
|
||||
if (new Date().getFullYear() === curr_date_conv.getFullYear()) n_days_remaining++;
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
m.daysPerYear = n_days_remaining;
|
||||
m.nextDate = next_date;
|
||||
}
|
||||
|
||||
module.exports = { updateMonsternametijden, regNextDate };
|
||||
File diff suppressed because it is too large
Load Diff
311
wiki/Home.md
Normal file
311
wiki/Home.md
Normal file
@@ -0,0 +1,311 @@
|
||||
# monster
|
||||
|
||||
> **Reflects code as of `2a6a0bc` · regenerated `2026-05-11` via `npm run wiki:all`**
|
||||
> If this banner is stale, the page may be out of date. Treat as informative, not authoritative.
|
||||
|
||||
## 1. What this node is
|
||||
|
||||
**monster** is an S88 Unit that runs an AQUON-scheduled flow-proportional sampling program. It aggregates measured + manual flow, blends a rain-scaled prediction, and emits a `pulse` whenever the integrated volume crosses `m³ per pulse`. Drives the physical "monsternamekast" (composite sampling cabinet) on a wastewater treatment plant.
|
||||
|
||||
## 2. Position in the platform
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
parent[plant parent<br/>Process Cell]:::pc
|
||||
monster[monster<br/>Unit]:::unit
|
||||
flow_up[measurement<br/>type=flow<br/>position=upstream]:::ctrl
|
||||
flow_at[measurement<br/>type=flow<br/>position=atequipment]:::ctrl
|
||||
op[(operator / AQUON)]
|
||||
weather[(Open-Meteo)]
|
||||
|
||||
flow_up -->|flow.measured.upstream| monster
|
||||
flow_at -->|flow.measured.atequipment| monster
|
||||
op -->|set.schedule / data.flow / cmd.start| monster
|
||||
weather -->|set.rain| monster
|
||||
monster -->|child.register| parent
|
||||
monster -.evt.output.-> parent
|
||||
classDef pc fill:#0c99d9,color:#fff
|
||||
classDef unit fill:#50a8d9,color:#000
|
||||
classDef ctrl fill:#a9daee,color:#000
|
||||
```
|
||||
|
||||
S88 colours: Process Cell `#0c99d9`, Unit `#50a8d9`, Control Module `#a9daee`. Source of truth: `.claude/rules/node-red-flow-layout.md`.
|
||||
|
||||
## 3. Capability matrix
|
||||
|
||||
| Capability | Status | Notes |
|
||||
|---|---|---|
|
||||
| Flow-proportional sampling pulse | ✅ | Triggered when integrated `temp_pulse` ≥ 1. |
|
||||
| Time-bounded sampling run | ✅ | Run length governed by `constraints.samplingtime` (hours). |
|
||||
| AQUON schedule auto-start | ✅ | `set.schedule` parses AQUON rows; `nextDate` arms the next run. |
|
||||
| Rain-scaled flow prediction | ✅ | `set.rain` aggregates Open-Meteo hourly precipitation into `sumRain` / `avgRain`. |
|
||||
| Measured + manual flow blend | ✅ | `flowTracker.getEffectiveFlow()` picks measured if recent, else manual. |
|
||||
| Minimum sample-interval cooldown | ✅ | Skips pulses inside `minSampleIntervalSec` window. |
|
||||
| Bucket / weight tracking | ✅ | `bucketVol`, `bucketWeight` track the composite container. |
|
||||
| Sub-sample volume override | ❌ | `subSampleVolume` fixed at 50 mL per schema. |
|
||||
| Stateful FSM | ❌ | Monster is run/idle only — no formal state machine. |
|
||||
|
||||
## 4. Code map
|
||||
|
||||
```mermaid
|
||||
flowchart TB
|
||||
subgraph nodeRED["nodeClass.js — adapter (BaseNodeAdapter)"]
|
||||
nc["buildDomainConfig()<br/>static DomainClass = Monster<br/>static commands"]
|
||||
end
|
||||
subgraph domain["specificClass.js — orchestrator (BaseDomain)"]
|
||||
sc["Monster.configure()<br/>wires concerns, ChildRouter rules<br/>tick() → flowCalc → samplingProgram"]
|
||||
end
|
||||
subgraph concerns["src/ concern modules"]
|
||||
parameters["parameters/<br/>bounds + targets + rain index"]
|
||||
flow["flow/<br/>FlowTracker (measured + manual)"]
|
||||
rain["rain/<br/>RainAggregator (sum + avg)"]
|
||||
schedule["schedule/<br/>AQUON next-date parser"]
|
||||
sampling["sampling/<br/>samplingProgram + flowCalc"]
|
||||
io["io/<br/>output + statusBadge"]
|
||||
commands["commands/<br/>topic registry + handlers"]
|
||||
end
|
||||
nc --> sc
|
||||
sc --> parameters
|
||||
sc --> flow
|
||||
sc --> rain
|
||||
sc --> schedule
|
||||
sc --> sampling
|
||||
sc --> io
|
||||
nc --> commands
|
||||
```
|
||||
|
||||
| Module | Owns | Read first if you're changing… |
|
||||
|---|---|---|
|
||||
| `parameters/` | Bounds (`minPuls`, `absMaxPuls`, `targetPuls`), rain-index lookup, predicted-flow rate. | Sampling bounds, rain scaling math. |
|
||||
| `flow/` | `FlowTracker` — measured-child latch + manual flow + effective-flow pick. | Flow source priority, dead-band logic. |
|
||||
| `rain/` | `RainAggregator` — fold hourly Open-Meteo rows into `sumRain` / `avgRain`. | Rain inputs, forecast horizon. |
|
||||
| `schedule/` | AQUON schedule parsing, `nextDate` + `daysPerYear` derivation. | Schedule arming, sample-name filtering. |
|
||||
| `sampling/` | `_beginRun` / `_endRun` / `_maybeEmitPulse` — pulse integrator + cooldown guard. | Pulse timing, cooldown behaviour. |
|
||||
| `io/` | `buildOutput`, `buildStatusBadge`. | Port-0 payload shape, status badge text. |
|
||||
| `commands/` | Topic registry + payload validation + unit conversion. | New input topics, alias deprecation. |
|
||||
|
||||
## 5. Topic contract
|
||||
|
||||
> **Auto-generated** from `src/commands/index.js`. Do NOT hand-edit between the markers. Re-run `npm run wiki:contract`.
|
||||
|
||||
<!-- BEGIN AUTOGEN: topic-contract -->
|
||||
|
||||
| Canonical topic | Aliases | Payload | Effect |
|
||||
|---|---|---|---|
|
||||
| `cmd.start` | `i_start` | `any` | Triggers an action / sequence — not idempotent. |
|
||||
| `set.schedule` | `monsternametijden` | `any` | Replaces the named state value with the supplied payload. |
|
||||
| `set.rain` | `rain_data` | `any` | Replaces the named state value with the supplied payload. |
|
||||
| `data.flow` | `input_q` | `object` | Pushes a value into the node's measurement stream. |
|
||||
| `set.mode` | `setMode` | `any` | Replaces the named state value with the supplied payload. |
|
||||
| `set.model-prediction` | `model_prediction` | `any` | Replaces the named state value with the supplied payload. |
|
||||
|
||||
<!-- END AUTOGEN: topic-contract -->
|
||||
|
||||
## 6. Child registration
|
||||
|
||||
Mirrors the `ChildRouter` declaration in `specificClass.js → configure()`. Monster only accepts `measurement` children whose `asset.type` is `flow` (or unset).
|
||||
|
||||
```mermaid
|
||||
flowchart LR
|
||||
subgraph kids["accepted children (softwareType)"]
|
||||
m_up["measurement<br/>asset.type=flow<br/>position=upstream"]:::ctrl
|
||||
m_at["measurement<br/>asset.type=flow<br/>position=atequipment"]:::ctrl
|
||||
m_dn["measurement<br/>asset.type=flow<br/>position=downstream"]:::ctrl
|
||||
end
|
||||
m_up -->|flow.measured.upstream| ft[FlowTracker.handleMeasuredFlow]
|
||||
m_at -->|flow.measured.atequipment| ft
|
||||
m_dn -->|flow.measured.downstream| ft
|
||||
ft --> eff[getEffectiveFlow]
|
||||
classDef ctrl fill:#a9daee,color:#000
|
||||
```
|
||||
|
||||
| softwareType | filter | wired to | side-effect |
|
||||
|---|---|---|---|
|
||||
| `measurement` | `asset.type=flow` (or missing) | `flowTracker.handleMeasuredFlow` | Latches latest measured flow for `getEffectiveFlow`. |
|
||||
| `measurement` | `asset.type` anything else | _ignored_ | Logged once at register. |
|
||||
|
||||
## 7. Lifecycle — the sampling-program loop
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant child as measurement child
|
||||
participant ops as operator / AQUON
|
||||
participant monster as monster
|
||||
participant ft as flowTracker
|
||||
participant sp as samplingProgram
|
||||
participant out as Port-0 output
|
||||
|
||||
child->>monster: flow.measured.<position>
|
||||
ops->>monster: set.schedule / cmd.start / data.flow
|
||||
Note over monster: every 1000 ms tick
|
||||
monster->>ft: getEffectiveFlow()
|
||||
monster->>monster: flowCalc → m3PerTick
|
||||
monster->>sp: samplingProgram
|
||||
alt cmd.start OR Date.now() ≥ nextDate
|
||||
sp->>sp: validateFlowBounds → _beginRun
|
||||
end
|
||||
alt running AND stop_time > now
|
||||
sp->>sp: integrate temp_pulse += m3PerTick / m3PerPuls
|
||||
sp->>sp: _maybeEmitPulse (cooldown-guarded)
|
||||
else stop_time elapsed
|
||||
sp->>sp: _endRun
|
||||
end
|
||||
monster->>out: msg{topic, payload (delta-compressed)}
|
||||
```
|
||||
|
||||
One pulse per integrated `m³ per pulse`. The cooldown guard suppresses pulses inside `minSampleIntervalSec` and increments `missedSamples`.
|
||||
|
||||
## 8. Data model — `getOutput()`
|
||||
|
||||
What lands on Port 0. Built in `buildOutput()` from `m.measurements.getFlattenedOutput()` plus the sampling-run snapshot.
|
||||
|
||||
<!-- BEGIN AUTOGEN: data-model -->
|
||||
|
||||
| Key | Type | Unit | Sample |
|
||||
|---|---|---|---|
|
||||
| `avgRain` | number | — | `0` |
|
||||
| `bucketVol` | number | — | `0` |
|
||||
| `bucketWeight` | number | — | `0` |
|
||||
| `daysPerYear` | number | — | `0` |
|
||||
| `flowMax` | undefined | — | `null` |
|
||||
| `flowToNextPulseM3` | number | — | `0` |
|
||||
| `invalidFlowBounds` | boolean | — | `false` |
|
||||
| `m3PerPuls` | number | — | `0` |
|
||||
| `m3PerPulse` | number | — | `0` |
|
||||
| `m3Total` | number | — | `0` |
|
||||
| `maxVolume` | number | — | `20` |
|
||||
| `minSampleIntervalSec` | number | — | `60` |
|
||||
| `minVolume` | number | — | `5` |
|
||||
| `missedSamples` | number | — | `0` |
|
||||
| `nextDate` | undefined | — | `null` |
|
||||
| `nominalFlowMin` | undefined | — | `null` |
|
||||
| `predFlow` | number | — | `0` |
|
||||
| `predM3PerSec` | number | — | `0` |
|
||||
| `predictedRateM3h` | number | — | `0` |
|
||||
| `pulse` | boolean | — | `false` |
|
||||
| `pulseFraction` | number | — | `0` |
|
||||
| `pulsesRemaining` | number | — | `200` |
|
||||
| `q` | number | — | `0` |
|
||||
| `running` | boolean | — | `false` |
|
||||
| `sampleCooldownMs` | number | — | `0` |
|
||||
| `sumPuls` | number | — | `0` |
|
||||
| `sumRain` | number | — | `0` |
|
||||
| `targetDeltaL` | number | — | `-10` |
|
||||
| `targetDeltaM3` | number | — | `-0.01` |
|
||||
| `targetProgressPct` | number | — | `0` |
|
||||
| `targetVolumeM3` | number | — | `0.01` |
|
||||
| `timeLeft` | number | — | `0` |
|
||||
| `timePassed` | number | — | `0` |
|
||||
| `timeToNextPulseSec` | number | — | `0` |
|
||||
|
||||
<!-- END AUTOGEN: data-model -->
|
||||
|
||||
**Concrete sample** (mid-run snapshot):
|
||||
|
||||
```json
|
||||
{
|
||||
"pulse": false,
|
||||
"running": true,
|
||||
"bucketVol": 1.25,
|
||||
"sumPuls": 25,
|
||||
"predFlow": 240.0,
|
||||
"m3PerPuls": 4,
|
||||
"q": 215.4,
|
||||
"timeLeft": 12340,
|
||||
"targetVolumeM3": 0.005,
|
||||
"targetProgressPct": 41.6,
|
||||
"sumRain": 3.2,
|
||||
"avgRain": 0.13,
|
||||
"nextDate": 1746940800000
|
||||
}
|
||||
```
|
||||
|
||||
Concrete samples must come from a known-good test run. Regenerate when concern modules change shape.
|
||||
|
||||
## 9. Configuration — editor form ↔ config keys
|
||||
|
||||
```mermaid
|
||||
flowchart TB
|
||||
subgraph editor["Node-RED editor form"]
|
||||
f1[Sampling time hr]
|
||||
f2[Sampling period hr]
|
||||
f3[Min volume L]
|
||||
f4[Max weight kg]
|
||||
f5[Empty bucket weight kg]
|
||||
f6[Flowmeter on/off]
|
||||
f7[Min sample interval s]
|
||||
end
|
||||
subgraph config["Domain config slice"]
|
||||
c1[constraints.samplingtime]
|
||||
c2[constraints.samplingperiod]
|
||||
c3[constraints.minVolume]
|
||||
c4[constraints.maxWeight]
|
||||
c5[asset.emptyWeightBucket]
|
||||
c6[constraints.flowmeter]
|
||||
c7[constraints.minSampleIntervalSec]
|
||||
end
|
||||
f1 --> c1
|
||||
f2 --> c2
|
||||
f3 --> c3
|
||||
f4 --> c4
|
||||
f5 --> c5
|
||||
f6 --> c6
|
||||
f7 --> c7
|
||||
```
|
||||
|
||||
| Form field | Config key | Default | Range | Where used |
|
||||
|---|---|---|---|---|
|
||||
| Sampling time (hr) | `constraints.samplingtime` | `0` | ≥ 0 | run length, `predFlow` |
|
||||
| Sampling period (hr) | `constraints.samplingperiod` | `24` | ≥ 1 | schedule arming |
|
||||
| Min volume (L) | `constraints.minVolume` | `5` | ≥ 5 | bounds + invalid-flow guard |
|
||||
| Max weight (kg) | `constraints.maxWeight` | `23` | ≤ 23 | bucket overload |
|
||||
| Empty bucket weight (kg) | `asset.emptyWeightBucket` | `3` | ≥ 0 | `bucketWeight` |
|
||||
| Sub-sample volume (mL) | `constraints.subSampleVolume` | `50` | fixed | per-pulse volume |
|
||||
| Flowmeter present | `constraints.flowmeter` | `true` | bool | proportional vs time mode |
|
||||
| Min sample interval (s) | `constraints.minSampleIntervalSec` | `60` | ≥ 0 | cooldown guard |
|
||||
| Intake speed (m/s) | `constraints.intakeSpeed` | `0.3` | ≥ 0 | informational |
|
||||
| Intake diameter (mm) | `constraints.intakeDiameter` | `12` | ≥ 0 | informational |
|
||||
|
||||
## 10. State chart
|
||||
|
||||
Skipped — monster has no formal state machine. The `running` boolean toggles when `_beginRun` / `_endRun` fire. See section 7 for the sampling-program sequence, which is the closest analogue.
|
||||
|
||||
## 11. Examples
|
||||
|
||||
| Tier | File | What it shows | Status |
|
||||
|---|---|---|---|
|
||||
| Basic | `examples/basic.flow.json` | Inject + manual flow + dashboard, no parent | ✅ in repo |
|
||||
| Integration | `examples/integration.flow.json` | monster + measurement child + AQUON schedule | ✅ in repo |
|
||||
| Dashboard | `examples/monster-dashboard.flow.json` | Live FlowFuse charts (pulse, bucket, predFlow) | ✅ in repo |
|
||||
| Edge | `examples/edge.flow.json` | Cooldown guard + invalid-flow bounds | ✅ in repo |
|
||||
| API | `examples/monster-api-dashboard.flow.json` | dashboardAPI consumer wired in | ✅ in repo |
|
||||
|
||||
One screenshot per tier where helpful. PNG ≤ 200 KB under `wiki/_partial-screenshots/monster/`.
|
||||
|
||||
## 12. Debug recipes
|
||||
|
||||
| Symptom | First thing to check | Where to look |
|
||||
|---|---|---|
|
||||
| `pulse` never fires | Is `running` true? Check `validateFlowBounds` log — invalid bounds short-circuits the run. | `parameters/parameters.js` |
|
||||
| Pulses arrive too fast / skipped | Cooldown guard active. Inspect `missedSamples` + `minSampleIntervalSec`. | `sampling/samplingProgram.js → _maybeEmitPulse` |
|
||||
| `q` always zero | Measured-flow child not registered, manual flow not pushed. Watch Port 2 + `data.flow` history. | `flow/flowTracker.js` |
|
||||
| `nextDate` not arming | `set.schedule` payload didn't include matching `aquonSampleName` row. | `schedule/schedule.js → regNextDate` |
|
||||
| `sumRain` zero with rain input | `rainAggregator.update` ran while `running=true` (skipped). | `specificClass.js → updateRainData` |
|
||||
| Bucket overfilled before `stop_time` | `m3PerPuls` rounded down; check `predFlow` vs effective `q`. | `sampling/samplingProgram.js → _beginRun` |
|
||||
|
||||
> Never ship `enableLog: 'debug'` in a demo — fills the container log within seconds and obscures real errors. Use only for live debugging.
|
||||
|
||||
## 13. When you would NOT use this node
|
||||
|
||||
- Use monster for **AQUON-scheduled composite sampling** on a wastewater plant. For a single grab sample on demand, fire `cmd.start` once and tear it down — monster is overkill for ad-hoc work.
|
||||
- Don't use monster as a generic flow totaliser. Use a `measurement` child with the right type/variant for raw flow integration.
|
||||
- Skip monster if you don't need pulse-proportional dosing — the time-mode (`flowmeter=false`) is currently informational only.
|
||||
|
||||
## 14. Known limitations / current issues
|
||||
|
||||
| # | Issue | Tracked in |
|
||||
|---|---|---|
|
||||
| 1 | Edge test `sampling-guards.edge.test.js` cooldown-guard case is a pre-existing failure — the cooldown skip increments `missedSamples` but the assertion expects a different timing. | `test/edge/sampling-guards.edge.test.js` |
|
||||
| 2 | `set.mode` and `set.model-prediction` are reserved — handlers delegate to optional methods that don't exist yet. | `commands/handlers.js` |
|
||||
| 3 | Time-only mode (`flowmeter=false`) is not exercised — the sampling program assumes a flow source. | `sampling/samplingProgram.js` |
|
||||
| 4 | Sub-sample volume hard-coded at 50 mL (schema enforces `min=max=50`). | `generalFunctions/src/configs/monster.json` |
|
||||
Reference in New Issue
Block a user