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 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, "Eexp") and px_set(...), which also records the old value so the case is put back at the end. Getting started shows them.
- Shepherd Model5
- Configuration7
- Discharge Curve of Internal Resistance20
- Discharge Curve of Battery Voltage20
Shepherd Model
| Parameter | Unit | Default | Description |
|---|---|---|---|
EexpReal | pu | 1.03 | Voltage at Exponential PointEnter the voltage at exponential point as a per unit value of nominal voltageAt least 1 |
EfullReal | pu | 1.15 | Fully Charged VoltageEnter fully charged voltage based on nominal voltageAt least 1 |
QexpReal | pu | 0.4 | Capacity at Exponential PointEnter dischrage capacity at exponential point based on rated capacityRange 1E-38 to 1 |
QnomReal | pu | 0.95 | Nominal CapacityEnter nominal capacity based on rated capacityRange 1E-38 to 1 |
lossReal | pu | 0.005 | Resistive DropEnter the voltage drop due at nominal discharge current as a per unit value of nominal voltageRange 0 to 1 |
Configuration
| Parameter | Unit | Default | Description |
|---|---|---|---|
EnomReal | kV | 0.12 | Nominal VoltageEnter the nominal votlageAt least 1E-38 |
InomReal | % | 20 | Loss of Capacity at Nominal Current in an HourThe nominal discharge current, for which the discharge curve has been measuredAt least 1E-38 |
NameText | · | Bat1 | Battery Name |
QratedReal | kA*hr | 0.0065 | Rated CapacityEner the rated capacityAt least 1E-38 |
SOCText | · | · | State of Charge [%] |
SOCintReal | % | 100 | Initial State of ChargeAt least 0 |
TypeChoice | · | SHEPHERD_MODEL | Data EntrySelect from Shepherd model or Tabular dataWritten as SHEPHERD_MODEL (Shepherd model), TABULAR_DATA (Tabular data) |
Discharge Curve of Internal Resistance
| Parameter | Unit | Default | Description |
|---|---|---|---|
R1Real | pu | 0.005 | R1 |
R10Real | pu | 0.005 | R10 |
R2Real | pu | 0.005 | R2 |
R3Real | pu | 0.005 | R3 |
R4Real | pu | 0.005 | R4 |
R5Real | pu | 0.005 | R5 |
R6Real | pu | 0.005 | R6 |
R7Real | pu | 0.005 | R7 |
R8Real | pu | 0.005 | R8 |
R9Real | pu | 0.005 | R9 |
SOCr1Real | % | 97 | SOC1At least 0 |
SOCr10Real | % | 0 | SOC10At least 0 |
SOCr2Real | % | 94 | SOC2At least 0 |
SOCr3Real | % | 90 | SOC3At least 0 |
SOCr4Real | % | 85 | SOC4At least 0 |
SOCr5Real | % | 50 | SOC5At least 0 |
SOCr6Real | % | 15 | SOC6At least 0 |
SOCr7Real | % | 10 | SOC7At least 0 |
SOCr8Real | % | 6 | SOC8At least 0 |
SOCr9Real | % | 3 | SOC9At least 0 |
Discharge Curve of Battery Voltage
| Parameter | Unit | Default | Description |
|---|---|---|---|
SOCv1Real | % | 100 | SOC1At least 0 |
SOCv10Real | % | 1.26 | SOC10At least 0 |
SOCv2Real | % | 98 | SOC2At least 0 |
SOCv3Real | % | 95 | SOC3At least 0 |
SOCv4Real | % | 92 | SOC4At least 0 |
SOCv5Real | % | 88 | SOC5At least 0 |
SOCv6Real | % | 82 | SOC6At least 0 |
SOCv7Real | % | 20 | SOC7At least 0 |
SOCv8Real | % | 10 | SOC8At least 0 |
SOCv9Real | % | 6 | SOC9At least 0 |
V1Real | pu | 1.15 | V1At least 1E-38 |
V10Real | pu | 0.9083 | V10At least 1E-38 |
V2Real | pu | 1.1333 | V2At least 1E-38 |
V3Real | pu | 1.1167 | V3At least 1E-38 |
V4Real | pu | 1.1 | V4At least 1E-38 |
V5Real | pu | 1.075 | V5At least 1E-38 |
V6Real | pu | 1.0583 | V6At least 1E-38 |
V7Real | pu | 1.025 | V7At least 1E-38 |
V8Real | pu | 1.025 | V8At least 1E-38 |
V9Real | pu | 1.0083 | V9At least 1E-38 |
Related
master:src_current_dependent_current Current Dependent Current Source →