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

Reviewed-on: RnD/rotatingMachine#2

rotatingMachine.html

@@ -1,3 +1,13 @@
+<!--
+| S88-niveau             | Primair (blokkleur) | Tekstkleur |
+| ---------------------- | ------------------- | ---------- |
+| **Area**               | `#0f52a5`           | wit        |
+| **Process Cell**       | `#0c99d9`           | wit        |
+| **Unit**               | `#50a8d9`           | zwart      |
+| **Equipment (Module)** | `#86bbdd`           | zwart      |
+| **Control Module**     | `#a9daee`           | zwart      |
+
+-->
 <!-- Load the dynamic menu & config endpoints -->
 <script src="/rotatingMachine/menu.js"></script>
 <script src="/rotatingMachine/configData.js"></script>
@@ -5,7 +15,7 @@
 <script>
   RED.nodes.registerType("rotatingMachine", {
     category: "EVOLV",
-    color: "#4f8582",
+    color: "#86bbdd",
         defaults: {
 
           // Define specific properties
@@ -15,6 +25,7 @@
           shutdown: { value: 0 },
           cooldown: { value: 0 },
           machineCurve: { value: {}},
+          flowNumber: { value: 1, required: true },
 
           //define asset properties
           uuid: { value: "" },
@@ -41,7 +52,7 @@
     outputs: 3,
     inputLabels: ["Input"],
     outputLabels: ["process", "dbase", "parent"],
-    icon: "font-awesome/fa-tachometer",
+    icon: "font-awesome/fa-cog",
 
     label: function () {
       return this.positionIcon + " " + this.category.slice(0, -1) || "Machine";
@@ -68,6 +79,7 @@
     },
     oneditsave: function() {
       const node = this;
+
       // save asset fields
       if (window.EVOLV?.nodes?.rotatingMachine?.assetMenu?.saveEditor) {
         window.EVOLV.nodes.rotatingMachine.assetMenu.saveEditor(this);
@@ -116,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

@@ -62,8 +62,9 @@ class nodeClass {
         unit: uiConfig.unit
       },
       functionality: {
-        positionVsParent: uiConfig.positionVsParent || 'atEquipment', // Default to 'atEquipment' if not specified
+        positionVsParent: uiConfig.positionVsParent
-      }
+      },
+      flowNumber: uiConfig.flowNumber
     };
 
     // Utility for formatting outputs

src/specificClass.js

@@ -1,48 +1,3 @@
-/**
- * @file machine.js
- *
- * Permission is hereby granted to any person obtaining a copy of this software 
- * and associated documentation files (the "Software"), to use it for personal 
- * or non-commercial purposes, with the following restrictions:
- *
- * 1. **No Copying or Redistribution**: The Software or any of its parts may not 
- *    be copied, merged, distributed, sublicensed, or sold without explicit 
- *    prior written permission from the author.
- * 
- * 2. **Commercial Use**: Any use of the Software for commercial purposes requires 
- *    a valid license, obtainable only with the explicit consent of the author.
- * 
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
- * FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER 
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, 
- * OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
- * SOFTWARE.
- *
- * Ownership of this code remains solely with the original author. Unauthorized 
- * use of this Software is strictly prohibited.
- *
- * @summary A class to interact and manipulate machines with a non-euclidian curve
- * @description A class to interact and manipulate machines with a non-euclidian curve
- * @module machine
- * @exports machine
- * @version 0.1.0
- * @since 0.1.0
- * 
- * Author:
- * - Rene De Ren
- * Email:
- * - r.de.ren@brabantsedelta.nl
- * 
- *  Add functionality later
-  // -------- Operational Metrics -------- //
-maintenanceAlert: this.state.checkMaintenanceStatus()
-
-
-*/
-
-//load local dependencies
 const EventEmitter = require('events');
 const {loadCurve,logger,configUtils,configManager,state, nrmse, MeasurementContainer, predict, interpolation , childRegistrationUtils} = require('generalFunctions');
 const { name } = require('../../generalFunctions/src/convert/lodash/lodash._shimkeys');
@@ -113,6 +68,10 @@ class Machine {
       this.updatePosition();
     });
 
+    // used for holding the source and sink unit operations or other object with setInfluent / getEffluent method for e.g. recirculation.
+    this.upstreamSource = null;
+    this.downstreamSink = null;
+
     this.child = {}; // object to hold child information so we know on what to subscribe
     this.childRegistrationUtils = new childRegistrationUtils(this); // Child registration utility
 
@@ -120,16 +79,35 @@ class Machine {
 
   /*-------------------               Register child events               -------------------*/
   registerChild(child, softwareType) {
-    this.logger.debug('Setting up child event listeners');
+    if(!child) {
+      this.logger.error(`Invalid ${softwareType} child provided.`);
+      return;
+    }
 
-    if(softwareType === "measurement"){
+    switch (softwareType) {
-          const position = child.config.functionality.positionVsParent;
+      case "measurement":
-          const measurementType = child.config.asset.type;
+        this.logger.debug(`Registering measurement child...`);
-          const key = `${measurementType}_${position}`;
+        this._connectMeasurement(child);
+        break;
+      case "reactor":
+        this.logger.debug(`Registering reactor child...`);
+        this._connectReactor(child);
+        break;
+      default:
+        this.logger.error(`Unrecognized softwareType: ${softwareType}`);
+    }
+  }
+
+  _connectMeasurement(measurementChild) {
+    const position = measurementChild.config.functionality.positionVsParent;
+    const distance = measurementChild.config.functionality.distanceVsParent || 0;
+    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
-          child.measurements.emitter.on(eventName, (eventData) => {
+    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
@@ -140,32 +118,25 @@ class Machine {
         .value(eventData.value, eventData.timestamp, eventData.unit);      
       
       // Call the appropriate handler
-          this._callMeasurementHandler(measurementType, eventData.value, position, eventData);
-      });
-    }
-  }
-
-// Centralized handler dispatcher
-_callMeasurementHandler(measurementType, value, position, context) {
       switch (measurementType) {
         case 'pressure':
-      this.updateMeasuredPressure(value, position, context);
+          this.updateMeasuredPressure(eventData.value, position, eventData);
           break;
           
         case 'flow':
-      this.updateMeasuredFlow(value, position, context);
+          this.updateMeasuredFlow(eventData.value, position, eventData);
-      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;
       }
+    });
+  }
+
+  _connectReactor(reactorChild) {
+    this.downstreamSink = reactorChild; // downstream from the pumps perpective
   }
 
   //---------------- END child stuff -------------//
@@ -214,37 +185,37 @@ _callMeasurementHandler(measurementType, value, position, context) {
   }
 
   async handleInput(source, action, parameter) {
+
     if (!this.isValidSourceForMode(source, this.currentMode)) {
       let warningTxt = `Source '${source}' is not valid for mode '${this.currentMode}'.`;
       this.logger.warn(warningTxt);
       return {status : false , feedback: warningTxt};
     }
     
-
     this.logger.info(`Handling input from source '${source}' with action '${action}' in mode '${this.currentMode}'.`);
+    
     try {
       switch (action) {
         case "execSequence":
-          await this.executeSequence(parameter);
+          return await this.executeSequence(parameter);
-          //recalc flow and power
+
-          this.updatePosition();
-          break;
         case "execMovement":
-          await this.setpoint(parameter);
+          return await this.setpoint(parameter);
-          break;
+
         case "flowMovement":
           // Calculate the control value for a desired flow
           const pos = this.calcCtrl(parameter);
           // Move to the desired setpoint
-          await this.setpoint(pos);
+          return await this.setpoint(pos);
-          break;
+
         case "emergencyStop":
           this.logger.warn(`Emergency stop activated by '${source}'.`);
-          await this.executeSequence("emergencyStop");
+          return await this.executeSequence("emergencyStop");
-          break;
+
         case "statusCheck":
           this.logger.info(`Status Check: Mode = '${this.currentMode}', Source = '${source}'.`);
           break;
+
         default:
           this.logger.warn(`Action '${action}' is not implemented.`);
           break;
@@ -254,6 +225,13 @@ _callMeasurementHandler(measurementType, value, position, context) {
     } catch (error) {
       this.logger.error(`Error handling input: ${error}`);
     }
+
+  }
+
+  abortMovement(reason = "group override") {
+    if (this.state?.abortCurrentMovement) {
+      this.state.abortCurrentMovement(reason);
+    }
   }
 
   setMode(newMode) {
@@ -294,6 +272,9 @@ _callMeasurementHandler(measurementType, value, position, context) {
         break; // Exit sequence execution on error
       }
     }
+
+    //recalc flow and power
+    this.updatePosition();
   }
 
   async setpoint(setpoint) {
@@ -341,20 +322,20 @@ _callMeasurementHandler(measurementType, value, position, context) {
   calcPower(x) {
     if(this.hasCurve) {
       if (!this._isOperationalState()) {
-        this.measurements.type("power").variant("predicted").position('upstream').value(0);
+        this.measurements.type("power").variant("predicted").position('atEquipment').value(0);
         this.logger.debug(`Machine is not operational. Setting predicted power to 0.`);
         return 0;
       }
     
       //this.predictPower.currentX = x; Decrepated
       const cPower = this.predictPower.y(x);
-      this.measurements.type("power").variant("predicted").position('upstream').value(cPower);
+      this.measurements.type("power").variant("predicted").position('atEquipment').value(cPower);
       //this.logger.debug(`Calculated power: ${cPower} for pressure: ${this.getMeasuredPressure()} and position: ${x}`);
       return cPower;
     }
     // If no curve data is available, log a warning and return 0
     this.logger.warn(`No curve data available for power calculation. Returning 0.`);
-    this.measurements.type("power").variant("predicted").position('upstream').value(0);
+    this.measurements.type("power").variant("predicted").position('atEquipment').value(0);
     return 0;
 
   }
@@ -372,7 +353,7 @@ _callMeasurementHandler(measurementType, value, position, context) {
     
     // If no curve data is available, log a warning and return 0
     this.logger.warn(`No curve data available for power calculation. Returning 0.`);
-    this.measurements.type("power").variant("predicted").position('upstream').value(0);
+    this.measurements.type("power").variant("predicted").position('atEquipment').value(0);
     return 0;
 
   }
@@ -382,14 +363,14 @@ _callMeasurementHandler(measurementType, value, position, context) {
     if(this.hasCurve) {
       this.predictCtrl.currentX = x;
       const cCtrl = this.predictCtrl.y(x);
-      this.measurements.type("ctrl").variant("predicted").position('upstream').value(cCtrl);
+      this.measurements.type("ctrl").variant("predicted").position('atEquipment').value(cCtrl);
       //this.logger.debug(`Calculated ctrl: ${cCtrl} for pressure: ${this.getMeasuredPressure()} and position: ${x}`);
       return cCtrl;
     }
     
     // If no curve data is available, log a warning and return 0
     this.logger.warn(`No curve data available for control calculation. Returning 0.`);
-    this.measurements.type("ctrl").variant("predicted").position('upstream').value(0);
+    this.measurements.type("ctrl").variant("predicted").position('atEquipment').value(0);
     return 0;
 
   }
@@ -400,7 +381,7 @@ _callMeasurementHandler(measurementType, value, position, context) {
     const pressureDiff = this.measurements.type('pressure').variant('measured').difference();
 
     // Both upstream & downstream => differential
-    if (pressureDiff != null) {
+    if (pressureDiff) {
       this.logger.debug(`Pressure differential: ${pressureDiff.value}`);
       this.predictFlow.fDimension = pressureDiff.value;
       this.predictPower.fDimension = pressureDiff.value;
@@ -420,7 +401,7 @@ _callMeasurementHandler(measurementType, value, position, context) {
 
     // Only downstream => use it, warn that it's partial
     if (downstreamPressure != null) {
-      this.logger.warn(`Using downstream pressure only for prediction: ${downstreamPressure} `);
+      this.logger.warn(`Using downstream pressure only for prediction: ${downstreamPressure} This is less acurate!!`);
       this.predictFlow.fDimension = downstreamPressure;
       this.predictPower.fDimension = downstreamPressure;
       this.predictCtrl.fDimension = downstreamPressure;
@@ -502,18 +483,12 @@ _callMeasurementHandler(measurementType, value, position, context) {
     }
   }
 
-  //  ENHANCED: Your existing handler but with rich context
+  // context handler for pressure updates
   updateMeasuredPressure(value, position, context = {}) {
-    //  Your existing operational check
-    if (!this._isOperationalState()) {
-      this.logger.warn(`Machine not operational, skipping pressure update from ${context.childName || 'unknown'}`);
-      return;
-    }
    
-    //  Enhanced logging with child context
     this.logger.debug(`Pressure update: ${value} at ${position} from ${context.childName || 'child'} (${context.childId || 'unknown-id'})`);
     
-    //  Store in parent's measurement container (your existing logic)
+    //  Store in parent's measurement container 
     this.measurements.type("pressure").variant("measured").position(position).value(value, context.timestamp, context.unit);
 
     // Determine what kind of value to use as pressure (upstream , downstream or difference)
@@ -523,8 +498,9 @@ _callMeasurementHandler(measurementType, value, position, context) {
     this.logger.debug(`Using pressure: ${pressure} for calculations`);
   }
 
-  // NEW: Flow handler (following your pattern)
+  // NEW: Flow handler
   updateMeasuredFlow(value, position, context = {}) {
+
     if (!this._isOperationalState()) {
       this.logger.warn(`Machine not operational, skipping flow update from ${context.childName || 'unknown'}`);
       return;
@@ -532,6 +508,10 @@ _callMeasurementHandler(measurementType, value, position, context) {
 
     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);
     
@@ -541,6 +521,12 @@ _callMeasurementHandler(measurementType, value, position, context) {
     }
   }
 
+  _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();
@@ -549,6 +535,7 @@ _callMeasurementHandler(measurementType, value, position, context) {
 
   //what is the internal functions that need updating when something changes that has influence on this.
   updatePosition() {
+    
     if (this._isOperationalState()) {
 
       const currentPosition = this.state.getCurrentPosition();
@@ -660,12 +647,12 @@ _callMeasurementHandler(measurementType, value, position, context) {
 
     if (power != 0 && flow != 0) {
       // Calculate efficiency after measurements update
-      this.measurements.type("efficiency").variant(variant).position('downstream').value((flow / power));
+      this.measurements.type("efficiency").variant(variant).position('atEquipment').value((flow / power));
     } else {
-      this.measurements.type("efficiency").variant(variant).position('downstream').value(null);
+      this.measurements.type("efficiency").variant(variant).position('atEquipment').value(null);
     }
 
-    return this.measurements.type("efficiency").variant(variant).position('downstream').getCurrentValue();
+    return this.measurements.type("efficiency").variant(variant).position('atEquipment').getCurrentValue();
 
   }