Skip to content

Protocol Documentation¤

Table of Contents¤

Top

frequenz/api/common/v1alpha7/microgrid/microgrid.proto¤

Microgrid¤

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.

!!! info "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.

Field Type Label Description
id uint64 Unique identifier of the microgrid.
enterprise_id uint64 Unique identifier linking this microgrid to its parent enterprise account.
name string Name of the microgrid.
delivery_area frequenz.api.common.v1alpha7.grid.DeliveryArea 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. | | location | frequenz.api.common.v1alpha7.type.Location | | Physical location of the microgrid, in geographical co-ordinates.

If the location is not known, this field will be missing. | | status | MicrogridStatus | | The current status of the microgrid. | | create_timestamp | google.protobuf.Timestamp | | The UTC timestamp indicating when the microgrid was initially created. |

MicrogridComponentIDs¤

A message to link component IDs with their respective microgrid ID.

Field Type Label Description
microgrid_id uint64 The ID of the microgrid.
component_ids uint64 repeated List of component IDs belonging to this microgrid.

MicrogridSensorIDs¤

A message to link sensor IDs with their respective microgrid ID.

Field Type Label Description
microgrid_id uint64 The ID of the microgrid.
sensor_ids uint64 repeated List of sensor IDs belonging to this microgrid.

MicrogridStatus¤

MicrogridStatus defines the possible statuses for a microgrid.

Name Number Description
MICROGRID_STATUS_UNSPECIFIED 0 The status is unspecified. This should not be used.
MICROGRID_STATUS_ACTIVE 1 The microgrid is active.
MICROGRID_STATUS_INACTIVE 2 The microgrid is inactive.

Scalar Value Types¤

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)