Skip to content

Commit 2b8e51b

Browse files
committed
Clear release notes
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent 7563587 commit 2b8e51b

File tree

1 file changed

+6
-16
lines changed

1 file changed

+6
-16
lines changed

RELEASE_NOTES.md

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,17 @@
11
# Frequenz Python SDK Release Notes
22

3-
## Upgrading
4-
5-
- The `frequenz-client-microgrid` dependency was bumped to v0.4.0. If you are using the client directly in your code, you will need to upgrade too.
6-
7-
- Calls to `microgrid.*_pool` methods now always need to specified a priority value, corresponding to the requirements/priority of the actor making the call.
8-
9-
- The `microgrid.*_pool` methods would only accept keyword arguments from now on.
3+
## Summary
104

11-
- The `microgrid.initialize()` method now takes a `server_url` instead of a `host` and `port`.
5+
<!-- Here goes a general summary of what this release is about -->
126

13-
The following format is expected: `grpc://hostname{:port}{?ssl=ssl}`, where the port should be an int between `0` and `65535` (defaulting to `9090`) and `ssl` should be a boolean (defaulting to `false`). For example: `grpc://localhost` or `grpc://localhost:1090?ssl=true`.
14-
15-
The default was also removed, so you always need to specify the server URL.
16-
17-
This applies to the `ConnectionManager` as well, which also now doesn't expose the `host` and `port` attributes, only the `server_url`. If you need to extract the host or port from the `server_url`, you can use the standard Python `urllib.parse.urlparse()` function.
7+
## Upgrading
188

19-
- The `Config` class was removed and the `ConfigManagingActor` now sends a plain dictionary rather than a `Config` object.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
2010

2111
## New Features
2212

23-
- Calls to `microgrid.*_pool` methods now accept an optional `set_operating_point` parameter, for setting an operating point for the other actors. This would shift the target power by the operating point before actually applying it to the components.
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
2414

2515
## Bug Fixes
2616

27-
- When the PowerDistributor receives a zero power request for PV inverters, it now correctly sets zero power to the inverters, and no longer crashes.
17+
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 commit comments

Comments
 (0)