v0.8.0

Frequenz Common API Release Notes

Summary

This release introduces the new v1alpha8 version of the API, which includes several breaking changes compared to v1alpha7. The changes focus on improving consistency and clarity by renaming several symbols and removing unused components.

Upgrading

• A new package frequenz.api.common.v1alpha8 has been introduced, containing the following breaking changes from v1alpha7.

• Removed:

  • electrical_components.Fuse
  • InverterType.INVERTER_TYPE_WIND_TURBINE

• Renamed several symbols to increase consistency and clarity:

  • microgrid:

    • MicrogridComponentIds to MicrogridElectricalComponentIds
    • MicrogridComponentIDs.component_ids to MicrogridElectricalComponentIds.electrical_component_ids

  • electrical_components:

    • ElectricalComponentConnections.source_component_id to ElectricalComponentConnections.source_electrical_component_id
    • ElectricalComponentConnections.destination_component_id to ElectricalComponentConnections.destination_electrical_component_id
    • ElectricalComponentStateSnapshot.component_id to ElectricalComponentStateSnapshot.electrical_component_id
    • Transformer-related terms are renamed to align them with power transformers, which are more commonly used in electrical engineering:
      • electrical_components.VoltageTransformer to electrical_components.PowerTransformer
      • ElectricalComponentCategorySpecificInfo.kind.voltage_transformer to ElectricalComponentCategorySpecificInfo.kind.power_transformer
      • ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_VOLTAGE_TRANSFORMER to ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_POWER_TRANSFORMER

  • type:

    • The whole package has been renamed to types to avoid using reserved keywords in programming languages.

What's Changed

• Bump the patch group with 2 updates by @dependabot in #383
• dependabot: Group grpc/protobuf updates together by @llucax in #385
• Bump the minor group across 1 directory with 2 updates by @dependabot in #386
• Bump frequenz-floss/gh-action-setup-python-with-deps from 1.0.0 to 1.0.1 in the compatible group by @dependabot in #388
• Bump frequenz-floss/gh-action-nox from 1.0.0 to 1.0.1 in the compatible group by @dependabot in #389
• Clear release notes and add v1alpha8 package by @tiyash-basu-frequenz in #396
• Remove electrical_components.Fuse from frequenz.api.common.v1alpha8 by @tiyash-basu-frequenz in #394
• Remove InverterType.INVERTER_TYPE_WIND_TURBINE by @tiyash-basu-frequenz in #397
• Rename leftover uses of component_id to electrical_component_id by @tiyash-basu-frequenz in #398
• Rename voltage-transformer to power-transformer by @tiyash-basu-frequenz in #399
• Rename type package to types in v1alpha8 proto files by @tiyash-basu-frequenz in #400
• Clean up and reformat the release notes for v1alpha8 by @tiyash-basu-frequenz in #401

Full Changelog: v0.7.0...v0.8.0