Skip to content

Commit 38e5749

Browse files
committed
Reset release notes
Signed-off-by: Mathias L. Baumann <[email protected]>
1 parent 11486b4 commit 38e5749

File tree

1 file changed

+3
-23
lines changed

1 file changed

+3
-23
lines changed

RELEASE_NOTES.md

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,15 @@
22

33
## Summary
44

5-
While the new TargetCategory class supports subtypes, only reading them is currently available; setting subtypes will be introduced in a future release.
5+
<!-- Here goes a general summary of what this release is about -->
66

77
## Upgrading
88

9-
* `TargetComponents` was reworked. It now is a type alias for `TargetIds | TargetCategories`:
10-
* `TargetIds` can be used to specify one or more specific target IDs:
11-
* `TargetIds(1, 2, 3)` or
12-
* `TargetIds(ComponentIds(1), ComponentIds(2), ComponentIds(3))`
13-
* `TargetCategories` can be used to specify one or more target categories:
14-
* `TargetCategories(ComponentCategory.BATTERY, ComponentCategory.INVERTER)`
15-
* Dispatch ids and microgrid ids are no longer simple `int` types but are now wrapped in `DispatchId` and `MicrogridId` classes, respectively. This allows for better type safety and clarity in the codebase.
9+
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
1610

1711
## New Features
1812

19-
* With the new `TargetCategory` class (providing `.category` and `.type`) we can now specify subtypes of the categories:
20-
* `ComponentCategory.BATTERY` uses `BatteryType` with possible values: `LI_ION`, `NA_ION`
21-
* `ComponentCategory.INVERTER` uses `InverterType` with possible values: `BATTERY`, `SOLAR`, `HYBRID`
22-
* `ComponentCategory.EV_CHARGER` uses `EvChargerType`: with possible values `AC`, `DC`, `HYBRID`
23-
* A few examples on how to use the new `TargetCategory`:
24-
* `TargetCategory(BatteryType.LI_ION)`
25-
* `category` is `ComponentCategory.BATTERY`
26-
* `type` is `BatteryType.LI_ION`
27-
* `TargetCategory(ComponentCategory.BATTERY)`
28-
* `category` is `ComponentCategory.BATTERY`
29-
* `type` is `None`
30-
* `TargetCategories(InverterType.SOLAR)`
31-
* `category` is `ComponentCategory.INVERTER`
32-
* `type` is `InverterType.SOLAR`
33-
13+
<!-- Here goes the main new features and examples or instructions on how to use them -->
3414

3515
## Bug Fixes
3616

0 commit comments

Comments
 (0)