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

v0.8.4

Frequenz Dispatch Client Library Release Notes

Bug Fixes

• Fix missing dependency in last release.
• The FakeClient.set_dispatches() method now correctly updates FakeService._last_id which is used to generate unique dispatch IDs.
• Fix that streams were globally shared between all clients.

What's Changed

• Bump types-python-dateutil from 2.9.0.20241003 to 2.9.0.20241206 by @dependabot in #121
• Update frequenz-client-common requirement from <0.3.0,>=0.1.0 to >=0.1.0,<0.4.0 by @dependabot in #122
• Bump types-markdown from 3.7.0.20240822 to 3.7.0.20241204 by @dependabot in #120
• Bump the required group across 1 directory with 7 updates by @dependabot in #123
• Fix some problems that related to flakey tests by @Marenz in #124

Full Changelog: v0.8.3...v0.8.4

v0.8.3

Frequenz Dispatch Client Library Release Notes

Bug Fixes

• Fix missing dependency in last release

What's Changed

• Fix missing dependency by @Marenz in #118

Full Changelog: v0.8.2...v0.8.3

v0.8.2

Frequenz Dispatch Client Library Release Notes

Summary

• The dispatch-cli application now features fancy colors and formatting!

Bug Fixes

• Fixed a bug where the dispatch-cli application would crash when reading a Dispatch with frequency YEARLY

What's Changed

• Add colors and formatting to dispatch-cli by @Marenz in #110
• Bump setuptools-scm[toml] from 7.1.0 to 8.1.0 by @dependabot in #112
• Bump setuptools from 68.1.0 to 75.6.0 by @dependabot in #113
• Apply new repo-config 0.11 templates by @llucax in #115
• Bump the required group across 1 directory with 8 updates by @dependabot in #114
• Add missing YEARLY mapping for recurrence by @Marenz in #116

Full Changelog: v0.8.1...v0.8.2

v0.8.1

Frequenz Dispatch Client Library Release Notes

Summary

• The base client dependency was updated to v0.8.0.

What's Changed

• Fix base-client used wrongly by @Marenz in #108
• Use new BaseClient version by @Marenz in #109

Full Changelog: v0.8.0...v0.8.1

v0.8.0

Frequenz Dispatch Client Library Release Notes

New Features

• Update BaseApiClient to get the http2 keepalive feature.
• Some Methods from the high-level API have been moved to this repo: The dispatch class now offers: until, started, next_run and next_run_after.
• Add start_immediately support to the create method. You can now specify "NOW" as the start time to trigger immediate dispatch. Note: While the dispatch CLI previously allowed this by converting "NOW" to a timestamp client-side before sending it to the server, this functionality is now supported directly on the server side!

What's Changed

• Enhance readme, add links, reformat by @Marenz in #100
• Bump the required group with 8 updates by @dependabot in #101
• Update BaseClient to support keepalive by @Marenz in #104
• Move some high-level functions to this repo by @Marenz in #103
• Update API and add support for start_immediately by @Marenz in #105
• Update readme for release by @Marenz in #106

Full Changelog: v0.7.1...v0.8.0