Skip to content

Commit

Permalink
Clear release notes
Browse files Browse the repository at this point in the history
Signed-off-by: Sahas Subramanian <[email protected]>
  • Loading branch information
shsms committed Oct 18, 2024
1 parent 2f62b64 commit 6e51fba
Showing 1 changed file with 4 additions and 12 deletions.
16 changes: 4 additions & 12 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,16 @@

## Summary

The SDK starts using the [`frequenz-quantities`](https://pypi.org/project/frequenz-quantities/) package with this release.

A new method for streaming reactive power at the grid connection point has been added, and the `ConfigManagingActor` has been improved.
<!-- Here goes a general summary of what this release is about -->

## Upgrading

- Replace `Quantity` and its sub-classes (`Power`, `Current`, etc.) in the `frequenz.sdk.timeseries` module with the external [`frequenz-quantities`](https://pypi.org/project/frequenz-quantities/) package. Please add the new library as a dependency and adapt your imports if you are using these types.
- The `QuantityT` has been moved to the `frequenz.sdk.timeseries._base_types` module.
- The `QuantityT` doesn't include itself (`QuantityT`) anymore.
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

## New Features

- `ConfigManagingActor`: The file polling mechanism is now forced by default. Two new parameters have been added:
- `force_polling`: Whether to force file polling to check for changes. Default is `True`.
- `polling_interval`: The interval to check for changes. Only relevant if polling is enabled. Default is 1 second.

- Add a new method `microgrid.grid().reactive_power` to stream reactive power at the grid connection point.
<!-- Here goes the main new features and examples or instructions on how to use them -->

## Bug Fixes

- Many long running async tasks including metric streamers in the BatteryPool now have automatic recovery in case of exceptions.
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 comments on commit 6e51fba

Please sign in to comment.