Skip to content

Commit 27312a9

Browse files
Rename SensorData to SensorTelemetry
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 e34e5ab commit 27312a9

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
@@ -40,6 +40,7 @@
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.
4242
- 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.
4344

4445
## Bug Fixes
4546

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)