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

v0.5.2

Frequenz Microgrid API Client Release Notes

New Features

• The client now supports setting reactive power for components through the new set_reactive_power method.

What's Changed

• Add the set_reactive_power method by @shsms in #99

Full Changelog: v0.5.1...v0.5.2

v0.5.1

Frequenz Microgrid API Client Release Notes

Bug Fixes

• Fix a bug where SSL was enabled by default. It is now disabled by default as in previous versions.

What's Changed

• Clear release notes by @llucax in #83
• Disable SSL by default by @llucax in #85
• Bump the required group across 1 directory with 4 updates by @dependabot in #86

Full Changelog: v0.5.0...v0.5.1

v0.5.0

Frequenz Microgrid API Client Release Notes

Upgrading

• This release stops using betterproto and grpclib as backend for gRPC and goes back to using Google's grpcio and protobuf.

  If your code was using betterproto and grpclib, it now needs to be ported to use grpcio and protobuf too. Remember to also remove any betterproto and grpclib dependencies from your project.

• We are now using base-client v0.6.0.

What's Changed

• Clear release notes by @llucax in #56
• Bump the required group with 14 updates by @dependabot in #57
• Bump docker/build-push-action from 5 to 6 by @dependabot in #58
• Bump brettcannon/check-for-changed-files from 1.2.0 to 1.2.1 by @dependabot in #59
• Configure dependabot to have separate minor updates for in-devel deps by @llucax in #61
• Bump mike from 2.1.1 to 2.1.2 by @dependabot in #65
• Bump pytest from 8.2.1 to 8.2.2 by @dependabot in #67
• Bump pydoclint from 0.4.1 to 0.5.3 by @dependabot in #63
• Fix patterns in dependabot.yml by @llucax in #70
• Bump the required group with 4 updates by @dependabot in #72
• Group GitHub action dependabot updates by @llucax in #71
• Bump the required group across 1 directory with 15 updates by @dependabot in #78
• Drop betterproto/grpclib (and upgrade client-base) by @llucax in #80
• Disable pylints no-name-in-module check by @llucax in #81
• Prepare readme for release by @Marenz in #82

New Contributors

• @Marenz made their first contribution in #82

Full Changelog: v0.4.0...v0.5.0

v0.4.0

Frequenz Microgrid API Client Release Notes

Summary

This release migrates to use betterproto and grpclib instead of grpcio and protobuf internally. It also stops leaking these internal libraries to downstream users. It should now be possible to use the client without having to use grpclib or betterproto directly.

Upgrading

• The client now uses a string URL to connect to the server, the grpc_channel and target arguments are now replaced by server_url. The current accepted format is grpc://hostname[:<port:int=9090>][?ssl=<ssl:bool=false>], meaning that the port and ssl are optional and default to 9090 and false respectively. You will have to adapt the way you connect to the server in your code.

• The client is now using grpclib to connect to the server instead of grpcio. You might need to adapt your code if you are using grpcio directly.

• The client now doesn't raise grpc.aio.RpcError exceptions anymore. Instead, it raises its own exceptions, one per gRPC error status code, all inheriting from GrpcError, which in turn inherits from ClientError (as any other exception raised by this library in the future). GrpcErrors have the grpclib.GRPCError as their __cause__. You might need to adapt your error handling code to catch these specific exceptions instead of grpc.aio.RpcError.

  You can also access the underlying grpclib.GRPCError using the grpc_error attribute for GrpStatusError exceptions, but it is discouraged because it makes downstream projects dependant on grpclib too

• The client now uses protobuf/grpc bindings generated betterproto (frequenz-microgrid-betterproto) instead of grpcio (frequenz-api-microgrid). If you were using the bindings directly, you might need to do some minor adjustments to your code.

• If an unknown EV charger component state is received, it will now be set to EVChargerComponentState.UNKNOWN instead of EVChargerComponentState.UNSPECIFIED.

New Features

• The client now raises more specific exceptions based on the gRPC status code, so you can more easily handle different types of errors.

  For example:

  try:
     connections = await client.connections()
  except OperationTimedOut:
     ...

  instead of:

  try:
     connections = await client.connections()
  except grpc.aio.RpcError as e:
     if e.code() == grpc.StatusCode.DEADLINE_EXCEEDED:
        ...

• We now expose component errors as part of the streamed component data:

  • BatteryData.errors
  • InverterData.errors

• We now expose component states as part of the streamed component data:

  • BatteryData.component_state and BatteryData.relay_state
  • InverterData.component_state

• Added the missing EVChargerComponentState.UNKNOWN state.

Bug Fixes

• Fix a leakage of GrpcStreamBroadcaster instances.
• The user-passed retry strategy was not properly used by the data streaming methods.
• The client set_bounds() method might have not done anything and if it did, errors were not properly raised.

What's Changed

• Clear release notes by @llucax in #32
• Bump nox from 2023.4.22 to 2024.3.2 by @dependabot in #35
• Update protobuf requirement from <5,>=4.21.6 to >=4.21.6,<6 by @dependabot in #34
• Bump nox from 2024.3.2 to 2024.4.15 in the required group by @dependabot in #38
• Improve exception messages by @llucax in #43
• Fix a few bugs related to GrpcStreamBroadcaster by @llucax in #42
• Bump client-base to v0.4.0 by @llucax in #44
• Properly await for AddInclusionBounds by @llucax in #47
• Allow using None to specify the default retry strategy by @llucax in #46
• Raise a new ClientError instead of AioRpcError by @llucax in #48
• Convert to betterproto by @llucax in #37
• Make the client accept a server URL to connect to by @llucax in #49
• Add specific gRPC client errors by @llucax in #53
• Add missing state and error wrappers by @llucax in #54

Full Changelog: v0.3.0...v0.4.0

v0.3.0

Frequenz Microgrid API Client Release Notes

New Features

• The reactive_power is exposed for meters, inverters and EV chargers.

What's Changed

• Clear RELEASE_NOTES.md by @shsms in #27
• Add reactive power for inverters, meters and EV chargers by @llucax in #30
• Improve Location docs and tests by @llucax in #29
• Widen the channels dependency by @llucax in #31

Full Changelog: v0.2.0...v0.3.0

v0.2.0

Frequenz Microgrid API Client Release Notes

Summary

This release updates the minimum required frequenz-channels version is updated
to v1.0.0-rc1. This is a breaking change, because the channels API has changed.

Upgrading

Follow the upgrading instructions from the new channel release: v1.0.0-rc1.

What's Changed

• Clear release notes by @llucax in #25
• Update minimum frequenz-channels version to v1.0.0-rc1 by @shsms in #26

New Contributors

• @shsms made their first contribution in #26

Full Changelog: v0.1.2...v0.2.0

v0.1.2

Frequenz Microgrid API Client Release Notes

Summary

This version downgrades the protobuf dependency to 4.21.6.

This is the version used in the SDK v1.0.0-rc5, which we imported the code from. If we don't do this we introduce an unnecessary dependency conflict with the SDK.

What's Changed

• Clear release notes by @llucax in #23
• Downgrade protobuf to 4.21.6 by @llucax in #24

Full Changelog: v0.1.1...v0.1.2

v0.1.1

Frequenz Microgrid API Client Release Notes

Summary

This release add some symbols that were missing from the public API:

• ComponentCategory
• ComponentMetadata
• ComponentMetricId
• ComponentType
• Fuse
• GridMetadata
• InverterType

What's Changed

• Clear release notes by @llucax in #21
• Expose missing symbols by @llucax in #22

Full Changelog: v0.1.0...v0.1.1

v0.1.0

Frequenz Microgrid API Client Release Notes

Summary

Code import from the SDK v1.0.0-rc5 release.

Upgrading

Changes compared to the code in the SDK v1.0.0-rc5 release:

• The MicrogridGrpcClient class was renamed to ApiClient.

  • The retry_spec constructor argument was renamed to retry_strategy.

• The MicrogridApiClient abstract base class was removed, use ApiClient instead.

• The Connection class is now a dataclass instead of a NamedTuple. If you use the tuple-like interface (connection[0], etc.) you should use the named attributes instead or use dataclasses.astuple() to convert it to a tuple.

What's Changed

• Generate project structure using repo-config by @llucax in #1
• Import code from the SDK v1.0.0-rc5 by @llucax in #9
• Bump actions/cache from 3 to 4 by @dependabot in #5
• Bump actions/setup-python from 4 to 5 by @dependabot in #4
• Bump flake8 from 6.1.0 to 7.0.0 by @dependabot in #7
• Bump black from 23.9.1 to 24.2.0 by @dependabot in #8
• Bump actions/{up,down}load-artifact from 3 to 4 by @dependabot in #2
• Bump the optional group with 12 updates by @dependabot in #10
• Clean up the code by @llucax in #11
• Add more tests from the SDK v1.0.0-rc5 by @llucax in #12
• Use streaming helper and retry strategies from frequenz-client-base by @llucax in #17
• Upgrade client-base to v0.2.0 by @llucax in #20
• Bump mkdocs-material from 9.5.11 to 9.5.12 by @llucax in #19

New Contributors

• @llucax made their first contribution in #1
• @dependabot made their first contribution in #5

Full Changelog: https://github.com/frequenz-floss/frequenz-client-microgrid-python/commits/v0.1.0