Index: firmware/App/Modes/ModePreTreat.c =================================================================== diff -u -r2b81130d2b0abfa811117ebd2961be6a2fd11737 -r427b37ad929a8d88b5fcb9ae21a4f4146ffd2fef --- firmware/App/Modes/ModePreTreat.c (.../ModePreTreat.c) (revision 2b81130d2b0abfa811117ebd2961be6a2fd11737) +++ firmware/App/Modes/ModePreTreat.c (.../ModePreTreat.c) (revision 427b37ad929a8d88b5fcb9ae21a4f4146ffd2fef) @@ -8,7 +8,7 @@ * @file ModePreTreat.c * * @author (last) Michael Garthwaite -* @date (last) 19-Oct-2022 +* @date (last) 28-Oct-2022 * * @author (original) Dara Navaei * @date (original) 05-Nov-2019 @@ -59,7 +59,8 @@ PRE_TREATMENT_RESERVOIR_MGMT_START_FILL_STATE, ///< Command DG to start filling reservoir PRE_TREATMENT_RESERVOIR_MGMT_FILL_CMD_RESP_STATE, ///< After sending fill command, process DG fill command response PRE_TREATMENT_RESERVOIR_MGMT_FILL_COMPLETE_STATE, ///< Reservoir fill has completed - PRE_TREATMENT_RESERVOIR_MGMT_WAIT_FOR_RESERVOIR_SWITCH_STATE, ///< Wait for prime operation to switch reservoir + PRE_TREATMENT_RESERVOIR_MGMT_REQUEST_RESERVOIR_SWITCH_STATE, ///< Command DG to switch (toggle) reservoirs + PRE_TREATMENT_RESERVOIR_MGMT_WAIT_FOR_RESERVOIR_SWITCH_STATE, ///< After sending switch command, process DG fill command response PRE_TREATMENT_RESERVOIR_MGMT_COMPLETE_STATE, ///< Pre-treatment reservoir management complete state NUM_OF_PRE_TREATMENT_RESERVOIR_MGMT_STATES ///< Number of pre-treatments reservoir mgmt. states } PRE_TREATMENT_RESERVOIR_MGMT_STATE_T; @@ -75,15 +76,17 @@ static BOOL alarmActionResumeReceived = FALSE; ///< Flag indicates alarm action resume received. static HD_PRE_TREATMENT_MODE_STATE_T currentPreTreatmentState; ///< Current state of pre-treatment mode state machine. +static BOOL fillReservoirOneStartRequested; ///< Flag indicates fill reservoir one has been requested. static U32 preTreatmentPublishTimerCounter; ///< Pre-treatment data broadcast timer counter used to schedule when to transmit data. /// Interval (in task intervals) at which to publish pre-treatment mode data to CAN bus. static OVERRIDE_U32_T preTreatmentModePublishInterval = { PRE_TREATMENT_DATA_PUB_INTERVAL, PRE_TREATMENT_DATA_PUB_INTERVAL, PRE_TREATMENT_DATA_PUB_INTERVAL, 0 }; static U32 submodeCompleteTransitionTimeCounter; ///< Sub-mode completed transition wait time counter. static PRE_TREATMENT_RESERVOIR_MGMT_STATE_T currentReservoirMgmtState; ///< Current pre-treatment reservoir management state. -static BOOL fillReservoirOneStartRequested; ///< Flag indicates fill reservoir one has been requested. static BOOL reservoirFilledStatus[ NUM_OF_DG_RESERVOIRS ]; ///< Flag indicates a reservoir has been filled. static BOOL reservoirFlushedStatus[ NUM_OF_DG_RESERVOIRS ]; ///< Flag indicates a reservoir has been flushed. +static PRE_TREATMENT_RESERVOIR_FLAGS_T reservoirFlags[ NUM_OF_DG_RESERVOIRS ]; ///< Set of Flags that signal if the DG should wait to fill. +static BOOL initialReservoirDrain[ NUM_OF_DG_RESERVOIRS ]; ///< Flags indicate whether a reservoir has been requested to initially drain. // ********** private function prototypes ********** @@ -108,7 +111,9 @@ static PRE_TREATMENT_RESERVOIR_MGMT_STATE_T handlePreTreatmentReservoirMgmtFillCmdState( void ); static PRE_TREATMENT_RESERVOIR_MGMT_STATE_T handlePreTreatmentReservoirMgmtFillCmdRespState( void ); static PRE_TREATMENT_RESERVOIR_MGMT_STATE_T handlePreTreatmentReservoirMgmtFillCompleteState( void ); +static PRE_TREATMENT_RESERVOIR_MGMT_STATE_T handlePreTreatmentReservoirMgmtRequestReservoirSwitchState( void ); static PRE_TREATMENT_RESERVOIR_MGMT_STATE_T handlePreTreatmentReservoirMgmtWaitReservoirSwitchState( void ); +static U32 getPreTreatmentFillVolume( DG_RESERVOIR_ID_T inactiveRes ); /*********************************************************************//** * @brief @@ -128,7 +133,17 @@ reservoirFilledStatus[ DG_RESERVOIR_1 ] = FALSE; reservoirFilledStatus[ DG_RESERVOIR_2 ] = FALSE; + reservoirFlushedStatus[ DG_RESERVOIR_1 ] = FALSE; + reservoirFlushedStatus[ DG_RESERVOIR_2 ] = FALSE; + reservoirFlags[ DG_RESERVOIR_1 ].startFlushFill = FALSE; + reservoirFlags[ DG_RESERVOIR_1 ].startNormalFill = FALSE; + reservoirFlags[ DG_RESERVOIR_2 ].startFlushFill = FALSE; + reservoirFlags[ DG_RESERVOIR_2 ].startNormalFill = FALSE; + + initialReservoirDrain[ DG_RESERVOIR_1 ] = FALSE; + initialReservoirDrain[ DG_RESERVOIR_2 ] = FALSE; + initSampleWater(); initConsumableSelfTest(); initPrime(); @@ -474,6 +489,22 @@ /*********************************************************************//** * @brief + * The signalActionToResumeFill function sets the remaining reservior fill + * flags to resume filling while in PreTreatment Mode. + * @details Inputs: none + * @details Outputs: reservoirFlags + * @return none + *************************************************************************/ +void signalActionToResumeFill( void ) +{ + reservoirFlags[ DG_RESERVOIR_1 ].startFlushFill = TRUE; + reservoirFlags[ DG_RESERVOIR_1 ].startNormalFill = TRUE; + reservoirFlags[ DG_RESERVOIR_2 ].startFlushFill = TRUE; + reservoirFlags[ DG_RESERVOIR_2 ].startNormalFill = TRUE; +} + +/*********************************************************************//** + * @brief * The getReservoirFillStatus function returns the fill complete status for * given reservoir. * @details Inputs: reservoirFilledStatus @@ -651,8 +682,8 @@ * @brief * The handleSelfTestConsumableState function handles consumable self-test state * during pre-treatment mode. - * @details Inputs: none - * @details Outputs: executed consumable self-test state machine + * @details Inputs: submodeCompleteTransitionTimeCounter + * @details Outputs: execute consumable self-test state machine * @return current state (sub-mode) *************************************************************************/ static HD_PRE_TREATMENT_MODE_STATE_T handleSelfTestConsumableState( void ) @@ -897,6 +928,10 @@ currentReservoirMgmtState = handlePreTreatmentReservoirMgmtFillCompleteState(); break; + case PRE_TREATMENT_RESERVOIR_MGMT_REQUEST_RESERVOIR_SWITCH_STATE: + currentReservoirMgmtState = handlePreTreatmentReservoirMgmtRequestReservoirSwitchState(); + break; + case PRE_TREATMENT_RESERVOIR_MGMT_WAIT_FOR_RESERVOIR_SWITCH_STATE: currentReservoirMgmtState = handlePreTreatmentReservoirMgmtWaitReservoirSwitchState(); break; @@ -916,7 +951,7 @@ * The handlePreTreatmentReservoirMgmtStartState function handles reservoir * management start state for pre-treatment mode. * @details Inputs: fillReservoirOneStartRequested - * @details Outputs: processed fill reservoir one request + * @details Outputs: fillReservoirOneStartRequested * @return current state of pre-treatment reservoir management *************************************************************************/ static PRE_TREATMENT_RESERVOIR_MGMT_STATE_T handlePreTreatmentReservoirMgmtStartState( void ) @@ -942,7 +977,7 @@ * @brief * The handlePreTreatmentReservoirMgmtDrainCmdState function sends drain * command to DG when DG is in re-circulate mode. - * @details Inputs: fillReservoirOneStartRequested + * @details Inputs: none * @details Outputs: processed fill reservoir one request * @return current state of pre-treatment reservoir management *************************************************************************/ @@ -1003,7 +1038,8 @@ * @brief * The handlePreTreatmentReservoirMgmtFillCmdState function sends fill * command to DG when DG is in re-circulate mode. - * @details Inputs: DG operation mode and operation sub-mode + * @details Inputs: DG operation mode, DG operation sub-mode, + * reservoirFlushedStatus, reservoirFlags * @details Outputs: sent fill command to DG * @return current state of pre-treatment reservoir management *************************************************************************/ @@ -1012,52 +1048,41 @@ PRE_TREATMENT_RESERVOIR_MGMT_STATE_T state = PRE_TREATMENT_RESERVOIR_MGMT_START_FILL_STATE; DG_OP_MODE_T dgOpMode = getDGOpMode(); U32 dgSubMode = getDGSubMode(); + U32 volume = 0; + DG_RESERVOIR_ID_T inactiveReservoir = getDGInactiveReservoir(); if ( ( DG_MODE_GENE == dgOpMode ) && ( DG_GEN_IDLE_MODE_STATE_FLUSH_WATER == dgSubMode ) ) { - state = PRE_TREATMENT_RESERVOIR_MGMT_FILL_CMD_RESP_STATE; - - if ( ( TRUE == reservoirFlushedStatus[ DG_RESERVOIR_1 ] ) && ( TRUE == reservoirFlushedStatus[ DG_RESERVOIR_2 ] ) ) + // if fills not yet enabled, check to see if we want to move on to drain the other reservoir + if ( reservoirFlags[ DG_RESERVOIR_1 ].startFlushFill != TRUE ) { - if ( DG_RESERVOIR_1 == getDGInactiveReservoir() ) + if ( ( initialReservoirDrain[ inactiveReservoir ] != TRUE ) || + ( inactiveReservoir != DG_RESERVOIR_1 ) ) { - U32 volume = FILL_RESERVOIR_TO_VOLUME_ML; - -#ifndef _RELEASE_ - if ( getSoftwareConfigStatus( SW_CONFIG_DISABLE_PRIMING ) != SW_CONFIG_ENABLE_VALUE ) - { - volume = PRE_TREATMENT_FILL_RESERVOIR_ONE_VOLUME_ML; - } -#endif - - cmdStartDGFill( volume, DEFAULT_TARGET_FILL_FLOW_RATE_LPM ); + initialReservoirDrain[ inactiveReservoir ] = TRUE; + state = PRE_TREATMENT_RESERVOIR_MGMT_REQUEST_RESERVOIR_SWITCH_STATE; } - else - { - U32 volume = FILL_RESERVOIR_TO_VOLUME_ML; - -#ifndef _RELEASE_ - if ( getSoftwareConfigStatus( SW_CONFIG_DISABLE_PRIMING ) != SW_CONFIG_ENABLE_VALUE ) - { - volume = PRE_TREATMENT_FILL_RESERVOIR_TWO_VOLUME_ML; - } -#endif - - cmdStartDGFill( volume, DEFAULT_TARGET_FILL_FLOW_RATE_LPM ); - } } + else { - U32 volume = PRE_TREATMENT_FLUSH_RESERVOIR_VOLUME_ML; + volume = getPreTreatmentFillVolume( inactiveReservoir ); -#ifndef _RELEASE_ - if ( SW_CONFIG_ENABLE_VALUE == getSoftwareConfigStatus( SW_CONFIG_DISABLE_PRIMING ) ) + // not flushed and need to fill + if ( ( TRUE != reservoirFlushedStatus[ inactiveReservoir ] ) && + ( TRUE == reservoirFlags[ inactiveReservoir ].startFlushFill ) ) { - volume = FILL_RESERVOIR_TO_VOLUME_ML; + cmdStartDGFill( volume, DEFAULT_TARGET_FILL_FLOW_RATE_LPM ); + state = PRE_TREATMENT_RESERVOIR_MGMT_FILL_CMD_RESP_STATE; } -#endif - cmdStartDGFill( volume, DEFAULT_TARGET_FILL_FLOW_RATE_LPM ); + // flushed and need to fill + if ( ( TRUE == reservoirFlushedStatus[ inactiveReservoir ] ) && + ( TRUE == reservoirFlags[ inactiveReservoir ].startNormalFill ) ) + { + cmdStartDGFill( volume, DEFAULT_TARGET_FILL_FLOW_RATE_LPM ); + state = PRE_TREATMENT_RESERVOIR_MGMT_FILL_CMD_RESP_STATE; + } } } @@ -1121,7 +1146,7 @@ { if ( FALSE == reservoirFilledStatus[ DG_RESERVOIR_1 ] ) { - state = PRE_TREATMENT_RESERVOIR_MGMT_WAIT_FOR_RESERVOIR_SWITCH_STATE; + state = PRE_TREATMENT_RESERVOIR_MGMT_REQUEST_RESERVOIR_SWITCH_STATE; reservoirFilledStatus[ DG_RESERVOIR_1 ] = TRUE; } else @@ -1135,7 +1160,7 @@ } else { - state = PRE_TREATMENT_RESERVOIR_MGMT_WAIT_FOR_RESERVOIR_SWITCH_STATE; + state = PRE_TREATMENT_RESERVOIR_MGMT_REQUEST_RESERVOIR_SWITCH_STATE; if ( FALSE == reservoirFlushedStatus[ DG_RESERVOIR_1 ] ) { @@ -1172,6 +1197,31 @@ /*********************************************************************//** * @brief + * The handlePreTreatmentReservoirMgmtRequestReservoirSwitchState function waits + * until prime operation switches the active reservoir before filling up next reservoir. + * @details Inputs: DG intactive reservoir + * @details Outputs: start filling next reservoir + * @return current state of pre-treatment reservoir management + *************************************************************************/ +static PRE_TREATMENT_RESERVOIR_MGMT_STATE_T handlePreTreatmentReservoirMgmtRequestReservoirSwitchState( void ) +{ + PRE_TREATMENT_RESERVOIR_MGMT_STATE_T state = PRE_TREATMENT_RESERVOIR_MGMT_REQUEST_RESERVOIR_SWITCH_STATE; + DG_OP_MODE_T dgOpMode = getDGOpMode(); + U32 dgSubMode = getDGSubMode(); + DG_RESERVOIR_ID_T inactiveReservoir = getDGInactiveReservoir(); + + //wait after drain or fill + if ( ( DG_MODE_GENE == dgOpMode ) && ( DG_GEN_IDLE_MODE_STATE_FLUSH_WATER == dgSubMode ) ) + { + state = PRE_TREATMENT_RESERVOIR_MGMT_WAIT_FOR_RESERVOIR_SWITCH_STATE; + cmdSetDGActiveReservoir( inactiveReservoir ); + } + + return state; +} + +/*********************************************************************//** + * @brief * The handlePreTreatmentReservoirMgmtWaitReservoirSwitchState function waits * until prime operation switches the active reservoir before filling up next reservoir. * @details Inputs: DG intactive reservoir @@ -1181,23 +1231,80 @@ static PRE_TREATMENT_RESERVOIR_MGMT_STATE_T handlePreTreatmentReservoirMgmtWaitReservoirSwitchState( void ) { PRE_TREATMENT_RESERVOIR_MGMT_STATE_T state = PRE_TREATMENT_RESERVOIR_MGMT_WAIT_FOR_RESERVOIR_SWITCH_STATE; + DG_CMD_RESPONSE_T dgCmdResp; - if ( ( TRUE == reservoirFilledStatus[ DG_RESERVOIR_1 ] ) && ( FALSE == reservoirFilledStatus[ DG_RESERVOIR_2 ] ) ) + // handle fill command response from DG + if ( TRUE == getDGCommandResponse( DG_CMD_SWITCH_RESERVOIR, &dgCmdResp ) ) { - if ( DG_RESERVOIR_2 == getDGInactiveReservoir() ) + if ( DG_CMD_REQUEST_REJECT_REASON_INVALID_MODE == dgCmdResp.rejectCode ) { + + state = PRE_TREATMENT_RESERVOIR_MGMT_REQUEST_RESERVOIR_SWITCH_STATE; + } + else if ( dgCmdResp.rejectCode != DG_CMD_REQUEST_REJECT_REASON_NONE ) + { + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_HD_SOFTWARE_FAULT, SW_FAULT_ID_DG_INVALID_FILL_COMMAND_REJECTED, dgCmdResp.rejectCode ) + } + else + { state = PRE_TREATMENT_RESERVOIR_MGMT_DRAIN_CMD_STATE; } } + + return state; +} + +/*********************************************************************//** + * @brief + * The getPreTreatmentFillVolume function determines which volume to fill + * the inactive reservoir. + * @details Inputs: reservoirFlushedStatus + * @details Outputs: none + * @param DG inactive Reservoir + * @return volume to fill + *************************************************************************/ +static U32 getPreTreatmentFillVolume( DG_RESERVOIR_ID_T inactiveRes ) +{ + U32 volume = 0; + + // Fill volumes after flushing + if ( TRUE == reservoirFlushedStatus[ inactiveRes ] ) + { + if ( DG_RESERVOIR_1 == inactiveRes ) + { + volume = FILL_RESERVOIR_TO_VOLUME_ML; +#ifndef _RELEASE_ + if ( getSoftwareConfigStatus( SW_CONFIG_DISABLE_PRIMING ) != SW_CONFIG_ENABLE_VALUE ) + { + volume = PRE_TREATMENT_FILL_RESERVOIR_ONE_VOLUME_ML; + } +#endif + } + // Reservoir 2 + else + { + volume = FILL_RESERVOIR_TO_VOLUME_ML; +#ifndef _RELEASE_ + if ( getSoftwareConfigStatus( SW_CONFIG_DISABLE_PRIMING ) != SW_CONFIG_ENABLE_VALUE ) + { + volume = PRE_TREATMENT_FILL_RESERVOIR_TWO_VOLUME_ML; + } +#endif + } + } + // Flush fill volumes else { - if ( TRUE == hasDGCompletedReservoirSwitch() ) + volume = PRE_TREATMENT_FLUSH_RESERVOIR_VOLUME_ML; +#ifndef _RELEASE_ + if ( SW_CONFIG_ENABLE_VALUE == getSoftwareConfigStatus( SW_CONFIG_DISABLE_PRIMING ) ) { - state = PRE_TREATMENT_RESERVOIR_MGMT_DRAIN_CMD_STATE; + volume = FILL_RESERVOIR_TO_VOLUME_ML; } +#endif } - return state; + return volume; }