Skip to content

Commit 4d2b6f4

Browse files
Renamed ElectricalComponentState to ElectricalComponentStateSnapshot
The state message in this case is a snapshot of the state of the electrical component's composite sttae at a given time. The name `ElectricalComponentStateSnapshot` is more descriptive and accurately reflects the purpose of the message. Signed-off-by: Tiyash Basu <[email protected]> # Conflicts: # RELEASE_NOTES.md
1 parent 8b6eb2e commit 4d2b6f4

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

RELEASE_NOTES.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
- A new inverter type `INVERTER_TYPE_WIND_TURBINE` has been added to the `InverterType` enum.
3232
- Renamed `ComponentCategoryMetadataVariant` to `ElectricalComponentCategorySpecificInfo`.
3333
- Renamed field `ElectricalComponent.category_type` to `ElectricalComponent.category_specific_info` to better reflect its purpose.
34+
- Renamed `ElectricalComponentState` to `ElectricalComponentStateSnapshot` to better reflect its purpose.
3435

3536
## Bug Fixes
3637

proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -474,7 +474,7 @@ message ElectricalComponentDiagnostic {
474474
}
475475

476476
// Representation of a component state, warnings, and errors.
477-
message ElectricalComponentState {
477+
message ElectricalComponentStateSnapshot {
478478
// The time at which the state was sampled.
479479
google.protobuf.Timestamp sampled_at = 1;
480480

@@ -561,5 +561,5 @@ message ElectricalComponentData {
561561
repeated frequenz.api.common.v1.metrics.MetricSample metric_samples = 2;
562562

563563
// List of states of a specific microgrid component.
564-
repeated ElectricalComponentState states = 3;
564+
repeated ElectricalComponentStateSnapshot states = 3;
565565
}

0 commit comments

Comments
 (0)