master:battery parametersPSCAD Battery

Every parameter of the PSCAD Battery (master:battery): 52 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().

What master:battery is

Battery (Generic battery model), a component of PSCAD's Master Library, filed under sources.

Definition
master:battery
PSCAD name
Battery
Category
Sources
Parameters
52, in 4 groups; 49 carry a unit
Read from
PSCAD 5.0.0, 2026-11-07

Read and write master:battery 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:battery"):   # the exact definition, namespace first
    params = comp.parameters()           # every parameter, as PSCAD holds it
    print(str(params["Eexp"]))           # Voltage at Exponential Point, in pu

comp = project.find_all("master:battery")[0]
comp.parameters(Eexp="2.06 [pu]")        # 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, "Eexp") and px_set(...), which also records the old value so the case is put back at the end. Getting started shows them.

Shepherd Model

ParameterUnitDefaultDescription
EexpRealpu1.03Voltage at Exponential PointEnter the voltage at exponential point as a per unit value of nominal voltageAt least 1
EfullRealpu1.15Fully Charged VoltageEnter fully charged voltage based on nominal voltageAt least 1
QexpRealpu0.4Capacity at Exponential PointEnter dischrage capacity at exponential point based on rated capacityRange 1E-38 to 1
QnomRealpu0.95Nominal CapacityEnter nominal capacity based on rated capacityRange 1E-38 to 1
lossRealpu0.005Resistive DropEnter the voltage drop due at nominal discharge current as a per unit value of nominal voltageRange 0 to 1

Configuration

ParameterUnitDefaultDescription
EnomRealkV0.12Nominal VoltageEnter the nominal votlageAt least 1E-38
InomReal%20Loss of Capacity at Nominal Current in an HourThe nominal discharge current, for which the discharge curve has been measuredAt least 1E-38
NameText·Bat1Battery Name
QratedRealkA*hr0.0065Rated CapacityEner the rated capacityAt least 1E-38
SOCText··State of Charge [%]
SOCintReal%100Initial State of ChargeAt least 0
TypeChoice·SHEPHERD_MODELData EntrySelect from Shepherd model or Tabular dataWritten as SHEPHERD_MODEL (Shepherd model), TABULAR_DATA (Tabular data)

Discharge Curve of Internal Resistance

ParameterUnitDefaultDescription
R1Realpu0.005R1
R10Realpu0.005R10
R2Realpu0.005R2
R3Realpu0.005R3
R4Realpu0.005R4
R5Realpu0.005R5
R6Realpu0.005R6
R7Realpu0.005R7
R8Realpu0.005R8
R9Realpu0.005R9
SOCr1Real%97SOC1At least 0
SOCr10Real%0SOC10At least 0
SOCr2Real%94SOC2At least 0
SOCr3Real%90SOC3At least 0
SOCr4Real%85SOC4At least 0
SOCr5Real%50SOC5At least 0
SOCr6Real%15SOC6At least 0
SOCr7Real%10SOC7At least 0
SOCr8Real%6SOC8At least 0
SOCr9Real%3SOC9At least 0

Discharge Curve of Battery Voltage

ParameterUnitDefaultDescription
SOCv1Real%100SOC1At least 0
SOCv10Real%1.26SOC10At least 0
SOCv2Real%98SOC2At least 0
SOCv3Real%95SOC3At least 0
SOCv4Real%92SOC4At least 0
SOCv5Real%88SOC5At least 0
SOCv6Real%82SOC6At least 0
SOCv7Real%20SOC7At least 0
SOCv8Real%10SOC8At least 0
SOCv9Real%6SOC9At least 0
V1Realpu1.15V1At least 1E-38
V10Realpu0.9083V10At least 1E-38
V2Realpu1.1333V2At least 1E-38
V3Realpu1.1167V3At least 1E-38
V4Realpu1.1V4At least 1E-38
V5Realpu1.075V5At least 1E-38
V6Realpu1.0583V6At least 1E-38
V7Realpu1.025V7At least 1E-38
V8Realpu1.025V8At least 1E-38
V9Realpu1.0083V9At least 1E-38

Related

master:src_current_dependent_current Current Dependent Current Source →