Index: firmware/App/Modes/ModeStandby.c =================================================================== diff -u -rdc0d9b087c609e71cacdb7f0395cccf29d749c00 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision dc0d9b087c609e71cacdb7f0395cccf29d749c00) +++ firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -32,14 +32,14 @@ // ********** private definitions ********** -#define WATER_SAMPLE_TIME_MS ( 10 * MS_PER_SECOND ) ///< Duration of water sample state (in ms). +#define WATER_SAMPLE_TIME_MS ( 10 * MS_PER_SECOND ) ///< Duration of water sample state (in ms). // ********** private data ********** -static DG_STANDBY_MODE_STATE_T standbyState = DG_STANDBY_MODE_STATE_START; ///< Currently active standby state. -static BOOL pendingSampleWaterRequest = FALSE; ///< Flag indicating HD has requested a water sample. -static BOOL pendingStartDGRequest = FALSE; ///< Flag indicating HD has requested DG start (go to re-circulate mode). -static U32 waterSampleStartTime = 0; ///< Time stamp for start of water sample state. +static DG_STANDBY_MODE_STATE_T standbyState = DG_STANDBY_MODE_STATE_START; ///< Currently active standby state. +static BOOL pendingSampleWaterRequest = FALSE; ///< Flag indicating HD has requested a water sample. +static BOOL pendingStartDGRequest = FALSE; ///< Flag indicating HD has requested DG start (go to re-circulate mode). +static U32 waterSampleStartTime = 0; ///< Time stamp for start of water sample state. // ********** private function prototypes ********** @@ -48,10 +48,10 @@ /*********************************************************************//** * @brief - * The initStandbyMode function initializes the Standby Mode module. + * The initStandbyMode function initializes the standby mode module. * @details * Inputs : none - * Outputs : Standby Mode module initialized. + * Outputs : Standby mode module initialized * @return none *************************************************************************/ void initStandbyMode( void ) @@ -67,7 +67,7 @@ * The transitionToStandbyMode function prepares for transition to standby mode. * @details * Inputs : none - * Outputs : + * Outputs : Re-initialized standby mode * @return none *************************************************************************/ void transitionToStandbyMode( void ) @@ -91,11 +91,11 @@ /*********************************************************************//** * @brief - * The execStandbyMode function executes the Standby Mode state machine. + * The execStandbyMode function executes the standby mode state machine. * @details * Inputs : none - * Outputs : - * @return current state. + * Outputs : Standby mode state machine executed + * @return current state *************************************************************************/ U32 execStandbyMode( void ) { @@ -125,11 +125,11 @@ /*********************************************************************//** * @brief - * The handleStandbyIdleState function executes the Idle state of the \n - * Standby Mode state machine. + * The handleStandbyIdleState function executes the idle state of the + * standby mode state machine. * @details * Inputs : pendingSampleWaterRequest, pendingStartDGRequest - * Outputs : possibly op mode + * Outputs : Idle state of the standby mode executed * @return the next state *************************************************************************/ static DG_STANDBY_MODE_STATE_T handleStandbyIdleState( void ) @@ -161,11 +161,11 @@ /*********************************************************************//** * @brief - * The handleStandbySampleWaterState function executes the sample water state \n - * of the Standby Mode state machine. + * The handleStandbySampleWaterState function executes the sample water state + * of the standby mode state machine. * @details * Inputs : none - * Outputs : + * Outputs : Sample water state of the standby mode executed * @return the next state *************************************************************************/ static DG_STANDBY_MODE_STATE_T handleStandbySampleWaterState( void ) @@ -227,8 +227,7 @@ /*********************************************************************//** * @brief - * The getCurrentStandbyState function returns the current state of the \n - * standby mode. + * The getCurrentStandbyState function returns the current state of standby mode. * @details * Inputs : standbyState * Outputs : none