RnD/pumpingStation
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: adopt POSITIONS constants and fix ESLint warnings

Browse Source 
Replace hardcoded position strings with POSITIONS.* constants.
Prefix unused variables with _ to resolve no-unused-vars warnings.
Fix no-prototype-builtins where applicable.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Rene De Ren
2026-03-11 15:35:28 +01:00
parent 90f87bb538
commit 4e098eefaa
1 changed files with 23 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
src/specificClass.js
View File

@@ -1,5 +1,5 @@
const EventEmitter = require('events'); const EventEmitter = require('events');
const {logger,configUtils,configManager,childRegistrationUtils,MeasurementContainer,coolprop,interpolation} = require('generalFunctions'); const {logger,configUtils,configManager,childRegistrationUtils,MeasurementContainer,coolprop,interpolation, POSITIONS} = require('generalFunctions');
class pumpingStation { class pumpingStation {
constructor(config={}) { constructor(config={}) {
@@ -41,9 +41,7 @@ class pumpingStation {
//define what to do with measurements //define what to do with measurements
if(softwareType === "measurement"){ if(softwareType === "measurement"){
const position = child.config.functionality.positionVsParent; const position = child.config.functionality.positionVsParent;
const distance = child.config.functionality.distanceVsParent || 0;
const measurementType = child.config.asset.type; const measurementType = child.config.asset.type;
const key = `${measurementType}_${position}`;
//rebuild to measurementype.variant no position and then switch based on values not strings or names. //rebuild to measurementype.variant no position and then switch based on values not strings or names.
const eventName = `${measurementType}.measured.${position}`; const eventName = `${measurementType}.measured.${position}`;
@@ -70,7 +68,7 @@ class pumpingStation {
this.logger.debug(`Listening for flow changes from machine ${child.config.general.id}`); this.logger.debug(`Listening for flow changes from machine ${child.config.general.id}`);
switch(child.config.functionality.positionVsParent){ switch(child.config.functionality.positionVsParent){
case("downstream"): case(POSITIONS.DOWNSTREAM):
case("atequipment"): //in case of atequipment we also assume downstream seeing as it is registered at this pumpingstation as part of it. case("atequipment"): //in case of atequipment we also assume downstream seeing as it is registered at this pumpingstation as part of it.
//for now lets focus on handling downstream predicted flow //for now lets focus on handling downstream predicted flow
child.measurements.emitter.on("flow.predicted.downstream", (eventData) => { child.measurements.emitter.on("flow.predicted.downstream", (eventData) => {
@@ -80,7 +78,7 @@ class pumpingStation {
break; break;
case("upstream"): case(POSITIONS.UPSTREAM):
//check for predicted outgoing flow at the connected child pumpingsation //check for predicted outgoing flow at the connected child pumpingsation
child.measurements.emitter.on("flow.predicted.downstream", (eventData) => { child.measurements.emitter.on("flow.predicted.downstream", (eventData) => {
this.logger.debug(`Flow prediction update from ${child.config.general.id}: ${eventData.value} ${eventData.unit}`); this.logger.debug(`Flow prediction update from ${child.config.general.id}: ${eventData.value} ${eventData.unit}`);
@@ -109,7 +107,7 @@ class pumpingStation {
this.logger.debug(`Listening for flow changes from machine ${child.config.general.id}`); this.logger.debug(`Listening for flow changes from machine ${child.config.general.id}`);
switch(child.config.functionality.positionVsParent){ switch(child.config.functionality.positionVsParent){
case("downstream"): case(POSITIONS.DOWNSTREAM):
//check for predicted outgoing flow at the connected child pumpingsation //check for predicted outgoing flow at the connected child pumpingsation
child.measurements.emitter.on("flow.predicted.downstream", (eventData) => { child.measurements.emitter.on("flow.predicted.downstream", (eventData) => {
this.logger.debug(`Flow prediction update from ${child.config.general.id}: ${eventData.value} ${eventData.unit}`); this.logger.debug(`Flow prediction update from ${child.config.general.id}: ${eventData.value} ${eventData.unit}`);
@@ -118,7 +116,7 @@ class pumpingStation {
}); });
break; break;
case("upstream"): case(POSITIONS.UPSTREAM):
//check for predicted outgoing flow at the connected child pumpingsation //check for predicted outgoing flow at the connected child pumpingsation
child.measurements.emitter.on("flow.predicted.downstream", (eventData) => { child.measurements.emitter.on("flow.predicted.downstream", (eventData) => {
this.logger.debug(`Flow prediction update from ${child.config.general.id}: ${eventData.value} ${eventData.unit}`); this.logger.debug(`Flow prediction update from ${child.config.general.id}: ${eventData.value} ${eventData.unit}`);
@@ -162,7 +160,7 @@ class pumpingStation {
const calcVol = avgFlow * deltaSeconds; const calcVol = avgFlow * deltaSeconds;
//substract seeing as this is downstream and is being pulled away from the pumpingstaion and keep track of status //substract seeing as this is downstream and is being pulled away from the pumpingstaion and keep track of status
const currVolume = this.measurements.type('volume').variant('predicted').position('atEquipment').getCurrentValue('m3'); const currVolume = this.measurements.type('volume').variant('predicted').position(POSITIONS.AT_EQUIPMENT).getCurrentValue('m3');
let newVol = currVolume; let newVol = currVolume;
switch(flowDir){ switch(flowDir){
@@ -179,11 +177,11 @@ class pumpingStation {
} }
this.measurements.type('volume').variant('predicted').position('atEquipment').value(newVol).unit('m3'); this.measurements.type('volume').variant('predicted').position(POSITIONS.AT_EQUIPMENT).value(newVol).unit('m3');
//convert to a predicted level //convert to a predicted level
const newLevel = this._calcLevelFromVolume(newVol); const newLevel = this._calcLevelFromVolume(newVol);
this.measurements.type('level').variant('predicted').position('atEquipment').value(newLevel).unit('m'); this.measurements.type('level').variant('predicted').position(POSITIONS.AT_EQUIPMENT).value(newLevel).unit('m');
this.logger.debug(`new predicted volume : ${newVol} new predicted level: ${newLevel} `); this.logger.debug(`new predicted volume : ${newVol} new predicted level: ${newLevel} `);
@@ -257,13 +255,13 @@ class pumpingStation {
this.measurements.type("pressure").variant("measured").position(position).value(value, context.timestamp, context.unit); this.measurements.type("pressure").variant("measured").position(position).value(value, context.timestamp, context.unit);
//convert pressure to level based on density of water and height of pressure sensor //convert pressure to level based on density of water and height of pressure sensor
const mTemp = this.measurements.type("temperature").variant("measured").position("atEquipment").getCurrentValue('K'); //default to 20C if no temperature measurement const mTemp = this.measurements.type("temperature").variant("measured").position(POSITIONS.AT_EQUIPMENT).getCurrentValue('K'); //default to 20C if no temperature measurement
//prefer measured temp but otherwise assume nominal temp for wastewater //prefer measured temp but otherwise assume nominal temp for wastewater
if(mTemp === null){ if(mTemp === null){
this.logger.warn(`No temperature measurement available, defaulting to 15C for pressure to level conversion.`); this.logger.warn(`No temperature measurement available, defaulting to 15C for pressure to level conversion.`);
this.measurements.type("temperature").variant("assumed").position("atEquipment").value(15, Date.now(), "C"); this.measurements.type("temperature").variant("assumed").position(POSITIONS.AT_EQUIPMENT).value(15, Date.now(), "C");
kelvinTemp = this.measurements.type('temperature').variant('assumed').position('atEquipment').getCurrentValue('K'); kelvinTemp = this.measurements.type('temperature').variant('assumed').position(POSITIONS.AT_EQUIPMENT).getCurrentValue('K');
this.logger.debug(`Temperature is : ${kelvinTemp}`); this.logger.debug(`Temperature is : ${kelvinTemp}`);
} else { } else {
kelvinTemp = mTemp; kelvinTemp = mTemp;
@@ -294,15 +292,14 @@ class pumpingStation {
const proc = this.interpolate.interpolate_lin_single_point(volume,this.basin.minVol,this.basin.maxVolOverflow,0,100); const proc = this.interpolate.interpolate_lin_single_point(volume,this.basin.minVol,this.basin.maxVolOverflow,0,100);
this.logger.debug(`PROC volume : ${proc}`); this.logger.debug(`PROC volume : ${proc}`);
this.measurements.type("volume").variant("measured").position("atEquipment").value(volume).unit('m3'); this.measurements.type("volume").variant("measured").position(POSITIONS.AT_EQUIPMENT).value(volume).unit('m3');
this.measurements.type("volume").variant("procent").position("atEquipment").value(proc); this.measurements.type("volume").variant("procent").position(POSITIONS.AT_EQUIPMENT).value(proc);
} }
_calcNetFlow() { _calcNetFlow() {
let netFlow = null;
const netFlow_FlowSensor = Math.abs(this.measurements.type("flow").variant("measured").difference({ from: "downstream", to: "upstream", unit: "m3/s" })); const netFlow_FlowSensor = Math.abs(this.measurements.type("flow").variant("measured").difference({ from: POSITIONS.DOWNSTREAM, to: POSITIONS.UPSTREAM, unit: "m3/s" }));
const netFlow_LevelSensor = this._calcNetFlowFromLevelDiff(); const netFlow_LevelSensor = this._calcNetFlowFromLevelDiff();
const netFlow_PredictedFlow = Math.abs(this.measurements.type('flow').variant('predicted').difference({ from: "in", to: "out", unit: "m3/s" })); const netFlow_PredictedFlow = Math.abs(this.measurements.type('flow').variant('predicted').difference({ from: "in", to: "out", unit: "m3/s" }));
@@ -325,7 +322,7 @@ class pumpingStation {
_calcRemainingTime(level,variant){ _calcRemainingTime(level,variant){
const { heightOverflow, heightOutlet, surfaceArea } = this.basin; const { heightOverflow, heightOutlet, surfaceArea } = this.basin;
const flowDiff = this.measurements.type("flow").variant(variant).difference({ from: "downstream", to: "upstream", unit: "m3/s" }); const flowDiff = this.measurements.type("flow").variant(variant).difference({ from: POSITIONS.DOWNSTREAM, to: POSITIONS.UPSTREAM, unit: "m3/s" });
let remainingHeight; let remainingHeight;
switch(true){ switch(true){
@@ -374,7 +371,7 @@ class pumpingStation {
_calcNetFlowFromLevelDiff() { _calcNetFlowFromLevelDiff() {
const { surfaceArea } = this.basin; const { surfaceArea } = this.basin;
const levelObj = this.measurements.type("level").variant("measured").position("atEquipment"); const levelObj = this.measurements.type("level").variant("measured").position(POSITIONS.AT_EQUIPMENT);
const level = levelObj.getCurrentValue("m"); const level = levelObj.getCurrentValue("m");
const prevLevel = levelObj.getLaggedValue(2, "m"); // { value, timestamp, unit } const prevLevel = levelObj.getLaggedValue(2, "m"); // { value, timestamp, unit }
const measurement = levelObj.get(); const measurement = levelObj.get();
@@ -426,7 +423,7 @@ class pumpingStation {
this.basin.minVolOut = minVolOut ; this.basin.minVolOut = minVolOut ;
//init predicted min volume to min vol in order to have a starting point //init predicted min volume to min vol in order to have a starting point
this.measurements.type("volume").variant("predicted").position("atEquipment").value(minVol).unit('m3'); this.measurements.type("volume").variant("predicted").position(POSITIONS.AT_EQUIPMENT).value(minVol).unit('m3');
this.logger.debug(` this.logger.debug(`
Basin initialized | area=${surfaceArea.toFixed(2)} m², Basin initialized | area=${surfaceArea.toFixed(2)} m²,
@@ -524,7 +521,7 @@ function createLevelMeasurementConfig(name) {
functionality: { functionality: {
softwareType: "measurement", softwareType: "measurement",
role: "sensor", role: "sensor",
positionVsParent: "atEquipment" positionVsParent: POSITIONS.AT_EQUIPMENT
}, },
asset: { asset: {
category: "sensor", category: "sensor",
@@ -566,7 +563,6 @@ function createFlowMeasurementConfig(name, position) {
function createMachineConfig(name) { function createMachineConfig(name) {
const curve = require('C:/Users/zn375/.node-red/public/fallbackData.json');
return { return {
general: { general: {
@@ -607,7 +603,7 @@ function createMachineStateConfig() {
} }
// convenience for seeding measurements // convenience for seeding measurements
function pushSample(measurement, type, value, unit) { function pushSample(measurement, type, value, unit) { // eslint-disable-line no-unused-vars
const pos = measurement.config.functionality.positionVsParent; const pos = measurement.config.functionality.positionVsParent;
measurement.measurements measurement.measurements
.type(type) .type(type)
@@ -621,9 +617,9 @@ function pushSample(measurement, type, value, unit) {
const station = new PumpingStation(createPumpingStationConfig("PumpingStationDemo")); const station = new PumpingStation(createPumpingStationConfig("PumpingStationDemo"));
const pump = new RotatingMachine(createMachineConfig("Pump1"), createMachineStateConfig()); const pump = new RotatingMachine(createMachineConfig("Pump1"), createMachineStateConfig());
const levelSensor = new Measurement(createLevelMeasurementConfig("WetWellLevel")); const levelSensor = new Measurement(createLevelMeasurementConfig("WetWellLevel")); // eslint-disable-line no-unused-vars
const upstreamFlow = new Measurement(createFlowMeasurementConfig("InfluentFlow", "upstream")); const upstreamFlow = new Measurement(createFlowMeasurementConfig("InfluentFlow", POSITIONS.UPSTREAM)); // eslint-disable-line no-unused-vars
const downstreamFlow = new Measurement(createFlowMeasurementConfig("PumpDischargeFlow", "downstream")); const downstreamFlow = new Measurement(createFlowMeasurementConfig("PumpDischargeFlow", POSITIONS.DOWNSTREAM));
// station uses the sensors // station uses the sensors
@@ -635,7 +631,7 @@ function pushSample(measurement, type, value, unit) {
// pump owns the downstream flow sensor // pump owns the downstream flow sensor
pump.childRegistrationUtils.registerChild(downstreamFlow, downstreamFlow.config.functionality.positionVsParent); pump.childRegistrationUtils.registerChild(downstreamFlow, downstreamFlow.config.functionality.positionVsParent);
station.childRegistrationUtils.registerChild(pump,"downstream"); station.childRegistrationUtils.registerChild(pump, POSITIONS.DOWNSTREAM);
setInterval(() => station.tick(), 1000); setInterval(() => station.tick(), 1000);