Skip to content

inverter_pb2

frequenz.api.microgrid.inverter_pb2 ¤

Generated protocol buffer code.

Attributes¤

frequenz.api.microgrid.inverter_pb2.COMPONENT_STATE_CHARGING: ComponentState.ValueType module-attribute ¤

The inverter is consuming electrical energy to charge batteries. Applicable to BATTERY and HYBRID inverters only.

frequenz.api.microgrid.inverter_pb2.COMPONENT_STATE_DISCHARGING: ComponentState.ValueType module-attribute ¤

The inverter is generating electrical energy.

frequenz.api.microgrid.inverter_pb2.COMPONENT_STATE_ERROR: ComponentState.ValueType module-attribute ¤

The inverter is in a faulty state.

frequenz.api.microgrid.inverter_pb2.COMPONENT_STATE_IDLE: ComponentState.ValueType module-attribute ¤

The inverter is idle.

frequenz.api.microgrid.inverter_pb2.COMPONENT_STATE_OFF: ComponentState.ValueType module-attribute ¤

Inverter is switched off.

frequenz.api.microgrid.inverter_pb2.COMPONENT_STATE_STANDBY: ComponentState.ValueType module-attribute ¤

The inverter is in a standby state, and is disconnected from the grid. When connected to the grid, it run a few tests, and move to the IDLE state.

frequenz.api.microgrid.inverter_pb2.COMPONENT_STATE_SWITCHING_OFF: ComponentState.ValueType module-attribute ¤

The inverter is switching off and needs some time to fully shut down.

frequenz.api.microgrid.inverter_pb2.COMPONENT_STATE_SWITCHING_ON: ComponentState.ValueType module-attribute ¤

The inverter is starting up and needs some time to become fully operational.

frequenz.api.microgrid.inverter_pb2.COMPONENT_STATE_UNAVAILABLE: ComponentState.ValueType module-attribute ¤

The inverter is online, but currently unavailable, possibly due to a pre-scheduled maintenance.

frequenz.api.microgrid.inverter_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.inverter_pb2.COMPONENT_STATE_UNSPECIFIED: ComponentState.ValueType module-attribute ¤

Default value.

frequenz.api.microgrid.inverter_pb2.ERROR_CODE_UNSPECIFIED: ErrorCode.ValueType module-attribute ¤

Unspecified.

Classes¤

frequenz.api.microgrid.inverter_pb2.ComponentState ¤

Bases: _ComponentState

Enumerated inverter states.

frequenz.api.microgrid.inverter_pb2.Data ¤

Bases: Message

Inverter data.

Attributes¤
ac: frequenz.api.common.metrics.electrical_pb2.AC property ¤

AC metrics of the inverter.

dc_battery: frequenz.api.common.metrics.electrical_pb2.DC property ¤

DC metrics for the inverter-battery linkage. This is applicable to BATTERY and HYBRID inverters only.

dc_solar: frequenz.api.common.metrics.electrical_pb2.DC property ¤

DC metrics for the inverter-PV linkage. This is applicable to SOLAR and HYBRID inverters only.

temperature: frequenz.api.common.metrics_pb2.Metric property ¤

The verall temperature of the inverter. In degree Celsius (°C).

frequenz.api.microgrid.inverter_pb2.Error ¤

Bases: Message

Error message.

Attributes¤
code: global___ErrorCode.ValueType instance-attribute ¤

The error code.

level: frequenz.api.microgrid.common_pb2.ErrorLevel.ValueType instance-attribute ¤

The error severity level.

msg: builtins.str instance-attribute ¤

The error message.

frequenz.api.microgrid.inverter_pb2.ErrorCode ¤

Bases: _ErrorCode

Enumerated inverter error codes.

frequenz.api.microgrid.inverter_pb2.Inverter ¤

Bases: Message

Inverter message definition.

Attributes¤
data: global___Data property ¤

An inverter 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 inverter's state.

frequenz.api.microgrid.inverter_pb2.Metadata ¤

Bases: Message

The inverter metadata.

Attributes¤
type: frequenz.api.common.components_pb2.InverterType.ValueType instance-attribute ¤

The inverter type.

frequenz.api.microgrid.inverter_pb2.Properties ¤

Bases: Message

Inverter properties.

Attributes¤
firmware_ver: builtins.str instance-attribute ¤

The firmware version of the component.

frequenz.api.microgrid.inverter_pb2.State ¤

Bases: Message

State message.

Attributes¤
component_state: global___ComponentState.ValueType instance-attribute ¤

The state of the overall component.

frequenz.api.microgrid.inverter_pb2.Type ¤

Bases: _Type

Enumerated inverter types.

Source code in frequenz/api/microgrid/inverter_pb2.py 
44
45
  _INVERTER._serialized_end=1049
# @@protoc_insertion_point(module_scope)