Skip to content

Remove SensorMetricSample in favour of MetricSample #346

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 22, 2025
Merged

Remove SensorMetricSample in favour of MetricSample #346

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
2a0ca00
Remove `SensorMetricSample` in favour of `MetricSample`
tiyash-basu-frequenz May 22, 2025
3567a48
Remove unused enum `SensorMetric`
tiyash-basu-frequenz May 22, 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 @@ -35,6 +35,8 @@
- Renamed `SensorState` to `SensorStateSnapshot` to better reflect its purpose.
- Renamed `sampled_at` timestamps for state snapshots to `origin_time`.
- Renamed `sampled_at` timestamps for metric samples to `sample_time`.
- Remove `SensorMetricSample` in favour of using `MetricSample` for sensors.
- Remove `SensorMetric` enum, since it was unused and redundant.

## Bug Fixes

Expand Down
58 changes: 5 additions & 53 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 @@ -42,46 +42,6 @@ enum SensorCategory {
SENSOR_CATEGORY_GENERAL = 7;
}

// Enumrated sensor metrics.
enum SensorMetric {
// Unspecified.
SENSOR_METRIC_UNSPECIFIED = 0;

// Temperature.
// In Celsius (°C).
SENSOR_METRIC_TEMPERATURE = 1;

// Humidity
// In percentage (%).
SENSOR_METRIC_HUMIDITY = 2;

// Pressure
// In Pascal (Pa).
SENSOR_METRIC_PRESSURE = 3;

// Irradiance / Radiation flux
// In watts per square meter (W / m^2).
SENSOR_METRIC_IRRADIANCE = 4;

// Velocity
// In meters per second (m / s).
SENSOR_METRIC_VELOCITY = 5;

// Acceleration.
// In meters per second per second (m / s^2)
SENSOR_METRIC_ACCELERATION = 6;

// Metric to represent angles, for metrics like direction.
// In angles with respect to the (magnetic) North (°).
SENSOR_METRIC_ANGLE = 7;

// Dew point.
// The temperature at which the air becomes saturated with water vapor.
//
// In Celsius (°C).
SENSOR_METRIC_DEW_POINT = 8;
}

// Enum to represent the various states that a sensor can be in.
// This enum is unified across all sensor categories for consistency.
enum SensorStateCode {
Expand Down Expand Up @@ -207,18 +167,6 @@ message SensorStateSnapshot {
repeated SensorDiagnostic errors = 4;
}

// Representation of a sampled sensor metric along with its value.
message SensorMetricSample {
// The UTC timestamp of when the metric was sampled.
google.protobuf.Timestamp sample_time = 1;

// The metric that was sampled.
frequenz.api.common.v1.metrics.Metric metric = 2;

// The value of the sampled metric.
frequenz.api.common.v1.metrics.MetricValueVariant value = 3;
}

// SensorData message aggregates multiple metrics, operational states, and
// errors, related to a specific microgrid sensor.
//
Expand All @@ -233,11 +181,15 @@ message SensorMetricSample {
// sample_time: "2023-10-01T00:00:00Z",
// metric: "METRIC_SENSOR_TEMPERATURE",
// value: metric_value_variant: {simple_metric: {value: 23.5},
// bounds: {}
// source: {}
// },
// {
// sample_time: "2023-10-01T00:00:00Z",
// metric: "METRIC_SENSOR_RELATIVE_HUMIDITY",
// value: metric_value_variant: {simple_metric: {value: 23.5},
// bounds: {}
// source: "humidity_sensor_1"
// }
// ],
// states: [
Expand All @@ -254,7 +206,7 @@ message SensorData {
uint64 sensor_id = 1;

// List of measurements for a metric of the specific microgrid sensor.
repeated SensorMetricSample metric_samples = 2;
repeated frequenz.api.common.v1.metrics.MetricSample metric_samples = 2;

// List of states of a specific microgrid sensor.
repeated SensorStateSnapshot states = 3;
Expand Down
Loading