Index: firmware/App/Controllers/ROPump.c =================================================================== diff -u -rbe027f8c9bee75f07267f7a9ab5635bbb02df86e -r99011bfb443632a788f3afe395c9c63a797bde9d --- firmware/App/Controllers/ROPump.c (.../ROPump.c) (revision be027f8c9bee75f07267f7a9ab5635bbb02df86e) +++ firmware/App/Controllers/ROPump.c (.../ROPump.c) (revision 99011bfb443632a788f3afe395c9c63a797bde9d) @@ -55,19 +55,21 @@ #define RO_FLOW_ADC_TO_LPM_FACTOR 10909.0909 ///< conversion factor from ADC counts to LPM (liters/min) for RO flow rate (multiply this by inverse of FPGA reading). +/// Enumeration of RO pump states. typedef enum ROPump_States { - RO_PUMP_OFF_STATE = 0, - RO_PUMP_CONTROL_TO_TARGET_STATE, - NUM_OF_RO_PUMP_STATES + RO_PUMP_OFF_STATE = 0, ///< RO pump off state. + RO_PUMP_CONTROL_TO_TARGET_STATE, ///< RO pump control to target pressure state. + NUM_OF_RO_PUMP_STATES ///< Number of RO pump states. } RO_PUMP_STATE_T; +/// Enumeration of RO pump self test states. typedef enum ROPump_Self_Test_States { - RO_PUMP_SELF_TEST_STATE_START = 0, - RO_PUMP_TEST_STATE_IN_PROGRESS, - RO_PUMP_TEST_STATE_COMPLETE, - NUM_OF_RO_PUMP_SELF_TEST_STATES + RO_PUMP_SELF_TEST_STATE_START = 0, ///< RO pump self test start state. + RO_PUMP_TEST_STATE_IN_PROGRESS, ///< RO pump self tests in progress state. + RO_PUMP_TEST_STATE_COMPLETE, ///< RO pump self tests completed state. + NUM_OF_RO_PUMP_SELF_TEST_STATES ///< Number of RO pump self test states. } RO_PUMP_SELF_TEST_STATE_T; // TODO - test code - remove later