Skip to content

Commit

Permalink
Update release notes
Browse files Browse the repository at this point in the history
Signed-off-by: Stefan Brus <[email protected]>
  • Loading branch information
stefan-brus-frequenz committed Sep 8, 2023
1 parent c6a23da commit 0068258
Showing 1 changed file with 5 additions and 36 deletions.
41 changes: 5 additions & 36 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,17 @@

## Summary

This release is mainly about creating a ruleset for recurring dispatches.
This release is mainly about updating the names of some objects, and improving documentation.

## Upgrading

- As part of introducing versioning, the protobuf definitions and generated python code now has the path `frequenz.dispatch.v1`.
- Service and its methods have been renamed to `MicrogridDispatchService`
- `DispatchComponentSelector` has been renamed to `ComponentSelector`
- `DispatchComponentIDs` has been renamed to `ComponentIDs`

## 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];
}
```
- `DispatchFilter` now supports filtering by `is_active` and `is_dry_run`

## Bug Fixes

Expand Down

0 comments on commit 0068258

Please sign in to comment.