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 frequenz/api/assets/v1/assets_pb2.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
from frequenz.api.common.v1.microgrid import microgrid_pb2 as frequenz_dot_api_dot_common_dot_v1_dot_microgrid_dot_microgrid__pb2


DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n#frequenz/api/assets/v1/assets.proto\x12\x16\x66requenz.api.assets.v1\x1aRfrequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto\x1a\x30\x66requenz/api/common/v1/microgrid/microgrid.proto\"+\n\x13GetMicrogridRequest\x12\x14\n\x0cmicrogrid_id\x18\x01 \x01(\x04\"V\n\x14GetMicrogridResponse\x12>\n\tmicrogrid\x18\x01 \x01(\x0b\x32+.frequenz.api.common.v1.microgrid.Microgrid\"\xc0\x01\n(ListMicrogridElectricalComponentsRequest\x12\x14\n\x0cmicrogrid_id\x18\x01 \x01(\x04\x12\x15\n\rcomponent_ids\x18\x02 \x03(\x04\x12g\n\ncategories\x18\x03 \x03(\x0e\x32S.frequenz.api.common.v1.microgrid.electrical_components.ElectricalComponentCategory\"\xa2\x01\n)ListMicrogridElectricalComponentsResponse\x12\x14\n\x0cmicrogrid_id\x18\x01 \x01(\x04\x12_\n\ncomponents\x18\x02 \x03(\x0b\x32K.frequenz.api.common.v1.microgrid.electrical_components.ElectricalComponent\"\x8b\x01\n2ListMicrogridElectricalComponentConnectionsRequest\x12\x14\n\x0cmicrogrid_id\x18\x01 \x01(\x04\x12\x1c\n\x14source_component_ids\x18\x02 \x03(\x04\x12!\n\x19\x64\x65stination_component_ids\x18\x03 \x03(\x04\"\xb7\x01\n3ListMicrogridElectricalComponentConnectionsResponse\x12\x14\n\x0cmicrogrid_id\x18\x01 \x01(\x04\x12j\n\x0b\x63onnections\x18\x02 \x03(\x0b\x32U.frequenz.api.common.v1.microgrid.electrical_components.ElectricalComponentConnection2\xef\x03\n\x0ePlatformAssets\x12i\n\x0cGetMicrogrid\x12+.frequenz.api.assets.v1.GetMicrogridRequest\x1a,.frequenz.api.assets.v1.GetMicrogridResponse\x12\xa8\x01\n!ListMicrogridElectricalComponents\x12@.frequenz.api.assets.v1.ListMicrogridElectricalComponentsRequest\x1a\x41.frequenz.api.assets.v1.ListMicrogridElectricalComponentsResponse\x12\xc6\x01\n+ListMicrogridElectricalComponentConnections\x12J.frequenz.api.assets.v1.ListMicrogridElectricalComponentConnectionsRequest\x1aK.frequenz.api.assets.v1.ListMicrogridElectricalComponentConnectionsResponseb\x06proto3')

_globals = globals()
_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=197
  _globals['_GETMICROGRIDREQUEST']._serialized_end=240
  _globals['_GETMICROGRIDRESPONSE']._serialized_start=242
  _globals['_GETMICROGRIDRESPONSE']._serialized_end=328
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTSREQUEST']._serialized_start=331
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTSREQUEST']._serialized_end=523
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTSRESPONSE']._serialized_start=526
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.

Source code in frequenz/api/assets/v1/assets_pb2.py 
46
47
48
49
50
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTCONNECTIONSRESPONSE']._serialized_start=833
  _globals['_LISTMICROGRIDELECTRICALCOMPONENTCONNECTIONSRESPONSE']._serialized_end=1016
  _globals['_PLATFORMASSETS']._serialized_start=1019
  _globals['_PLATFORMASSETS']._serialized_end=1514
# @@protoc_insertion_point(module_scope)
Attributes¤
microgrid property ¤
microgrid: Microgrid

Details of the requested microgrid.

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

Bases: Message

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.

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¤
destination_component_ids property ¤
destination_component_ids: RepeatedScalarFieldContainer[int]

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

microgrid_id instance-attribute ¤
microgrid_id: int

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

source_component_ids property ¤
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¤
connections property ¤
connections: RepeatedCompositeFieldContainer[
    ElectricalComponentConnection
]

Contains the list of connections that match the filtering criteria.

microgrid_id instance-attribute ¤
microgrid_id: int

The ID of the microgrid for which connections are returned.

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

Bases: Message

Request parameters for the RPC ListMicrogridElectricalComponents.

Attributes¤
categories property ¤
categories: RepeatedScalarFieldContainer[ValueType]

Return components that have the specified categories only.

component_ids property ¤
component_ids: RepeatedScalarFieldContainer[int]

Return components that have the specified IDs only.

microgrid_id instance-attribute ¤
microgrid_id: int

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

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

Bases: Message

A message containing a list of electrical components.

Attributes¤
components property ¤
components: RepeatedCompositeFieldContainer[
    ElectricalComponent
]

List of electrical components matching the filter criteria.

microgrid_id instance-attribute ¤
microgrid_id: int

Unique microgrid identifier used in the request.