Index: firmware/App/Services/PIControllers.h =================================================================== diff -u -rdaf8d5b60c753becab80cbaf164aac0e49d533a2 -rab304e2ca6e3e40ed8cb12650e9855ae0b9649d8 --- firmware/App/Services/PIControllers.h (.../PIControllers.h) (revision daf8d5b60c753becab80cbaf164aac0e49d533a2) +++ firmware/App/Services/PIControllers.h (.../PIControllers.h) (revision ab304e2ca6e3e40ed8cb12650e9855ae0b9649d8) @@ -7,8 +7,8 @@ * * @file PIControllers.h * -* @author (last) Sean -* @date (last) 22-Apr-2020 +* @author (last) Quang Nguyen +* @date (last) 24-Aug-2020 * * @author (original) Sean * @date (original) 04-Feb-2020 @@ -22,15 +22,15 @@ /** * @defgroup PIControllers PIControllers - * @brief PIControllers service module. Provides PI controllers for various actuators.. + * @brief PIControllers service module. Provides PI controllers for various actuators. * * @addtogroup PIControllers * @{ */ // ********** public definitions ********** -/// Enumeration of PI controllers +/// Enumeration of PI controllers. typedef enum ControllerList { PI_CONTROLLER_ID_RO_PUMP = 0, ///< RO Pump controller. @@ -41,18 +41,18 @@ NUM_OF_PI_CONTROLLERS_IDS ///< Number of PI controllers. } PI_CONTROLLER_ID_T; -/// Enumeration of PI controller signals +/// Enumeration of PI controller signals. typedef enum ControllerSignals { - CONTROLLER_SIGNAL_REFERENCE = 0, ///< Reference value. - CONTROLLER_SIGNAL_MEASURED, ///< Measured value. - CONTROLLER_SIGNAL_ERROR, ///< Error value. - CONTROLLER_SIGNAL_ERROR_SUM, ///< Error sum before anti-windup. - CONTROLLER_SIGNAL_ERROR_SUM_AFTER_WINDUP, ///< Error sum after anti-windup. - CONTROLLER_SIGNAL_PROPORTIONAL_OUTPUT, ///< P portion of controller output signal. - CONTROLLER_SIGNAL_INTEGRAL_OUTPUT, ///< I portion of controller output signal. - CONTROLLER_SIGNAL_CONTROL, ///< Controller output signal. - NUM_OF_CONTROLLER_SIGNAL ///< Number of PI controller signals. + CONTROLLER_SIGNAL_REFERENCE = 0, ///< Reference value + CONTROLLER_SIGNAL_MEASURED, ///< Measured value + CONTROLLER_SIGNAL_ERROR, ///< Error value + CONTROLLER_SIGNAL_ERROR_SUM, ///< Error sum before anti-windup + CONTROLLER_SIGNAL_ERROR_SUM_AFTER_WINDUP, ///< Error sum after anti-windup + CONTROLLER_SIGNAL_PROPORTIONAL_OUTPUT, ///< P portion of controller output signal + CONTROLLER_SIGNAL_INTEGRAL_OUTPUT, ///< I portion of controller output signal + CONTROLLER_SIGNAL_CONTROL, ///< Controller output signal + NUM_OF_CONTROLLER_SIGNAL ///< Number of PI controller signals } PI_CONTROLLER_SIGNALS_ID; // ********** public function prototypes ********** @@ -66,4 +66,3 @@ /**@}*/ #endif -