Skip to content

Reset release notes for new release #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 29, 2025
Merged

Reset release notes for new release #211

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 3 additions & 14 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,15 @@

## Summary

This release updates the `frequenz-api-dispatch` dependency to `v1.0.0-rc3` and adapts the client to the latest API changes. It introduces more specific component categories and new event names while maintaining backward compatibility.
<!-- Here goes a general summary of what this release is about -->

## Upgrading

* `InverterType.SOLAR` is now deprecated in favor of `InverterType.PV`. The old name can still be used but will be removed in a future release.
* The following dependencies were updated:
* `frequenz-api-dispatch` to `v1.0.0-rc3`
* `frequenz-client-common` to `v0.3.6`
* `grpcio` to `v1.72.1`
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

## New Features

* **`ElectricalComponentCategory`**: The client now uses the more specific `frequenz.client.common.microgrid.electrical_components.ElectricalComponentCategory` for targeting components.
* The new property `TargetCategory.category2` will return an `ElectricalComponentCategory`.
* The existing `TargetCategory.category` property is preserved for backward compatibility and returns the corresponding `ComponentCategory`.
* Support secrets for signing and verifying messages.
* Use the new env variable `DISPATCH_API_SIGN_SECRET` to set the secret key.
* Use the new `sign_secret` parameter in the `DispatchClient` constructor to set the secret key.
* Added `auth_key` parameter to the `dispatch-cli` and the new variable `DISPATCH_API_AUTH_KEY` to set the authentication key for the Dispatch API.

<!-- Here goes the main new features and examples or instructions on how to use them -->

## Bug Fixes

Expand Down