Add communication component state codes and snapshot message #329
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 updates the `CommunicationComponentDiagnosticCode` enum in the `communication_components.proto` file to include additional diagnostic codes for better error handling and reporting. The new codes include `COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_UNKNOWN`, `COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_AUTHENTICATION_ERR`, `COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_OVER_TEMPERATURE`. 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 adds a new enum (CommunicationComponentStateCode) to represent the operational state of a communication component and introduces a snapshot message (CommunicationComponentStateSnapshot) for capturing component state, diagnostics, and timing.
- Added CommunicationComponentStateCode enum with state codes such as ONLINE, OFFLINE, etc.
- Introduced CommunicationComponentStateSnapshot, a new message capturing timing, state, and diagnostic details.
- Updated the CommunicationComponentDiagnosticCode enum values and key names (e.g., renaming HARDWARE_FAULT to HARDWARE_GENERIC_FAULT) and corresponding release notes.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/microgrid/communication_components/communication_components.proto | Added new state code enum and snapshot message; updated diagnostic enum values and key names. |
| RELEASE_NOTES.md | Updated release notes to include the new message CommunicationComponentStateSnapshot. |
Comments suppressed due to low confidence (1)
proto/frequenz/api/common/v1/microgrid/communication_components/communication_components.proto:72
- [nitpick] The renaming from HARDWARE_FAULT to HARDWARE_GENERIC_FAULT may cause confusion among consumers expecting the old naming. Please update related documentation and ensure that corresponding handling logic is adjusted accordingly.
COMMUNICATION_COMPONENT_DIAGNOSTIC_CODE_HARDWARE_GENERIC_FAULT = 6;
proto/frequenz/api/common/v1/microgrid/communication_components/communication_components.proto
Outdated
Show resolved
Hide resolved
This commit adds a new enum `CommunicationComponentStateCode` to represent the high-level operational state of a communication component. It also introduces a new message `CommunicationComponentStateSnapshot` that captures a snapshot of the component's state, diagnostics, and timing. This is useful for monitoring and diagnosing the status of communication components in a microgrid system. Signed-off-by: Tiyash Basu <[email protected]>
tiyash-basu-frequenz
force-pushed
the
comm_components
branch
from
2eac4a3 to
d1f0e91
Compare
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 adds a new enum
CommunicationComponentStateCodeto represent the high-level operational state of a communication component. It also introduces a new messageCommunicationComponentStateSnapshotthat captures a snapshot of the component's state, diagnostics, and timing. This is useful for monitoring and diagnosing the status of communication components in a microgrid system.