CMSIS DSP Lib
Fork of mbed-dsp by
Diff: cmsis_dsp/ControllerFunctions/arm_pid_init_f32.c
- Revision:
- 1:fdd22bb7aa52
- Child:
- 2:da51fb522205
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/cmsis_dsp/ControllerFunctions/arm_pid_init_f32.c Wed Nov 28 12:30:09 2012 +0000 @@ -0,0 +1,79 @@ +/* ---------------------------------------------------------------------- +* Copyright (C) 2010 ARM Limited. All rights reserved. +* +* $Date: 15. February 2012 +* $Revision: V1.1.0 +* +* Project: CMSIS DSP Library +* Title: arm_pid_init_f32.c +* +* Description: Floating-point PID Control initialization function +* +* +* Target Processor: Cortex-M4/Cortex-M3/Cortex-M0 +* +* Version 1.1.0 2012/02/15 +* Updated with more optimizations, bug fixes and minor API changes. +* +* Version 1.0.10 2011/7/15 +* Big Endian support added and Merged M0 and M3/M4 Source code. +* +* Version 1.0.3 2010/11/29 +* Re-organized the CMSIS folders and updated documentation. +* +* Version 1.0.2 2010/11/11 +* Documentation updated. +* +* Version 1.0.1 2010/10/05 +* Production release and review comments incorporated. +* +* Version 1.0.0 2010/09/20 +* Production release and review comments incorporated. +* ------------------------------------------------------------------- */ + +#include "arm_math.h" + + /** + * @addtogroup PID + * @{ + */ + +/** + * @brief Initialization function for the floating-point PID Control. + * @param[in,out] *S points to an instance of the PID structure. + * @param[in] resetStateFlag flag to reset the state. 0 = no change in state & 1 = reset the state. + * @return none. + * \par Description: + * \par + * The <code>resetStateFlag</code> specifies whether to set state to zero or not. \n + * The function computes the structure fields: <code>A0</code>, <code>A1</code> <code>A2</code> + * using the proportional gain( \c Kp), integral gain( \c Ki) and derivative gain( \c Kd) + * also sets the state variables to all zeros. + */ + +void arm_pid_init_f32( + arm_pid_instance_f32 * S, + int32_t resetStateFlag) +{ + + /* Derived coefficient A0 */ + S->A0 = S->Kp + S->Ki + S->Kd; + + /* Derived coefficient A1 */ + S->A1 = (-S->Kp) - ((float32_t) 2.0 * S->Kd); + + /* Derived coefficient A2 */ + S->A2 = S->Kd; + + /* Check whether state needs reset or not */ + if(resetStateFlag) + { + /* Clear the state buffer. The size will be always 3 samples */ + memset(S->state, 0, 3u * sizeof(float32_t)); + } + +} + +/** + * @} end of PID group + */