master:polpi5 parametersPSCAD Generic Current Controller

Every parameter of the PSCAD Generic Current Controller (master:polpi5): 7 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().

What master:polpi5 is

Generic Current Controller, a component of PSCAD's Master Library, filed under other components.

Definition
master:polpi5
PSCAD name
Generic Current Controller
Category
Other components
Parameters
7, in 1 group; 6 carry a unit
Read from
PSCAD 5.0.0, 2026-11-07

Read and write master:polpi5 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:polpi5"):   # the exact definition, namespace first
    params = comp.parameters()           # every parameter, as PSCAD holds it
    print(str(params["AMAX"]))           # Alpha Maximum Limit, in rad

comp = project.find_all("master:polpi5")[0]
comp.parameters(AMAX="6.284 [rad]")      # 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 without master: comes back empty; the Builder's px_find walks the pages for those.

The Builder's runtime does the same with the unit handled for you: px_get(comp, "AMAX") and px_set(...), which also records the old value so the case is put back at the end. Getting started shows them.

Configuration

ParameterUnitDefaultDescription
AMAXRealrad3.142Alpha Maximum LimitRange 0 to 3.142
AMINRealrad0.0Alpha Minimum LimitRange 0 to 3.142
CMRealpu0.0Current MarginRange 0 to 1
DVRealpu0.1Slope of Current ErrorRange 0 to 1
GR1Realdeg*A^-1*s^-15.0Integral GainRange 0 to 1000
GR2Realpu0.02Proportional GainRange 0 to 10
NameText··Name for IdentificationEnter a name for identification

Related

← master:force_dsout Force to DSOut · master:vg6p18 Generic Gamma Controller →