Index: firmware/App/Controllers/BoostPump.c =================================================================== diff -u -r3f5c0e277e979078c3153421274c660258e8a68b -r5e5ece62c01bc4576acd936fb4b200e8a336f2c2 --- firmware/App/Controllers/BoostPump.c (.../BoostPump.c) (revision 3f5c0e277e979078c3153421274c660258e8a68b) +++ firmware/App/Controllers/BoostPump.c (.../BoostPump.c) (revision 5e5ece62c01bc4576acd936fb4b200e8a336f2c2) @@ -267,8 +267,8 @@ * @brief * The handleBoostPumpControlToTargetFlowState function handles the control to * target flow state of the Boost pump controller state machine. - * @details Inputs: boostPumpPWMDutyCyclePctSet, boostControlTimerCounter, boostPumpControlMode - * @details Outputs: boostPumpPWMDutyCyclePctSet, boostControlTimerCounter + * @details \b Inputs: boostPumpPWMDutyCyclePctSet, boostControlTimerCounter, boostPumpControlMode + * @details \b Outputs: boostPumpPWMDutyCyclePctSet, boostControlTimerCounter * @return next state of the controller state machine *************************************************************************/ static BOOST_PUMP_STATE_T handleBoostPumpControlToTargetFlowState( void ) @@ -290,8 +290,8 @@ * @brief * The handleBoostPumpControlToTargetPressureState function handles the control * to target pressure state of the Boost pump controller state machine. - * @details Inputs: boostPumpPWMDutyCyclePctSet, boostControlTimerCounter, boostPumpControlMode - * @details Outputs: boostPumpPWMDutyCyclePctSet, boostControlTimerCounter + * @details \b Inputs: boostPumpPWMDutyCyclePctSet, boostControlTimerCounter, boostPumpControlMode + * @details \b Outputs: boostPumpPWMDutyCyclePctSet, boostControlTimerCounter * @return next state of the controller state machine *************************************************************************/ static BOOST_PUMP_STATE_T handleBoostPumpControlToTargetPressureState( void ) @@ -313,8 +313,8 @@ * @brief * The setBoostPumpTargetFlowRateLPM function sets a new target flow rate for the * Boost pump. - * @details Inputs: boostPumpOpenLoopTargetDutyCycle - * @details Outputs: targetBoostPumpFlowRate, boostPumpControlMode, boostPumpDutyCyclePctSet, + * @details \b Inputs: boostPumpOpenLoopTargetDutyCycle + * @details \b Outputs: targetBoostPumpFlowRate, boostPumpControlMode, boostPumpDutyCyclePctSet, * boostControlTimerCounter, isBoostPumpOn * @param boostFlowRate which is target Boost flow rate in mL/min * @return TRUE if new target flow rate is set successfully, FALSE if not @@ -357,8 +357,8 @@ * @brief * The setBoostPumpTargetPressure function sets a new target pressure for the * Boost pump. - * @details Inputs: boostPumpOpenLoopTargetDutyCycle, targetBoostPumpFlowRate - * @details Outputs: boostPumpOpenLoopTargetDutyCycle, targetBoostPumpFlowRate, isBoostPumpOn, + * @details \b Inputs: boostPumpOpenLoopTargetDutyCycle, targetBoostPumpFlowRate + * @details \b Outputs: boostPumpOpenLoopTargetDutyCycle, targetBoostPumpFlowRate, isBoostPumpOn, * boostControlTimerCounter, boostPumpDutyCyclePctSet, boostPumpControlMode, targetBoostPumpPressure * @param boostPressure which is target Boost pressure * @return TRUE if new target flow rate is set successfully, FALSE if not @@ -400,9 +400,9 @@ * @brief * The setBoostPumpTargetDutyCycle function sets the duty cycle that the * pump should run. - * @details Inputs: boostPumpOpenLoopTargetDutyCycle, boostPumpPWMDutyCyclePct, + * @details \b Inputs: boostPumpOpenLoopTargetDutyCycle, boostPumpPWMDutyCyclePct, * targetBoostPumpPressure, targetBoostPumpFlowRate - * @details Outputs: boostPumpOpenLoopTargetDutyCycle + * @details \b Outputs: boostPumpOpenLoopTargetDutyCycle * boostPumpControlMode, targetBoostPumpFlowRate, targetBoostPumpPressure * @param duty which is the duty cycle * @return none @@ -441,8 +441,8 @@ * @brief * The getTargetBoostPumpPressure function gets the current target Boost pump * pressure. - * @details Inputs: targetBoostPumpPressure - * @details Outputs: none + * @details \b Inputs: targetBoostPumpPressure + * @details \b Outputs: none * @return the current target Boost pressure in PSI *************************************************************************/ F32 getTargetBoostPumpPressure( void ) @@ -456,8 +456,8 @@ * @brief * The getTargetBoostPumpFlowRateLPM function gets the current target Boost pump * flow rate. - * @details Inputs: targetBoostPumpFlowRate - * @details Outputs: none + * @details \b Inputs: targetBoostPumpFlowRate + * @details \b Outputs: none * @return the current target Boost flow rate (in L/min). *************************************************************************/ F32 getTargetBoostPumpFlowRateLPM( void ) @@ -471,8 +471,8 @@ * @brief * The boostPumpPresToPWM function calculates the duty cycle for the given target * pressure. - * @details Inputs: none - * @details Outputs: dutyCyclePct + * @details \b Inputs: none + * @details \b Outputs: dutyCyclePct * @param targetPressure target pressure value to control in PSI * @return the current target Boost pump PWM in a percentage. *************************************************************************/ @@ -488,8 +488,8 @@ * @brief * The boostPumpFlowToPWM function calculates the duty cycle for the given target * flow rate. - * @details Inputs: none - * @details Outputs: dutyCyclePct + * @details \b Inputs: none + * @details \b Outputs: dutyCyclePct * @param targetFlow target flow value to control in in L/min * @return the current target Boost pump PWM in a percentage. *************************************************************************/ @@ -502,8 +502,8 @@ /*********************************************************************//** * @brief - * The signalBoostPumpStop function stops the P12 pump immediately and - * resets all the variables associated with the P12 pump run. + * The signalBoostPumpStop function stops the P40 pump immediately and + * resets all the variables associated with the P40 pump run. * @details \b Inputs: boostPumpState[] * @details \b Outputs: stopPumpRequest[] * @return none @@ -546,9 +546,9 @@ /*********************************************************************//** * @brief - * The isBoostPumpRunning function returns the on/off status of P12 pump. - * @details Inputs: isBoostPumpOn - * @details Outputs: none + * The isBoostPumpRunning function returns the on/off status of P40 pump. + * @details \b Inputs: isBoostPumpOn + * @details \b Outputs: none * @return isBoostPumpOn the boolean flag that is TRUE if the pump is on and * FALSE if it is off *************************************************************************/ @@ -559,8 +559,8 @@ /*********************************************************************//** * @brief - * The publishBoostPumpData function publishes p12 pump data at the set interval. - * @details \b Message \b Sent: + * The publishBoostPumpData function publishes p40 pump data at the set interval. + * @details \b Message \b Sent: MSG_ID_FP_BOOST_PUMP_DATA * @details \b Inputs: boostPumpDataPublicationTimerCounter * @details \b Outputs: boostPumpDataPublicationTimerCounter * @return none @@ -595,8 +595,8 @@ * @brief * The testBoostPumpDataPublishIntervalOverride function overrides the Boost pump * data publish interval. - * @details Inputs: boostPumpDataPublishInterval - * @details Outputs: boostPumpDataPublishInterval + * @details \b Inputs: boostPumpDataPublishInterval + * @details \b Outputs: boostPumpDataPublishInterval * @param message Override message from Dialin which includes the value * that override boost pump data publish interval with (in ms) * @return TRUE if override successful, FALSE if not @@ -612,8 +612,8 @@ * @brief * The testBoostPumpTargetPressureOverride function overrides the Boost pump * data publish interval. - * @details Inputs: targetBoostPumpPressure - * @details Outputs: targetBoostPumpPressure + * @details \b Inputs: targetBoostPumpPressure + * @details \b Outputs: targetBoostPumpPressure * @param message Override message from Dialin which includes the value * that override boost pump data publish interval with (in ms) * @return TRUE if override successful, FALSE if not @@ -629,8 +629,8 @@ * @brief * The testBoostPumpTargetFlowOverride function overrides the Boost pump * data publish interval. - * @details Inputs: targetBoostPumpFlowRate - * @details Outputs: targetBoostPumpFlowRate + * @details \b Inputs: targetBoostPumpFlowRate + * @details \b Outputs: targetBoostPumpFlowRate * @param message Override message from Dialin which includes the value * that override boost pump data publish interval with (in ms) * @return TRUE if override successful, FALSE if not Index: firmware/App/Controllers/ROPump.c =================================================================== diff -u -ra80e7b6bee41fed2e5246332c577c5a29de1d8dc -r5e5ece62c01bc4576acd936fb4b200e8a336f2c2 --- firmware/App/Controllers/ROPump.c (.../ROPump.c) (revision a80e7b6bee41fed2e5246332c577c5a29de1d8dc) +++ firmware/App/Controllers/ROPump.c (.../ROPump.c) (revision 5e5ece62c01bc4576acd936fb4b200e8a336f2c2) @@ -266,8 +266,8 @@ * @brief * The handleROPumpControlToTargetFlowState function handles the control to * target flow state of the RO pump controller state machine. - * @details Inputs: roPumpPWMDutyCyclePctSet, roControlTimerCounter, roPumpControlMode - * @details Outputs: roPumpPWMDutyCyclePctSet, roControlTimerCounter + * @details \b Inputs: roPumpPWMDutyCyclePctSet, roControlTimerCounter, roPumpControlMode + * @details \b Outputs: roPumpPWMDutyCyclePctSet, roControlTimerCounter * @return next state of the controller state machine *************************************************************************/ static RO_PUMP_STATE_T handleROPumpControlToTargetFlowState( void ) @@ -289,8 +289,8 @@ * @brief * The handleROPumpControlToTargetPressureState function handles the control * to target pressure state of the RO pump controller state machine. - * @details Inputs: roPumpPWMDutyCyclePctSet, roControlTimerCounter, roPumpControlMode - * @details Outputs: roPumpPWMDutyCyclePctSet, roControlTimerCounter + * @details \b Inputs: roPumpPWMDutyCyclePctSet, roControlTimerCounter, roPumpControlMode + * @details \b Outputs: roPumpPWMDutyCyclePctSet, roControlTimerCounter * @return next state of the controller state machine *************************************************************************/ static RO_PUMP_STATE_T handleROPumpControlToTargetPressureState( void ) @@ -312,8 +312,8 @@ * @brief * The setROPumpTargetFlowRateLPM function sets a new target flow rate for the * RO pump. - * @details Inputs: roPumpOpenLoopTargetDutyCycle - * @details Outputs: targetROPumpFlowRate, roPumpControlMode, roPumpDutyCyclePctSet, + * @details \b Inputs: roPumpOpenLoopTargetDutyCycle + * @details \b Outputs: targetROPumpFlowRate, roPumpControlMode, roPumpDutyCyclePctSet, * roControlTimerCounter, isROPumpOn * @param roFlowRate which is target RO flow rate in mL/min * @return TRUE if new target flow rate is set successfully, FALSE if not @@ -356,8 +356,8 @@ * @brief * The setROPumpTargetPressure function sets a new target pressure for the * RO pump. - * @details Inputs: roPumpOpenLoopTargetDutyCycle, targetROPumpFlowRate - * @details Outputs: roPumpOpenLoopTargetDutyCycle, targetROPumpFlowRate, isROPumpOn, + * @details \b Inputs: roPumpOpenLoopTargetDutyCycle, targetROPumpFlowRate + * @details \b Outputs: roPumpOpenLoopTargetDutyCycle, targetROPumpFlowRate, isROPumpOn, * roControlTimerCounter, roPumpDutyCyclePctSet, roPumpControlMode, targetROPumpPressure * @param roPressure which is target RO pressure * @return TRUE if new target flow rate is set successfully, FALSE if not @@ -399,9 +399,9 @@ * @brief * The setROPumpTargetDutyCycle function sets the duty cycle that the * pump should run. - * @details Inputs: roPumpOpenLoopTargetDutyCycle, roPumpPWMDutyCyclePct, + * @details \b Inputs: roPumpOpenLoopTargetDutyCycle, roPumpPWMDutyCyclePct, * targetROPumpPressure, targetROPumpFlowRate - * @details Outputs: roPumpOpenLoopTargetDutyCycle + * @details \b Outputs: roPumpOpenLoopTargetDutyCycle * roPumpControlMode, targetROPumpFlowRate, targetROPumpPressure * @param duty which is the duty cycle * @return none @@ -440,8 +440,8 @@ * @brief * The getTargetROPumpPressure function gets the current target RO pump * pressure. - * @details Inputs: targetROPumpPressure - * @details Outputs: none + * @details \b Inputs: targetROPumpPressure + * @details \b Outputs: none * @return the current target RO pressure in PSI *************************************************************************/ F32 getTargetROPumpPressure( void ) @@ -455,8 +455,8 @@ * @brief * The getTargetROPumpFlowRateMLPM function gets the current target RO pump * flow rate. - * @details Inputs: targetROPumpFlowRate - * @details Outputs: none + * @details \b Inputs: targetROPumpFlowRate + * @details \b Outputs: none * @return the current target RO flow rate (in L/min). *************************************************************************/ F32 getTargetROPumpFlowRateLPM( void ) @@ -470,8 +470,8 @@ * @brief * The roPumpPresToPWM function calculates the duty cycle for the given target * pressure. - * @details Inputs: none - * @details Outputs: dutyCyclePct + * @details \b Inputs: none + * @details \b Outputs: dutyCyclePct * @param targetPressure target pressure value to control in PSI * @return the current target RO pump PWM in a percentage. *************************************************************************/ @@ -486,8 +486,8 @@ * @brief * The roPumpFlowToPWM function calculates the duty cycle for the given target * flow rate. - * @details Inputs: none - * @details Outputs: dutyCyclePct + * @details \b Inputs: none + * @details \b Outputs: dutyCyclePct * @param targetFlow target flow value to control in in mL/min * @return the current target RO pump PWM in a percentage. *************************************************************************/ @@ -530,8 +530,8 @@ /*********************************************************************//** * @brief * The stopROPump function sets the P12 pump duty cycle to zero. - * @details Inputs: none - * @details Outputs: isROPumpOn, roPumpPWMDutyCyclePctSet + * @details \b Inputs: none + * @details \b Outputs: isROPumpOn, roPumpPWMDutyCyclePctSet * @return none *************************************************************************/ static void stopROPump( void ) @@ -545,8 +545,8 @@ /*********************************************************************//** * @brief * The isROPumpRunning function returns the on/off status of P12 pump. - * @details Inputs: isROPumpOn - * @details Outputs: none + * @details \b Inputs: isROPumpOn + * @details \b Outputs: none * @return isROPumpOn the boolean flag that is TRUE if the pump is on and * FALSE if it is off *************************************************************************/ @@ -558,7 +558,7 @@ /*********************************************************************//** * @brief * The publishROPumpData function publishes p12 pump data at the set interval. - * @details \b Message \b Sent: + * @details \b Message \b Sent: MSG_ID_FP_RO_PUMP_DATA * @details \b Inputs: roPumpDataPublicationTimerCounter * @details \b Outputs: roPumpDataPublicationTimerCounter * @return none @@ -593,8 +593,8 @@ * @brief * The testROPumpDataPublishIntervalOverride function overrides the RO pump * data publish interval. - * @details Inputs: roPumpDataPublishInterval - * @details Outputs: roPumpDataPublishInterval + * @details \b Inputs: roPumpDataPublishInterval + * @details \b Outputs: roPumpDataPublishInterval * @param message Override message from Dialin which includes the value * that override ro pump data publish interval with (in ms) * @return TRUE if override successful, FALSE if not @@ -610,8 +610,8 @@ * @brief * The testROPumpTargetPressureOverride function overrides the RO pump * data publish interval. - * @details Inputs: targetROPumpPressure - * @details Outputs: targetROPumpPressure + * @details \b Inputs: targetROPumpPressure + * @details \b Outputs: targetROPumpPressure * @param message Override message from Dialin which includes the value * that override ro pump data publish interval with (in ms) * @return TRUE if override successful, FALSE if not @@ -627,8 +627,8 @@ * @brief * The testROPumpTargetFlowOverride function overrides the RO pump * data publish interval. - * @details Inputs: targetROPumpFlowRate - * @details Outputs: targetROPumpFlowRate + * @details \b Inputs: targetROPumpFlowRate + * @details \b Outputs: targetROPumpFlowRate * @param message Override message from Dialin which includes the value * that override ro pump data publish interval with (in ms) * @return TRUE if override successful, FALSE if not