Add Metric enum

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

src/frequenz/client/microgrid/metrics/__init__.py

@@ -3,9 +3,11 @@
 
 """Metrics definitions."""
 
+from ._metric import Metric
 from ._sample import AggregatedMetricValue, AggregationMethod
 
 __all__ = [
     "AggregatedMetricValue",
     "AggregationMethod",
+    "Metric",
 ]

src/frequenz/client/microgrid/metrics/_metric.py

@@ -0,0 +1,264 @@
+# License: MIT
+# Copyright © 2024 Frequenz Energy-as-a-Service GmbH
+
+"""Supported metrics for microgrid components."""
+
+
+import enum
+
+from frequenz.api.common.v1.metrics import metric_sample_pb2
+
+
+@enum.unique
+class Metric(enum.Enum):
+    """List of supported metrics.
+
+    Note: AC energy metrics information
+        - This energy metric is reported directly from the component, and not a
+          result of aggregations in our systems. If a component does not have this
+          metric, this field cannot be populated.
+
+        - Components that provide energy metrics reset this metric from time to
+          time. This behaviour is specific to each component model. E.g., some
+          components reset it on UTC 00:00:00.
+
+        - This energy metric does not specify the start time of the accumulation
+          period,and therefore can be inconsistent.
+    """
+
+    UNSPECIFIED = metric_sample_pb2.METRIC_UNSPECIFIED
+    """The metric is unspecified (this should not be used)."""
+
+    DC_VOLTAGE = metric_sample_pb2.METRIC_DC_VOLTAGE
+    """The direct current voltage."""
+
+    DC_CURRENT = metric_sample_pb2.METRIC_DC_CURRENT
+    """The direct current current."""
+
+    DC_POWER = metric_sample_pb2.METRIC_DC_POWER
+    """The direct current power."""
+
+    AC_FREQUENCY = metric_sample_pb2.METRIC_AC_FREQUENCY
+    """The alternating current frequency."""
+
+    AC_VOLTAGE = metric_sample_pb2.METRIC_AC_VOLTAGE
+    """The alternating current electric potential difference."""
+
+    AC_VOLTAGE_PHASE_1_N = metric_sample_pb2.METRIC_AC_VOLTAGE_PHASE_1_N
+    """The alternating current electric potential difference between phase 1 and neutral."""
+
+    AC_VOLTAGE_PHASE_2_N = metric_sample_pb2.METRIC_AC_VOLTAGE_PHASE_2_N
+    """The alternating current electric potential difference between phase 2 and neutral."""
+
+    AC_VOLTAGE_PHASE_3_N = metric_sample_pb2.METRIC_AC_VOLTAGE_PHASE_3_N
+    """The alternating current electric potential difference between phase 3 and neutral."""
+
+    AC_VOLTAGE_PHASE_1_PHASE_2 = metric_sample_pb2.METRIC_AC_VOLTAGE_PHASE_1_PHASE_2
+    """The alternating current electric potential difference between phase 1 and phase 2."""
+
+    AC_VOLTAGE_PHASE_2_PHASE_3 = metric_sample_pb2.METRIC_AC_VOLTAGE_PHASE_2_PHASE_3
+    """The alternating current electric potential difference between phase 2 and phase 3."""
+
+    AC_VOLTAGE_PHASE_3_PHASE_1 = metric_sample_pb2.METRIC_AC_VOLTAGE_PHASE_3_PHASE_1
+    """The alternating current electric potential difference between phase 3 and phase 1."""
+
+    AC_CURRENT = metric_sample_pb2.METRIC_AC_CURRENT
+    """The alternating current current."""
+
+    AC_CURRENT_PHASE_1 = metric_sample_pb2.METRIC_AC_CURRENT_PHASE_1
+    """The alternating current current in phase 1."""
+
+    AC_CURRENT_PHASE_2 = metric_sample_pb2.METRIC_AC_CURRENT_PHASE_2
+    """The alternating current current in phase 2."""
+
+    AC_CURRENT_PHASE_3 = metric_sample_pb2.METRIC_AC_CURRENT_PHASE_3
+    """The alternating current current in phase 3."""
+
+    AC_APPARENT_POWER = metric_sample_pb2.METRIC_AC_APPARENT_POWER
+    """The alternating current apparent power."""
+
+    AC_APPARENT_POWER_PHASE_1 = metric_sample_pb2.METRIC_AC_APPARENT_POWER_PHASE_1
+    """The alternating current apparent power in phase 1."""
+
+    AC_APPARENT_POWER_PHASE_2 = metric_sample_pb2.METRIC_AC_APPARENT_POWER_PHASE_2
+    """The alternating current apparent power in phase 2."""
+
+    AC_APPARENT_POWER_PHASE_3 = metric_sample_pb2.METRIC_AC_APPARENT_POWER_PHASE_3
+    """The alternating current apparent power in phase 3."""
+
+    AC_ACTIVE_POWER = metric_sample_pb2.METRIC_AC_ACTIVE_POWER
+    """The alternating current active power."""
+
+    AC_ACTIVE_POWER_PHASE_1 = metric_sample_pb2.METRIC_AC_ACTIVE_POWER_PHASE_1
+    """The alternating current active power in phase 1."""
+
+    AC_ACTIVE_POWER_PHASE_2 = metric_sample_pb2.METRIC_AC_ACTIVE_POWER_PHASE_2
+    """The alternating current active power in phase 2."""
+
+    AC_ACTIVE_POWER_PHASE_3 = metric_sample_pb2.METRIC_AC_ACTIVE_POWER_PHASE_3
+    """The alternating current active power in phase 3."""
+
+    AC_REACTIVE_POWER = metric_sample_pb2.METRIC_AC_REACTIVE_POWER
+    """The alternating current reactive power."""
+
+    AC_REACTIVE_POWER_PHASE_1 = metric_sample_pb2.METRIC_AC_REACTIVE_POWER_PHASE_1
+    """The alternating current reactive power in phase 1."""
+
+    AC_REACTIVE_POWER_PHASE_2 = metric_sample_pb2.METRIC_AC_REACTIVE_POWER_PHASE_2
+    """The alternating current reactive power in phase 2."""
+
+    AC_REACTIVE_POWER_PHASE_3 = metric_sample_pb2.METRIC_AC_REACTIVE_POWER_PHASE_3
+    """The alternating current reactive power in phase 3."""
+
+    AC_POWER_FACTOR = metric_sample_pb2.METRIC_AC_POWER_FACTOR
+    """The alternating current power factor."""
+
+    AC_POWER_FACTOR_PHASE_1 = metric_sample_pb2.METRIC_AC_POWER_FACTOR_PHASE_1
+    """The alternating current power factor in phase 1."""
+
+    AC_POWER_FACTOR_PHASE_2 = metric_sample_pb2.METRIC_AC_POWER_FACTOR_PHASE_2
+    """The alternating current power factor in phase 2."""
+
+    AC_POWER_FACTOR_PHASE_3 = metric_sample_pb2.METRIC_AC_POWER_FACTOR_PHASE_3
+    """The alternating current power factor in phase 3."""
+
+    AC_APPARENT_ENERGY = metric_sample_pb2.METRIC_AC_APPARENT_ENERGY
+    """The alternating current apparent energy."""
+
+    AC_APPARENT_ENERGY_PHASE_1 = metric_sample_pb2.METRIC_AC_APPARENT_ENERGY_PHASE_1
+    """The alternating current apparent energy in phase 1."""
+
+    AC_APPARENT_ENERGY_PHASE_2 = metric_sample_pb2.METRIC_AC_APPARENT_ENERGY_PHASE_2
+    """The alternating current apparent energy in phase 2."""
+
+    AC_APPARENT_ENERGY_PHASE_3 = metric_sample_pb2.METRIC_AC_APPARENT_ENERGY_PHASE_3
+    """The alternating current apparent energy in phase 3."""
+
+    AC_ACTIVE_ENERGY = metric_sample_pb2.METRIC_AC_ACTIVE_ENERGY
+    """The alternating current active energy."""
+
+    AC_ACTIVE_ENERGY_PHASE_1 = metric_sample_pb2.METRIC_AC_ACTIVE_ENERGY_PHASE_1
+    """The alternating current active energy in phase 1."""
+
+    AC_ACTIVE_ENERGY_PHASE_2 = metric_sample_pb2.METRIC_AC_ACTIVE_ENERGY_PHASE_2
+    """The alternating current active energy in phase 2."""
+
+    AC_ACTIVE_ENERGY_PHASE_3 = metric_sample_pb2.METRIC_AC_ACTIVE_ENERGY_PHASE_3
+    """The alternating current active energy in phase 3."""
+
+    AC_ACTIVE_ENERGY_CONSUMED = metric_sample_pb2.METRIC_AC_ACTIVE_ENERGY_CONSUMED
+    """The alternating current active energy consumed."""
+
+    AC_ACTIVE_ENERGY_CONSUMED_PHASE_1 = (
+        metric_sample_pb2.METRIC_AC_ACTIVE_ENERGY_CONSUMED_PHASE_1
+    )
+    """The alternating current active energy consumed in phase 1."""
+
+    AC_ACTIVE_ENERGY_CONSUMED_PHASE_2 = (
+        metric_sample_pb2.METRIC_AC_ACTIVE_ENERGY_CONSUMED_PHASE_2
+    )
+    """The alternating current active energy consumed in phase 2."""
+
+    AC_ACTIVE_ENERGY_CONSUMED_PHASE_3 = (
+        metric_sample_pb2.METRIC_AC_ACTIVE_ENERGY_CONSUMED_PHASE_3
+    )
+    """The alternating current active energy consumed in phase 3."""
+
+    AC_ACTIVE_ENERGY_DELIVERED = metric_sample_pb2.METRIC_AC_ACTIVE_ENERGY_DELIVERED
+    """The alternating current active energy delivered."""
+
+    AC_ACTIVE_ENERGY_DELIVERED_PHASE_1 = (
+        metric_sample_pb2.METRIC_AC_ACTIVE_ENERGY_DELIVERED_PHASE_1
+    )
+    """The alternating current active energy delivered in phase 1."""
+
+    AC_ACTIVE_ENERGY_DELIVERED_PHASE_2 = (
+        metric_sample_pb2.METRIC_AC_ACTIVE_ENERGY_DELIVERED_PHASE_2
+    )
+    """The alternating current active energy delivered in phase 2."""
+
+    AC_ACTIVE_ENERGY_DELIVERED_PHASE_3 = (
+        metric_sample_pb2.METRIC_AC_ACTIVE_ENERGY_DELIVERED_PHASE_3
+    )
+    """The alternating current active energy delivered in phase 3."""
+
+    AC_REACTIVE_ENERGY = metric_sample_pb2.METRIC_AC_REACTIVE_ENERGY
+    """The alternating current reactive energy."""
+
+    AC_REACTIVE_ENERGY_PHASE_1 = metric_sample_pb2.METRIC_AC_REACTIVE_ENERGY_PHASE_1
+    """The alternating current reactive energy in phase 1."""
+
+    AC_REACTIVE_ENERGY_PHASE_2 = metric_sample_pb2.METRIC_AC_REACTIVE_ENERGY_PHASE_2
+    """The alternating current reactive energy in phase 2."""
+
+    AC_REACTIVE_ENERGY_PHASE_3 = metric_sample_pb2.METRIC_AC_REACTIVE_ENERGY_PHASE_3
+    """The alternating current reactive energy in phase 3."""
+
+    AC_TOTAL_HARMONIC_DISTORTION_CURRENT = (
+        metric_sample_pb2.METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT
+    )
+    """The alternating current total harmonic distortion current."""
+
+    AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_1 = (
+        metric_sample_pb2.METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_1
+    )
+    """The alternating current total harmonic distortion current in phase 1."""
+
+    AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_2 = (
+        metric_sample_pb2.METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_2
+    )
+    """The alternating current total harmonic distortion current in phase 2."""
+
+    AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_3 = (
+        metric_sample_pb2.METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_3
+    )
+    """The alternating current total harmonic distortion current in phase 3."""
+
+    BATTERY_CAPACITY = metric_sample_pb2.METRIC_BATTERY_CAPACITY
+    """The capacity of the battery."""
+
+    BATTERY_SOC_PCT = metric_sample_pb2.METRIC_BATTERY_SOC_PCT
+    """The state of charge of the battery as a percentage."""
+
+    BATTERY_TEMPERATURE = metric_sample_pb2.METRIC_BATTERY_TEMPERATURE
+    """The temperature of the battery."""
+
+    INVERTER_TEMPERATURE = metric_sample_pb2.METRIC_INVERTER_TEMPERATURE
+    """The temperature of the inverter."""
+
+    INVERTER_TEMPERATURE_CABINET = metric_sample_pb2.METRIC_INVERTER_TEMPERATURE_CABINET
+    """The temperature of the inverter cabinet."""
+
+    INVERTER_TEMPERATURE_HEATSINK = (
+        metric_sample_pb2.METRIC_INVERTER_TEMPERATURE_HEATSINK
+    )
+    """The temperature of the inverter heatsink."""
+
+    INVERTER_TEMPERATURE_TRANSFORMER = (
+        metric_sample_pb2.METRIC_INVERTER_TEMPERATURE_TRANSFORMER
+    )
+    """The temperature of the inverter transformer."""
+
+    EV_CHARGER_TEMPERATURE = metric_sample_pb2.METRIC_EV_CHARGER_TEMPERATURE
+    """The temperature of the EV charger."""
+
+    SENSOR_WIND_SPEED = metric_sample_pb2.METRIC_SENSOR_WIND_SPEED
+    """The speed of the wind measured."""
+
+    SENSOR_WIND_DIRECTION = metric_sample_pb2.METRIC_SENSOR_WIND_DIRECTION
+    """The direction of the wind measured."""
+
+    SENSOR_TEMPERATURE = metric_sample_pb2.METRIC_SENSOR_TEMPERATURE
+    """The temperature measured."""
+
+    SENSOR_RELATIVE_HUMIDITY = metric_sample_pb2.METRIC_SENSOR_RELATIVE_HUMIDITY
+    """The relative humidity measured."""
+
+    SENSOR_DEW_POINT = metric_sample_pb2.METRIC_SENSOR_DEW_POINT
+    """The dew point measured."""
+
+    SENSOR_AIR_PRESSURE = metric_sample_pb2.METRIC_SENSOR_AIR_PRESSURE
+    """The air pressure measured."""
+
+    SENSOR_IRRADIANCE = metric_sample_pb2.METRIC_SENSOR_IRRADIANCE
+    """The irradiance measured."""