Remove SensorCategory enum
#352
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
part:docs
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR removes the SensorCategory enum since it was deemed unhelpful and potentially confusing, and updates the release notes accordingly.
- Removed the SensorCategory enum and the associated "category" field from the Sensor message in sensors.proto.
- Updated RELEASE_NOTES.md to reflect the removal.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto | Removed SensorCategory enum and the Sensor category field |
| RELEASE_NOTES.md | Added note explaining removal of SensorCategory enum |
llucax
previously approved these changes
May 23, 2025
This enumeration 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. Signed-off-by: Tiyash Basu <[email protected]> # Conflicts: # RELEASE_NOTES.md
tiyash-basu-frequenz
force-pushed
the
348_sensor_category
branch
from
2fb2c88 to
43a0dff
Compare
Contributor
Author
|
Rebased |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR removes the SensorCategory enum and its associated field in the Sensor message from the proto file because the enum was deemed potentially confusing and not sufficiently useful.
- Removed SensorCategory enum and its usage from the proto file.
- Updated RELEASE_NOTES.md to document the removal.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto | Removed SensorCategory enum and the corresponding Sensor message field. |
| RELEASE_NOTES.md | Added an entry documenting the removal of SensorCategory. |
Comments suppressed due to low confidence (1)
proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto:57
- Removing a field from a public proto message can be a breaking change; please ensure that all dependent services are updated and that you provide a migration path or clear documentation for the change.
SensorCategory category = 4;
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This enumeration 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.
closes #348