frequenz-client-common 0.3.6__tar.gz → 0.3.7__tar.gz

{frequenz_client_common-0.3.6/src/frequenz_client_common.egg-info → frequenz_client_common-0.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frequenz-client-common
-Version: 0.3.6
+Version: 0.3.7
 Summary: Common code and utilities for Frequenz API clients
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT
@@ -23,41 +23,44 @@ License-File: LICENSE
 Requires-Dist: typing-extensions<5,>=4.13.0
 Requires-Dist: frequenz-api-common<1,>=0.8.0
 Requires-Dist: frequenz-core<2,>=1.0.2
+Requires-Dist: protobuf<7,>=6.33.1
 Provides-Extra: dev-flake8
 Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
 Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
 Requires-Dist: flake8-pyproject==1.2.3; extra == "dev-flake8"
-Requires-Dist: pydoclint==0.6.6; extra == "dev-flake8"
+Requires-Dist: pydoclint==0.7.6; extra == "dev-flake8"
 Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
 Provides-Extra: dev-formatting
-Requires-Dist: black==25.1.0; extra == "dev-formatting"
-Requires-Dist: isort==6.0.1; extra == "dev-formatting"
+Requires-Dist: black==25.9.0; extra == "dev-formatting"
+Requires-Dist: isort==6.1.0; extra == "dev-formatting"
 Provides-Extra: dev-mkdocs
-Requires-Dist: Markdown==3.8.2; extra == "dev-mkdocs"
-Requires-Dist: black==25.1.0; extra == "dev-mkdocs"
+Requires-Dist: Markdown==3.9; extra == "dev-mkdocs"
+Requires-Dist: black==25.9.0; extra == "dev-mkdocs"
 Requires-Dist: mike==2.1.3; extra == "dev-mkdocs"
 Requires-Dist: mkdocs-gen-files==0.5.0; extra == "dev-mkdocs"
 Requires-Dist: mkdocs-literate-nav==0.6.2; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-macros-plugin==1.3.7; extra == "dev-mkdocs"
-Requires-Dist: mkdocs-material==9.6.16; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings[python]==0.30.0; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings-python==1.16.12; extra == "dev-mkdocs"
-Requires-Dist: frequenz-repo-config[lib]==0.13.5; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-macros-plugin==1.4.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-material==9.6.21; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings[python]==0.30.1; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings-python==1.18.2; extra == "dev-mkdocs"
+Requires-Dist: frequenz-repo-config[lib]==0.13.6; extra == "dev-mkdocs"
 Provides-Extra: dev-mypy
-Requires-Dist: mypy==1.17.1; extra == "dev-mypy"
-Requires-Dist: types-Markdown==3.8.0.20250708; extra == "dev-mypy"
+Requires-Dist: mypy==1.18.2; extra == "dev-mypy"
+Requires-Dist: types-Markdown==3.9.0.20250906; extra == "dev-mypy"
+Requires-Dist: types-protobuf==6.32.1.20251105; extra == "dev-mypy"
 Requires-Dist: frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
 Provides-Extra: dev-noxfile
-Requires-Dist: nox==2025.5.1; extra == "dev-noxfile"
-Requires-Dist: frequenz-repo-config[lib]==0.13.5; extra == "dev-noxfile"
+Requires-Dist: nox==2025.10.16; extra == "dev-noxfile"
+Requires-Dist: frequenz-repo-config[lib]==0.13.6; extra == "dev-noxfile"
 Provides-Extra: dev-pylint
-Requires-Dist: pylint==3.3.7; extra == "dev-pylint"
+Requires-Dist: pylint==4.0.3; extra == "dev-pylint"
 Requires-Dist: frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
 Provides-Extra: dev-pytest
-Requires-Dist: pytest==8.4.1; extra == "dev-pytest"
-Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.5; extra == "dev-pytest"
-Requires-Dist: pytest-mock==3.14.1; extra == "dev-pytest"
-Requires-Dist: pytest-asyncio==1.1.0; extra == "dev-pytest"
+Requires-Dist: pytest==8.4.2; extra == "dev-pytest"
+Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.6; extra == "dev-pytest"
+Requires-Dist: hypothesis==6.140.3; extra == "dev-pytest"
+Requires-Dist: pytest-mock==3.15.1; extra == "dev-pytest"
+Requires-Dist: pytest-asyncio==1.2.0; extra == "dev-pytest"
 Requires-Dist: async-solipsism==0.8; extra == "dev-pytest"
 Provides-Extra: dev
 Requires-Dist: frequenz-client-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"

frequenz_client_common-0.3.7/RELEASE_NOTES.md

@@ -0,0 +1,22 @@
+# Frequenz Client Common Library Release Notes
+
+## Summary
+
+This release main change is the introduction of a new `metrics` package compatible with the common API v0.8 (`v1alpha8`) (the old `metric` package, in singular, still works with the old v0.5/`v1` version).
+
+## Deprecations
+
+- The old `frequenz.client.common.enum_proto` module is now deprecated, please use `frequenz.client.common.proto.enum_from_proto` instead.
+
+## New Features
+
+- New `frequenz.client.common.common.proto` module with conversion utilities for protobuf types:
+  - `enum_from_proto()` (moved from `enum_proto).
+  - `datetime_to_proto()` and `datetime_from_proto()` functions to convert between Python `datetime` and protobuf `Timestamp` (imported from `frequenz-client-base`.
+- New `metrics` package compatible with API v0.8, which includes:
+  - `Metric` enum with all supported metrics.
+  - `MetricSample` dataclass to represent metric samples.
+  - `AggregatedMetricValue` dataclass to represent derived statistical summaries.
+  - `Bounds` dataclass to represent bounds for metrics.
+  - `MetricConnection` and `MetricConnectionCategory` to represent connections from which metrics are obtained.
+  - `proto` submodule with conversion functions to/from protobuf types.

{frequenz_client_common-0.3.6 → frequenz_client_common-0.3.7}/pyproject.toml

@@ -4,8 +4,8 @@
 [build-system]
 requires = [
   "setuptools == 80.9.0",
-  "setuptools_scm[toml] == 8.3.1",
-  "frequenz-repo-config[lib] == 0.13.5",
+  "setuptools_scm[toml] == 9.2.2",
+  "frequenz-repo-config[lib] == 0.13.6",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -29,6 +29,7 @@ dependencies = [
   "typing-extensions >= 4.13.0, < 5",
   "frequenz-api-common >= 0.8.0, < 1",
   "frequenz-core >= 1.0.2, < 2",
+  "protobuf >= 6.33.1, < 7",
 ]
 dynamic = ["version"]
 
@@ -41,39 +42,41 @@ dev-flake8 = [
   "flake8 == 7.3.0",
   "flake8-docstrings == 1.7.0",
   "flake8-pyproject == 1.2.3", # For reading the flake8 config from pyproject.toml
-  "pydoclint == 0.6.6",
+  "pydoclint == 0.7.6",
   "pydocstyle == 6.3.0",
 ]
-dev-formatting = ["black == 25.1.0", "isort == 6.0.1"]
+dev-formatting = ["black == 25.9.0", "isort == 6.1.0"]
 dev-mkdocs = [
-  "Markdown == 3.8.2",
-  "black == 25.1.0",
+  "Markdown == 3.9",
+  "black == 25.9.0",
   "mike == 2.1.3",
   "mkdocs-gen-files == 0.5.0",
   "mkdocs-literate-nav == 0.6.2",
-  "mkdocs-macros-plugin == 1.3.7",
-  "mkdocs-material == 9.6.16",
-  "mkdocstrings[python] == 0.30.0",
-  "mkdocstrings-python == 1.16.12",
-  "frequenz-repo-config[lib] == 0.13.5",
+  "mkdocs-macros-plugin == 1.4.0",
+  "mkdocs-material == 9.6.21",
+  "mkdocstrings[python] == 0.30.1",
+  "mkdocstrings-python == 1.18.2",
+  "frequenz-repo-config[lib] == 0.13.6",
 ]
 dev-mypy = [
-  "mypy == 1.17.1",
-  "types-Markdown == 3.8.0.20250708",
+  "mypy == 1.18.2",
+  "types-Markdown == 3.9.0.20250906",
+  "types-protobuf == 6.32.1.20251105",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
-dev-noxfile = ["nox == 2025.5.1", "frequenz-repo-config[lib] == 0.13.5"]
+dev-noxfile = ["nox == 2025.10.16", "frequenz-repo-config[lib] == 0.13.6"]
 dev-pylint = [
-  "pylint == 3.3.7",
+  "pylint == 4.0.3",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 8.4.1",
-  "frequenz-repo-config[extra-lint-examples] == 0.13.5",
-  "pytest-mock == 3.14.1",
-  "pytest-asyncio == 1.1.0",
+  "pytest == 8.4.2",
+  "frequenz-repo-config[extra-lint-examples] == 0.13.6",
+  "hypothesis == 6.140.3",
+  "pytest-mock == 3.15.1",
+  "pytest-asyncio == 1.2.0",
   "async-solipsism == 0.8",
 ]
 dev = [

frequenz_client_common-0.3.7/src/frequenz/client/common/enum_proto.py

@@ -0,0 +1,82 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Conversion of protobuf int enums to Python enums."""
+
+import enum
+from typing import Literal, TypeVar, overload
+
+from typing_extensions import deprecated
+
+EnumT = TypeVar("EnumT", bound=enum.Enum)
+"""A type variable that is bound to an enum."""
+
+
+@overload
+def enum_from_proto(
+    value: int, enum_type: type[EnumT], *, allow_invalid: Literal[False]
+) -> EnumT: ...
+
+
+@overload
+def enum_from_proto(
+    value: int, enum_type: type[EnumT], *, allow_invalid: Literal[True] = True
+) -> EnumT | int: ...
+
+
+@deprecated(
+    "frequenz.client.common.enum_proto.enum_from_proto is deprecated. "
+    "Please use frequenz.client.common.proto.enum_from_proto instead."
+)
+def enum_from_proto(
+    value: int, enum_type: type[EnumT], *, allow_invalid: bool = True
+) -> EnumT | int:
+    """Convert a protobuf int enum value to a python enum.
+
+    Example:
+        ```python
+        import enum
+
+        from proto import proto_pb2  # Just an example. pylint: disable=import-error
+
+        @enum.unique
+        class SomeEnum(enum.Enum):
+            # These values should match the protobuf enum values.
+            UNSPECIFIED = 0
+            SOME_VALUE = 1
+
+        enum_value = enum_from_proto(proto_pb2.SomeEnum.SOME_ENUM_SOME_VALUE, SomeEnum)
+        # -> SomeEnum.SOME_VALUE
+
+        enum_value = enum_from_proto(42, SomeEnum)
+        # -> 42
+
+        enum_value = enum_from_proto(
+            proto_pb2.SomeEnum.SOME_ENUM_UNKNOWN_VALUE, SomeEnum, allow_invalid=False
+        )
+        # -> ValueError
+        ```
+
+    Args:
+        value: The protobuf int enum value.
+        enum_type: The python enum type to convert to.
+        allow_invalid: If `True`, return the value as an `int` if the value is not
+            a valid member of the enum (this allows for forward-compatibility with new
+            enum values defined in the protocol but not added to the Python enum yet).
+            If `False`, raise a `ValueError` if the value is not a valid member of the
+            enum.
+
+    Returns:
+        The resulting python enum value if the protobuf value is known, otherwise
+            the input value converted to a plain `int`.
+
+    Raises:
+        ValueError: If `allow_invalid` is `False` and the value is not a valid member
+            of the enum.
+    """
+    try:
+        return enum_type(value)
+    except ValueError:
+        if allow_invalid:
+            return value
+        raise

{frequenz_client_common-0.3.6 → frequenz_client_common-0.3.7}/src/frequenz/client/common/metric/__init__.py

@@ -142,7 +142,10 @@ class Metric(enum.Enum):
     SENSOR_IRRADIANCE = PBMetric.METRIC_SENSOR_IRRADIANCE
 
     @classmethod
-    @deprecated("Use `frequenz.client.common.enum_proto.enum_from_proto` instead.")
+    @deprecated(
+        "frequenz.client.common.metric.Metric.from_proto() is deprecated. "
+        "Use frequenz.client.common.proto.enum_from_proto instead."
+    )
     def from_proto(cls, metric: PBMetric.ValueType) -> Self:
         """Convert a protobuf Metric value to Metric enum.
 

frequenz_client_common-0.3.7/src/frequenz/client/common/metrics/__init__.py

@@ -0,0 +1,24 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Metrics definitions."""
+
+from ._bounds import Bounds
+from ._metric import Metric
+from ._sample import (
+    AggregatedMetricValue,
+    AggregationMethod,
+    MetricConnection,
+    MetricConnectionCategory,
+    MetricSample,
+)
+
+__all__ = [
+    "AggregatedMetricValue",
+    "AggregationMethod",
+    "Bounds",
+    "Metric",
+    "MetricConnection",
+    "MetricConnectionCategory",
+    "MetricSample",
+]

frequenz_client_common-0.3.7/src/frequenz/client/common/metrics/_bounds.py

@@ -0,0 +1,45 @@
+# License: MIT
+# Copyright © 2024 Frequenz Energy-as-a-Service GmbH
+
+
+"""Definitions for bounds."""
+
+import dataclasses
+
+
+@dataclasses.dataclass(frozen=True, kw_only=True)
+class Bounds:
+    """A set of lower and upper bounds for any metric.
+
+    The lower bound must be less than or equal to the upper bound.
+
+    The units of the bounds are always the same as the related metric.
+    """
+
+    lower: float | None = None
+    """The lower bound.
+
+    If `None`, there is no lower bound.
+    """
+
+    upper: float | None = None
+    """The upper bound.
+
+    If `None`, there is no upper bound.
+    """
+
+    def __post_init__(self) -> None:
+        """Validate these bounds."""
+        if self.lower is None:
+            return
+        if self.upper is None:
+            return
+        if self.lower > self.upper:
+            raise ValueError(
+                f"Lower bound ({self.lower}) must be less than or equal to upper "
+                f"bound ({self.upper})"
+            )
+
+    def __str__(self) -> str:
+        """Return a string representation of these bounds."""
+        return f"[{self.lower}, {self.upper}]"

frequenz_client_common-0.3.7/src/frequenz/client/common/metrics/_metric.py

@@ -0,0 +1,278 @@
+# License: MIT
+# Copyright © 2024 Frequenz Energy-as-a-Service GmbH
+
+"""Supported metrics for microgrid components."""
+
+
+import enum
+
+from frequenz.api.common.v1alpha8.metrics import metrics_pb2
+
+
+@enum.unique
+class Metric(enum.Enum):
+    """List of supported metrics.
+
+    Metric units are as follows:
+
+    * `VOLTAGE`: V (Volts)
+    * `CURRENT`: A (Amperes)
+    * `POWER_ACTIVE`: W (Watts)
+    * `POWER_APPARENT`: VA (Volt-Amperes)
+    * `POWER_REACTIVE`: VAr (Volt-Amperes reactive)
+    * `ENERGY_ACTIVE`: Wh (Watt-hours)
+    * `ENERGY_APPARENT`: VAh (Volt-Ampere hours)
+    * `ENERGY_REACTIVE`: VArh (Volt-Ampere reactive hours)
+    * `FREQUENCY`: Hz (Hertz)
+    * `TEMPERATURE`: °C (Degree Celsius)
+    * `BATTERY_SOC_PCT`: % (percentage)
+    * `BATTERY_CAPACITY`: Wh (Watt-hours)
+    * `FACTOR`: no unit
+
+    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 = metrics_pb2.METRIC_UNSPECIFIED
+    """The metric is unspecified (this should not be used)."""
+
+    DC_VOLTAGE = metrics_pb2.METRIC_DC_VOLTAGE
+    """The DC voltage."""
+
+    DC_CURRENT = metrics_pb2.METRIC_DC_CURRENT
+    """The DC current."""
+
+    DC_POWER = metrics_pb2.METRIC_DC_POWER
+    """The DC power."""
+
+    AC_FREQUENCY = metrics_pb2.METRIC_AC_FREQUENCY
+    """The AC frequency."""
+
+    AC_VOLTAGE = metrics_pb2.METRIC_AC_VOLTAGE
+    """The AC electric potential difference."""
+
+    AC_VOLTAGE_PHASE_1_N = metrics_pb2.METRIC_AC_VOLTAGE_PHASE_1_N
+    """The AC electric potential difference between phase 1 and neutral."""
+
+    AC_VOLTAGE_PHASE_2_N = metrics_pb2.METRIC_AC_VOLTAGE_PHASE_2_N
+    """The AC electric potential difference between phase 2 and neutral."""
+
+    AC_VOLTAGE_PHASE_3_N = metrics_pb2.METRIC_AC_VOLTAGE_PHASE_3_N
+    """The AC electric potential difference between phase 3 and neutral."""
+
+    AC_VOLTAGE_PHASE_1_PHASE_2 = metrics_pb2.METRIC_AC_VOLTAGE_PHASE_1_PHASE_2
+    """The AC electric potential difference between phase 1 and phase 2."""
+
+    AC_VOLTAGE_PHASE_2_PHASE_3 = metrics_pb2.METRIC_AC_VOLTAGE_PHASE_2_PHASE_3
+    """The AC electric potential difference between phase 2 and phase 3."""
+
+    AC_VOLTAGE_PHASE_3_PHASE_1 = metrics_pb2.METRIC_AC_VOLTAGE_PHASE_3_PHASE_1
+    """The AC electric potential difference between phase 3 and phase 1."""
+
+    AC_CURRENT = metrics_pb2.METRIC_AC_CURRENT
+    """The AC current."""
+
+    AC_CURRENT_PHASE_1 = metrics_pb2.METRIC_AC_CURRENT_PHASE_1
+    """The AC current in phase 1."""
+
+    AC_CURRENT_PHASE_2 = metrics_pb2.METRIC_AC_CURRENT_PHASE_2
+    """The AC current in phase 2."""
+
+    AC_CURRENT_PHASE_3 = metrics_pb2.METRIC_AC_CURRENT_PHASE_3
+    """The AC current in phase 3."""
+
+    AC_POWER_APPARENT = metrics_pb2.METRIC_AC_POWER_APPARENT
+    """The AC apparent power."""
+
+    AC_POWER_APPARENT_PHASE_1 = metrics_pb2.METRIC_AC_POWER_APPARENT_PHASE_1
+    """The AC apparent power in phase 1."""
+
+    AC_POWER_APPARENT_PHASE_2 = metrics_pb2.METRIC_AC_POWER_APPARENT_PHASE_2
+    """The AC apparent power in phase 2."""
+
+    AC_POWER_APPARENT_PHASE_3 = metrics_pb2.METRIC_AC_POWER_APPARENT_PHASE_3
+    """The AC apparent power in phase 3."""
+
+    AC_POWER_ACTIVE = metrics_pb2.METRIC_AC_POWER_ACTIVE
+    """The AC active power."""
+
+    AC_POWER_ACTIVE_PHASE_1 = metrics_pb2.METRIC_AC_POWER_ACTIVE_PHASE_1
+    """The AC active power in phase 1."""
+
+    AC_POWER_ACTIVE_PHASE_2 = metrics_pb2.METRIC_AC_POWER_ACTIVE_PHASE_2
+    """The AC active power in phase 2."""
+
+    AC_POWER_ACTIVE_PHASE_3 = metrics_pb2.METRIC_AC_POWER_ACTIVE_PHASE_3
+    """The AC active power in phase 3."""
+
+    AC_POWER_REACTIVE = metrics_pb2.METRIC_AC_POWER_REACTIVE
+    """The AC reactive power."""
+
+    AC_POWER_REACTIVE_PHASE_1 = metrics_pb2.METRIC_AC_POWER_REACTIVE_PHASE_1
+    """The AC reactive power in phase 1."""
+
+    AC_POWER_REACTIVE_PHASE_2 = metrics_pb2.METRIC_AC_POWER_REACTIVE_PHASE_2
+    """The AC reactive power in phase 2."""
+
+    AC_POWER_REACTIVE_PHASE_3 = metrics_pb2.METRIC_AC_POWER_REACTIVE_PHASE_3
+    """The AC reactive power in phase 3."""
+
+    AC_POWER_FACTOR = metrics_pb2.METRIC_AC_POWER_FACTOR
+    """The AC power factor."""
+
+    AC_POWER_FACTOR_PHASE_1 = metrics_pb2.METRIC_AC_POWER_FACTOR_PHASE_1
+    """The AC power factor in phase 1."""
+
+    AC_POWER_FACTOR_PHASE_2 = metrics_pb2.METRIC_AC_POWER_FACTOR_PHASE_2
+    """The AC power factor in phase 2."""
+
+    AC_POWER_FACTOR_PHASE_3 = metrics_pb2.METRIC_AC_POWER_FACTOR_PHASE_3
+    """The AC power factor in phase 3."""
+
+    AC_ENERGY_APPARENT = metrics_pb2.METRIC_AC_ENERGY_APPARENT
+    """The AC apparent energy."""
+
+    AC_ENERGY_APPARENT_PHASE_1 = metrics_pb2.METRIC_AC_ENERGY_APPARENT_PHASE_1
+    """The AC apparent energy in phase 1."""
+
+    AC_ENERGY_APPARENT_PHASE_2 = metrics_pb2.METRIC_AC_ENERGY_APPARENT_PHASE_2
+    """The AC apparent energy in phase 2."""
+
+    AC_ENERGY_APPARENT_PHASE_3 = metrics_pb2.METRIC_AC_ENERGY_APPARENT_PHASE_3
+    """The AC apparent energy in phase 3."""
+
+    AC_ENERGY_ACTIVE = metrics_pb2.METRIC_AC_ENERGY_ACTIVE
+    """The AC active energy."""
+
+    AC_ENERGY_ACTIVE_PHASE_1 = metrics_pb2.METRIC_AC_ENERGY_ACTIVE_PHASE_1
+    """The AC active energy in phase 1."""
+
+    AC_ENERGY_ACTIVE_PHASE_2 = metrics_pb2.METRIC_AC_ENERGY_ACTIVE_PHASE_2
+    """The AC active energy in phase 2."""
+
+    AC_ENERGY_ACTIVE_PHASE_3 = metrics_pb2.METRIC_AC_ENERGY_ACTIVE_PHASE_3
+    """The AC active energy in phase 3."""
+
+    AC_ENERGY_ACTIVE_CONSUMED = metrics_pb2.METRIC_AC_ENERGY_ACTIVE_CONSUMED
+    """The AC active energy consumed."""
+
+    AC_ENERGY_ACTIVE_CONSUMED_PHASE_1 = (
+        metrics_pb2.METRIC_AC_ENERGY_ACTIVE_CONSUMED_PHASE_1
+    )
+    """The AC active energy consumed in phase 1."""
+
+    AC_ENERGY_ACTIVE_CONSUMED_PHASE_2 = (
+        metrics_pb2.METRIC_AC_ENERGY_ACTIVE_CONSUMED_PHASE_2
+    )
+    """The AC active energy consumed in phase 2."""
+
+    AC_ENERGY_ACTIVE_CONSUMED_PHASE_3 = (
+        metrics_pb2.METRIC_AC_ENERGY_ACTIVE_CONSUMED_PHASE_3
+    )
+    """The AC active energy consumed in phase 3."""
+
+    AC_ENERGY_ACTIVE_DELIVERED = metrics_pb2.METRIC_AC_ENERGY_ACTIVE_DELIVERED
+    """The AC active energy delivered."""
+
+    AC_ENERGY_ACTIVE_DELIVERED_PHASE_1 = (
+        metrics_pb2.METRIC_AC_ENERGY_ACTIVE_DELIVERED_PHASE_1
+    )
+    """The AC active energy delivered in phase 1."""
+
+    AC_ENERGY_ACTIVE_DELIVERED_PHASE_2 = (
+        metrics_pb2.METRIC_AC_ENERGY_ACTIVE_DELIVERED_PHASE_2
+    )
+    """The AC active energy delivered in phase 2."""
+
+    AC_ENERGY_ACTIVE_DELIVERED_PHASE_3 = (
+        metrics_pb2.METRIC_AC_ENERGY_ACTIVE_DELIVERED_PHASE_3
+    )
+    """The AC active energy delivered in phase 3."""
+
+    AC_ENERGY_REACTIVE = metrics_pb2.METRIC_AC_ENERGY_REACTIVE
+    """The AC reactive energy."""
+
+    AC_ENERGY_REACTIVE_PHASE_1 = metrics_pb2.METRIC_AC_ENERGY_REACTIVE_PHASE_1
+    """The AC reactive energy in phase 1."""
+
+    AC_ENERGY_REACTIVE_PHASE_2 = metrics_pb2.METRIC_AC_ENERGY_REACTIVE_PHASE_2
+    """The AC reactive energy in phase 2."""
+
+    AC_ENERGY_REACTIVE_PHASE_3 = metrics_pb2.METRIC_AC_ENERGY_REACTIVE_PHASE_3
+    """The AC reactive energy in phase 3."""
+
+    AC_TOTAL_HARMONIC_DISTORTION_CURRENT = (
+        metrics_pb2.METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT
+    )
+    """The AC total harmonic distortion current."""
+
+    AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_1 = (
+        metrics_pb2.METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_1
+    )
+    """The AC total harmonic distortion current in phase 1."""
+
+    AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_2 = (
+        metrics_pb2.METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_2
+    )
+    """The AC total harmonic distortion current in phase 2."""
+
+    AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_3 = (
+        metrics_pb2.METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_3
+    )
+    """The AC total harmonic distortion current in phase 3."""
+
+    BATTERY_CAPACITY = metrics_pb2.METRIC_BATTERY_CAPACITY
+    """The capacity of the battery."""
+
+    BATTERY_SOC_PCT = metrics_pb2.METRIC_BATTERY_SOC_PCT
+    """The state of charge of the battery as a percentage."""
+
+    BATTERY_TEMPERATURE = metrics_pb2.METRIC_BATTERY_TEMPERATURE
+    """The temperature of the battery."""
+
+    INVERTER_TEMPERATURE = metrics_pb2.METRIC_INVERTER_TEMPERATURE
+    """The temperature of the inverter."""
+
+    INVERTER_TEMPERATURE_CABINET = metrics_pb2.METRIC_INVERTER_TEMPERATURE_CABINET
+    """The temperature of the inverter cabinet."""
+
+    INVERTER_TEMPERATURE_HEATSINK = metrics_pb2.METRIC_INVERTER_TEMPERATURE_HEATSINK
+    """The temperature of the inverter heatsink."""
+
+    INVERTER_TEMPERATURE_TRANSFORMER = (
+        metrics_pb2.METRIC_INVERTER_TEMPERATURE_TRANSFORMER
+    )
+    """The temperature of the inverter transformer."""
+
+    EV_CHARGER_TEMPERATURE = metrics_pb2.METRIC_EV_CHARGER_TEMPERATURE
+    """The temperature of the EV charger."""
+
+    SENSOR_WIND_SPEED = metrics_pb2.METRIC_SENSOR_WIND_SPEED
+    """The speed of the wind measured."""
+
+    SENSOR_WIND_DIRECTION = metrics_pb2.METRIC_SENSOR_WIND_DIRECTION
+    """The direction of the wind measured."""
+
+    SENSOR_TEMPERATURE = metrics_pb2.METRIC_SENSOR_TEMPERATURE
+    """The temperature measured."""
+
+    SENSOR_RELATIVE_HUMIDITY = metrics_pb2.METRIC_SENSOR_RELATIVE_HUMIDITY
+    """The relative humidity measured."""
+
+    SENSOR_DEW_POINT = metrics_pb2.METRIC_SENSOR_DEW_POINT
+    """The dew point measured."""
+
+    SENSOR_AIR_PRESSURE = metrics_pb2.METRIC_SENSOR_AIR_PRESSURE
+    """The air pressure measured."""
+
+    SENSOR_IRRADIANCE = metrics_pb2.METRIC_SENSOR_IRRADIANCE
+    """The irradiance measured."""