v0.11.2
Frequenz Dispatch Client Library Release Notes
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.
Upgrading
InverterType.SOLARis now deprecated in favor ofInverterType.PV. The old name can still be used but will be removed in a future release.- The following dependencies were updated:
frequenz-api-dispatchtov1.0.0-rc3frequenz-client-commontov0.3.6grpciotov1.72.1
New Features
ElectricalComponentCategory: The client now uses the more specificfrequenz.client.common.microgrid.electrical_components.ElectricalComponentCategoryfor targeting components.- The new property
TargetCategory.category2will return anElectricalComponentCategory. - The existing
TargetCategory.categoryproperty is preserved for backward compatibility and returns the correspondingComponentCategory.
- The new property
- Support secrets for signing and verifying messages.
- Use the new env variable
DISPATCH_API_SIGN_SECRETto set the secret key. - Use the new
sign_secretparameter in theDispatchClientconstructor to set the secret key.
- Use the new env variable
- Added
auth_keyparameter to thedispatch-cliand the new variableDISPATCH_API_AUTH_KEYto set the authentication key for the Dispatch API.
Bug Fixes
What's Changed
- Support secrets and signing by @Marenz in #186
- Bump types-markdown from 3.8.0.20250415 to 3.8.0.20250708 by @dependabot[bot] in #195
- Bump pytest-asyncio from 1.0.0 to 1.1.0 by @dependabot[bot] in #194
- Bump types-protobuf from 6.30.2.20250516 to 6.30.2.20250703 by @dependabot[bot] in #196
- Bump the compatible group with 2 updates by @dependabot[bot] in #190
- Bump mkdocstrings[python] from 0.29.1 to 0.30.0 in the mkdocstrings group by @dependabot[bot] in #191
- Bump mkdocs-material from 9.6.15 to 9.6.16 in the patch group by @dependabot[bot] in #188
- Bump async-solipsism from 0.7 to 0.8 by @dependabot[bot] in #192
- Bump the minor group with 2 updates by @dependabot[bot] in #189
- refactor: Adapt code to v1alpha8 API of frequenz-client-common by @Marenz in #197
Full Changelog: v0.11.1...v0.11.2