Skip to content

meter_pb2

frequenz.api.microgrid.meter_pb2 ¤

Generated protocol buffer code.

Attributes¤

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

The meter is in an error state.

frequenz.api.microgrid.meter_pb2.COMPONENT_STATE_OK: ComponentState.ValueType module-attribute ¤

The meter is behaving as expected.

frequenz.api.microgrid.meter_pb2.COMPONENT_STATE_UNSPECIFIED: ComponentState.ValueType module-attribute ¤

Unspecified state.

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

Unspecified.

frequenz.api.microgrid.meter_pb2.TYPE_CONSUMPTION: Type.ValueType module-attribute ¤

Consumption meter

frequenz.api.microgrid.meter_pb2.TYPE_FEED_IN: Type.ValueType module-attribute ¤

Exported to grid meter

frequenz.api.microgrid.meter_pb2.TYPE_PRODUCTION: Type.ValueType module-attribute ¤

AC production power meter / inverter production AC power (fallback)

frequenz.api.microgrid.meter_pb2.TYPE_PURCHASED: Type.ValueType module-attribute ¤

Imported power from grid meter

Classes¤

frequenz.api.microgrid.meter_pb2.ComponentState ¤

Bases: _ComponentState

Enumerated meter states.

frequenz.api.microgrid.meter_pb2.Data ¤

Bases: Message

Meter data.

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

AC metrics of the inverter.

frequenz.api.microgrid.meter_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.meter_pb2.ErrorCode ¤

Bases: _ErrorCode

Enumerated meter error codes.

frequenz.api.microgrid.meter_pb2.Metadata ¤

Bases: Message

The meter metadata.

Attributes¤
type: global___Type.ValueType instance-attribute ¤

The meter type.

frequenz.api.microgrid.meter_pb2.Meter ¤

Bases: Message

Meter details

Attributes¤
data: global___Data property ¤

A meter 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 meter's state.

frequenz.api.microgrid.meter_pb2.Properties ¤

Bases: Message

Meter properties.

Attributes¤
firmware_ver: builtins.str instance-attribute ¤

The firmware version of the component.

frequenz.api.microgrid.meter_pb2.State ¤

Bases: Message

State message.

Attributes¤
component_state: global___ComponentState.ValueType instance-attribute ¤

The state of the overall component.

frequenz.api.microgrid.meter_pb2.Type ¤

Bases: _Type

Enumerated meter types.