Compare commits
5 Commits
dev-Rene
...
3ff76228eb
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3ff76228eb | ||
|
|
f01b0bcb19 | ||
|
|
4e098eefaa | ||
|
|
90f87bb538 | ||
|
|
8fe9c7ec05 |
@@ -24,12 +24,6 @@
|
||||
heightInlet: { value: 0.8 }, // m, centre of inlet pipe above floor
|
||||
heightOutlet: { value: 0.2 }, // m, centre of outlet pipe above floor
|
||||
heightOverflow: { value: 0.9 }, // m, overflow elevation
|
||||
timeleftToFullOrEmptyThresholdSeconds:{value:0}, // time threshold to safeguard starting or stopping pumps in seconds
|
||||
enableDryRunProtection: { value: true },
|
||||
enableOverfillProtection: { value: true },
|
||||
dryRunThresholdPercent: { value: 2 },
|
||||
overfillThresholdPercent: { value: 98 },
|
||||
minHeightBasedOn: { value: "outlet" }, // basis for minimum height check: inlet or outlet
|
||||
|
||||
// Advanced reference information
|
||||
refHeight: { value: "NAP" }, // reference height
|
||||
@@ -53,16 +47,7 @@
|
||||
hasDistance: { value: false },
|
||||
distance: { value: 0 },
|
||||
distanceUnit: { value: "m" },
|
||||
distanceDescription: { value: "" },
|
||||
|
||||
// control strategy
|
||||
controlMode: { value: "none" },
|
||||
startLevel: { value: null },
|
||||
stopLevel: { value: null },
|
||||
minFlowLevel: { value: null },
|
||||
maxFlowLevel: { value: null },
|
||||
flowSetpoint: { value: null },
|
||||
flowDeadband: { value: null }
|
||||
distanceDescription: { value: "" }
|
||||
|
||||
},
|
||||
|
||||
@@ -101,68 +86,6 @@
|
||||
refHeightEl.value = this.refHeight || "NAP";
|
||||
}
|
||||
|
||||
const minHeightBasedOnEl = document.getElementById("node-input-minHeightBasedOn");
|
||||
if (minHeightBasedOnEl) {
|
||||
minHeightBasedOnEl.value = this.minHeightBasedOn;
|
||||
}
|
||||
|
||||
const dryRunToggle = document.getElementById("node-input-enableDryRunProtection");
|
||||
const dryRunPercent = document.getElementById("node-input-dryRunThresholdPercent");
|
||||
const overfillToggle = document.getElementById("node-input-enableOverfillProtection");
|
||||
const overfillPercent = document.getElementById("node-input-overfillThresholdPercent");
|
||||
|
||||
const toggleInput = (toggleEl, inputEl) => {
|
||||
if (!toggleEl || !inputEl) { return; }
|
||||
inputEl.disabled = !toggleEl.checked;
|
||||
inputEl.parentElement.classList.toggle('disabled', inputEl.disabled);
|
||||
};
|
||||
|
||||
if (dryRunToggle && dryRunPercent) {
|
||||
dryRunToggle.checked = !!this.enableDryRunProtection;
|
||||
dryRunPercent.value = Number.isFinite(this.dryRunThresholdPercent) ? this.dryRunThresholdPercent : 2;
|
||||
dryRunToggle.addEventListener('change', () => toggleInput(dryRunToggle, dryRunPercent));
|
||||
toggleInput(dryRunToggle, dryRunPercent);
|
||||
}
|
||||
|
||||
if (overfillToggle && overfillPercent) {
|
||||
overfillToggle.checked = !!this.enableOverfillProtection;
|
||||
overfillPercent.value = Number.isFinite(this.overfillThresholdPercent) ? this.overfillThresholdPercent : 98;
|
||||
overfillToggle.addEventListener('change', () => toggleInput(overfillToggle, overfillPercent));
|
||||
toggleInput(overfillToggle, overfillPercent);
|
||||
}
|
||||
|
||||
const timeLeftInput = document.getElementById("node-input-timeleftToFullOrEmptyThresholdSeconds");
|
||||
if (timeLeftInput) {
|
||||
timeLeftInput.value = Number.isFinite(this.timeleftToFullOrEmptyThresholdSeconds)
|
||||
? this.timeleftToFullOrEmptyThresholdSeconds
|
||||
: 0;
|
||||
}
|
||||
|
||||
// control mode toggle UI
|
||||
const toggleModeSections = (val) => {
|
||||
document.querySelectorAll('.ps-mode-section').forEach((el) => el.style.display = 'none');
|
||||
const active = document.getElementById(`ps-mode-${val}`);
|
||||
if (active) active.style.display = '';
|
||||
};
|
||||
|
||||
const modeSelect = document.getElementById('node-input-controlMode');
|
||||
if (modeSelect) {
|
||||
modeSelect.value = this.controlMode || 'none';
|
||||
toggleModeSections(modeSelect.value);
|
||||
modeSelect.addEventListener('change', (e) => toggleModeSections(e.target.value));
|
||||
}
|
||||
|
||||
const setNumberField = (id, val) => {
|
||||
const el = document.getElementById(id);
|
||||
if (el) el.value = Number.isFinite(val) ? val : '';
|
||||
};
|
||||
|
||||
setNumberField('node-input-startLevel', this.startLevel);
|
||||
setNumberField('node-input-stopLevel', this.stopLevel);
|
||||
setNumberField('node-input-minFlowLevel', this.minFlowLevel);
|
||||
setNumberField('node-input-maxFlowLevel', this.maxFlowLevel);
|
||||
setNumberField('node-input-flowSetpoint', this.flowSetpoint);
|
||||
setNumberField('node-input-flowDeadband', this.flowDeadband);
|
||||
|
||||
//------------------- END OF CUSTOM config UI ELEMENTS ------------------- //
|
||||
},
|
||||
@@ -175,29 +98,14 @@
|
||||
|
||||
//node specific
|
||||
node.refHeight = document.getElementById("node-input-refHeight").value || "NAP";
|
||||
node.minHeightBasedOn = document.getElementById("node-input-minHeightBasedOn").value || "outlet";
|
||||
node.simulator = document.getElementById("node-input-simulator").checked;
|
||||
|
||||
["basinVolume","basinHeight","heightInlet","heightOutlet","heightOverflow","basinBottomRef","timeleftToFullOrEmptyThresholdSeconds","dryRunThresholdPercent","overfillThresholdPercent"]
|
||||
["basinVolume","basinHeight","heightInlet","heightOutlet","heightOverflow","basinBottomRef"]
|
||||
.forEach(field => {
|
||||
node[field] = parseFloat(document.getElementById(`node-input-${field}`).value) || 0;
|
||||
});
|
||||
|
||||
node.refHeight = document.getElementById("node-input-refHeight").value || "";
|
||||
node.enableDryRunProtection = document.getElementById("node-input-enableDryRunProtection").checked;
|
||||
node.enableOverfillProtection = document.getElementById("node-input-enableOverfillProtection").checked;
|
||||
|
||||
// control strategy
|
||||
node.controlMode = document.getElementById('node-input-controlMode').value || 'none';
|
||||
|
||||
const parseNum = (id) => parseFloat(document.getElementById(id)?.value);
|
||||
node.startLevel = parseNum('node-input-startLevel');
|
||||
node.stopLevel = parseNum('node-input-stopLevel');
|
||||
node.minFlowLevel = parseNum('node-input-minFlowLevel');
|
||||
node.maxFlowLevel = parseNum('node-input-maxFlowLevel');
|
||||
node.flowSetpoint = parseNum('node-input-flowSetpoint');
|
||||
node.flowDeadband = parseNum('node-input-flowDeadband');
|
||||
|
||||
},
|
||||
|
||||
});
|
||||
@@ -207,7 +115,7 @@
|
||||
|
||||
<script type="text/html" data-template-name="pumpingStation">
|
||||
|
||||
<h4>Simulation</h4>
|
||||
<!-- Simulator toggle -->
|
||||
<div class="form-row">
|
||||
<label for="node-input-simulator"><i class="fa fa-play-circle"></i> Simulator</label>
|
||||
<input type="checkbox" id="node-input-simulator" style="width:20px;vertical-align:baseline;" />
|
||||
@@ -216,7 +124,7 @@
|
||||
|
||||
<hr>
|
||||
|
||||
<h4>Basin Geometry</h4>
|
||||
<!-- Basin geometry -->
|
||||
<div class="form-row">
|
||||
<label for="node-input-basinVolume"><i class="fa fa-cube"></i> Basin Volume (m³)</label>
|
||||
<input type="number" id="node-input-basinVolume" min="0" step="0.1" />
|
||||
@@ -242,58 +150,7 @@
|
||||
|
||||
<hr>
|
||||
|
||||
<h4>Control Strategy</h4>
|
||||
<div class="form-row">
|
||||
<label for="node-input-controlMode"><i class="fa fa-sliders"></i> Control mode</label>
|
||||
<select id="node-input-controlMode">
|
||||
<option value="none">None / Manual</option>
|
||||
<option value="levelbased">Level-based</option>
|
||||
<option value="flowbased">Flow-based</option>
|
||||
</select>
|
||||
</div>
|
||||
|
||||
<div id="ps-mode-levelbased" class="ps-mode-section">
|
||||
<div class="form-row">
|
||||
<label for="node-input-startLevel">startLevel</label>
|
||||
<input type="number" id="node-input-startLevel" placeholder="m" />
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-stopLevel">stopLevel</label>
|
||||
<input type="number" id="node-input-stopLevel" placeholder="m" />
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-minFlowLevel">Min flow (m)</label>
|
||||
<input type="number" id="node-input-minFlowLevel" placeholder="m" />
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-maxFlowLevel">Max flow (m)</label>
|
||||
<input type="number" id="node-input-maxFlowLevel" placeholder="m" />
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="ps-mode-flowbased" class="ps-mode-section" style="display:none">
|
||||
<div class="form-row">
|
||||
<label for="node-input-flowSetpoint">Flow setpoint</label>
|
||||
<input type="number" id="node-input-flowSetpoint" placeholder="m3/h" />
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-flowDeadband">Deadband</label>
|
||||
<input type="number" id="node-input-flowDeadband" placeholder="m3/h" />
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<hr>
|
||||
|
||||
<h4>Reference</h4>
|
||||
|
||||
<!-- Reference data -->
|
||||
<div class="form-row">
|
||||
<label for="node-input-minHeightBasedOn"><i class="fa fa-arrows-v"></i> Minimum Height Based On</label>
|
||||
<select id="node-input-minHeightBasedOn" style="width:60%;">
|
||||
<option value="inlet">Inlet Elevation</option>
|
||||
<option value="outlet">Outlet Elevation</option>
|
||||
</select>
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-refHeight"><i class="fa fa-map-marker"></i> Reference height</label>
|
||||
<select id="node-input-refHeight" style="width:60%;">
|
||||
@@ -306,40 +163,6 @@
|
||||
<input type="number" id="node-input-basinBottomRef" step="0.01" />
|
||||
</div>
|
||||
|
||||
<hr>
|
||||
|
||||
<h4>Safety</h4>
|
||||
|
||||
<!-- Safety settings -->
|
||||
<div class="form-row">
|
||||
<label for="node-input-timeleftToFullOrEmptyThresholdSeconds"><i class="fa fa-clock-o"></i> Time To Empty/Full (s)</label>
|
||||
<input type="number" id="node-input-timeleftToFullOrEmptyThresholdSeconds" min="0" step="1" />
|
||||
</div>
|
||||
|
||||
<div class="form-row">
|
||||
<label for="node-input-enableDryRunProtection">
|
||||
<i class="fa fa-shield"></i> Dry-run Protection
|
||||
</label>
|
||||
<input type="checkbox" id="node-input-enableDryRunProtection" style="width:20px;vertical-align:baseline;" />
|
||||
<span>Prevent pumps from running on low volume</span>
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-dryRunThresholdPercent" style="padding-left:20px;">Low Volume Threshold (%)</label>
|
||||
<input type="number" id="node-input-dryRunThresholdPercent" min="0" max="100" step="0.1" />
|
||||
</div>
|
||||
|
||||
<div class="form-row">
|
||||
<label for="node-input-enableOverfillProtection">
|
||||
<i class="fa fa-exclamation-triangle"></i> Overfill Protection
|
||||
</label>
|
||||
<input type="checkbox" id="node-input-enableOverfillProtection" style="width:20px;vertical-align:baseline;" />
|
||||
<span>Stop filling when approaching overflow</span>
|
||||
</div>
|
||||
<div class="form-row">
|
||||
<label for="node-input-overfillThresholdPercent" style="padding-left:20px;">High Volume Threshold (%)</label>
|
||||
<input type="number" id="node-input-overfillThresholdPercent" min="0" max="100" step="0.1" />
|
||||
</div>
|
||||
<hr>
|
||||
<!-- Shared asset/logger/position menus -->
|
||||
<div id="asset-fields-placeholder"></div>
|
||||
<div id="logger-fields-placeholder"></div>
|
||||
|
||||
152
src/nodeClass.js
152
src/nodeClass.js
@@ -39,21 +39,8 @@ class nodeClass {
|
||||
const cfgMgr = new configManager();
|
||||
this.defaultConfig = cfgMgr.getConfig(this.name);
|
||||
|
||||
// Merge UI config over defaults
|
||||
this.config = {
|
||||
general: {
|
||||
name: this.name,
|
||||
id: node.id, // node.id is for the child registration process
|
||||
unit: uiConfig.unit, // add converter options later to convert to default units (need like a model that defines this which units we are going to use and then conver to those standards)
|
||||
logging: {
|
||||
enabled: uiConfig.enableLog,
|
||||
logLevel: uiConfig.logLevel
|
||||
}
|
||||
},
|
||||
functionality: {
|
||||
positionVsParent: uiConfig.positionVsParent,// Default to 'atEquipment' if not specified
|
||||
distance: uiConfig.hasDistance ? uiConfig.distance : undefined
|
||||
},
|
||||
// Build config: base sections + pumpingStation-specific domain config
|
||||
this.config = cfgMgr.buildConfig(this.name, uiConfig, node.id, {
|
||||
basin: {
|
||||
volume: uiConfig.basinVolume,
|
||||
height: uiConfig.basinHeight,
|
||||
@@ -63,28 +50,9 @@ class nodeClass {
|
||||
},
|
||||
hydraulics: {
|
||||
refHeight: uiConfig.refHeight,
|
||||
minHeightBasedOn: uiConfig.minHeightBasedOn,
|
||||
basinBottomRef: uiConfig.basinBottomRef,
|
||||
},
|
||||
control:{
|
||||
mode: uiConfig.controlMode,
|
||||
levelbased:{
|
||||
startLevel:uiConfig.startLevel,
|
||||
stopLevel:uiConfig.stopLevel,
|
||||
minFlowLevel:uiConfig.minFlowLevel,
|
||||
maxFlowLevel:uiConfig.maxFlowLevel
|
||||
}
|
||||
},
|
||||
safety:{
|
||||
enableDryRunProtection: uiConfig.enableDryRunProtection,
|
||||
dryRunThresholdPercent: uiConfig.dryRunThresholdPercent,
|
||||
enableOverfillProtection: uiConfig.enableOverfillProtection,
|
||||
overfillThresholdPercent: uiConfig.overfillThresholdPercent,
|
||||
timeleftToFullOrEmptyThresholdSeconds: uiConfig.timeleftToFullOrEmptyThresholdSeconds
|
||||
}
|
||||
};
|
||||
|
||||
console.log(`position vs child for ${this.name} is ${this.config.functionality.positionVsParent} the distance is ${this.config.functionality.distance}`);
|
||||
});
|
||||
|
||||
// Utility for formatting outputs
|
||||
this._output = new outputUtils();
|
||||
@@ -118,58 +86,63 @@ class nodeClass {
|
||||
|
||||
_updateNodeStatus() {
|
||||
const ps = this.source;
|
||||
|
||||
const pickVariant = (type, prefer = ['measured', 'predicted'], position = 'atEquipment', unit) => {
|
||||
for (const variant of prefer) {
|
||||
const chain = ps.measurements.type(type).variant(variant).position(position);
|
||||
const value = unit ? chain.getCurrentValue(unit) : chain.getCurrentValue();
|
||||
if (value != null) return { value, variant };
|
||||
}
|
||||
return { value: null, variant: null };
|
||||
};
|
||||
|
||||
const vol = pickVariant('volume', ['measured', 'predicted'], 'atEquipment', 'm3');
|
||||
const volPercent = pickVariant('volumePercent', ['measured','predicted'], 'atEquipment'); // already unitless
|
||||
const level = pickVariant('level', ['measured', 'predicted'], 'atEquipment', 'm');
|
||||
const netFlow = pickVariant('netFlowRate', ['measured', 'predicted'], 'atEquipment', 'm3/h');
|
||||
|
||||
try {
|
||||
// --- Basin & measurements -------------------------------------------------
|
||||
const maxVolBeforeOverflow = ps.basin?.maxVolOverflow ?? ps.basin?.maxVol ?? 0;
|
||||
const currentVolume = vol.value ?? 0;
|
||||
const currentvolPercent = volPercent.value ?? 0;
|
||||
const netFlowM3h = netFlow.value ?? 0;
|
||||
const volumeMeasurement = ps.measurements.type("volume").variant("measured").position("atEquipment");
|
||||
const currentVolume = volumeMeasurement.getCurrentValue("m3") ?? 0;
|
||||
const netFlowMeasurement = ps.measurements.type("netFlowRate").variant("predicted").position("atEquipment");
|
||||
const netFlowM3s = netFlowMeasurement?.getCurrentValue("m3/s") ?? 0;
|
||||
const netFlowM3h = netFlowM3s * 3600;
|
||||
const percentFull = ps.measurements.type("volume").variant("procent").position("atEquipment").getCurrentValue() ?? 0;
|
||||
|
||||
const direction = ps.state?.direction ?? 'unknown';
|
||||
// --- State information ----------------------------------------------------
|
||||
const direction = ps.state?.direction || "unknown";
|
||||
const secondsRemaining = ps.state?.seconds ?? null;
|
||||
const timeRemainingMinutes = secondsRemaining != null ? Math.round(secondsRemaining / 60) : null;
|
||||
|
||||
const badgePieces = [];
|
||||
badgePieces.push(`${currentvolPercent.toFixed(1)}% `);
|
||||
badgePieces.push(
|
||||
`V=${currentVolume.toFixed(2)} / ${maxVolBeforeOverflow.toFixed(2)} m³`
|
||||
);
|
||||
badgePieces.push(`net: ${netFlowM3h.toFixed(0)} m³/h`);
|
||||
if (timeRemainingMinutes != null) {
|
||||
badgePieces.push(`t≈${timeRemainingMinutes} min)`);
|
||||
}
|
||||
const timeRemaining = secondsRemaining ? `${Math.round(secondsRemaining / 60)}` : 0 + " min";
|
||||
|
||||
// --- Icon / colour selection ---------------------------------------------
|
||||
let symbol = "❔";
|
||||
let fill = "grey";
|
||||
|
||||
const { symbol, fill } = (() => {
|
||||
switch (direction) {
|
||||
case 'filling': return { symbol: '⬆️', fill: 'blue' };
|
||||
case 'draining': return { symbol: '⬇️', fill: 'orange' };
|
||||
case 'steady': return { symbol: '⏸️', fill: 'green' };
|
||||
default: return { symbol: '❔', fill: 'grey' };
|
||||
case "filling":
|
||||
symbol = "⬆️";
|
||||
fill = "blue";
|
||||
break;
|
||||
case "draining":
|
||||
symbol = "⬇️";
|
||||
fill = "orange";
|
||||
break;
|
||||
case "stable":
|
||||
symbol = "⏸️";
|
||||
fill = "green";
|
||||
break;
|
||||
default:
|
||||
symbol = "❔";
|
||||
fill = "grey";
|
||||
break;
|
||||
}
|
||||
})();
|
||||
|
||||
badgePieces[0] = `${symbol} ${badgePieces[0]}`;
|
||||
// --- Status text ----------------------------------------------------------
|
||||
const textParts = [
|
||||
`${symbol} ${percentFull.toFixed(1)}%`,
|
||||
`V=${currentVolume.toFixed(2)} / ${maxVolBeforeOverflow.toFixed(2)} m³`,
|
||||
`net=${netFlowM3h.toFixed(1)} m³/h`,
|
||||
`t≈${timeRemaining}`
|
||||
];
|
||||
|
||||
return {
|
||||
fill,
|
||||
shape: 'dot',
|
||||
text: badgePieces.join(' | ')
|
||||
shape: "dot",
|
||||
text: textParts.join(" | ")
|
||||
};
|
||||
} catch (error) {
|
||||
this.node.error("Error in updateNodeStatus: " + error.message);
|
||||
return { fill: "red", shape: "ring", text: "Status Error" };
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
// any time based functions here
|
||||
@@ -194,8 +167,8 @@ class nodeClass {
|
||||
//pumping station needs time based ticks to recalc level when predicted
|
||||
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');
|
||||
const processMsg = this._output.formatMsg(raw, this.config, 'process');
|
||||
const influxMsg = this._output.formatMsg(raw, this.config, 'influxdb');
|
||||
|
||||
// Send only updated outputs on ports 0 & 1
|
||||
this.node.send([processMsg, influxMsg]);
|
||||
@@ -208,33 +181,20 @@ class nodeClass {
|
||||
this.node.on('input', (msg, send, done) => {
|
||||
switch (msg.topic) {
|
||||
//example
|
||||
case 'changemode':
|
||||
this.source.changeMode(msg.payload);
|
||||
/*case 'simulator':
|
||||
this.source.toggleSimulation();
|
||||
break;
|
||||
case 'registerChild':
|
||||
default:
|
||||
this.source.handleInput(msg);
|
||||
break;
|
||||
*/
|
||||
case 'registerChild': {
|
||||
// Register this node as a child of the parent node
|
||||
const childId = msg.payload;
|
||||
const childObj = this.RED.nodes.getNode(childId);
|
||||
this.source.childRegistrationUtils.registerChild(childObj.source ,msg.positionVsParent);
|
||||
break;
|
||||
case 'calibratePredictedVolume':
|
||||
const injectedVol = parseFloat(msg.payload);
|
||||
this.source.calibratePredictedVolume(injectedVol);
|
||||
break;
|
||||
case 'calibratePredictedLevel':
|
||||
const injectedLevel = parseFloat(msg.payload);
|
||||
this.source.calibratePredictedLevel(injectedLevel);
|
||||
break;
|
||||
case 'q_in': {
|
||||
// payload can be number or { value, unit, timestamp }
|
||||
const val = Number(msg.payload);
|
||||
const unit = msg?.unit;
|
||||
const ts = msg?.timestamp || Date.now();
|
||||
this.source.setManualInflow(val, ts, unit);
|
||||
break;
|
||||
}
|
||||
|
||||
|
||||
}
|
||||
done();
|
||||
});
|
||||
|
||||
1100
src/specificClass.js
1100
src/specificClass.js
File diff suppressed because it is too large
Load Diff
260
test/specificClass.test.js
Normal file
260
test/specificClass.test.js
Normal file
@@ -0,0 +1,260 @@
|
||||
/**
|
||||
* Tests for pumpingStation specificClass (domain logic).
|
||||
*
|
||||
* The pumpingStation class manages a basin (wet well):
|
||||
* - initBasinProperties: derives surface area, volumes from config
|
||||
* - _calcVolumeFromLevel / _calcLevelFromVolume: linear geometry
|
||||
* - _calcDirection: filling / draining / stable from flow diff
|
||||
* - _callMeasurementHandler: dispatches to type-specific handlers
|
||||
* - getOutput: builds an output snapshot
|
||||
*/
|
||||
|
||||
const PumpingStation = require('../src/specificClass');
|
||||
|
||||
// --------------- helpers ---------------
|
||||
|
||||
function makeConfig(overrides = {}) {
|
||||
const base = {
|
||||
general: {
|
||||
name: 'TestStation',
|
||||
id: 'ps-test-1',
|
||||
unit: 'm3/h',
|
||||
logging: { enabled: false, logLevel: 'error' },
|
||||
},
|
||||
functionality: {
|
||||
softwareType: 'pumpingStation',
|
||||
role: 'stationcontroller',
|
||||
positionVsParent: 'atEquipment',
|
||||
},
|
||||
basin: {
|
||||
volume: 50, // m3 (empty basin volume)
|
||||
height: 5, // m
|
||||
heightInlet: 0.3, // m
|
||||
heightOutlet: 0.2, // m
|
||||
heightOverflow: 4.0, // m
|
||||
},
|
||||
hydraulics: {
|
||||
refHeight: 'NAP',
|
||||
basinBottomRef: 0,
|
||||
},
|
||||
};
|
||||
|
||||
for (const key of Object.keys(overrides)) {
|
||||
if (typeof overrides[key] === 'object' && !Array.isArray(overrides[key]) && base[key]) {
|
||||
base[key] = { ...base[key], ...overrides[key] };
|
||||
} else {
|
||||
base[key] = overrides[key];
|
||||
}
|
||||
}
|
||||
return base;
|
||||
}
|
||||
|
||||
// --------------- tests ---------------
|
||||
|
||||
describe('pumpingStation specificClass', () => {
|
||||
|
||||
describe('constructor / initialization', () => {
|
||||
it('should create an instance with the given config', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
expect(ps).toBeDefined();
|
||||
expect(ps.config.general.name).toBe('teststation');
|
||||
});
|
||||
|
||||
it('should initialize state object with default values', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
expect(ps.state).toEqual({ direction: '', netDownstream: 0, netUpstream: 0, seconds: 0 });
|
||||
});
|
||||
|
||||
it('should initialize empty machines, stations, child, parent objects', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
expect(ps.machines).toEqual({});
|
||||
expect(ps.stations).toEqual({});
|
||||
expect(ps.child).toEqual({});
|
||||
expect(ps.parent).toEqual({});
|
||||
});
|
||||
});
|
||||
|
||||
describe('initBasinProperties()', () => {
|
||||
it('should calculate surfaceArea = volume / height', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
// 50 / 5 = 10 m2
|
||||
expect(ps.basin.surfaceArea).toBe(10);
|
||||
});
|
||||
|
||||
it('should calculate maxVol = height * surfaceArea', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
// 5 * 10 = 50
|
||||
expect(ps.basin.maxVol).toBe(50);
|
||||
});
|
||||
|
||||
it('should calculate maxVolOverflow = heightOverflow * surfaceArea', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
// 4.0 * 10 = 40
|
||||
expect(ps.basin.maxVolOverflow).toBe(40);
|
||||
});
|
||||
|
||||
it('should calculate minVol = heightOutlet * surfaceArea', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
// 0.2 * 10 = 2
|
||||
expect(ps.basin.minVol).toBeCloseTo(2, 5);
|
||||
});
|
||||
|
||||
it('should calculate minVolOut = heightInlet * surfaceArea', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
// 0.3 * 10 = 3
|
||||
expect(ps.basin.minVolOut).toBeCloseTo(3, 5);
|
||||
});
|
||||
|
||||
it('should store the raw config values on basin', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
expect(ps.basin.volEmptyBasin).toBe(50);
|
||||
expect(ps.basin.heightBasin).toBe(5);
|
||||
expect(ps.basin.heightInlet).toBe(0.3);
|
||||
expect(ps.basin.heightOutlet).toBe(0.2);
|
||||
expect(ps.basin.heightOverflow).toBe(4.0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('_calcVolumeFromLevel()', () => {
|
||||
let ps;
|
||||
beforeAll(() => { ps = new PumpingStation(makeConfig()); });
|
||||
|
||||
it('should return level * surfaceArea', () => {
|
||||
// surfaceArea = 10, level = 2 => 20
|
||||
expect(ps._calcVolumeFromLevel(2)).toBe(20);
|
||||
});
|
||||
|
||||
it('should return 0 for level = 0', () => {
|
||||
expect(ps._calcVolumeFromLevel(0)).toBe(0);
|
||||
});
|
||||
|
||||
it('should clamp negative levels to 0', () => {
|
||||
expect(ps._calcVolumeFromLevel(-3)).toBe(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('_calcLevelFromVolume()', () => {
|
||||
let ps;
|
||||
beforeAll(() => { ps = new PumpingStation(makeConfig()); });
|
||||
|
||||
it('should return volume / surfaceArea', () => {
|
||||
// surfaceArea = 10, vol = 20 => 2
|
||||
expect(ps._calcLevelFromVolume(20)).toBe(2);
|
||||
});
|
||||
|
||||
it('should return 0 for volume = 0', () => {
|
||||
expect(ps._calcLevelFromVolume(0)).toBe(0);
|
||||
});
|
||||
|
||||
it('should clamp negative volumes to 0', () => {
|
||||
expect(ps._calcLevelFromVolume(-10)).toBe(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('volume/level roundtrip', () => {
|
||||
it('should roundtrip level -> volume -> level', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
const level = 2.7;
|
||||
const vol = ps._calcVolumeFromLevel(level);
|
||||
const levelBack = ps._calcLevelFromVolume(vol);
|
||||
expect(levelBack).toBeCloseTo(level, 10);
|
||||
});
|
||||
});
|
||||
|
||||
describe('_calcDirection()', () => {
|
||||
let ps;
|
||||
beforeAll(() => { ps = new PumpingStation(makeConfig()); });
|
||||
|
||||
it('should return "filling" for positive flow above threshold', () => {
|
||||
expect(ps._calcDirection(0.01)).toBe('filling');
|
||||
});
|
||||
|
||||
it('should return "draining" for negative flow below negative threshold', () => {
|
||||
expect(ps._calcDirection(-0.01)).toBe('draining');
|
||||
});
|
||||
|
||||
it('should return "stable" for flow near zero (within threshold)', () => {
|
||||
expect(ps._calcDirection(0.0005)).toBe('stable');
|
||||
expect(ps._calcDirection(-0.0005)).toBe('stable');
|
||||
expect(ps._calcDirection(0)).toBe('stable');
|
||||
});
|
||||
});
|
||||
|
||||
describe('_callMeasurementHandler()', () => {
|
||||
it('should not throw for flow and temperature measurement types', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
// flow and temperature handlers are empty stubs, safe to call
|
||||
expect(() => ps._callMeasurementHandler('flow', 0.5, 'downstream', {})).not.toThrow();
|
||||
expect(() => ps._callMeasurementHandler('temperature', 15, 'atEquipment', {})).not.toThrow();
|
||||
});
|
||||
|
||||
it('should dispatch to the correct handler based on measurement type', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
// Verify the switch dispatches by checking it does not warn for known types
|
||||
// pressure handler stores values and attempts coolprop calculation
|
||||
// level handler stores values and computes volume
|
||||
// We verify the dispatch logic by calling with type and checking no unhandled error
|
||||
const spy = jest.spyOn(ps, 'updateMeasuredFlow');
|
||||
ps._callMeasurementHandler('flow', 0.5, 'downstream', {});
|
||||
expect(spy).toHaveBeenCalledWith(0.5, 'downstream', {});
|
||||
spy.mockRestore();
|
||||
});
|
||||
});
|
||||
|
||||
describe('getOutput()', () => {
|
||||
it('should return an object containing state and basin', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
const out = ps.getOutput();
|
||||
expect(out).toHaveProperty('state');
|
||||
expect(out).toHaveProperty('basin');
|
||||
expect(out.state).toBe(ps.state);
|
||||
expect(out.basin).toBe(ps.basin);
|
||||
});
|
||||
|
||||
it('should include measurement keys in the output', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
const out = ps.getOutput();
|
||||
// After initialization the predicted volume is set
|
||||
expect(typeof out).toBe('object');
|
||||
});
|
||||
});
|
||||
|
||||
describe('_calcRemainingTime()', () => {
|
||||
it('should not throw when called with a level and variant', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
// Should not throw even with no measurement data; it will just find null diffs
|
||||
expect(() => ps._calcRemainingTime(2, 'predicted')).not.toThrow();
|
||||
});
|
||||
});
|
||||
|
||||
describe('tick()', () => {
|
||||
it('should call _updateVolumePrediction and _calcNetFlow', () => {
|
||||
const ps = new PumpingStation(makeConfig());
|
||||
const spyVol = jest.spyOn(ps, '_updateVolumePrediction');
|
||||
const spyNet = jest.spyOn(ps, '_calcNetFlow');
|
||||
// stub _calcRemainingTime to avoid needing full measurement data
|
||||
ps._calcRemainingTime = jest.fn();
|
||||
ps.tick();
|
||||
expect(spyVol).toHaveBeenCalledWith('out');
|
||||
expect(spyVol).toHaveBeenCalledWith('in');
|
||||
expect(spyNet).toHaveBeenCalled();
|
||||
spyVol.mockRestore();
|
||||
spyNet.mockRestore();
|
||||
});
|
||||
});
|
||||
|
||||
describe('edge cases', () => {
|
||||
it('should handle basin with zero height gracefully', () => {
|
||||
// surfaceArea = volume / height => division by 0 gives Infinity
|
||||
const config = makeConfig({ basin: { volume: 50, height: 0, heightInlet: 0, heightOutlet: 0, heightOverflow: 0 } });
|
||||
const ps = new PumpingStation(config);
|
||||
expect(ps.basin.surfaceArea).toBe(Infinity);
|
||||
});
|
||||
|
||||
it('should handle basin with very small dimensions', () => {
|
||||
const config = makeConfig({ basin: { volume: 0.001, height: 0.001, heightInlet: 0, heightOutlet: 0, heightOverflow: 0.0005 } });
|
||||
const ps = new PumpingStation(config);
|
||||
expect(ps.basin.surfaceArea).toBeCloseTo(1, 5);
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user