Skip to content

v0.16.0
Compare
Choose a tag to compare
@github-actions github-actions released this 22 Nov 15:44
· 118 commits to v0.x.x since this release
v0.16.0
This tag was signed with the committer’s verified signature.
tiyash-basu-frequenz Tiyash Basu
GPG key ID: ADFEA3C3939D94E1
Learn about vigilant mode.
30d75b3
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.

Frequenz Microgrid API Release Notes

Summary

This version of the API introduces a number of breaking changes, and is not
backwards compatible with the previous version. The changes primarily include:

  • RPC renames
  • Upgrade to frequenz.api.common v0.5.0

Upgrading

  • The CanStreamData RPC has been removed. Users are recommended to check it
    by calling the StreamComponentData RPC.

  • The message microgrid.Location has been removed, and
    frequenz.api.common.location.Location is being used instead. The Location
    message from the common API also has a country_code member.

  • The following gRPC methods have been renamed:
    StreamComponentData -> ReceiveComponentDataStream
    AddExclusionBounds -> AddComponentExclusionBounds
    AddInclusionBounds -> AddComponentInclusionBounds
    SetPowerActive -> SetComponentPowerActive
    SetPowerReactive -> SetComponentPowerReactive
    Start -> StartComponent
    HotStandby -> HotStandbyComponent
    ColdStandby -> PutComponentInStandby
    Stop -> StopComponent
    ErrorAck -> AckComponentError

  • The following gRPC method have been removed: HotStandby

  • Introduced a dedicated RPC method for listing sensors in the microgrid,
    separating them from the "component" category.

  • The RPC parameters have been renamed to be more consistent with the RPC names,
    and with each other.

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

  • The common protobuf dependency has been upgraded to v0.5.0. The protobuf
    messages returned by the RPCs are now in the frequenz.api.common.v1 package.
    As a result, all files besides microgrid.proto became obsolete, and
    therefore, have been removed.

  • The request messages for receiving data streams have now been extended to
    consist of a list of metrics to be streamed. This allows the user to request
    only the metrics they are interested in, instead of receiving all of them.
    If this list is empty, then no data will be streamed, and the service will
    return an error.

  • The RPC SetComponentPowerActivenow returns a timestamp until which the
    command will stay in effect. The component's active power will be set to 0
    after this timestamp, if the API receives no further requests to change it
    before then. By default, this timestamp will be the current time plus 60
    seconds.

  • The RPC SetComponentPowerReactivenow returns a timestamp until which the
    command will stay in effect. The component's reactive power will be set to 0
    after this timestamp, if the API receives no further requests to change it
    before then. By default, this timestamp will be the current time plus 60
    seconds.

What's Changed

New Contributors

Full Changelog: v0.15.2...v0.16.0

Contributors

llucax, dependabot, and 2 other contributors
Assets 4
Loading