Skip to content

Commit e34e5ab

Browse files
Rename ElectricalComponentData to ElectricalComponentTelemetry
This message 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. The name change reflects this purpose more accurately. Signed-off-by: Tiyash Basu <[email protected]>
1 parent 521b808 commit e34e5ab

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
@@ -39,6 +39,7 @@
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.
4243

4344
## Bug Fixes
4445

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

0 commit comments

Comments
 (0)