QuickPID is an updated implementation of the Arduino PID library with additional features for PID control. By default, this implementation closely follows the method of processing the p,i,d terms as in the PID_v1 library except for using a more advanced anti-windup mode. Integral anti-windup can be based on conditionally using PI terms to provide some integral correction, prevent deep saturation and reduce overshoot. Anti-windup can also be based on clamping only, or it can be turned completely off. Also, the proportional term can be based on error, measurement, or both. The derivative term can be based on error or measurement. PID controller modes include timer, which allows external timer or ISR timing control.
Note: You can use this library in esp-idf tool to program esp32 by cloning
this repo into your components folder, then clean the build and rebuild.
Development began with a fork of the Arduino PID Library. Modifications and new features have been added as described in the releases.
- New functions added:
SetProportionalMode,SetDerivativeModeandSetAntiWindupMode -
timermode for calling PID compute by an external timer function or ISR - Proportional on error
pOnError, measurementpOnMeasor bothpOnErrorMeasoptions - Derivative on error
dOnErrorand measurementdOnMeasoptions - New PID Query Functions
GetPterm,GetIterm,GetDterm,GetPmode,GetDmodeandGetAwMode - New integral anti-windup options
iAwCondition,iAwClampandiAwOff
QuickPID::QuickPID(float* Input, float* Output, float* Setpoint, float Kp, float Ki, float Kd,
pMode pMode = pMode::pOnError, dMode dMode = dMode::dOnMeas,
iAwMode iAwMode = iAwMode::iAwCondition, Action action = Action::direct)Input,Output, andSetpointare pointers to the variables holding these values.Kp,Ki, andKdare the PID proportional, integral, and derivative gains.pModeis the proportional mode parameter with options forpOnErrorproportional on error (default),pOnMeasproportional on measurement andpOnErrorMeaswhich is 0.5pOnError+ 0.5pOnMeas.dModeis the derivative mode parameter with options fordOnErrorderivative on error,dOnMeasderivative on measurement (default).awModeis the integral anti-windup parameter with an option foriAwCondition(default) that is based on PI terms to provide some integral correction, prevent deep saturation and reduce overshoot. TheiAwClampoption clamps the summation of the pmTerm and iTerm. TheiAwOffoption turns off all anti-windup.Actionis the controller action parameter which hasdirect(default) andreverseoptions. These options set how the controller responds to a change in input.directaction is used if the input moves in the same direction as the controller output (i.e. heating process).reverseaction is used if the input moves in the opposite direction as the controller output (i.e. cooling process).
QuickPID::QuickPID(float* Input, float* Output, float* Setpoint,
float Kp, float Ki, float Kd, Action action)This allows you to use Proportional on Error without explicitly saying so.
QuickPID::QuickPID(float *Input, float *Output, float *Setpoint)This simplified version allows you to define the remaining parameters later via specific setter functions. By default, Kp, Ki, and Kd will be initialized to zero and should be later set via SetTunings to relevant values.
bool QuickPID::Compute();This function contains the PID algorithm and it should be called once every loop(). Most of the time it will just return false without doing anything. However, at a frequency specified by SetSampleTime it will calculate a new Output and return true.
void QuickPID::Initialize();Does all the things that need to happen to ensure a bump-less transfer from manual to automatic mode.
void QuickPID::Reset();Clears pTerm, iTerm, dTerm and outputSum values.
These functions query the internal state of the PID.
float GetKp(); // proportional gain
float GetKi(); // integral gain
float GetKd(); // derivative gain
float GetPterm(); // proportional component of output
float GetIterm(); // integral component of output
float GetDterm(); // derivative component of output
uint8_t GetMode(); // manual (0), automatic (1) or timer (2)
uint8_t GetDirection(); // direct (0), reverse (1)
uint8_t GetPmode(); // pOnError (0), pOnMeas (1), pOnErrorMeas (2)
uint8_t GetDmode(); // dOnError (0), dOnMeas (1)
uint8_t GetAwMode(); // iAwCondition (0, iAwClamp (1), iAwOff (2)These functions set the internal state of the PID.
void SetMode(Control mode); // Set PID mode to manual, automatic or timer
void SetOutputLimits(float Min, float Max); // Set and clamps the output to (0-255 by default)
void SetTunings(float Kp, float Ki, float Kd, // set pid tunings and all computational modes
pMode pMode, dMode dMode, iAwMode iAwMode);
void SetTunings(float Kp, float Ki, float Kd); // only set pid tunings, other pid modes are unchanged
void SetControllerDirection(Action Action); // Set controller action to direct (default) or reverse
void SetSampleTimeUs(uint32_t NewSampleTimeUs); // Set PID compute sample time, default = 100000 µs
void SetProportionalMode(pMode pMode); // Set pTerm based on error (default), measurement, or both
void SetDerivativeMode(dMode dMode); // Set the dTerm, based error or measurement (default).
void SetAntiWindupMode(iAwMode iAwMode); // Set iTerm anti-windup to iAwCondition, iAwClamp or iAwOffGet sTune 
A very fast autotuner capable of on-the-fly tunings and more.