-
Notifications
You must be signed in to change notification settings - Fork 14
Add protobuf definition for communication components #292
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.
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
tar-viturawong-frequenz
merged 6 commits into
frequenz-floss:v0.x.x
from
tar-viturawong-frequenz:feat/communication-components
Apr 1, 2025
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
8f49f21
Add protobuf definition for communication components
tar-viturawong-frequenz 5829065
Update RELEASE_NOTES.md
tar-viturawong-frequenz a1c65cc
Update documentation on review
tar-viturawong-frequenz 9ee3a11
Add communication_components py module
tar-viturawong-frequenz 167052f
add import tests for communication_components_pb2/grpc
tar-viturawong-frequenz 7d3901c
Merge branch 'v0.x.x' into feat/communication-components
tar-viturawong-frequenz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
71 changes: 71 additions & 0 deletions
71
.../frequenz/api/common/v1/microgrid/communication_components/communication_components.proto
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| // Frequenz microgrid communication components definitions. | ||
| // | ||
| // Copyright: | ||
| // Copyright 2025 Frequenz Energy-as-a-Service GmbH | ||
| // | ||
| // License: | ||
| // MIT | ||
|
|
||
| syntax = "proto3"; | ||
|
|
||
| package frequenz.api.common.v1.microgrid.communication_components; | ||
|
|
||
|
|
||
| // `CommunicationComponent` represents a communication component within a | ||
| // microgrid. | ||
| // | ||
| // Communication components are networked devices responsible for enabling | ||
| // communication between electrical components, sensors, controllers, and other | ||
| // network devices. | ||
| message CommunicationComponent { | ||
| // Unique identifier of the communication component. | ||
| uint64 id = 1; | ||
|
|
||
| // Unique identifier of the parent microgrid. | ||
| uint64 microgrid_id = 2; | ||
|
|
||
| // Human-readable name of the communication component. | ||
| string name = 3; | ||
|
|
||
| // Category identifying the type of the communication component. | ||
| CommunicationComponentCategory category = 4; | ||
|
|
||
| // List of IP addresses assigned to this communication component. | ||
| repeated string ip_addresses = 5; | ||
| } | ||
|
|
||
| // `CommunicationComponentCategory` enumerates possible types of communication | ||
| // components within the microgrid. | ||
| // | ||
| // Categories help distinguish communication devices according to their roles, | ||
| // capabilities, and protocols they handle within the microgrid infrastructure. | ||
| enum CommunicationComponentCategory { | ||
| // Unspecified communication component category. | ||
| // | ||
| // !!! caution | ||
| // This default value should never be used explicitly and indicates that | ||
| // the category has not been properly defined. | ||
| COMMUNICATION_COMPONENT_CATEGORY_UNSPECIFIED = 0; | ||
|
|
||
| // Modbus Gateway used for protocol translation and managing Modbus | ||
| // communication. | ||
| COMMUNICATION_COMPONENT_CATEGORY_MODBUS_GATEWAY = 1; | ||
|
|
||
| // LTE Router providing cellular connectivity (LTE, 4G, 5G) for the microgrid. | ||
| COMMUNICATION_COMPONENT_CATEGORY_ROUTER = 2; | ||
|
|
||
| // Ethernet Switch enabling wired network connections within the microgrid. | ||
| COMMUNICATION_COMPONENT_CATEGORY_ETHERNET_SWITCH = 3; | ||
|
|
||
| // Digital Input/Output (DIO) Gateway enabling communication and control | ||
| // of digital signals between microgrid devices. | ||
| COMMUNICATION_COMPONENT_CATEGORY_DIO_GATEWAY = 4; | ||
|
|
||
| // Programmable Logic Controller (PLC) used for automation tasks, | ||
| // process control, and operational logic in the microgrid. | ||
| COMMUNICATION_COMPONENT_CATEGORY_PLC = 5; | ||
|
|
||
| // Serial Gateway (RS-232, RS-485, etc.) facilitating serial communication | ||
| // between legacy equipment and modern network infrastructures. | ||
| COMMUNICATION_COMPONENT_CATEGORY_SERIAL_GATEWAY = 6; | ||
| } |
Empty file.
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be
communication_components_pb2.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed here 167052f