Skip to content

feat: add communication components listing #119

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.

Sign up for GitHub

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

Closed
sandovalrr wants to merge 1 commit into from
Closed

feat: add communication components listing #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@

## New Features

<!-- Here goes the main new features and examples or instructions on how to use them -->
- Added `ListMicrogridCommunicationComponents` to list and filter communication
components in a microgrid.

## Bug Fixes

Expand Down
63 changes: 58 additions & 5 deletions proto/frequenz/api/platformassets/v1alpha1/platformassets.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ import "frequenz/api/common/v1alpha8/grid/delivery_duration.proto";
import "frequenz/api/common/v1alpha8/grid/market_location.proto";
import "frequenz/api/common/v1alpha8/gridpool/gridpool.proto";
// protolint:disable:next MAX_LINE_LENGTH
import "frequenz/api/common/v1alpha8/microgrid/communication_components/communication_components.proto";
// protolint:disable:next MAX_LINE_LENGTH
import "frequenz/api/common/v1alpha8/microgrid/electrical_components/electrical_components.proto";
import "frequenz/api/common/v1alpha8/microgrid/microgrid.proto";
import "frequenz/api/common/v1alpha8/microgrid/sensors/sensors.proto";
Expand All @@ -31,9 +33,9 @@ import "google/protobuf/timestamp.proto";
// The service exposes a platform-wide read model for resolving stable
// identifiers, asset inventories, and relationships managed by the Frequenz
// platform. This includes Gridpools, microgrids, Market Locations,
// market-topology relations, Gridpool energy schedules, electrical component
// inventories, sensor inventories, and the directed electrical component graph
// within a microgrid.
// market-topology relations, Gridpool energy schedules, electrical and
// communication component inventories, sensor inventories, and the directed
// electrical component graph within a microgrid.
//
// Gridpools represent virtual balancing-group structures used for market
// interactions, such as electricity trading, scheduled energy exchange, and
Expand All @@ -46,8 +48,8 @@ import "google/protobuf/timestamp.proto";
// market participation.
//
// Microgrid asset metadata describes the technical structure of deployed or
// planned microgrids, including electrical components, sensors, and the
// directed electrical component graph.
// planned microgrids, including electrical components, communication
// components, sensors, and the directed electrical component graph.
//
// !!! important "Authentication"
// All requests to PlatformAssetsService must be signed. The key identifier
Expand Down Expand Up @@ -79,6 +81,11 @@ service PlatformAssetsService {
ListMicrogridElectricalComponentsRequest)
returns (ListMicrogridElectricalComponentsResponse);

// Lists communication components for a specific microgrid.
rpc ListMicrogridCommunicationComponents(
ListMicrogridCommunicationComponentsRequest)
returns (ListMicrogridCommunicationComponentsResponse);

// Lists directed electrical connections between components in a specific
// microgrid.
rpc ListMicrogridElectricalComponentConnections(
Expand Down Expand Up @@ -665,6 +672,52 @@ message ListMicrogridElectricalComponentsResponse {
ElectricalComponent components = 2;
}

// Request parameters for the RPC `ListMicrogridCommunicationComponents`.
message ListMicrogridCommunicationComponentsRequest {
// Filters for selecting communication components in a microgrid.
//
// A communication component must match all specified filter fields to be
// included in the response.
//
// !!! note "Filter Semantics"
// Each repeated field is evaluated using logical OR. Different filter
// fields are combined using logical AND. If no filters are provided,
// all communication components in the microgrid are returned.
//
message MicrogridCommunicationComponentsFilter {
// Optional. Return only components whose IDs are included in this list.
//
// If empty, no component-ID filtering is applied.
repeated uint64 component_ids = 1;

// Optional. Return only components whose categories are included in this
// list.
//
// If empty, no category filtering is applied.
repeated frequenz.api.common.v1alpha8.microgrid.communication_components.
CommunicationComponentCategory categories = 2;
}

// Mandatory field. The ID of the microgrid for which components
// are to be listed.
uint64 microgrid_id = 1;

// Optional. Filtering criteria for narrowing the returned components.
//
// If omitted, all communication components in the microgrid are returned.
MicrogridCommunicationComponentsFilter filter = 2;
}

// Response message containing communication components for a microgrid.
message ListMicrogridCommunicationComponentsResponse {
// The unique identifier of the microgrid the returned components belong to.
uint64 microgrid_id = 1;

// Communication components matching the request filters.
repeated frequenz.api.common.v1alpha8.microgrid.communication_components.
CommunicationComponent components = 2;
}

// Request message for listing directed electrical connections between
// components in a microgrid.
//
Expand Down
Loading