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