From 4d2b6f40a69c2340a4ece6c68906f2562dcd4976 Mon Sep 17 00:00:00 2001 From: Tiyash Basu Date: Tue, 20 May 2025 18:07:35 +0200 Subject: [PATCH 1/2] 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 # Conflicts: # RELEASE_NOTES.md --- RELEASE_NOTES.md | 1 + .../electrical_components/electrical_components.proto | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index b070d132..7bb2fc02 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -31,6 +31,7 @@ - A new inverter type `INVERTER_TYPE_WIND_TURBINE` has been added to the `InverterType` enum. - Renamed `ComponentCategoryMetadataVariant` to `ElectricalComponentCategorySpecificInfo`. - Renamed field `ElectricalComponent.category_type` to `ElectricalComponent.category_specific_info` to better reflect its purpose. +- Renamed `ElectricalComponentState` to `ElectricalComponentStateSnapshot` to better reflect its purpose. ## Bug Fixes diff --git a/proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto b/proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto index 8a184376..a3086799 100644 --- a/proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto +++ b/proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto @@ -474,7 +474,7 @@ message ElectricalComponentDiagnostic { } // Representation of a component state, warnings, and errors. -message ElectricalComponentState { +message ElectricalComponentStateSnapshot { // The time at which the state was sampled. google.protobuf.Timestamp sampled_at = 1; @@ -561,5 +561,5 @@ message ElectricalComponentData { repeated frequenz.api.common.v1.metrics.MetricSample metric_samples = 2; // List of states of a specific microgrid component. - repeated ElectricalComponentState states = 3; + repeated ElectricalComponentStateSnapshot states = 3; } From 5c917b413b3da05ba5c843970ef720518b4f2464 Mon Sep 17 00:00:00 2001 From: Tiyash Basu Date: Mon, 19 May 2025 17:49:05 +0200 Subject: [PATCH 2/2] Rename `SensorState` to `SensorStateSnapshot` The state message in this case is a snapshot of the sensor's composite state at a given time. The name `SensorStateSnapshot` is more descriptive and accurately reflects the purpose of the message. Signed-off-by: Tiyash Basu --- RELEASE_NOTES.md | 1 + proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 7bb2fc02..9f5bba00 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -32,6 +32,7 @@ - Renamed `ComponentCategoryMetadataVariant` to `ElectricalComponentCategorySpecificInfo`. - Renamed field `ElectricalComponent.category_type` to `ElectricalComponent.category_specific_info` to better reflect its purpose. - Renamed `ElectricalComponentState` to `ElectricalComponentStateSnapshot` to better reflect its purpose. +- Renamed `SensorState` to `SensorStateSnapshot` to better reflect its purpose. ## Bug Fixes diff --git a/proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto b/proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto index c79ec263..a18f4180 100644 --- a/proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto +++ b/proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto @@ -168,7 +168,7 @@ message SensorDiagnostic { } // Representation of a sensor state and errors. -message SensorState { +message SensorStateSnapshot { // The time at which the state was sampled. google.protobuf.Timestamp sampled_at = 1; @@ -257,6 +257,6 @@ message SensorData { repeated SensorMetricSample metric_samples = 2; // List of states of a specific microgrid sensor. - repeated SensorState states = 3; + repeated SensorStateSnapshot states = 3; }