Skip to content

Commit 84fd05d

Browse files
Rename *Data messages to *Telemetry (#351)
These messages holds two different types of data: metric samples and state snapshots, which when combined into a single message, represent the telemetry data of a component/sensor. The name change reflects this purpose more accurately.
2 parents 521b808 + 27312a9 commit 84fd05d

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
@@ -39,6 +39,8 @@
3939
- Remove `SensorMetric` enum, since it was unused and redundant.
4040
- Renamed `MetricSample.source` to `MetricSample.connection` to make it more specific as to what it refers to.
4141
- Rename `SensorStateCode.SENSOR_STATE_CODE_ON` to `SensorStateCode.SENSOR_STATE_CODE_OK`, to better indicate that we do not control on/off state of sensors.
42+
- Rename `ComponentData` to `ElectricalComponentTelemetry` to better specify its purpose of encapsulating general telemetry data from electrical components.
43+
- Rename `SensorData` to `SensorTelemetry` to better specify its purpose of encapsulating general telemetry data from sensors.
4244

4345
## Bug Fixes
4446

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
@@ -513,7 +513,7 @@ message ElectricalComponentStateSnapshot {
513513
repeated ElectricalComponentDiagnostic errors = 4;
514514
}
515515

516-
// ElectricalComponentData message aggregates multiple metrics, operational
516+
// ElectricalComponentTelemetry message aggregates multiple metrics, operational
517517
// states, and errors, related to a specific microgrid component.
518518
//
519519
// !!! example
@@ -555,7 +555,7 @@ message ElectricalComponentStateSnapshot {
555555
// ]
556556
// }
557557
// ```
558-
message ElectricalComponentData {
558+
message ElectricalComponentTelemetry {
559559
// The ID of the microgrid component.
560560
uint64 component_id = 1;
561561

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ message SensorStateSnapshot {
167167
repeated SensorDiagnostic errors = 4;
168168
}
169169

170-
// SensorData message aggregates multiple metrics, operational states, and
170+
// SensorTelemetry message aggregates multiple metrics, operational states, and
171171
// errors, related to a specific microgrid sensor.
172172
//
173173
// !!! example
@@ -201,7 +201,7 @@ message SensorStateSnapshot {
201201
// ]
202202
// }
203203
// ```
204-
message SensorData {
204+
message SensorTelemetry {
205205
// The ID of the microgrid sensors.
206206
uint64 sensor_id = 1;
207207

0 commit comments

Comments
 (0)