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";
@@ -117,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
@@ -115,7 +116,7 @@ class nodeClass {
           const mode = m.currentMode;
           const state = m.state.getCurrentState();
           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());
+          const power = Math.round(m.measurements.type("power").variant("predicted").position('upstream').getCurrentValue());
           let symbolState;
           switch(state){
             case "off":

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 remainregisterChilds 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,23 +79,37 @@ class Machine {
 
   /*-------------------               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;
+      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 ${child.config.general.name}`);
+    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}`);
 
-
-          console.log(` Emitting... ${eventName} with data:`);
       // Store directly in parent's measurement container
       this.measurements
         .type(measurementType)
@@ -145,28 +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;
           
         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 -------------//
@@ -513,13 +483,12 @@ _callMeasurementHandler(measurementType, value, position, context) {
     }
   }
 
-  //  rich context handler for pressure updates
+  // context handler for pressure updates
   updateMeasuredPressure(value, position, context = {}) {
    
-    //  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)
@@ -531,6 +500,7 @@ _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;
@@ -538,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);
     
@@ -547,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();
@@ -771,9 +751,9 @@ _callMeasurementHandler(measurementType, value, position, context) {
 module.exports = Machine;
 
 /*-------------------               Testing               -------------------*/
-
 /*
-//curve = require('C:/Users/zn375/.node-red/public/fallbackData.json');
+
+curve = require('C:/Users/zn375/.node-red/public/fallbackData.json');
 
 //import a child
 const Child = require('../../measurement/src/specificClass');
@@ -789,6 +769,7 @@ const PT1 = new Child(config={
   },
   functionality:{
     softwareType:"measurement",
+    positionVsParent:"upstream",
   },
   asset:{
     supplier:"Vega",
@@ -810,6 +791,7 @@ const PT2 = new Child(config={
   },
   functionality:{
     softwareType:"measurement",
+    positionVsParent:"upstream",
   },
   asset:{
     supplier:"Vega",
@@ -825,17 +807,18 @@ console.log(`Creating machine...`);
 
 const machineConfig = {
   general: {
-      name: "Hidrostal",
+      name: "Hydrostal",
       logging: {
           enabled: true,
           logLevel: "debug",
       }
   },
   asset: {
-      supplier: "Hidrostal",
+      supplier: "Hydrostal",
       type: "pump",
       category: "centrifugal",
-      model: "hidrostal-H05K-S03R", // Ensure this field is present.
+      model: "H05K-S03R+HGM1X-X280KO", // Ensure this field is present.
+      machineCurve: curve["machineCurves"]["Hydrostal"]["H05K-S03R+HGM1X-X280KO"],
   }
 }
 
@@ -864,17 +847,18 @@ const machine = new Machine(machineConfig, stateConfig);
 machine.logger.info(`Registering child...`);
 machine.childRegistrationUtils.registerChild(PT1, "upstream");
 machine.childRegistrationUtils.registerChild(PT2, "downstream");
-/*
+
+//feed curve to the machine class
+//machine.updateCurve(curve["machineCurves"]["Hydrostal"]["H05K-S03R+HGM1X-X280KO"]);
+
 PT1.logger.info(`Enable sim...`);
 PT1.toggleSimulation();
 PT2.logger.info(`Enable sim...`);
 PT2.toggleSimulation();
-*/
+machine.getOutput();
-
-
 //manual test
 //machine.handleInput("parent", "execSequence", "startup");
-/*
+
 machine.measurements.type("pressure").variant("measured").position('upstream').value(-200);
 machine.measurements.type("pressure").variant("measured").position('downstream').value(1000);
 
@@ -884,8 +868,8 @@ const tickLoop = setInterval(changeInput,1000);
 
 function changeInput(){
   PT1.logger.info(`tick...`);
-  //PT1.tick();
+  PT1.tick();
-  //PT2.tick();
+  PT2.tick();
 }
 
 async function testingSequences(){