v0.6.0

Frequenz Microgrid API Client Release Notes

Upgrading

• ApiClient:

  • The class was renamed to MicrogridApiClient.
  • The api attribute was renamed to stub.
  • The constructor parameter channel_options was renamed to channels_defaults to match the name used in BaseApiClient.
  • The constructor now accepts a connect parameter, which is True by default. If set to False, the client will not connect to the server upon instantiation. You can connect later by calling the connect() method.

• The frequenz-client-base dependency was bumped to v0.8.0.

New Features

• The client now inherits from frequenz.client.base.BaseApiClient, so it provides a few new features, like disconnect()ing or using it as a context manager. Please refer to the BaseApiClient documentation for more information on these features.
• The client now supports setting reactive power for components through the new set_reactive_power method.

What's Changed

• Clear release notes by @llucax in #87
• Inherit from BaseApiClient by @llucax in #88
• Use call_stub_method() to call stub methods by @llucax in #89
• Remove duplicated show_symbol_type_toc key in mkdocs.yml by @llucax in #90
• Bump mkdocstrings dependencies by @llucax in #91
• Bump the required group with 5 updates by @dependabot in #92
• Bump the required group with 7 updates by @dependabot in #95
• Bump types-protobuf from 4.21.0.7 to 5.28.3.20241030 by @dependabot in #97
• Add the set_reactive_power method by @shsms in #99
• Update the client-base dependency to v0.8.0 by @llucax in #100
• Prepare for the v0.6.0 release by @llucax in #101

Full Changelog: v0.5.1...v0.6.0