Index: firmware/App/Modes/ModeStandby.c =================================================================== diff -u -r52ded7b22d4b413aa8182f1343e4fbb78e8c3b0a -r090cfb22a7c0b4738299c3fb411ca77aaba8d968 --- firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision 52ded7b22d4b413aa8182f1343e4fbb78e8c3b0a) +++ firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision 090cfb22a7c0b4738299c3fb411ca77aaba8d968) @@ -84,8 +84,8 @@ /*********************************************************************//** * @brief * The initStandbyMode function initializes the standby mode module. - * @details Inputs: none - * @details Outputs: standbyState, stopSampleWaterRequest, startSampleWaterRequest, + * @details \b Inputs: none + * @details \b Outputs: standbyState, stopSampleWaterRequest, startSampleWaterRequest, * flushFilterRequest, endSampleWaterRequest, waterSampleStartTime, * filterFlushStartTime, filterFlushPublishTimerCounter, pendingStartDGRequest, * pendingStartDGHeatDisinfectActiveCoolRequest, @@ -116,8 +116,9 @@ /*********************************************************************//** * @brief * The transitionToStandbyMode function prepares for transition to standby mode. - * @details Inputs: none - * @details Outputs: Re-initialized standby mode + * while transition, deenergize all actuators and update DD usage info to TD module. + * @details \b Inputs: none + * @details \b Outputs: Re-initialized standby mode * @return initial state *************************************************************************/ U32 transitionToStandbyMode( void ) @@ -158,8 +159,9 @@ /*********************************************************************//** * @brief * The execStandbyMode function executes the standby mode state machine. - * @details Inputs: none - * @details Outputs: Standby mode state machine executed + * @details \b Inputs: none + * @details \b Outputs: Standby mode state machine executed + * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT if stanbyState is invalid. * @return current state *************************************************************************/ U32 execStandbyMode( void ) @@ -206,8 +208,8 @@ * @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 + * @details \b Inputs: none + * @details \b Outputs: None * @return TRUE if any of the alarms are active, otherwise, FALSE *************************************************************************/ static BOOL areInletWaterConditionsAlarmsActive( void ) @@ -234,10 +236,10 @@ * @brief * The handleStandbyIdleState function executes the idle state of the * standby mode state machine. - * @details Inputs: pendingSampleWaterRequest, pendingStartDGRequest, + * @details \b Inputs: pendingSampleWaterRequest, pendingStartDGRequest, * pendingStartDGFlushRequest, pendingStartDGHeatDisinfectRequest, * pendingStartDGChemicalDisinfectRequest - * @details Outputs: Idle state of the standby mode executed, + * @details \b Outputs: Idle state of the standby mode executed, * pendingStartDGFlushRequest, pendingStartDGHeatDisinfectRequest, * pendingStartDGChemicalDisinfectRequest * @return the next state @@ -304,8 +306,8 @@ * @brief * The handleStandbyFilterFlushState function executes the flush filter state * of the standby mode state machine. - * @details Inputs: filterFLushStartTime - * @details Outputs: Flushed the filters + * @details \b Inputs: filterFLushStartTime + * @details \b Outputs: Flushed the filters * @return the next state *************************************************************************/ static DG_STANDBY_MODE_STATE_T handleStandbyFlushFilterState( void ) @@ -344,8 +346,8 @@ * @brief * The handleStandbyFlushFilterIdleState function executes the flush filter * idle state of the standby mode state machine. - * @details Inputs: filterFLushStartTime, startSampleWaterRequest, endSampleWaterRequest - * @details Outputs: Flushed the filters, startSampleWaterRequest, endSampleWaterRequest, + * @details \b Inputs: filterFLushStartTime, startSampleWaterRequest, endSampleWaterRequest + * @details \b Outputs: Flushed the filters, startSampleWaterRequest, endSampleWaterRequest, * waterSampleStartTime * @return the next state *************************************************************************/ @@ -377,8 +379,8 @@ * @brief * The handleStandbySampleWaterState function executes the sample water state * of the standby mode state machine. - * @details Inputs: stopSampleWaterRequest, waterSampleStartTime - * @details Outputs: Finished sample water and closed valve + * @details \b Inputs: stopSampleWaterRequest, waterSampleStartTime + * @details \b Outputs: Finished sample water and closed valve * @return the next state *************************************************************************/ static DG_STANDBY_MODE_STATE_T handleStandbySampleWaterState( void ) @@ -400,8 +402,8 @@ /*********************************************************************//** * @brief * The handleStandbyPauseState function executes the pause state. - * @details Inputs: none - * @details Outputs: filterFlushStartTime + * @details \b Inputs: none + * @details \b Outputs: filterFlushStartTime * @return the next state *************************************************************************/ static DG_STANDBY_MODE_STATE_T handleStandbyPauseState( void ) @@ -420,8 +422,8 @@ /*********************************************************************//** * @brief * The requestWaterSample function handles an HD request to sample water. - * @details Inputs: standbyState - * @details Outputs: pendingSampleWaterRequest + * @details \b Inputs: standbyState + * @details \b Outputs: pendingSampleWaterRequest * @return TRUE if request accepted, FALSE if not. *************************************************************************/ void waterSampleCommandHandler( SAMPLE_WATER_CMD_T sampleWaterCmd ) @@ -481,8 +483,8 @@ /*********************************************************************//** * @brief * The requestDGStart function handles an HD request to start (go to generation idle mode). - * @details Inputs: standbyState - * @details Outputs: pendingSampleWaterRequest + * @details \b Inputs: standbyState + * @details \b Outputs: pendingSampleWaterRequest * @return TRUE if request accepted, FALSE if not. *************************************************************************/ BOOL requestDGStart( void ) @@ -505,8 +507,8 @@ * @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 + * @details \b Inputs: none + * @details \b Outputs: standby mode variable initialized * @return TRUE if request accepted, FALSE if not *************************************************************************/ BOOL signalAbortWaterSampling( void ) @@ -527,8 +529,8 @@ /*********************************************************************//** * @brief * The startDGFlush function starts DG flush mode. - * @details Inputs: standbyState - * @details Outputs: none + * @details \b Inputs: standbyState + * @details \b Outputs: none * @return: TRUE if the switch was successful, otherwise FALSE *************************************************************************/ BOOL startDGFlush( void ) @@ -587,8 +589,8 @@ /*********************************************************************//** * @brief * The startDGHeatDisinfect function starts heat disinfect mode. - * @details Inputs: standbyState - * @details Outputs: none + * @details \b Inputs: standbyState + * @details \b Outputs: none * @return: TRUE if the switch was successful *************************************************************************/ BOOL startDGHeatDisinfect( void ) @@ -648,8 +650,8 @@ * @brief * The startDGHeatDisinfectActiveCool function starts heat disinfect active * cool mode. - * @details Inputs: standbyState - * @details Outputs: none + * @details \b Inputs: standbyState + * @details \b Outputs: none * @return: TRUE if the switch was successful *************************************************************************/ BOOL startDGHeatDisinfectActiveCool( void ) @@ -708,8 +710,8 @@ /*********************************************************************//** * @brief * The startDGChemicalDisinfect function starts chemical disinfect mode. - * @details Inputs: standbyState - * @details Outputs: none + * @details \b Inputs: standbyState + * @details \b Outputs: none * @return: TRUE if the switch was successful *************************************************************************/ BOOL startDGChemicalDisinfect( void ) @@ -755,8 +757,8 @@ /*********************************************************************//** * @brief * The startDGChemicalDisinfectFlush function starts chemical disinfect flush mode. - * @details Inputs: standbyState - * @details Outputs: none + * @details \b Inputs: standbyState + * @details \b Outputs: none * @return: TRUE if the switch was successful *************************************************************************/ BOOL startDGChemicalDisinfectFlush( void ) @@ -809,8 +811,8 @@ /*********************************************************************//** * @brief * The startDGROPermeateSample function starts RO permeate sample mode. - * @details Inputs: standbyState - * @details Outputs: pendingStartDGChemicalDisinfectFlushRequest + * @details \b Inputs: standbyState + * @details \b Outputs: pendingStartDGChemicalDisinfectFlushRequest * @return: TRUE if the switch was successful *************************************************************************/ BOOL startDGROPermeateSample( void ) @@ -874,8 +876,8 @@ /*********************************************************************//** * @brief * The getCurrentStandbyState function returns the current state of standby mode. - * @details Inputs: standbyState - * @details Outputs: none + * @details \b Inputs: standbyState + * @details \b Outputs: none * @return the current state of standby mode. *************************************************************************/ DG_STANDBY_MODE_STATE_T getCurrentStandbyState( void ) @@ -893,8 +895,8 @@ * @brief * The testSetFilterFlushTimePeriodOverride function overrides the filter * flush time period. - * @details Inputs: none - * @details Outputs: filterFlushTimePeriod + * @details \b Inputs: none + * @details \b Outputs: filterFlushTimePeriod * @param value override concentrate pump data publish interval with (in ms) * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -916,8 +918,8 @@ * @brief * The testResetFilterFlushTimePeriodOverride function resets the * override of the filter flush time period. - * @details Inputs: none - * @details Outputs: filterFlushTimePeriod + * @details \b Inputs: none + * @details \b Outputs: filterFlushTimePeriod * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetFilterFlushTimePeriodOverride( void )