Index: firmware/App/Drivers/FluidPump.h =================================================================== diff -u -r17a448770daa138ebeb6ce79974966e650828f25 -rd5574e12aa9638c933d11b9bee8d5cf024864440 --- firmware/App/Drivers/FluidPump.h (.../FluidPump.h) (revision 17a448770daa138ebeb6ce79974966e650828f25) +++ firmware/App/Drivers/FluidPump.h (.../FluidPump.h) (revision d5574e12aa9638c933d11b9bee8d5cf024864440) @@ -5,7 +5,7 @@ * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * -* @file BoostPump.h +* @file FluidPump.h * * @author (last) Sean Nash * @date (last) 12-Nov-2024 @@ -15,34 +15,35 @@ * ***************************************************************************/ -#ifndef __BOOST_PUMP_H__ -#define __BOOST_PUMP_H__ +#ifndef __FLUID_PUMP_H__ +#define __FLUID_PUMP_H__ #include "FPCommon.h" /** - * @defgroup BoostPump BoostPump - * @brief Boost Pump driver unit. Controls the RO and booster pumps. + * @defgroup FluidPump FluidPump + * @brief Fluid Pump driver unit. Controls the RO and booster pumps. * The diaphragm (RO) pump is manufactured by TBD. * The optional booster pump is manufactured by TBD. * - * @addtogroup BoostPump + * @addtogroup FluidPump * @{ */ // ********** public definitions ********** -#define MAX_FLUID_PUMP_PWM_DUTY_CYCLE 500 ///< Maximum settable boost pump duty cycle magnitude. -#define MIN_FLUID_PUMP_PWM_DUTY_CYCLE 0 ///< minimum settable boost pump duty cycle magnitude. +#define MAX_FLUID_PUMP_PWM_DUTY_CYCLE 500 ///< Maximum settable boost pump duty cycle magnitude. +#define MIN_FLUID_PUMP_PWM_DUTY_CYCLE 0 ///< minimum settable boost pump duty cycle magnitude. -#define MAX_FLUID_PUMP_DUTY_CYCLE_PCT 0.99F ///< Max duty cycle in percentage. -#define MIN_FLUID_PUMP_DUTY_CYCLE_PCT 0.0F ///< Min duty cycle in percentage. -/// Enumerations of RO boost pumps. -typedef enum BoostPumps +#define MAX_FLUID_PUMP_DUTY_CYCLE_PCT 0.99F ///< Max duty cycle in percentage. +#define MIN_FLUID_PUMP_DUTY_CYCLE_PCT 0.0F ///< Min duty cycle in percentage. + +/// Enumerations of fluid pumps. +typedef enum FluidPumps { - P12_PUMP = 0, ///< RO pump - P40_PUMP, ///< Optional inlet boost pump - NUM_OF_PUMPS, ///< Number of boost pumps + P12_PUMP = 0, ///< RO pump + P40_PUMP, ///< Optional inlet boost pump + NUM_OF_PUMPS, ///< Number of boost pumps } FP_FLUID_PUMP_T; // ********** public function prototypes ********** @@ -59,7 +60,6 @@ U16 convertDutyCyclePctToCnt( F32 dutyCyclePct ); BOOL setFluidPumpPctToPWMDutyCycle( FP_FLUID_PUMP_T pumpID, F32 dutyCyclePct); - BOOL testSetFluidPumpPWM( MESSAGE_T *message ); BOOL testFluidPumpPWMOverride( MESSAGE_T *message ); BOOL testFluidPumpRPMOverride( MESSAGE_T *message );