From 4459882a4b5b56cb2d2ee6e35a80e9688792f575 Mon Sep 17 00:00:00 2001 From: Tiyash Basu Date: Tue, 2 May 2023 11:37:30 +0530 Subject: [PATCH 1/2] Improve RELEASE_NOTES This commit restructures the RELEASE_NOTES, placing release items under appropriate headings (upgrades, new features, etc.), improving the formatting of the text, and adding a release summary. Signed-off-by: Tiyash Basu --- RELEASE_NOTES.md | 62 +++++++++++++++++++++++++++--------------------- 1 file changed, 35 insertions(+), 27 deletions(-) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index c96b9cd..cbb64a0 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -2,41 +2,65 @@ ## Summary - +This release introduces a few breaking changes to the API. The changes consist +of renaming RPCs, removing deprecated code, and introducing new features. +Please refer to the following sections for details. ## Upgrading - +* [Renamed RPCs](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/43) + + The following RPC has been renamed to make their objectives clearer: + * `GetMetadata` -> `GetMicrogridMetadata` + * `GetComponentData` -> `StreamComponentData` + +* [Removed deprecated code](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/44) + + The following deprecated code has been removed: + * The `COMPONENT_CATEGORY_LOAD` variant from the `ComponentCategory` enum. + * The `COMPONENT_CATEGORY_JUNCTION` variant from the `ComponentCategory` enum. + * The RPCs `Charge` and `Discharge`, in favour of RPC `SetPowerActive`. + * The RPC `SetBounds`, in favour of RPCs `AddExclusiveBounds` and + `AddInclusiveBounds`. + + This removal also includes code that has been deprecated after the last major + release. The reason to remove these deprecations now is to have a leaner API + earlier, since we are already on the way for a major release now. ## New Features -* [Added new RPC to return the microgrid metadata](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/30). +* [Added new RPC to return the microgrid metadata](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/30) + The microgrid metadata consists of information about the overall microgrid, as opposed to its components, e.g., the microgrid ID, location, etc. This change adds a new RPC `GetMicrogridMetadata()` that allows users to fetch microgrid metadata. The returned value is an instance of the message `MicrogridMetadata`. - Further changes were introduced to this addition in [this PR](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/43). + Further changes were introduced to this addition in PR [#43](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/43). + +* [Added enum variants for setting bounds on currents](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/33) -* [Added enum variants for setting bounds on currents](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/33). This will allow clients to set bounds on a components 1. DC electrical current, 2. total AC electrical current, 3. per-phase AC electrical currents. -* [Add RPC to set active power using a signed integer](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/35). +* [Add RPC to set active power using a signed integer](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/35) + While reading power values, the passive sign convention is followed (-ve for production, and +ve for consumption). This new method allows setting active power values in the same convention, making the API more consistent. -* [Introduced component category-specific metadata](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/36). +* [Introduced component category-specific metadata](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/36) + This metadata is returned in response to `ListComponents` calls, in a new message variable `Component.metadata`. This is a more general way of representing category-specific metadata, like category-type, and removes `Component.type`. -* [Introduced grid max-current](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/38). +* [Introduced grid max-current](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/38) + This change introduces a `grid.Metadata` message, which contains the item `rated_fuse_current`. This is the rating of the fuse at the grid connection point. @@ -45,7 +69,8 @@ The current _i_ A at the grid connection point must comply with the following constraint: : `-rated_fuse_current <= i <= rated_fuse_current` -* [Introduced exclusion bounds](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/39). +* [Introduced exclusion bounds](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/39) + In the messages `common.Metric` and `common.MetricAggregation`, `system_bounds` has now been replaced by `system_exclusion_bounds` and `system_inclusion_bounds`. A metric's `value` now has to comply with the @@ -87,23 +112,6 @@ The RPC `SetBounds` has been deprecated. -* [Renamed RPCs](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/43). - The following RPC has been renamed to make their objectives clearer: - * `GetMetadata` -> `GetMicrogridMetadata` - * `GetComponentData` -> `StreamComponentData` - -* [Removed deprecated code](https://github.com/frequenz-floss/frequenz-api-microgrid/pull/44) - The following deprecated code has been removed: - * The `COMPONENT_CATEGORY_LOAD` variant from the `ComponentCategory` enum. - * The `COMPONENT_CATEGORY_JUNCTION` variant from the `ComponentCategory` enum. - * The RPCs `Charge` and `Discharge`, in favour of RPC `SetPowerActive`. - * The RPC `SetBounds`, in favour of RPCs `AddExclusiveBounds` and - `AddInclusiveBounds`. - - This removal also includes code that has been deprecated after the last major - release. The reason to remove these deprecations now is to have a leaner API - earlier, since we are already on the way for a major release now. - ## Bug Fixes - +None From 337778e0b2b97d9b00083c1b4997f9412328a432 Mon Sep 17 00:00:00 2001 From: Tiyash Basu Date: Tue, 2 May 2023 11:39:23 +0530 Subject: [PATCH 2/2] Fix hyperlink in README.md This commit fixes the broken hyperlink to the contribution docs in the README.md file. Signed-off-by: Tiyash Basu --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5130829..1e26b90 100644 --- a/README.md +++ b/README.md @@ -13,4 +13,4 @@ Contributing If you want to know how to build this project and contribute to it, please check out the [Contributing -Guide](https://github.com/frequenz-floss/frequenz-api-microgrid/CONTRIBUTING.md). +Guide](https://github.com/frequenz-floss/frequenz-api-microgrid/blob/v0.x.x/CONTRIBUTING.md).