Skip to content

assets_pb2

frequenz.api.assets.v1.assets_pb2 ¤

Generated protocol buffer code.

Classes¤

frequenz.api.assets.v1.assets_pb2.GetMicrogridRequest ¤

Bases: Message

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

Source code in py/frequenz/api/assets/v1/assets_pb2.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
_builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
_builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'frequenz.api.assets.v1.assets_pb2', _globals)
if not _descriptor._USE_C_DESCRIPTORS:
  DESCRIPTOR._loaded_options = None
  _globals['_GETMICROGRIDREQUEST']._serialized_start=209
  _globals['_GETMICROGRIDREQUEST']._serialized_end=252
  _globals['_GETMICROGRIDRESPONSE']._serialized_start=254
  _globals['_GETMICROGRIDRESPONSE']._serialized_end=346
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTSREQUEST']._serialized_start=349
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTSREQUEST']._serialized_end=547
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTSRESPONSE']._serialized_start=550
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTSRESPONSE']._serialized_end=718
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTCONNECTIONSREQUEST']._serialized_start=721
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTCONNECTIONSREQUEST']._serialized_end=860
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTCONNECTIONSRESPONSE']._serialized_start=863
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTCONNECTIONSRESPONSE']._serialized_end=1052
  _globals['_PLATFORMASSETS']._serialized_start=1055
  _globals['_PLATFORMASSETS']._serialized_end=1550
# @@protoc_insertion_point(module_scope)
Attributes¤
microgrid_id instance-attribute ¤
microgrid_id: int

The unique identifier of the microgrid for which to fetch details.

frequenz.api.assets.v1.assets_pb2.GetMicrogridResponse ¤

Bases: Message

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

Functions¤
microgrid ¤
microgrid() -> Microgrid

Details of the requested microgrid.

frequenz.api.assets.v1.assets_pb2.ListMicrogridElectricalComponentConnectionsRequest ¤

Bases: Message

ListMicrogridElectricalComponentConnectionsRequest is used for listing the electrical connections between components in a microgrid. Connections define a directed graph of electrical energy flow.

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.

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.

Attributes¤
microgrid_id instance-attribute ¤
microgrid_id: int

Mandatory field. The ID of the microgrid for which connections are to be listed.

Functions¤
destination_component_ids ¤
destination_component_ids() -> (
    RepeatedScalarFieldContainer[int]
)

Only return connections that terminate at these component IDs. If empty, no filtering is applied.

source_component_ids ¤
source_component_ids() -> RepeatedScalarFieldContainer[int]

Only return connections that originate from these component IDs. If empty, no filtering is applied.

frequenz.api.assets.v1.assets_pb2.ListMicrogridElectricalComponentConnectionsResponse ¤

Bases: Message

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

Attributes¤
microgrid_id instance-attribute ¤
microgrid_id: int

The ID of the microgrid for which connections are returned.

Functions¤
connections ¤
connections() -> (
    RepeatedCompositeFieldContainer[
        ElectricalComponentConnection
    ]
)

Contains the list of connections that match the filtering criteria.

frequenz.api.assets.v1.assets_pb2.ListMicrogridElectricalComponentsRequest ¤

Bases: Message

Request parameters for the RPC ListMicrogridElectricalComponents.

Attributes¤
microgrid_id instance-attribute ¤
microgrid_id: int

Mandatory field. The ID of the microgrid for which components are to be listed.

Functions¤
categories ¤
categories() -> RepeatedScalarFieldContainer[ValueType]

Return components that have the specified categories only.

component_ids ¤
component_ids() -> RepeatedScalarFieldContainer[int]

Return components that have the specified IDs only.

frequenz.api.assets.v1.assets_pb2.ListMicrogridElectricalComponentsResponse ¤

Bases: Message

A message containing a list of electrical components.

Attributes¤
microgrid_id instance-attribute ¤
microgrid_id: int

Unique microgrid identifier used in the request.

Functions¤
components ¤
components() -> (
    RepeatedCompositeFieldContainer[ElectricalComponent]
)

List of electrical components matching the filter criteria.