Index: firmware/App/Services/PIControllers.c =================================================================== diff -u -re28798081348b470495ec605fcadda4276f37c46 -r8e7158d8231435496fcf1d5649e51babf859ccc7 --- firmware/App/Services/PIControllers.c (.../PIControllers.c) (revision e28798081348b470495ec605fcadda4276f37c46) +++ firmware/App/Services/PIControllers.c (.../PIControllers.c) (revision 8e7158d8231435496fcf1d5649e51babf859ccc7) @@ -1,14 +1,14 @@ /************************************************************************** * -* Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. +* Copyright (c) 2019-2021 Diality Inc. - All Rights Reserved. * * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * * @file PIControllers.c * -* @author (last) Sean -* @date (last) 07-May-2020 +* @author (last) Sean Nash +* @date (last) 13-Aug-2020 * * @author (original) Sean * @date (original) 27-Dec-2019 @@ -65,12 +65,12 @@ * Initialize controller before operation. Make sure to call it before * first call to runController function. * - * @param controllerID - ID filter number - * @param initialControlSignal - Value of the output on the first iteration - * @param kP - Coefficient for proportional. - * @param kI - Coefficient for integral. - * @param controlMin - Minimum control output. - * @param controlMax - Maximum control output. + * @param controllerID ID filter number + * @param initialControlSignal Value of the output on the first iteration + * @param kP Coefficient for proportional + * @param kI Coefficient for integral + * @param controlMin Minimum control output + * @param controlMax Maximum control output * * @return none *************************************************************************/ @@ -107,8 +107,8 @@ * Reset controller before new set point. Make sure to call it before first * call to runController function. * - * @param controllerID - ID filter number - * @param initialControlSignal - Value of the output on the first iteration + * @param controllerID ID filter number + * @param initialControlSignal Value of the output on the first iteration * * @return none *************************************************************************/ @@ -136,9 +136,9 @@ * @brief * Call this function whenever a new measured signal sampled is acquired. * - * @param controllerID - ID filter number - * @param referenceSignal - reference signal value - * @param measuredSignal - latest measured sample + * @param controllerID ID filter number + * @param referenceSignal reference signal value + * @param measuredSignal latest measured sample * * @return value of the control signal *************************************************************************/ @@ -184,8 +184,8 @@ * @brief * Returns the latest requested signal sample. * - * @param controllerID - ID filter number - * @param signalID - signal sample ID request + * @param controllerID ID filter number + * @param signalID signal sample ID request * * @return latest sample requested *************************************************************************/