Skip to content

Commit 415c4ac

Browse files
Rename leftover uses of component_id to electrical_component_id
The following changes have been made to the proto file `electrical_components.proto`: - `ElectricalComponentConnections.source_component_id` has been renamed to `ElectricalComponentConnections.source_electrical_component_id` - `ElectricalComponentConnections.destination_component_id` has been renamed to `ElectricalComponentConnections.destination_electrical_component_id` - `ElectricalComponentStateSnapshot.component_id` has been renamed to `ElectricalComponentStateSnapshot.electrical_component_id` Additionally, a few documentation comments have been updated to reflect the change from "component" to "electrical component". Signed-off-by: Tiyash Basu <[email protected]>
1 parent b5d067a commit 415c4ac

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

RELEASE_NOTES.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@
1313
- A new package `frequenz.api.common.v1alpha8` has been added. It has the following changes when compared to `frequenz.api.common.v1alpha7`:
1414
- `electrical_components.Fuse` has been removed.
1515
- `InverterType.INVERTER_TYPE_WIND_TURBINE` has been removed.
16+
- `ElectricalComponentConnections.source_component_id` has been renamed to `ElectricalComponentConnections.source_electrical_component_id`
17+
- `ElectricalComponentConnections.destination_component_id` has been renamed to `ElectricalComponentConnections.destination_electrical_component_id`
18+
- `ElectricalComponentStateSnapshot.component_id` has been renamed to `ElectricalComponentStateSnapshot.electrical_component_id`
19+
1620

1721
## Bug Fixes
1822

proto/frequenz/api/common/v1alpha8/microgrid/electrical_components/electrical_components.proto

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -638,11 +638,11 @@ message ElectricalComponentConnection {
638638
// Unique identifier of the component where the connection originates. This is
639639
// aligned with the direction of current flow away from the grid connection
640640
// point, or in case of islands, away from the islanding point.
641-
uint64 source_component_id = 1;
641+
uint64 source_electrical_component_id = 1;
642642

643643
// Unique ID of the component where the connection terminates. This is the
644644
// component towards which the current flows.
645-
uint64 destination_component_id = 2;
645+
uint64 destination_electrical_component_id = 2;
646646

647647
// The operational lifetime of the connection.
648648
frequenz.api.common.v1alpha8.microgrid.Lifetime operational_lifetime = 3;
@@ -728,13 +728,14 @@ message ElectricalComponentStateSnapshot {
728728
}
729729

730730
// ElectricalComponentTelemetry message aggregates multiple metrics, operational
731-
// states, and errors, related to a specific microgrid component.
731+
// states, and errors, related to a specific electrical component in a
732+
// microgrid.
732733
//
733734
// !!! example
734-
//  Example output of a component data message:
735+
//  Example output of a telemetry message:
735736
//  ```
736737
// {
737-
// component_id: 13,
738+
// electrical_component_id: 13,
738739
// metric_samples: [
739740
// /* list of metrics for multiple timestamps */
740741
// {
@@ -770,12 +771,13 @@ message ElectricalComponentStateSnapshot {
770771
// }
771772
// ```
772773
message ElectricalComponentTelemetry {
773-
// The ID of the microgrid component.
774-
uint64 component_id = 1;
774+
// The ID of the electrical component for which the telemetry is
775+
// collected.
776+
uint64 electrical_component_id = 1;
775777

776-
// List of measurements for a metric of the specific microgrid component.
778+
// List of measurements for a metric of the specific electrical component.
777779
repeated frequenz.api.common.v1alpha8.metrics.MetricSample metric_samples = 2;
778780

779-
// List of state snapshots of a specific microgrid component.
781+
// List of state snapshots of a specific electrical component.
780782
repeated ElectricalComponentStateSnapshot state_snapshots = 3;
781783
}

0 commit comments

Comments
 (0)