Skip to content

Commit a11258d

Browse files
Add Snapshot prefix to sensor and electrical component states (#341)
closes #326
2 parents 8b6eb2e + 5c917b4 commit a11258d

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

RELEASE_NOTES.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
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.
35+
- Renamed `SensorState` to `SensorStateSnapshot` to better reflect its purpose.
3436

3537
## Bug Fixes
3638

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
}

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)