Index: firmware/App/Services/PIControllers.c =================================================================== diff -u -ra4236a98b2de7d007173862dfe6b114bce08f90f -r60a95cb6e1325abd179b4a01d83b8aabe20ccda5 --- firmware/App/Services/PIControllers.c (.../PIControllers.c) (revision a4236a98b2de7d007173862dfe6b114bce08f90f) +++ firmware/App/Services/PIControllers.c (.../PIControllers.c) (revision 60a95cb6e1325abd179b4a01d83b8aabe20ccda5) @@ -28,26 +28,26 @@ // ********** private definitions ********** -/// minimum integral coefficient - cannot be zero +/// minimum integral coefficient - cannot be zero. #define MIN_KI NEARLY_ZERO -/// record for PI controller +/// record for PI controller. typedef struct { // -- PI's parameters -- - F32 Kp; ///< Proportional Value - F32 Ki; ///< Integral Value - F32 uMax; ///< Maximum control signal - F32 uMin; ///< Minimum control signal + F32 Kp; ///< Proportional Value. + F32 Ki; ///< Integral Value. + F32 uMax; ///< Maximum control signal. + F32 uMin; ///< Minimum control signal. // -- PI's signals -- - F32 referenceSignal; ///< reference signal - F32 measuredSignal; ///< measured signal - F32 errorSignal; ///< reference - measured signal - F32 errorSumBeforeWindUp; ///< error signal before windup correction - F32 errorSum; ///< error integral after windup correction - F32 controlSignal; ///< actual control signal + F32 referenceSignal; ///< reference signal. + F32 measuredSignal; ///< measured signal. + F32 errorSignal; ///< reference - measured signal. + F32 errorSumBeforeWindUp; ///< error signal before windup correction. + F32 errorSum; ///< error integral after windup correction. + F32 controlSignal; ///< actual control signal. } PI_CONTROLLER_T; -#define SET_CONTROLLER( c, id ) ((c) = &piControllers[id]) ///< macro to set a local controller pointer to a given piController +#define SET_CONTROLLER( c, id ) ((c) = &piControllers[id]) ///< macro to set a local controller pointer to a given piController. // ********** private data ********** @@ -62,7 +62,7 @@ /**@}*/ /*********************************************************************//** - * @brief initializePIController + * @brief * Initialize controller before operation. Make sure to call it before * first call to runController function. * @@ -100,7 +100,7 @@ } /*********************************************************************//** - * @brief resetPIController + * @brief * Reset controller before new set point. Make sure to call it before first * call to runController function. * @@ -130,7 +130,7 @@ } /*********************************************************************//** - * @brief runPIController + * @brief * Call this function whenever a new measured signal sampled is acquired. * * @param controllerID - ID filter number @@ -195,7 +195,7 @@ } /*********************************************************************//** - * @brief getPIControllerSignals + * @brief * Returns the latest requested signal sample. * * @param controllerID - ID filter number @@ -259,3 +259,5 @@ return output; } +/**@}*/ +