Skip to content

electrical_pb2

frequenz.api.common.metrics.electrical_pb2 ¤

Generated protocol buffer code.

Classes¤

frequenz.api.common.metrics.electrical_pb2.AC ¤

Bases: Message

The current state and metrics of the electrical connections to the inverter.

Attributes¤
current: frequenz.api.common.metrics_pb2.Metric property ¤

The apparent 3-phase AC current. Positive values represent apparent energy flowing towards the grid connection, and vice versa. In Ampere (A).

energy_active: global___AC.ActiveEnergy property ¤

The total 3-phase active energy counters for the underlying component's consumption and supply. In Watt-hour (Wh).

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

The total 3-phase apparent energy. A positive value represents the net apparent energy supplied to the grid connection, and vice versa. In Volt-Ampere-hour (VAh).

energy_reactive: global___AC.ReactiveEnergy property ¤

The total 3-phase reactive energy counters for the underlying component's capacitive and inductive energy values. In Volt-Ampere reactive hour (VArh). FIXME: ReactiveEnergy says Volt-Ampere-hour (VAh).

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

Overall AC metrics.

The AC frequency. In Hertz (Hz).

harmonics_power_active: global___AC.Harmonics property ¤

The sums of the harmonics of the instantaneous active power at the component across all 3 phases.

phase_1: global___AC.ACPhase property ¤

AC metrics for phase/line 1.

phase_2: global___AC.ACPhase property ¤

AC metrics for phase/line 2.

phase_3: global___AC.ACPhase property ¤

AC metrics for phase/line 3.

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

The total active 3-phase AC active power. +ve power means consumption, away from the grid. -ve power means supply into the grid. In Watt (W).

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

The apparent 3-phase AC power. Positive values represent apparent energy flowing towards the grid connection, and vice versa. In Volt-Ampere (VA).

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

The reactive 3-phase AC power. +ve power means capacitive (current leading w.r.t. voltage). -ve power means inductive (current lagging w.r.t. voltage). In Volt-Ampere reactive (VAr).

thd_power_active: builtins.float instance-attribute ¤

The sums of the total harmonic distortion of the instantaneous active power at the component across all 3 phases.

Classes¤
ACPhase ¤

Bases: Message

AC metrics of a single phase.

Attributes¤
current: frequenz.api.common.metrics_pb2.Metric property ¤

AC current. +ve current means consumption, away from the grid. -ve current means supply into the grid. In Ampere (A).

energy_active: global___AC.ActiveEnergy property ¤

The total active energy counters for the underlying component's consumption and supply. In Watt-hour (Wh).

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

The total apparent energy. A Positive value represents the net apparent energy supplied to the grid connection, and vice versa. In Volt-Ampere-hour (VAh).

energy_reactive: global___AC.ReactiveEnergy property ¤

The total reactive energy counters for the underlying component's capacitive and inductive energy values. In Volt-Ampere reactive hour (VArh).

harmonics_power_active: global___AC.Harmonics property ¤

Harmonics of the instantaneous active power at the component. In percent (%).

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

AC active power. +ve power means consumption, away from the grid. -ve power means supply into the grid. In Watt (W).

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

AC reactive power. +ve power means inductive (leading). -ve power means capacitive (lagging). In Volt-Ampere reactive (VAr).

thd_power_active: builtins.float instance-attribute ¤

Total harmonic distortion of the instantaneous active power at the component. In percent (%).

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

The AC voltage between the line and the neutral wire. In Volt (V).

ActiveEnergy ¤

Bases: Message

The active energy the inverter is consuming or generating.

Attributes¤
energy: frequenz.api.common.metrics_pb2.Metric property ¤

The sum of the consumed and delivered energy. This is a signed value in passive sign convention: if more energy is consumed than delivered, this is a -ve number, otherwise +ve. In Watt-hour (Wh).

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

The consumed energy. In Watt-hour (Wh).

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

The delivered energy. In Watt-hour (Wh).

Harmonics ¤

Bases: Message

The harmonics of the fast Fourier transform of the instantaneous values and its total harmonic distortion. In percent (%).

ReactiveEnergy ¤

Bases: Message

The reactive energy the inverter is consuming or generating.

Attributes¤
energy: frequenz.api.common.metrics_pb2.Metric property ¤

The sum of the capacitive and inductive energy. This is a signed value. If more energy is capacitive than inductive, this is a -ve number, otherwise +ve. In Volt-Ampere-hour (VArh).

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

The capacitive energy. In Volt-Ampere-hour (VArh).

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

The inductive energy. In Volt-Ampere-hour (VArh).

frequenz.api.common.metrics.electrical_pb2.DC ¤

Bases: Message

Metrics of a DC electrical connection.

Source code in frequenz/api/common/metrics/electrical_pb2.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
  _globals['_DC']._serialized_start=124
  _globals['_DC']._serialized_end=288
  _globals['_AC']._serialized_start=291
  _globals['_AC']._serialized_end=2339
  _globals['_AC_ACTIVEENERGY']._serialized_start=1134
  _globals['_AC_ACTIVEENERGY']._serialized_end=1326
  _globals['_AC_REACTIVEENERGY']._serialized_start=1329
  _globals['_AC_REACTIVEENERGY']._serialized_end=1525
  _globals['_AC_HARMONICS']._serialized_start=1528
  _globals['_AC_HARMONICS']._serialized_end=1761
  _globals['_AC_ACPHASE']._serialized_start=1764
  _globals['_AC_ACPHASE']._serialized_end=2339
# @@protoc_insertion_point(module_scope)
Attributes¤
current: frequenz.api.common.metrics_pb2.Metric property ¤

The DC current flowing away from the grid connection. In passive sign convention: +ve current means consumption, away from the grid. -ve current means supply into the grid. In Ampere (A).

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

The DC power flowing away from the grid connection. In passive sign convention: +ve power means consumption, away from the grid. -ve power means supply into the grid. In Watt (W).

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

The DC voltage across the component. In Volt (V).