Frequenz Microgrid API Release Notes
Summary
This release introduces a new preview API version, v1alpha19, alongside the stable v1 API.
The v1 API remains unchanged to ensure backward compatibility. All new features are available exclusively in the new v1alpha19 package.
Stable v1 and v1alpha18 APIs
The v1 and v1alpha18 APIs are stable and have not been changed in this release. Users currently on these API versions do not need to make any changes, beyond potentially updating python dependencies.
New v1alpha19 Preview API
A new package, frequenz.api.microgrid.v1alpha19, has been introduced to provide access to the latest features. The v1alpha19 API introduces a more streamlined and robust interface compared to the stable v1 API.
Upgrading to the v0.19.0 release
1. Dependency Updates
Despite the v1 API remaining unchanged, your project's dependencies may need to be updated, due to the following python dependency updates:
Upgrading to the v1alpha19 API
Alongside upgrading to the v0.19.0 release, you can also upgrade to the new v1alpha19 API, which includes several significant changes and improvements.
1. Symbol Renaming
Numerous symbols were renamed. The changes are primarily for clarity and consistency with the new frequenz-api-common API. The changes are listed below:
| Type | Old Name | New Name |
|---|---|---|
| Message | ReceiveElectricalComponentTelemetryStreamRequest.ComponentTelemetryStreamFilter |
ReceiveElectricalComponentTelemetryStreamRequest.ElectricalComponentTelemetryStreamFilter |
What's Changed
- Add
v1alpha19API and renameComponentTelemetryStreamFilterby @tiyash-basu-frequenz in #347 - Bump mkdocs-material from 9.6.15 to 9.6.16 in the patch group by @dependabot[bot] in #349
- Bump mypy from 1.16.1 to 1.17.1 in the minor group by @dependabot[bot] in #350
- Bump the compatible group with 2 updates by @dependabot[bot] in #348
- Bump actions/labeler from 5.0.0 to 6.0.1 by @dependabot[bot] in #354
- Bump actions/download-artifact from 4 to 5 by @dependabot[bot] in #355
- Bump actions/checkout from 4 to 5 by @dependabot[bot] in #356
- Bump the patch group with 3 updates by @dependabot[bot] in #357
- Bump pydoclint from 0.6.6 to 0.7.3 by @dependabot[bot] in #360
- Bump setuptools-scm[toml] from 8.3.1 to 9.2.0 by @dependabot[bot] in #361
- Bump the minor group with 4 updates by @dependabot[bot] in #358
- Bump setuptools-scm[toml] from 9.2.0 to 9.2.1 in the patch group by @dependabot[bot] in #363
- Bump mkdocstrings-python from 1.16.12 to 1.18.2 by @dependabot[bot] in #362
- Bump the patch group with 5 updates by @dependabot[bot] in #368
- Bump actions/upload-artifact from 4 to 5 by @dependabot[bot] in #366
- Bump actions/download-artifact from 5 to 6 by @dependabot[bot] in #367
- Bump pylint from 3.3.8 to 4.0.2 by @dependabot[bot] in #370
- Bump nox from 2025.5.1 to 2025.10.16 in the minor group by @dependabot[bot] in #369
- Bump pydoclint from 0.7.3 to 0.7.6 by @dependabot[bot] in #371
- Bump isort from 6.0.1 to 7.0.0 by @dependabot[bot] in #365
- Add power-source selection for hybrid inverter controls by @tiyash-basu-frequenz in #382
- Add repo-config auto-migration workflow by @llucax in #383
- Bump the minor group across 1 directory with 4 updates by @dependabot[bot] in #386
- Bump the compatible group across 1 directory with 2 updates by @dependabot[bot] in #384
- Bump actions/create-github-app-token from 2.2.1 to 3.0.0 by @dependabot[bot] in #389
- Bump actions/checkout from 5 to 6 by @dependabot[bot] in #373
- Bump the patch group across 1 directory with 3 updates by @dependabot[bot] in #385
- Bump actions/upload-artifact from 5 to 7 by @dependabot[bot] in #390
- Bump actions/download-artifact from 6 to 8 by @dependabot[bot] in #388
- Bump the compatible group across 1 directory with 2 updates by @dependabot[bot] in #391
- Bump protobuf from 6.31.1 to 6.33.5 by @dependabot[bot] in #394
- Bump pydoclint from 0.8.1 to 0.8.3 by @dependabot[bot] in #379
- Bump black from 25.9.0 to 26.3.1 by @dependabot[bot] in #395
- Revert "Add power-source selection for hybrid inverter controls" by @tiyash-basu-frequenz in #392
- Add grpc-stubs dependency for mkdocs by @llucax in #404
- Bump frequenz-repo-config from 0.13.6 to 0.17.0 in the repo-config group across 1 directory by @dependabot[bot] in #398
- Bump isort from 7.0.0 to 8.0.1 by @dependabot[bot] in #399
- Bump mypy from 1.19.1 to 1.20.2 in the minor group across 1 directory by @dependabot[bot] in #397
- Bump mkdocstrings-python from 1.18.2 to 2.0.3 by @dependabot[bot] in #400
- Bump pytest from 8.4.2 to 9.0.3 by @dependabot[bot] in #393
- Bump mkdocs-gen-files from 0.5.0 to 0.6.1 by @dependabot[bot] in #403
- Bump setuptools from 80.9.0 to 82.0.1 by @dependabot[bot] in #402
- Bump nox from 2025.10.16 to 2026.4.10 by @dependabot[bot] in #401
- Add dependabot grpc update fix workflow by @llucax in #405
- Build(deps): Bump the compatible group with 5 updates by @dependabot[bot] in #406
- Build(deps): Bump actions/create-github-app-token from 2.2.1 to 3.1.1 by @dependabot[bot] in #407
- Build(deps): Bump frequenz-floss/gh-action-setup-python-with-deps from 0d0d77eac3b54799f31f25a1060ef2c6ebdf9299 to e4d0b2ef8f5a1612d7827f3abaef17c931d2b946 by @dependabot[bot] in #408
- Build(deps): Bump frequenz-floss/gh-action-setup-git from 16952aac3ccc01d27412fe0dea3ea946530dcace to f9d86a01228ee1cadaac5224d4d7626f1eb23f90 by @dependabot[bot] in #409
- Build(deps-dev): Bump setuptools-scm from 9.2.2 to 10.0.5 by @dependabot[bot] in #412
- Build(deps): Bump the grpc-compatible group across 1 directory with 3 updates by @dependabot[bot] in #413
- Update frequenz-api-common to v0.8.3 by @tiyash-basu-frequenz in #396
- Update frequenz-api-common submodule from v0.8.3 to v0.8.4 by @tiyash-basu-frequenz in #414
Full Changelog: v0.18.0...v0.19.0