battery_pb2
frequenz.api.microgrid.battery_pb2
¤
Generated protocol buffer code.
Attributes¤
frequenz.api.microgrid.battery_pb2.COMPONENT_STATE_CHARGING: ComponentState.ValueType
module-attribute
¤
The battery is consuming electrical energy.
frequenz.api.microgrid.battery_pb2.COMPONENT_STATE_DISCHARGING: ComponentState.ValueType
module-attribute
¤
The battery is generating electrical energy.
frequenz.api.microgrid.battery_pb2.COMPONENT_STATE_ERROR: ComponentState.ValueType
module-attribute
¤
The battery is in a faulty state.
frequenz.api.microgrid.battery_pb2.COMPONENT_STATE_IDLE: ComponentState.ValueType
module-attribute
¤
The battery is idle.
frequenz.api.microgrid.battery_pb2.COMPONENT_STATE_LOCKED: ComponentState.ValueType
module-attribute
¤
The battery is online, but currently unavailable, possibly due to a pre-scheduled maintenance, or waiting for a resource to be loaded.
frequenz.api.microgrid.battery_pb2.COMPONENT_STATE_OFF: ComponentState.ValueType
module-attribute
¤
The battery is switched off.
frequenz.api.microgrid.battery_pb2.COMPONENT_STATE_SWITCHING_OFF: ComponentState.ValueType
module-attribute
¤
The battery is switching off and needs some time to fully shut down.
frequenz.api.microgrid.battery_pb2.COMPONENT_STATE_SWITCHING_ON: ComponentState.ValueType
module-attribute
¤
The battery is starting up and needs some time to become fully operational.
frequenz.api.microgrid.battery_pb2.COMPONENT_STATE_UNKNOWN: ComponentState.ValueType
module-attribute
¤
The state is provided by the device, but it can not be parsed as any of the above (known) states.
frequenz.api.microgrid.battery_pb2.COMPONENT_STATE_UNSPECIFIED: ComponentState.ValueType
module-attribute
¤
Default value. This value is used only when the state information is not available.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_BLOCK_ERROR: ErrorCode.ValueType
module-attribute
¤
One or more battery blocks have failed.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_CALIBRATION_NEEDED: ErrorCode.ValueType
module-attribute
¤
The battery requires a calibration to reset its measurements.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_CONTROLLER_ERROR: ErrorCode.ValueType
module-attribute
¤
The battery controller has failed.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_EXCEEDED_SOP_CHARGE: ErrorCode.ValueType
module-attribute
¤
Charge current has exceeded component bounds.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_EXCEEDED_SOP_DISCHARGE: ErrorCode.ValueType
module-attribute
¤
Discharge current has exceeded component bounds.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_EXTERNAL_POWER_SWITCH_ERROR: ErrorCode.ValueType
module-attribute
¤
The eternal power switch has failed.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_FUSE_ERROR: ErrorCode.ValueType
module-attribute
¤
The battery's fuse has failed.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_HIGH_CURRENT_CHARGE: ErrorCode.ValueType
module-attribute
¤
Charge current is too high.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_HIGH_CURRENT_DISCHARGE: ErrorCode.ValueType
module-attribute
¤
Discharge current is too high.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_HIGH_HUMIDITY: ErrorCode.ValueType
module-attribute
¤
Humidity is too high.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_HIGH_TEMPERATURE: ErrorCode.ValueType
module-attribute
¤
Temperature is too high.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_HIGH_VOLTAGE: ErrorCode.ValueType
module-attribute
¤
Voltage is too high.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_LOW_SOH: ErrorCode.ValueType
module-attribute
¤
The State of health is low.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_LOW_TEMPERATURE: ErrorCode.ValueType
module-attribute
¤
Temperature is too low.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_LOW_VOLTAGE: ErrorCode.ValueType
module-attribute
¤
Voltage is too low.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_PRECHARGE_ERROR: ErrorCode.ValueType
module-attribute
¤
The precharge operation has failed.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_RELAY_CYCLE_LIMIT_REACHED: ErrorCode.ValueType
module-attribute
¤
The battery's DC relays have been cycled for the maximum number of times mentioned in their lifetime specifications.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_RELAY_ERROR: ErrorCode.ValueType
module-attribute
¤
The battery's DC relays have failed.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_SYSTEM_IMBALANCE: ErrorCode.ValueType
module-attribute
¤
The battery blocks are not balanced with respect to each other.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_SYSTEM_PLAUSIBILITY_ERROR: ErrorCode.ValueType
module-attribute
¤
System plausibility checks have failed.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_SYSTEM_UNDERVOLTAGE_SHUTDOWN: ErrorCode.ValueType
module-attribute
¤
System shut down due to extremely low voltage.
frequenz.api.microgrid.battery_pb2.ERROR_CODE_UNSPECIFIED: ErrorCode.ValueType
module-attribute
¤
Unspecified.
frequenz.api.microgrid.battery_pb2.RELAY_STATE_CLOSED: RelayState.ValueType
module-attribute
¤
The relays are closed, and the DC power line to the inverter is connected.
frequenz.api.microgrid.battery_pb2.RELAY_STATE_ERROR: RelayState.ValueType
module-attribute
¤
The relays are in an error state.
frequenz.api.microgrid.battery_pb2.RELAY_STATE_LOCKED: RelayState.ValueType
module-attribute
¤
The relays are locked, and should be available to accept commands shortly.
frequenz.api.microgrid.battery_pb2.RELAY_STATE_OPENED: RelayState.ValueType
module-attribute
¤
The relays are open, and the DC power line to the inverter is disconnected.
frequenz.api.microgrid.battery_pb2.RELAY_STATE_PRECHARGING: RelayState.ValueType
module-attribute
¤
The relays are closing, and the DC power line to the inverter is being connected.
frequenz.api.microgrid.battery_pb2.RELAY_STATE_UNSPECIFIED: RelayState.ValueType
module-attribute
¤
Default value.
Classes¤
frequenz.api.microgrid.battery_pb2.Battery
¤
Bases: Message
Battery/BMS details
Attributes¤
data: global___Data
property
¤
A Battery data object.
errors: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Error]
property
¤
A list of errors encountered the component. An empty list implies no error.
properties: global___Properties
property
¤
The component properties
state: global___State
property
¤
The battery state.
frequenz.api.microgrid.battery_pb2.Data
¤
Bases: Message
Battery data.
Attributes¤
dc: frequenz.api.common.metrics.electrical_pb2.DC
property
¤
DC electricity metrics.
humidity: frequenz.api.common.metrics_pb2.MetricAggregation
property
¤
The aggregated values of all the humidity measurements of a battery. In percent (%).
soc: frequenz.api.common.metrics_pb2.MetricAggregation
property
¤
Battery's overall SoC. In percent (%).
temperature: frequenz.api.common.metrics_pb2.MetricAggregation
property
¤
The aggregated values of all the temperature measurements of a battery. In degree Celsius (°C).
frequenz.api.microgrid.battery_pb2.Error
¤
frequenz.api.microgrid.battery_pb2.ErrorCode
¤
Bases: _ErrorCode
Enumerated Battery/BMS error codes.