2025-10-14 08:36:45 +02:00
|
|
|
const nameOfNode = 'pumpingStation'; // this is the name of the node, it should match the file name and the node type in Node-RED
|
Level-armed shift, derived dryRunLevel, side-panel editor + manual q_out
Runtime (specificClass.js):
- Replace direction-based hysteresis with level-armed _shiftArmed state.
Arms when level rises past shiftLevel; disarms when level drops below
startLevel. While armed, ramp foot moves to startLevel and ramp top
to shiftLevel — both ends shift left, then saturate at 100 % up to
maxLevel.
- _scaleLevelToFlowPercent now takes (rampStartLevel, rampTopLevel) so
the saturation point follows the shift state.
- New setManualOutflow mirroring setManualInflow.
Adapter (nodeClass.js):
- Pipe enableShiftedRamp / shiftLevel through to control.levelbased.
- New q_out topic handler.
Editor (pumpingStation.html + new src/editor/ modules):
- Split monolithic <script> into modules: index.js (helpers),
basin-diagram.js, mode-preview.js, hover-couple.js, oneditprepare.js,
oneditsave.js — served via /pumpingStation/editor/:file.
- Mode preview redrawn per the SVG diagrams: OFF tier below 0 %, 0 %
flat from start→inlet, ramp inlet→max, optional shifted-down curve
start→shift with 100 % saturation past shift.
- Mode preview gains zone bands (dryRun / safetyLow / safe / safetyHigh /
overflow), level markers (dryRun derived, start, inlet, max, shift,
overflow), validation ribbon that blocks save on bad ordering.
- Auto-default shiftLevel to 0.9 × maxLevel on enable so the marker is
always visible.
- All level inputs moved to a side panel left of each diagram, color-
coded to match line strokes; hover-couple highlights the paired SVG
line on input focus / mouseover.
- Removed UI for non-static parameters: minHeightBasedOn,
pipelineLength, maxDischargeHead, staticHead, defaultFluid,
maxInflowRate, temperatureReferenceDegC,
timeleftToFullOrEmptyThresholdSeconds, inletPipeDiameter,
outletPipeDiameter, minLevel (now derived = dryRunLevel).
- foreignObject inputs in basin SVG removed (single source of truth in
side panel).
Dashboard example (examples/basic-dashboard.flow.json):
- Add manual Q_OUT slider + q_out builder mirroring the existing q_in
trio so the basin can be exercised end-to-end without a connected
rotating-machine downstream.
Tests (test/basic/specificClass.test.js):
- Replace direction-shift test with two new cases covering shift-disabled
hold-zone behaviour and shift-armed/disarmed transitions through
shiftLevel and startLevel boundaries. 53/53 tests pass.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-05 19:29:34 +02:00
|
|
|
const path = require('path');
|
2025-10-07 18:05:54 +02:00
|
|
|
const nodeClass = require('./src/nodeClass.js'); // this is the specific node class
|
|
|
|
|
const { MenuManager, configManager } = require('generalFunctions');
|
|
|
|
|
|
|
|
|
|
// This is the main entry point for the Node-RED node, it will register the node and setup the endpoints
|
|
|
|
|
module.exports = function(RED) {
|
|
|
|
|
// Register the node type
|
|
|
|
|
RED.nodes.registerType(nameOfNode, function(config) {
|
|
|
|
|
// Initialize the Node-RED node first
|
|
|
|
|
RED.nodes.createNode(this, config);
|
|
|
|
|
// Then create your custom class and attach it
|
|
|
|
|
this.nodeClass = new nodeClass(config, RED, this, nameOfNode);
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
// Setup admin UIs
|
|
|
|
|
const menuMgr = new MenuManager(); //this will handle the menu endpoints so we can load them dynamically
|
|
|
|
|
const cfgMgr = new configManager(); // this will handle the config endpoints so we can load them dynamically
|
|
|
|
|
|
|
|
|
|
// Register the different menu's for the measurement node (in the future we could automate this further by refering to the config)
|
|
|
|
|
RED.httpAdmin.get(`/${nameOfNode}/menu.js`, (req, res) => {
|
|
|
|
|
try {
|
2025-10-14 08:36:45 +02:00
|
|
|
const script = menuMgr.createEndpoint(nameOfNode, ['logger','position']);
|
2025-10-07 18:05:54 +02:00
|
|
|
res.type('application/javascript').send(script);
|
|
|
|
|
} catch (err) {
|
|
|
|
|
res.status(500).send(`// Error generating menu: ${err.message}`);
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
|
|
|
|
// Endpoint to get the configuration data for the specific node
|
|
|
|
|
RED.httpAdmin.get(`/${nameOfNode}/configData.js`, (req, res) => {
|
|
|
|
|
try {
|
|
|
|
|
const script = cfgMgr.createEndpoint(nameOfNode);
|
|
|
|
|
// Send the configuration data as JSON response
|
|
|
|
|
res.type('application/javascript').send(script);
|
|
|
|
|
} catch (err) {
|
|
|
|
|
res.status(500).send(`// Error generating configData: ${err.message}`);
|
|
|
|
|
}
|
|
|
|
|
});
|
|
|
|
|
|
Level-armed shift, derived dryRunLevel, side-panel editor + manual q_out
Runtime (specificClass.js):
- Replace direction-based hysteresis with level-armed _shiftArmed state.
Arms when level rises past shiftLevel; disarms when level drops below
startLevel. While armed, ramp foot moves to startLevel and ramp top
to shiftLevel — both ends shift left, then saturate at 100 % up to
maxLevel.
- _scaleLevelToFlowPercent now takes (rampStartLevel, rampTopLevel) so
the saturation point follows the shift state.
- New setManualOutflow mirroring setManualInflow.
Adapter (nodeClass.js):
- Pipe enableShiftedRamp / shiftLevel through to control.levelbased.
- New q_out topic handler.
Editor (pumpingStation.html + new src/editor/ modules):
- Split monolithic <script> into modules: index.js (helpers),
basin-diagram.js, mode-preview.js, hover-couple.js, oneditprepare.js,
oneditsave.js — served via /pumpingStation/editor/:file.
- Mode preview redrawn per the SVG diagrams: OFF tier below 0 %, 0 %
flat from start→inlet, ramp inlet→max, optional shifted-down curve
start→shift with 100 % saturation past shift.
- Mode preview gains zone bands (dryRun / safetyLow / safe / safetyHigh /
overflow), level markers (dryRun derived, start, inlet, max, shift,
overflow), validation ribbon that blocks save on bad ordering.
- Auto-default shiftLevel to 0.9 × maxLevel on enable so the marker is
always visible.
- All level inputs moved to a side panel left of each diagram, color-
coded to match line strokes; hover-couple highlights the paired SVG
line on input focus / mouseover.
- Removed UI for non-static parameters: minHeightBasedOn,
pipelineLength, maxDischargeHead, staticHead, defaultFluid,
maxInflowRate, temperatureReferenceDegC,
timeleftToFullOrEmptyThresholdSeconds, inletPipeDiameter,
outletPipeDiameter, minLevel (now derived = dryRunLevel).
- foreignObject inputs in basin SVG removed (single source of truth in
side panel).
Dashboard example (examples/basic-dashboard.flow.json):
- Add manual Q_OUT slider + q_out builder mirroring the existing q_in
trio so the basin can be exercised end-to-end without a connected
rotating-machine downstream.
Tests (test/basic/specificClass.test.js):
- Replace direction-shift test with two new cases covering shift-disabled
hold-zone behaviour and shift-armed/disarmed transitions through
shiftLevel and startLevel boundaries. 53/53 tests pass.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-05 19:29:34 +02:00
|
|
|
// Editor JS modules — loaded by pumpingStation.html via <script src=...> tags.
|
|
|
|
|
// Files live in src/editor/. Filename is restricted to a safe charset to
|
|
|
|
|
// prevent path-traversal.
|
|
|
|
|
RED.httpAdmin.get(`/${nameOfNode}/editor/:file`, (req, res) => {
|
|
|
|
|
const safe = String(req.params.file || '').replace(/[^a-zA-Z0-9._-]/g, '');
|
|
|
|
|
if (!safe.endsWith('.js')) return res.status(400).send('// invalid');
|
|
|
|
|
res.type('application/javascript');
|
|
|
|
|
res.sendFile(path.join(__dirname, 'src', 'editor', safe), (err) => {
|
|
|
|
|
if (err && !res.headersSent) res.status(404).send('// editor module not found');
|
|
|
|
|
});
|
|
|
|
|
});
|
|
|
|
|
|
2025-10-07 18:05:54 +02:00
|
|
|
};
|