Skip to content

Commit 11baf07

Browse files
committed
Clear release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 57337df commit 11baf07

File tree

1 file changed

+4
-30
lines changed

1 file changed

+4
-30
lines changed

RELEASE_NOTES.md

Lines changed: 4 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,42 +2,16 @@
22

33
## Summary
44

5-
The most notable features for this release is the addition of the `PVPool` (exposed via `microgrid.pv_pool()`), which can be used to manage PV arrays as a single entity and the `EVChargerPool` (`microgrid.ev_charger_pool()`) learning to manage power for the whole pool (before it could only be used to control chargers individually).
6-
7-
Another notable change is the microgrid API client being moved to its own [repository](https://github.com/frequenz-floss/frequenz-client-microgrid-python/).
5+
<!-- Here goes a general summary of what this release is about -->
86

97
## Upgrading
108

11-
- The SDK is now using the microgrid API client from [`frequenz-client-microgrid`](https://github.com/frequenz-floss/frequenz-client-microgrid-python/). You should update your code if you are using the microgrid API client directly.
12-
13-
- The minimum required `frequenz-channels` version is now [`v1.0.0-rc1`](https://github.com/frequenz-floss/frequenz-channels-python/releases/tag/v1.0.0-rc.1).
14-
15-
- The set of battery IDs managed by a battery pool are now available through `BatteryPool.component_ids`, and no longer through `BatteryPool.battery_ids`. This is done to have a consistent interface with other `*Pool`s.
16-
17-
- The `maxsize` parameter in calls to `BatteryPool.{soc/capacity/temperature}.new_receiver()` methods have now been renamed to `limit`, to be consistent with the channels repository.
18-
19-
- Support for per-component interaction in `EVChargerPool` has been removed. Please use the new `propose_power()` method to manage power for the whole pool. If you still need to manage power of chargers individually, you can create one pool per charger.
20-
21-
- PV power is now available from `microgrid.pv_pool().power`, and no longer from `microgrid.logical_meter().pv_power`.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
2210

2311
## New Features
2412

25-
- `EVChargerPool`/`microgrid.ev_charger_pool()`: New `propose_power` and `power_status` methods have been added, similar to the `BatteryPool`. These method interface with the `PowerManager` and `PowerDistributor`, which currently uses a first-come-first-serve algorithm to distribute power to EVs.
26-
27-
- A PV pool (`PVPool`/`microgrid.pv_pool()`) was added, with `propose_power`, `power_status` and `power` methods similar to Battery and EV pools.
28-
29-
- The microgrid API client now exposes the reactive power for inverters, meters and EV chargers.
30-
31-
## Enhancements
32-
33-
- Warning messages are logged when multiple instances of `*Pool`s are created for the same set of batteries, with the same priority values.
34-
35-
- A warning message will now be logged if no relevant samples are found in a component for resampling.
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
3614

3715
## Bug Fixes
3816

39-
- A bug was fixed where the grid fuse was not created properly and would end up with a `max_current` with type `float` instead of `Current`.
40-
41-
- `BatteryPool.propose_discharge` now converts power values to the passive-sign convention. Earlier it was not doing this and that was causing it to charge instead of discharge.
42-
43-
- Fix a bug that was causing the power managing actor to crash and restart when cleaning up old proposals.
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)