Academic
- Updated2023-02-17
- 5 minute(s) read
Academic
Implements a PID controller in the Academic form.
Inputs/Outputs
feedforward input
Value of the feedforward control.
This input accepts an array of double-precision, floating-point numbers if setpoint is an array.
manual control
Settings for the manual control mode.
This input accepts an array of clusters if setpoint is an array.
manual
A Boolean that specifies whether to use the manual control mode.
True | Uses the manual control mode. |
False | Uses the automatic control mode. |
Default value: False
manual input
Value of the control output when you use the manual control mode.
Default value: 0
reset
A Boolean that specifies whether to reset the internal parameters, such as the integrated error, of the controller.
True | Resets the internal parameters. |
False | Does not reset the internal parameters. |
Set reset to True if your application must stop and restart the control loop without restarting the entire application.
This input accepts an array of Booleans if setpoint is an array.
Default value: False
setpoint
Setpoint value, or desired value, of the process variable.
This input accepts a double-precision, floating-point number or an array of double-precision, floating-point numbers.
process variable
Measured value of the process variable.
This input accepts an array of double-precision, floating-point numbers if setpoint is an array.
PID gains
Proportional gain, integral gain, derivative gain, and filter coefficient parameters of the controller.
This input accepts a cluster or an array of clusters.
proportional
Proportional gain of the controller.
integral
Integral time constant of the controller, in seconds.
derivative
Derivative time constant of the controller, in seconds.
filter coefficient [a]
Derivative lowpass filter coefficient of the controller.
output range
Range for the control output value.
If the control output value is outside output range, this node coerces the value to fall within the range and returns the coerced value as the control output value. This node implements integrator anti-windup when the control output is saturated at the specified minimum or maximum value.
This input accepts an array of clusters if setpoint is an array.
output high
Maximum control output value.
Default value: Infinity
output low
Minimum control output value.
Default value: -Infinity
dt
Loop-cycle time, or interval in seconds, at which this node is called.
setpoint weighting
Corrections to apply to the error values of the controller.
This input accepts an array of clusters if setpoint is an array.
proportional weighting [beta]
Relative emphasis of setpoint tracking to disturbance rejection.
The valid value range is [0, 1]. Use the default value for most applications.
Default value: 1
derivative weighting [gamma]
An amount by which to weight the error applied to the derivative action.
The valid value range is [0, 1]. Use the default value to avoid the derivative kick.
Default value: 0
output
Control output of the PID algorithm that is applied to the controlled process.
error
Difference between the setpoint and the process variable.
actions
Values of the proportional action, the integral action, and the derivative action in the PID algorithm.
proportional
Value of the proportional action.
integral
Value of the integral action.
derivative
Value of the derivative action.
Algorithm Definition
The following transfer function represents a PID controller in the Academic form:
where
- K c is the proportional gain
- T i is the integral time constant
- T d is the derivative time constant
-