-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,17 @@ | ||
# Frequenz Microgrid API Client Release Notes | ||
|
||
## Upgrading | ||
## Summary | ||
|
||
- `ApiClient`: | ||
<!-- Here goes a general summary of what this release is about --> | ||
|
||
* 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. | ||
## Upgrading | ||
|
||
* The `frequenz-client-base` dependency was bumped to v0.8.0. | ||
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with --> | ||
|
||
## 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](https://frequenz-floss.github.io/frequenz-client-base-python/latest/reference/frequenz/client/base/client/#frequenz.client.base.client.BaseApiClient) for more information on these features. | ||
- The client now supports setting reactive power for components through the new `set_reactive_power` method. | ||
<!-- Here goes the main new features and examples or instructions on how to use them --> | ||
|
||
## Bug Fixes | ||
|
||
<!-- Here goes notable bug fixes that are worth a special mention or explanation --> |