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 Index: firmware/App/Controllers/LoadCell.c =================================================================== diff -u -r0831cb6bf766fe461340b711f2ff14c3d797e10d -rc081112c61e0d85854e8f1e604ac7f1f37c2ec02 --- firmware/App/Controllers/LoadCell.c (.../LoadCell.c) (revision 0831cb6bf766fe461340b711f2ff14c3d797e10d) +++ firmware/App/Controllers/LoadCell.c (.../LoadCell.c) (revision c081112c61e0d85854e8f1e604ac7f1f37c2ec02) @@ -184,7 +184,7 @@ *************************************************************************/ -/************************************************************************* +/*********************************************************************//** * @brief * The testSetLoadCellOverride function overrides the measured \n * load cell A1. @@ -212,7 +212,7 @@ return result; } -/************************************************************************* +/*********************************************************************//** * @brief * The testResetLoadCellOverride function resets the override of the \n * load cell A1. Index: firmware/App/Controllers/ROPump.c =================================================================== diff -u -r0831cb6bf766fe461340b711f2ff14c3d797e10d -rc081112c61e0d85854e8f1e604ac7f1f37c2ec02 --- firmware/App/Controllers/ROPump.c (.../ROPump.c) (revision 0831cb6bf766fe461340b711f2ff14c3d797e10d) +++ firmware/App/Controllers/ROPump.c (.../ROPump.c) (revision c081112c61e0d85854e8f1e604ac7f1f37c2ec02) @@ -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 Index: firmware/App/Controllers/ROPump.h =================================================================== diff -u -ra75923f40bea362b44fc082ce8eebde7bfa97c9a -rc081112c61e0d85854e8f1e604ac7f1f37c2ec02 --- firmware/App/Controllers/ROPump.h (.../ROPump.h) (revision a75923f40bea362b44fc082ce8eebde7bfa97c9a) +++ firmware/App/Controllers/ROPump.h (.../ROPump.h) (revision c081112c61e0d85854e8f1e604ac7f1f37c2ec02) @@ -29,8 +29,8 @@ // ********** public definitions ********** -#define MAX_RO_PRESSURE 140 // PSI -#define MIN_RO_PRESSURE 100 // PSI +#define MAX_RO_PRESSURE 140 ///< Maximum target RO outlet pressure (in PSI). +#define MIN_RO_PRESSURE 100 ///< Minimum target RO outlet pressure (in PSI). // ********** public function prototypes ********** Index: firmware/App/Drivers/SafetyShutdown.c =================================================================== diff -u -r3cc737c39b4440e18abab95ef2f8b6aef13acba9 -rc081112c61e0d85854e8f1e604ac7f1f37c2ec02 --- firmware/App/Drivers/SafetyShutdown.c (.../SafetyShutdown.c) (revision 3cc737c39b4440e18abab95ef2f8b6aef13acba9) +++ firmware/App/Drivers/SafetyShutdown.c (.../SafetyShutdown.c) (revision c081112c61e0d85854e8f1e604ac7f1f37c2ec02) @@ -36,7 +36,7 @@ static BOOL safetyShutdownActivated = FALSE; ///< Status of safety shutdown signal. static BOOL safetyShutdownOverrideResetState = FALSE; ///< Natural status of safety shutdown signal. Used to restore state on override reset. -/************************************************************************* +/*********************************************************************//** * @brief * The initSafetyShutdown function initializes the Safety Shutdown module. * @details @@ -49,7 +49,7 @@ CLR_SAFETY_SHUTDOWN(); } -/************************************************************************* +/*********************************************************************//** * @brief * The activateSafetyShutdown function activates the safety shutdown signal. * @details