electrical_components_pb2
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2
¤
Generated protocol buffer code.
Attributes¤
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.BATTERY_TYPE_LI_ION
module-attribute
¤
Li-ion batteries.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.BATTERY_TYPE_NA_ION
module-attribute
¤
Sodium-ion batteries
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.BATTERY_TYPE_UNSPECIFIED
module-attribute
¤
Unspecified.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_BATTERY
module-attribute
¤
A battery energy storage system.
Stores electrical energy and can be dispatched for load balancing, backup, or arbitrage. Remotely controllable for charging, discharging, and operational mode. Examples: Tesla Megapack, LG Chem RESU, etc.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_BREAKER
module-attribute
¤
A circuit breaker.
Provides protection and switching by disconnecting circuits as needed. Remotely controllable for opening/closing and status monitoring. Examples: Finder Series 62, Phoenix Contact PLC-Interface, Siemens Sirius, Schneider Electric Zelio, etc.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_CAPACITOR_BANK
module-attribute
¤
A capacitor bank for power factor correction.
Improves power quality by compensating reactive power. Remotely controllable for switching capacitors in or out. Examples: Siemens 3FK, ABB Capacitor Banks, Schneider Electric VarSet, Eaton PowerXL.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_CHP
module-attribute
¤
A combined heat and power (CHP) plant.
Generates electricity and useful heat from a single energy source. Remotely controllable for start/stop commands and setpoint adjustments. Examples: 2G Agenitor, Viessmann Vitobloc, TEDOM Micro series, Bosch CHP.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_CONVERTER
module-attribute
¤
A DC-DC converter.
Converts electrical energy between different DC voltage levels. Typically remotely controllable for voltage, current, or mode adjustment. Examples: Victron Orion, Delta Electronics DC-DC converters, TDK Lambda.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_CRYPTO_MINER
module-attribute
¤
A crypto miner.
Consumes power for blockchain computations and can be remotely curtailed or powered down. Examples: Bitmain Antminer, MicroBT WhatsMiner, Canaan AvalonMiner.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_ELECTROLYZER
module-attribute
¤
An electrolyzer.
Converts electrical energy into hydrogen and oxygen by electrolyzing water. Remotely controllable for operating mode and production rate. Examples: Siemens Silyzer, Nel Hydrogen PEM, ITM Power electrolyzers.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_EV_CHARGER
module-attribute
¤
An EV charger.
Provides controlled charging for electric vehicles. Remotely controllable for starting/stopping charging and setting power limits. Examples: Alfen NG 9xx, KEBA KeContact P30, Siemens VersiCharge, etc.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_GRID_CONNECTION_POINT
module-attribute
¤
The point where the local microgrid is connected to the grid.
Represents the interface between a local microgrid and the public electricity grid, typically used for metering, protection, and isolation. This category itself is not remotely controllable, but can be associated with other devices (inverters, relays, etc.) that can be controlled to affect the grid connection point.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_HVAC
module-attribute
¤
An HVAC system (Heating, Ventilation, and Air Conditioning).
Manages indoor climate by controlling heating, cooling, and ventilation. Remotely controllable for setpoint and operational scheduling. Examples: Siemens Desigo, Trane Voyager, Daikin VRV, Schneider Electric SmartStruxure.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_INVERTER
module-attribute
¤
An inverter.
Converts DC to AC power and vice-versa, enabling integration of batteries, PV arrays, or other renewables. Remotely controllable via digital protocols for power setpoints, modes, and status. Examples: SMA Sunny Tripower, Kaco Blueplanet, Refu RefuStore88k, etc.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_METER
module-attribute
¤
A meter for measuring electrical parameters.
Measures electrical parameters such as voltage, current, power, energy, and frequency. Meters typically cannot be controlled remotely, but they can provide telemetry data. Examples: Janitza UMG 604, Janitza B24, ABB B24, etc.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_PLC
module-attribute
¤
An industrial controller or PLC (Programmable Logic Controller).
Automates industrial processes, load shedding, and custom logic. Remotely controllable for process execution and telemetry via digital protocols. Examples: Siemens SIMATIC S7-1200/1500, Beckhoff CX-series IPC, Schneider M340, Wago PFC 200.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_PRECHARGER
module-attribute
¤
A pre-charge module.
Ramps up DC voltage gradually to protect components during power-up. Remotely controllable to initiate or manage the pre-charge sequence. Examples: Precharge modules from Bender, Precharge controllers by Elcon, custom PLC-controlled circuits.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_STATIC_TRANSFER_SWITCH
module-attribute
¤
A static transfer switch (STS).
Switches between multiple power sources with minimal transfer time to maintain continuity. Remotely controllable for source selection and transfer commands. Examples: Socomec ATyS, ABB TruONE, Eaton Automatic Transfer Switch, ASCO Series 7000.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_UNINTERRUPTIBLE_POWER_SUPPLY
module-attribute
¤
An uninterruptible power supply (UPS).
Provides immediate backup power with battery and inverter integration. Remotely controllable for status, diagnostics, and sometimes operational commands. Examples: APC Symmetra PX, Eaton 93PM, Schneider Electric Galaxy, Vertiv Liebert EXL.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_UNSPECIFIED
module-attribute
¤
The component category is unspecified. This should not be used.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_VOLTAGE_TRANSFORMER
module-attribute
¤
A voltage transformer.
Voltage transformers are used to step up or step down the voltage, keeping the power somewhat constant by increasing or decreasing the current. If voltage is stepped up, current is stepped down, and vice versa. Note that voltage transformers have efficiency losses, so the output power is always less than the input power.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_CATEGORY_WIND_TURBINE
module-attribute
¤
A wind turbine.
Converts wind energy into electricity. Remotely controllable (in most commercial systems) for start/stop, output regulation, and status. Examples: Siemens Gamesa SG, Vestas V series, GE Cypress, Nordex Delta.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_ARC_FAULT
module-attribute
¤
The component is inoperable due to arcing.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_BATTERY_BLOCK_ERROR
module-attribute
¤
At least one of the battery blocks is in an error state.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_BATTERY_CALIBRATION_NEEDED
module-attribute
¤
The battery needs calibration.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_BATTERY_CONTROLLER_ERROR
module-attribute
¤
The battery controller is in an error state.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_BATTERY_IMBALANCE
module-attribute
¤
There is a battery system imbalance.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_BATTERY_LOW_SOH
module-attribute
¤
The battery has a low state of health (SOH).
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_BATTERY_RELAY_ERROR
module-attribute
¤
The battery's DC contactor or relay is in an error state.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_CONFIG_ERROR
module-attribute
¤
The component has been configured incorrectly.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_EV_CHARGING_CABLE_INVALID
module-attribute
¤
The electric vehicle (EV) charging cable is invalid.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_EV_CHARGING_CABLE_LOCK_FAILED
module-attribute
¤
There is a cable lock failure with the electric vehicle (EV).
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_EV_CHARGING_CABLE_UNPLUGGED_FROM_EV
module-attribute
¤
The electric vehicle (EV) cable was abruptly unplugged from the vehicle.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_EV_CHARGING_CABLE_UNPLUGGED_FROM_STATION
module-attribute
¤
The electric vehicle (EV) cable was abruptly unplugged from the charging station.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_EV_CONSUMER_INCOMPATIBLE
module-attribute
¤
The incompatible electric vehicle (EV) charging plug is invalid.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_EV_UNEXPECTED_PILOT_FAILURE
module-attribute
¤
There is an unexpected pilot failure in an electric vehicle (EV) component.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_EXCESS_LEAKAGE_CURRENT
module-attribute
¤
There is excessive leakage current in the component. The threshold for excessive leakage current is defined by the component manufacturer.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_FAN_FAULT
module-attribute
¤
The component is inoperable due to its fan being faulty.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_FAULT_CURRENT
module-attribute
¤
A fault current has been detected in the component.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_FUSE_ERROR
module-attribute
¤
The component's fuse has blown.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_GRID_ABNORMAL
module-attribute
¤
The component is inoperable due to the grid being in a non-standard configuration.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_GRID_DISCONNECTED
module-attribute
¤
The component is inoperable due to the grid being disconnected, despite the AC relay being closed.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_GRID_OVERFREQUENCY
module-attribute
¤
The component is inoperable due to the grid frequency being too high.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_GRID_OVERVOLTAGE
module-attribute
¤
The component is inoperable due to the grid voltage being too high.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_GRID_UNDERFREQUENCY
module-attribute
¤
The component is inoperable due to the grid frequency being too low.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_GRID_UNDERVOLTAGE
module-attribute
¤
The component is inoperable due to the grid voltage being too low.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_GRID_VOLTAGE_IMBALANCE
module-attribute
¤
The component is inoperable due to the grid voltage being imbalanced. This happens when the voltage of one or more phases is outside the acceptable range.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_GROUND_FAULT
module-attribute
¤
The component is inoperable due to the faulty grounding.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_HARDWARE_FAULT
module-attribute
¤
The component is inoperable due to the component's hardware being faulty.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_HARDWARE_INACCESSIBLE
module-attribute
¤
The hardware of the component is inaccessible.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_HIGH_HUMIDITY
module-attribute
¤
The component is exposed to high humidity levels over the maximum rated value.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_ILLEGAL_COMPONENT_STATE_CODE_REQUESTED
module-attribute
¤
A illegal state has been requested for the component.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_INTERNAL
module-attribute
¤
There is an internal error within the component.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_INVERTER_DC_OVERVOLTAGE
module-attribute
¤
The inverter is inoperable due to the DC voltage being too high.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_INVERTER_DC_UNDERVOLTAGE
module-attribute
¤
The inverter is inoperable due to the DC voltage being too low.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_LOW_SYSTEM_INSULATION_RESISTANCE
module-attribute
¤
The component is inoperable due to the insulation resistance being too low. The threshold for low insulation resistance is defined by the component manufacturer, or can be configured by the user in the component.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_OVERCURRENT
module-attribute
¤
The component is drawing more current than the maximum rated value.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_OVERCURRENT_CHARGING
module-attribute
¤
The component's consumption current is over the maximum rated value during charging.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_OVERCURRENT_DISCHARGING
module-attribute
¤
The component's production current is over the maximum rated value during discharging.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_OVERTEMPERATURE
module-attribute
¤
The component is operating over the maximum rated temperature.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_OVERVOLTAGE
module-attribute
¤
The component is operating over the maximum rated voltage.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_PLAUSIBILITY_ERROR
module-attribute
¤
There are plausibility issues within the component, causing its internal sanity checks to fail.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_PRECHARGE_ERROR
module-attribute
¤
The component's precharge unit has failed.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_PROTECTIVE_SHUTDOWN
module-attribute
¤
The component is inoperable due to its hardware being faulty.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_PV_FAULT
module-attribute
¤
The PV panels have a fault. The component is not able to determine or specify the fault.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_PV_GROUND_FAULT
module-attribute
¤
The PV panels are not grounded properly.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_PV_REVERSAL_POLARITY
module-attribute
¤
The PV panels have been connected with reversed polarity.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_PV_REVERSE_CURRENT
module-attribute
¤
The PV panels are receiving a reverse current.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_PV_UNDERPERFORMANCE
module-attribute
¤
The PV panels are underperforming.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_RELAY_CYCLE_LIMIT_REACHED
module-attribute
¤
The battery's DC contactor or relays have reached end of life.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_SHORT_CIRCUIT
module-attribute
¤
A short circuit has been detected in the component.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_SWITCH_ON_FAULT
module-attribute
¤
The component could not be switched on.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_UNAUTHORIZED
module-attribute
¤
The component is unauthorized to perform the last requested action.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_UNDERTEMPERATURE
module-attribute
¤
The component is operating under the minimum rated temperature.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_UNDERVOLTAGE
module-attribute
¤
The component is operating under the minimum rated voltage.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_UNKNOWN
module-attribute
¤
The component is reporting an unknown or an undefined error, and the sender cannot parse the component error to any of the variants below.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_UNSPECIFIED
module-attribute
¤
Default value. No specific error is specified.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_CHARGING
module-attribute
¤
State when the component is actively consuming energy.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_DISCHARGING
module-attribute
¤
State when the component is actively producing or releasing energy.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_ERROR
module-attribute
¤
State when the component is in an error state and may need attention.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_EV_CHARGING_CABLE_LOCKED_AT_EV
module-attribute
¤
The EV charging cable is locked at the vehicle end, indicating that charging is active.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_EV_CHARGING_CABLE_LOCKED_AT_STATION
module-attribute
¤
The EV charging cable is locked at the charging station end, indicating readiness for charging.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_EV_CHARGING_CABLE_PLUGGED_AT_EV
module-attribute
¤
The EV charging cable is plugged into the vehicle.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_EV_CHARGING_CABLE_PLUGGED_AT_STATION
module-attribute
¤
The EV charging cable is plugged into the charging station.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_EV_CHARGING_CABLE_UNPLUGGED
module-attribute
¤
The Electric Vehicle (EV) charging cable is unplugged from the charging station.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_OFF
module-attribute
¤
State when the component has successfully switched off.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_PRECHARGER_CLOSED
module-attribute
¤
The precharger circuit is closed, allowing full current to flow to the main circuit.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_PRECHARGER_OPEN
module-attribute
¤
The precharger circuit is open, meaning it's not currently active.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_PRECHARGER_PRECHARGING
module-attribute
¤
The precharger is in a precharging state, preparing the main circuit for activation.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_READY
module-attribute
¤
State when the component is fully operational and ready for use.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_RELAY_CLOSED
module-attribute
¤
The relay is in a closed state, allowing current to flow.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_RELAY_OPEN
module-attribute
¤
The relay is in an open state, meaning no current can flow through.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_STANDBY
module-attribute
¤
State when the component is in standby mode, and not immediately ready for immediate operations.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_SWITCHING_OFF
module-attribute
¤
State when the component is in the process of switching off.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_SWITCHING_ON
module-attribute
¤
State when the component is in the process of switching on from an off state.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_UNAVAILABLE
module-attribute
¤
State when the component is temporarily unavailable for operation.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_UNKNOWN
module-attribute
¤
State when the component is in an unknown or undefined condition. This is used when the sender is unable to classify the component into any other state.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ELECTRICAL_COMPONENT_STATE_CODE_UNSPECIFIED
module-attribute
¤
Default value when the component state is not explicitly set. This is the zero value of the enum.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.EV_CHARGER_TYPE_AC
module-attribute
¤
The EV charging station supports AC charging only.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.EV_CHARGER_TYPE_DC
module-attribute
¤
The EV charging station supports DC charging only.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.EV_CHARGER_TYPE_HYBRID
module-attribute
¤
The EV charging station supports both AC and DC.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.EV_CHARGER_TYPE_UNSPECIFIED
module-attribute
¤
Default type.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.INVERTER_TYPE_BATTERY
module-attribute
¤
Battery inverter.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.INVERTER_TYPE_HYBRID
module-attribute
¤
Hybrid inverter.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.INVERTER_TYPE_PV
module-attribute
¤
PV (photovoltaic) inverter.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.INVERTER_TYPE_UNSPECIFIED
module-attribute
¤
Unspecified.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.INVERTER_TYPE_WIND_TURBINE
module-attribute
¤
Wind turbine inverter.
Classes¤
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.Battery
¤
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.BatteryType
¤
Bases: _BatteryType
Enumerated battery types.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ElectricalComponent
¤
Bases: Message
Microgrid electrical component details.
Attributes¤
category
instance-attribute
¤
The component category. E.g., Inverter, Battery, etc.
category_specific_info
property
¤
The metadata specific to the component category type.
id
instance-attribute
¤
The component ID.
manufacturer
instance-attribute
¤
The component manufacturer.
metric_config_bounds
property
¤
List of rated bounds present for the component identified by Metric.
microgrid_id
instance-attribute
¤
Unique identifier of the parent microgrid_id.
model_name
instance-attribute
¤
The model name of the component.
name
instance-attribute
¤
The component name.
operational_lifetime
property
¤
The operational lifetime of the component.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ElectricalComponentCategory
¤
Bases: _ElectricalComponentCategory
Enumerated electrical component categories.
This enum lists key microgrid components, most of which are typically capable of being remotely controlled via digital interfaces (e.g., Modbus, MQTT, OPC-UA).
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ElectricalComponentCategorySpecificInfo
¤
Bases: Message
Information specific to a microgrid electrical component, based upon its category.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ElectricalComponentConnection
¤
Bases: Message
ElectricalComponentConnection describes a single electrical link between two components within a microgrid, effectively representing the physical wiring as viewed from the grid connection point, if one exists, or from the islanding point, in case of an islanded microgrids.
Physical Representation
This message is not about data flow but rather about the physical electrical connections between components. Therefore, the IDs for the source and destination components correspond to the actual setup within the microgrid.
Direction
The direction of the connection follows the flow of current away from the grid connection point, or in case of islands, away from the islanding point. This direction is aligned with positive current according to the [Passive Sign Convention] (https://en.wikipedia.org/wiki/Passive_sign_convention).
Historical Data
The timestamps of when a connection was created and terminated allows for tracking the changes over time to a microgrid, providing insights into when and how the microgrid infrastructure has been modified.
Attributes¤
destination_component_id
instance-attribute
¤
Unique ID of the component where the connection terminates. This is the component towards which the current flows.
operational_lifetime
property
¤
The operational lifetime of the connection.
source_component_id
instance-attribute
¤
Unique identifier of the component where the connection originates. This is aligned with the direction of current flow away from the grid connection point, or in case of islands, away from the islanding point.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ElectricalComponentDiagnostic
¤
Bases: Message
Represents an error or warning condition reported by a microgrid electrical component.
This message extends a standardized error code with contextual information useful for diagnostics, such as subsystem names, measured values, or vendor-specific insights.
Typical Component Error
Component-Originated Diagnostics
This message is intended to reflect diagnostics originating from electrical components (e.g., inverters, batteries), either from internal firmware or via gateway logic.
Vendor-Specific Codes
When available, vendor_error_code will reflect manufacturer-defined
error identifiers, typically exposed via Modbus or similar interfaces.
These codes are vendor- and firmware-specific and must be interpreted
using the vendor's official documentation.
Attributes¤
diagnostic_code
instance-attribute
¤
A standardized error code representing the category of the issue.
message
instance-attribute
¤
Optional human-readable message providing additional context.
vendor_diagnostic_code
instance-attribute
¤
Optional vendor-provided error code for the error, for vendor-specific insights or more granular diagnostics.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ElectricalComponentDiagnosticCode
¤
Bases: _ElectricalComponentDiagnosticCode
A representation of all possible diagnostic codes that can occur for electrical component, across all their categories. These diagnostic codes can be used to refer to warnings or errors that are reported by the component.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ElectricalComponentStateCode
¤
Bases: _ElectricalComponentStateCode
Enum to represent the various states that a component can be in. This enum is unified across all component categories for consistency.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ElectricalComponentStateSnapshot
¤
Bases: Message
Representation of a component state, warnings, and errors.
Attributes¤
errors
property
¤
List of critical errors currently affecting the component.
Note
This list is treated as a set, and therefore its members will be unique, i.e., no state will exist twice in this list.
Note
This list is expected to have errors if and only if the electrical component is in an error state.
origin_time
property
¤
The UTC time when the state was originally captured.
states
property
¤
List of operational states currently active for the component.
Note
This list is treated as a set, and therefore its members will be unique, i.e., no state will exist twice in this list.
Note
If the state is ELECTRICAL_COMPONENT_STATE_CODE_ERROR, then the
electrical component is in an error state. In such cases, the errors
field will be populated with the list of errors.
warnings
property
¤
List of non-critical warnings detected for the component.
Note
This list is treated as a set, and therefore its members will be unique, i.e., no state will exist twice in this list.
Note
Warnings may be reported even when the component is operational.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.ElectricalComponentTelemetry
¤
Bases: Message
ElectricalComponentTelemetry message aggregates multiple metrics, operational states, and errors, related to a specific microgrid component.
Example
Example output of a component data message:
{
ELECTRICAL_component_id: 13,
metric_samples: [
/* list of metrics for multiple timestamps */
{
sample_time: "2023-10-01T00:00:00Z",
metric: "DC_VOLTAGE_V",
value: {},
bounds: {},
connection: "battery_0"
},
{
sample_time: "2023-10-01T00:00:00Z",
metric: "DC_VOLTAGE_V",
value: {},
bounds: {},
connection: "pv_0"
}
],
states: [
/* list of states for multiple timestamps */
{
sample_time: "2023-10-01T00:00:00Z",
states: [],
warnings: [],
errors: [],
},
{
sample_time: "2023-10-01T00:00:00Z",
states: [],
warnings: [],
errors: [],
},
]
}
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.EvCharger
¤
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.EvChargerType
¤
Bases: _EvChargerType
Enumerated EV charger types.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.Fuse
¤
Bases: Message
A representation of a fuse. The fuse component represents a fuse in the microgrid. It is used to protect components from overcurrents.
Attributes¤
rated_current
instance-attribute
¤
The rated current of the fuse in amperes. This is the maximum current that the fuse can withstand for a long time. This limit applies to currents both flowing in or out of each of the 3 phases individually.
In other words, a current i A at one of the phases of the node must
comply with the following constraint:
-rated_fuse_current <= i <= rated_fuse_current
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.GridConnectionPoint
¤
Bases: Message
A representation of a grid connection point. This is the point where a microgrid connects to the grid.
The terms "Grid Connection Point" and "Point of Common Coupling" (PCC) are commonly used in the context.
While both terms describe a connection point to the grid, the
GridConnectionPoint is specifically the physical connection point of the
generation facility to the grid, often concerned with the technical and
ownership aspects of the connection.
In contrast, the PCC is is more specific in terms of electrical engineering. It refers to the point where a customer's local electrical system (such as a microgrid) connects to the utility distribution grid in such a way that it can affect other customers’ systems connected to the same network. It is the point where the grid and customer's electrical systems interface and where issues like power quality and supply regulations are assessed.
The term GridConnectionPoint is used to make it clear that what is referred
to here is the physical connection point of the local facility to the grid.
Note that this may also be the PCC in some cases.
Attributes¤
rated_fuse_current
instance-attribute
¤
This refers to the maximum amount of electrical current, in amperes, that a fuse at the grid connection point is designed to safely carry under normal operating conditions.
This limit applies to currents both flowing in or out of each of the 3 phases individually.
In other words, a current i A at one of the phases of the grid connection
point must comply with the following constraint:
-rated_fuse_current <= i <= rated_fuse_current
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.Inverter
¤
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.InverterType
¤
Bases: _InverterType
Enumerated inverter types.
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.MetricConfigBounds
¤
Bases: Message
MetricConfigBounds describes a set of limits for a specific metric consisting of a lower and upper bound for said metric.
This can be used for example to specify an allowed range of power output for a component.
Attributes¤
config_bounds
property
¤
The set of bounds for the specified metric.
This contains the lower and upper bounds for said metric. Sources these may be derived from include the component configuration, manufacturers limits, and limits of other devices.
metric
instance-attribute
¤
Metric type the config bounds are for
frequenz.api.common.v1alpha7.microgrid.electrical_components.electrical_components_pb2.VoltageTransformer
¤
Bases: Message
A representation of a voltage transformer. Voltage transformers are used to step up or step down the voltage, keeping the power somewhat constant by increasing or decreasing the current. If voltage is stepped up, current is stepped down, and vice versa. Note that voltage transformers have efficiency losses, so the output power is always less than the input power.