Skip to content

Commit 6245649

Browse files
Rename sensor and electrical component telemetry states
This commit renames the following: - `ComponentData.state` to `ElectricalComponentTelemetry.state_snapshot` - `SensorData.states` to `SensorTelemetry.state_snapshot` Signed-off-by: Tiyash Basu <[email protected]>
1 parent 4b120ae commit 6245649

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
@@ -28,6 +28,7 @@
2828
* `ComponentState` to `ElectricalComponentStateSnapshot`
2929
* `ComponentState.sampled_at` to `ElectricalComponentStateSnapshot.origin_time`
3030
* `ComponentData` to `ElectricalComponentTelemetry` (to better specify its purpose of encapsulating general telemetry data from electrical components)
31+
* `ComponentData.states` to `ElectricalComponentTelemetry.state_snapshots`
3132
* Grid-related terms to clarify their meaning and purpose:
3233

3334
+ `COMPONENT_CATEGORY_GRID` to `ELECTRICAL_COMPONENT_CATEGORY_GRID_CONNECTION_POINT`
@@ -38,6 +39,7 @@
3839
* `SensorErrorCode` to `SensorDiagnosticCode`
3940
* `SensorData` to `SensorTelemetry` (to better specify its purpose of encapsulating general telemetry data from sensors)
4041
* `SensorState` to `SensorStateSnapshot`
42+
* `SensorData.states` to `SensorTelemetry.state_snapshots`
4143
* `SensorState.sampled_at` to `SensorStateSnapshot.origin_time`
4244
* `SensorStateCode.SENSOR_STATE_CODE_ON` to `SensorStateCode.SENSOR_STATE_CODE_OK` (to better indicate that we do not control on/off state of sensors)
4345

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
@@ -580,6 +580,6 @@ message ElectricalComponentTelemetry {
580580
// List of measurements for a metric of the specific microgrid component.
581581
repeated frequenz.api.common.v1.metrics.MetricSample metric_samples = 2;
582582

583-
// List of states of a specific microgrid component.
584-
repeated ElectricalComponentStateSnapshot states = 3;
583+
// List of state snapshots of a specific microgrid component.
584+
repeated ElectricalComponentStateSnapshot state_snapshots = 3;
585585
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ message SensorTelemetry {
182182
// sensors.
183183
repeated frequenz.api.common.v1.metrics.MetricSample metric_samples = 2;
184184

185-
// List of states of a specific microgrid sensor.
186-
repeated SensorStateSnapshot states = 3;
185+
// List of state snapshots of a specific microgrid sensor.
186+
repeated SensorStateSnapshot state_snapshots = 3;
187187
}
188188

0 commit comments

Comments
 (0)