Skip to content

Commit 07c70e4

Browse files
committed
feat(gridpool): add gridpool definition to v1alpha8
Introduce Gridpool message with id and name fields. A gridpool represents an assigned group of microgrids for the purpose of energy trading. Signed-off-by: Richard Sandoval <[email protected]>
1 parent 2ea5e6d commit 07c70e4

File tree

4 files changed

+29
-31
lines changed

4 files changed

+29
-31
lines changed

RELEASE_NOTES.md

Lines changed: 2 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,34 +2,6 @@
22

33
## Summary
44

5-
This release introduces the new `v1alpha8` version of the API, which includes several breaking changes compared to `v1alpha7`. The changes focus on improving consistency and clarity by renaming several symbols and removing unused components.
5+
## Features
66

7-
## Upgrading
8-
9-
- A new package `frequenz.api.common.v1alpha8` has been introduced, containing the following breaking changes from `v1alpha7`.
10-
11-
- Removed:
12-
13-
+ `electrical_components.Fuse`
14-
+ `InverterType.INVERTER_TYPE_WIND_TURBINE`
15-
16-
- Renamed several symbols to increase consistency and clarity:
17-
18-
+ `microgrid`:
19-
20-
* `MicrogridComponentIds` to `MicrogridElectricalComponentIds`
21-
* `MicrogridComponentIDs.component_ids` to `MicrogridElectricalComponentIds.electrical_component_ids`
22-
23-
+ `electrical_components`:
24-
25-
* `ElectricalComponentConnections.source_component_id` to `ElectricalComponentConnections.source_electrical_component_id`
26-
* `ElectricalComponentConnections.destination_component_id` to `ElectricalComponentConnections.destination_electrical_component_id`
27-
* `ElectricalComponentStateSnapshot.component_id` to `ElectricalComponentStateSnapshot.electrical_component_id`
28-
* Transformer-related terms are renamed to align them with power transformers, which are more commonly used in electrical engineering:
29-
* `electrical_components.VoltageTransformer` to `electrical_components.PowerTransformer`
30-
* `ElectricalComponentCategorySpecificInfo.kind.voltage_transformer` to `ElectricalComponentCategorySpecificInfo.kind.power_transformer`
31-
* `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_VOLTAGE_TRANSFORMER` to `ElectricalComponentCategory.ELECTRICAL_COMPONENT_CATEGORY_POWER_TRANSFORMER`
32-
33-
+ `types`:
34-
35-
* The whole package has been renamed to `types` to avoid using reserved keywords in programming languages.
7+
- Add `gridpool.Gridpool` message type to `v1alpha8`, defining a gridpool as an assigned group of microgrids for the purpose of energy trading.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// protolint:disable MAX_LINE_LENGTH
2+
// Frequenz gridpool definition.
3+
//
4+
// Copyright 2025 Frequenz Energy-as-a-Service GmbH
5+
//
6+
// Licensed under the MIT License (the "License");
7+
// you may not use this file except in compliance with the License.
8+
9+
syntax = "proto3";
10+
11+
package frequenz.api.common.v1alpha8.gridpool;
12+
13+
14+
// Gridpool contains details of a specific gridpool.
15+
// A gridpool is an assigned group of microgrids for the purpose of energy trading.
16+
message Gridpool {
17+
// A unique identifier for the gridpool.
18+
uint64 id = 1;
19+
20+
// The name of the gridpool.
21+
string name = 2;
22+
}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# License: MIT
22
# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
33

4-
"""Frequenz common gRPC API and bindings for v1alpha7."""
4+
"""Frequenz common gRPC API and bindings for v1alpha8."""
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# License: MIT
2+
# Copyright © 2025 Frequenz Energy-as-a-Service GmbH
3+
4+
"""Gridpool bindings for Frequenz common gRPC API."""

0 commit comments

Comments
 (0)