Skip to content

Rename sensor and electrical component telemetry states #371

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 1 commit into from
Jun 13, 2025
Merged

Rename sensor and electrical component telemetry states #371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 @@ -28,6 +28,7 @@
* `ComponentState` to `ElectricalComponentStateSnapshot`
* `ComponentState.sampled_at` to `ElectricalComponentStateSnapshot.origin_time`
* `ComponentData` to `ElectricalComponentTelemetry` (to better specify its purpose of encapsulating general telemetry data from electrical components)
* `ComponentData.states` to `ElectricalComponentTelemetry.state_snapshots`
* Grid-related terms to clarify their meaning and purpose:

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

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

// List of states of a specific microgrid component.
repeated ElectricalComponentStateSnapshot states = 3;
// List of state snapshots of a specific microgrid component.
repeated ElectricalComponentStateSnapshot state_snapshots = 3;
}
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 @@ -182,7 +182,7 @@ message SensorTelemetry {
// sensors.
repeated frequenz.api.common.v1.metrics.MetricSample metric_samples = 2;

// List of states of a specific microgrid sensor.
repeated SensorStateSnapshot states = 3;
// List of state snapshots of a specific microgrid sensor.
repeated SensorStateSnapshot state_snapshots = 3;
}

Loading