frequenz-api-common 0.8.2__tar.gz → 0.8.4__tar.gz

{frequenz_api_common-0.8.2 → frequenz_api_common-0.8.4}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: frequenz-api-common
-Version: 0.8.2
+Version: 0.8.4
 Summary: Frequenz common gRPC API and bindings
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
-License: MIT
+License-Expression: MIT
 Project-URL: Changelog, https://github.com/frequenz-floss/frequenz-api-common/releases
 Project-URL: Issues, https://github.com/frequenz-floss/frequenz-api-common/issues
 Project-URL: Repository, https://github.com/frequenz-floss/frequenz-api-common
@@ -11,7 +11,6 @@ Project-URL: Support, https://github.com/frequenz-floss/frequenz-api-common/disc
 Keywords: frequenz,python,api,grpc,protobuf,rpc,common
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Software Development :: Libraries
@@ -19,37 +18,38 @@ Classifier: Typing :: Typed
 Requires-Python: <4,>=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: protobuf<8,>=6.32.1
-Requires-Dist: grpcio<2,>=1.72.1
+Requires-Dist: protobuf<8,>=6.33.6
+Requires-Dist: grpcio<2,>=1.80.0
 Provides-Extra: dev-flake8
 Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
+Requires-Dist: flake8-datetimez==20.10.0; extra == "dev-flake8"
 Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
 Requires-Dist: flake8-pyproject==1.2.4; extra == "dev-flake8"
 Requires-Dist: pydoclint==0.8.3; extra == "dev-flake8"
 Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
 Provides-Extra: dev-formatting
-Requires-Dist: black==25.9.0; extra == "dev-formatting"
-Requires-Dist: isort==6.1.0; extra == "dev-formatting"
+Requires-Dist: black==26.3.1; extra == "dev-formatting"
+Requires-Dist: isort==8.0.1; extra == "dev-formatting"
 Provides-Extra: dev-mkdocs
 Requires-Dist: mike==1.1.2; 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-material==9.6.21; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings[python]==0.30.1; extra == "dev-mkdocs"
-Requires-Dist: frequenz-repo-config[api]==0.14.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-gen-files==0.6.1; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-literate-nav==0.6.3; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-material==9.7.6; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings[python]==1.0.4; extra == "dev-mkdocs"
+Requires-Dist: frequenz-repo-config[api]==0.17.0; extra == "dev-mkdocs"
 Provides-Extra: dev-mypy
-Requires-Dist: mypy==1.18.2; extra == "dev-mypy"
+Requires-Dist: mypy==1.20.2; extra == "dev-mypy"
 Requires-Dist: grpc-stubs==1.53.0.6; extra == "dev-mypy"
 Requires-Dist: frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
 Provides-Extra: dev-noxfile
-Requires-Dist: nox==2025.10.16; extra == "dev-noxfile"
-Requires-Dist: frequenz-repo-config[api]==0.14.0; extra == "dev-noxfile"
+Requires-Dist: nox==2026.4.10; extra == "dev-noxfile"
+Requires-Dist: frequenz-repo-config[api]==0.17.0; extra == "dev-noxfile"
 Provides-Extra: dev-pylint
-Requires-Dist: pylint==3.3.8; extra == "dev-pylint"
+Requires-Dist: pylint==4.0.5; extra == "dev-pylint"
 Requires-Dist: frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
 Provides-Extra: dev-pytest
-Requires-Dist: pytest==8.4.2; extra == "dev-pytest"
-Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.14.0; extra == "dev-pytest"
+Requires-Dist: pytest==9.0.3; extra == "dev-pytest"
+Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.17.0; extra == "dev-pytest"
 Provides-Extra: dev
 Requires-Dist: frequenz-api-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
 Dynamic: license-file

frequenz_api_common-0.8.4/RELEASE_NOTES.md

@@ -0,0 +1,9 @@
+# Frequenz Common API Release Notes
+
+## Summary
+
+This release includes a bug fix for a typo in the enum `v1alpha8::microgrid::electrical_components::ElectricalComponentOperationalMode`.
+
+## Bug Fixes
+
+- A typo in the enum `v1alpha8::microgrid::electrical_components::ElectricalComponentOperationalMode` has been fixed. The variant `ELECTRICAL_COMPONENT_OPERATIONAL_MODE_TELEMTRY` has been renamed to `ELECTRICAL_COMPONENT_OPERATIONAL_MODE_TELEMETRY`.

{frequenz_api_common-0.8.2 → frequenz_api_common-0.8.4}/proto/frequenz/api/common/v1alpha8/microgrid/electrical_components/electrical_components.proto

@@ -595,6 +595,30 @@ message ElectricalComponentCategorySpecificInfo {
   }
 }
 
+// This enum represents the operational mode of an electrical component,
+// indicating whether the component is active and operational, and whether it
+// provides telemetry data, accepts control commands, or both.
+enum ElectricalComponentOperationalMode {
+  // Default value when the operational mode is not explicitly set.
+  ELECTRICAL_COMPONENT_OPERATIONAL_MODE_UNSPECIFIED = 0;
+
+  // The component is inactive and not operational. It does not provide
+  // telemetry data, and it does not accept control commands.
+  ELECTRICAL_COMPONENT_OPERATIONAL_MODE_INACTIVE = 1;
+
+  // The component is active and operational. It only provides telemetry data,
+  // and it does not accept control commands.
+  ELECTRICAL_COMPONENT_OPERATIONAL_MODE_TELEMETRY_ONLY = 2;
+
+  // The component is active and operational. It only accepts control commands,
+  // and it does not provide telemetry data.
+  ELECTRICAL_COMPONENT_OPERATIONAL_MODE_CONTROL_ONLY = 3;
+
+  // The component is active and operational. It provides telemetry data and
+  // accepts control commands.
+  ELECTRICAL_COMPONENT_OPERATIONAL_MODE_CONTROL_AND_TELEMETRY = 4;
+}
+
 // Microgrid electrical component details.
 message ElectricalComponent {
   // The component ID.
@@ -613,16 +637,33 @@ message ElectricalComponent {
   ElectricalComponentCategorySpecificInfo category_specific_info = 5;
 
   // The component manufacturer.
-  string manufacturer = 6;
+  //
+  // Note that this field is deprecated and should not be used.
+  // Please use the `model` field instead, which includes both the manufacturer
+  // and the model name.
+  string manufacturer = 6 [deprecated = true];
 
   // The model name of the component.
-  string model_name = 7;
+  //
+  // Note that this field is deprecated and should not be used.
+  // Please use the `model` field instead, which includes both the manufacturer
+  // and the model name.
+  string model_name = 7 [deprecated = true];
 
   // The operational lifetime of the component.
   frequenz.api.common.v1alpha8.microgrid.Lifetime operational_lifetime = 8;
 
   // List of rated bounds present for the component identified by Metric.
   repeated MetricConfigBounds metric_config_bounds = 9;
+
+  // The operational mode of the component, indicating whether the component is
+  // active and operational, and whether it provides telemetry data, accepts
+  // control commands, or both.
+  ElectricalComponentOperationalMode operational_mode = 10;
+
+  // The model name of the electrical component.
+  // Includes both the manufacturer and the model name.
+  string model = 11;
 }
 
 // ElectricalComponentConnection describes a single electrical link between two

{frequenz_api_common-0.8.2 → frequenz_api_common-0.8.4}/proto/frequenz/api/common/v1alpha8/microgrid/sensors/sensors.proto

@@ -55,14 +55,26 @@ message Sensor {
   // An optional name for the sensor.
   string name = 3;
 
-  // The sensor manufacturer.
-  string manufacturer = 5;
+  // The component manufacturer.
+  //
+  // Note that this field is deprecated and should not be used.
+  // Please use the `model` field instead, which includes both the manufacturer
+  // and the model name.
+  string manufacturer = 5 [deprecated = true];
 
-  // The model name of the sensor.
-  string model_name = 6;
+  // The model name of the component.
+  //
+  // Note that this field is deprecated and should not be used.
+  // Please use the `model` field instead, which includes both the manufacturer
+  // and the model name.
+  string model_name = 6 [deprecated = true];
 
   // The operational lifetime of the sensor.
   frequenz.api.common.v1alpha8.microgrid.Lifetime operational_lifetime = 7;
+
+  // The model name of the electrical component.
+  // Includes both the manufacturer and the model name.
+  string model = 8;
 }
 
 // Represents an error or warning condition reported by a microgrid sensor.

{frequenz_api_common-0.8.2 → frequenz_api_common-0.8.4}/py/frequenz_api_common.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: frequenz-api-common
-Version: 0.8.2
+Version: 0.8.4
 Summary: Frequenz common gRPC API and bindings
 Author-email: Frequenz Energy-as-a-Service GmbH <floss@frequenz.com>
-License: MIT
+License-Expression: MIT
 Project-URL: Changelog, https://github.com/frequenz-floss/frequenz-api-common/releases
 Project-URL: Issues, https://github.com/frequenz-floss/frequenz-api-common/issues
 Project-URL: Repository, https://github.com/frequenz-floss/frequenz-api-common
@@ -11,7 +11,6 @@ Project-URL: Support, https://github.com/frequenz-floss/frequenz-api-common/disc
 Keywords: frequenz,python,api,grpc,protobuf,rpc,common
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Software Development :: Libraries
@@ -19,37 +18,38 @@ Classifier: Typing :: Typed
 Requires-Python: <4,>=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: protobuf<8,>=6.32.1
-Requires-Dist: grpcio<2,>=1.72.1
+Requires-Dist: protobuf<8,>=6.33.6
+Requires-Dist: grpcio<2,>=1.80.0
 Provides-Extra: dev-flake8
 Requires-Dist: flake8==7.3.0; extra == "dev-flake8"
+Requires-Dist: flake8-datetimez==20.10.0; extra == "dev-flake8"
 Requires-Dist: flake8-docstrings==1.7.0; extra == "dev-flake8"
 Requires-Dist: flake8-pyproject==1.2.4; extra == "dev-flake8"
 Requires-Dist: pydoclint==0.8.3; extra == "dev-flake8"
 Requires-Dist: pydocstyle==6.3.0; extra == "dev-flake8"
 Provides-Extra: dev-formatting
-Requires-Dist: black==25.9.0; extra == "dev-formatting"
-Requires-Dist: isort==6.1.0; extra == "dev-formatting"
+Requires-Dist: black==26.3.1; extra == "dev-formatting"
+Requires-Dist: isort==8.0.1; extra == "dev-formatting"
 Provides-Extra: dev-mkdocs
 Requires-Dist: mike==1.1.2; 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-material==9.6.21; extra == "dev-mkdocs"
-Requires-Dist: mkdocstrings[python]==0.30.1; extra == "dev-mkdocs"
-Requires-Dist: frequenz-repo-config[api]==0.14.0; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-gen-files==0.6.1; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-literate-nav==0.6.3; extra == "dev-mkdocs"
+Requires-Dist: mkdocs-material==9.7.6; extra == "dev-mkdocs"
+Requires-Dist: mkdocstrings[python]==1.0.4; extra == "dev-mkdocs"
+Requires-Dist: frequenz-repo-config[api]==0.17.0; extra == "dev-mkdocs"
 Provides-Extra: dev-mypy
-Requires-Dist: mypy==1.18.2; extra == "dev-mypy"
+Requires-Dist: mypy==1.20.2; extra == "dev-mypy"
 Requires-Dist: grpc-stubs==1.53.0.6; extra == "dev-mypy"
 Requires-Dist: frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-mypy"
 Provides-Extra: dev-noxfile
-Requires-Dist: nox==2025.10.16; extra == "dev-noxfile"
-Requires-Dist: frequenz-repo-config[api]==0.14.0; extra == "dev-noxfile"
+Requires-Dist: nox==2026.4.10; extra == "dev-noxfile"
+Requires-Dist: frequenz-repo-config[api]==0.17.0; extra == "dev-noxfile"
 Provides-Extra: dev-pylint
-Requires-Dist: pylint==3.3.8; extra == "dev-pylint"
+Requires-Dist: pylint==4.0.5; extra == "dev-pylint"
 Requires-Dist: frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]; extra == "dev-pylint"
 Provides-Extra: dev-pytest
-Requires-Dist: pytest==8.4.2; extra == "dev-pytest"
-Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.14.0; extra == "dev-pytest"
+Requires-Dist: pytest==9.0.3; extra == "dev-pytest"
+Requires-Dist: frequenz-repo-config[extra-lint-examples]==0.17.0; extra == "dev-pytest"
 Provides-Extra: dev
 Requires-Dist: frequenz-api-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]; extra == "dev"
 Dynamic: license-file

{frequenz_api_common-0.8.2 → frequenz_api_common-0.8.4}/py/frequenz_api_common.egg-info/requires.txt

@@ -1,41 +1,42 @@
-protobuf<8,>=6.32.1
-grpcio<2,>=1.72.1
+protobuf<8,>=6.33.6
+grpcio<2,>=1.80.0
 
 [dev]
 frequenz-api-common[dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]
 
 [dev-flake8]
 flake8==7.3.0
+flake8-datetimez==20.10.0
 flake8-docstrings==1.7.0
 flake8-pyproject==1.2.4
 pydoclint==0.8.3
 pydocstyle==6.3.0
 
 [dev-formatting]
-black==25.9.0
-isort==6.1.0
+black==26.3.1
+isort==8.0.1
 
 [dev-mkdocs]
 mike==1.1.2
-mkdocs-gen-files==0.5.0
-mkdocs-literate-nav==0.6.2
-mkdocs-material==9.6.21
-mkdocstrings[python]==0.30.1
-frequenz-repo-config[api]==0.14.0
+mkdocs-gen-files==0.6.1
+mkdocs-literate-nav==0.6.3
+mkdocs-material==9.7.6
+mkdocstrings[python]==1.0.4
+frequenz-repo-config[api]==0.17.0
 
 [dev-mypy]
-mypy==1.18.2
+mypy==1.20.2
 grpc-stubs==1.53.0.6
 frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-noxfile]
-nox==2025.10.16
-frequenz-repo-config[api]==0.14.0
+nox==2026.4.10
+frequenz-repo-config[api]==0.17.0
 
 [dev-pylint]
-pylint==3.3.8
+pylint==4.0.5
 frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]
 
 [dev-pytest]
-pytest==8.4.2
-frequenz-repo-config[extra-lint-examples]==0.14.0
+pytest==9.0.3
+frequenz-repo-config[extra-lint-examples]==0.17.0

{frequenz_api_common-0.8.2 → frequenz_api_common-0.8.4}/pyproject.toml

@@ -3,16 +3,16 @@
 
 [build-system]
 requires = [
-  "setuptools == 80.9.0",
-  "setuptools_scm[toml] == 9.2.2",
-  "frequenz-repo-config[api] == 0.14.0",
+  "setuptools == 82.0.1",
+  "setuptools_scm[toml] == 10.0.5",
+  "frequenz-repo-config[api] == 0.17.0",
   # We need to pin the protobuf, grpcio and  grpcio-tools dependencies to make
   # sure the code is generated using the minimum supported versions, as older
   # versions can't work with code that was generated with newer versions.
   # https://protobuf.dev/support/cross-version-runtime-guarantee/#backwards
-  "protobuf == 6.32.1",
-  "grpcio-tools == 1.72.1",
-  "grpcio == 1.72.1",
+  "protobuf == 6.33.6",
+  "grpcio-tools == 1.80.0",
+  "grpcio == 1.80.0",
 ]
 build-backend = "setuptools.build_meta"
 
@@ -20,12 +20,12 @@ build-backend = "setuptools.build_meta"
 name = "frequenz-api-common"
 description = "Frequenz common gRPC API and bindings"
 readme = "README.md"
-license = { text = "MIT" }
+license = "MIT"
+license-files = ["LICENSE"]
 keywords = ["frequenz", "python", "api", "grpc", "protobuf", "rpc", "common"]
 classifiers = [
   "Development Status :: 3 - Alpha",
   "Intended Audience :: Developers",
-  "License :: OSI Approved :: MIT License",
   "Programming Language :: Python :: 3",
   "Programming Language :: Python :: 3 :: Only",
   "Topic :: Software Development :: Libraries",
@@ -36,11 +36,11 @@ dependencies = [
   # We can't widen beyond the current value unless we bump the minimum
   # requirements too because of protobuf cross-version runtime guarantees:
   # https://protobuf.dev/support/cross-version-runtime-guarantee/#major
-  "protobuf >= 6.32.1, < 8", # Do not widen beyond 8!
+  "protobuf >= 6.33.6, < 8", # Do not widen beyond 8!
   # We couldn't find any document with a spec about the cross-version runtime
   # guarantee for grpcio, so unless we find one in the future, we'll assume
   # major version jumps are not compatible
-  "grpcio >= 1.72.1, < 2", # Do not widen beyond 2!
+  "grpcio >= 1.80.0, < 2", # Do not widen beyond 2!
 ]
 dynamic = ["version"]
 
@@ -51,35 +51,36 @@ email = "floss@frequenz.com"
 [project.optional-dependencies]
 dev-flake8 = [
   "flake8 == 7.3.0",
+  "flake8-datetimez == 20.10.0",
   "flake8-docstrings == 1.7.0",
   "flake8-pyproject == 1.2.4", # For reading the flake8 config from pyproject.toml
   "pydoclint == 0.8.3",
   "pydocstyle == 6.3.0",
 ]
-dev-formatting = ["black == 25.9.0", "isort == 6.1.0"]
+dev-formatting = ["black == 26.3.1", "isort == 8.0.1"]
 dev-mkdocs = [
   "mike == 1.1.2",
-  "mkdocs-gen-files == 0.5.0",
-  "mkdocs-literate-nav == 0.6.2",
-  "mkdocs-material == 9.6.21",
-  "mkdocstrings[python] == 0.30.1",
-  "frequenz-repo-config[api] == 0.14.0",
+  "mkdocs-gen-files == 0.6.1",
+  "mkdocs-literate-nav == 0.6.3",
+  "mkdocs-material == 9.7.6",
+  "mkdocstrings[python] == 1.0.4",
+  "frequenz-repo-config[api] == 0.17.0",
 ]
 dev-mypy = [
-  "mypy == 1.18.2",
+  "mypy == 1.20.2",
   "grpc-stubs == 1.53.0.6",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
-dev-noxfile = ["nox == 2025.10.16", "frequenz-repo-config[api] == 0.14.0"]
+dev-noxfile = ["nox == 2026.4.10", "frequenz-repo-config[api] == 0.17.0"]
 dev-pylint = [
-  "pylint == 3.3.8",
+  "pylint == 4.0.5",
   # For checking the noxfile, docs/ script, and tests
   "frequenz-api-common[dev-mkdocs,dev-noxfile,dev-pytest]",
 ]
 dev-pytest = [
-  "pytest == 8.4.2",
-  "frequenz-repo-config[extra-lint-examples] == 0.14.0",
+  "pytest == 9.0.3",
+  "frequenz-repo-config[extra-lint-examples] == 0.17.0",
 ]
 dev = [
   "frequenz-api-common[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",

frequenz_api_common-0.8.2/RELEASE_NOTES.md

@@ -1,5 +0,0 @@
-# Frequenz Common API Release Notes
-
-## New Features
-
-A new component category for electric steam boilers has been added. The use case we're adding this for is a hybrid (gas/electric) steam boiler that may switch/blend between power sources and takes _available_ electric power into consideration.