Academic

Implements a PID controller in the Academic form.

1378

Inputs/Outputs

datatype_icon

feedforward input

Value of the feedforward control.

This input accepts an array of double-precision, floating-point numbers if setpoint is an array.

datatype_icon

manual control

Settings for the manual control mode.

This input accepts an array of clusters if setpoint is an array.

datatype_icon

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

datatype_icon

manual input

Value of the control output when you use the manual control mode.

Default value: 0

datatype_icon

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

datatype_icon

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.

datatype_icon

process variable

Measured value of the process variable.

This input accepts an array of double-precision, floating-point numbers if setpoint is an array.

datatype_icon

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.

datatype_icon

proportional

Proportional gain of the controller.

datatype_icon

integral

Integral time constant of the controller, in seconds.

datatype_icon

derivative

Derivative time constant of the controller, in seconds.

datatype_icon

filter coefficient [a]

Derivative lowpass filter coefficient of the controller.

datatype_icon

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.

datatype_icon

output high

Maximum control output value.

Default value: Infinity

datatype_icon

output low

Minimum control output value.

Default value: -Infinity

datatype_icon

dt

Loop-cycle time, or interval in seconds, at which this node is called.

dt must be greater than 0.
datatype_icon

setpoint weighting

Corrections to apply to the error values of the controller.

setpoint weighting tunes the proportional action and the derivative action.

This input accepts an array of clusters if setpoint is an array.

datatype_icon

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

datatype_icon

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

datatype_icon

output

Control output of the PID algorithm that is applied to the controlled process.

datatype_icon

error

Difference between the setpoint and the process variable.

datatype_icon

actions

Values of the proportional action, the integral action, and the derivative action in the PID algorithm.

datatype_icon

proportional

Value of the proportional action.

datatype_icon

integral

Value of the integral action.

datatype_icon

derivative

Value of the derivative action.

Algorithm Definition

The following transfer function represents a PID controller in the Academic form:

Ci(s)=Kc(1+1Tis+TdsαiTds+1) Ci(s)=Kc(1+1Tis+TdsαiTds+1)

where

  • K c is the proportional gain
  • T i is the integral time constant
  • T d is the derivative time constant
  • αi
    is the derivative filter coefficient