Eli Hughes / CMSIS_DSP_401

V4.0.1 of the ARM CMSIS DSP libraries. Note that arm_bitreversal2.s, arm_cfft_f32.c and arm_rfft_fast_f32.c had to be removed. arm_bitreversal2.s will not assemble with the online tools. So, the fast f32 FFT functions are not yet available. All the other FFT functions are available.

Dependents:   MPU9150_Example fir_f32 fir_f32 MPU9150_nucleo_noni2cdev ... more

Embed: (wiki syntax)

« Back to documentation index

PID Motor Control
Functions

PID Motor Control
[Controller Functions]

A Proportional Integral Derivative (PID) controller is a generic feedback control loop mechanism widely used in industrial control systems. More...

Functions

static __INLINE float32_t arm_pid_f32 (arm_pid_instance_f32 *S, float32_t in)
 Process function for the floating-point PID Control.
static __INLINE q31_t arm_pid_q31 (arm_pid_instance_q31 *S, q31_t in)
 Process function for the Q31 PID Control.
static __INLINE q15_t arm_pid_q15 (arm_pid_instance_q15 *S, q15_t in)
 Process function for the Q15 PID Control.
void arm_pid_init_f32 (arm_pid_instance_f32 *S, int32_t resetStateFlag)
 Initialization function for the floating-point PID Control.
void arm_pid_init_q15 (arm_pid_instance_q15 *S, int32_t resetStateFlag)
 Initialization function for the Q15 PID Control.
void arm_pid_init_q31 (arm_pid_instance_q31 *S, int32_t resetStateFlag)
 Initialization function for the Q31 PID Control.
void arm_pid_reset_f32 (arm_pid_instance_f32 *S)
 Reset function for the floating-point PID Control.
void arm_pid_reset_q15 (arm_pid_instance_q15 *S)
 Reset function for the Q15 PID Control.
void arm_pid_reset_q31 (arm_pid_instance_q31 *S)
 Reset function for the Q31 PID Control.

Detailed Description

A Proportional Integral Derivative (PID) controller is a generic feedback control loop mechanism widely used in industrial control systems.

A PID controller is the most commonly used type of feedback controller.

This set of functions implements (PID) controllers for Q15, Q31, and floating-point data types. The functions operate on a single sample of data and each call to the function returns a single processed value. S points to an instance of the PID control data structure. in is the input sample value. The functions return the output value.

Algorithm:
    y[n] = y[n-1] + A0 * x[n] + A1 * x[n-1] + A2 * x[n-2]
    A0 = Kp + Ki + Kd
    A1 = (-Kp ) - (2 * Kd )
    A2 = Kd
where Kp is proportional constant, Ki is Integral constant and Kd is Derivative constant
PID.gif

Proportional Integral Derivative Controller

The PID controller calculates an "error" value as the difference between the measured output and the reference input. The controller attempts to minimize the error by adjusting the process control inputs. The proportional value determines the reaction to the current error, the integral value determines the reaction based on the sum of recent errors, and the derivative value determines the reaction based on the rate at which the error has been changing.
Instance Structure
The Gains A0, A1, A2 and state variables for a PID controller are stored together in an instance data structure. A separate instance structure must be defined for each PID Controller. There are separate instance structure declarations for each of the 3 supported data types.
Reset Functions
There is also an associated reset function for each data type which clears the state array.
Initialization Functions
There is also an associated initialization function for each data type. The initialization function performs the following operations:
  • Initializes the Gains A0, A1, A2 from Kp,Ki, Kd gains.
  • Zeros out the values in the state buffer.
Instance structure cannot be placed into a const data section and it is recommended to use the initialization function.
Fixed-Point Behavior
Care must be taken when using the fixed-point versions of the PID Controller functions. In particular, the overflow and saturation behavior of the accumulator used in each function must be considered. Refer to the function specific documentation below for usage guidelines.

Function Documentation

static __INLINE float32_t arm_pid_f32 ( arm_pid_instance_f32 *  S,
float32_t  in 
) [static]

Process function for the floating-point PID Control.

Parameters:
[in,out]*Sis an instance of the floating-point PID Control structure
[in]ininput sample to process
Returns:
out processed output sample.

Definition at line 4946 of file arm_math.h.

void arm_pid_init_f32 ( arm_pid_instance_f32 *  S,
int32_t  resetStateFlag 
)

Initialization function for the floating-point PID Control.

Parameters:
[in,out]*Spoints to an instance of the PID structure.
[in]resetStateFlagflag to reset the state. 0 = no change in state & 1 = reset the state.
Returns:
none.
Description:
The resetStateFlag specifies whether to set state to zero or not.
The function computes the structure fields: A0, A1 A2 using the proportional gain( Kp), integral gain( Ki) and derivative gain( Kd) also sets the state variables to all zeros.

Definition at line 62 of file arm_pid_init_f32.c.

void arm_pid_init_q15 ( arm_pid_instance_q15 *  S,
int32_t  resetStateFlag 
)

Initialization function for the Q15 PID Control.

Parameters:
[in,out]*Spoints to an instance of the Q15 PID structure.
[in]resetStateFlagflag to reset the state. 0 = no change in state 1 = reset the state.
Returns:
none.
Description:
The resetStateFlag specifies whether to set state to zero or not.
The function computes the structure fields: A0, A1 A2 using the proportional gain( Kp), integral gain( Ki) and derivative gain( Kd) also sets the state variables to all zeros.

Definition at line 61 of file arm_pid_init_q15.c.

void arm_pid_init_q31 ( arm_pid_instance_q31 *  S,
int32_t  resetStateFlag 
)

Initialization function for the Q31 PID Control.

Parameters:
[in,out]*Spoints to an instance of the Q31 PID structure.
[in]resetStateFlagflag to reset the state. 0 = no change in state 1 = reset the state.
Returns:
none.
Description:
The resetStateFlag specifies whether to set state to zero or not.
The function computes the structure fields: A0, A1 A2 using the proportional gain( Kp), integral gain( Ki) and derivative gain( Kd) also sets the state variables to all zeros.

Definition at line 61 of file arm_pid_init_q31.c.

static __INLINE q15_t arm_pid_q15 ( arm_pid_instance_q15 *  S,
q15_t  in 
) [static]

Process function for the Q15 PID Control.

Parameters:
[in,out]*Spoints to an instance of the Q15 PID Control structure
[in]ininput sample to process
Returns:
out processed output sample.

Scaling and Overflow Behavior:

The function is implemented using a 64-bit internal accumulator. Both Gains and state variables are represented in 1.15 format and multiplications yield a 2.30 result. The 2.30 intermediate results are accumulated in a 64-bit accumulator in 34.30 format. There is no risk of internal overflow with this approach and the full precision of intermediate multiplications is preserved. After all additions have been performed, the accumulator is truncated to 34.15 format by discarding low 15 bits. Lastly, the accumulator is saturated to yield a result in 1.15 format.

Definition at line 5029 of file arm_math.h.

static __INLINE q31_t arm_pid_q31 ( arm_pid_instance_q31 *  S,
q31_t  in 
) [static]

Process function for the Q31 PID Control.

Parameters:
[in,out]*Spoints to an instance of the Q31 PID Control structure
[in]ininput sample to process
Returns:
out processed output sample.

Scaling and Overflow Behavior:

The function is implemented using an internal 64-bit accumulator. The accumulator has a 2.62 format and maintains full precision of the intermediate multiplication results but provides only a single guard bit. Thus, if the accumulator result overflows it wraps around rather than clip. In order to avoid overflows completely the input signal must be scaled down by 2 bits as there are four additions. After all multiply-accumulates are performed, the 2.62 accumulator is truncated to 1.32 format and then saturated to 1.31 format.

Definition at line 4981 of file arm_math.h.

void arm_pid_reset_f32 ( arm_pid_instance_f32 *  S )

Reset function for the floating-point PID Control.

Parameters:
[in]*SInstance pointer of PID control data structure.
Returns:
none.
Description:
The function resets the state buffer to zeros.

Definition at line 55 of file arm_pid_reset_f32.c.

void arm_pid_reset_q15 ( arm_pid_instance_q15 *  S )

Reset function for the Q15 PID Control.

Parameters:
[in]*SInstance pointer of PID control data structure.
Returns:
none.
Description:
The function resets the state buffer to zeros.

Definition at line 55 of file arm_pid_reset_q15.c.

void arm_pid_reset_q31 ( arm_pid_instance_q31 *  S )

Reset function for the Q31 PID Control.

Parameters:
[in]*SInstance pointer of PID control data structure.
Returns:
none.
Description:
The function resets the state buffer to zeros.

Definition at line 55 of file arm_pid_reset_q31.c.

Generated on Tue Jul 12 2022 19:48:46 by  doxygen 1.7.2