Skip to content

Remove SensorCategory enum #352

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 1 commit into from
May 28, 2025
Merged

Remove SensorCategory enum #352

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
1 change: 1 addition & 0 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
- The code `UNDERVOLTAGE_SHUTDOWN` has been removed in favour of `UNDERVOLTAGE`.
- New diagnostic codes have been added to cover more cases, especially for inverters.
- The codes have been renumbered.
- Removed `SensorCategory` enum, since it was not useful and potentially confusing. Sensors can report different sensor metrics, and they could belong to several of these categories simultaneously. This defeats the purpose of having singular categories for sensors. We need to rethink how to categorize sensors. Until then, having it does not add any value, and therefore it has been removed.

## Bug Fixes

Expand Down
30 changes: 0 additions & 30 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 @@ -15,33 +15,6 @@ import "frequenz/api/common/v1/microgrid/lifetime.proto";

import "google/protobuf/timestamp.proto";

// Enumerated sensor categories.
enum SensorCategory {
// Unspecified
SENSOR_CATEGORY_UNSPECIFIED = 0;

// Thermometer (temperature sensor)
SENSOR_CATEGORY_THERMOMETER = 1;

// Hygrometer (humidity sensor)
SENSOR_CATEGORY_HYGROMETER = 2;

// Barometer (pressure sensor).
SENSOR_CATEGORY_BAROMETER = 3;

// Pyranometer (solar irradiance sensor).
SENSOR_CATEGORY_PYRANOMETER = 4;

// Anemometer (wind velocity and direction sensor).
SENSOR_CATEGORY_ANEMOMETER = 5;

// Accelerometers (acceleration sensor).
SENSOR_CATEGORY_ACCELEROMETER = 6;

// General sensors, which do not fall in any of the above categories
SENSOR_CATEGORY_GENERAL = 7;
}

// 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 @@ -82,9 +55,6 @@ message Sensor {
// An optional name for the sensor.
string name = 3;

// The category of the sensor.
SensorCategory category = 4;

// The sensor manufacturer.
string manufacturer = 5;

Expand Down
Loading