v0.10.0

Frequenz Dispatch API Release Notes

Summary

This release is mainly about creating a ruleset for recurring dispatches.

Upgrading

• As part of introducing versioning, the protobuf definitions and generated python code now has the path frequenz.dispatch.v1.

New Features

• Package-based versioning has been introduced.

• Rules for recurring dispatches have been added.
  Examples:
  Every 6 months:

  message RecurrenceRule {
    Frequency freq = FREQUENCY_MONTHLY;
    uint32 interval = 6;
  }
  

  Weekends only:

  message RecurrenceRule {
    Frequency freq = FREQUENCY_WEEKLY;
    repeated Weekday byweekdays = [WEEKDAY_SATURDAY, WEEKDAY_SUNDAY];
  }
  

  Every day at midnight:

  message RecurrenceRule {
    Frequency freq = FREQUENCY_DAILY;
    repeated uint32 byhours = [0];
  }
  

  Nightly, assuming "night" means from 8 PM to 6 AM:

  message RecurrenceRule {
    Frequency freq = FREQUENCY_DAILY;
    repeated uint32 byhours = [20, 21, 22, 23, 0, 1, 2, 3, 4, 5];
  }
  

Bug Fixes

What's Changed

• Add update_time field to Dispatch message by @stefan-brus-frequenz in #23
• Re-design dispatch filter message by @stefan-brus-frequenz in #28
• Remove ability to update existing microgrid ID by @stefan-brus-frequenz in #29
• Add rules for recurring dispatches by @stefan-brus-frequenz in #57

Full Changelog: v0.9.0...v0.10.0

v0.9.0

Release notes

• The FcrPrequalificationSettings message has been removed, and settings
  fields have been modified/reverted to use protobuf Structs, in order to
  represent arbitrary JSON objects.

What's Changed

• Add FCR prequalification cancellation event type by @christianparpart in #17
• Rename fcr_prequal_settings to fcr_prequalification by @christianparpart in #16
• Change settings to payload and use google protobuf Struct by @stefan-brus-frequenz in #19

Full Changelog: v0.8.2...v0.9.0

v0.8.2

Release notes

• Added python module & test case for submodule fcr.

What's Changed

• Fix Python module being broken by @christianparpart in #10

New Contributors

• @christianparpart made their first contribution in #10

Full Changelog: v0.8.1...v0.8.2

v0.8.1

Release notes

• Removed unused import that broke protoc compilations.

What's Changed

• Remove unused import by @stefan-brus-frequenz in #7

Full Changelog: v0.8.0...v0.8.1

v0.8.0

Release notes

• Initial open source release

What's Changed

• Add snapshot of private api-dispatch-spec repository by @stefan-brus-frequenz in #2
• Add final pieces for open sourcing this project by @stefan-brus-frequenz in #3
• Add create release & publish to pypi actions by @stefan-brus-frequenz in #4
• Add gen-docs job to github workflows by @stefan-brus-frequenz in #5

New Contributors

• @stefan-brus-frequenz made their first contribution in #2

Full Changelog: https://github.com/frequenz-floss/frequenz-api-dispatch/commits/v0.8.0