Index: firmware/App/Controllers/DrainPump.c =================================================================== diff -u -rbbf1e3736be03a4f041ace57e0f95e23caf472dd -rc081112c61e0d85854e8f1e604ac7f1f37c2ec02 --- firmware/App/Controllers/DrainPump.c (.../DrainPump.c) (revision bbf1e3736be03a4f041ace57e0f95e23caf472dd) +++ firmware/App/Controllers/DrainPump.c (.../DrainPump.c) (revision c081112c61e0d85854e8f1e604ac7f1f37c2ec02) @@ -46,19 +46,21 @@ #define DRP_SPEED_ADC_TO_RPM_FACTOR 12.94 ///< conversion factor from ADC counts to RPM for Drain pump #define DRP_SPEED_RPM_TO_ADC_FACTOR ( 1.0 / DRP_SPEED_ADC_TO_RPM_FACTOR ) ///< conversion factor from RPM to ADC counts for Drain pump +/// Enumeration of drain pump states. typedef enum DrainPump_States { - DRAIN_PUMP_OFF_STATE = 0, - DRAIN_PUMP_CONTROL_TO_TARGET_STATE, - NUM_OF_DRAIN_PUMP_STATES + DRAIN_PUMP_OFF_STATE = 0, ///< Drain pump off state. + DRAIN_PUMP_CONTROL_TO_TARGET_STATE, ///< Drain pump control to target state. + NUM_OF_DRAIN_PUMP_STATES ///< Number of drain pump states. } DRAIN_PUMP_STATE_T; +/// Enumeration of drain pump self test states. typedef enum DrainPump_Self_Test_States { - DRAIN_PUMP_SELF_TEST_STATE_START = 0, - DRAIN_PUMP_TEST_STATE_IN_PROGRESS, - DRAIN_PUMP_TEST_STATE_COMPLETE, - NUM_OF_DRAIN_PUMP_SELF_TEST_STATES + DRAIN_PUMP_SELF_TEST_STATE_START = 0, ///< Drain pump self test start state. + DRAIN_PUMP_TEST_STATE_IN_PROGRESS, ///< Drain pump self tests in progress state. + DRAIN_PUMP_TEST_STATE_COMPLETE, ///< Drain pump self tests completed state. + NUM_OF_DRAIN_PUMP_SELF_TEST_STATES ///< Number of drain pump self test states. } DRAIN_PUMP_SELF_TEST_STATE_T; // pin assignment for pump enable