Skip to content

Commit 5f897be

Browse files
Add message representing electrical connections between components
This commit adds a new message `ComponentConnection` to represent electrical connections between two components installed in a microgrid. The message is not about data flow but rather about the physical electrical connections between components. Therefore, the IDs for the source and destination components correspond to the actual setup within the microgrid. Signed-off-by: Tiyash Basu <[email protected]>
1 parent 43a9c4f commit 5f897be

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

RELEASE_NOTES.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@
5050
- Added a message `ComponentCategoryMetadataVariant` to represent the different
5151
types of sub-categories that can be associated with a component category.
5252

53+
- Added a message `ComponentConnection` to represent electrical connection
54+
between two components installed in a microgrid.
55+
5356
## New Features
5457

5558
<!-- Here goes the main new features and examples or instructions on how to use them -->

proto/frequenz/api/common/v1/components.proto

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,43 @@ message Component {
143143
frequenz.api.common.v1.lifetime.Lifetime operational_lifetime = 9;
144144
}
145145

146+
// ComponentConnection describes a single electrical link between two components
147+
// within a microgrid, effectively representing the physical wiring as viewed
148+
// from the grid connection point, if one exists, or from the islanding point,
149+
// in case of an islanded microgrids.
150+
//
151+
// !!! note "Physical Representation"
152+
// This message is not about data flow but rather about the physical
153+
// electrical connections between components. Therefore, the IDs for the
154+
// source and destination components correspond to the actual setup within
155+
// the microgrid.
156+
//
157+
// !!! note "Direction"
158+
// The direction of the connection follows the flow of current away from the
159+
// grid connection point, or in case of islands, away from the islanding
160+
// point. This direction is aligned with positive current according to the
161+
// [Passive Sign Convention]
162+
// (https://en.wikipedia.org/wiki/Passive_sign_convention).
163+
//
164+
// !!! info "Historical Data"
165+
// The timestamps of when a connection was created and terminated allows for
166+
// tracking the changes over time to a microgrid, providing insights into
167+
// when and how the microgrid infrastructure has been modified.
168+
//
169+
message ComponentConnection {
170+
// Unique identifier of the component where the connection originates. This is
171+
// aligned with the direction of current flow away from the grid connection
172+
// point, or in case of islands, away from the islanding point.
173+
uint64 source_component_id = 1;
174+
175+
// Unique ID of the component where the connection terminates. This is the
176+
// component towards which the current flows.
177+
uint64 destination_component_id = 2;
178+
179+
// The operational lifetime of the connection.
180+
frequenz.api.common.v1.lifetime.Lifetime operational_lifetime = 3;
181+
}
182+
146183
// ComponentData message aggregates multiple metrics, operational states, and
147184
// errors, related to a specific microgrid component.
148185
//

0 commit comments

Comments
 (0)