Class: Storage¶
A Storage object in OpenDSS representing a battery energy storage system with inverter-based grid connection.
URI: dss:Storage
classDiagram
class Storage
click Storage href "../Storage/"
Storage : AmpLimit
Storage : AmpLimitGain
Storage : Balanced
Storage : basefreq
Storage : bus1
Storage : ChargeTrigger
Storage : class_class
Storage : conn
Storage : ControlMode
Storage : daily
Storage : debugtrace
Storage : DischargeTrigger
Storage : DispMode
Storage : duty
Storage : DynaData
Storage : DynaDLL
Storage : DynamicEq
Storage : DynOut
Storage : EffCurve
Storage : enabled
Storage : Kp
Storage : kv
Storage : kVA
Storage : kvar
Storage : kvarMax
Storage : kvarMaxAbs
Storage : kVDC
Storage : kW
Storage : kWhrated
Storage : kWhstored
Storage : kWrated
Storage : like
Storage : LimitCurrent
Storage : model
Storage : name
Storage : pct_Charge
Storage : pct_Cutin
Storage : pct_Cutout
Storage : pct_Discharge
Storage : pct_EffCharge
Storage : pct_EffDischarge
Storage : pct_Idlingkvar
Storage : pct_IdlingkW
Storage : pct_kWrated
Storage : pct_PminkvarMax
Storage : pct_PminNoVars
Storage : pct_R
Storage : pct_reserve
Storage : pct_stored
Storage : pct_X
Storage : pf
Storage : PFPriority
Storage : phases
Storage : PITol
Storage : SafeMode
Storage : SafeVoltage
Storage : spectrum
Storage : State
Storage : TimeChargeTrig
Storage : UserData
Storage : UserModel
Storage : VarFollowInverter
Storage : Vmaxpu
Storage : Vminpu
Storage : WattPriority
Storage : yearly
Class Properties¶
| Property | Value |
|---|---|
| Class URI | dss:Storage |
Slots¶
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| name | 1 String |
Object name | direct |
| phases | 0..1 Integer |
Number of Phases, this Storage element | direct |
| bus1 | 0..1 String |
Bus to which the Storage element is connected | direct |
| kv | 0..1 Float |
Nominal rated (1 | direct |
| conn | 0..1 String |
={wye | LN |
| kW | 0..1 Float |
Get/set the requested kW value | direct |
| kvar | 0..1 Float |
Get/set the requested kvar value | direct |
| pf | 0..1 Float |
Get/set the requested PF value | direct |
| kVA | 0..1 Float |
Indicates the inverter nameplate capability (in kVA) | direct |
| pct_Cutin | 0..1 Float |
Cut-in power as a percentage of inverter kVA rating | direct |
| pct_Cutout | 0..1 Float |
Cut-out power as a percentage of inverter kVA rating | direct |
| EffCurve | 0..1 Float |
An XYCurve object, previously defined, that describes the PER UNIT efficiency... | direct |
| VarFollowInverter | 0..1 Boolean |
Boolean variable (Yes | No) or (True |
| kvarMax | 0..1 Float |
Indicates the maximum reactive power GENERATION (un-signed, kvar) for the inv... | direct |
| kvarMaxAbs | 0..1 Float |
Indicates the maximum reactive power ABSORPTION (un-signed, kvar) for the inv... | direct |
| WattPriority | 0..1 String |
{Yes/No*/True/False} Set inverter to watt priority instead of the default var... | direct |
| PFPriority | 0..1 Float |
If set to true, priority is given to power factor and WattPriority is neglect... | direct |
| pct_PminNoVars | 0..1 Float |
Minimum active power as percentage of kWrated under which there is no vars pr... | direct |
| pct_PminkvarMax | 0..1 Float |
Minimum active power as percentage of kWrated that allows the inverter to pro... | direct |
| kWrated | 0..1 Float |
kW rating of power output | direct |
| pct_kWrated | 0..1 Float |
Upper limit on active power as a percentage of kWrated | direct |
| kWhrated | 0..1 Float |
Rated Storage capacity in kWh | direct |
| kWhstored | 0..1 Float |
Present amount of energy stored, kWh | direct |
| pct_stored | 0..1 Float |
Present amount of energy stored, % of rated kWh | direct |
| pct_reserve | 0..1 Float |
Percentage of rated kWh Storage capacity to be held in reserve for normal ope... | direct |
| State | 0..1 String |
{idling | charging |
| pct_Discharge | 0..1 Float |
Discharge rate (output power) in percentage of rated kW | direct |
| pct_Charge | 0..1 Float |
Charging rate (input power) in percentage of rated kW | direct |
| pct_EffCharge | 0..1 Float |
Percentage efficiency for CHARGING the Storage element | direct |
| pct_EffDischarge | 0..1 Float |
Percentage efficiency for DISCHARGING the Storage element | direct |
| pct_IdlingkW | 0..1 Float |
Percentage of rated kW consumed by idling losses | direct |
| pct_Idlingkvar | 0..1 String |
Deprecated | direct |
| pct_R | 0..1 Float |
Equivalent percentage internal resistance, ohms | direct |
| pct_X | 0..1 Float |
Equivalent percentage internal reactance, ohms | direct |
| model | 0..1 Integer |
Integer code (default=1) for the model to be used for power output variation ... | direct |
| Vminpu | 0..1 Float |
Minimum per unit voltage | direct |
| Vmaxpu | 0..1 Float |
Maximum per unit voltage | direct |
| Balanced | 0..1 Boolean |
{Yes | No*} Default is No |
| LimitCurrent | 0..1 Float |
Limits current magnitude to Vminpu value for both 1-phase and 3-phase Storage... | direct |
| yearly | 0..1 String |
Dispatch shape to use for yearly simulations | direct |
| daily | 0..1 String |
Dispatch shape to use for daily simulations | direct |
| duty | 0..1 Integer |
Load shape to use for duty cycle dispatch simulations | direct |
| DispMode | 0..1 Float |
{DEFAULT | FOLLOW |
| DischargeTrigger | 0..1 String |
Dispatch trigger value for discharging the Storage | direct |
| ChargeTrigger | 0..1 String |
Dispatch trigger value for charging the Storage | direct |
| TimeChargeTrig | 0..1 String |
Time of day in fractional hours (0230 = 2 | direct |
| class_class | 0..1 Integer |
An arbitrary integer number representing the class of Storage element | direct |
| DynaDLL | 0..1 Float |
Name of DLL containing user-written dynamics model for Dynamics-mode simulati... | direct |
| DynaData | 0..1 String |
String that gets passed to the user-written dynamics model Edit function | direct |
| UserModel | 0..1 Float |
Name of DLL containing user-written model for both power flow and dynamics | direct |
| UserData | 0..1 String |
String that gets passed to user-written model for defining the data required ... | direct |
| debugtrace | 0..1 Boolean |
{Yes | No } Default is no |
| kVDC | 0..1 Float |
Indicates the rated voltage (kV) at the input of the inverter while the stora... | direct |
| Kp | 0..1 String |
It is the proportional gain for the PI controller within the inverter | direct |
| PITol | 0..1 String |
It is the tolerance (%) for the closed loop controller of the inverter | direct |
| SafeVoltage | 0..1 Float |
Indicates the voltage level (%) respect to the base voltage level for which t... | direct |
| SafeMode | 0..1 String |
(Read only) Indicates whether the inverter entered (Yes) or not (No) into Saf... | direct |
| DynamicEq | 0..1 String |
The name of the dynamic equation (DinamicExp) that will be used for defining ... | direct |
| DynOut | 0..1 Float |
The name of the variables within the Dynamic equation that will be used to go... | direct |
| ControlMode | 0..1 String |
Defines the control mode for the inverter | direct |
| AmpLimit | 0..1 Float |
Is the current limiter per phase for the IBR when operating in GFM mode | direct |
| AmpLimitGain | 0..1 Float |
Use it for fine tunning the current limiter when active, by default is 0 | direct |
| spectrum | 0..1 Float |
Name of harmonic voltage or current spectrum for this Storage element | direct |
| basefreq | 0..1 Float |
Base Frequency for ratings | direct |
| enabled | 0..1 Boolean |
{Yes | No or True |
| like | 0..1 String |
Make like another object, e | direct |
Comments¶
- Each DSS Storage creates two CIM objects: BatteryUnit (the battery; holds ratedE, storedE, batteryState, maxP, minP) and PowerElectronicsConnection (the inverter; holds ratedS, ratedU, p, q, maxQ, minQ). The converter returns the PowerElectronicsConnection; the BatteryUnit is linked via PowerElectronicsConnection.PowerElectronicsUnit.
Identifier and Mapping Information¶
Schema Source¶
- from schema: https://gridappsd.github.io/dss-graph/opendss
Mappings¶
| Mapping Type | Mapped Value |
|---|---|
| self | dss:Storage |
| native | dss:Storage |
| close | cim:BatteryUnit |
LinkML Source¶
Direct¶
name: Storage
description: A Storage object in OpenDSS representing a battery energy storage system
with inverter-based grid connection.
comments:
- 'Each DSS Storage creates two CIM objects: BatteryUnit (the battery; holds ratedE,
storedE, batteryState, maxP, minP) and PowerElectronicsConnection (the inverter;
holds ratedS, ratedU, p, q, maxQ, minQ). The converter returns the PowerElectronicsConnection;
the BatteryUnit is linked via PowerElectronicsConnection.PowerElectronicsUnit.'
from_schema: https://gridappsd.github.io/dss-graph/opendss
close_mappings:
- cim:BatteryUnit
attributes:
name:
name: name
description: Object name. Must be unique per object type.
comments:
- Name applied to both BatteryUnit and PowerElectronicsConnection with suffix
'_bat' / '_pec'.
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:IdentifiedObject.name
identifier: true
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: true
phases:
name: phases
annotations:
order:
tag: order
value: 1
description: Number of Phases, this Storage element
comments:
- 'Import: inferred from bus1 node suffix. Export: len(PowerElectronicsConnection.PowerElectronicsConnectionPhase).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:PowerElectronicsConnectionPhase
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Xfmrcode
- Fault
- Gicsource
- Isource
- Vsource
range: integer
required: false
bus1:
name: bus1
annotations:
order:
tag: order
value: 2
description: Bus to which the Storage element is connected
comments:
- 'Structural mapping via traversal: equipment.Terminals[0].ConnectivityNode.name.
Phase suffix reconstructed from PowerElectronicsConnectionPhase objects.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:Terminal.ConnectivityNode
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Windgen
- Capacitor
- Line
- Reactor
- Fault
- Isource
- Vsource
range: string
required: false
kv:
name: kv
annotations:
order:
tag: order
value: 3
description: Nominal rated (1.0 per unit) voltage, kV, for Storage element. For
2- and 3-phase Storage, specify phase-phase kV. Otherwise, specify actual kV
across each branch.
comments:
- 'Import: ratedU = Voltage(kv, ''kV'') — always treated as L-L (Storage converter
does not apply sqrt(3) scaling unlike PVSystem). Export: kv = ratedU.to(''kV'').
CIM stores in V (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:PowerElectronicsConnection.ratedU
domain_of:
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
minimum_value: 0.0
conn:
name: conn
annotations:
order:
tag: order
value: 4
description: ={wye|LN|delta|LL}
comments:
- 'This CIM profile''s PowerElectronicsConnection has no dedicated connection-kind
field, so the winding connection is carried as a literal text workaround: import
sets description = ''conn=delta'' when conn is ''delta'' (wye, the default,
leaves description unset); export reads ess.conn = ''delta'' when description
equals that literal string, and otherwise leaves conn at its default (wye).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:PowerElectronicsConnection.description
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Capacitor
- Reactor
- Transformer
- Xfmrcode
- Sensor
range: string
required: false
kW:
name: kW
annotations:
order:
tag: order
value: 5
description: Get/set the requested kW value. Positive = discharging (generating).
comments:
- 'Import: PEC.p = ActivePower(-kW, ''kW'') — negated because DSS uses generator
convention (positive kW = power out), while CIM Terminal uses load convention
(positive p = power in). If kW is not given, PEC.p is instead derived from State
combined with %Discharge/%Charge and kWrated (see those attributes). Export:
kW = abs(PEC.p.to(''kW'')) — DSS Storage kW is always a positive magnitude,
with the State attribute carrying the charge/discharge direction.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
close_mappings:
- cim:PowerElectronicsConnection.p
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Storage
- Vsconverter
- Windgen
range: float
required: false
kvar:
name: kvar
annotations:
order:
tag: order
value: 6
description: Get/set the requested kvar value. Positive = capacitive (generator
convention).
comments:
- 'Import: PEC.q = ReactivePower(-kvar, ''kVAr'') — negated for same CIM vs DSS
sign convention reason as kW. Export: kvar = -PEC.q.to(''kVAr'').'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
close_mappings:
- cim:PowerElectronicsConnection.q
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
pf:
name: pf
annotations:
order:
tag: order
value: 7
dss_default:
tag: dss_default
value: float(1.0)
description: Get/set the requested PF value. Default is 1.0.
comments:
- 'Import-only fallback: used to derive PowerElectronicsConnection.q only when
kvar is not explicitly given and kW is available — kvar = kW * tan(acos(|pf|)),
sign-flipped when pf is negative, then negated into CIM''s sign convention like
kvar. Export always writes an explicit kvar from PEC.q and never reconstructs
pf, so a round trip does not recover the original pf value.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:PowerElectronicsConnection.q
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Upfc
range: float
required: false
minimum_value: -1.0
maximum_value: 1.0
kVA:
name: kVA
annotations:
order:
tag: order
value: 8
description: Indicates the inverter nameplate capability (in kVA).
comments:
- 'Import: PEC.ratedS = ApparentPower(kVA, ''kVA''). Export: kVA = ratedS.to(''kVA'').
CIM stores in VA (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:PowerElectronicsConnection.ratedS
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Transformer
- Xfmrcode
range: float
required: false
pct_Cutin:
name: pct_Cutin
annotations:
order:
tag: order
value: 9
dss_name:
tag: dss_name
value: '%Cutin'
description: Cut-in power as a percentage of inverter kVA rating.
comments:
- 'OpenDSS-only (N/A): inverter dispatch threshold; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
pct_Cutout:
name: pct_Cutout
annotations:
order:
tag: order
value: 10
dss_name:
tag: dss_name
value: '%Cutout'
description: Cut-out power as a percentage of inverter kVA rating.
comments:
- 'OpenDSS-only (N/A): inverter dispatch threshold; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
EffCurve:
name: EffCurve
annotations:
order:
tag: order
value: 11
description: An XYCurve object, previously defined, that describes the PER UNIT
efficiency vs PER UNIT of rated kVA for the inverter.
todos:
- No CIM equivalent. Inverter efficiency curve; requires CIM extension or mapping
to a custom XYCurve linked to the PEC.
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
VarFollowInverter:
name: VarFollowInverter
annotations:
order:
tag: order
value: 12
description: Boolean variable (Yes|No) or (True|False). When True, reactive power
follows the inverter dispatch.
comments:
- 'OpenDSS-only (N/A): inverter control mode flag; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: boolean
required: false
kvarMax:
name: kvarMax
annotations:
order:
tag: order
value: 13
description: Indicates the maximum reactive power GENERATION (un-signed, kvar)
for the inverter.
comments:
- 'Import: PEC.maxQ = ReactivePower(kvarMax, ''kVAr''). Export: kvarMax = maxQ.to(''kVAr'').
CIM stores in VAr (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:PowerElectronicsConnection.maxQ
domain_of:
- Pvsystem
- Storage
range: float
required: false
kvarMaxAbs:
name: kvarMaxAbs
annotations:
order:
tag: order
value: 14
description: Indicates the maximum reactive power ABSORPTION (un-signed, kvar)
for the inverter.
comments:
- 'Import: PEC.minQ = ReactivePower(-kvarMaxAbs, ''kVAr'') — negated because absorption
is negative Q in CIM convention. Export: kvarMaxAbs = abs(minQ.to(''kVAr'')).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
close_mappings:
- cim:PowerElectronicsConnection.minQ
domain_of:
- Pvsystem
- Storage
range: float
required: false
WattPriority:
name: WattPriority
annotations:
order:
tag: order
value: 15
description: '{Yes/No*/True/False} Set inverter to watt priority instead of the
default var priority.'
comments:
- 'OpenDSS-only (N/A): inverter operating mode priority; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: string
required: false
PFPriority:
name: PFPriority
annotations:
order:
tag: order
value: 16
description: If set to true, priority is given to power factor and WattPriority
is neglected.
comments:
- 'OpenDSS-only (N/A): inverter operating mode priority; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
pct_PminNoVars:
name: pct_PminNoVars
annotations:
order:
tag: order
value: 17
dss_name:
tag: dss_name
value: '%PminNoVars'
description: Minimum active power as percentage of kWrated under which there is
no vars production/absorption.
comments:
- 'OpenDSS-only (N/A): inverter deadband parameter; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
pct_PminkvarMax:
name: pct_PminkvarMax
annotations:
order:
tag: order
value: 18
dss_name:
tag: dss_name
value: '%PminkvarMax'
description: Minimum active power as percentage of kWrated that allows the inverter
to produce/absorb reactive power up to its maximum reactive power.
comments:
- 'OpenDSS-only (N/A): inverter reactive capability threshold; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
kWrated:
name: kWrated
annotations:
order:
tag: order
value: 19
description: kW rating of power output. Rated maximum active power.
comments:
- 'Import: BatteryUnit.maxP = ActivePower(kWrated, ''kW''). Export: kWrated =
maxP.to(''kW''). CIM stores in W (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:PowerElectronicsUnit.maxP
rank: 1000
domain_of:
- Storage
range: float
required: false
minimum_value: 0.0
pct_kWrated:
name: pct_kWrated
annotations:
order:
tag: order
value: 20
dss_name:
tag: dss_name
value: '%kWrated'
description: Upper limit on active power as a percentage of kWrated.
comments:
- 'OpenDSS-only (N/A): operational curtailment factor; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
domain_of:
- Storage
range: float
required: false
kWhrated:
name: kWhrated
annotations:
order:
tag: order
value: 21
description: Rated Storage capacity in kWh.
comments:
- 'Import: BatteryUnit.ratedE = Energy(kWhrated, ''kWh''). Export: kWhrated =
ratedE.to(''kWh''). CIM stores in J (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:BatteryUnit.ratedE
rank: 1000
domain_of:
- Storage
range: float
required: false
minimum_value: 0.0
kWhstored:
name: kWhstored
annotations:
order:
tag: order
value: 22
description: Present amount of energy stored, kWh.
comments:
- 'Import: BatteryUnit.storedE = Energy(kWhstored, ''kWh''). Export: kWhstored
= storedE.to(''kWh''). CIM stores in J (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:BatteryUnit.storedE
rank: 1000
domain_of:
- Storage
range: float
required: false
pct_stored:
name: pct_stored
annotations:
order:
tag: order
value: 23
dss_name:
tag: dss_name
value: '%stored'
description: Present amount of energy stored, % of rated kWh.
comments:
- 'OpenDSS-only (N/A): derived as kWhstored / kWhrated * 100; not stored on CIM
separately.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
domain_of:
- Storage
range: float
required: false
pct_reserve:
name: pct_reserve
annotations:
order:
tag: order
value: 24
dss_name:
tag: dss_name
value: '%reserve'
description: Percentage of rated kWh Storage capacity to be held in reserve for
normal operation.
comments:
- 'OpenDSS-only (N/A): operational reserve parameter; no CIM equivalent in the
standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
domain_of:
- Storage
range: float
required: false
State:
name: State
annotations:
order:
tag: order
value: 25
description: '{idling | charging | discharging} Get/Set present operational state.'
comments:
- 'Import: ''discharging'' → BatteryStateKind.discharging; ''charging'' → BatteryStateKind.charging;
''idling''/''waiting''/''idle'' → BatteryStateKind.waiting. Export: reverse
enum lookup.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:BatteryUnit.batteryState
rank: 1000
domain_of:
- Storage
- Fuse
- Recloser
- Relay
- Swtcontrol
range: string
required: false
pct_Discharge:
name: pct_Discharge
annotations:
order:
tag: order
value: 26
dss_name:
tag: dss_name
value: '%Discharge'
description: Discharge rate (output power) in percentage of rated kW.
comments:
- 'Import-only fallback: used only when kW is not explicitly given and State is
''discharging'' — PEC.p = -(kWrated * pct_Discharge / 100), negated into CIM''s
generator sign convention. Ignored whenever kW is present, and never reconstructed
on export (export always writes an explicit kW from PEC.p).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:PowerElectronicsConnection.p
rank: 1000
domain_of:
- Storage
range: float
required: false
pct_Charge:
name: pct_Charge
annotations:
order:
tag: order
value: 27
dss_name:
tag: dss_name
value: '%Charge'
description: Charging rate (input power) in percentage of rated kW.
comments:
- 'Import-only fallback: used only when kW is not explicitly given and State is
''charging'' — PEC.p = kWrated * pct_Charge / 100. Ignored whenever kW is present,
and never reconstructed on export (export always writes an explicit kW from
PEC.p).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:PowerElectronicsConnection.p
rank: 1000
domain_of:
- Storage
range: float
required: false
pct_EffCharge:
name: pct_EffCharge
annotations:
order:
tag: order
value: 28
dss_name:
tag: dss_name
value: '%EffCharge'
description: Percentage efficiency for CHARGING the Storage element.
comments:
- 'OpenDSS-only (N/A): efficiency parameter; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
domain_of:
- Storage
range: float
required: false
pct_EffDischarge:
name: pct_EffDischarge
annotations:
order:
tag: order
value: 29
dss_name:
tag: dss_name
value: '%EffDischarge'
description: Percentage efficiency for DISCHARGING the Storage element.
comments:
- 'OpenDSS-only (N/A): efficiency parameter; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
domain_of:
- Storage
range: float
required: false
pct_IdlingkW:
name: pct_IdlingkW
annotations:
order:
tag: order
value: 30
dss_name:
tag: dss_name
value: '%IdlingkW'
description: Percentage of rated kW consumed by idling losses.
comments:
- 'OpenDSS-only (N/A): standby loss parameter; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
domain_of:
- Storage
range: float
required: false
pct_Idlingkvar:
name: pct_Idlingkvar
annotations:
order:
tag: order
value: 31
dss_name:
tag: dss_name
value: '%Idlingkvar'
description: Deprecated.
comments:
- Deprecated DSS attribute; not mapped.
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
domain_of:
- Storage
range: string
required: false
pct_R:
name: pct_R
annotations:
order:
tag: order
value: 32
dss_name:
tag: dss_name
value: '%R'
description: Equivalent percentage internal resistance, ohms.
comments:
- 'OpenDSS-only (N/A): internal resistance used for short-circuit simulation;
no standard CIM equivalent on PowerElectronicsConnection.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
- Autotrans
- Transformer
- Xfmrcode
range: float
required: false
pct_X:
name: pct_X
annotations:
order:
tag: order
value: 33
dss_name:
tag: dss_name
value: '%X'
description: Equivalent percentage internal reactance, ohms.
comments:
- 'OpenDSS-only (N/A): internal reactance used for short-circuit simulation; no
standard CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
model:
name: model
annotations:
order:
tag: order
value: 34
description: Integer code (default=1) for the model to be used for power output
variation with voltage.
comments:
- 'OpenDSS-only (N/A): DSS V/Q model selector; no direct CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: integer
required: false
Vminpu:
name: Vminpu
annotations:
order:
tag: order
value: 35
description: Minimum per unit voltage. Default = 0.9.
comments:
- 'Import: PEC.maxIFault = 1.0 / Vminpu. Export: Vminpu = 1.0 / maxIFault. Approximate
mapping — maxIFault is the primary CIM field used by the OpenDSS exporter for
fault current limiting.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
close_mappings:
- cim:PowerElectronicsConnection.maxIFault
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
Vmaxpu:
name: Vmaxpu
annotations:
order:
tag: order
value: 36
description: Maximum per unit voltage. Default = 1.1.
comments:
- 'OpenDSS-only (N/A): overvoltage trip threshold; no direct CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
Balanced:
name: Balanced
annotations:
order:
tag: order
value: 37
description: '{Yes | No*} Default is No. If true, force balanced operation.'
comments:
- 'OpenDSS-only (N/A): simulation option; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Generator
- Pvsystem
- Storage
range: boolean
required: false
LimitCurrent:
name: LimitCurrent
annotations:
order:
tag: order
value: 38
description: Limits current magnitude to Vminpu value for both 1-phase and 3-phase
Storage similar to Generator Model 7.
comments:
- 'OpenDSS-only (N/A): current-limiting simulation flag; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
yearly:
name: yearly
annotations:
order:
tag: order
value: 39
description: Dispatch shape to use for yearly simulations. LoadShape name.
todos:
- Loadshape converter not yet implemented.
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:SeasonDayTypeSchedule
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
daily:
name: daily
annotations:
order:
tag: order
value: 40
description: Dispatch shape to use for daily simulations. LoadShape name.
todos:
- Loadshape converter not yet implemented.
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:SeasonDayTypeSchedule
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
duty:
name: duty
annotations:
order:
tag: order
value: 41
description: Load shape to use for duty cycle dispatch simulations.
todos:
- Loadshape converter not yet implemented.
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:SeasonDayTypeSchedule
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: integer
required: false
DispMode:
name: DispMode
annotations:
order:
tag: order
value: 42
description: '{DEFAULT | FOLLOW | EXTERNAL | LOADLEVEL | PRICE } Default = "DEFAULT".
Dispatch mode for the storage element.'
comments:
- 'OpenDSS-only (N/A): dispatch control mode flag; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
domain_of:
- Storage
range: float
required: false
DischargeTrigger:
name: DischargeTrigger
annotations:
order:
tag: order
value: 43
description: Dispatch trigger value for discharging the Storage.
comments:
- 'OpenDSS-only (N/A): dispatch trigger; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
domain_of:
- Storage
range: string
required: false
ChargeTrigger:
name: ChargeTrigger
annotations:
order:
tag: order
value: 44
description: Dispatch trigger value for charging the Storage.
comments:
- 'OpenDSS-only (N/A): dispatch trigger; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
domain_of:
- Storage
range: string
required: false
TimeChargeTrig:
name: TimeChargeTrig
annotations:
order:
tag: order
value: 45
description: Time of day in fractional hours (0230 = 2.5) at which storage element
will automatically go into charge state.
comments:
- 'OpenDSS-only (N/A): time-based dispatch trigger; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
domain_of:
- Storage
range: string
required: false
class_class:
name: class_class
annotations:
order:
tag: order
value: 46
dss_name:
tag: dss_name
value: class
description: An arbitrary integer number representing the class of Storage element.
comments:
- 'OpenDSS-only (N/A): internal classification integer; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
- Windgen
range: integer
required: false
DynaDLL:
name: DynaDLL
annotations:
order:
tag: order
value: 47
description: Name of DLL containing user-written dynamics model for Dynamics-mode
simulations.
comments:
- 'OpenDSS-only (N/A): dynamics DLL hook; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
domain_of:
- Storage
range: float
required: false
DynaData:
name: DynaData
annotations:
order:
tag: order
value: 48
description: String that gets passed to the user-written dynamics model Edit function.
comments:
- 'OpenDSS-only (N/A): dynamics DLL data; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
domain_of:
- Storage
range: string
required: false
UserModel:
name: UserModel
annotations:
order:
tag: order
value: 49
description: Name of DLL containing user-written model for both power flow and
dynamics.
comments:
- 'OpenDSS-only (N/A): user model DLL; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Capcontrol
range: float
required: false
UserData:
name: UserData
annotations:
order:
tag: order
value: 50
description: String that gets passed to user-written model for defining the data
required for that model.
comments:
- 'OpenDSS-only (N/A): user model data; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Capcontrol
range: string
required: false
debugtrace:
name: debugtrace
annotations:
order:
tag: order
value: 51
description: '{Yes | No } Default is no. If true, writes debug trace to a file.'
comments:
- 'OpenDSS-only (N/A): simulation debug flag; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Regcontrol
range: boolean
required: false
kVDC:
name: kVDC
annotations:
order:
tag: order
value: 52
description: Indicates the rated voltage (kV) at the input of the inverter while
the storage is discharging.
comments:
- 'OpenDSS-only (N/A): DC-side voltage rating; no CIM equivalent in the standard
AC profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
Kp:
name: Kp
annotations:
order:
tag: order
value: 53
description: It is the proportional gain for the PI controller within the inverter.
comments:
- 'OpenDSS-only (N/A): inverter PI controller tuning parameter; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: string
required: false
PITol:
name: PITol
annotations:
order:
tag: order
value: 54
description: It is the tolerance (%) for the closed loop controller of the inverter.
comments:
- 'OpenDSS-only (N/A): inverter PI controller tolerance; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: string
required: false
SafeVoltage:
name: SafeVoltage
annotations:
order:
tag: order
value: 55
description: Indicates the voltage level (%) respect to the base voltage level
for which the Inverter will operate.
comments:
- 'OpenDSS-only (N/A): grid-forming safe-voltage threshold; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
SafeMode:
name: SafeMode
annotations:
order:
tag: order
value: 56
description: (Read only) Indicates whether the inverter entered (Yes) or not (No)
into Safe Mode.
comments:
- 'OpenDSS-only (N/A): read-only operational state; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: string
required: false
DynamicEq:
name: DynamicEq
annotations:
order:
tag: order
value: 57
description: The name of the dynamic equation (DinamicExp) that will be used for
defining the dynamic behavior of the generator.
comments:
- 'OpenDSS-only (N/A): dynamics model reference; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
DynOut:
name: DynOut
annotations:
order:
tag: order
value: 58
description: The name of the variables within the Dynamic equation that will be
used to govern the PVSystem dynamics.
comments:
- 'OpenDSS-only (N/A): dynamics output variable mapping; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
ControlMode:
name: ControlMode
annotations:
order:
tag: order
value: 59
description: Defines the control mode for the inverter. {GFM | GFL*}
comments:
- 'OpenDSS-only (N/A): grid-forming vs. grid-following mode flag; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: string
required: false
AmpLimit:
name: AmpLimit
annotations:
order:
tag: order
value: 60
description: Is the current limiter per phase for the IBR when operating in GFM
mode.
comments:
- 'OpenDSS-only (N/A): GFM current limiter; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
AmpLimitGain:
name: AmpLimitGain
annotations:
order:
tag: order
value: 61
description: Use it for fine tunning the current limiter when active, by default
is 0.
comments:
- 'OpenDSS-only (N/A): GFM limiter gain; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
spectrum:
name: spectrum
annotations:
order:
tag: order
value: 62
description: Name of harmonic voltage or current spectrum for this Storage element.
comments:
- 'OpenDSS-only (N/A): harmonic spectrum reference; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Gicsource
- Isource
- Vsource
range: float
required: false
basefreq:
name: basefreq
annotations:
order:
tag: order
value: 63
description: Base Frequency for ratings.
comments:
- Not stored on CIM PowerElectronicsConnection; base frequency is a circuit-level
property in CIM.
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: float
required: false
enabled:
name: enabled
annotations:
order:
tag: order
value: 64
dss_default:
tag: dss_default
value: 'true'
description: '{Yes|No or True|False} Indicates whether this element is enabled.'
comments:
- 'OpenDSS-only (N/A): if False, converter returns None and no CIM objects are
created.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: boolean
required: false
like:
name: like
annotations:
order:
tag: order
value: 65
description: 'Make like another object, e.g.: New Storage.S2 like=S1 ...'
comments:
- 'OpenDSS-only (N/A): DSS template/copy directive resolved at parse time; no
CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: false
class_uri: dss:Storage
Induced¶
name: Storage
description: A Storage object in OpenDSS representing a battery energy storage system
with inverter-based grid connection.
comments:
- 'Each DSS Storage creates two CIM objects: BatteryUnit (the battery; holds ratedE,
storedE, batteryState, maxP, minP) and PowerElectronicsConnection (the inverter;
holds ratedS, ratedU, p, q, maxQ, minQ). The converter returns the PowerElectronicsConnection;
the BatteryUnit is linked via PowerElectronicsConnection.PowerElectronicsUnit.'
from_schema: https://gridappsd.github.io/dss-graph/opendss
close_mappings:
- cim:BatteryUnit
attributes:
name:
name: name
description: Object name. Must be unique per object type.
comments:
- Name applied to both BatteryUnit and PowerElectronicsConnection with suffix
'_bat' / '_pec'.
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:IdentifiedObject.name
identifier: true
owner: Storage
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: true
phases:
name: phases
annotations:
order:
tag: order
value: 1
description: Number of Phases, this Storage element
comments:
- 'Import: inferred from bus1 node suffix. Export: len(PowerElectronicsConnection.PowerElectronicsConnectionPhase).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:PowerElectronicsConnectionPhase
owner: Storage
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Xfmrcode
- Fault
- Gicsource
- Isource
- Vsource
range: integer
required: false
bus1:
name: bus1
annotations:
order:
tag: order
value: 2
description: Bus to which the Storage element is connected
comments:
- 'Structural mapping via traversal: equipment.Terminals[0].ConnectivityNode.name.
Phase suffix reconstructed from PowerElectronicsConnectionPhase objects.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:Terminal.ConnectivityNode
owner: Storage
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Windgen
- Capacitor
- Line
- Reactor
- Fault
- Isource
- Vsource
range: string
required: false
kv:
name: kv
annotations:
order:
tag: order
value: 3
description: Nominal rated (1.0 per unit) voltage, kV, for Storage element. For
2- and 3-phase Storage, specify phase-phase kV. Otherwise, specify actual kV
across each branch.
comments:
- 'Import: ratedU = Voltage(kv, ''kV'') — always treated as L-L (Storage converter
does not apply sqrt(3) scaling unlike PVSystem). Export: kv = ratedU.to(''kV'').
CIM stores in V (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:PowerElectronicsConnection.ratedU
owner: Storage
domain_of:
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
minimum_value: 0.0
conn:
name: conn
annotations:
order:
tag: order
value: 4
description: ={wye|LN|delta|LL}
comments:
- 'This CIM profile''s PowerElectronicsConnection has no dedicated connection-kind
field, so the winding connection is carried as a literal text workaround: import
sets description = ''conn=delta'' when conn is ''delta'' (wye, the default,
leaves description unset); export reads ess.conn = ''delta'' when description
equals that literal string, and otherwise leaves conn at its default (wye).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:PowerElectronicsConnection.description
owner: Storage
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Capacitor
- Reactor
- Transformer
- Xfmrcode
- Sensor
range: string
required: false
kW:
name: kW
annotations:
order:
tag: order
value: 5
description: Get/set the requested kW value. Positive = discharging (generating).
comments:
- 'Import: PEC.p = ActivePower(-kW, ''kW'') — negated because DSS uses generator
convention (positive kW = power out), while CIM Terminal uses load convention
(positive p = power in). If kW is not given, PEC.p is instead derived from State
combined with %Discharge/%Charge and kWrated (see those attributes). Export:
kW = abs(PEC.p.to(''kW'')) — DSS Storage kW is always a positive magnitude,
with the State attribute carrying the charge/discharge direction.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
close_mappings:
- cim:PowerElectronicsConnection.p
owner: Storage
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Storage
- Vsconverter
- Windgen
range: float
required: false
kvar:
name: kvar
annotations:
order:
tag: order
value: 6
description: Get/set the requested kvar value. Positive = capacitive (generator
convention).
comments:
- 'Import: PEC.q = ReactivePower(-kvar, ''kVAr'') — negated for same CIM vs DSS
sign convention reason as kW. Export: kvar = -PEC.q.to(''kVAr'').'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
close_mappings:
- cim:PowerElectronicsConnection.q
owner: Storage
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
- Capacitor
- Reactor
range: float
required: false
pf:
name: pf
annotations:
order:
tag: order
value: 7
dss_default:
tag: dss_default
value: float(1.0)
description: Get/set the requested PF value. Default is 1.0.
comments:
- 'Import-only fallback: used to derive PowerElectronicsConnection.q only when
kvar is not explicitly given and kW is available — kvar = kW * tan(acos(|pf|)),
sign-flipped when pf is negative, then negated into CIM''s sign convention like
kvar. Export always writes an explicit kvar from PEC.q and never reconstructs
pf, so a round trip does not recover the original pf value.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:PowerElectronicsConnection.q
owner: Storage
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Upfc
range: float
required: false
minimum_value: -1.0
maximum_value: 1.0
kVA:
name: kVA
annotations:
order:
tag: order
value: 8
description: Indicates the inverter nameplate capability (in kVA).
comments:
- 'Import: PEC.ratedS = ApparentPower(kVA, ''kVA''). Export: kVA = ratedS.to(''kVA'').
CIM stores in VA (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:PowerElectronicsConnection.ratedS
owner: Storage
domain_of:
- Load
- Generator
- Generic5
- Indmach012
- Pvsystem
- Storage
- Windgen
- Autotrans
- Transformer
- Xfmrcode
range: float
required: false
pct_Cutin:
name: pct_Cutin
annotations:
order:
tag: order
value: 9
dss_name:
tag: dss_name
value: '%Cutin'
description: Cut-in power as a percentage of inverter kVA rating.
comments:
- 'OpenDSS-only (N/A): inverter dispatch threshold; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
pct_Cutout:
name: pct_Cutout
annotations:
order:
tag: order
value: 10
dss_name:
tag: dss_name
value: '%Cutout'
description: Cut-out power as a percentage of inverter kVA rating.
comments:
- 'OpenDSS-only (N/A): inverter dispatch threshold; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
EffCurve:
name: EffCurve
annotations:
order:
tag: order
value: 11
description: An XYCurve object, previously defined, that describes the PER UNIT
efficiency vs PER UNIT of rated kVA for the inverter.
todos:
- No CIM equivalent. Inverter efficiency curve; requires CIM extension or mapping
to a custom XYCurve linked to the PEC.
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
VarFollowInverter:
name: VarFollowInverter
annotations:
order:
tag: order
value: 12
description: Boolean variable (Yes|No) or (True|False). When True, reactive power
follows the inverter dispatch.
comments:
- 'OpenDSS-only (N/A): inverter control mode flag; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: boolean
required: false
kvarMax:
name: kvarMax
annotations:
order:
tag: order
value: 13
description: Indicates the maximum reactive power GENERATION (un-signed, kvar)
for the inverter.
comments:
- 'Import: PEC.maxQ = ReactivePower(kvarMax, ''kVAr''). Export: kvarMax = maxQ.to(''kVAr'').
CIM stores in VAr (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:PowerElectronicsConnection.maxQ
owner: Storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
kvarMaxAbs:
name: kvarMaxAbs
annotations:
order:
tag: order
value: 14
description: Indicates the maximum reactive power ABSORPTION (un-signed, kvar)
for the inverter.
comments:
- 'Import: PEC.minQ = ReactivePower(-kvarMaxAbs, ''kVAr'') — negated because absorption
is negative Q in CIM convention. Export: kvarMaxAbs = abs(minQ.to(''kVAr'')).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
close_mappings:
- cim:PowerElectronicsConnection.minQ
owner: Storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
WattPriority:
name: WattPriority
annotations:
order:
tag: order
value: 15
description: '{Yes/No*/True/False} Set inverter to watt priority instead of the
default var priority.'
comments:
- 'OpenDSS-only (N/A): inverter operating mode priority; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: string
required: false
PFPriority:
name: PFPriority
annotations:
order:
tag: order
value: 16
description: If set to true, priority is given to power factor and WattPriority
is neglected.
comments:
- 'OpenDSS-only (N/A): inverter operating mode priority; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
pct_PminNoVars:
name: pct_PminNoVars
annotations:
order:
tag: order
value: 17
dss_name:
tag: dss_name
value: '%PminNoVars'
description: Minimum active power as percentage of kWrated under which there is
no vars production/absorption.
comments:
- 'OpenDSS-only (N/A): inverter deadband parameter; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
pct_PminkvarMax:
name: pct_PminkvarMax
annotations:
order:
tag: order
value: 18
dss_name:
tag: dss_name
value: '%PminkvarMax'
description: Minimum active power as percentage of kWrated that allows the inverter
to produce/absorb reactive power up to its maximum reactive power.
comments:
- 'OpenDSS-only (N/A): inverter reactive capability threshold; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
kWrated:
name: kWrated
annotations:
order:
tag: order
value: 19
description: kW rating of power output. Rated maximum active power.
comments:
- 'Import: BatteryUnit.maxP = ActivePower(kWrated, ''kW''). Export: kWrated =
maxP.to(''kW''). CIM stores in W (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:PowerElectronicsUnit.maxP
rank: 1000
owner: Storage
domain_of:
- Storage
range: float
required: false
minimum_value: 0.0
pct_kWrated:
name: pct_kWrated
annotations:
order:
tag: order
value: 20
dss_name:
tag: dss_name
value: '%kWrated'
description: Upper limit on active power as a percentage of kWrated.
comments:
- 'OpenDSS-only (N/A): operational curtailment factor; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
owner: Storage
domain_of:
- Storage
range: float
required: false
kWhrated:
name: kWhrated
annotations:
order:
tag: order
value: 21
description: Rated Storage capacity in kWh.
comments:
- 'Import: BatteryUnit.ratedE = Energy(kWhrated, ''kWh''). Export: kWhrated =
ratedE.to(''kWh''). CIM stores in J (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:BatteryUnit.ratedE
rank: 1000
owner: Storage
domain_of:
- Storage
range: float
required: false
minimum_value: 0.0
kWhstored:
name: kWhstored
annotations:
order:
tag: order
value: 22
description: Present amount of energy stored, kWh.
comments:
- 'Import: BatteryUnit.storedE = Energy(kWhstored, ''kWh''). Export: kWhstored
= storedE.to(''kWh''). CIM stores in J (SI base).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:BatteryUnit.storedE
rank: 1000
owner: Storage
domain_of:
- Storage
range: float
required: false
pct_stored:
name: pct_stored
annotations:
order:
tag: order
value: 23
dss_name:
tag: dss_name
value: '%stored'
description: Present amount of energy stored, % of rated kWh.
comments:
- 'OpenDSS-only (N/A): derived as kWhstored / kWhrated * 100; not stored on CIM
separately.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
owner: Storage
domain_of:
- Storage
range: float
required: false
pct_reserve:
name: pct_reserve
annotations:
order:
tag: order
value: 24
dss_name:
tag: dss_name
value: '%reserve'
description: Percentage of rated kWh Storage capacity to be held in reserve for
normal operation.
comments:
- 'OpenDSS-only (N/A): operational reserve parameter; no CIM equivalent in the
standard profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
owner: Storage
domain_of:
- Storage
range: float
required: false
State:
name: State
annotations:
order:
tag: order
value: 25
description: '{idling | charging | discharging} Get/Set present operational state.'
comments:
- 'Import: ''discharging'' → BatteryStateKind.discharging; ''charging'' → BatteryStateKind.charging;
''idling''/''waiting''/''idle'' → BatteryStateKind.waiting. Export: reverse
enum lookup.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
exact_mappings:
- cim:BatteryUnit.batteryState
rank: 1000
owner: Storage
domain_of:
- Storage
- Fuse
- Recloser
- Relay
- Swtcontrol
range: string
required: false
pct_Discharge:
name: pct_Discharge
annotations:
order:
tag: order
value: 26
dss_name:
tag: dss_name
value: '%Discharge'
description: Discharge rate (output power) in percentage of rated kW.
comments:
- 'Import-only fallback: used only when kW is not explicitly given and State is
''discharging'' — PEC.p = -(kWrated * pct_Discharge / 100), negated into CIM''s
generator sign convention. Ignored whenever kW is present, and never reconstructed
on export (export always writes an explicit kW from PEC.p).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:PowerElectronicsConnection.p
rank: 1000
owner: Storage
domain_of:
- Storage
range: float
required: false
pct_Charge:
name: pct_Charge
annotations:
order:
tag: order
value: 27
dss_name:
tag: dss_name
value: '%Charge'
description: Charging rate (input power) in percentage of rated kW.
comments:
- 'Import-only fallback: used only when kW is not explicitly given and State is
''charging'' — PEC.p = kWrated * pct_Charge / 100. Ignored whenever kW is present,
and never reconstructed on export (export always writes an explicit kW from
PEC.p).'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:PowerElectronicsConnection.p
rank: 1000
owner: Storage
domain_of:
- Storage
range: float
required: false
pct_EffCharge:
name: pct_EffCharge
annotations:
order:
tag: order
value: 28
dss_name:
tag: dss_name
value: '%EffCharge'
description: Percentage efficiency for CHARGING the Storage element.
comments:
- 'OpenDSS-only (N/A): efficiency parameter; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
owner: Storage
domain_of:
- Storage
range: float
required: false
pct_EffDischarge:
name: pct_EffDischarge
annotations:
order:
tag: order
value: 29
dss_name:
tag: dss_name
value: '%EffDischarge'
description: Percentage efficiency for DISCHARGING the Storage element.
comments:
- 'OpenDSS-only (N/A): efficiency parameter; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
owner: Storage
domain_of:
- Storage
range: float
required: false
pct_IdlingkW:
name: pct_IdlingkW
annotations:
order:
tag: order
value: 30
dss_name:
tag: dss_name
value: '%IdlingkW'
description: Percentage of rated kW consumed by idling losses.
comments:
- 'OpenDSS-only (N/A): standby loss parameter; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
owner: Storage
domain_of:
- Storage
range: float
required: false
pct_Idlingkvar:
name: pct_Idlingkvar
annotations:
order:
tag: order
value: 31
dss_name:
tag: dss_name
value: '%Idlingkvar'
description: Deprecated.
comments:
- Deprecated DSS attribute; not mapped.
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
owner: Storage
domain_of:
- Storage
range: string
required: false
pct_R:
name: pct_R
annotations:
order:
tag: order
value: 32
dss_name:
tag: dss_name
value: '%R'
description: Equivalent percentage internal resistance, ohms.
comments:
- 'OpenDSS-only (N/A): internal resistance used for short-circuit simulation;
no standard CIM equivalent on PowerElectronicsConnection.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
- Autotrans
- Transformer
- Xfmrcode
range: float
required: false
pct_X:
name: pct_X
annotations:
order:
tag: order
value: 33
dss_name:
tag: dss_name
value: '%X'
description: Equivalent percentage internal reactance, ohms.
comments:
- 'OpenDSS-only (N/A): internal reactance used for short-circuit simulation; no
standard CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
model:
name: model
annotations:
order:
tag: order
value: 34
description: Integer code (default=1) for the model to be used for power output
variation with voltage.
comments:
- 'OpenDSS-only (N/A): DSS V/Q model selector; no direct CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: integer
required: false
Vminpu:
name: Vminpu
annotations:
order:
tag: order
value: 35
description: Minimum per unit voltage. Default = 0.9.
comments:
- 'Import: PEC.maxIFault = 1.0 / Vminpu. Export: Vminpu = 1.0 / maxIFault. Approximate
mapping — maxIFault is the primary CIM field used by the OpenDSS exporter for
fault current limiting.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
close_mappings:
- cim:PowerElectronicsConnection.maxIFault
owner: Storage
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
Vmaxpu:
name: Vmaxpu
annotations:
order:
tag: order
value: 36
description: Maximum per unit voltage. Default = 1.1.
comments:
- 'OpenDSS-only (N/A): overvoltage trip threshold; no direct CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
Balanced:
name: Balanced
annotations:
order:
tag: order
value: 37
description: '{Yes | No*} Default is No. If true, force balanced operation.'
comments:
- 'OpenDSS-only (N/A): simulation option; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Generator
- Pvsystem
- Storage
range: boolean
required: false
LimitCurrent:
name: LimitCurrent
annotations:
order:
tag: order
value: 38
description: Limits current magnitude to Vminpu value for both 1-phase and 3-phase
Storage similar to Generator Model 7.
comments:
- 'OpenDSS-only (N/A): current-limiting simulation flag; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
yearly:
name: yearly
annotations:
order:
tag: order
value: 39
description: Dispatch shape to use for yearly simulations. LoadShape name.
todos:
- Loadshape converter not yet implemented.
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:SeasonDayTypeSchedule
owner: Storage
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
daily:
name: daily
annotations:
order:
tag: order
value: 40
description: Dispatch shape to use for daily simulations. LoadShape name.
todos:
- Loadshape converter not yet implemented.
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:SeasonDayTypeSchedule
owner: Storage
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
duty:
name: duty
annotations:
order:
tag: order
value: 41
description: Load shape to use for duty cycle dispatch simulations.
todos:
- Loadshape converter not yet implemented.
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
related_mappings:
- cim:SeasonDayTypeSchedule
owner: Storage
domain_of:
- Load
- Generator
- Pvsystem
- Storage
- Windgen
range: integer
required: false
DispMode:
name: DispMode
annotations:
order:
tag: order
value: 42
description: '{DEFAULT | FOLLOW | EXTERNAL | LOADLEVEL | PRICE } Default = "DEFAULT".
Dispatch mode for the storage element.'
comments:
- 'OpenDSS-only (N/A): dispatch control mode flag; no CIM equivalent in the standard
profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
owner: Storage
domain_of:
- Storage
range: float
required: false
DischargeTrigger:
name: DischargeTrigger
annotations:
order:
tag: order
value: 43
description: Dispatch trigger value for discharging the Storage.
comments:
- 'OpenDSS-only (N/A): dispatch trigger; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
owner: Storage
domain_of:
- Storage
range: string
required: false
ChargeTrigger:
name: ChargeTrigger
annotations:
order:
tag: order
value: 44
description: Dispatch trigger value for charging the Storage.
comments:
- 'OpenDSS-only (N/A): dispatch trigger; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
owner: Storage
domain_of:
- Storage
range: string
required: false
TimeChargeTrig:
name: TimeChargeTrig
annotations:
order:
tag: order
value: 45
description: Time of day in fractional hours (0230 = 2.5) at which storage element
will automatically go into charge state.
comments:
- 'OpenDSS-only (N/A): time-based dispatch trigger; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
owner: Storage
domain_of:
- Storage
range: string
required: false
class_class:
name: class_class
annotations:
order:
tag: order
value: 46
dss_name:
tag: dss_name
value: class
description: An arbitrary integer number representing the class of Storage element.
comments:
- 'OpenDSS-only (N/A): internal classification integer; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
- Windgen
range: integer
required: false
DynaDLL:
name: DynaDLL
annotations:
order:
tag: order
value: 47
description: Name of DLL containing user-written dynamics model for Dynamics-mode
simulations.
comments:
- 'OpenDSS-only (N/A): dynamics DLL hook; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
owner: Storage
domain_of:
- Storage
range: float
required: false
DynaData:
name: DynaData
annotations:
order:
tag: order
value: 48
description: String that gets passed to the user-written dynamics model Edit function.
comments:
- 'OpenDSS-only (N/A): dynamics DLL data; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
rank: 1000
owner: Storage
domain_of:
- Storage
range: string
required: false
UserModel:
name: UserModel
annotations:
order:
tag: order
value: 49
description: Name of DLL containing user-written model for both power flow and
dynamics.
comments:
- 'OpenDSS-only (N/A): user model DLL; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Capcontrol
range: float
required: false
UserData:
name: UserData
annotations:
order:
tag: order
value: 50
description: String that gets passed to user-written model for defining the data
required for that model.
comments:
- 'OpenDSS-only (N/A): user model data; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Capcontrol
range: string
required: false
debugtrace:
name: debugtrace
annotations:
order:
tag: order
value: 51
description: '{Yes | No } Default is no. If true, writes debug trace to a file.'
comments:
- 'OpenDSS-only (N/A): simulation debug flag; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
- Regcontrol
range: boolean
required: false
kVDC:
name: kVDC
annotations:
order:
tag: order
value: 52
description: Indicates the rated voltage (kV) at the input of the inverter while
the storage is discharging.
comments:
- 'OpenDSS-only (N/A): DC-side voltage rating; no CIM equivalent in the standard
AC profile.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
Kp:
name: Kp
annotations:
order:
tag: order
value: 53
description: It is the proportional gain for the PI controller within the inverter.
comments:
- 'OpenDSS-only (N/A): inverter PI controller tuning parameter; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: string
required: false
PITol:
name: PITol
annotations:
order:
tag: order
value: 54
description: It is the tolerance (%) for the closed loop controller of the inverter.
comments:
- 'OpenDSS-only (N/A): inverter PI controller tolerance; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: string
required: false
SafeVoltage:
name: SafeVoltage
annotations:
order:
tag: order
value: 55
description: Indicates the voltage level (%) respect to the base voltage level
for which the Inverter will operate.
comments:
- 'OpenDSS-only (N/A): grid-forming safe-voltage threshold; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
SafeMode:
name: SafeMode
annotations:
order:
tag: order
value: 56
description: (Read only) Indicates whether the inverter entered (Yes) or not (No)
into Safe Mode.
comments:
- 'OpenDSS-only (N/A): read-only operational state; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: string
required: false
DynamicEq:
name: DynamicEq
annotations:
order:
tag: order
value: 57
description: The name of the dynamic equation (DinamicExp) that will be used for
defining the dynamic behavior of the generator.
comments:
- 'OpenDSS-only (N/A): dynamics model reference; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
range: string
required: false
DynOut:
name: DynOut
annotations:
order:
tag: order
value: 58
description: The name of the variables within the Dynamic equation that will be
used to govern the PVSystem dynamics.
comments:
- 'OpenDSS-only (N/A): dynamics output variable mapping; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Generator
- Pvsystem
- Storage
- Windgen
range: float
required: false
ControlMode:
name: ControlMode
annotations:
order:
tag: order
value: 59
description: Defines the control mode for the inverter. {GFM | GFL*}
comments:
- 'OpenDSS-only (N/A): grid-forming vs. grid-following mode flag; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: string
required: false
AmpLimit:
name: AmpLimit
annotations:
order:
tag: order
value: 60
description: Is the current limiter per phase for the IBR when operating in GFM
mode.
comments:
- 'OpenDSS-only (N/A): GFM current limiter; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
AmpLimitGain:
name: AmpLimitGain
annotations:
order:
tag: order
value: 61
description: Use it for fine tunning the current limiter when active, by default
is 0.
comments:
- 'OpenDSS-only (N/A): GFM limiter gain; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Pvsystem
- Storage
range: float
required: false
spectrum:
name: spectrum
annotations:
order:
tag: order
value: 62
description: Name of harmonic voltage or current spectrum for this Storage element.
comments:
- 'OpenDSS-only (N/A): harmonic spectrum reference; no CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Gicsource
- Isource
- Vsource
range: float
required: false
basefreq:
name: basefreq
annotations:
order:
tag: order
value: 63
description: Base Frequency for ratings.
comments:
- Not stored on CIM PowerElectronicsConnection; base frequency is a circuit-level
property in CIM.
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: float
required: false
enabled:
name: enabled
annotations:
order:
tag: order
value: 64
dss_default:
tag: dss_default
value: 'true'
description: '{Yes|No or True|False} Indicates whether this element is enabled.'
comments:
- 'OpenDSS-only (N/A): if False, converter returns None and no CIM objects are
created.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: boolean
required: false
like:
name: like
annotations:
order:
tag: order
value: 65
description: 'Make like another object, e.g.: New Storage.S2 like=S1 ...'
comments:
- 'OpenDSS-only (N/A): DSS template/copy directive resolved at parse time; no
CIM equivalent.'
from_schema: https://gridappsd.github.io/dss-graph/pce/storage
owner: Storage
domain_of:
- Load
- Generator
- Generic5
- Gicline
- Indmach012
- Pvsystem
- Storage
- Upfc
- Vccs
- Vsconverter
- Windgen
- Autotrans
- Capacitor
- Gictransformer
- Line
- Reactor
- Transformer
- Capcontrol
- Espvlcontrol
- Expcontrol
- Fuse
- Gendispatcher
- Invcontrol
- Pycontrol
- Recloser
- Regcontrol
- Relay
- Storagecontroller
- Swtcontrol
- Upfccontrol
- Cndata
- Dynamicexp
- Growthshape
- Linecode
- Linegeometry
- Linespacing
- Loadshape
- Priceshape
- Spectrum
- TccCurve
- Tsdata
- Tshape
- Wiredata
- Xfmrcode
- Xycurve
- Energymeter
- Fmonitor
- Monitor
- Sensor
- Fault
- Gicsource
- Isource
- Vsource
range: string
required: false
class_uri: dss:Storage