Frequenz-api-common

Frequenz Common API Release Notes

Update of the `PaginationParams` struct.

Upgrading

- `PaginationParams` has been changed so that the `page_size` and `page_token`
fields are now mutually exclusive.

- A new component category `COMPONENT_CATEGORY_HVAC` has been added to the API
to represent HVAC (Heating, Ventilation, and Air Conditioning) systems.

- Additional information for energy metric

- Generalize Energy message documentation for broader market use

- Add Power message to represent Power in MW

Bug Fixes

- Fix a dependency issue by pinning the `grpcio` version and related libraries.
- Fixed a wrong documentation comment for `COMPONENT_CATEGORY_UNSPECIFIED`.


What's Changed
* Bump the required group with 3 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/227
* Be a bit more explicit about when some fields can be missing by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/228
* Bump brettcannon/check-for-changed-files from 1.2.0 to 1.2.1 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/229
* Bump the required group with 6 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/230
* Add energy metric information by flora-hofmann-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/235
* Change `PaginationParams` to make `page_size` and `page_token` mutually exclusive by Marenz in https://github.com/frequenz-floss/frequenz-api-common/pull/232
* Merge v0.6.2 into v0.x.x by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/243
* Bump the required group across 1 directory with 10 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/247
* Bump the `protobuf` and `grpcio` versions by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/251
* Fix documentation comment for `COMPONENT_CATEGORY_UNSPECIFIED` by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/245
* Bump yoheimuta/action-protolint from 1.1.0 to 1.3.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/196
* Move `conftest.py` to the python package root by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/252
* Improve the `Lifetime` message documentation by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/259
* Bump the required group with 3 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/265
* Add `Power` message and make `Energy` message broader by camille-bouvy-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/267

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

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

Frequenz Common API Release Notes

Bug Fixes

- Fix a dependency issue by pinning the `grpcio` version and related libraries.


What's Changed
* Pin grpc related dependencies by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/241


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

Frequenz Common API Release Notes

Summary

This release adds a new component category `COMPONENT_CATEGORY_HVAC` to the API.

New Features

- A new component category `COMPONENT_CATEGORY_HVAC` has been added to the API
to represent HVAC (Heating, Ventilation, and Air Conditioning) systems.


What's Changed
* Update protobuf requirement from <5,>=4.25.3 to >=4.25.3,<6 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/205
* Bump the optional group with 2 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/211
* Bump the optional group with 1 update by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/214
* Bump the optional group with 2 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/216
* Bump black from 24.3.0 to 24.4.0 in the required group by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/219
* Bump the required group with 2 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/220
* Bump the required group with 5 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/222
* Make Dependabot check for updates monthly on Thursdays by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/223
* Bump the required group with 4 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/224
* Add new component category HVAC by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/225
* Clean up release notes to prepare for release v0.6.1 by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/226


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

Frequenz Common API Release Notes

Summary

- Removed dependency on `googleapis-common-protos` in favor of internal `frequenz.api.common.v1.types.Decimal`, advising updates to dependencies for users previously relying on Google's types.
- Renamed voltage and current metrics for clarity and introduced new metrics, including line-to-line voltages and Total Harmonic Distortion (THD) metrics, with updated naming conventions for simplicity and precision.

Upgrading

- The dependency on `googleapis-common-protos` / `googleapis/googleapis` was removed, now the built-in `frequenz.api.common.v1.types.Decimal` is used internally instead. This is compatible with Google's type, but if you depended indirectly on Google's submodule or python packages, you may need to update your dependencies.

Nevertheless it is strongly recommended to remove the dependency on Google repos and use the built-in `frequenz.api.common.v1.types.Decimal` instead if your project only uses the `Decimal` type from it too.

- Voltage metrics have been renamed from `METRIC_VOLTAGE_PHASE_[1|2|3]` to `METRIC_VOLTAGE_PHASE_[1|2|3]_N`.

- The variants in the enum `Metric` have been renumberd due to the addition of line-to-line voltages.

- Current metrics have been renamed:
`METRIC_AC_APPARENT_CURRENT` -> `METRIC_AC_CURRENT`
`METRIC_AC_APPARENT_CURRENT_PHASE_[1|2|3]` -> `METRIC_AC_CURRENT_PHASE_[1|2|3]`

- Metrics for Total Harmonic Distortion have been un-abbreviated:
`METRIC_AC_THD_CURRENT` -> `METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT`
`METRIC_AC_THD_CURRENT_PHASE_[1|2|3]` -> `METRIC_AC_TOTAL_HARMONIC_DISTORTION_CURRENT_PHASE_[1|2|3]`

- Renamed `SimpleMetricSample` to `SimpleMetricValue`, because it does not contain a timestamp, so it does not represent a sample but a value.

- Renamed `AggregatedMetricSample` to `AggregatedMetricValue`, because it does not contain a timestamp, so it does not represent a sample but a value.

- Renamed `MetricSampleVariant` to `MetricValueVariant`.

- Rename `MetricSample.sample` to `MetricSample.value`.

- Rename `SensorMetricSample.sample` to `SensorMetricSample.value`.

New Features

- Added a `Frequenz.api.common.v1.types.Decimal` type, compatible with `google.type.Decimal`.

- The following new metrics have been added:
- `METRIC_VOLTAGE_PHASE_1_PHASE_2`
- `METRIC_VOLTAGE_PHASE_2_PHASE_3`
- `METRIC_VOLTAGE_PHASE_3_PHASE_1`


What's Changed
* Clear release notes by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/192
* Remove dependency on `googleapis` by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/187
* Bump the optional group with 3 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/194
* Bump actions/labeler from 4.3.0 to 5.0.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/145
* Update to repo-conf 0.9.0 by Marenz in https://github.com/frequenz-floss/frequenz-api-common/pull/195
* Bump the optional group with 4 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/199
* Bump pytest from 7.4.4 to 8.1.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/202
* Bump nox from 2023.4.22 to 2024.3.2 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/201
* Bump the optional group with 2 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/200
* Bump the optional group with 3 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/203
* Add line-to-line voltage metrics by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/206
* Remove `APPARENT_` from current metric names by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/208
* Unabbreviate `THD` in the Metric enum by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/209
* Rename `[Simple|Aggregated]MetricSample` to `[Simple|Aggregated]MetricValue` by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/210
* Cleanup release notes for release v0.6.0 by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/212

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

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

Frequenz Common API Release Notes

Summary

This release contains minor updates to the API, including new metric variants,
and a new field in `MetricSample` to identify the source of the metric.

New Features

- Added a field named `source` to `MetricSample` to allow the user to identify
the source of the metric, in case different sensors in component report
metrics with the same `Metric` variant.

- Added 3 new metric variants for inverter temperatures:
- `METRIC_INVERTER_TEMPERATURE_CABINET`
- `METRIC_INVERTER_TEMPERATURE_HEATSINK`
- `METRIC_INVERTER_TEMPERATURE_TRANSFORMER`


What's Changed
* Clear release notes by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/180
* Bump submodules/api-common-protos from `86f7539` to `738ff24` by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/182
* Add field `source` to `MetricSample` by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/181
* Add metrics variants for inverter temperatures by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/188
* Update release notes for v0.5.5 release by tiyash-basu-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/191


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

Frequenz Common API Release Notes

New Features

- Add a energy message for electricity trading markets
- Add backwards compatibility with v0.3.x

This release includes the top-level files present in the v0.3.x release, so the Microgrid API v0.15.x can depend on a newer version of the Common API.


What's Changed
* Add Energy message for electricity trading markets by matthias-wende-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/161
* Prepare release notes for release by matthias-wende-frequenz in https://github.com/frequenz-floss/frequenz-api-common/pull/162
* Bump the optional group with 9 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/164
* Bump submodules/api-common-protos from `51555da` to `f6b54cd` by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/166
* Bump submodules/api-common-protos from `f6b54cd` to `86f7539` by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/168
* Bump the optional group with 2 updates by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/169
* Bump flake8 from 6.1.0 to 7.0.0 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/170
* Bump grpc-stubs from 1.53.0.3 to 1.53.0.5 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/171
* Add backwards compatibility with v0.3.x by llucax in https://github.com/frequenz-floss/frequenz-api-common/pull/179
* Bump black from 23.12.1 to 24.1.1 by dependabot in https://github.com/frequenz-floss/frequenz-api-common/pull/176

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

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