@@ -9,9 +9,12 @@ https://frequenz-floss.github.io/frequenz-sdk-python/
99For now the documentation is pretty scarce but we will be improving it with
1010time.
1111
12- ## Upgrading
12+ The most prominent changes in this release is the cleanup of the public API,
13+ which is much more concise and clear now and the addition of classes
14+ implementing the new data flow design, in particular the ` DataSourcingActor `
15+ and the ` ComponentMetricsResamplingActor ` .
1316
14- <!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
17+ ## Upgrading
1518
1619* ` EVChargerData ` 's ` active_power_consumption ` has been renamed to ` active_power `
1720
@@ -27,14 +30,62 @@ time.
2730 changes] ( https://github.com/frequenz-floss/frequenz-channels-python/blob/v0.11.0/RELEASE_NOTES.md#upgrading-breaking-changes )
2831 you should be aware of.
2932
30- ## New Features
33+ * The public API has been cleaned up, several symbols were moved or exposed in
34+ a single module, and some symbols were hidden because they are either
35+ schedule for deprecation or not yet stabilized.
36+
37+ * ` frequenz.sdk.actor ` : The ` decorator ` sub-module was hidden and now the
38+ ` @actor ` decorator is exposed directly only in the main module.
39+
40+ * ` frequenz.sdk.configs ` : was renamed to ` frequenz.sdk.config ` , ` Config ` is
41+ only exposed in the main module and the ` ConfigManager ` was moved to
42+ ` frequenz.sdk.actor.ConfigManagingActor ` .
43+
44+ * The modules ` frequenz.sdk.data_handling ` and ` frequenz.sdk.data_ingestion `
45+ were hidden from the public interface and will probably be removed in the
46+ future. They are still available as ` frequenz.sdk._data_handling ` and
47+ ` frequenz.sdk._data_ingestion ` for users still needing them.
48+
49+ * The module ` frequenz.sdk.power_distribution ` was renamed to
50+ ` frequenz.sdk.power ` and the ` PowerDistributor ` was moved to
51+ ` frequenz.sdk.actor.power_distributing.PowerDistributingActor ` (with the
52+ utility classes ` Request ` and ` Result ` ).
53+
54+ * The module ` frequenz.sdk.microgrid ` was simplified.
55+
56+ * All component-related symbols (` .component ` , ` .component_data ` ,
57+ ` .component_states ` ) were moved to the sub-module
58+ ` frequenz.sdk.microgrid.component ` .
3159
32- <!-- Here goes the main new features and examples or instructions on how to use them -->
60+ * All API client-related symbols (` .client ` , ` .connection ` , ` .retry ` ) were
61+ moved to the sub-module ` frequenz.sdk.microgrid.client ` .
62+
63+ * The ` ComponentGraph ` is exposed directly in the main module (and only
64+ there).
65+
66+ * The ` microgrid_api ` module is now exposed via the main module directly
67+ (and thus indirectly renamed to ` microgrid ` , so instead of using `from
68+ frequenz.sdk.microgrid import microgrid_api; microgrid_api.initialize()`
69+ (for example) you should use `from frequenz.sdk.microgrid import
70+ microgridi; microgrid.initialize()`.
71+
72+ * The ` MicrogridApi ` class was renamed to ` Microgrid ` to make it clear it
73+ is not exclusively about the API.
74+
75+ * The ` Microgrid.microgrid_api_client ` attribute was renamed to
76+ ` Microgrid.api_client ` to avoid the redundancy.
77+
78+ ## New Features
3379
3480* ` MeterData ` objects now expose the AC ` frequency ` measured by the meter.
81+
3582* ` BatteryData ` objects now expose the temperature of the hottest block in the
3683 battery as ` temperature_max `
3784
38- ## Bug Fixes
85+ * A new ` frequenz.sdk.actor.DataSourcingActor ` was added.
86+
87+ * A new ` frequenz.sdk.actor.ComponentMetricsResamplingActor ` was added.
88+
89+ * A new ` frequenz.sdk.actor.ChannelRegistry ` was added.
3990
40- <!-- Here goes notable bug fixes that are worth a special mention or explanation -->
91+ * A new module ` frequenz.sdk.timeseries ` was added.
0 commit comments