Skip to content

Add Snapshot prefix to sensor and electrical component states #341

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

Merged
merged 2 commits into from
May 20, 2025
Merged

Add Snapshot prefix to sensor and electrical component states #341

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d2b6f4
Renamed `ElectricalComponentState` to `ElectricalComponentStateSnapshot`
tiyash-basu-frequenz May 20, 2025
5c917b4
Rename `SensorState` to `SensorStateSnapshot`
tiyash-basu-frequenz May 19, 2025
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
2 changes: 2 additions & 0 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@
- A new inverter type `INVERTER_TYPE_WIND_TURBINE` has been added to the `InverterType` enum.
- Renamed `ComponentCategoryMetadataVariant` to `ElectricalComponentCategorySpecificInfo`.
- Renamed field `ElectricalComponent.category_type` to `ElectricalComponent.category_specific_info` to better reflect its purpose.
- Renamed `ElectricalComponentState` to `ElectricalComponentStateSnapshot` to better reflect its purpose.
- Renamed `SensorState` to `SensorStateSnapshot` to better reflect its purpose.

## Bug Fixes

Expand Down
4 changes: 2 additions & 2 deletions proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -474,7 +474,7 @@ message ElectricalComponentDiagnostic {
}

// Representation of a component state, warnings, and errors.
message ElectricalComponentState {
message ElectricalComponentStateSnapshot {
// The time at which the state was sampled.
google.protobuf.Timestamp sampled_at = 1;
Copy link
Contributor

@tar-viturawong-frequenz tar-viturawong-frequenz May 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The issue conversation wants origin_time/snapshot_time here (for ElectricalComponentStateSnapshot).

Copy link
Contributor

@thomas-nicolai-frequenz thomas-nicolai-frequenz May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Exactly, I just also spotted that and reopened the issue.


Expand Down Expand Up @@ -561,5 +561,5 @@ message ElectricalComponentData {
repeated frequenz.api.common.v1.metrics.MetricSample metric_samples = 2;

// List of states of a specific microgrid component.
repeated ElectricalComponentState states = 3;
repeated ElectricalComponentStateSnapshot states = 3;
}
4 changes: 2 additions & 2 deletions proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ message SensorDiagnostic {
}

// Representation of a sensor state and errors.
message SensorState {
message SensorStateSnapshot {
// The time at which the state was sampled.
google.protobuf.Timestamp sampled_at = 1;
Copy link
Contributor

@tar-viturawong-frequenz tar-viturawong-frequenz May 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The issue conversation wants origin_time/snapshot_time here (for SensorStateSnapshot).


Expand Down Expand Up @@ -257,6 +257,6 @@ message SensorData {
repeated SensorMetricSample metric_samples = 2;

// List of states of a specific microgrid sensor.
repeated SensorState states = 3;
repeated SensorStateSnapshot states = 3;
}

Loading