communication_components_pb2

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2

Generated protocol buffer code.

Attributes

frequenz.api.common.v1alpha7.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.v1alpha7.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.v1alpha7.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.v1alpha7.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.v1alpha7.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.v1alpha7.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.v1alpha7.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.

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_AUTHENTICATION_ERR module-attribute

Authentication error (e.g., invalid credentials, certificate issues).

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_CONFIGURATION_ERR module-attribute

Configuration error detected (e.g., invalid VLAN, IP conflict).

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_HARDWARE_GENERIC_FAULT module-attribute

Hardware fault reported by device (e.g., port error, cable disconnected).

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_HIGH_LATENCY module-attribute

Excessive latency observed (e.g., ping time above threshold).

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_OVER_TEMPERATURE module-attribute

Hardware fault due to overheating.

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_PACKET_LOSS module-attribute

High packet loss detected over a sustained period.

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_UNKNOWN module-attribute

Communication component is unknown. This could happen in cases where the status could be read from the component, but it could not be identified as a known state.

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_UNREACHABLE module-attribute

Component is unreachable (e.g., no heartbeat from device, network down).

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_UNSPECIFIED module-attribute

Default value; no specific diagnostic is specified.

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_STATE_CODE_CONNECTING module-attribute

The component is in the process of establishing connections.

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_STATE_CODE_DEGRADED module-attribute

The component is up but experiencing degraded performance (e.g., high packet loss).

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_STATE_CODE_DISCONNECTING module-attribute

The component is in the process of shutting down connections.

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_STATE_CODE_MAINTENANCE module-attribute

The component is undergoing maintenance (e.g., firmware upgrade).

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_STATE_CODE_OFFLINE module-attribute

The component is powered off, unreachable, or administratively disabled.

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_STATE_CODE_ONLINE module-attribute

The component is powered on and responding to network traffic.

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_STATE_CODE_UNKNOWN module-attribute

The component's internal status is unknown.

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.COMMUNICATION_COMPONENT_STATE_CODE_UNSPECIFIED module-attribute

Default unset value.

Classes

frequenz.api.common.v1alpha7.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.v1alpha7.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.

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.CommunicationComponentDiagnostic

Bases: Message

Represents an error or warning condition reported by a microgrid communication component.

This message extends a standardized diagnostic code with optional vendor-specific codes and contextual information for troubleshooting.

Typical Communication Component Warning

{
  "diagnosticCode": "COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_CONFIGURATION_ERR",
  "vendorDiagnosticCode": "ERR_1002",
  "message": "VLAN mismatch detected on port 3"
}

Vendor-Specific Codes

When available, vendor_error_code reflects manufacturer-defined error identifiers. These codes are vendor- and firmware-specific and must be interpreted using the vendor's official documentation.

Attributes

diagnostic_code instance-attribute

A standardized diagnostic code representing the category of the issue.

message instance-attribute

Human-readable message providing additional context.

vendor_diagnostic_code instance-attribute

Optional vendor-provided code for more granular diagnostics.

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.CommunicationComponentDiagnosticCode

Bases: _CommunicationComponentDiagnosticCode

Enumerated diagnostic codes for communication components.

These codes indicate common network- or device-level faults that may affect connectivity.

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.CommunicationComponentStateCode

Bases: _CommunicationComponentStateCode

Defines the high-level operational state of a communication component. These codes can be used in a one-shot snapshot to show its current condition.

frequenz.api.common.v1alpha7.microgrid.communication_components.communication_components_pb2.CommunicationComponentStateSnapshot

Bases: Message

A single snapshot of a communication component's state, diagnostics, and timing.

snapshot semantics

all fields in this message represent the component's view at one point in time, so there is only a single snapshot_time. any parallel reads happening to produce this data are collapsed under that timestamp.

Attributes

errors property

critical errors currently affecting the component.

Note

an error state code should accompany entries here.

origin_time property

The UTC time when the state was originally captured.

states property

one or more high-level state codes active at snapshot_time.

Note

typical usage is a single state (e.g., online), but multiple may apply (e.g., connecting + degraded) if that makes sense.

warnings property

non-critical warnings detected for the component.

Note

warnings may coexist with an online state, indicating potential issues that do not prevent basic operation.