master:Zpi_ctlr parametersPSCAD PI Controller
Every parameter of the PSCAD PI Controller (master:Zpi_ctlr): 11 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().
What master:Zpi_ctlr is
PI Controller (Z domain PI controller), a component of PSCAD's Master Library, filed under lines, cables and towers.
- Definition
master:Zpi_ctlr- PSCAD name
- PI Controller
- Category
- Lines, cables and towers
- Parameters
- 11, in 1 group; 1 carry a unit
- Read from
- PSCAD 5.0.0, 2026-11-07
Read and write master:Zpi_ctlr in Python
import mhi.pscad
pscad = mhi.pscad.connect() # the PSCAD that is open; launch() starts one
project = pscad.project("my_case") # a case loaded in the workspace
for comp in project.find_all("master:Zpi_ctlr"): # the exact definition, namespace first
params = comp.parameters() # every parameter, as PSCAD holds it
print(str(params["TI"])) # Integral Time Constant, in s
comp = project.find_all("master:Zpi_ctlr")[0]
comp.parameters(TI="0.02 [s]") # a value that carries a unit is written with it- A parameter is named exactly as in the table, letter case included:
parameters()gives every one of them in a dictionary, and a name the component does not have is refused. - A value that carries a unit comes back as a number whose unit is only in its text, so read it as text first (
str(...)) or the unit is lost. PSCAD keeps a written unit as it is given:"2500 [mohm]"stays in mohm. - A Choice is read and written as its symbol (the capitals in "Written as"), not as the words PSCAD shows in the dialog.
find_all()takes the exact definition only. A wildcard or a bare name withoutmaster:comes back empty; the Builder'spx_findwalks the pages for those.
The Builder's runtime does the same with the unit handled for you: px_get(comp, "TI") and px_set(...), which also records the old value so the case is put back at the end. Getting started shows them.
Configuration
| Parameter | Unit | Default | Description |
|---|---|---|---|
DimInteger | · | 1 | Dimensiondimension of input/output signalsRange 1 to 2147483647 |
GPReal | · | 1.0 | Proportional Gain |
INTRChoice | · | NO | Is Input Already Sampled?Select Yes if the input is already sampled with the same execution frequency, Select No if sampling is needed.Written as YES (Yes), NO (No) |
LimitChoice | · | NO | Limit Output?Select Yes to enable non windup limitsWritten as NO (No), YES (Yes) |
MthdChoice | · | TRPEZOIDAL | Integration MethodSelect the integration method: Forward Euler, Backward Euler or TrapezoidalWritten as FORWARD_EULER (Forward Euler), BACKWARD_EULER (Backward Euler), TRPEZOIDAL (Trpezoidal) |
NameText | · | · | Name for IdentificationEnter a name for identification |
ResetChoice | · | NEVER | Resettable?Select when to enable resetWritten as NEVER (Never), ANYTIME (Anytime), TIMEZERO (Timezero) |
TIReal | s | 0.01 | Integral Time ConstantAt least 1E-20 |
Y0Real | · | 0.0 | Reset OutputOutput when the reset is enabled |
YHIReal | · | 10.0 | Maximum LimitUsed when Limit==1 |
YLOReal | · | -10.0 | Minimum LimitUsed when Limit==1 |
Related
- All 345 definitions in the component reference
- Control tuning: overshoot, rise time and damping
- PSCAD automation with Python: getting started
← master:pi_ctlr PI Controller · master:pi_section2 pi_section2 →