Index: firmware/App/Services/Reservoirs.c =================================================================== diff -u -r5b448e81db260e5b041699a83c6f2a3faa260ea9 -r487d3524cbf3b50dad1308fc1f68b733cc00c4cd --- firmware/App/Services/Reservoirs.c (.../Reservoirs.c) (revision 5b448e81db260e5b041699a83c6f2a3faa260ea9) +++ firmware/App/Services/Reservoirs.c (.../Reservoirs.c) (revision 487d3524cbf3b50dad1308fc1f68b733cc00c4cd) @@ -1,7 +1,20 @@ +/************************************************************************** +* +* Copyright (c) 2021-2023 Diality Inc. - All Rights Reserved. +* +* THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN +* WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. +* +* @file Reservoirs.c +* +* @author (last) Sean Nash +* @date (last) 18-Jul-2023 +* +* @author (original) Dara Navaei +* @date (original) 21-Nov-2021 +* +***************************************************************************/ - -// TODO the copyright will be added automatically - #include // For reservoir management calculations #include "DGInterface.h" @@ -18,27 +31,35 @@ // ********** private definitions ********** -#define RESERVOIR_SETTLE_TIME_MS 5000 ///< Allocated time to settle the filled reservoir in milliseconds. +#define RESERVOIR_FRESH_SETTLE_TIME_MS 15000 ///< Allocated time to settle the freshly filled reservoir in milliseconds. +#define RESERVOIR_USED_SETTLE_TIME_MS 5000 ///< Allocated time to settle the depleted reservoir in milliseconds. #define RESERVOIR_CYCLE_EXTRA_MARGIN_TIME_MS 8000 ///< Reservoir extra time in during the cycle for error in milliseconds. -#define MAX_RESERVOIR_VOLUME_ML 1950.0 ///< Maximum allowed fluid in a reservoir in milliliters. +#define MAX_RESERVOIR_VOLUME_ML 1900.0F ///< Maximum allowed fluid in a reservoir in milliliters. #define MAX_RESERVOIR_DILUTION 0.15F ///< Maximum reservoir dilution limit. -#define MAX_RESERVOIR_RECIRCULATION 1.1F ///< Maximum reservoir recirculation limit. +#define MAX_RESERVOIR_RECIRCULATION_400_MLP 1.1F ///< Maximum reservoir recirculation limit <= 400mL/m. +#define MAX_RESERVOIR_RECIRCULATION_450_MLP 1.15F ///< Maximum reservoir recirculation limit <= 450mL/m. +#define MAX_RESERVOIR_RECIRCULATION_500_MLP 1.2F ///< Maximum reservoir recirculation limit <= 500mL/m. +#define MAX_RESERVOIR_RECIRCULATION_550_MLP 1.3F ///< Maximum reservoir recirculation limit <= 550mL/m. +#define MAX_RESERVOIR_RECIRCULATION_600_MLP 1.4F ///< Maximum reservoir recirculation limit <= 600mL/m. +#define RESERVOIR_FLOW_400_MLP 400.0F ///< Reservoir flow rate 400mL/m. +#define RESERVOIR_FLOW_450_MLP 450.0F ///< Reservoir flow rate 450mL/m. +#define RESERVOIR_FLOW_500_MLP 500.0F ///< Reservoir flow rate 500mL/m. +#define RESERVOIR_FLOW_550_MLP 550.0F ///< Reservoir flow rate 550mL/m. +#define RESERVOIR_FLOW_600_MLP 600.0F ///< Reservoir flow rate 600mL/m. #define MAX_RESERVOIR_DEPLETION_TIME_MS ( 30 * SEC_PER_MIN * MS_PER_SECOND ) ///< Maximum allowed depletion time in milliseconds. #define RESERVOIR_DATA_PUB_INTERVAL ( MS_PER_SECOND / TASK_GENERAL_INTERVAL ) ///< Interval (ms/task time) at which the reservoir data is published on the CAN bus. -#define DIALYSATE_FLOW_RATE_350_ML_PER_MIN 0.35F ///< Dialysate flow rate 350 mL/min. -#define DIALYSATE_FLOW_RATE_400_ML_PER_MIN 0.4F ///< Dialysate flow rate 400 mL/min. -#define DIALYSATE_FLOW_RATE_500_ML_PER_MIN 0.5F ///< Dialysate flow rate 500 mL/min. -#define DIALYSATE_FLOW_RATE_550_ML_PER_MIN 0.55F ///< Dialysate flow rate 550 mL/min. -#define TGT_FILL_FLOW_FOR_DIA_FLOW_100_TO_350_ML_PER_MIN 0.5F ///< Target fill flow rate for dialysate flow rates in between 100 to 350 mL/min. -#define TGT_FILL_FLOW_FOR_DIA_FLOW_550_TO_600_ML_PER_MIN 0.8F ///< Target fill flow rate for dialysate flow rates in between 500 to 600 mL/min. +#define TGT_FILL_FLOW_800_ML_PER_MIN 0.8F ///< Target fill flow rate 800 mL/min. +#define TGT_FILL_FLOW_ERROR_ALLOWANCE 0.9F ///< Target fill flow rate for dialysate allowed error percentage. #define DIA_FLOW_TO_FILL_FLOW_SECOND_ORDER_COEFF 10.0F ///< Dialysate flow rate to fill flow rate second order coefficient. #define DIA_FLOW_TO_FILL_FLOW_FIRST_ORDER_COEFF 7.5F ///< Dialysate flow rate to fill flow rate first order coefficient. #define DIA_FLOW_TO_FILL_FLOW_CONSTANT 2.0F ///< Dialysate flow rate to fill flow rate constant. +#define MAX_RESERVOIR_VOL_BEFORE_SWITCH_ML 1900.0F ///< Maximum reservoir volume before we switch reservoirs (in mL). + // ********** private data ********** /// States of the treatment reservoir management state machine. @@ -54,40 +75,38 @@ } TREATMENT_RESERVOIR_MGMT_STATE_T; static TREATMENT_RESERVOIR_MGMT_STATE_T reservoirsState; ///< Treatment mode's reservoirs state. -static U32 timeStartMS = 0; ///< Active reservoir start time in milliseconds. -static U32 timeDepleteMS = 0; ///< Active reservoir depletion time in milliseconds. -static F32 volSpentML = 0.0; ///< Active reservoir spent volume in milliliters. -static U32 reservoirPublicationCounter = 0; ///< Reservoirs data publication timer counter. -static F32 dilutionLevelPct = 0.0; ///< Reservoir dilution level. -static DG_OP_MODE_T dgOpMode = DG_MODE_INIT; ///< DG operation mode. -static U32 dgSubMode = 0; ///< DG operation submode. -static U32 timeReservoirInUseMS = 0; ///< Reservoir time in use in milliseconds. -static F32 volSpentUFML = 0.0; ///< Ultrafiltration volume in milliliters. +static U32 timeStartMS; ///< Active reservoir start time in milliseconds. +static U32 timeDepleteMS; ///< Active reservoir depletion time in milliseconds. +static F32 volSpentML; ///< Active reservoir spent volume in milliliters. +static U32 reservoirPublicationCounter; ///< Reservoirs data publication timer counter. +static F32 dilutionLevelPct; ///< Reservoir dilution level. +static DG_OP_MODE_T dgOpMode; ///< DG operation mode. +static U32 dgSubMode; ///< DG operation submode. +static U32 timeReservoirInUse; ///< Reservoir time in use in general task intervals. +static U32 timeReservoirInUF; ///< Reservoir time in ultrafiltration (in ms). +static U32 lastTimeReservoirInUF; ///< Reservoir time in ultrafiltration from prior reservoir (in ms). +static F32 volSpentUFML; ///< Ultrafiltration volume in milliliters. static DG_RESERVOIR_ID_T activeReservoir; ///< Active reservoir. -static F32 recirculationLevelPct = 0.0; ///< Recirculation level in percent. -static U32 reservoirSwitchStartTimeMS = 0; ///< Reservoir switch start time in milliseconds. -static S32 timeWaitToFillMS = 0; ///< Time to wait to fill in milliseconds. -static F32 targetFillFlowLPM = 0.0; ///< Target fill flow in liters/minutes. -static U32 previousDialysateFlowMLP = 0; ///< Previous dialysate flow rate in mL/min. -static F32 previousUFFlowMLP = 0.0; ///< Previous ultrafiltration flow rate in mL/min. +static F32 recirculationLevelPct; ///< Recirculation level in percent. +static U32 reservoirSwitchStartTimeMS; ///< Reservoir switch start time in milliseconds. +static S32 timeWaitToFillMS; ///< Time to wait to fill in milliseconds. +static F32 targetFillFlowLPM; ///< Target fill flow in liters/minutes. +static U32 previousDialysateFlowMLP; ///< Previous dialysate flow rate in mL/min. +static F32 previousUFFlowMLP; ///< Previous ultrafiltration flow rate in mL/min. static DG_MIXING_RATIOS_T ratios; ///< Mixing ratios and fill prep time in milliseconds structure. static const F32 RESERVOIR_DILUTION_RATIO = MAX_RESERVOIR_DILUTION / ( 1.0 - MAX_RESERVOIR_DILUTION ); ///< Reservoir dilution ratio. -// TODO remove -// FALSE for reservoir 1 and TRUE for reservoir 2 -static BOOL test = TRUE; -// TODO remove - // ********** private function prototypes ********** // Reservoir management functions -static void checkReservoirDepletionTime( void ); static void checkReservoirMaxVolume( void ); static F32 getTargetFillFlowRateLPM( void ); static U32 getFillTimeMS( void ); static void calculateActiveReservoirCycleTime( void ); +static F32 getReservoirRecirculationMaxPercent( void ); static void publishReservoirData( void ); +static BOOL isDialysateTempAlarmActive( void ); static TREATMENT_RESERVOIR_MGMT_STATE_T handleReservoirMgmtStartState( void ); static TREATMENT_RESERVOIR_MGMT_STATE_T handleReservoirMgmtDrainState( void ); @@ -103,7 +122,7 @@ * @details Inputs: none * @details Outputs: reservoirsState, timeStartMS, timeDepletionMS, volTotalMl, * volSpentMl, reservoirsPublicationCounter, dilutionLevelPct, dgOpMode, dgSubMode, - * timeReservoirInUseMS, volSpentUFML, activeReservoir, recirculationLevelPct, + * timeReservoirInUse, volSpentUFML, activeReservoir, recirculationLevelPct, * reservoirSwitchStartTimeMS, timeWaitToFillMS, targetFillFlowLPM, ratios * previousDialysateFlowRate * @return none @@ -114,21 +133,24 @@ reservoirsState = TREATMENT_RESERVOIR_MGMT_START_STATE; timeStartMS = getMSTimerCount(); timeDepleteMS = 0; - volSpentML = 0.0; + volSpentML = 0.0F; reservoirPublicationCounter = 0; - dilutionLevelPct = 0.0; + dilutionLevelPct = 0.0F; dgOpMode = DG_MODE_INIT; dgSubMode = 0; - timeReservoirInUseMS = 0; - volSpentUFML = 0.0; - activeReservoir = DG_RESERVOIR_1; - recirculationLevelPct = 0.0; + timeReservoirInUse = 0; + timeReservoirInUF = 0; + lastTimeReservoirInUF = 0; + volSpentUFML = 0.0F; + activeReservoir = getDGActiveReservoir(); + recirculationLevelPct = 0.0F; reservoirSwitchStartTimeMS = 0; timeWaitToFillMS = 0; - targetFillFlowLPM = 0.0; + targetFillFlowLPM = 0.0F; previousDialysateFlowMLP = 0; - ratios.acidMixingRatio = 0.0; - ratios.bicarbMixingRatio = 0.0; + previousUFFlowMLP = 0.0F; + ratios.acidMixingRatio = 0.0F; + ratios.bicarbMixingRatio = 0.0F; ratios.timeFillPrepMS = 0; } @@ -149,8 +171,8 @@ * @brief * The execReservoirs function executes the state machine for the treatment * reservoir management during treatment mode. - * @details Inputs: reservoirsStatus - * @details Outputs: reservoirsStatus + * @details Inputs: reservoirsState + * @details Outputs: reservoirsState, timeReservoirInUse, volSpentML, recirculationLevelPct * @return none *************************************************************************/ void execReservoirs( void ) @@ -164,17 +186,25 @@ dgSubMode = getDGSubMode(); ratios = getDGMixingRatios(); - checkReservoirDepletionTime(); checkReservoirMaxVolume(); calculateActiveReservoirCycleTime(); - // TODO do we need this? Should we not call the reservoir management exec function in saline bolus? - - // Calculate volume used from active reservoir - do not accumulate if saline bolus is in progress - if ( getSalineBolusState() != SALINE_BOLUS_STATE_IN_PROGRESS ) + // Calculate volume used from active reservoir - do not accumulate if not performing dialysis or saline bolus is in progress + if ( ( TREATMENT_DIALYSIS_STATE == getTreatmentState() ) && ( getDialysisState() != DIALYSIS_SALINE_BOLUS_STATE ) ) { - volSpentML += ( flowRateMLPerMS * msSinceLastVolumeCalc ); +#ifdef DIALYZER_REPRIME_ENABLED + if ( getDialysisState() != DIALYSIS_DIALYZER_REPRIME_STATE ) + { +#endif + volSpentML += ( flowRateMLPerMS * msSinceLastVolumeCalc ); + timeReservoirInUse++; + // Check the recirculation level + recirculationLevelPct = volSpentML / (F32)FILL_RESERVOIR_TO_VOLUME_ML; +#ifdef DIALYZER_REPRIME_ENABLED + } +#endif } + // Update the reservoir start time timeStartMS = getMSTimerCount(); @@ -215,42 +245,32 @@ /*********************************************************************//** * @brief - * The setDialysateHeatingParams function is an API to call other internal - * functions to set the trimmer's heater target temperature and times that are - * required to calculated the heaters target temperature in DG. + * The getLastReservoirUFTimeInMs function returns the reservoir ultrafiltration + * time (in ms) for the last reservoir used in treatment. * @details Inputs: none * @details Outputs: none - * @return none + * @return lastTimeReservoirInUF *************************************************************************/ -void setDialysateHeatingParams( void ) +U32 getLastReservoirUFTimeInMs( void ) { - calculateActiveReservoirCycleTime(); + return lastTimeReservoirInUF; } -// ********** private functions ********** - /*********************************************************************//** * @brief - * The checkReservoirDepletionTime function checks whether the active reservoir's - * depletion time has elapsed or not. If it has elapsed, it raises an alarm. - * @details Inputs: timeStartMS - * @details Outputs: none - * @return none + * The updateReservoirUFTime function updates the reservoir ultrafiltration + * time (in ms) for currently active reservoir used in treatment. + * @details Inputs: timeReservoirInUF + * @details Outputs: timeReservoirInUF + * @return lastTimeReservoirInUF *************************************************************************/ -static void checkReservoirDepletionTime( void ) +void updateReservoirUFTime( void ) { - // Check if the time that the reservoir has been use has exceeded the limit - if ( TRUE == didTimeout( timeReservoirInUseMS, MAX_RESERVOIR_DEPLETION_TIME_MS ) ) - { -#ifndef _RELEASE_ - if ( getSoftwareConfigStatus( SW_CONFIG_DISABLE_RESERVOIRS_ALARMS ) != SW_CONFIG_ENABLE_VALUE ) -#endif - { - SET_ALARM_WITH_1_U32_DATA( ALARM_ID_HD_ACTIVE_RESERVOIR_DEPLETION_TIME_OUT, calcTimeSince( timeReservoirInUseMS ) ) - } - } + timeReservoirInUF += TASK_GENERAL_INTERVAL; } +// ********** private functions ********** + /*********************************************************************//** * @brief * The checkReservoirMaxVolume function checks whether the active reservoir's @@ -275,31 +295,13 @@ * The getTargetFillFlowRateLPM function sets the target fill flow rate for DG * based on the target dialysate flow rate. * @details Inputs: none - * @details Outputs: none + * @details Outputs: targetFillFlowLPM * @return target fill flow rate *************************************************************************/ static F32 getTargetFillFlowRateLPM( void ) { - F32 fillFlowRate = 0.0; + F32 fillFlowRate = TGT_FILL_FLOW_800_ML_PER_MIN; - // Get the current dialysate flow rate set by the user and convert it L/min - F32 dialysateFlow = (F32)getTreatmentParameterU32( TREATMENT_PARAM_DIALYSATE_FLOW ) / ML_PER_LITER; - - if ( dialysateFlow <= DIALYSATE_FLOW_RATE_350_ML_PER_MIN ) - { - fillFlowRate = TGT_FILL_FLOW_FOR_DIA_FLOW_100_TO_350_ML_PER_MIN; - } - else if ( ( dialysateFlow >= DIALYSATE_FLOW_RATE_400_ML_PER_MIN ) && ( dialysateFlow <= DIALYSATE_FLOW_RATE_500_ML_PER_MIN ) ) - { - // fill flow = 10 x dialysate_flow ^ 2 - 7.5 x dialysate_flow + 2.0 - fillFlowRate = pow( dialysateFlow, 2 ) * DIA_FLOW_TO_FILL_FLOW_SECOND_ORDER_COEFF - - dialysateFlow * DIA_FLOW_TO_FILL_FLOW_FIRST_ORDER_COEFF + DIA_FLOW_TO_FILL_FLOW_CONSTANT; - } - else if ( dialysateFlow >= DIALYSATE_FLOW_RATE_550_ML_PER_MIN ) - { - fillFlowRate = TGT_FILL_FLOW_FOR_DIA_FLOW_550_TO_600_ML_PER_MIN; - } - targetFillFlowLPM = fillFlowRate; return fillFlowRate; @@ -308,13 +310,14 @@ /*********************************************************************//** * @brief * The getFillTimeMS function calculates the fill time in milliseconds. - * @details Inputs: none + * @details Inputs: ratios * @details Outputs: none - * @return target fill flow rate + * @return target maximum fill time *************************************************************************/ static U32 getFillTimeMS( void ) { - F32 targetFillFlowRate = getTargetFillFlowRateLPM(); + // Get target flow * error allowance to make sure there is enough time to fill + F32 targetFillFlowRate = getTargetFillFlowRateLPM() * TGT_FILL_FLOW_ERROR_ALLOWANCE; // The target fill flow rate is RO flow rate plus acid and bicarb flow rates F32 totalTargetFillFlow = targetFillFlowRate + ( targetFillFlowRate * ratios.acidMixingRatio ) + ( targetFillFlowRate * ratios.bicarbMixingRatio ); @@ -333,7 +336,7 @@ * flow has changed the function sends the new active reservoir cycle time * to the DG. * @details Inputs: previousDialysateFlowMLP, previousUFFlowMLP - * @details Outputs: previousDialysateFlowMLP, previousUFFlowMLP + * @details Outputs: previousDialysateFlowMLP, previousUFFlowMLP, volSpentUFML, timeDepleteMS * @return none *************************************************************************/ static void calculateActiveReservoirCycleTime( void ) @@ -342,16 +345,30 @@ F32 fillTimeMS = ( (F32)FILL_RESERVOIR_TO_VOLUME_ML / ( getTargetFillFlowRateLPM() * ML_PER_LITER ) ) * SEC_PER_MIN * MS_PER_SECOND; F32 targetUFFlowMLP = getCurrentUFSetRate(); F32 timeDepletionMS = ( (F32)FILL_RESERVOIR_TO_VOLUME_ML / dialysateFlowMLP ) * SEC_PER_MIN * MS_PER_SECOND; - F32 timeTotalCycleMS = fillTimeMS + RESERVOIR_SETTLE_TIME_MS + RESERVOIR_CYCLE_EXTRA_MARGIN_TIME_MS + ratios.timeFillPrepMS; - F32 timeReservoirCycleMS = 0.0; + F32 timeTotalCycleMS = fillTimeMS + RESERVOIR_FRESH_SETTLE_TIME_MS + RESERVOIR_CYCLE_EXTRA_MARGIN_TIME_MS + ratios.timeFillPrepMS; + F32 timeReservoirCycleMS = 0.0F; F32 timeUFDepletionMS = NEARLY_INFINITY; + F32 volFreshML = FILL_RESERVOIR_TO_VOLUME_ML - volSpentML; + F32 timeFreshRemainingMS = ( volFreshML / (F32)dialysateFlowMLP ) * SEC_PER_MIN * MS_PER_SECOND; + F32 volMaxUFML = FILL_RESERVOIR_TO_VOLUME_ML * MAX_RESERVOIR_DILUTION; // Check if target UF flow is not zero to consider it in the calculations too if ( targetUFFlowMLP > NEARLY_ZERO ) { // If UF is not 0, the active reservoir cycle time is minimum of UF depletion and fill time timeUFDepletionMS = ( ( (F32)FILL_RESERVOIR_TO_VOLUME_ML * RESERVOIR_DILUTION_RATIO ) / targetUFFlowMLP ) * SEC_PER_MIN * MS_PER_SECOND; + // Calculate the ultra-filtration remaining volume + // Using the ultra-filtration remaining volume and the ultra-filtration target flow rate calculate the time + // The depletion time in milliseconds is the minimum time of the fresh remaining time and the depletion remaining time + // The depletion time is then used to calculate the time to wait to fill and whether to trigger a fill command or not + F32 volRemainingUFML = volMaxUFML - volSpentUFML; + F32 timeDepleteRemainingMS = ( volRemainingUFML / targetUFFlowMLP ) * SEC_PER_MIN * MS_PER_SECOND; + timeDepleteMS = MIN( timeFreshRemainingMS, timeDepleteRemainingMS ); } + else + { + timeDepleteMS = timeFreshRemainingMS; + } timeDepletionMS = MIN( timeDepletionMS, timeUFDepletionMS ); timeReservoirCycleMS = MAX( timeTotalCycleMS, timeDepletionMS ); @@ -361,11 +378,14 @@ if ( ( previousDialysateFlowMLP != dialysateFlowMLP ) || ( previousUFFlowMLP != targetUFFlowMLP ) ) { DG_CMD_DIALYSATE_HEATING_PARAMS_T params; + params.trimmerTargetTemperature = getTreatmentParameterF32( TREATMENT_PARAM_DIALYSATE_TEMPERATURE ); - params.timeReservoirWait2SwitchMS = RESERVOIR_SETTLE_TIME_MS + RESERVOIR_CYCLE_EXTRA_MARGIN_TIME_MS; + // TODO timeReservoirWait2SwitchMS Should this be the calculated value? Or just RESERVOIR_FRESH_SETTLE_TIME_MS? + params.timeReservoirWait2SwitchMS = RESERVOIR_FRESH_SETTLE_TIME_MS + RESERVOIR_CYCLE_EXTRA_MARGIN_TIME_MS; params.timeReservoirFillMS = fillTimeMS; params.timeReservoirCycleMS = timeReservoirCycleMS; params.dialysateFlowLPM = ( (F32)dialysateFlowMLP ) / ML_PER_LITER; + params.usePriTargetTempEquation = TRUE; cmdSetDGDialysateHeatingParams( params ); @@ -378,14 +398,51 @@ /*********************************************************************//** * @brief + * The getReservoirRecirculationMaxPercent function returns the reservoir management + * maximum recirculation percentage. + * @details Inputs: TREATMENT_PARAM_DIALYSATE_FLOW + * @details Outputs: none + * @return reservoir management max recirculation percent + *************************************************************************/ +static F32 getReservoirRecirculationMaxPercent( void ) +{ + U32 targetDialysateFlowMLP = getTreatmentParameterU32( TREATMENT_PARAM_DIALYSATE_FLOW ); + F32 maxPercent = 0.0F; + + if ( targetDialysateFlowMLP <= RESERVOIR_FLOW_400_MLP ) + { + maxPercent = MAX_RESERVOIR_RECIRCULATION_400_MLP; + } + else if ( targetDialysateFlowMLP <= RESERVOIR_FLOW_450_MLP ) + { + maxPercent = MAX_RESERVOIR_RECIRCULATION_450_MLP; + } + else if ( targetDialysateFlowMLP <= RESERVOIR_FLOW_500_MLP ) + { + maxPercent = MAX_RESERVOIR_RECIRCULATION_500_MLP; + } + else if ( targetDialysateFlowMLP <= RESERVOIR_FLOW_550_MLP ) + { + maxPercent = MAX_RESERVOIR_RECIRCULATION_550_MLP; + } + else + { + maxPercent = MAX_RESERVOIR_RECIRCULATION_600_MLP; + } + + return maxPercent; +} + +/*********************************************************************//** + * @brief * The publishReservoirData function publishes reservoirs data during treatment. * @details Inputs: reservoirsPublicationCounter * @details Outputs: reservoirsPublicationCounter * @return none *************************************************************************/ static void publishReservoirData( void ) { - if ( ++reservoirPublicationCounter > RESERVOIR_DATA_PUB_INTERVAL ) + if ( ++reservoirPublicationCounter >= RESERVOIR_DATA_PUB_INTERVAL ) { RESERVOIRS_MANAGEMENT_DATA_T data; @@ -396,7 +453,7 @@ data.recircLevelPct = recirculationLevelPct * 100; data.timeDepletionMS = timeDepleteMS; data.timeWaitFillMS = timeWaitToFillMS; - data.tempRemoveTragetFillFlow = targetFillFlowLPM; + data.tempRemoveTargetFillFlow = targetFillFlowLPM; broadcastData( MSG_ID_HD_RESERVOIRS_DATA, COMM_BUFFER_OUT_CAN_HD_BROADCAST, (U08*)&data, sizeof( RESERVOIRS_MANAGEMENT_DATA_T ) ); @@ -408,7 +465,7 @@ * @brief * The handleReservoirMgmtStartState function executes the reservoir management * start state. - * @details Inputs: none + * @details Inputs: dgOpMode * @details Outputs: none * @return next reservoir management state of the state machine *************************************************************************/ @@ -435,7 +492,7 @@ * @brief * The handleReservoirMgmtDrainState function executes the reservoir management * drain state. - * @details Inputs: none + * @details Inputs: dgOpMode * @details Outputs: none * @return next reservoir management state of the state machine *************************************************************************/ @@ -455,8 +512,8 @@ * @brief * The handleReservoirMgmtWaitToFillState function executes the reservoir management * wait to fill state. - * @details Inputs: dilutionLevel, volSpentML, dgSubMode - * @details Outputs: dilutionLevel, volSpentML, volSpentUFML, timeDepletionMS + * @details Inputs: volSpentML, dgOpMode, dgSubMode + * @details Outputs: dilutionLevelPct, volSpentUFML, timeDepleteMS, timeWaitToFillMS * @return next reservoir management state of the state machine *************************************************************************/ static TREATMENT_RESERVOIR_MGMT_STATE_T handleReservoirMgmtWaitToFillState( void ) @@ -481,43 +538,23 @@ cmdStartDGFill( FILL_RESERVOIR_TO_VOLUME_ML, targetFillFlowRateLPM ); } } - else + // If we have active dialysate temp alarms, we want to fill immediately. + else if ( TRUE == isDialysateTempAlarmActive() ) { - // The fresh left volume in the reservoir is the nominal volume - the spent volume - // Using the fresh remaining volume, time to spent the fresh remaining is calculated by dividing the volume to - // target dialysate flow rate. The target dialysate flow rate is used to be able to respond to the flow changes - // by the user - U32 targetDialysateFlowMLP = getTreatmentParameterU32( TREATMENT_PARAM_DIALYSATE_FLOW ); - F32 volFreshML = FILL_RESERVOIR_TO_VOLUME_ML - volSpentML; - F32 timeFreshRemainingMS = ( volFreshML / (F32)targetDialysateFlowMLP ) * SEC_PER_MIN * MS_PER_SECOND; - F32 volMaxUFML = FILL_RESERVOIR_TO_VOLUME_ML * MAX_RESERVOIR_DILUTION; - F32 ultrafiltrationFlowMLP = getCurrentUFSetRate(); - - // If the ultra-filtration volume is not 0 check the depletion time for that too - if ( ultrafiltrationFlowMLP > NEARLY_ZERO ) + if ( DG_GEN_IDLE_MODE_STATE_FLUSH_WATER == dgSubMode ) { - // Calculate the ultra-filtration remaining volume - // Using the ultra-filtration remaining volume and the ultra-filtration target flow rate calculate the time - // The depletion time in milliseconds is the minimum time of the fresh remaining time and the depletion remaining time - // The depletion time is then used to calculate the time to wait to fill and whether to trigger a fill command or not - F32 volRemainingUFML = volMaxUFML - volSpentUFML; - F32 timeDepleteRemainingMS = ( volRemainingUFML / ultrafiltrationFlowMLP ) * SEC_PER_MIN * MS_PER_SECOND; - timeDepleteMS = MIN( timeFreshRemainingMS, timeDepleteRemainingMS ); + cmdStartDGFill( FILL_RESERVOIR_TO_VOLUME_ML, targetFillFlowRateLPM ); } - else - { - timeDepleteMS = timeFreshRemainingMS; - } - + } + else + { // Time to wait prior to next fill is depletion time - the whole group of how much time is needed to fill a reservoir + // the time it takes to wait for a reservoir to settle and the extra margin time for ramp up of the RO and drain pumps and // any other extra times. - timeWaitToFillMS = timeDepleteMS - ( getFillTimeMS() + RESERVOIR_SETTLE_TIME_MS + RESERVOIR_CYCLE_EXTRA_MARGIN_TIME_MS ); + timeWaitToFillMS = timeDepleteMS - ( getFillTimeMS() + RESERVOIR_FRESH_SETTLE_TIME_MS + RESERVOIR_CYCLE_EXTRA_MARGIN_TIME_MS ); // If the wait time has elapsed, trigger a fill command - // TODO uncomment - //if ( timeWaitToFillMS <= 0 ) - // TODO uncomment + if ( timeWaitToFillMS <= 0 ) { cmdStartDGFill( FILL_RESERVOIR_TO_VOLUME_ML, targetFillFlowRateLPM ); } @@ -540,35 +577,30 @@ * The handleReservoirMgmtFillState function executes the reservoir management * fill state. * @details Inputs: recirculationLevelPct, dgOpMode, dgSubMode - * @details Outputs: recirculationLevelPct, reservoirSwitchTimer + * @details Outputs: recirculationLevelPct, reservoirSwitchStartTimeMS * @return next reservoir management state of the state machine *************************************************************************/ static TREATMENT_RESERVOIR_MGMT_STATE_T handleReservoirMgmtFillState( void ) { TREATMENT_RESERVOIR_MGMT_STATE_T state = TREATMENT_RESERVOIR_MGMT_FILL_RESERVOIR_STATE; - // Check the recirculation level - recirculationLevelPct = volSpentML / (F32)FILL_RESERVOIR_TO_VOLUME_ML; - // If the recirculation level has exceeded the max allowed, raise the alarm to stop using the active reservoir as it has been // diluted to much - if ( recirculationLevelPct >= MAX_RESERVOIR_RECIRCULATION ) + if ( recirculationLevelPct >= getReservoirRecirculationMaxPercent() ) { #ifndef _RELEASE_ if ( getSoftwareConfigStatus( SW_CONFIG_DISABLE_RESERVOIRS_ALARMS ) != SW_CONFIG_ENABLE_VALUE ) #endif { SET_ALARM_WITH_1_F32_DATA( ALARM_ID_HD_ACTIVE_RESERVOIR_RECIRCULATION_OUT_OF_RANGE, recirculationLevelPct ) } - } // Check if DG has moved out of the fill mode if ( ( DG_MODE_GENE == dgOpMode ) && ( DG_GEN_IDLE_MODE_STATE_FLUSH_WATER == dgSubMode ) ) { // Clear any of the recoverable conditions in case they were raised during the fill or wait to fill clearAlarmCondition( ALARM_ID_HD_ACTIVE_RESERVOIR_RECIRCULATION_OUT_OF_RANGE ); - clearAlarmCondition( ALARM_ID_HD_ACTIVE_RESERVOIR_DEPLETION_TIME_OUT ); clearAlarmCondition( ALARM_ID_HD_ACTIVE_RESERVOIR_WEIGHT_OUT_OF_RANGE ); reservoirSwitchStartTimeMS = getMSTimerCount(); @@ -582,52 +614,47 @@ * @brief * The handleReservoirMgmtWaitForFillSettleState function executes the reservoir * management wait for fill to settle state. - * @details Inputs: reservoirSwitchTimer, volSpentML - * @details Outputs: reservoirSwitchTimer, volSpentML + * @details Inputs: reservoirSwitchStartTimeMS, volSpentML + * @details Outputs: reservoirSwitchStartTimeMS, volSpentML, volSpentUFML, dilutionLevelPct * @return next reservoir management state of the state machine *************************************************************************/ static TREATMENT_RESERVOIR_MGMT_STATE_T handleReservoirMgmtWaitForFillSettleState( void ) { TREATMENT_RESERVOIR_MGMT_STATE_T state = TREATMENT_RESERVOIR_MGMT_WAIT_FOR_FILL_SETTLE_STATE; + DG_RESERVOIR_ID_T active = getDGActiveReservoir(); - // Wait for the reservoir to settle and then send the commands to switch the active reservoir TODO - restore #define below - if ( ( TRUE == didTimeout( reservoirSwitchStartTimeMS, 15000 /*RESERVOIR_SETTLE_TIME_MS*/ ) ) && - ( ( dilutionLevelPct >= MAX_RESERVOIR_DILUTION ) || ( volSpentML >= (F32)FILL_RESERVOIR_TO_VOLUME_ML ) ) ) + // Get the ultra-filtration volume milliliters + // Get the dilution level in percent = spent ultra-filtration volume / target fill volume in milliliters + volSpentUFML = getReservoirUltrafiltrationVol( activeReservoir ); + dilutionLevelPct = volSpentUFML / (F32)FILL_RESERVOIR_TO_VOLUME_ML; + + // Wait for the reservoir to settle and then send the commands to switch the active reservoir + if ( ( TRUE == didTimeout( reservoirSwitchStartTimeMS, RESERVOIR_FRESH_SETTLE_TIME_MS ) ) && + ( ( dilutionLevelPct >= MAX_RESERVOIR_DILUTION ) || ( volSpentML >= (F32)FILL_RESERVOIR_TO_VOLUME_ML ) || ( getReservoirWeight( active ) > MAX_RESERVOIR_VOL_BEFORE_SWITCH_ML ) || ( TRUE == isDialysateTempAlarmActive() ) ) ) { - DG_RESERVOIR_ID_T inactiveRes = getDGInactiveReservoir(); + DG_SWITCH_RSRVRS_CMD_T rsrvrCmd; - // TODO test code remove - //if ( TRUE == test ) // TODO comment the if statement - { - // Signal dialysis sub-mode to capture baseline volume for next reservoir. - setStartReservoirVolume( inactiveRes ); + DG_RESERVOIR_ID_T inactiveRes = getDGInactiveReservoir(); + rsrvrCmd.reservoirID = (U32)inactiveRes; + rsrvrCmd.useLastTrimmerHeaterDC = TRUE; - // Command DG to switch reservoirs - cmdSetDGActiveReservoir( inactiveRes ); + // Signal dialysis sub-mode to capture baseline volume for next reservoir. + setStartReservoirVolume( inactiveRes ); - // Signal dialysis sub-mode to switch reservoirs - signalReservoirsSwitched(); - } - // TODO test code + // Command DG to switch reservoirs + cmdSetDGActiveReservoir( &rsrvrCmd ); + // Signal dialysis sub-mode to switch reservoirs + signalReservoirsSwitched(); + // Get ready for the next delivery volSpentML = 0.0; // Wait for used reservoir to settle reservoirSwitchStartTimeMS = getMSTimerCount(); - // TODO test code - // For reservoir test, it should go back to start state - /*if ( FALSE == test ) - { - state = TREATMENT_RESERVOIR_MGMT_START_STATE; - } - else*/ // TODO comment the code above it is test code - { - state = TREATMENT_RESERVOIR_MGMT_WAIT_FOR_SWITCH_SETTLE_STATE; - test = FALSE; - } - // TODO test code + state = TREATMENT_RESERVOIR_MGMT_WAIT_FOR_SWITCH_SETTLE_STATE; + } return state; @@ -637,27 +664,51 @@ * @brief * The handleReservoirMgmtWaitForSwitchSettleState function executes the reservoir * management wait for switch to settle state. - * @details Inputs: reservoirSwitchTimer - * @details Outputs: none + * @details Inputs: reservoirSwitchStartTimeMS + * @details Outputs: timeReservoirInUse * @return next reservoir management state of the state machine *************************************************************************/ static TREATMENT_RESERVOIR_MGMT_STATE_T handleReservoirMgmtWaitForSwitchSettleState( void ) { TREATMENT_RESERVOIR_MGMT_STATE_T state = TREATMENT_RESERVOIR_MGMT_WAIT_FOR_SWITCH_SETTLE_STATE; - if ( TRUE == didTimeout( reservoirSwitchStartTimeMS, RESERVOIR_SETTLE_TIME_MS ) ) + if ( TRUE == didTimeout( reservoirSwitchStartTimeMS, RESERVOIR_USED_SETTLE_TIME_MS ) ) { + // Switching the active reservoir so reset the reservoir in use timer + lastTimeReservoirInUF = timeReservoirInUF; + timeReservoirInUF = 0; + timeReservoirInUse = 0; + // Signal dialysis sub-mode to capture final volume of prior reservoir after settling. setFinalReservoirVolume(); - // Switched the active reservoir so reset the reservoir in use timer - timeReservoirInUseMS = getMSTimerCount(); - // Reset to start state to restart drain, fill, switch process. state = TREATMENT_RESERVOIR_MGMT_START_STATE; } return state; } +/*********************************************************************//** + * @brief + * The isDialysateTempAlarmActive function checks for active dialysate + * temperature alarms + * @details Inputs: none + * @details Outputs: none + * @return True if dialysate temperature alarm is active. False if not. + *************************************************************************/ +static BOOL isDialysateTempAlarmActive( void ) +{ + BOOL result = FALSE; + if ( ( TREATMENT_STOP_STATE == getTreatmentState() ) && + ( TRUE == isAlarmConditionDetected( ALARM_ID_HD_DIALYSATE_TEMP_BELOW_TARGET_TEMP ) || + TRUE == isAlarmConditionDetected( ALARM_ID_HD_DIALYSATE_TEMP_ABOVE_SAFETY_TEMP ) || + TRUE == isAlarmConditionDetected( ALARM_ID_HD_DIALYSATE_TEMP_ABOVE_TARGET_TEMP ) ) ) + { + result = TRUE; + } + + return result; +} + /**@}*/