Skip to content

Releases: frequenz-floss/frequenz-api-common

v0.5.4

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

Choose a tag to compare

View all tags
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
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
Verified
Learn about vigilant mode.
6800adb
This commit was signed with the committer’s verified signature.
matthias-wende-frequenz Matthias Wende
GPG key ID: 6A05AD41F76BE154
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
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
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
Verified
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
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
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
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
Verified
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
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
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.
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
Verified
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
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
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
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
Verified
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
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
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
Loading

v0.3.1

08 Aug 14:34
@github-actions github-actions
v0.3.1
This tag was signed with the committer’s verified signature. The key has expired.
llucax Leandro Lucarella
GPG key ID: F75C5E5CA8EB7FE7
Expired
Verified
Learn about vigilant mode.
8600e96
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
v0.3.1

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

New Contributors

Full Changelog: v0.3.0...v0.3.1

Contributors

llucax, dependabot, and tiyash-basu-frequenz
Loading

v0.3.0

06 Jun 09:35
@github-actions github-actions
v0.3.0
This tag was signed with the committer’s verified signature.
tiyash-basu-frequenz Tiyash Basu
GPG key ID: ADFEA3C3939D94E1
Verified
Learn about vigilant mode.
340100b
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
v0.3.0

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:

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

  • EVChargerType enum refactored

    The enum with the oder variants was compiled into the following rust enum
    (by prost):

    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:

    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

Bug Fixes

None

What's Changed

New Contributors

Full Changelog: v0.2.0...v0.3.0

Contributors

dependabot, tiyash-basu-frequenz, and leandro-lucarella-frequenz
Loading
0 Join discussion

v0.2.0

23 May 11:40
@github-actions github-actions
v0.2.0
This tag was signed with the committer’s verified signature.
stefan-brus-frequenz
SSH Key Fingerprint: 4D24sUzAnH7lEsGG7UryZAI7d7LKsfsjJ+l63Df2CLE
Verified
Learn about vigilant mode.
5b3c5e5
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
v0.2.0

Frequenz Common API Release Notes

Summary

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

What's Changed

New Contributors

Full Changelog: v0.1.0...v0.2.0

Contributors

dependabot, stefan-brus-frequenz, and leandro-lucarella-frequenz
Loading
0 Join discussion

v0.1.0

17 May 08:49
@github-actions github-actions
v0.1.0
This tag was signed with the committer’s verified signature.
stefan-brus-frequenz
SSH Key Fingerprint: 4D24sUzAnH7lEsGG7UryZAI7d7LKsfsjJ+l63Df2CLE
Verified
Learn about vigilant mode.
12ccbe6
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Verified
Learn about vigilant mode.

Choose a tag to compare

View all tags
v0.1.0

Frequenz Common API Release Notes

Summary

This is the first release, including packages for common metrics types, electrical metrics and components.

What's Changed

New Contributors

Full Changelog: https://github.com/frequenz-floss/frequenz-api-common/commits/v0.1.0

Contributors

stefan-brus-frequenz and leandro-lucarella-frequenz
Loading
0 Join discussion