Battery Equipment

Battery Equipment#

pydantic model gdm.distribution.equipment.BatteryEquipment#

Data model for Solar Model.

Show JSON schema
{
   "title": "BatteryEquipment",
   "description": "Data model for Solar Model.",
   "type": "object",
   "properties": {
      "uuid": {
         "format": "uuid",
         "title": "Uuid",
         "type": "string"
      },
      "name": {
         "title": "Name",
         "type": "string"
      },
      "rated_energy": {
         "default": null,
         "description": "Rated energy capacity (DC) of the battery.",
         "title": "Rated Energy",
         "type": "string"
      },
      "rated_power": {
         "default": null,
         "description": "Rated power of the battery",
         "title": "Rated Power",
         "type": "string"
      },
      "charging_efficiency": {
         "description": "Charging efficiency of the battery.",
         "maximum": 100.0,
         "minimum": 0.0,
         "title": "Charging Efficiency",
         "type": "number"
      },
      "discharging_efficiency": {
         "description": "Discharging efficiency of the battery.",
         "maximum": 100.0,
         "minimum": 0.0,
         "title": "Discharging Efficiency",
         "type": "number"
      },
      "idling_efficiency": {
         "description": "Idling efficiency of the battery.",
         "maximum": 100.0,
         "minimum": 0.0,
         "title": "Idling Efficiency",
         "type": "number"
      },
      "rated_voltage": {
         "description": "Rated voltage for this battery equipment.",
         "ge": 0,
         "title": "Rated Voltage"
      },
      "voltage_type": {
         "$ref": "#/$defs/VoltageTypes",
         "description": "Rated voltage is line to line or line to neutral."
      }
   },
   "$defs": {
      "VoltageTypes": {
         "description": "Identifier of voltage types referenced in distribution models.",
         "enum": [
            "line-to-line",
            "line-to-ground"
         ],
         "title": "VoltageTypes",
         "type": "string"
      }
   },
   "additionalProperties": false,
   "required": [
      "name",
      "rated_energy",
      "rated_power",
      "charging_efficiency",
      "discharging_efficiency",
      "idling_efficiency",
      "rated_voltage",
      "voltage_type"
   ]
}

Config:

  • str_strip_whitespace: bool = True

  • validate_assignment: bool = True

  • validate_default: bool = True

  • extra: str = forbid

  • use_enum_values: bool = False

  • arbitrary_types_allowed: bool = True

  • populate_by_name: bool = True

Fields:

  • charging_efficiency (float)

  • discharging_efficiency (float)

  • idling_efficiency (float)

  • name (str)

  • rated_energy (gdm.quantities.EnergyDC)

  • rated_power (infrasys.quantities.ActivePower)

  • rated_voltage (infrasys.quantities.Voltage)

  • uuid (uuid.UUID)

  • voltage_type (gdm.distribution.enums.VoltageTypes)

field charging_efficiency: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Charging efficiency of the battery.', metadata=[Ge(ge=0), Le(le=100)])] [Required]#

Charging efficiency of the battery.

Constraints:

  • ge = 0

  • le = 100

field discharging_efficiency: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Discharging efficiency of the battery.', metadata=[Ge(ge=0), Le(le=100)])] [Required]#

Discharging efficiency of the battery.

Constraints:

  • ge = 0

  • le = 100

field idling_efficiency: Annotated[float, FieldInfo(annotation=NoneType, required=True, description='Idling efficiency of the battery.', metadata=[Ge(ge=0), Le(le=100)])] [Required]#

Idling efficiency of the battery.

Constraints:

  • ge = 0

  • le = 100

field rated_energy: ')] [Required]#

Rated energy capacity (DC) of the battery.

Constraints:

  • json_schema = {‘type’: ‘string’, ‘default’: None}

field rated_power: WithJsonSchema(json_schema={'type': 'string', 'default': None}, mode=None), FieldInfo(annotation=NoneType, required=True, description='Rated power of the battery', metadata=[Ge(ge=0)])] [Required]#

Rated power of the battery

Constraints:

  • json_schema = {‘type’: ‘string’, ‘default’: None}

  • ge = 0

field rated_voltage: Annotated[Voltage, FieldInfo(annotation=NoneType, required=True, description='Rated voltage for this battery equipment.', metadata=[Ge(ge=0)])] [Required]#

Rated voltage for this battery equipment.

Constraints:

  • ge = 0

field voltage_type: Annotated[VoltageTypes, FieldInfo(annotation=NoneType, required=True, description='Rated voltage is line to line or line to neutral.')] [Required]#

Rated voltage is line to line or line to neutral.

Contents