Index: firmware/App/Controllers/Heaters.c =================================================================== diff -u -r4d7d40a27130dc813d653f044cbb856b1b7d8481 -r0ab2c7bbd020dc4481b0727d785fd2b13bd90c13 --- firmware/App/Controllers/Heaters.c (.../Heaters.c) (revision 4d7d40a27130dc813d653f044cbb856b1b7d8481) +++ firmware/App/Controllers/Heaters.c (.../Heaters.c) (revision 0ab2c7bbd020dc4481b0727d785fd2b13bd90c13) @@ -151,8 +151,9 @@ * @brief * The initHeaters function initializes the variables and the PI controllers * for the primary and trimmer heaters. - * @details Inputs: none - * @details Outputs: Heaters module initialized + * @details + * Inputs : none + * Outputs : Heaters module initialized * @return none *************************************************************************/ void initHeaters( void ) @@ -182,8 +183,9 @@ * @brief * The setPrimaryHeaterTargetTemperature function sets the primary heater * target temperature. - * @details Inputs: none - * @details Outputs: primaryHeaterTargetTemperature + * @details + * Inputs : none + * Outputs : primaryHeaterTargetTemperature * @param targetTemp target temperature for the primary heater * @return none *************************************************************************/ @@ -196,8 +198,9 @@ * @brief * The setTrimmerHeaterTargetTemperature function sets the trimmer heater * target temperature. - * @details Inputs: none - * @details Outputs: trimmerHeaterTargetTemperature + * @details + * Inputs : none + * Outputs : trimmerHeaterTargetTemperature * @param targetTemp target temperature for the trimmer heater * @return none *************************************************************************/ @@ -210,8 +213,9 @@ * @brief * The startPrimaryHeater function starts the primary heaters. It resets * the primary heaters state and sets the main primary heater duty cycle. - * @details Inputs: primaryHeaterTargetTemperature - * @details Outputs: hasStartPrimaryHeaterRequested + * @details + * Inputs : primaryHeaterTargetTemperature + * Outputs : hasStartPrimaryHeaterRequested * @return status *************************************************************************/ BOOL startPrimaryHeater( void ) @@ -233,8 +237,9 @@ * @brief * The startTrimmerHeater function starts the trimmer heater. It resets the * trimmer heater's state and sets the duty cycle of the trimmer heater. - * @details Inputs: trimmerHeaterTargetTemperature - * @details Outputs: hasStartTrimmerHeaterRequested + * @details + * Inputs : trimmerHeaterTargetTemperature + * Outputs : hasStartTrimmerHeaterRequested * @return status *************************************************************************/ BOOL startTrimmerHeater( void ) @@ -255,8 +260,9 @@ /*********************************************************************//** * @brief * The stopPrimaryHeater function stops the primary heater. - * @details Inputs: none - * @details Outputs: Primary heater stops + * @details + * Inputs : none + * Outputs : Primary heater stops * @return none *************************************************************************/ void stopPrimaryHeater( void ) @@ -271,8 +277,9 @@ /*********************************************************************//** * @brief * The stopTrimmerHeater function stops the trimmer heater. - * @details Inputs: none - * @details Outputs: Trimmer heater stops + * @details + * Inputs : none + * Outputs : Trimmer heater stops * @return none *************************************************************************/ void stopTrimmerHeater( void ) @@ -285,8 +292,9 @@ /*********************************************************************//** * @brief * The execHeatersMonitor function turns off the heaters when RO pump is not on. - * @details Inputs: none - * @details Outputs: Turns off the heaters when RO pump is not on + * @details + * Inputs : none + * Outputs : Turns off the heaters when RO pump is not on * @return none *************************************************************************/ void execHeatersMonitor( void ) @@ -306,8 +314,9 @@ /*********************************************************************//** * @brief * The execHeatersSelfTest function executes the heaters' self-test state machine. - * @details Inputs: heatersSelfTestState - * @details Outputs: heatersSelfTestState + * @details + * Inputs : heatersSelfTestState + * Outputs : heatersSelfTestState * @return heatersSelfTestState *************************************************************************/ SELF_TEST_STATUS_T execHeatersSelfTest( void ) @@ -342,8 +351,9 @@ /*********************************************************************//** * @brief * The execPrimaryHeaters function executes the primary heaters' state machine. - * @details Inputs: primaryHeatersExecState - * @details Outputs: primaryHeatersExecState + * @details + * Inputs : primaryHeatersExecState + * Outputs : primaryHeatersExecState * @return none *************************************************************************/ void execPrimaryHeaters( void ) @@ -368,8 +378,9 @@ /*********************************************************************//** * @brief * The execTrimmerHeater function executes the trimmer heater's state machine. - * @details Inputs: trimmerHeaterExecState - * @details Outputs: trimmerHeaterExecState + * @details + * Inputs : trimmerHeaterExecState + * Outputs : trimmerHeaterExecState * @return none *************************************************************************/ void execTrimmerHeater( void ) @@ -395,8 +406,9 @@ * @brief * The handleHeatersSelfTestStart function starts the small primary and * the trimmer heaters for self-test. - * @details Inputs: heatersSelfTestResult, selfTestElapsedTime - * @details Outputs: heatersSelfTestResult, selfTestElapsedTime + * @details + * Inputs : heatersSelfTestResult, selfTestElapsedTime + * Outputs : heatersSelfTestResult, selfTestElapsedTime * @return state (HEATERS_SELF_TEST_STATES_T) *************************************************************************/ static HEATERS_SELF_TEST_STATES_T handleHeatersSelfTestStart( void ) @@ -423,8 +435,9 @@ * elapsed, it checks the thermocouple temperature shared among the two * heaters. If they are in range, it sets the main primary heater and transitions * to the next state. If it fails, it sets an alarm and fails the test. - * @details Inputs: heatersSelfTestResult, selfTestElapsedTime - * @details Outputs: heatersSelfTestResult, selfTestElapsedTime + * @details + * Inputs : heatersSelfTestResult, selfTestElapsedTime + * Outputs : heatersSelfTestResult, selfTestElapsedTime * @return state (HEATERS_SELF_TEST_STATES_T) *************************************************************************/ static HEATERS_SELF_TEST_STATES_T handleHeatersSelfTestSmallPrimaryAndTrimmerHeaters( void ) @@ -462,8 +475,9 @@ * on the main primary heater has elapsed. When the time has elapsed, it * checks to ensure the thermocouple temperature is within the tolerance * of the target temperature. It then transitions to the complete state. - * @details Inputs: heatersSelfTestResult - * @details Outputs: heatersSelfTestResult + * @details + * Inputs : heatersSelfTestResult + * Outputs : heatersSelfTestResult * @return state (HEATERS_SELF_TEST_STATES_T) *************************************************************************/ static HEATERS_SELF_TEST_STATES_T handleHeatersSelfTestMainPrimaryHeater( void ) @@ -497,8 +511,9 @@ * @brief * The handlePrimaryHeaterStateOff function handles the primary heaters at * off state. - * @details Inputs: hasStartPrimaryHeaterRequested, isPrimaryHeaterOn - * @details Outputs: state (PRIMARY_HEATERS_EXEC_STATES_T), isPrimaryHeaterOn + * @details + * Inputs : hasStartPrimaryHeaterRequested, isPrimaryHeaterOn + * Outputs : state (PRIMARY_HEATERS_EXEC_STATES_T), isPrimaryHeaterOn * @return state (PRIMARY_HEATERS_EXEC_STATES_T) *************************************************************************/ static PRIMARY_HEATERS_EXEC_STATES_T handlePrimaryHeaterStateOff( void ) @@ -543,9 +558,10 @@ * @brief * The handlePrimaryHeaterStateControlToTarget function handles the primary * heaters at control state when the heaters are active. - * @details Inputs: primaryHeaterTimerCounter, mainPrimaryHeaterDutyCycle, + * @details + * Inputs : primaryHeaterTimerCounter, mainPrimaryHeaterDutyCycle, * smallPrimaryHeaterDutyCycle, isPrimaryHeaterOn - * @details Outputs: primaryHeaterTimerCounter, mainPrimaryHeaterDutyCycle, + * Outputs : primaryHeaterTimerCounter, mainPrimaryHeaterDutyCycle, * smallPrimaryHeaterDutyCycle * @return state (PRIMARY_HEATERS_EXEC_STATES_T) *************************************************************************/ @@ -609,8 +625,9 @@ * @brief * The handleTrimmerHeaterStateOff function handles the trimmer heater at * off state. - * @details Inputs: hasStartTrimmerHeaterRequested, isTrimmerHeaterOn - * @details Outputs: state (TRIMMER_HEATER_EXEC_STATES_T), isTrimmerHeaterOn + * @details + * Inputs : hasStartTrimmerHeaterRequested, isTrimmerHeaterOn + * Outputs : state (TRIMMER_HEATER_EXEC_STATES_T), isTrimmerHeaterOn * @return state (TRIMMER_HEATER_EXEC_STATES_T) *************************************************************************/ static TRIMMER_HEATER_EXEC_STATES_T handleTrimmerHeaterStateOff( void ) @@ -658,8 +675,9 @@ * @brief * The handleTrimmerHeaterControlToTarget function handles the trimmer * heater at control state when the heater is active. - * @details Inputs: trimmerHeaterTimerCounter, trimmerHeaterDutyCycle - * @details Outputs: trimmerHeaterTimerCounter, trimmerHeaterDutyCycle, isTrimmerHeaterOn + * @details + * Inputs : trimmerHeaterTimerCounter, trimmerHeaterDutyCycle + * Outputs : trimmerHeaterTimerCounter, trimmerHeaterDutyCycle, isTrimmerHeaterOn * @return state (TRIMMER_HEATER_EXEC_STATES_T) *************************************************************************/ static TRIMMER_HEATER_EXEC_STATES_T handleTrimmerHeaterControlToTarget( void ) @@ -709,8 +727,9 @@ /*********************************************************************//** * @brief * The setMainPrimaryHeaterPWM function sets the PWM of the main primary heater. - * @details Inputs: none - * @details Outputs: Sets the PWM duty cycle for the main primary heater + * @details + * Inputs : none + * Outputs : Sets the PWM duty cycle for the main primary heater * @param pwm PWM duty cycle to set for 1st primary heater element * @return none *************************************************************************/ @@ -722,8 +741,9 @@ /*********************************************************************//** * @brief * The setSmallPrimaryHeaterPWM function sets the PWM of the small primary heater. - * @details Inputs: none - * @details Outputs: Sets the PWM duty cycle for the small primary heater + * @details + * Inputs : none + * Outputs : Sets the PWM duty cycle for the small primary heater * @param pwm PWM duty cycle to set for 2nd primary heater element * @return none *************************************************************************/ @@ -735,8 +755,9 @@ /*********************************************************************//** * @brief * The setTrimmerHeaterPWM function sets the PWM of the trimmer heater. - * @details Inputs: none - * @details Outputs: Sets the PWM duty cycle for the trimmer heater + * @details + * Inputs : none + * Outputs : Sets the PWM duty cycle for the trimmer heater * @param pwm PWM duty cycle to set for trimmer heater * @return none *************************************************************************/ @@ -748,8 +769,9 @@ /*********************************************************************//** * @brief * The resetHeaterState function resets the PI controller of the selected heater. - * @details Inputs: mainPrimaryHeaterDutyCycle, trimmerHeaterDutyCycle - * @details Outputs: mainPrimaryHeaterDutyCycle, trimmerHeaterDutyCycle + * @details + * Inputs : mainPrimaryHeaterDutyCycle, trimmerHeaterDutyCycle + * Outputs : mainPrimaryHeaterDutyCycle, trimmerHeaterDutyCycle * @param heater enumeration of the heater for which the PI controller will be reset * @return none *************************************************************************/ @@ -770,8 +792,9 @@ /*********************************************************************//** * @brief * The getPublishHeatersDataInterval function gets the publish interval. - * @details Inputs: heatersDataPublishInterval - * @details Outputs: none + * @details + * Inputs : heatersDataPublishInterval + * Outputs : none * @return result *************************************************************************/ U32 getPublishHeatersDataInterval( void ) @@ -790,8 +813,9 @@ * @brief * The publishTemperatureData function publishes the temperature sensors * data into the USB debug port at the defined time interval. - * @details Inputs: dataPublicationTimerCounter - * @details Outputs: Broadcast temperature sensors' data + * @details + * Inputs : dataPublicationTimerCounter + * Outputs : Broadcast temperature sensors' data * @return none *************************************************************************/ static void publishHeatersData( void ) @@ -832,8 +856,9 @@ * @brief * The testSetHeatersPublishIntervalOverride function overrides the heaters * publish data time interval. - * @details Inputs: heatersDataPublishInterval - * @details Outputs: heatersDataPublishInterval + * @details + * Inputs : heatersDataPublishInterval + * Outputs : heatersDataPublishInterval * @return result *************************************************************************/ BOOL testSetHeatersPublishIntervalOverride( U32 value ) @@ -856,8 +881,9 @@ * @brief * The testResetHeatersPublishIntervalOverride function resets the heaters * publish time interval to its previous time interval. - * @details Inputs: heatersDataPublishInterval - * @details Outputs: heatersDataPublishInterval + * @details + * Inputs : heatersDataPublishInterval + * Outputs : heatersDataPublishInterval * @return result *************************************************************************/ BOOL testResetHeatersPublishIntervalOverride( void )