Skip to content

Releases: frequenz-floss/frequenz-api-common

v0.6.2

10 Sep 12:28
@github-actions github-actions
v0.6.2
This tag was signed with the committer’s verified signature.
llucax Leandro Lucarella
GPG key ID: F75C5E5CA8EB7FE7
Learn about vigilant mode.
ebe12dd
This commit was created on github.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.6.2 Latest
Latest

Frequenz Common API Release Notes

Bug Fixes

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

What's Changed

Full Changelog: v0.6.1...v0.6.2

Contributors

llucax
Assets 4
Loading

v0.6.1

08 May 15:38
@github-actions github-actions
v0.6.1
This tag was signed with the committer’s verified signature.
tiyash-basu-frequenz Tiyash Basu
GPG key ID: ADFEA3C3939D94E1
Learn about vigilant mode.
b354ac4
This commit was created on github.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.6.1

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

Full Changelog: v0.6.0...v0.6.1

Contributors

llucax, dependabot, and tiyash-basu-frequenz
Assets 4
Loading

v0.6.0

25 Mar 12:53
@github-actions github-actions
v0.6.0
This tag was signed with the committer’s verified signature.
tiyash-basu-frequenz Tiyash Basu
GPG key ID: ADFEA3C3939D94E1
Learn about vigilant mode.
08538ce
This commit was created on github.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.6.0

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

New Contributors

Full Changelog: v0.5.5...v0.6.0

Contributors

Marenz, llucax, and 2 other contributors
Assets 4
Loading

v0.5.5

19 Feb 10:20
@github-actions github-actions
v0.5.5
This tag was signed with the committer’s verified signature.
tiyash-basu-frequenz Tiyash Basu
GPG key ID: ADFEA3C3939D94E1
Learn about vigilant mode.
755bd43
This commit was created on github.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.5.5

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

Full Changelog: v0.5.4...v0.5.5

Contributors

llucax, dependabot, and tiyash-basu-frequenz
Assets 4
Loading

v0.5.4

31 Jan 15:03
@github-actions github-actions
v0.5.4
This tag was signed with the committer’s verified signature.
llucax Leandro Lucarella
GPG key ID: F75C5E5CA8EB7FE7
Learn about vigilant mode.
7f4ea48
This commit was created on github.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.5.4

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

New Contributors

Full Changelog: v0.5.2...v0.5.4

Contributors

llucax, dependabot, and matthias-wende-frequenz
Assets 4
Loading

v0.5.3

28 Dec 09:32
@github-actions github-actions
v0.5.3
This tag was signed with the committer’s verified signature.
matthias-wende-frequenz Matthias Wende
GPG key ID: 6A05AD41F76BE154
Learn about vigilant mode.
6800adb
This commit was signed with the committer’s verified signature.
matthias-wende-frequenz Matthias Wende
GPG key ID: 6A05AD41F76BE154
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.5.3

Frequenz Common API Release Notes

New Features

  • Add a energy message for electricity trading markets

What's Changed

Full Changelog: v0.5.2...v0.5.3

Contributors

matthias-wende-frequenz
Assets 4
Loading

v0.5.2

19 Dec 13:26
@github-actions github-actions
v0.5.2
This tag was signed with the committer’s verified signature.
tiyash-basu-frequenz Tiyash Basu
GPG key ID: ADFEA3C3939D94E1
Learn about vigilant mode.
fa774d9
This commit was created on github.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.5.2

Frequenz Common API Release Notes

Summary

This release adds new features, and fixes the documentation of a few messages.

Upgrading

  • This release does not contain breaking changes in terms of protobuf definitions.
    However, when upgrading, applications may need to be adjusted to work with the new additions.

New Features

  • Adds ability to specify static bounds in the Component message.

  • Adds protobuf definition necessary for Electricity Trading (and for Ancillary Services Market).

Bug Fixes

  • Fixes SensorData and ComponentData doc examples to correctly reflect differences in respective values.

What's Changed

New Contributors

Full Changelog: v0.5.1...v0.5.2

Contributors

thea-leake, dependabot, and 3 other contributors
Assets 4
Loading

v0.5.1

22 Nov 11:30
@github-actions github-actions
v0.5.1
This tag was signed with the committer’s verified signature.
stefan-brus-frequenz
SSH Key Fingerprint: 4D24sUzAnH7lEsGG7UryZAI7d7LKsfsjJ+l63Df2CLE Learn about vigilant mode.
4abef2e
This commit was created on github.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.5.1

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.
Assets 4
Loading

v0.5.0

10 Nov 13:29
@github-actions github-actions
v0.5.0
This tag was signed with the committer’s verified signature.
tiyash-basu-frequenz Tiyash Basu
GPG key ID: ADFEA3C3939D94E1
Learn about vigilant mode.
2ab871a
This commit was created on github.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.5.0

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

New Contributors

Full Changelog: v0.4.0...v0.5.0

Contributors

dependabot, tiyash-basu-frequenz, and TalweSingh
Assets 4
Loading

v0.4.0

28 Sep 14:21
@github-actions github-actions
v0.4.0
This tag was signed with the committer’s verified signature.
tiyash-basu-frequenz Tiyash Basu
GPG key ID: ADFEA3C3939D94E1
Learn about vigilant mode.
83e96a9
This commit was created on github.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.4.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

Full Changelog: v0.3.1...v0.4.0

Contributors

llucax, dependabot, and tiyash-basu-frequenz
Assets 4
Loading