Rename SensorState to SensorStateSnapshot

tiyash-basu-frequenz · tiyash-basu-frequenz · commit f66ed39d7d2d · 2025-05-20T18:07:41.000+02:00
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 &lt;tiyash.basu@frequenz.com&gt;
diff --git 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
@@ -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;
 

Original file line number	Diff line number	Diff line change
`@@ -168,7 +168,7 @@ message SensorDiagnostic {`
`168`	`168`	`}`
`169`	`169`
`170`	`170`	`// Representation of a sensor state and errors.`
`171`		`-message SensorState {`
	`171`	`+message SensorStateSnapshot {`
`172`	`172`	`// The time at which the state was sampled.`
`173`	`173`	`google.protobuf.Timestamp sampled_at = 1;`
`174`	`174`