Skip to content
LIBRARY
Continuous.LimPID.md

Continuous.LimPID

PID controller with limited output, back calculation anti-windup compensation, setpoint weighting and feed-forward

The transfer function is:

y=k[e+1Tis(e+ysatyNiTi)+Tds1+TdNdse]+kffuff

This component extends from BlockComponents.Interfaces.SingleVariableController

Usage

BlockComponents.Continuous.LimPID(k=1, Ti=0.5, Td=0.1, y_max=1e300, y_min=-y_max, wp=1, wd=1, Ni=0.9, Nd=10, k_ff=1, xi0=0, xd0=0)

Parameters:

NameDescriptionUnitsDefault value
kGain of controller1
TiTime constant of the integrator blocks0.5
TdTime constant of the derivative blocks0.1
y_maxMaximum output1e+300
y_minMinimum output-y_max
wpSet-point weight for proportional block1
wdSet-point weight for derivative block1
NiNi*Ti is time constant of anti-windup compensation0.9
NdMaximum derivative gain. Higher the value of Nd, the more ideal the derivative block gets (less filtering, higher high-frequency gain).10
k_ffGain of the feed-forward input1
xi0Initial guess value for integrator output0
xd0Initial guess value for derivative output0

Connectors

  • u_s - This connector represents a real signal as an input to a component (RealInput)

  • u_m - This connector represents a real signal as an input to a component (RealInput)

  • y - This connector represents a real signal as an output from a component (RealOutput)

  • u_ff - This connector represents a real signal as an input to a component (RealInput)

Variables

NameDescriptionUnits
control_error

Behavior

julia
using BlockComponents #hide
using ModelingToolkit #hide
@variables k #hide
@variables Ti #hide
@variables Td #hide
@variables y_max #hide
@variables y_min #hide
@variables wp #hide
@variables wd #hide
@variables Ni #hide
@variables Nd #hide
@variables k_ff #hide
@variables xi0 #hide
@variables xd0 #hide
@named sys = BlockComponents.Continuous.LimPID(k=k, Ti=Ti, Td=Td, y_max=y_max, y_min=y_min, wp=wp, wd=wd, Ni=Ni, Nd=Nd, k_ff=k_ff, xi0=xi0, xd0=xd0) #hide
full_equations(sys) #hide
<< @example-block not executed in draft mode >>

Source

dyad
"""
PID controller with limited output, back calculation anti-windup compensation, setpoint weighting and feed-forward

The transfer function is:

math y = k \left[e + \dfrac{1}{T_is}\left(e + \dfrac{y_{sat} - y}{N_iT_i}\right) + \dfrac{T_ds}{1 + {\dfrac{T_d}{N_d}s}}e \right] + k_{ff}u_

"""
component LimPID
  extends BlockComponents.Interfaces.SingleVariableController
  u_ff = RealInput() {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "input", "x1": 450, "y1": -100, "x2": 550, "y2": 0, "rot": 90}
      },
      "tags": []
    }
  }
  add_p = BlockComponents.Math.Add(k1 = wp, k2 = -1) {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 100, "y1": 100, "x2": 200, "y2": 200, "rot": 0},
        "diagram": {"iconName": "input", "x1": 100, "y1": 90, "x2": 200, "y2": 190, "rot": 0}
      },
      "tags": []
    }
  }
  add_d = BlockComponents.Math.Add(k1 = wd, k2 = -1) {
    "Dyad": {
      "placement": {"icon": {"iconName": "input", "x1": 100, "y1": 300, "x2": 200, "y2": 400}}
    }
  }
  add_i = BlockComponents.Math.Add3(k2 = -1) {
    "Dyad": {
      "placement": {"icon": {"iconName": "input", "x1": 100, "y1": 500, "x2": 200, "y2": 600}}
    }
  }
  proportional = BlockComponents.Math.Gain(k = 1) {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 300, "y1": 100, "x2": 400, "y2": 200, "rot": 0},
        "diagram": {"iconName": "input", "x1": 300, "y1": 90, "x2": 400, "y2": 190, "rot": 0}
      },
      "tags": []
    }
  }
  derivative = Derivative(k = Td, T = max(Td / Nd, 1e-14), x0 = xd0) {
    "Dyad": {
      "placement": {"icon": {"iconName": "input", "x1": 300, "y1": 300, "x2": 400, "y2": 400}}
    }
  }
  integrator = Integrator(k = 1 / Ti, x0 = xi0) {
    "Dyad": {
      "placement": {"icon": {"iconName": "input", "x1": 300, "y1": 500, "x2": 400, "y2": 600}}
    }
  }
  add_pid = BlockComponents.Math.Add3() {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 500, "y1": 300, "x2": 600, "y2": 400, "rot": 0},
        "diagram": {"iconName": "input", "x1": 500, "y1": 120, "x2": 600, "y2": 220, "rot": 0}
      },
      "tags": []
    }
  }
  gain_pid = BlockComponents.Math.Gain(k = k) {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 700, "y1": 300, "x2": 800, "y2": 400, "rot": 0},
        "diagram": {"iconName": "input", "x1": 550, "y1": 310, "x2": 650, "y2": 410, "rot": 0}
      },
      "tags": []
    }
  }
  add_ff = BlockComponents.Math.Add(k2 = k_ff) {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 900, "y1": 300, "x2": 1000, "y2": 400, "rot": 0},
        "diagram": {"iconName": "input", "x1": 710, "y1": 340, "x2": 810, "y2": 440, "rot": 0}
      },
      "tags": []
    }
  }
  limiter = BlockComponents.Nonlinear.Limiter(y_max = y_max, y_min = y_min) {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 1100, "y1": 300, "x2": 1200, "y2": 400, "rot": 0},
        "diagram": {"iconName": "input", "x1": 850, "y1": 340, "x2": 950, "y2": 440, "rot": 0}
      },
      "tags": []
    }
  }
  add_sat = BlockComponents.Math.Add(k1 = 1, k2 = -1) {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 1100, "y1": 500, "x2": 1200, "y2": 600, "rot": 90},
        "diagram": {"iconName": "input", "x1": 800, "y1": 590, "x2": 900, "y2": 690, "rot": 90}
      },
      "tags": []
    }
  }
  gain_track = BlockComponents.Math.Gain(k = 1 / (k * Ni)) {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 500, "y1": 700, "x2": 600, "y2": 800, "rot": 180}
      }
    }
  }
  variable control_error::Real
  "Gain of controller"
  parameter k::Real = 1
  "Time constant of the integrator block"
  parameter Ti::Time = 0.5
  "Time constant of the derivative block"
  parameter Td::Time = 0.1
  "Maximum output"
  parameter y_max::Real = 1e300
  "Minimum output"
  parameter y_min::Real = -y_max
  "Set-point weight for proportional block"
  parameter wp::Real = 1
  "Set-point weight for derivative block"
  parameter wd::Real = 1
  "`Ni*Ti` is time constant of anti-windup compensation"
  parameter Ni::Real = 0.9
  "Maximum derivative gain. Higher the value of `Nd`, the more ideal the derivative block gets (less filtering, higher high-frequency gain)."
  parameter Nd::Real = 10
  "Gain of the feed-forward input"
  parameter k_ff::Real = 1
  "Initial guess value for integrator output"
  parameter xi0::Real = 0
  "Initial guess value for derivative output"
  parameter xd0::Real = 0
relations
  connect(add_p.y, proportional.u) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
  connect(add_d.y, derivative.u) {"Dyad": {"edges": [{"S": 1, "E": 2}]}}
  connect(add_i.y, integrator.u) {"Dyad": {"edges": [{"S": 1, "E": 2}]}}
  connect(proportional.y, add_pid.u1) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
  connect(derivative.y, add_pid.u2) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 452.5, "y": 350}, {"x": 452.5, "y": 170}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(integrator.y, add_pid.u3) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 490, "y": 550}, {"x": 490, "y": 200}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(add_pid.y, gain_pid.u) {
    "Dyad": {
      "edges": [
        {
          "S": 1,
          "M": [
            {"x": 650, "y": 170},
            {"x": 650, "y": 260},
            {"x": 510, "y": 260},
            {"x": 510, "y": 360}
          ],
          "E": 2
        }
      ],
      "renderStyle": "standard"
    }
  }
  connect(gain_pid.y, add_ff.u1) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
  connect(add_ff.y, limiter.u) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
  connect(limiter.y, add_sat.u1) {
    "Dyad": {
      "edges": [
        {
          "S": 1,
          "M": [{"x": 970, "y": 390}, {"x": 970, "y": 500}, {"x": 880, "y": 500}],
          "E": 2
        }
      ],
      "renderStyle": "standard"
    }
  }
  connect(add_sat.y, gain_track.u) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 850, "y": 750}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(gain_track.y, add_i.u3) {
    "Dyad": {"edges": [{"S": 1, "M": [{"x": 75, "y": 750}, {"x": 75, "y": 580}], "E": 2}]}
  }
  control_error = u_s - u_m
  connect(limiter.y, y) {
    "Dyad": {
      "edges": [
        {
          "S": 1,
          "M": [{"x": 970, "y": 390}, {"x": 970, "y": 500}, {"x": 1050, "y": 500}],
          "E": 2
        }
      ],
      "renderStyle": "standard"
    }
  }
  connect(add_ff.u2, u_ff) {
    "Dyad": {
      "edges": [
        {
          "S": 1,
          "M": [{"x": 670, "y": 420}, {"x": 670, "y": 80}, {"x": 500, "y": 80}],
          "E": 2
        }
      ],
      "renderStyle": "standard"
    }
  }
  connect(add_ff.y, add_sat.u2) {
    "Dyad": {
      "edges": [
        {
          "S": 1,
          "M": [{"x": 830, "y": 390}, {"x": 830, "y": 545}, {"x": 820, "y": 545}],
          "E": 2
        }
      ],
      "renderStyle": "standard"
    }
  }
  connect(add_p.u1, u_s) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 20, "y": 110}, {"x": 20, "y": 270}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(add_d.u1, u_s) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 20, "y": 320}, {"x": 20, "y": 270}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(add_i.u1, u_s) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 20, "y": 520}, {"x": 20, "y": 270}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(u_m, add_p.u2) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 50, "y": 730}, {"x": 50, "y": 170}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(add_i.u2, u_m) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 50, "y": 550}, {"x": 50, "y": 730}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(add_d.u2, u_m) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 50, "y": 380}, {"x": 50, "y": 730}], "E": 2}],
      "renderStyle": "standard"
    }
  }
metadata {
  "Dyad": {
    "labels": [{"label": "$(instance)", "x": 500, "y": 1100, "rot": 0}],
    "icons": {"default": "dyad://BlockComponents/LimPID.svg"}
  }
}
end
Flattened Source
dyad
"""
PID controller with limited output, back calculation anti-windup compensation, setpoint weighting and feed-forward

The transfer function is:

math y = k \left[e + \dfrac{1}{T_is}\left(e + \dfrac{y_{sat} - y}{N_iT_i}\right) + \dfrac{T_ds}{1 + {\dfrac{T_d}{N_d}s}}e \right] + k_{ff}u_

"""
component LimPID
  "Connector of setpoint input signal"
  u_s = RealInput() {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "default", "x1": -100, "y1": 220, "x2": 0, "y2": 320, "rot": 0},
        "diagram": {"iconName": "default", "x1": -100, "y1": 220, "x2": 0, "y2": 320, "rot": 0}
      }
    }
  }
  "Connector of measurement input signal"
  u_m = RealInput() {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "default", "x1": -100, "y1": 680, "x2": 0, "y2": 780, "rot": 0},
        "diagram": {"iconName": "default", "x1": -100, "y1": 680, "x2": 0, "y2": 780, "rot": 0}
      }
    }
  }
  "Connector of actuator output signal"
  y = RealOutput() {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "output", "x1": 1000, "y1": 460, "x2": 1100, "y2": 560, "rot": 0},
        "diagram": {"iconName": "output", "x1": 1000, "y1": 460, "x2": 1100, "y2": 560, "rot": 0}
      }
    }
  }
  u_ff = RealInput() {
    "Dyad": {
      "placement": {
        "diagram": {"iconName": "input", "x1": 450, "y1": -100, "x2": 550, "y2": 0, "rot": 90}
      },
      "tags": []
    }
  }
  add_p = BlockComponents.Math.Add(k1 = wp, k2 = -1) {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 100, "y1": 100, "x2": 200, "y2": 200, "rot": 0},
        "diagram": {"iconName": "input", "x1": 100, "y1": 90, "x2": 200, "y2": 190, "rot": 0}
      },
      "tags": []
    }
  }
  add_d = BlockComponents.Math.Add(k1 = wd, k2 = -1) {
    "Dyad": {
      "placement": {"icon": {"iconName": "input", "x1": 100, "y1": 300, "x2": 200, "y2": 400}}
    }
  }
  add_i = BlockComponents.Math.Add3(k2 = -1) {
    "Dyad": {
      "placement": {"icon": {"iconName": "input", "x1": 100, "y1": 500, "x2": 200, "y2": 600}}
    }
  }
  proportional = BlockComponents.Math.Gain(k = 1) {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 300, "y1": 100, "x2": 400, "y2": 200, "rot": 0},
        "diagram": {"iconName": "input", "x1": 300, "y1": 90, "x2": 400, "y2": 190, "rot": 0}
      },
      "tags": []
    }
  }
  derivative = Derivative(k = Td, T = max(Td / Nd, 1e-14), x0 = xd0) {
    "Dyad": {
      "placement": {"icon": {"iconName": "input", "x1": 300, "y1": 300, "x2": 400, "y2": 400}}
    }
  }
  integrator = Integrator(k = 1 / Ti, x0 = xi0) {
    "Dyad": {
      "placement": {"icon": {"iconName": "input", "x1": 300, "y1": 500, "x2": 400, "y2": 600}}
    }
  }
  add_pid = BlockComponents.Math.Add3() {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 500, "y1": 300, "x2": 600, "y2": 400, "rot": 0},
        "diagram": {"iconName": "input", "x1": 500, "y1": 120, "x2": 600, "y2": 220, "rot": 0}
      },
      "tags": []
    }
  }
  gain_pid = BlockComponents.Math.Gain(k = k) {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 700, "y1": 300, "x2": 800, "y2": 400, "rot": 0},
        "diagram": {"iconName": "input", "x1": 550, "y1": 310, "x2": 650, "y2": 410, "rot": 0}
      },
      "tags": []
    }
  }
  add_ff = BlockComponents.Math.Add(k2 = k_ff) {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 900, "y1": 300, "x2": 1000, "y2": 400, "rot": 0},
        "diagram": {"iconName": "input", "x1": 710, "y1": 340, "x2": 810, "y2": 440, "rot": 0}
      },
      "tags": []
    }
  }
  limiter = BlockComponents.Nonlinear.Limiter(y_max = y_max, y_min = y_min) {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 1100, "y1": 300, "x2": 1200, "y2": 400, "rot": 0},
        "diagram": {"iconName": "input", "x1": 850, "y1": 340, "x2": 950, "y2": 440, "rot": 0}
      },
      "tags": []
    }
  }
  add_sat = BlockComponents.Math.Add(k1 = 1, k2 = -1) {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 1100, "y1": 500, "x2": 1200, "y2": 600, "rot": 90},
        "diagram": {"iconName": "input", "x1": 800, "y1": 590, "x2": 900, "y2": 690, "rot": 90}
      },
      "tags": []
    }
  }
  gain_track = BlockComponents.Math.Gain(k = 1 / (k * Ni)) {
    "Dyad": {
      "placement": {
        "icon": {"iconName": "input", "x1": 500, "y1": 700, "x2": 600, "y2": 800, "rot": 180}
      }
    }
  }
  variable control_error::Real
  "Gain of controller"
  parameter k::Real = 1
  "Time constant of the integrator block"
  parameter Ti::Time = 0.5
  "Time constant of the derivative block"
  parameter Td::Time = 0.1
  "Maximum output"
  parameter y_max::Real = 1e300
  "Minimum output"
  parameter y_min::Real = -y_max
  "Set-point weight for proportional block"
  parameter wp::Real = 1
  "Set-point weight for derivative block"
  parameter wd::Real = 1
  "`Ni*Ti` is time constant of anti-windup compensation"
  parameter Ni::Real = 0.9
  "Maximum derivative gain. Higher the value of `Nd`, the more ideal the derivative block gets (less filtering, higher high-frequency gain)."
  parameter Nd::Real = 10
  "Gain of the feed-forward input"
  parameter k_ff::Real = 1
  "Initial guess value for integrator output"
  parameter xi0::Real = 0
  "Initial guess value for derivative output"
  parameter xd0::Real = 0
relations
  connect(add_p.y, proportional.u) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
  connect(add_d.y, derivative.u) {"Dyad": {"edges": [{"S": 1, "E": 2}]}}
  connect(add_i.y, integrator.u) {"Dyad": {"edges": [{"S": 1, "E": 2}]}}
  connect(proportional.y, add_pid.u1) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
  connect(derivative.y, add_pid.u2) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 452.5, "y": 350}, {"x": 452.5, "y": 170}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(integrator.y, add_pid.u3) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 490, "y": 550}, {"x": 490, "y": 200}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(add_pid.y, gain_pid.u) {
    "Dyad": {
      "edges": [
        {
          "S": 1,
          "M": [
            {"x": 650, "y": 170},
            {"x": 650, "y": 260},
            {"x": 510, "y": 260},
            {"x": 510, "y": 360}
          ],
          "E": 2
        }
      ],
      "renderStyle": "standard"
    }
  }
  connect(gain_pid.y, add_ff.u1) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
  connect(add_ff.y, limiter.u) {"Dyad": {"edges": [{"S": 1, "M": [], "E": 2}], "renderStyle": "standard"}}
  connect(limiter.y, add_sat.u1) {
    "Dyad": {
      "edges": [
        {
          "S": 1,
          "M": [{"x": 970, "y": 390}, {"x": 970, "y": 500}, {"x": 880, "y": 500}],
          "E": 2
        }
      ],
      "renderStyle": "standard"
    }
  }
  connect(add_sat.y, gain_track.u) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 850, "y": 750}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(gain_track.y, add_i.u3) {
    "Dyad": {"edges": [{"S": 1, "M": [{"x": 75, "y": 750}, {"x": 75, "y": 580}], "E": 2}]}
  }
  control_error = u_s - u_m
  connect(limiter.y, y) {
    "Dyad": {
      "edges": [
        {
          "S": 1,
          "M": [{"x": 970, "y": 390}, {"x": 970, "y": 500}, {"x": 1050, "y": 500}],
          "E": 2
        }
      ],
      "renderStyle": "standard"
    }
  }
  connect(add_ff.u2, u_ff) {
    "Dyad": {
      "edges": [
        {
          "S": 1,
          "M": [{"x": 670, "y": 420}, {"x": 670, "y": 80}, {"x": 500, "y": 80}],
          "E": 2
        }
      ],
      "renderStyle": "standard"
    }
  }
  connect(add_ff.y, add_sat.u2) {
    "Dyad": {
      "edges": [
        {
          "S": 1,
          "M": [{"x": 830, "y": 390}, {"x": 830, "y": 545}, {"x": 820, "y": 545}],
          "E": 2
        }
      ],
      "renderStyle": "standard"
    }
  }
  connect(add_p.u1, u_s) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 20, "y": 110}, {"x": 20, "y": 270}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(add_d.u1, u_s) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 20, "y": 320}, {"x": 20, "y": 270}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(add_i.u1, u_s) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 20, "y": 520}, {"x": 20, "y": 270}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(u_m, add_p.u2) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 50, "y": 730}, {"x": 50, "y": 170}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(add_i.u2, u_m) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 50, "y": 550}, {"x": 50, "y": 730}], "E": 2}],
      "renderStyle": "standard"
    }
  }
  connect(add_d.u2, u_m) {
    "Dyad": {
      "edges": [{"S": 1, "M": [{"x": 50, "y": 380}, {"x": 50, "y": 730}], "E": 2}],
      "renderStyle": "standard"
    }
  }
metadata {
  "Dyad": {
    "labels": [{"label": "$(instance)", "x": 500, "y": 1100, "rot": 0}],
    "icons": {"default": "dyad://BlockComponents/LimPID.svg"}
  }
}
end


Test Cases

No test cases defined.