BatteryUnit

Type: object

An electrochemical energy storage device.

 No Additional Properties

root BatteryUnit.BatteryResponse
Type: object

nan

 No Additional Properties

root BatteryUnit.BatteryResponse BatteryResponseCharacteristic.responseCharacteristic
Type: enum (of string)

nan

Must be one of:

  • "constantPFixedQConstantReactance"
  • "constantPFixedV"
  • "constantPFixedQ"
  • "constantPF"
  • "constantPConstantQCurrentLimited"
  • "constantAdmittance"

root BatteryUnit.BatteryDispatchProfile
Type: string

Pointer to Curve object

root BatteryUnit.ratedE
Type: object or number

Full energy storage capacity of the battery. The attribute shall be a positive value.

root BatteryUnit.ratedE value
Type: number Default: null

nan

root BatteryUnit.ratedE multiplier
Type: enum (of string) Default: "none"

nan

Must be one of:

  • "f"
  • "c"
  • "G"
  • "d"
  • "z"
  • "p"
  • "y"
  • "h"
  • "Y"
  • "a"
  • "none"
  • "k"
  • "m"
  • "n"
  • "E"
  • "da"
  • "T"
  • "M"
  • "P"
  • "Z"
  • "micro"

root BatteryUnit.ratedE unit
Type: enum (of string) Default: "Wh"

nan

Must be one of:

  • "JPerkg"
  • "NPerm"
  • "WPerW"
  • "JPermol"
  • "WPerm2sr"
  • "V"
  • "A2h"
  • "JPerK"
  • "m3Perkg"
  • "HzPerHz"
  • "T"
  • "Vh"
  • "tonne"
  • "JPerm2"
  • "CPerkg"
  • "VPerHz"
  • "ohm"
  • "K"
  • "m3Compensated"
  • "lx"
  • "lPerh"
  • "APerm"
  • "charPers"
  • "katPerm3"
  • "Pas"
  • "ohmPerm"
  • "radPers2"
  • "Btu"
  • "WPers"
  • "h"
  • "lPerl"
  • "l"
  • "As"
  • "cosPhi"
  • "W"
  • "count"
  • "PaPers"
  • "onePerHz"
  • "m3Pers"
  • "KPers"
  • "Vs"
  • "m2Pers"
  • "Ah"
  • "deg"
  • "mPers2"
  • "lm"
  • "d"
  • "JPerkgK"
  • "m"
  • "min"
  • "dB"
  • "Gy"
  • "Nm"
  • "JPerm3"
  • "sPers"
  • "Q"
  • "rev"
  • "N"
  • "Bq"
  • "WPermK"
  • "GyPers"
  • "HPerm"
  • "molPerkg"
  • "molPerm3"
  • "Wb"
  • "VPerm"
  • "WPerm2"
  • "kn"
  • "CPerm2"
  • "anglemin"
  • "Oe"
  • "kgm"
  • "character"
  • "APerA"
  • "A2s"
  • "Qh"
  • "JPers"
  • "Hz"
  • "rad"
  • "kat"
  • "degC"
  • "bar"
  • "M"
  • "molPermol"
  • "kgPerJ"
  • "J"
  • "HzPers"
  • "WPersr"
  • "anglesec"
  • "F"
  • "Mx"
  • "ha"
  • "SPerm"
  • "gal"
  • "mmHg"
  • "m2"
  • "mPers"
  • "V2h"
  • "m3"
  • "G"
  • "H"
  • "mol"
  • "rotPers"
  • "VAh"
  • "mPerm3"
  • "onePerm"
  • "V2"
  • "WPerA"
  • "Pa"
  • "kgPerm3"
  • "CPerm3"
  • "Sv"
  • "S"
  • "JPermolK"
  • "ft3"
  • "Wh"
  • "radPers"
  • "ohmm"
  • "kgm2"
  • "m3Perh"
  • "dBm"
  • "VA"
  • "A2"
  • "s"
  • "therm"
  • "VArh"
  • "cd"
  • "VPerV"
  • "gPerg"
  • "kg"
  • "A"
  • "m3Uncompensated"
  • "ppm"
  • "FPerm"
  • "C"
  • "sr"
  • "none"
  • "VPerVAr"
  • "VAr"
  • "VPerVA"
  • "lPers"

root BatteryUnit.storedE
Type: object or number

Amount of energy currently stored. The attribute shall be a positive value or zero and lower than BatteryUnit.ratedE.

Same definition as BatteryUnit.ratedE

root Equipment.aggregate
Type: boolean

The aggregate flag provides an alternative way of representing an aggregated (equivalent) element. It is applicable in cases when the dedicated classes for equivalent equipment do not have all of the attributes necessary to represent the required level of detail. In case the flag is set to “true” the single instance of equipment represents multiple pieces of equipment that have been modelled together as an aggregate equivalent obtained by a network reduction procedure. Examples would be power transformers or synchronous machines operating in parallel modelled as a single aggregate power transformer or aggregate synchronous machine.
The attribute is not used for EquivalentBranch, EquivalentShunt and EquivalentInjection.

root Equipment.networkAnalysisEnabled
Type: boolean

The equipment is enabled to participate in network analysis. If unspecified, the value is assumed to be true.

root Equipment.normallyInService
Type: boolean

Specifies the availability of the equipment under normal operating conditions. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

root Ravens.CimObjectType
Type: string

Used in RAVENS Schema to identify the corresponding CIM Object Type of the JSON object.

root InefficientBatteryUnit.efficiencyDischarge
Type: object or number

nan

root InefficientBatteryUnit.efficiencyDischarge value
Type: number Default: null

Normally 0 to 100 on a defined base.

root InefficientBatteryUnit.efficiencyDischarge unit
Type: enum (of string) Default: "none"

nan

Same definition as unit

root BatteryUnit.batteryState
Type: enum (of string)

The current state of the battery (charging, full, etc.).

Must be one of:

  • "charging"
  • "empty"
  • "discharging"
  • "waiting"
  • "full"

root PowerElectronicsUnit.maxP
Type: object or number

Maximum active power limit. This is the maximum (nameplate) limit for the unit.

root PowerElectronicsUnit.maxP value
Type: number Default: null

nan

root PowerElectronicsUnit.maxP unit
Type: enum (of string) Default: "W"

nan

Same definition as unit

root PowerElectronicsUnit.maxP multiplier
Type: enum (of string) Default: "none"

nan

Same definition as multiplier

root PowerElectronicsUnit.minP
Type: object or number

Minimum active power limit. This is the minimum (nameplate) limit for the unit.

Same definition as PowerElectronicsUnit.maxP

root Equipment.inService
Type: boolean

Specifies the availability of the equipment. True means the equipment is available for topology processing, which determines if the equipment is energized or not. False means that the equipment is treated by network applications as if it is not in the model.

root IdentifiedObject.description
Type: string

The description is a free human readable text describing or naming the object. It may be non unique and may not correlate to a naming hierarchy.

root IdentifiedObject.aliasName
Type: string

The aliasName is free text human readable name of the object alternative to IdentifiedObject.name. It may be non unique and may not correlate to a naming hierarchy.
The attribute aliasName is retained because of backwards compatibility between CIM relases. It is however recommended to replace aliasName with the Name class as aliasName is planned for retirement at a future time.

root IdentifiedObject.mRID
Type: string

Master resource identifier issued by a model authority. The mRID is unique within an exchange context. Global uniqueness is easily achieved by using a UUID, as specified in RFC 4122, for the mRID. The use of UUID is strongly recommended.
For CIMXML data files in RDF syntax conforming to IEC 61970-552, the mRID is mapped to rdf:ID or rdf:about attributes that identify CIM object elements.

root IdentifiedObject.name
Type: string

The name is any free human readable and possibly non unique text naming the object.