LIBML  Version 3.2.4
LIBML DSP Software Library
Functions
PID Motor Control
Controller Functions
Collaboration diagram for PID Motor Control:

Functions

static f32_t tpt_pid_f32 (tpt_pid_f32_t *aController, f32_t aX)
 Process function for the floating-point PID Control. More...
 
static q31_t tpt_pid_q31 (tpt_pid_q31_t *aController, q31_t aX)
 Process function for the Q31 PID Control. More...
 
static q15_t tpt_pid_q15 (tpt_pid_q15_t *aController, q15_t aX)
 Process function for the Q15 PID Control. More...
 
void tpt_pid_init_f32 (tpt_pid_f32_t *aController, bool aResetFlag)
 Initialization function for the floating-point PID Control. More...
 
void tpt_pid_init_q15 (tpt_pid_q15_t *aController, bool aResetFlag)
 Initialization function for the Q15 PID Control. More...
 
void tpt_pid_init_q31 (tpt_pid_q31_t *aController, bool aResetFlag)
 Initialization function for the Q31 PID Control. More...
 
void tpt_pid_reset_f32 (tpt_pid_f32_t *aController)
 Reset function for the floating-point PID Control. More...
 
void tpt_pid_reset_q15 (tpt_pid_q15_t *aController)
 Reset function for the Q15 PID Control. More...
 
void tpt_pid_reset_q31 (tpt_pid_q31_t *aController)
 Reset function for the Q31 PID Control. More...
 

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. aFilter 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
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.
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

◆ tpt_pid_f32()

static f32_t tpt_pid_f32 ( tpt_pid_f32_t *  aController,
f32_t  aX 
)
inlinestatic

Process function for the floating-point PID Control.

Parameters
[in,out]aControlleran instance of the PID Control structure
[in]aXinput sample to process
Returns
processed output sample

◆ tpt_pid_init_f32()

void tpt_pid_init_f32 ( tpt_pid_f32_t *  aController,
bool  aResetFlag 
)

Initialization function for the floating-point PID Control.

Parameters
[in,out]aControllerpoints to an instance of the PID structure.
[in]aResetFlag
  • false: no change instate
  • true: reset state
Returns
none
Parameters
[in,out]aControllerpoints to an instance of the PID structure.
[in]aResetFlag
  • false: no change instate
  • true: reset state
Returns
none
Details
The aResetFlag 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.

◆ tpt_pid_init_q15()

void tpt_pid_init_q15 ( tpt_pid_q15_t *  aController,
bool  aResetFlag 
)

Initialization function for the Q15 PID Control.

Parameters
[in,out]aControllerpoints to an instance of the PID structure.
[in]aResetFlag
  • false: no change instate
  • true: reset state
Returns
none
Parameters
[in,out]aControllerpoints to an instance of the PID structure.
[in]aResetFlag
  • false: no change instate
  • true: reset state
Returns
none
Details
The aResetFlag 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.

◆ tpt_pid_init_q31()

void tpt_pid_init_q31 ( tpt_pid_q31_t *  aController,
bool  aResetFlag 
)

Initialization function for the Q31 PID Control.

Parameters
[in,out]aControllerpoints to an instance of the PID structure.
[in]aResetFlag
  • false: no change instate
  • true: reset state
Returns
none
Parameters
[in,out]aControllerpoints to an instance of the PID structure.
[in]aResetFlag
  • false: no change instate
  • true: reset state
Returns
none
Details
The aResetFlag 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.

◆ tpt_pid_q15()

static q15_t tpt_pid_q15 ( tpt_pid_q15_t *  aController,
q15_t  aX 
)
inlinestatic

Process function for the Q15 PID Control.

Parameters
[in,out]aControlleran instance of the PID Control structure
[in]aXinput sample to process
Returns
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.

◆ tpt_pid_q31()

static q31_t tpt_pid_q31 ( tpt_pid_q31_t *  aController,
q31_t  aX 
)
inlinestatic

Process function for the Q31 PID Control.

Parameters
[in,out]aControlleran instance of the PID Control structure
[in]aXinput sample to process
Returns
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.

◆ tpt_pid_reset_f32()

void tpt_pid_reset_f32 ( tpt_pid_f32_t *  aController)

Reset function for the floating-point PID Control.

Parameters
[in,out]aControllerpoints to an instance of the PID structure.
Returns
none
Parameters
[in,out]aControllerpoints to an instance of the PID structure.
Returns
none
Details
The function resets the state buffer to zeros.

◆ tpt_pid_reset_q15()

void tpt_pid_reset_q15 ( tpt_pid_q15_t *  aController)

Reset function for the Q15 PID Control.

Parameters
[in,out]aControllerpoints to an instance of the PID structure.
Returns
none
Parameters
[in,out]aControllerpoints to an instance of the PID structure.
Returns
none
Details
The function resets the state buffer to zeros.

◆ tpt_pid_reset_q31()

void tpt_pid_reset_q31 ( tpt_pid_q31_t *  aController)

Reset function for the Q31 PID Control.

Parameters
[in,out]aControllerpoints to an instance of the PID structure.
Returns
none
Parameters
[in,out]aControllerpoints to an instance of the PID structure.
Returns
none
Details
The function resets the state buffer to zeros.
Generated by doxygen 1.9.1