frequenz-client-common 0.3.2__tar.gz → 0.3.4__tar.gz

{frequenz_client_common-0.3.2/src/frequenz_client_common.egg-info → frequenz_client_common-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frequenz-client-common
-Version: 0.3.2
+Version: 0.3.4
 Summary: Common code and utilities for Frequenz API clients
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
 License: MIT
@@ -21,10 +21,10 @@ Requires-Python: <4,>=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: typing-extensions<5,>=4.13.0
-Requires-Dist: frequenz-api-common<7,>=0.6.0
-Requires-Dist: frequenz-core<2,>=1.0.0
+Requires-Dist: frequenz-api-common<9,>=0.8.0
+Requires-Dist: frequenz-core<2,>=1.0.2
 Provides-Extra: dev-flake8
-Requires-Dist: flake8==7.2.0; 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"
@@ -33,32 +33,32 @@ Provides-Extra: dev-formatting
 Requires-Dist: black==25.1.0; extra == "dev-formatting"
 Requires-Dist: isort==6.0.1; extra == "dev-formatting"
 Provides-Extra: dev-mkdocs
-Requires-Dist: Markdown==3.8; extra == "dev-mkdocs"
+Requires-Dist: Markdown==3.8.2; extra == "dev-mkdocs"
 Requires-Dist: black==25.1.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.12; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings[python]==0.29.1; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings-python==1.16.10; extra == "dev-mkdocs"
-Requires-Dist: frequenz-repo-config[lib]==0.13.3; 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"
 Provides-Extra: dev-mypy
-Requires-Dist: mypy==1.15.0; extra == "dev-mypy"
-Requires-Dist: types-Markdown==3.8.0.20250415; 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: 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.3; extra == "dev-noxfile"
+Requires-Dist: frequenz-repo-config[lib]==0.13.5; extra == "dev-noxfile"
 Provides-Extra: dev-pylint
-Requires-Dist: pylint==3.3.6; extra == "dev-pylint"
+Requires-Dist: pylint==3.3.7; 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.3.5; extra == "dev-pytest"
-Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.13.3; extra == "dev-pytest"
-Requires-Dist: pytest-mock==3.14.0; extra == "dev-pytest"
-Requires-Dist: pytest-asyncio==0.26.0; extra == "dev-pytest"
-Requires-Dist: async-solipsism==0.7; 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: 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"
 Dynamic: license-file

frequenz_client_common-0.3.4/RELEASE_NOTES.md

@@ -0,0 +1,18 @@
+# Frequenz Client Common Library Release Notes
+
+## Summary
+
+This release introduces the `v1alpha8` module to support a new API version.
+
+## Upgrading
+
+<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
+
+## New Features
+
+- Provide access to new API using new `v1alpha8` module.
+- Mapping for the new `Event` message has been added.
+
+## Bug Fixes
+
+- Updated display of protobuf version warnings

{frequenz_client_common-0.3.2 → frequenz_client_common-0.3.4}/pyproject.toml

@@ -3,9 +3,9 @@
 
 [build-system]
 requires = [
-  "setuptools == 80.3.1",
+  "setuptools == 80.9.0",
   "setuptools_scm[toml] == 8.3.1",
-  "frequenz-repo-config[lib] == 0.13.3",
+  "frequenz-repo-config[lib] == 0.13.5",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -27,8 +27,8 @@ classifiers = [
 requires-python = ">= 3.11, < 4"
 dependencies = [
   "typing-extensions >= 4.13.0, < 5",
-  "frequenz-api-common >= 0.6.0, < 7",
-  "frequenz-core >= 1.0.0, < 2",
+  "frequenz-api-common >= 0.8.0, < 9",
+  "frequenz-core >= 1.0.2, < 2",
 ]
 dynamic = ["version"]
 
@@ -38,43 +38,43 @@ email = "floss@frequenz.com"
 
 [project.optional-dependencies]
 dev-flake8 = [
-  "flake8 == 7.2.0",
+  "flake8 == 7.3.0",
   "flake8-docstrings == 1.7.0",
-  "flake8-pyproject == 1.2.3", # For reading the flake8 config from pyproject.toml
+  "flake8-pyproject == 1.2.3",  # For reading the flake8 config from pyproject.toml
   "pydoclint == 0.6.6",
   "pydocstyle == 6.3.0",
 ]
 dev-formatting = ["black == 25.1.0", "isort == 6.0.1"]
 dev-mkdocs = [
-  "Markdown == 3.8",
+  "Markdown == 3.8.2",
   "black == 25.1.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.12",
-  "mkdocstrings[python] == 0.29.1",
-  "mkdocstrings-python == 1.16.10",
-  "frequenz-repo-config[lib] == 0.13.3",
+  "mkdocs-material == 9.6.16",
+  "mkdocstrings[python] == 0.30.0",
+  "mkdocstrings-python == 1.16.12",
+  "frequenz-repo-config[lib] == 0.13.5",
 ]
 dev-mypy = [
-  "mypy == 1.15.0",
-  "types-Markdown == 3.8.0.20250415",
+  "mypy == 1.17.1",
+  "types-Markdown == 3.8.0.20250708",
   # 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.3"]
+dev-noxfile = ["nox == 2025.5.1", "frequenz-repo-config[lib] == 0.13.5"]
 dev-pylint = [
-  "pylint == 3.3.6",
+  "pylint == 3.3.7",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 8.3.5",
-  "frequenz-repo-config[extra-lint-examples] == 0.13.3",
-  "pytest-mock == 3.14.0",
-  "pytest-asyncio == 0.26.0",
-  "async-solipsism == 0.7",
+  "pytest == 8.4.1",
+  "frequenz-repo-config[extra-lint-examples] == 0.13.5",
+  "pytest-mock == 3.14.1",
+  "pytest-asyncio == 1.1.0",
+  "async-solipsism == 0.8",
 ]
 dev = [
   "frequenz-client-common[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
@@ -145,7 +145,6 @@ disable = [
 ]
 
 [tool.pytest.ini_options]
-addopts = "-vv"
 filterwarnings = [
   "error",
   "once::DeprecationWarning",
@@ -157,6 +156,7 @@ filterwarnings = [
   # characters as this is a regex.
   'ignore:Protobuf gencode version .*exactly one major version older.*:UserWarning',
 ]
+addopts = "-vv"
 testpaths = ["tests", "src"]
 asyncio_mode = "auto"
 asyncio_default_fixture_loop_scope = "function"

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

@@ -0,0 +1,76 @@
+# 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
+
+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: ...
+
+
+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.2 → frequenz_client_common-0.3.4}/src/frequenz/client/common/metric/__init__.py

@@ -3,16 +3,18 @@
 
 """Module to define the metrics used with the common client."""
 
-from enum import Enum
+import enum
 from typing import Self
 
 # pylint: disable=no-name-in-module
 from frequenz.api.common.v1.metrics.metric_sample_pb2 import Metric as PBMetric
+from typing_extensions import deprecated
 
 # pylint: enable=no-name-in-module
 
 
-class Metric(Enum):
+@enum.unique
+class Metric(enum.Enum):
     """List of supported metrics.
 
     AC energy metrics information:
@@ -140,6 +142,7 @@ class Metric(Enum):
     SENSOR_IRRADIANCE = PBMetric.METRIC_SENSOR_IRRADIANCE
 
     @classmethod
+    @deprecated("Use `frequenz.client.common.enum_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.2 → frequenz_client_common-0.3.4}/src/frequenz/client/common/microgrid/components/__init__.py

@@ -5,7 +5,7 @@
 
 from __future__ import annotations
 
-from enum import Enum
+import enum
 from typing import final
 
 # pylint: disable=no-name-in-module
@@ -19,6 +19,7 @@ from frequenz.api.common.v1.microgrid.components.components_pb2 import (
     ComponentStateCode as PBComponentStateCode,
 )
 from frequenz.core.id import BaseId
+from typing_extensions import deprecated
 
 # pylint: enable=no-name-in-module
 
@@ -28,7 +29,8 @@ class ComponentId(BaseId, str_prefix="CID"):
     """A unique identifier for a microgrid component."""
 
 
-class ComponentCategory(Enum):
+@enum.unique
+class ComponentCategory(enum.Enum):
     """Possible types of microgrid component."""
 
     UNSPECIFIED = PBComponentCategory.COMPONENT_CATEGORY_UNSPECIFIED
@@ -47,16 +49,63 @@ class ComponentCategory(Enum):
     INVERTER = PBComponentCategory.COMPONENT_CATEGORY_INVERTER
     """An electricity generator, with batteries or solar energy."""
 
+    CONVERTER = PBComponentCategory.COMPONENT_CATEGORY_CONVERTER
+    """A DC-DC converter."""
+
     BATTERY = PBComponentCategory.COMPONENT_CATEGORY_BATTERY
     """A storage system for electrical energy, used by inverters."""
 
     EV_CHARGER = PBComponentCategory.COMPONENT_CATEGORY_EV_CHARGER
     """A station for charging electrical vehicles."""
 
+    CRYPTO_MINER = PBComponentCategory.COMPONENT_CATEGORY_CRYPTO_MINER
+    """A crypto miner."""
+
+    ELECTROLYZER = PBComponentCategory.COMPONENT_CATEGORY_ELECTROLYZER
+    """An electrolyzer for converting water into hydrogen and oxygen."""
+
     CHP = PBComponentCategory.COMPONENT_CATEGORY_CHP
     """A heat and power combustion plant (CHP stands for combined heat and power)."""
 
+    RELAY = PBComponentCategory.COMPONENT_CATEGORY_RELAY
+    """A relay.
+
+    Relays generally have two states: open (connected) and closed (disconnected).
+    They are generally placed in front of a component, e.g., an inverter, to
+    control whether the component is connected to the grid or not.
+    """
+
+    PRECHARGER = PBComponentCategory.COMPONENT_CATEGORY_PRECHARGER
+    """A precharge module.
+
+    Precharging involves gradually ramping up the DC voltage to prevent any
+    potential damage to sensitive electrical components like capacitors.
+
+    While many inverters and batteries come equipped with in-built precharging
+    mechanisms, some may lack this feature. In such cases, we need to use
+    external precharging modules.
+    """
+
+    FUSE = PBComponentCategory.COMPONENT_CATEGORY_FUSE
+    """A fuse."""
+
+    VOLTAGE_TRANSFORMER = PBComponentCategory.COMPONENT_CATEGORY_VOLTAGE_TRANSFORMER
+    """A voltage transformer.
+
+    Voltage transformers are used to step up or step down the voltage, keeping
+    the power somewhat constant by increasing or decreasing the current.  If voltage is
+    stepped up, current is stepped down, and vice versa.
+
+    Note:
+        Voltage transformers have efficiency losses, so the output power is
+        always less than the input power.
+    """
+
+    HVAC = PBComponentCategory.COMPONENT_CATEGORY_HVAC
+    """A Heating, Ventilation, and Air Conditioning (HVAC) system."""
+
     @classmethod
+    @deprecated("Use `frequenz.client.common.enum_proto.enum_from_proto` instead.")
     def from_proto(
         cls, component_category: PBComponentCategory.ValueType
     ) -> ComponentCategory:
@@ -81,7 +130,8 @@ class ComponentCategory(Enum):
         return self.value
 
 
-class ComponentStateCode(Enum):
+@enum.unique
+class ComponentStateCode(enum.Enum):
     """All possible states of a microgrid component."""
 
     UNSPECIFIED = PBComponentStateCode.COMPONENT_STATE_CODE_UNSPECIFIED
@@ -161,6 +211,7 @@ class ComponentStateCode(Enum):
     """The precharger circuit is closed, allowing full current to flow to the main circuit."""
 
     @classmethod
+    @deprecated("Use `frequenz.client.common.enum_proto.enum_from_proto` instead.")
     def from_proto(
         cls, component_state: PBComponentStateCode.ValueType
     ) -> ComponentStateCode:
@@ -185,7 +236,8 @@ class ComponentStateCode(Enum):
         return self.value
 
 
-class ComponentErrorCode(Enum):
+@enum.unique
+class ComponentErrorCode(enum.Enum):
     """All possible errors that can occur across all microgrid component categories."""
 
     UNSPECIFIED = PBComponentErrorCode.COMPONENT_ERROR_CODE_UNSPECIFIED
@@ -338,6 +390,7 @@ class ComponentErrorCode(Enum):
     times."""
 
     @classmethod
+    @deprecated("Use `frequenz.client.common.enum_proto.enum_from_proto` instead.")
     def from_proto(
         cls, component_error_code: PBComponentErrorCode.ValueType
     ) -> ComponentErrorCode:

frequenz_client_common-0.3.4/src/frequenz/client/common/v1alpha8/__init__.py

@@ -0,0 +1,4 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Types introduced or modified in the v1alpha8 version of the common api."""

frequenz_client_common-0.3.4/src/frequenz/client/common/v1alpha8/metric/__init__.py

@@ -0,0 +1,162 @@
+# License: MIT
+# Copyright © 2024 Frequenz Energy-as-a-Service GmbH
+
+"""Module to define the metrics used with the common client."""
+
+import enum
+from typing import Self
+
+from frequenz.api.common.v1alpha8.metrics.metrics_pb2 import Metric as PBMetric
+from typing_extensions import deprecated
+
+
+@enum.unique
+class Metric(enum.Enum):
+    """List of supported metrics.
+
+    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 timestamp since when the energy
+    was being accumulated, and therefore can be inconsistent.
+    """
+
+    # Default value
+    UNSPECIFIED = PBMetric.METRIC_UNSPECIFIED
+
+    # DC electricity metrics
+    DC_VOLTAGE = PBMetric.METRIC_DC_VOLTAGE
+    DC_CURRENT = PBMetric.METRIC_DC_CURRENT
+    DC_POWER = PBMetric.METRIC_DC_POWER
+
+    # General AC electricity metrics
+    AC_FREQUENCY = PBMetric.METRIC_AC_FREQUENCY
+    AC_VOLTAGE = PBMetric.METRIC_AC_VOLTAGE
+    AC_VOLTAGE_PHASE_1_N = PBMetric.METRIC_AC_VOLTAGE_PHASE_1_N
+    AC_VOLTAGE_PHASE_2_N = PBMetric.METRIC_AC_VOLTAGE_PHASE_2_N
+    AC_VOLTAGE_PHASE_3_N = PBMetric.METRIC_AC_VOLTAGE_PHASE_3_N
+    AC_VOLTAGE_PHASE_1_PHASE_2 = PBMetric.METRIC_AC_VOLTAGE_PHASE_1_PHASE_2
+    AC_VOLTAGE_PHASE_2_PHASE_3 = PBMetric.METRIC_AC_VOLTAGE_PHASE_2_PHASE_3
+    AC_VOLTAGE_PHASE_3_PHASE_1 = PBMetric.METRIC_AC_VOLTAGE_PHASE_3_PHASE_1
+    AC_CURRENT = PBMetric.METRIC_AC_CURRENT
+    AC_CURRENT_PHASE_1 = PBMetric.METRIC_AC_CURRENT_PHASE_1
+    AC_CURRENT_PHASE_2 = PBMetric.METRIC_AC_CURRENT_PHASE_2
+    AC_CURRENT_PHASE_3 = PBMetric.METRIC_AC_CURRENT_PHASE_3
+
+    # AC power metrics
+    AC_POWER_APPARENT = PBMetric.METRIC_AC_POWER_APPARENT
+    AC_POWER_APPARENT_PHASE_1 = PBMetric.METRIC_AC_POWER_APPARENT_PHASE_1
+    AC_POWER_APPARENT_PHASE_2 = PBMetric.METRIC_AC_POWER_APPARENT_PHASE_2
+    AC_POWER_APPARENT_PHASE_3 = PBMetric.METRIC_AC_POWER_APPARENT_PHASE_3
+    AC_POWER_ACTIVE = PBMetric.METRIC_AC_POWER_ACTIVE
+    AC_POWER_ACTIVE_PHASE_1 = PBMetric.METRIC_AC_POWER_ACTIVE_PHASE_1
+    AC_POWER_ACTIVE_PHASE_2 = PBMetric.METRIC_AC_POWER_ACTIVE_PHASE_2
+    AC_POWER_ACTIVE_PHASE_3 = PBMetric.METRIC_AC_POWER_ACTIVE_PHASE_3
+    AC_POWER_REACTIVE = PBMetric.METRIC_AC_POWER_REACTIVE
+    AC_POWER_REACTIVE_PHASE_1 = PBMetric.METRIC_AC_POWER_REACTIVE_PHASE_1
+    AC_POWER_REACTIVE_PHASE_2 = PBMetric.METRIC_AC_POWER_REACTIVE_PHASE_2
+    AC_POWER_REACTIVE_PHASE_3 = PBMetric.METRIC_AC_POWER_REACTIVE_PHASE_3
+
+    # AC power factor
+    AC_POWER_FACTOR = PBMetric.METRIC_AC_POWER_FACTOR
+    AC_POWER_FACTOR_PHASE_1 = PBMetric.METRIC_AC_POWER_FACTOR_PHASE_1
+    AC_POWER_FACTOR_PHASE_2 = PBMetric.METRIC_AC_POWER_FACTOR_PHASE_2
+    AC_POWER_FACTOR_PHASE_3 = PBMetric.METRIC_AC_POWER_FACTOR_PHASE_3
+
+    # AC energy metrics - Please be careful when using and check Enum docs
+    AC_ENERGY_APPARENT = PBMetric.METRIC_AC_ENERGY_APPARENT
+    AC_ENERGY_APPARENT_PHASE_1 = PBMetric.METRIC_AC_ENERGY_APPARENT_PHASE_1
+    AC_ENERGY_APPARENT_PHASE_2 = PBMetric.METRIC_AC_ENERGY_APPARENT_PHASE_2
+    AC_ENERGY_APPARENT_PHASE_3 = PBMetric.METRIC_AC_ENERGY_APPARENT_PHASE_3
+    AC_ENERGY_ACTIVE = PBMetric.METRIC_AC_ENERGY_ACTIVE
+    AC_ENERGY_ACTIVE_PHASE_1 = PBMetric.METRIC_AC_ENERGY_ACTIVE_PHASE_1
+    AC_ENERGY_ACTIVE_PHASE_2 = PBMetric.METRIC_AC_ENERGY_ACTIVE_PHASE_2
+    AC_ENERGY_ACTIVE_PHASE_3 = PBMetric.METRIC_AC_ENERGY_ACTIVE_PHASE_3
+    AC_ENERGY_ACTIVE_CONSUMED = PBMetric.METRIC_AC_ENERGY_ACTIVE_CONSUMED
+    AC_ENERGY_ACTIVE_CONSUMED_PHASE_1 = (
+        PBMetric.METRIC_AC_ENERGY_ACTIVE_CONSUMED_PHASE_1
+    )
+    AC_ENERGY_ACTIVE_CONSUMED_PHASE_2 = (
+        PBMetric.METRIC_AC_ENERGY_ACTIVE_CONSUMED_PHASE_2
+    )
+    AC_ENERGY_ACTIVE_CONSUMED_PHASE_3 = (
+        PBMetric.METRIC_AC_ENERGY_ACTIVE_CONSUMED_PHASE_3
+    )
+    AC_ENERGY_ACTIVE_DELIVERED = PBMetric.METRIC_AC_ENERGY_ACTIVE_DELIVERED
+    AC_ENERGY_ACTIVE_DELIVERED_PHASE_1 = (
+        PBMetric.METRIC_AC_ENERGY_ACTIVE_DELIVERED_PHASE_1
+    )
+    AC_ENERGY_ACTIVE_DELIVERED_PHASE_2 = (
+        PBMetric.METRIC_AC_ENERGY_ACTIVE_DELIVERED_PHASE_2
+    )
+    AC_ENERGY_ACTIVE_DELIVERED_PHASE_3 = (
+        PBMetric.METRIC_AC_ENERGY_ACTIVE_DELIVERED_PHASE_3
+    )
+    AC_ENERGY_REACTIVE = PBMetric.METRIC_AC_ENERGY_REACTIVE
+    AC_ENERGY_REACTIVE_PHASE_1 = PBMetric.METRIC_AC_ENERGY_REACTIVE_PHASE_1
+    AC_ENERGY_REACTIVE_PHASE_2 = PBMetric.METRIC_AC_ENERGY_REACTIVE_PHASE_2
+    AC_ENERGY_REACTIVE_PHASE_3 = PBMetric.METRIC_AC_ENERGY_REACTIVE_PHASE_3
+
+    # AC harmonics
+    AC_TOTAL_HARMONIC_DISTORTION_CURRENT = (
+        PBMetric.METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT
+    )
+    AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_1 = (
+        PBMetric.METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_1
+    )
+    AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_2 = (
+        PBMetric.METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_2
+    )
+    AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_3 = (
+        PBMetric.METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_3
+    )
+
+    # General BMS metrics
+    BATTERY_CAPACITY = PBMetric.METRIC_BATTERY_CAPACITY
+    BATTERY_SOC_PCT = PBMetric.METRIC_BATTERY_SOC_PCT
+    BATTERY_TEMPERATURE = PBMetric.METRIC_BATTERY_TEMPERATURE
+
+    # General inverter metrics
+    INVERTER_TEMPERATURE = PBMetric.METRIC_INVERTER_TEMPERATURE
+    INVERTER_TEMPERATURE_CABINET = PBMetric.METRIC_INVERTER_TEMPERATURE_CABINET
+    INVERTER_TEMPERATURE_HEATSINK = PBMetric.METRIC_INVERTER_TEMPERATURE_HEATSINK
+    INVERTER_TEMPERATURE_TRANSFORMER = PBMetric.METRIC_INVERTER_TEMPERATURE_TRANSFORMER
+
+    # EV charging station metrics
+    EV_CHARGER_TEMPERATURE = PBMetric.METRIC_EV_CHARGER_TEMPERATURE
+
+    # General sensor metrics
+    SENSOR_WIND_SPEED = PBMetric.METRIC_SENSOR_WIND_SPEED
+    SENSOR_WIND_DIRECTION = PBMetric.METRIC_SENSOR_WIND_DIRECTION
+    SENSOR_TEMPERATURE = PBMetric.METRIC_SENSOR_TEMPERATURE
+    SENSOR_RELATIVE_HUMIDITY = PBMetric.METRIC_SENSOR_RELATIVE_HUMIDITY
+    SENSOR_DEW_POINT = PBMetric.METRIC_SENSOR_DEW_POINT
+    SENSOR_AIR_PRESSURE = PBMetric.METRIC_SENSOR_AIR_PRESSURE
+    SENSOR_IRRADIANCE = PBMetric.METRIC_SENSOR_IRRADIANCE
+
+    @classmethod
+    @deprecated("Use `frequenz.client.common.enum_proto.enum_from_proto` instead.")
+    def from_proto(cls, metric: PBMetric.ValueType) -> Self:
+        """Convert a protobuf Metric value to Metric enum.
+
+        Args:
+            metric: Metric to convert.
+        Returns:
+            Enum value corresponding to the protobuf message.
+        """
+        if not any(m.value == metric for m in cls):
+            return cls(Metric.UNSPECIFIED)
+
+        return cls(metric)
+
+    def to_proto(self) -> PBMetric.ValueType:
+        """Convert a Metric object to protobuf Metric.
+
+        Returns:
+            Protobuf message corresponding to the Metric object.
+        """
+        return self.value

frequenz_client_common-0.3.4/src/frequenz/client/common/v1alpha8/microgrid/__init__.py

@@ -0,0 +1,18 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Frequenz microgrid definition."""
+
+from typing import final
+
+from frequenz.core.id import BaseId
+
+
+@final
+class EnterpriseId(BaseId, str_prefix="EID"):
+    """A unique identifier for an enterprise account."""
+
+
+@final
+class MicrogridId(BaseId, str_prefix="MID"):
+    """A unique identifier for a microgrid."""