Add communication component diagnostic message #315
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
github-actions
bot
added
part:docs
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces new diagnostic message definitions for communication components in the microgrid API. Key changes include:
- Addition of enum CommunicationComponentDiagnosticCode to standardize diagnostic codes.
- Addition of the CommunicationComponentDiagnostic message that provides contextual and vendor-specific error information.
- Update of RELEASE_NOTES.md to document these new features.
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/communication_components/communication_components.proto | Added diagnostic enum and message with detailed documentation for communication components. |
| RELEASE_NOTES.md | Updated release notes to include the CommunicationComponentDiagnostic message. |
tiyash-basu-frequenz
force-pushed
the
communication_component_status
branch
from
51b7d7f to
67118e5
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new diagnostic enumeration and message for microgrid communication components to standardize error and warning reporting. Key changes include:
- Adding the enum CommunicationComponentDiagnosticCode for common diagnostic states.
- Adding the CommunicationComponentDiagnostic message with fields for diagnostic code, vendor error code, and a detailed message.
- Updating RELEASE_NOTES.md to document the new messaging feature.
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/communication_components/communication_components.proto | Added diagnostic enumeration and message for communication components. |
| RELEASE_NOTES.md | Updated documentation to include new diagnostic message. |
Comments suppressed due to low confidence (1)
proto/frequenz/api/common/v1/microgrid/communication_components/communication_components.proto:24
- [nitpick] Consider renaming 'COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_CONFIGURATION_ERR' to 'COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_CONFIGURATION_ERROR' for improved clarity, unless this naming is intentional and consistent with existing conventions.
COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_CONFIGURATION_ERR = 2;
Signed-off-by: Tiyash Basu <[email protected]>
tiyash-basu-frequenz
force-pushed
the
communication_component_status
branch
from
67118e5 to
7eee221
Compare
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.