Index: firmware/App/Modes/ModeStandby.c =================================================================== diff -u -re0413e662822f3ccc8b4fe9d969efef7eedb05ad -r7d4711edd7b40cd3e29f43e766f79a8a09586fe9 --- firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision e0413e662822f3ccc8b4fe9d969efef7eedb05ad) +++ firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision 7d4711edd7b40cd3e29f43e766f79a8a09586fe9) @@ -1,14 +1,14 @@ /************************************************************************** * -* Copyright (c) 2019-2023 Diality Inc. - All Rights Reserved. +* Copyright (c) 2019-2024 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 ModeStandby.c * -* @author (last) Michael Garthwaite -* @date (last) 01-Mar-2023 +* @author (last) Dara Navaei +* @date (last) 10-Nov-2023 * * @author (original) Dara Navaei * @date (original) 05-Nov-2019 @@ -66,16 +66,20 @@ static BOOL pendingStartDGChemicalDisinfectRequest; ///< Flag indicating HD has requested DG start chemical disinfect. static BOOL pendingStartDGHeatDisinfectActiveCoolRequest; ///< Flag indicating HD has requested DG start heat disinfect active cool. static BOOL pendingStartDGChemicalDisinfectFlushRequest; ///< Flag indicating HD has requested DG start chemical disinfect flush. +static BOOL pendingStartDGROPermeateSampleRequest; ///< Flag indicating HD has requested DG start RO permeate sample. static OVERRIDE_U32_T filterFlushTimePeriod = { FILTER_FLUSH_TIME_MS, FILTER_FLUSH_TIME_MS, 0, 0 }; ///< Filter flush time period in ms. // ********** private function prototypes ********** +static BOOL areInletWaterConditionsAlarmsActive( void ); + static DG_STANDBY_MODE_STATE_T handleStandbyIdleState( void ); static DG_STANDBY_MODE_STATE_T handleStandbyFlushFilterState( void ); static DG_STANDBY_MODE_STATE_T handleStandbyFlushFilterIdleState( void ); static DG_STANDBY_MODE_STATE_T handleStandbySampleWaterState( void ); +static DG_STANDBY_MODE_STATE_T handleStandbyPauseState( void ); /*********************************************************************//** * @brief @@ -84,7 +88,8 @@ * @details Outputs: standbyState, stopSampleWaterRequest, startSampleWaterRequest, * flushFilterRequest, endSampleWaterRequest, waterSampleStartTime, * filterFlushStartTime, filterFlushPublishTimerCounter, pendingStartDGRequest, - * pendingStartDGHeatDisinfectActiveCoolRequest + * pendingStartDGHeatDisinfectActiveCoolRequest, + * pendingStartDGROPermeateSampleRequest * @return none *************************************************************************/ void initStandbyMode( void ) @@ -102,13 +107,10 @@ pendingStartDGHeatDisinfectRequest = FALSE; pendingStartDGChemicalDisinfectRequest = FALSE; pendingStartDGHeatDisinfectActiveCoolRequest = FALSE; + pendingStartDGROPermeateSampleRequest = FALSE; // Reset the heaters efficiency for another treatment resetHeatersEstimationGain(); - - // Initialize the reservoirs parameters for another treatment. - // This is to make sure the boolean flag for the first fill is set to TRUE. - initReservoirs(); } /*********************************************************************//** @@ -120,18 +122,34 @@ *************************************************************************/ U32 transitionToStandbyMode( void ) { + MESSAGE_T usageMsg; + // re-initialize standby mode each time we transition to standby mode initStandbyMode(); deenergizeActuators( PARK_CONC_PUMPS ); setCPLDCleanLEDColor( CPLD_CLEAN_LED_OFF ); + // Upon transition to mode standby set CD1 and CD2 calibration records to be picked to the normal + // table. If the chemical disinfect fails, the mode transitions back to mode standby. + setCondcutivitySensorCalTable( CONDUCTIVITYSENSORS_CD1_SENSOR, CAL_DATA_CD1_COND_SENSOR ); + setCondcutivitySensorCalTable( CONDUCTIVITYSENSORS_CD2_SENSOR, CAL_DATA_CD2_COND_SENSOR ); + #ifndef _RELEASE_ setHeatNelsonSupportMode( NELSON_NONE ); setChemNelsonSupportMode( NELSON_NONE ); #endif + // Initialize the reservoirs parameters for another treatment. + // This is to make sure the boolean flag for the first fill is set to TRUE. + initReservoirs(); + + // Send DG usage data to HD + usageMsg.hdr.msgID = MSG_ID_HD_DG_USAGE_INFO_REQUEST; + usageMsg.hdr.payloadLen = 0; + handleHDRequestDGUsageInfo( &usageMsg ); + return standbyState; } @@ -144,9 +162,11 @@ *************************************************************************/ U32 execStandbyMode( void ) { - checkInletWaterPressure(); - checkInletWaterTemperature(); - checkInletWaterConductivity(); + if ( TRUE == areInletWaterConditionsAlarmsActive() ) + { + setValveState( VSP, VALVE_STATE_CLOSED ); + standbyState = DG_STANDBY_MODE_STATE_PAUSE; + } // execute current Standby state switch ( standbyState ) @@ -167,6 +187,10 @@ standbyState = handleStandbySampleWaterState(); break; + case DG_STANDBY_MODE_STATE_PAUSE: + standbyState = handleStandbyPauseState(); + break; + default: SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DG_SOFTWARE_FAULT, SW_FAULT_ID_STANDBY_MODE_INVALID_EXEC_STATE, standbyState ) standbyState = DG_STANDBY_MODE_STATE_IDLE; @@ -178,6 +202,34 @@ /*********************************************************************//** * @brief + * The areInletWaterConditionsAlarmsActive function checks whether the inlet + * water conditions are out of range and any of their alarms are active. + * @details Inputs: none + * @details Outputs: None + * @return TRUE if any of the alarms are active, otherwise, FALSE + *************************************************************************/ +static BOOL areInletWaterConditionsAlarmsActive( void ) +{ + // Check inlet water conductivity, temperature, pressure, and RO rejection ratio + BOOL status = FALSE; + + checkInletWaterConductivity(); + checkInletWaterTemperature(); + checkInletWaterPressure(); + + status |= isAlarmConditionActive( ALARM_ID_DG_INLET_WATER_CONDUCTIVITY_IN_LOW_RANGE ); + status |= isAlarmConditionActive( ALARM_ID_DG_INLET_WATER_CONDUCTIVITY_IN_HIGH_RANGE ); + status |= isAlarmConditionActive( ALARM_ID_DG_INLET_WATER_TEMPERATURE_IN_HIGH_RANGE ); + status |= isAlarmConditionActive( ALARM_ID_DG_INLET_WATER_TEMPERATURE_IN_LOW_RANGE ); + status |= isAlarmConditionActive( ALARM_ID_DG_OUTLET_PRIMARY_CONDUCTIVITY_OUT_OF_RANGE ); + status |= isAlarmConditionActive( ALARM_ID_DG_INLET_WATER_PRESSURE_IN_HIGH_RANGE ); + status |= isAlarmConditionActive( ALARM_ID_DG_INLET_WATER_PRESSURE_IN_LOW_RANGE ); + + return status; +} + +/*********************************************************************//** + * @brief * The handleStandbyIdleState function executes the idle state of the * standby mode state machine. * @details Inputs: pendingSampleWaterRequest, pendingStartDGRequest, @@ -237,6 +289,11 @@ pendingStartDGChemicalDisinfectFlushRequest = FALSE; requestNewOperationMode( DG_MODE_CHFL ); } + else if ( TRUE == pendingStartDGROPermeateSampleRequest ) + { + pendingStartDGROPermeateSampleRequest = FALSE; + requestNewOperationMode( DG_MODE_ROPS ); + } return state; } @@ -296,7 +353,6 @@ if ( TRUE == startSampleWaterRequest ) { - startSampleWaterRequest = FALSE; waterSampleStartTime = getMSTimerCount(); setValveState( VPI, VALVE_STATE_OPEN ); setValveState( VSP, VALVE_STATE_OPEN ); @@ -310,6 +366,8 @@ state = DG_STANDBY_MODE_STATE_IDLE; } + startSampleWaterRequest = FALSE; + return state; } @@ -325,7 +383,7 @@ { DG_STANDBY_MODE_STATE_T state = DG_STANDBY_MODE_STATE_SAMPLE_WATER; - // After HD requests to stop or 10 seconds has elapsed, close and return to idle state + // After HD requests to stop or 10 seconds has elapsed, close and return to idle state if ( ( TRUE == stopSampleWaterRequest ) || ( TRUE == didTimeout( waterSampleStartTime, MAX_WATER_SAMPLE_TIME_MS ) ) ) { stopSampleWaterRequest = FALSE; @@ -339,6 +397,26 @@ /*********************************************************************//** * @brief + * The handleStandbyPauseState function executes the pause state. + * @details Inputs: none + * @details Outputs: filterFlushStartTime + * @return the next state + *************************************************************************/ +static DG_STANDBY_MODE_STATE_T handleStandbyPauseState( void ) +{ + DG_STANDBY_MODE_STATE_T state = DG_STANDBY_MODE_STATE_PAUSE; + + if ( FALSE == areInletWaterConditionsAlarmsActive() ) + { + filterFlushStartTime = getMSTimerCount(); + state = DG_STANDBY_MODE_STATE_FLUSH_FILTER; + } + + return state; +} + +/*********************************************************************//** + * @brief * The requestWaterSample function handles an HD request to sample water. * @details Inputs: standbyState * @details Outputs: pendingSampleWaterRequest @@ -407,7 +485,7 @@ *************************************************************************/ BOOL requestDGStart( void ) { - BOOL result = FALSE; + BOOL result = FALSE; if ( DG_STANDBY_MODE_STATE_IDLE == standbyState ) { @@ -423,6 +501,29 @@ /*********************************************************************//** * @brief + * The signalAbortWaterSampling function handles an HD request to abort water + * sampling (return to standby idle state). + * @details Inputs: none + * @details Outputs: standby mode variable initialized + * @return TRUE if request accepted, FALSE if not + *************************************************************************/ +BOOL signalAbortWaterSampling( void ) +{ + BOOL result = FALSE; + + if ( ( DG_MODE_STAN == getCurrentOperationMode() ) && ( standbyState != DG_STANDBY_MODE_STATE_IDLE ) ) + { + result = TRUE; + initStandbyMode(); + setValveState( VSP, VALVE_STATE_CLOSED ); + setValveState( VPI, VALVE_STATE_CLOSED ); + } + + return result; +} + +/*********************************************************************//** + * @brief * The startDGFlush function starts DG flush mode. * @details Inputs: standbyState * @details Outputs: none @@ -452,8 +553,9 @@ concCap = STATE_CLOSED; diaCap = STATE_CLOSED; // Using the caps switch to disable the chemical disinfect date checks + // This is for debug builds only to simulate that a chem flush has been done after chem usageInfo.lastChemDisFlushCompleteDateEpoch = 40; - usageInfo.lastChemDisCompleteDateEpoch = 32; + usageInfo.lastChemDisStartDateEpoch = 32; } #endif @@ -463,7 +565,7 @@ cmdResponse.rejectCode = ( STATE_OPEN == getSwitchStatus( DIALYSATE_CAP ) ? REQUEST_REJECT_REASON_DG_DIALYSATE_CAP_OPEN : REQUEST_REJECT_REASON_DG_CONCENTRATE_CAP_OPEN ); } - else if ( usageInfo.lastChemDisFlushCompleteDateEpoch < usageInfo.lastChemDisCompleteDateEpoch ) + else if ( usageInfo.lastChemDisFlushCompleteDateEpoch < usageInfo.lastChemDisStartDateEpoch ) { cmdResponse.rejected = TRUE; cmdResponse.rejectCode = REQUEST_REJECT_REASON_DG_CHEM_FLUSH_NOT_COMPLETED; @@ -496,23 +598,24 @@ { DG_CMD_RESPONSE_T cmdResponse; DG_USAGE_INFO_RECORD_T usageInfo; + OPN_CLS_STATE_T concCap = getSwitchStatus( CONCENTRATE_CAP ); + OPN_CLS_STATE_T diaCap = getSwitchStatus( DIALYSATE_CAP ); getNVRecord2Driver( GET_USAGE_RECORD, (U08*)&usageInfo, sizeof( DG_USAGE_INFO_RECORD_T ), 0, ALARM_ID_NO_ALARM ); - cmdResponse.commandID = DG_CMD_START_HEAT_DISINFECT; - cmdResponse.rejected = FALSE; - cmdResponse.rejectCode = DG_CMD_REQUEST_REJECT_REASON_NONE; - OPN_CLS_STATE_T concCap = getSwitchStatus( CONCENTRATE_CAP ); - OPN_CLS_STATE_T diaCap = getSwitchStatus( DIALYSATE_CAP ); + cmdResponse.commandID = DG_CMD_START_HEAT_DISINFECT; + cmdResponse.rejected = FALSE; + cmdResponse.rejectCode = DG_CMD_REQUEST_REJECT_REASON_NONE; #ifndef _RELEASE_ if ( SW_CONFIG_ENABLE_VALUE == getSoftwareConfigStatus( SW_CONFIG_DISABLE_CAPS_MONITOR ) ) { concCap = STATE_CLOSED; diaCap = STATE_CLOSED; // Using the caps switch to disable the chemical disinfect date checks + // This is for debug builds only to simulate that a chem flush has been done after chem usageInfo.lastChemDisFlushCompleteDateEpoch = 40; - usageInfo.lastChemDisCompleteDateEpoch = 32; + usageInfo.lastChemDisStartDateEpoch = 32; } #endif @@ -522,7 +625,7 @@ cmdResponse.rejectCode = ( STATE_OPEN == getSwitchStatus( DIALYSATE_CAP ) ? REQUEST_REJECT_REASON_DG_DIALYSATE_CAP_OPEN : REQUEST_REJECT_REASON_DG_CONCENTRATE_CAP_OPEN ); } - else if ( usageInfo.lastChemDisFlushCompleteDateEpoch < usageInfo.lastChemDisCompleteDateEpoch ) + else if ( usageInfo.lastChemDisFlushCompleteDateEpoch < usageInfo.lastChemDisStartDateEpoch ) { cmdResponse.rejected = TRUE; cmdResponse.rejectCode = REQUEST_REJECT_REASON_DG_CHEM_FLUSH_NOT_COMPLETED; @@ -571,8 +674,9 @@ concCap = STATE_CLOSED; diaCap = STATE_CLOSED; // Using the caps switch to disable the chemical disinfect date checks + // This is for debug builds only to simulate that a chem flush has been done after chem usageInfo.lastChemDisFlushCompleteDateEpoch = 40; - usageInfo.lastChemDisCompleteDateEpoch = 32; + usageInfo.lastChemDisStartDateEpoch = 32; } #endif @@ -582,7 +686,7 @@ cmdResponse.rejectCode = ( STATE_OPEN == getSwitchStatus( DIALYSATE_CAP ) ? REQUEST_REJECT_REASON_DG_DIALYSATE_CAP_OPEN : REQUEST_REJECT_REASON_DG_CONCENTRATE_CAP_OPEN ); } - else if ( usageInfo.lastChemDisFlushCompleteDateEpoch < usageInfo.lastChemDisCompleteDateEpoch ) + else if ( usageInfo.lastChemDisFlushCompleteDateEpoch < usageInfo.lastChemDisStartDateEpoch ) { cmdResponse.rejected = TRUE; cmdResponse.rejectCode = REQUEST_REJECT_REASON_DG_CHEM_FLUSH_NOT_COMPLETED; @@ -633,7 +737,7 @@ { cmdResponse.rejected = TRUE; cmdResponse.rejectCode = REQUEST_REJECT_REASON_DG_DIALYSATE_CAP_OPEN; - } + } else { pendingStartDGChemicalDisinfectRequest = TRUE; @@ -702,6 +806,71 @@ /*********************************************************************//** * @brief + * The startDGROPermeateSample function starts RO permeate sample mode. + * @details Inputs: standbyState + * @details Outputs: pendingStartDGChemicalDisinfectFlushRequest + * @return: TRUE if the switch was successful + *************************************************************************/ +BOOL startDGROPermeateSample( void ) +{ + BOOL status = FALSE; + DG_CMD_RESPONSE_T cmdResponse; + + cmdResponse.commandID = DG_CMD_START_RO_PERMEATE_SAMPLE; + cmdResponse.rejected = FALSE; + cmdResponse.rejectCode = DG_CMD_REQUEST_REJECT_REASON_NONE; + + // If DG is in standby mode and the standby mode is in Idle, request RO permeate sample + if ( ( DG_MODE_STAN == getCurrentOperationMode() ) && ( DG_STANDBY_MODE_STATE_IDLE == standbyState ) ) + { + DG_USAGE_INFO_RECORD_T usageInfo; + OPN_CLS_STATE_T concCap = getSwitchStatus( CONCENTRATE_CAP ); + OPN_CLS_STATE_T diaCap = getSwitchStatus( DIALYSATE_CAP ); + + getNVRecord2Driver( GET_USAGE_RECORD, (U08*)&usageInfo, sizeof( DG_USAGE_INFO_RECORD_T ), 0, ALARM_ID_NO_ALARM ); + +#ifndef _RELEASE_ + if ( SW_CONFIG_ENABLE_VALUE == getSoftwareConfigStatus( SW_CONFIG_DISABLE_CAPS_MONITOR ) ) + { + concCap = STATE_CLOSED; + diaCap = STATE_CLOSED; + // Using the caps switch to disable the chemical disinfect date checks. + // This is for debug builds only to simulate that a chem flush has been done after chem + usageInfo.lastChemDisFlushCompleteDateEpoch = 40; + usageInfo.lastChemDisStartDateEpoch = 32; + } +#endif + + if ( ( STATE_OPEN == concCap ) || ( STATE_OPEN == diaCap ) ) + { + cmdResponse.rejected = TRUE; + cmdResponse.rejectCode = ( STATE_OPEN == getSwitchStatus( DIALYSATE_CAP ) ? REQUEST_REJECT_REASON_DG_DIALYSATE_CAP_OPEN : + REQUEST_REJECT_REASON_DG_CONCENTRATE_CAP_OPEN ); + } + else if ( usageInfo.lastChemDisFlushCompleteDateEpoch < usageInfo.lastChemDisStartDateEpoch ) + { + cmdResponse.rejected = TRUE; + cmdResponse.rejectCode = REQUEST_REJECT_REASON_DG_CHEM_FLUSH_NOT_COMPLETED; + } + else + { + pendingStartDGROPermeateSampleRequest = TRUE; + status = TRUE; + } + } + else + { + cmdResponse.rejected = TRUE; + cmdResponse.rejectCode = REQUEST_REJECT_REASON_DG_NOT_IN_STANDBY_IDLE_STATE; + } + + sendCommandResponseMsg( &cmdResponse ); + + return status; +} + +/*********************************************************************//** + * @brief * The getCurrentStandbyState function returns the current state of standby mode. * @details Inputs: standbyState * @details Outputs: none