communication_components_pb2
frequenz.api.common.v1.microgrid.communication_components.communication_components_pb2
¤
Generated protocol buffer code.
Attributes¤
frequenz.api.common.v1.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_CATEGORY_DIO_GATEWAY
module-attribute
¤
Digital Input/Output (DIO) Gateway enabling communication and control of digital signals between microgrid devices.
frequenz.api.common.v1.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_CATEGORY_ETHERNET_SWITCH
module-attribute
¤
Ethernet Switch enabling wired network connections within the microgrid.
frequenz.api.common.v1.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_CATEGORY_MODBUS_GATEWAY
module-attribute
¤
Modbus Gateway used for protocol translation and managing Modbus communication.
frequenz.api.common.v1.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_CATEGORY_PLC
module-attribute
¤
Programmable Logic Controller (PLC) used for automation tasks, process control, and operational logic in the microgrid.
frequenz.api.common.v1.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_CATEGORY_ROUTER
module-attribute
¤
LTE Router providing cellular connectivity (LTE, 4G, 5G) for the microgrid.
frequenz.api.common.v1.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_CATEGORY_SERIAL_GATEWAY
module-attribute
¤
Serial Gateway (RS-232, RS-485, etc.) facilitating serial communication between legacy equipment and modern network infrastructures.
frequenz.api.common.v1.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_CATEGORY_UNSPECIFIED
module-attribute
¤
Unspecified communication component category.
Caution
This default value should never be used explicitly and indicates that the category has not been properly defined.
Classes¤
frequenz.api.common.v1.microgrid.communication_components.communication_components_pb2.CommunicationComponent
¤
Bases: Message
CommunicationComponent
represents a communication component within a
microgrid.
Communication components are networked devices responsible for enabling communication between electrical components, sensors, controllers, and other network devices.
Attributes¤
category
instance-attribute
¤
Category identifying the type of the communication component.
id
instance-attribute
¤
Unique identifier of the communication component.
ip_addresses
property
¤
List of IP addresses assigned to this communication component.
microgrid_id
instance-attribute
¤
Unique identifier of the parent microgrid.
name
instance-attribute
¤
Human-readable name of the communication component.
frequenz.api.common.v1.microgrid.communication_components.communication_components_pb2.CommunicationComponentCategory
¤
Bases: _CommunicationComponentCategory
CommunicationComponentCategory
enumerates possible types of communication
components within the microgrid.
Categories help distinguish communication devices according to their roles, capabilities, and protocols they handle within the microgrid infrastructure.