v1.0.0

Frequenz Dispatch Client Library Release Notes

Summary

Upgrading

New Features

Bug Fixes

What's Changed

• Prepare for v1.0.0 by @Marenz in #222

Full Changelog: v0.11.4...v1.0.0

v0.11.4

Frequenz Dispatch Client Library Release Notes

Summary

Upgrading

New Features

• Changed target_components, dispatch_ids, and filter_queries parameters from Iterator to Iterable in list method for better API usability
• Added support for dispatch_ids and queries filters in the list method
  • dispatch_ids parameter allows filtering by specific dispatch IDs
  • filter_queries parameter supports text-based filtering on dispatch id and type fields
    • Query format: IDs are prefixed with # (e.g., #4), types are matched as substrings (e.g., bar matches foobar)
    • Multiple queries are combined with logical OR
• Date-only inputs in CLI timestamps now default to midnight UTC instead of using the current time.

Bug Fixes

What's Changed

• Bump pytest-asyncio from 1.1.0 to 1.2.0 by @dependabot[bot] in #218
• Bump actions/labeler from 5.0.0 to 6.0.1 by @dependabot[bot] in #215
• Bump pydoclint from 0.6.11 to 0.7.3 by @dependabot[bot] in #217
• Bump the minor group with 10 updates by @dependabot[bot] in #216
• Bump the patch group across 1 directory with 5 updates by @dependabot[bot] in #219
• Add support for dispatch_ids and queries filters by @Marenz in #213
• Fix: Use midnight UTC for date-only CLI timestamps instead of current time by @Marenz in #220
• Fix: Change list method parameters from Iterator to Iterable for better API usability by @Marenz in #223

Full Changelog: v0.11.3...v0.11.4

v0.11.3

Frequenz Dispatch Client Library Release Notes

Summary

Upgrading

New Features

Bug Fixes

• The FakeService filter list code is now properly checking for unset fields to filter for.

What's Changed

• Bump types-python-dateutil from 2.9.0.20250516 to 2.9.0.20250708 by @dependabot[bot] in #193
• Bump types-markdown from 3.8.0.20250708 to 3.8.0.20250809 by @dependabot[bot] in #209
• Bump types-python-dateutil from 2.9.0.20250708 to 2.9.0.20250822 by @dependabot[bot] in #208
• Bump actions/checkout from 4 to 5 by @dependabot[bot] in #205
• Bump the patch group with 4 updates by @dependabot[bot] in #207
• Bump setuptools-scm[toml] from 8.3.1 to 9.2.0 by @dependabot[bot] in #204
• Bump pydoclint from 0.6.6 to 0.6.11 by @dependabot[bot] in #203
• Bump actions/download-artifact from 4 to 5 in the artifacts group by @dependabot[bot] in #202
• Reset release notes for new release by @Marenz in #211
• FakeService: filter: Fix field-existance check by @Marenz in #212

Full Changelog: v0.11.2...v0.11.3

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.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

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.

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

v0.11.1

Frequenz Dispatch Client Library Release Notes

Summary

Upgrading

New Features

• Dispatch.started_at(now: datetime) was added as alternative to the started property for when users want to use the same now for multiple calls, ensuring deterministic return values with respect to the same now.

Bug Fixes

What's Changed

• Bump the minor group with 3 updates by @dependabot[bot] in #184
• Bump the patch group with 5 updates by @dependabot[bot] in #183
• Bump pytest-asyncio from 0.26.0 to 1.0.0 by @dependabot[bot] in #185
• Add started_at by @Marenz in #187

Full Changelog: v0.11.0...v0.11.1

v0.11.0

Frequenz Dispatch Client Library Release Notes

Summary

While the new TargetCategory class supports subtypes, only reading them is currently available; setting subtypes will be introduced in a future release.

Upgrading

• TargetComponents was reworked. It now is a type alias for TargetIds | TargetCategories:
• TargetIds can be used to specify one or more specific target IDs:
• TargetIds(1, 2, 3) or
• TargetIds(ComponentIds(1), ComponentIds(2), ComponentIds(3))
• TargetCategories can be used to specify one or more target categories:
• TargetCategories(ComponentCategory.BATTERY, ComponentCategory.INVERTER)
• Dispatch ids and microgrid ids are no longer simple int types but are now wrapped in DispatchId and MicrogridId classes, respectively. This allows for better type safety and clarity in the codebase.

New Features

• With the new TargetCategory class (providing .category and .type) we can now specify subtypes of the categories:
• ComponentCategory.BATTERY uses BatteryType with possible values: LI_ION, NA_ION
• ComponentCategory.INVERTER uses InverterType with possible values: BATTERY, SOLAR, HYBRID
• ComponentCategory.EV_CHARGER uses EvChargerType: with possible values AC, DC, HYBRID
• A few examples on how to use the new TargetCategory:
  • TargetCategory(BatteryType.LI_ION)
    • category is ComponentCategory.BATTERY
    • type is BatteryType.LI_ION
  • TargetCategory(ComponentCategory.BATTERY)
    • category is ComponentCategory.BATTERY
    • type is None
  • TargetCategories(InverterType.SOLAR)
    • category is ComponentCategory.INVERTER
    • type is InverterType.SOLAR

Bug Fixes

What's Changed

• Bump the patch group with 5 updates by @dependabot in #173
• Bump types-protobuf from 5.29.1.20250403 to 6.30.2.20250516 by @dependabot in #175
• Bump the minor group with 3 updates by @dependabot in #174
• Bump types-python-dateutil from 2.9.0.20241206 to 2.9.0.20250516 by @dependabot in #176
• Allow targeting categories with subtypes by @Marenz in #168
• Delete obsolete release notes entries by @Marenz in #177
• Prepare readme for release by @Marenz in #178
• Fix stream() not working with base-client 0.11 by @Marenz in #180
• Update to use BaseId' ids by @Marenz in #181

Full Changelog: v0.10.2...v0.11.0

v0.10.2

Frequenz Dispatch Client Library Release Notes

Summary

Upgrading

New Features

• dispatch-cli supports now the parameter --type and --running to filter the list of running services by type and status, respectively.
• Every call now has a default timeout of 60 seconds, streams terminate after five minutes. This can be influenced by the two new parameters forDispatchApiClient.__init__():
  • default_timeout: timedelta (default: 60 seconds)
  • stream_timeout: timedelta (default: 5 minutes)

Bug Fixes

What's Changed

• Add two new filters by @Marenz in #167
• Add timeouts to all api calls by @Marenz in #169
• Widen base-client dependency to 0.12.0 by @Marenz in #171

Full Changelog: v0.10.1...v0.10.2

v0.10.1

Frequenz Dispatch Client Library Release Notes

Bug Fixes

• Fix cli client trying to use a invalid default URL when none is given.

Upgrading

• You now must always provide the URL to the dispatch client.

What's Changed

• Remove (now invalid) default URL for dispatch API by @Marenz in #166

Full Changelog: v0.10.0...v0.10.1

v0.9.0

Frequenz Dispatch Client Library Release Notes

Features

• Dispatch.end_time has been added to the Dispatch class, which is the time when the dispatch ended as calculated by the server. dispatch-cli will also print this time.

Bug Fixes

• Fix that dispatch-cli stream would try to print an event as dispatch, causing an exception.
• Fix that stream() would not reconnect and just closes the channel upon disconnection.

What's Changed

• Bump black from 24.10.0 to 25.1.0 by @dependabot in #129
• Bump the required group with 8 updates by @dependabot in #127
• Bump isort from 5.13.2 to 6.0.0 by @dependabot in #128
• Update frequenz-client-base requirement from <0.9.0,>=0.8.0 to >=0.8.0,<0.10.0 by @dependabot in #131
• Bump types-protobuf from 5.29.1.20241207 to 5.29.1.20250208 by @dependabot in #132
• Bump nox from 2024.10.9 to 2025.2.9 by @dependabot in #133
• Update pylint + isort by @Marenz in #136
• Update nox-all CI job by @Marenz in #138
• Fix dispatch-cli stream trying to print event as dispatch by @Marenz in #141
• Update to repo-config v0.13.2 by @llucax in #143
• Bump setuptools from 75.8.0 to 78.1.0 by @dependabot in #144
• Bump pytest-asyncio from 0.25.3 to 0.26.0 by @dependabot in #145
• Bump types-protobuf from 5.29.1.20250208 to 5.29.1.20250403 by @dependabot in #149
• Bump pydoclint from 0.6.0 to 0.6.5 by @dependabot in #148
• Bump the patch group with 4 updates by @dependabot in #147
• Bump the minor group with 7 updates by @dependabot in #150
• Add Dispatch.end_time and print it in dispatch-cli by @Marenz in #142
• Fix stream reconnecting by @Marenz in #151

Full Changelog: v0.8.5...v0.9.0

v0.8.5

Frequenz Dispatch Client Library Release Notes

Bug Fixes

• Fix that duration=0 was sent & received as None.

What's Changed

• Fix that duration=0 was sent & received as None by @Marenz in #126

Full Changelog: v0.8.4...v0.8.5