Skip to content

delivery_area_pb2

frequenz.api.common.v1.grid.delivery_area_pb2 ¤

Generated protocol buffer code.

Attributes¤

frequenz.api.common.v1.grid.delivery_area_pb2.ENERGY_MARKET_CODE_TYPE_EUROPE_EIC: EnergyMarketCodeType.ValueType module-attribute ¤

European Energy Identification Code Standard.

frequenz.api.common.v1.grid.delivery_area_pb2.ENERGY_MARKET_CODE_TYPE_UNSPECIFIED: EnergyMarketCodeType.ValueType module-attribute ¤

Unspecified type. This value is a placeholder and should not be used.

frequenz.api.common.v1.grid.delivery_area_pb2.ENERGY_MARKET_CODE_TYPE_US_NERC: EnergyMarketCodeType.ValueType module-attribute ¤

North American Electric Reliability Corporation identifiers.

Classes¤

frequenz.api.common.v1.grid.delivery_area_pb2.DeliveryArea ¤

Bases: Message

DeliveryArea represents the geographical or administrative region, usually defined and maintained by a Transmission System Operator (TSO), where electricity deliveries for a contract occur.

The concept is important to energy trading as it delineates the agreed-upon delivery location. Delivery areas can have different codes based on the// jurisdiction in which they operate.

Jurisdictional Differences

This is typically represented by specific codes according to local jurisdiction. In Europe, this is represented by an EIC (Energy Identification Code).

Attributes¤
code: builtins.str instance-attribute ¤

Code representing the unique identifier for the delivery area.

code_type: global___EnergyMarketCodeType.ValueType instance-attribute ¤

Type of code used for identifying the delivery area itself.

frequenz.api.common.v1.grid.delivery_area_pb2.EnergyMarketCodeType ¤

Bases: _EnergyMarketCodeType

CodeType specifies the type of identification code used for uniquely identifying various entities such as delivery areas, market participants, and grid components within the energy market. This enumeration aims to offer compatibility across different jurisdictional standards.

Understanding Code Types

Different regions or countries may have their own standards for uniquely identifying various entities within the energy market. For example, in Europe, the Energy Identification Code (EIC) is commonly used for this purpose.

Extensibility

New code types can be added to this enum to accommodate additional regional standards, enhancing the API's adaptability.

Validation Required

The chosen code type should correspond correctly with the code field in the relevant message objects, such as DeliveryArea or Counterparty. Failure to match the code type with the correct code could lead to processing errors.