Skip to content

Rename *Data messages to *Telemetry #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 23, 2025
Merged

Rename *Data messages to *Telemetry #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e34e5ab
Rename `ElectricalComponentData` to `ElectricalComponentTelemetry`
tiyash-basu-frequenz May 22, 2025
27312a9
Rename `SensorData` to `SensorTelemetry`
tiyash-basu-frequenz May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@
- Remove `SensorMetric` enum, since it was unused and redundant.
- Renamed `MetricSample.source` to `MetricSample.connection` to make it more specific as to what it refers to.
- 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.
- Rename `ComponentData` to `ElectricalComponentTelemetry` to better specify its purpose of encapsulating general telemetry data from electrical components.
- Rename `SensorData` to `SensorTelemetry` to better specify its purpose of encapsulating general telemetry data from sensors.

## Bug Fixes

Expand Down
4 changes: 2 additions & 2 deletions proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -513,7 +513,7 @@ message ElectricalComponentStateSnapshot {
repeated ElectricalComponentDiagnostic errors = 4;
}

// ElectricalComponentData message aggregates multiple metrics, operational
// ElectricalComponentTelemetry message aggregates multiple metrics, operational
// states, and errors, related to a specific microgrid component.
//
// !!! example
Expand Down Expand Up @@ -555,7 +555,7 @@ message ElectricalComponentStateSnapshot {
// ]
// }
// ```
message ElectricalComponentData {
message ElectricalComponentTelemetry {
// The ID of the microgrid component.
uint64 component_id = 1;

Expand Down
4 changes: 2 additions & 2 deletions proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ message SensorStateSnapshot {
repeated SensorDiagnostic errors = 4;
}

// SensorData message aggregates multiple metrics, operational states, and
// SensorTelemetry message aggregates multiple metrics, operational states, and
// errors, related to a specific microgrid sensor.
//
// !!! example
Expand Down Expand Up @@ -201,7 +201,7 @@ message SensorStateSnapshot {
// ]
// }
// ```
message SensorData {
message SensorTelemetry {
// The ID of the microgrid sensors.
uint64 sensor_id = 1;

Expand Down
Loading