Frequenz-api-common

Frequenz Common API Release Notes

Summary

- Added `MicrogridComponentIDs` message, which groups a microgrid ID together with
a list of component IDs.

New Features

- Added `MicrogridComponentIDs` message, which groups a microgrid ID together with
a list of component IDs.

Frequenz Common API Release Notes

Summary

This release contains
* additions of data definitions to the common specs, that are intended to be used by the Frequenz APIs.
* refactors of existing definitions, in order to make them more consistent and easier to use.

Upgrading

- `lower` and `upper` bounds fields in the `Bounds` message are now `optional`

- `rated_bounds` field has been removed from the messages `Metric` and `MetricAggregation`

- `component_bounds` field has been removed from the messages `Metric` and `MetricAggregation`

- Inclusion and exclusion bounds have been removed from the metric definitions. These have been replaced with an array of inclusion bounds. This simplifies the message definition, and removes the requirement of clients having to check if a parameter is _not_ in a given pair of bounds. This also extends the possibility of having more than 2 pairs bounds for a given metric.

- Fields in `MetricAggregation` message have been suffixed with `_value`, to make them consistent with the `Metric` message.

- Timestamps have been introduced in the metric messages. This makes it easier to use these messages in a timeseries context.

- Renamed `Metric` message to `SimpleMetricSample`

- Renamed `MetricAggregation` message to `AggregatedMetricSample`

- Added a union type message `MetricSampleVariant` to represent both
`SimpleMetricSample` and `AggregatedMetricSample`

- Added a message `MetricSample` to represent a metric sample with a timestamp
and bounds.

- Added a message to represent metrics sampled from components.

- Added a message `SensorData` to represent metrics sampled from sensors.

- Added a message `Lifetime` as a wrapper over the start and end timestamps of an entity.

- Added a message `Sensor` to represent sensors installed in a microgrid.

- Added a message `Component` to represent components installed in a microgrid.

- Added a message `ComponentCategoryMetadataVariant` to represent the different types of sub-categories that can be associated with a component category.

- Added a message `ComponentConnection` to represent electrical connection between two components installed in a microgrid.

- Added a message `DeliveryArea` to represent a market contract delivery area.

- Added a message `Microgrid` to represent a microgrid.

- Updated the package name of `location.proto` to `frequenz.api.common.v1`.

- Added messages to support pagination in APIs.

- Removed `metrics/electrical.proto`, since it is no longer needed.


What's Changed
* Make lower and upper bounds optional in the Bounds message by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/104
* Bump mypy from 1.5.1 to 1.6.1 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/109
* Bump black from 23.9.1 to 23.10.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/110
* Bump mkdocs-material from 9.4.2 to 9.4.6 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/107
* Add a message 'Pagination' to define pagination parameters by TalweSingh in https://github.com/frequenz-floss/frequenz-api-common/pull/99
* Bump black from 23.10.0 to 23.10.1 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/116
* Bump pytest from 7.4.2 to 7.4.3 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/117
* Update the metrics package by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/114
* Bump repo config to v0.6.2 by TalweSingh in https://github.com/frequenz-floss/frequenz-api-common/pull/102
* Bump the optional group with 1 update by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/118
* Bump yoheimuta/action-protolint from 1.0.0 to 1.1.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/120
* Bump the optional group with 1 update by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/121
* Bump grpc-stubs from 1.53.0.2 to 1.53.0.3 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/119
* Update `metrics` and `component.data` packages by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/122
* Bump actions/checkout from 3 to 4 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/72
* Add messages to stream sensor data by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/125
* Move `ComponentData` message to `components.proto` by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/126
* Bump the optional group with 3 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/129
* Bump pylint from 2.17.6 to 3.0.2 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/115
* Add messages describing microgrid entities by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/127
* Refactor protobuf messages and files to establish a standard packaging scheme by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/131
* Remove unnecessary items and add a test by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/132
* Cleanup RELEASE_NOTES.md for release v0.5.0 by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/133

New Contributors
* TalweSingh made their first contribution in https://github.com/frequenz-floss/frequenz-api-common/pull/99

**Full Changelog**: https://github.com/frequenz-floss/frequenz-api-common/compare/v0.4.0...v0.5.0

Frequenz Common API Release Notes

Summary

Added versioning to the API, added new component category variants, and split
sensors out of components.

Upgrading

- The package names have been changed from `frequenz.api.common.<package>` to
`frequenz.api.common.v1.<package>`. `v1` is the API's major version, and will
be incremented for breaking changes.

- Added `frequenz.api.common.sensors` package, containing the enums
`SensorCategory` and `SensorType`. Removed the component category variant
`COMPONENT_CATEGORY_SENSOR` and the enum `SensorType` from
`frequenz.api.common.components`.

- The component category variant `PRECHARGE_MODULE` has been renamed to
`PRECHARGER`.

New Features

- Added a new component category variant: `COMPONENT_CATEGORY_FUSE`.

- Added a new component category variant:
`COMPONENT_CATEGORY_VOLTAGE_TRANSFORMER`.


What's Changed
* Clear release notes by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/55
* Bump mypy from 1.4.1 to 1.5.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/56
* Bump mypy from 1.5.0 to 1.5.1 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/57
* Upgrade to repo-config v0.5.2 by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/59
* Bump mkdocs-material from 9.1.21 to 9.2.1 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/63
* Bump mkdocs-material from 9.2.1 to 9.2.3 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/64
* Bump mkdocs-section-index from 0.3.5 to 0.3.6 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/74
* Bump mkdocstrings[python] from 0.22.0 to 0.23.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/68
* Bump pytest from 7.4.0 to 7.4.2 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/76
* Bump black from 23.7.0 to 23.9.1 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/77
* Bump mkdocs-literate-nav from 0.6.0 to 0.6.1 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/78
* Bump mkdocs-material from 9.2.3 to 9.3.1 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/79
* Bump mkdocs-section-index from 0.3.6 to 0.3.7 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/81
* Bump mkdocs-material from 9.3.1 to 9.3.2 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/84
* Bump mkdocs-section-index from 0.3.7 to 0.3.8 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/87
* Bump pylint from 2.17.5 to 2.17.6 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/89
* Bump mkdocs-material from 9.3.2 to 9.4.2 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/88
* Add versioning to common proto files by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/90
* Introduce new component categories by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/92
* Add new sensor category and metric enums by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/93
* Rename `PRECHARGE_MODULE` to `PRECHARGER` by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/91
* Clean up release notes for release v0.4.0 by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/94


**Full Changelog**: https://github.com/frequenz-floss/frequenz-api-common/compare/v0.3.1...v0.4.0

Frequenz Common API Release Notes

New Features

* Added a new message named `Location`, representing the co-ordinates of a
geographical location and the corresponding country-code.

* Added a new variant `COMPONENT_CATEGORY_RELAY` to the `ComponentCategory`
enum.

* Added a new variant `COMPONENT_CATEGORY_PRECHARGE_MODULE` to the
`ComponentCategory` enum.


What's Changed
* Bump pytest from 7.3.1 to 7.3.2 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/25
* Bump mypy from 1.3.0 to 1.4.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/26
* Bump pytest from 7.3.2 to 7.4.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/27
* Bump mypy from 1.4.0 to 1.4.1 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/28
* Bump actions/labeler from 4.1.0 to 4.2.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/29
* Upgrade to repo-config v0.3.0 by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/31
* Bump mkdocs-material from 9.1.16 to 9.1.18 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/33
* Replace protolint check with yoheimuta/action-protolint by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/32
* Bump black from 23.3.0 to 23.7.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/35
* Bump mkdocs-material from 9.1.18 to 9.1.19 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/38
* Bump pylint from 2.17.4 to 2.17.5 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/39
* Regenerate repository using repo-config v0.4.0 by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/37
* Bump mkdocs-material from 9.1.19 to 9.1.21 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/40
* Bump actions/labeler from 4.2.0 to 4.3.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/34
* Configure the protobuf include paths by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/41
* Update protobuf file headers by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/47
* Add a message `Location` to represent geo co-ordinates by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/48
* Add new component categories for relays and precharge modules by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/49
* Revert "Update protobuf file headers" by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/50
* Add country code to the Location message by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/53
* Remove empty section from the release notes by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/54

New Contributors
* llucax made their first contribution in https://github.com/frequenz-floss/frequenz-api-common/pull/31

**Full Changelog**: https://github.com/frequenz-floss/frequenz-api-common/compare/v0.3.0...v0.3.1

Frequenz Common API Release Notes

Summary

This release includes renaming the `EVChargerType` enum to `EvChargerType` and
the addition of the `MetricAggregation` message.

Upgrading

* The submodule URL was changed to use HTTPS instead of SSH (to avoid problems trying to unlock SSH keys to do updates, etc.).

Make sure you sync your submodules to the new URL:

console
$ git submodule sync
Synchronizing submodule url for 'submodules/api-common-protos'


* [`EVChargerType` enum refactored](https://github.com/frequenz-floss/frequenz-api-common/pull/21)

The enum with the oder variants was compiled into the following rust enum
(by prost):
rust
pub enum EvChargerType {
/// Default type.
EvchargerTypeUnspecified = 0,
/// The EV charging station supports AC charging only.
EvchargerTypeAc = 1,
/// The EV charging station supports DC charging only.
EvchargerTypeDc = 2,
/// The EV charging station supports both AC and DC.
EvchargerTypeHybrid = 3,
}

Here the enum variants were unnecessarily prefixed with `EvchargerType`.
This lead to accessing the enum variants in a very verbose manner, e.g.,
`EvChargerType::EvchargerTypeHybrid`.

The changed version of the enum in this commit results in the following
rust enum:
rust
pub enum EvChargerType {
/// Default type.
Unspecified = 0,
/// The EV charging station supports AC charging only.
Ac = 1,
/// The EV charging station supports DC charging only.
Dc = 2,
/// The EV charging station supports both AC and DC.
Hybrid = 3,
}

Here the unnecessary prefix `EvchargerType` is absent. This reduces the
verbosity while accessing the enum variants, making the resulting rust code
more readable, e.g., as `EvChargerType::Hybrid`.

This change also leads to renaming the enum from `EVChargerType` to
`EvChargerType`, to satisfy protolint requirements.
New Features

* [Added `MetricAggregation` message](https://github.com/frequenz-floss/frequenz-api-common/pull/22)

The message `MetricAggregation` has been [copied from frequenz-api-microgrid](https://github.com/frequenz-floss/frequenz-api-microgrid/blob/2b316db3d34565fa04445be62700176d07756750/proto/frequenz/api/microgrid/common.proto#L15-L99)
into this repository, so that it can be used by other APIs as well.

Bug Fixes

None


What's Changed
* Use HTTPS URL for the submodule by leandro-lucarella-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/17
* Bump actions/labeler from 4.0.3 to 4.0.4 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/18
* Bump frequenz-repo-config[api] from 0.1.0 to 0.2.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/19
* Bump actions/labeler from 4.0.4 to 4.1.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/20
* Refactor `EVChargerType` enum variants by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/21
* Add `MetricAggregation` message by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/22
* Prepare for release v0.3.0 by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/23

New Contributors
* tiyash-basu-frequenz made their first contribution in https://github.com/frequenz-floss/frequenz-api-common/pull/21

**Full Changelog**: https://github.com/frequenz-floss/frequenz-api-common/compare/v0.2.0...v0.3.0

Frequenz Common API Release Notes

Summary

- Various build system fixes
- Improved smoothness of using this as a dependency


What's Changed
* Pin build dependencies and add dependabot by leandro-lucarella-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/7
* Bump actions/labeler from 4.0.1 to 4.0.3 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/9
* Bump nox from 2022.11.21 to 2023.4.22 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/12
* Bump pylint from 2.17.1 to 2.17.4 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/13
* Bump pytest from 7.2.2 to 7.3.1 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/10
* Bump mypy from 1.1.1 to 1.3.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/11
* Remove erroneous "microgrid" references by stefan-brus-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/14
* Fix some more microgrid copy&paste errors by leandro-lucarella-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/15

New Contributors
* dependabot made their first contribution in https://github.com/frequenz-floss/frequenz-api-common/pull/9

**Full Changelog**: https://github.com/frequenz-floss/frequenz-api-common/compare/v0.1.0...v0.2.0