Rename sensor and electrical component telemetry states #371
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR renames telemetry fields in the proto files to better clarify their purpose.
- Renames SensorData.states to SensorTelemetry.state_snapshot in sensors.proto
- Renames ComponentData.state to ElectricalComponentTelemetry.state_snapshot in electrical_components.proto
- Updates RELEASE_NOTES.md to document the changes
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto | Updated field name in SensorTelemetry to state_snapshot |
| proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto | Updated field name in ElectricalComponentTelemetry to state_snapshot |
| RELEASE_NOTES.md | Documented telemetry field renames |
Comments suppressed due to low confidence (2)
proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto:185
- Update the comment to reflect the new field name. For example, change it to "List of sensor state snapshots for a specific microgrid sensor."
// List of states of a specific microgrid sensor.
proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto:583
- Consider revising the comment to align with the new field name, for instance: "List of electrical component state snapshots for a specific microgrid component."
// List of states of a specific microgrid component.
github-actions
bot
added
part:docs
tiyash-basu-frequenz
force-pushed
the
366_state_snapshot
branch
from
65c8c1a to
7ebb5e5
Compare
This commit renames the following: - `ComponentData.state` to `ElectricalComponentTelemetry.state_snapshot` - `SensorData.states` to `SensorTelemetry.state_snapshot` Signed-off-by: Tiyash Basu <[email protected]>
tiyash-basu-frequenz
force-pushed
the
366_state_snapshot
branch
from
7ebb5e5 to
6245649
Compare
llucax
approved these changes
Jun 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit renames the following:
ComponentData.statetoElectricalComponentTelemetry.state_snapshotsSensorData.statestoSensorTelemetry.state_snapshotscloses #366