Skip to content

Commit 5c917b4

Browse files
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 <[email protected]>
1 parent 4d2b6f4 commit 5c917b4

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
@@ -32,6 +32,7 @@
3232
- Renamed `ComponentCategoryMetadataVariant` to `ElectricalComponentCategorySpecificInfo`.
3333
- Renamed field `ElectricalComponent.category_type` to `ElectricalComponent.category_specific_info` to better reflect its purpose.
3434
- Renamed `ElectricalComponentState` to `ElectricalComponentStateSnapshot` to better reflect its purpose.
35+
- Renamed `SensorState` to `SensorStateSnapshot` to better reflect its purpose.
3536

3637
## Bug Fixes
3738

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ message SensorDiagnostic {
168168
}
169169

170170
// Representation of a sensor state and errors.
171-
message SensorState {
171+
message SensorStateSnapshot {
172172
// The time at which the state was sampled.
173173
google.protobuf.Timestamp sampled_at = 1;
174174

@@ -257,6 +257,6 @@ message SensorData {
257257
repeated SensorMetricSample metric_samples = 2;
258258

259259
// List of states of a specific microgrid sensor.
260-
repeated SensorState states = 3;
260+
repeated SensorStateSnapshot states = 3;
261261
}
262262

0 commit comments

Comments
 (0)