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

{frequenz_client_common-0.3.3/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.3
+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.1
+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.3 → 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,7 +27,7 @@ classifiers = [
 requires-python = ">= 3.11, < 4"
 dependencies = [
   "typing-extensions >= 4.13.0, < 5",
-  "frequenz-api-common >= 0.6.1, < 7",
+  "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/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."""

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

@@ -0,0 +1,459 @@
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
+
+"""Defines the electrical components that can be used in a microgrid."""
+from __future__ import annotations
+
+import enum
+from typing import final
+
+# pylint: disable=no-name-in-module
+from frequenz.api.common.v1alpha8.microgrid.electrical_components.electrical_components_pb2 import (
+    ElectricalComponentCategory as PBElectricalComponentCategory,
+)
+from frequenz.api.common.v1alpha8.microgrid.electrical_components.electrical_components_pb2 import (
+    ElectricalComponentDiagnosticCode as PBElectricalComponentDiagnosticCode,
+)
+from frequenz.api.common.v1alpha8.microgrid.electrical_components.electrical_components_pb2 import (
+    ElectricalComponentStateCode as PBElectricalComponentStateCode,
+)
+from frequenz.core.id import BaseId
+from typing_extensions import deprecated
+
+# pylint: enable=no-name-in-module
+
+
+@final
+class ElectricalComponentId(BaseId, str_prefix="CID"):
+    """A unique identifier for a microgrid electrical component."""
+
+
+@enum.unique
+class ElectricalComponentCategory(enum.Enum):
+    """Possible types of microgrid electrical component."""
+
+    UNSPECIFIED = (
+        PBElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_UNSPECIFIED
+    )
+    """An unknown component category.
+
+    Useful for error handling, and marking unknown components in
+    a list of components with otherwise known categories.
+    """
+
+    GRID_CONNECTION_POINT = (
+        PBElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_GRID_CONNECTION_POINT
+    )
+    """The point where the local microgrid is connected to the grid."""
+
+    METER = PBElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_METER
+    """A meter, for measuring electrical metrics, e.g., current, voltage, etc."""
+
+    INVERTER = PBElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_INVERTER
+    """An electricity generator, with batteries or solar energy."""
+
+    CONVERTER = PBElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_CONVERTER
+    """An electricity converter, e.g., a DC-DC converter."""
+
+    BATTERY = PBElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_BATTERY
+    """A storage system for electrical energy, used by inverters."""
+
+    EV_CHARGER = PBElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_EV_CHARGER
+    """A station for charging electrical vehicles."""
+
+    CRYPTO_MINER = (
+        PBElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_CRYPTO_MINER
+    )
+    """A device for mining cryptocurrencies."""
+
+    ELECTROLYZER = (
+        PBElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_ELECTROLYZER
+    )
+    """A device for splitting water into hydrogen and oxygen using electricity."""
+
+    CHP = PBElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_CHP
+    """A heat and power combustion plant (CHP stands for combined heat and power)."""
+
+    BREAKER = PBElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_BREAKER
+    """A relay, used for switching electrical circuits on and off."""
+
+    PRECHARGER = PBElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_PRECHARGER
+    """A precharger, used for preparing electrical circuits for switching on."""
+
+    POWER_TRANSFORMER = (
+        PBElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_POWER_TRANSFORMER
+    )
+    """A transformer, used for changing the voltage of electrical circuits."""
+
+    HVAC = PBElectricalComponentCategory.ELECTRICAL_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: PBElectricalComponentCategory.ValueType
+    ) -> ElectricalComponentCategory:
+        """Convert a protobuf ElectricalComponentCategory message to enum.
+
+        Args:
+            component_category: protobuf enum to convert
+
+        Returns:
+            Enum value corresponding to the protobuf message.
+        """
+        if not any(t.value == component_category for t in ElectricalComponentCategory):
+            return ElectricalComponentCategory.UNSPECIFIED
+        return cls(component_category)
+
+    def to_proto(self) -> PBElectricalComponentCategory.ValueType:
+        """Convert a ElectricalComponentCategory enum to protobuf message.
+
+        Returns:
+            Enum value corresponding to the protobuf message.
+        """
+        return self.value
+
+
+@enum.unique
+class ElectricalComponentStateCode(enum.Enum):
+    """All possible states of a microgrid electrical component."""
+
+    UNSPECIFIED = (
+        PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_UNSPECIFIED
+    )
+    """Default value when the component state is not explicitly set."""
+
+    UNKNOWN = PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_UNKNOWN
+    """State when the component is in an unknown or undefined condition.
+
+    This is used when the sender is unable to classify the component into any
+    other state.
+    """
+
+    UNAVAILABLE = (
+        PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_UNAVAILABLE
+    )
+    """State when the component is not available for use."""
+
+    SWITCHING_OFF = (
+        PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_SWITCHING_OFF
+    )
+    """State when the component is in the process of switching off."""
+
+    OFF = PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_OFF
+    """State when the component has successfully switched off."""
+
+    SWITCHING_ON = (
+        PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_SWITCHING_ON
+    )
+    """State when the component is in the process of switching on from an off state."""
+
+    STANDBY = PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_STANDBY
+    """State when the component is in standby mode, and not immediately ready for operation."""
+
+    READY = PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_READY
+    """State when the component is fully operational and ready for use."""
+
+    CHARGING = PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_CHARGING
+    """State when the component is actively consuming energy."""
+
+    DISCHARGING = (
+        PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_DISCHARGING
+    )
+    """State when the component is actively producing or releasing energy."""
+
+    ERROR = PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_ERROR
+    """State when the component is in an error state and may need attention."""
+
+    EV_CHARGING_CABLE_UNPLUGGED = (
+        PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_EV_CHARGING_CABLE_UNPLUGGED
+    )
+    """The Electric Vehicle (EV) charging cable is unplugged from the charging station."""
+
+    EV_CHARGING_CABLE_PLUGGED_AT_STATION = (
+        PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_EV_CHARGING_CABLE_PLUGGED_AT_STATION  # noqa: E501
+    )
+    """The EV charging cable is plugged into the charging station."""
+
+    EV_CHARGING_CABLE_PLUGGED_AT_EV = (
+        PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_EV_CHARGING_CABLE_PLUGGED_AT_EV  # noqa: E501
+    )
+    """The EV charging cable is plugged into the vehicle."""
+
+    EV_CHARGING_CABLE_LOCKED_AT_STATION = (
+        PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_EV_CHARGING_CABLE_LOCKED_AT_STATION  # noqa: E501
+    )
+    """The EV charging cable is locked at the charging station end, indicating
+    readiness for charging."""
+
+    EV_CHARGING_CABLE_LOCKED_AT_EV = (
+        PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_EV_CHARGING_CABLE_LOCKED_AT_EV  # noqa: E501
+    )
+    """The EV charging cable is locked at the vehicle end, indicating that charging is active."""
+
+    RELAY_OPEN = (
+        PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_RELAY_OPEN
+    )
+    """The relay is in an open state, meaning no current can flow through."""
+
+    RELAY_CLOSED = (
+        PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_RELAY_CLOSED
+    )
+    """The relay is in a closed state, allowing current to flow."""
+
+    PRECHARGER_OPEN = (
+        PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_PRECHARGER_OPEN
+    )
+    """The precharger circuit is open, meaning it's not currently active."""
+
+    PRECHARGER_PRECHARGING = (
+        PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_PRECHARGER_PRECHARGING
+    )
+    """The precharger is in a precharging state, preparing the main circuit for activation."""
+
+    PRECHARGER_CLOSED = (
+        PBElectricalComponentStateCode.ELECTRICAL_COMPONENT_STATE_CODE_PRECHARGER_CLOSED
+    )
+    """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: PBElectricalComponentStateCode.ValueType
+    ) -> ElectricalComponentStateCode:
+        """Convert a protobuf ElectricalComponentStateCode message to enum.
+
+        Args:
+            component_state: protobuf enum to convert
+
+        Returns:
+            Enum value corresponding to the protobuf message.
+        """
+        if not any(c.value == component_state for c in ElectricalComponentStateCode):
+            return ElectricalComponentStateCode.UNSPECIFIED
+        return cls(component_state)
+
+    def to_proto(self) -> PBElectricalComponentStateCode.ValueType:
+        """Convert a ElectricalComponentStateCode enum to protobuf message.
+
+        Returns:
+            Enum value corresponding to the protobuf message.
+        """
+        return self.value
+
+
+@enum.unique
+class ElectricalComponentDiagnosticCode(enum.Enum):
+    """All diagnostics that can occur across electrical component categories."""
+
+    UNSPECIFIED = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_UNSPECIFIED
+    )
+    """Default value. No specific error is specified."""
+
+    UNKNOWN = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_UNKNOWN
+    )
+    """The component is reporting an unknown or an undefined error, and the sender
+    cannot parse the component error to any of the variants below."""
+
+    SWITCH_ON_FAULT = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_SWITCH_ON_FAULT
+    )
+    """Error indicating that the component could not be switched on."""
+
+    UNDERVOLTAGE = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_UNDERVOLTAGE
+    )
+    """Error indicating that the component is operating under the minimum rated
+    voltage."""
+
+    OVERVOLTAGE = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_OVERVOLTAGE
+    )
+    """Error indicating that the component is operating over the maximum rated
+    voltage."""
+
+    OVERCURRENT = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_OVERCURRENT
+    )
+    """Error indicating that the component is drawing more current than the
+    maximum rated value."""
+
+    OVERCURRENT_CHARGING = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_OVERCURRENT_CHARGING  # noqa: E501
+    )
+    """Error indicating that the component's consumption current is over the
+    maximum rated value during charging."""
+
+    OVERCURRENT_DISCHARGING = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_OVERCURRENT_DISCHARGING  # noqa: E501
+    )
+    """Error indicating that the component's production current is over the
+    maximum rated value during discharging."""
+
+    OVERTEMPERATURE = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_OVERTEMPERATURE
+    )
+    """Error indicating that the component is operating over the maximum rated
+    temperature."""
+
+    UNDERTEMPERATURE = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_UNDERTEMPERATURE
+    )
+    """Error indicating that the component is operating under the minimum rated
+    temperature."""
+
+    HIGH_HUMIDITY = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_HIGH_HUMIDITY
+    )
+    """Error indicating that the component is exposed to high humidity levels over
+    the maximum rated value."""
+
+    FUSE_ERROR = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_FUSE_ERROR
+    )
+    """Error indicating that the component's fuse has blown."""
+
+    PRECHARGE_ERROR = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_PRECHARGE_ERROR
+    )
+    """Error indicating that the component's precharge unit has failed."""
+
+    PLAUSIBILITY_ERROR = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_PLAUSIBILITY_ERROR
+    )
+    """Error indicating plausibility issues within the system involving this
+    component."""
+
+    EV_UNEXPECTED_PILOT_FAILURE = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_EV_UNEXPECTED_PILOT_FAILURE  # noqa: E501
+    )
+    """Error indicating unexpected pilot failure in an electric vehicle (EV)
+    component."""
+
+    FAULT_CURRENT = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_FAULT_CURRENT
+    )
+    """Error indicating fault current detected in the component."""
+
+    SHORT_CIRCUIT = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_SHORT_CIRCUIT
+    )
+    """Error indicating a short circuit detected in the component."""
+
+    CONFIG_ERROR = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_CONFIG_ERROR
+    )
+    """Error indicating a configuration error related to the component."""
+
+    ILLEGAL_COMPONENT_STATE_CODE_REQUESTED = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_ILLEGAL_COMPONENT_STATE_CODE_REQUESTED  # noqa: E501
+    )
+    """Error indicating an illegal state requested for the component."""
+
+    HARDWARE_INACCESSIBLE = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_HARDWARE_INACCESSIBLE  # noqa: E501
+    )
+    """Error indicating that the hardware of the component is inaccessible."""
+
+    INTERNAL = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_INTERNAL
+    )
+    """Error indicating an internal error within the component."""
+
+    UNAUTHORIZED = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_UNAUTHORIZED
+    )
+    """Error indicating that the component is unauthorized to perform the
+    last requested action."""
+
+    EV_CHARGING_CABLE_UNPLUGGED_FROM_STATION = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_EV_CHARGING_CABLE_UNPLUGGED_FROM_STATION  # noqa: E501
+    )
+    """Error indicating electric vehicle (EV) cable was abruptly unplugged from
+    the charging station."""
+
+    EV_CHARGING_CABLE_UNPLUGGED_FROM_EV = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_EV_CHARGING_CABLE_UNPLUGGED_FROM_EV  # noqa: E501
+    )
+    """Error indicating electric vehicle (EV) cable was abruptly unplugged from
+    the vehicle."""
+
+    EV_CHARGING_CABLE_LOCK_FAILED = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_EV_CHARGING_CABLE_LOCK_FAILED  # noqa: E501
+    )
+    """Error indicating electric vehicle (EV) cable lock failure."""
+
+    EV_CHARGING_CABLE_INVALID = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_EV_CHARGING_CABLE_INVALID  # noqa: E501
+    )
+    """Error indicating an invalid electric vehicle (EV) cable."""
+
+    EV_CONSUMER_INCOMPATIBLE = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_EV_CONSUMER_INCOMPATIBLE  # noqa: E501
+    )
+    """Error indicating an incompatible electric vehicle (EV) plug."""
+
+    BATTERY_IMBALANCE = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_BATTERY_IMBALANCE
+    )
+    """Error indicating a battery system imbalance."""
+
+    BATTERY_LOW_SOH = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_BATTERY_LOW_SOH
+    )
+    """Error indicating a low state of health (SOH) detected in the battery."""
+
+    BATTERY_BLOCK_ERROR = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_BATTERY_BLOCK_ERROR
+    )
+    """Error indicating a battery block error."""
+
+    BATTERY_CONTROLLER_ERROR = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_BATTERY_CONTROLLER_ERROR  # noqa: E501
+    )
+    """Error indicating a battery controller error."""
+
+    BATTERY_RELAY_ERROR = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_BATTERY_RELAY_ERROR
+    )
+    """Error indicating a battery relay error."""
+
+    BATTERY_CALIBRATION_NEEDED = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_BATTERY_CALIBRATION_NEEDED  # noqa: E501
+    )
+    """Error indicating that battery calibration is needed."""
+
+    RELAY_CYCLE_LIMIT_REACHED = (
+        PBElectricalComponentDiagnosticCode.ELECTRICAL_COMPONENT_DIAGNOSTIC_CODE_RELAY_CYCLE_LIMIT_REACHED  # noqa: E501
+    )
+    """Error indicating that the relays have been cycled for the maximum number of
+    times."""
+
+    @classmethod
+    @deprecated("Use `frequenz.client.common.enum_proto.enum_from_proto` instead.")
+    def from_proto(
+        cls, component_error_code: PBElectricalComponentDiagnosticCode.ValueType
+    ) -> ElectricalComponentDiagnosticCode:
+        """Convert a protobuf ElectricalComponentDiagnosticCode message to enum.
+
+        Args:
+            component_error_code: protobuf enum to convert
+
+        Returns:
+            Enum value corresponding to the protobuf message.
+        """
+        if not any(
+            c.value == component_error_code for c in ElectricalComponentDiagnosticCode
+        ):
+            return ElectricalComponentDiagnosticCode.UNSPECIFIED
+        return cls(component_error_code)
+
+    def to_proto(self) -> PBElectricalComponentDiagnosticCode.ValueType:
+        """Convert a ElectricalComponentDiagnosticCode enum to protobuf message.
+
+        Returns:
+            Enum value corresponding to the protobuf message.
+        """
+        return self.value

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

@@ -0,0 +1,13 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Microgrid sensors."""
+
+from typing import final
+
+from frequenz.core.id import BaseId
+
+
+@final
+class SensorId(BaseId, str_prefix="SID"):
+    """A unique identifier for a microgrid sensor."""

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

@@ -0,0 +1,91 @@
+# License: MIT
+# Copyright © 2024 Frequenz Energy-as-a-Service GmbH
+
+"""Module to define the pagination used with the common client."""
+
+from __future__ import annotations  # required for constructor type hinting
+
+from dataclasses import dataclass
+from typing import Self
+
+# pylint: disable=no-name-in-module
+from frequenz.api.common.v1alpha8.pagination.pagination_info_pb2 import (
+    PaginationInfo as PBPaginationInfo,
+)
+from frequenz.api.common.v1alpha8.pagination.pagination_params_pb2 import (
+    PaginationParams as PBPaginationParams,
+)
+
+# pylint: enable=no-name-in-module
+
+
+@dataclass(frozen=True, kw_only=True)
+class PaginationParams:
+    """Parameters for paginating list requests."""
+
+    page_size: int
+    """The maximum number of results to be returned per request."""
+
+    page_token: str
+    """The token identifying a specific page of the list results."""
+
+    @classmethod
+    def from_proto(cls, pagination_params: PBPaginationParams) -> Self:
+        """Convert a protobuf PaginationParams to python PaginationParams object.
+
+        Args:
+            pagination_params: Params to convert.
+        Returns:
+            Params object corresponding to the protobuf message.
+        """
+        return cls(
+            page_size=pagination_params.page_size,
+            page_token=pagination_params.page_token,
+        )
+
+    def to_proto(self) -> PBPaginationParams:
+        """Convert a Params object to protobuf PaginationParams.
+
+        Returns:
+            Protobuf message corresponding to the Params object.
+        """
+        return PBPaginationParams(
+            page_size=self.page_size,
+            page_token=self.page_token,
+        )
+
+
+@dataclass(frozen=True, kw_only=True)
+class PaginationInfo:
+    """Information about the pagination of a list request."""
+
+    total_items: int
+    """The total number of items that match the request."""
+
+    next_page_token: str | None = None
+    """The token identifying the next page of results."""
+
+    @classmethod
+    def from_proto(cls, pagination_info: PBPaginationInfo) -> Self:
+        """Convert a protobuf PBPaginationInfo to Info object.
+
+        Args:
+            pagination_info: Info to convert.
+        Returns:
+            Info object corresponding to the protobuf message.
+        """
+        return cls(
+            total_items=pagination_info.total_items,
+            next_page_token=pagination_info.next_page_token,
+        )
+
+    def to_proto(self) -> PBPaginationInfo:
+        """Convert a Info object to protobuf PBPaginationInfo.
+
+        Returns:
+            Protobuf message corresponding to the Info object.
+        """
+        return PBPaginationInfo(
+            total_items=self.total_items,
+            next_page_token=self.next_page_token,
+        )

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

@@ -0,0 +1,26 @@
+# License: MIT
+# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
+
+"""Type wrappers for the generated protobuf messages."""
+
+
+from enum import Enum
+
+# pylint: disable-next=no-name-in-module
+from frequenz.api.common.v1alpha8.streaming import event_pb2 as PBEvent
+
+
+class Event(Enum):
+    """Enum representing the type of streaming event."""
+
+    EVENT_UNSPECIFIED = PBEvent.EVENT_UNSPECIFIED
+    """Unspecified event type."""
+
+    EVENT_CREATED = PBEvent.EVENT_CREATED
+    """Event when a new resource is created."""
+
+    EVENT_UPDATED = PBEvent.EVENT_UPDATED
+    """Event when an existing resource is updated."""
+
+    EVENT_DELETED = PBEvent.EVENT_DELETED
+    """Event when a resource is deleted."""

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: frequenz-client-common
-Version: 0.3.3
+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.1
+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.3 → frequenz_client_common-0.3.4}/src/frequenz_client_common.egg-info/SOURCES.txt

@@ -12,6 +12,13 @@ src/frequenz/client/common/microgrid/__init__.py
 src/frequenz/client/common/microgrid/sensors.py
 src/frequenz/client/common/microgrid/components/__init__.py
 src/frequenz/client/common/pagination/__init__.py
+src/frequenz/client/common/v1alpha8/__init__.py
+src/frequenz/client/common/v1alpha8/metric/__init__.py
+src/frequenz/client/common/v1alpha8/microgrid/__init__.py
+src/frequenz/client/common/v1alpha8/microgrid/sensors.py
+src/frequenz/client/common/v1alpha8/microgrid/electrical_components/__init__.py
+src/frequenz/client/common/v1alpha8/pagination/__init__.py
+src/frequenz/client/common/v1alpha8/streaming/__init__.py
 src/frequenz_client_common.egg-info/PKG-INFO
 src/frequenz_client_common.egg-info/SOURCES.txt
 src/frequenz_client_common.egg-info/dependency_links.txt

{frequenz_client_common-0.3.3 → frequenz_client_common-0.3.4}/src/frequenz_client_common.egg-info/requires.txt

@@ -1,12 +1,12 @@
 typing-extensions<5,>=4.13.0
-frequenz-api-common<7,>=0.6.1
+frequenz-api-common<9,>=0.8.0
 frequenz-core<2,>=1.0.2
 
 [dev]
 frequenz-client-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]
 
 [dev-flake8]
-flake8==7.2.0
+flake8==7.3.0
 flake8-docstrings==1.7.0
 flake8-pyproject==1.2.3
 pydoclint==0.6.6
@@ -17,33 +17,33 @@ 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
 frequenz-client-common[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-noxfile]
 nox==2025.5.1
-frequenz-repo-config[lib]==0.13.3
+frequenz-repo-config[lib]==0.13.5
 
 [dev-pylint]
-pylint==3.3.6
+pylint==3.3.7
 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

frequenz_client_common-0.3.3/RELEASE_NOTES.md

@@ -1,22 +0,0 @@
-# Frequenz Client Common Library Release Notes
-
-## Summary
-
-<!-- Here goes a general summary of what this release is about -->
-
-## Upgrading
-
-- The metrics and components enums `.from_proto()` are deprecated, please use the new `enum_from_proto()` instead.
-- Some minimum dependencies have been bumped, you might need to update your minimum dependencies too:
-
-    * `frequenz-api-common` to 0.6.1
-    * `frequenz-core` to 1.0.2
-
-## New Features
-
-- A new module `frequenz.client.common.enum_proto` has been added, which provides a generic `enum_from_proto()` function to convert protobuf enums to Python enums.
-- The `frequenz.client.common.microgrid.ComponentCategory` was extended to include the missing categories.
-
-## Bug Fixes
-
-<!-- Here goes notable bug fixes that are worth a special mention or explanation -->