microgrid_pb2
frequenz.api.common.v1.microgrid.microgrid_pb2
¤
Generated protocol buffer code.
Attributes¤
frequenz.api.common.v1.microgrid.microgrid_pb2.MICROGRID_STATUS_ACTIVE
module-attribute
¤
The microgrid is active.
frequenz.api.common.v1.microgrid.microgrid_pb2.MICROGRID_STATUS_INACTIVE
module-attribute
¤
The microgrid is inactive.
frequenz.api.common.v1.microgrid.microgrid_pb2.MICROGRID_STATUS_UNSPECIFIED
module-attribute
¤
The status is unspecified. This should not be used.
Classes¤
frequenz.api.common.v1.microgrid.microgrid_pb2.Microgrid
¤
Bases: Message
Microgrid contains details of a specific microgrid. A microgrid is a localized grouping of electricity generation, energy storage, and loads that normally operates connected to a traditional centralized grid. Each microgrid has a unique identifier and is associated with an enterprise account. A key feature is that it has a physical location and is situated in a delivery area.
Key Concepts
Physical Location: Geographical coordinates specify the exact physical location of the microgrid.Delivery Area: Each microgrid is part of a broader delivery area, which is crucial for energy trading and compliance.
Attributes¤
create_timestamp
property
¤
The UTC timestamp indicating when the microgrid was initially created.
delivery_area
property
¤
The delivery area where the microgrid is located, as identified by a specific code.
If a microgrid is not connected to the grid (it is an island) it does not belong to any delivery area and this field will be missing, but it could be missing for other reasons as well.
enterprise_id
instance-attribute
¤
Unique identifier linking this microgrid to its parent enterprise account.
id
instance-attribute
¤
Unique identifier of the microgrid.
location
property
¤
Physical location of the microgrid, in geographical co-ordinates.
If the location is not known, this field will be missing.
name
instance-attribute
¤
Name of the microgrid.
status
instance-attribute
¤
The current status of the microgrid.