Update sensor error representation #310
Merged
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
This commit introduces the `SensorDiagnostic` message to represent errors and warnings reported by microgrid sensors. This message extends a standardized error code with contextual information useful for diagnostics, such as subsystem names, measured values, or vendor-specific insights. Signed-off-by: Tiyash Basu <[email protected]>
This commit renames the enum `SensorErrorCode` to `SensorDiagnosticCode` in the `sensors.proto` file. This change is made to better reflect the shared usage of this enum for both warnings and errors in microgrid sensors. Signed-off-by: Tiyash Basu <[email protected]>
This commit adds a new field `warnings` to the `SensorState` message in the `sensors.proto` file. This field is a repeated field of type `SensorDiagnostic`, which is used to represent warnings for the microgrid sensor. The `warnings` field is expected to have warnings if and only if the sensor is reporting warnings. The list will contain unique members, meaning no warning will exist twice in this list. This makes the `SensorState` message consistent with respect to `ElectricalComponentState`. Signed-off-by: Tiyash Basu <[email protected]>
github-actions
bot
added
part:docs
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the sensor error representation for microgrid sensors by introducing a new SensorDiagnostic message and aligning diagnostic reporting for both errors and warnings.
- Added a SensorDiagnostic message to encapsulate standardized diagnostic codes, vendor error codes, and descriptive messages.
- Updated SensorState to include a new warnings list and replaced the errors field to use SensorDiagnostic.
- Renamed SensorErrorCode to SensorDiagnosticCode to better represent its broader usage.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto | Introduces SensorDiagnostic, updates SensorState to include warnings, and renames SensorErrorCode to SensorDiagnosticCode. |
| RELEASE_NOTES.md | Adds documentation updates reflecting the new SensorDiagnostic message and the updated enum name. |
ktickner
reviewed
Apr 17, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
No description provided.