Skip to content

Protocol Documentation¤

Table of Contents¤

Top

frequenz/api/assets/v1/assets.proto¤

GetMicrogridRequest¤

GetMicrogridRequest is the input parameter for fetching details given a specific microgrid.

Field Type Label Description
microgrid_id uint64 The unique identifier of the microgrid for which to fetch details.

GetMicrogridResponse¤

GetMicrogridResponse is the response for fetching details given a specific microgrid.

Field Type Label Description
microgrid frequenz.api.common.v1.microgrid.Microgrid Details of the requested microgrid.

ListMicrogridElectricalComponentConnectionsRequest¤

ListMicrogridElectricalComponentConnectionsRequest is used for filtering and listing the electrical connections between components in a specific microgrid. These connections can be used to construct a component graph of the microgrid.

!!! note "Component Graph" A component graph in the context of a microgrid refers to a directed graph where the nodes represent electrical components (like generators, batteries, or loads) and the edges represent electrical connections between them. The edges are directional, pointing away from the grid-connection point (or the root point for island microgrids). This means that for each edge, the source component is towards the grid connection point, and the destination component is pointing towards an underlying component. This graph provides a structured view of how electrical energy flows within the microgrid.

!!! note "Filtering" Filtering can be done based on the source_component_id or destination_component_id. If these fields are left empty, connections with any source or destination will be returned.

Field Type Label Description
microgrid_id uint64 Mandatory field. The ID of the microgrid for which connections are to be listed.
source_component_ids uint64 repeated Only return connections that originate from these component IDs. If empty, no filtering is applied.
destination_component_ids uint64 repeated Only return connections that terminate at these component IDs. If empty, no filtering is applied.

ListMicrogridElectricalComponentConnectionsResponse¤

ListMicrogridElectricalComponentConnectionsResponse holds the list of electrical connections that match the filter criteria specified in the ListMicrogridElectricalComponentConnectionsRequest.

Field Type Label Description
microgrid_id uint64 The ID of the microgrid for which connections are returned.
connections frequenz.api.common.v1.microgrid.electrical_components.ElectricalComponentConnection repeated Contains the list of connections that match the filtering criteria.

ListMicrogridElectricalComponentsRequest¤

Request parameters for the RPC ListMicrogridElectricalComponents.

Field Type Label Description
microgrid_id uint64 Mandatory field. The ID of the microgrid for which components are to be listed.
component_ids uint64 repeated Return components that have the specified IDs only.
categories frequenz.api.common.v1.microgrid.electrical_components.ElectricalComponentCategory repeated Return components that have the specified categories only.

ListMicrogridElectricalComponentsResponse¤

A message containing a list of electrical components.

Field Type Label Description
microgrid_id uint64 Unique microgrid identifier used in the request.
components frequenz.api.common.v1.microgrid.electrical_components.ElectricalComponent repeated List of electrical components matching the filter criteria.

PlatformAssets¤

Service providing access to manage and retrieve information related to gridpools and microgrids, and other platform assets.

Method Name Request Type Response Type Description
GetMicrogrid GetMicrogridRequest GetMicrogridResponse Returns details of a specific microgrid.
ListMicrogridElectricalComponents ListMicrogridElectricalComponentsRequest ListMicrogridElectricalComponentsResponse Returns list of a electrical components for a specific microgrid.
ListMicrogridElectricalComponentConnections ListMicrogridElectricalComponentConnectionsRequest ListMicrogridElectricalComponentConnectionsResponse Returns a list of the connections between electrical components for a specific microgrid.

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)