Refactor flow handling: rename reactor references to source and sink and fix config minor bug

Reviewed-on: #2

rotatingMachine.html

@@ -24,7 +24,8 @@
           warmup: { value: 0 },
           shutdown: { value: 0 },
           cooldown: { value: 0 },
-          machineCurve : { value: {}},
+          machineCurve: { value: {}},
+          flowNumber: { value: 1, required: true },
 
           //define asset properties
           uuid: { value: "" },
@@ -127,6 +128,10 @@
     <label for="node-input-cooldown"><i class="fa fa-clock-o"></i> Cooldown Time</label>
     <input type="number" id="node-input-cooldown" style="width:60%;" />
   </div>
+  <div class="form-row">
+    <label for="node-input-flowNumber"><i class="fa fa-clock-o"></i> Flow Number</label>
+    <input type="number" id="node-input-flowNumber" style="width:60%;" />
+  </div>
 
   <!-- Asset fields injected here -->
   <div id="asset-fields-placeholder"></div>

src/nodeClass.js

@@ -63,7 +63,8 @@ class nodeClass {
       },
       functionality: {
         positionVsParent: uiConfig.positionVsParent
-      }
+      },
+      flowNumber: uiConfig.flowNumber
     };
 
     // Utility for formatting outputs
@@ -114,8 +115,8 @@ class nodeClass {
     try {
           const mode = m.currentMode;
           const state = m.state.getCurrentState();
-          const flow = Math.round(m.measurements.type("flow").variant("predicted").position('downstream').getCurrentValue('m3/h'));
+          const flow = Math.round(m.measurements.type("flow").variant("predicted").position('downstream').getCurrentValue());
-          const power = Math.round(m.measurements.type("power").variant("predicted").position('atequipment').getCurrentValue('kW'));
+          const power = Math.round(m.measurements.type("power").variant("predicted").position('upstream').getCurrentValue());
           let symbolState;
           switch(state){
             case "off":
@@ -145,9 +146,6 @@ class nodeClass {
             case "decelerating":
               symbolState = "⏪";
               break;
-            case "maintenance":
-              symbolState = "🔧";
-              break;
           }
           const position = m.state.getCurrentPosition();
           const roundedPosition = Math.round(position * 100) / 100;
@@ -227,8 +225,8 @@ class nodeClass {
     //this.source.tick();
 
     const raw = this.source.getOutput();
-    const processMsg = this._output.formatMsg(raw, this.source.config, 'process');
+    const processMsg = this._output.formatMsg(raw, this.config, 'process');
-    const influxMsg  = this._output.formatMsg(raw, this.source.config, 'influxdb');
+    const influxMsg  = this._output.formatMsg(raw, this.config, 'influxdb');
 
     // Send only updated outputs on ports 0 & 1
     this.node.send([processMsg, influxMsg]);

src/specificClass.js

@@ -48,17 +48,7 @@ class Machine {
     this.errorMetrics = new nrmse(errorMetricsConfig, this.logger);
 
     // Initialize measurements
-    this.measurements = new MeasurementContainer({
+    this.measurements = new MeasurementContainer();
-      autoConvert: true,
-      windowSize: 50,
-      defaultUnits: {
-        pressure: 'mbar',
-        flow: this.config.general.unit,
-        power: 'kW',
-        temperature: 'C'
-      }
-    });
-
     this.interpolation = new interpolation();
 
     this.flowDrift = null;
@@ -78,97 +68,94 @@ class Machine {
       this.updatePosition();
     });
 
-    //When state changes look if we need to do other updates
+    // used for holding the source and sink unit operations or other object with setInfluent / getEffluent method for e.g. recirculation.
-    this.state.emitter.on("stateChange", (newState) => {
+    this.upstreamSource = null;
-      this.logger.debug(`State change detected: ${newState}`);
+    this.downstreamSink = null;
-      this._updateState();
-    });
 
     this.child = {}; // object to hold child information so we know on what to subscribe
     this.childRegistrationUtils = new childRegistrationUtils(this); // Child registration utility
 
   }
 
-  _updateState(){
-    const isOperational = this._isOperationalState();
-    if(!isOperational){
-      //overrule the last prediction this should be 0 now
-      this.measurements.type("flow").variant("predicted").position("downstream").value(0);
-    }
-  }
-
   /*-------------------               Register child events               -------------------*/
   registerChild(child, softwareType) {
-    this.logger.debug('Setting up child event for softwaretype ' + softwareType);
+    if(!child) {
+      this.logger.error(`Invalid ${softwareType} child provided.`);
+      return;
+    }
 
-    if(softwareType === "measurement"){
+    switch (softwareType) {
-          const position = child.config.functionality.positionVsParent;
+      case "measurement":
-          const distance = child.config.functionality.distanceVsParent || 0;
+        this.logger.debug(`Registering measurement child...`);
-          const measurementType = child.config.asset.type;
+        this._connectMeasurement(child);
-          const key = `${measurementType}_${position}`;
+        break;
-          //rebuild to measurementype.variant no position and then switch based on values not strings or names.
+      case "reactor":
-          const eventName = `${measurementType}.measured.${position}`;
+        this.logger.debug(`Registering reactor child...`);
+        this._connectReactor(child);
+        break;
+      default:
+        this.logger.error(`Unrecognized softwareType: ${softwareType}`);
+    }
+  }
 
-          this.logger.debug(`Setting up listener for ${eventName} from child ${child.config.general.name}`);
+  _connectMeasurement(measurementChild) {
-          // Register event listener for measurement updates
+    const position = measurementChild.config.functionality.positionVsParent;
-          child.measurements.emitter.on(eventName, (eventData) => {
+    const distance = measurementChild.config.functionality.distanceVsParent || 0;
-          this.logger.debug(`🔄 ${position} ${measurementType} from ${eventData.childName}: ${eventData.value} ${eventData.unit}`);
+    const measurementType = measurementChild.config.asset.type;
+    //rebuild to measurementype.variant no position and then switch based on values not strings or names.
+    const eventName = `${measurementType}.measured.${position}`;
+
+    this.logger.debug(`Setting up listener for ${eventName} from child ${measurementChild.config.general.name}`);
+    // Register event listener for measurement updates
+    measurementChild.measurements.emitter.on(eventName, (eventData) => {
+      this.logger.debug(`🔄 ${position} ${measurementType} from ${eventData.childName}: ${eventData.value} ${eventData.unit}`);
+
+      // Store directly in parent's measurement container
+      this.measurements
+        .type(measurementType)
+        .variant("measured")
+        .position(position)
+        .value(eventData.value, eventData.timestamp, eventData.unit);      
       
-
+      // Call the appropriate handler
-          console.log(` Emitting... ${eventName} with data:`);
+      switch (measurementType) {
-          // Store directly in parent's measurement container
+        case 'pressure':
-          this.measurements
+          this.updateMeasuredPressure(eventData.value, position, eventData);
-            .type(measurementType)
+          break;
-            .variant("measured")
-            .position(position)
-            .value(eventData.value, eventData.timestamp, eventData.unit);
           
-          // Call the appropriate handler
+        case 'flow':
-          this._callMeasurementHandler(measurementType, eventData.value, position, eventData);
+          this.updateMeasuredFlow(eventData.value, position, eventData);
-      });
+          break;
-    }
+          
+        default:
+          this.logger.warn(`No handler for measurement type: ${measurementType}`);
+          // Generic handler - just update position
+          this.updatePosition();
+      }
+    });
   }
 
-// Centralized handler dispatcher
+  _connectReactor(reactorChild) {
-_callMeasurementHandler(measurementType, value, position, context) {
+    this.downstreamSink = reactorChild; // downstream from the pumps perpective
-  switch (measurementType) {
-    case 'pressure':
-      this.updateMeasuredPressure(value, position, context);
-      break;
-      
-    case 'flow':
-      this.updateMeasuredFlow(value, position, context);
-      break;
-      
-    case 'temperature':
-      this.updateMeasuredTemperature(value, position, context);
-      break;
-      
-    default:
-      this.logger.warn(`No handler for measurement type: ${measurementType}`);
-      // Generic handler - just update position
-      this.updatePosition();
-      break;
   }
-}
 
-//---------------- END child stuff -------------//
+  //---------------- END child stuff -------------//
 
-    // Method to assess drift using errorMetrics
+  // Method to assess drift using errorMetrics
-    assessDrift(measurement, processMin, processMax) {
+  assessDrift(measurement, processMin, processMax) {
-      this.logger.debug(`Assessing drift for measurement: ${measurement} processMin: ${processMin} processMax: ${processMax}`);
+    this.logger.debug(`Assessing drift for measurement: ${measurement} processMin: ${processMin} processMax: ${processMax}`);
-      const predictedMeasurement = this.measurements.type(measurement).variant("predicted").position("downstream").getAllValues().values;
+    const predictedMeasurement = this.measurements.type(measurement).variant("predicted").position("downstream").getAllValues().values;
-      const measuredMeasurement = this.measurements.type(measurement).variant("measured").position("downstream").getAllValues().values;
+    const measuredMeasurement = this.measurements.type(measurement).variant("measured").position("downstream").getAllValues().values;
 
-      if (!predictedMeasurement || !measuredMeasurement) return null;
+    if (!predictedMeasurement || !measuredMeasurement) return null;
-      
+    
-      return this.errorMetrics.assessDrift(
+    return this.errorMetrics.assessDrift(
-        predictedMeasurement,
+      predictedMeasurement,
-        measuredMeasurement,
+      measuredMeasurement,
-        processMin,
+      processMin,
-        processMax
+      processMax
-      );
+    );
-    }
+  }
 
   reverseCurve(curve) {
     const reversedCurve = {};
@@ -189,65 +176,43 @@ _callMeasurementHandler(measurementType, value, position, context) {
   // -------- Mode and Input Management -------- //
   isValidSourceForMode(source, mode) {
     const allowedSourcesSet = this.config.mode.allowedSources[mode] || [];
-    const allowed = allowedSourcesSet.has(source);
+    return allowedSourcesSet.has(source);
-    allowed? 
-    this.logger.debug(`source is allowed proceeding with ${source} for mode ${mode}`) : 
-    this.logger.warn(`${source} is not allowed in mode ${mode}`);
-
-    return allowed;
   }
 
   isValidActionForMode(action, mode) {
     const allowedActionsSet = this.config.mode.allowedActions[mode] || [];
-    const allowed = allowedActionsSet.has(action);
+    return allowedActionsSet.has(action);
-    allowed ? 
-    this.logger.debug(`Action is allowed proceeding with ${action} for mode ${mode}`) : 
-    this.logger.warn(`${action} is not allowed in mode ${mode}`);
-
-    return allowed;
   }
 
   async handleInput(source, action, parameter) {
 
-    //sanitize input
+    if (!this.isValidSourceForMode(source, this.currentMode)) {
-    if( typeof action !== 'string'){this.logger.error(`Action must be string`); return;}
+      let warningTxt = `Source '${source}' is not valid for mode '${this.currentMode}'.`;
-    //convert to lower case to avoid to many mistakes in commands
+      this.logger.warn(warningTxt);
-    action = action.toLowerCase();
+      return {status : false , feedback: warningTxt};
-
+    }
-    // check for validity of the request
-    if(!this.isValidActionForMode(action,this.currentMode)){return ;}
-    if (!this.isValidSourceForMode(source, this.currentMode)) {return ;}
     
     this.logger.info(`Handling input from source '${source}' with action '${action}' in mode '${this.currentMode}'.`);
     
     try {
       switch (action) {
-
+        case "execSequence":
-        case "execsequence":
           return await this.executeSequence(parameter);
 
-        case "execmovement":
+        case "execMovement":
           return await this.setpoint(parameter);
 
-        case "entermaintenance":
+        case "flowMovement":
-           
-          return await this.executeSequence(parameter);
-
-        
-        case "exitmaintenance":
-          return await this.executeSequence(parameter);
-
-        case "flowmovement":
           // Calculate the control value for a desired flow
           const pos = this.calcCtrl(parameter);
           // Move to the desired setpoint
           return await this.setpoint(pos);
 
-        case "emergencystop":
+        case "emergencyStop":
           this.logger.warn(`Emergency stop activated by '${source}'.`);
           return await this.executeSequence("emergencyStop");
 
-        case "statuscheck":
+        case "statusCheck":
           this.logger.info(`Status Check: Mode = '${this.currentMode}', Source = '${source}'.`);
           break;
 
@@ -535,26 +500,36 @@ _callMeasurementHandler(measurementType, value, position, context) {
 
   // NEW: Flow handler
   updateMeasuredFlow(value, position, context = {}) {
+
     if (!this._isOperationalState()) {
       this.logger.warn(`Machine not operational, skipping flow update from ${context.childName || 'unknown'}`);
       return;
     }
 
     this.logger.debug(`Flow update: ${value} at ${position} from ${context.childName || 'child'}`);
+
+    if (this.upstreamSource && this.downstreamSink) {
+      this._updateSourceSink();
+    }
     
     // Store in parent's measurement container
     this.measurements.type("flow").variant("measured").position(position).value(value, context.timestamp, context.unit);
     
     // Update predicted flow if you have prediction capability
     if (this.predictFlow) {
-      this.measurements.type("flow").variant("predicted").position("downstream").value(this.predictFlow.outputY || 0);
+      this.measurements.type("flow").variant("predicted").position("atEquipment").value(this.predictFlow.outputY || 0);
     }
   }
 
+  _updateSourceSink() {
+    // Handles flow according to the configured "flow number"
+    this.logger.debug(`Updating source-sink pair: ${this.upstreamSource.config.functionality.softwareType} - ${this.downstreamSink.config.functionality.softwareType}`);
+    this.downstreamSink.setInfluent = this.upstreamSource.getEffluent[this.config.flowNumber];
+  }
+
   // Helper method for operational state check
   _isOperationalState() {
     const state = this.state.getCurrentState();
-    this.logger.debug(`Checking operational state ${this.state.getCurrentState()} ? ${["operational", "accelerating", "decelerating"].includes(state)}`);
     return ["operational", "accelerating", "decelerating"].includes(state);
   }
 
@@ -578,9 +553,6 @@ _callMeasurementHandler(measurementType, value, position, context) {
       this.calcDistanceBEP(efficiency,cog,minEfficiency);
 
     }
-
-    
-
   }
 
   calcDistanceFromPeak(currentEfficiency,peakEfficiency){
@@ -611,6 +583,7 @@ _callMeasurementHandler(measurementType, value, position, context) {
     };
   }
 
+
    // Calculate the center of gravity for current pressure
   calcCog() {
 
@@ -726,12 +699,23 @@ _callMeasurementHandler(measurementType, value, position, context) {
 
     // Improved output object generation
     const output = {};
+    //build the output object
+    this.measurements.getTypes().forEach(type => {
+      this.measurements.getVariants(type).forEach(variant => {
 
-    Object.entries(this.measurements.measurements).forEach(([type, variants]) => {
+        const downstreamVal = this.measurements.type(type).variant(variant).position("downstream").getCurrentValue();
-      Object.entries(variants).forEach(([variant, positions]) => {
+        const upstreamVal = this.measurements.type(type).variant(variant).position("upstream").getCurrentValue();
-        Object.entries(positions).forEach(([position, measurement]) => {
+
-          output[`${type}.${variant}.${position}`] = measurement.getCurrentValue();
+        if (downstreamVal != null) {
-        });
+          output[`downstream_${variant}_${type}`] = downstreamVal;
+        }
+        if (upstreamVal != null) {
+          output[`upstream_${variant}_${type}`] = upstreamVal;
+        }
+        if (downstreamVal != null && upstreamVal != null) {
+          const diffVal = this.measurements.type(type).variant(variant).difference().value;
+          output[`differential_${variant}_${type}`] = diffVal;
+        }
       });
     });
 
@@ -744,7 +728,6 @@ _callMeasurementHandler(measurementType, value, position, context) {
     output["cog"] = this.cog; // flow / power efficiency
     output["NCog"] = this.NCog; // normalized cog
     output["NCogPercent"] = Math.round(this.NCog * 100 * 100) / 100 ;
-    output["maintenanceTime"] = this.state.getMaintenanceTimeHours();
 
     if(this.flowDrift != null){
       const flowDrift = this.flowDrift;