Rename SensorStateCode variant ON to OK in sensors.proto
#350
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
Sensor state `ON` is misleading, as it can mislead users to think that the API controls the on/off state of the sensor. This is not the case, as the API only provides information about the sensor's state. The sensor's state can be `OK` (indicating that the sensor is functioning correctly) or `ERROR` (indicating that the sensor is in an error state). This change renames the `SENSOR_STATE_CODE_ON` variant to `SENSOR_STATE_CODE_OK`, which is more accurate and descriptive. Signed-off-by: Tiyash Basu <[email protected]>
github-actions
bot
added
part:docs
Contributor
There was a problem hiding this comment.
Pull Request Overview
Renames the SensorStateCode enum variant from ON to OK to more accurately reflect sensor health rather than power state.
- Updated the proto definition for clarity.
- Added a release note entry to document the change.
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 | Changed SENSOR_STATE_CODE_ON to SENSOR_STATE_CODE_OK |
| RELEASE_NOTES.md | Documented the rename in the release notes |
Comments suppressed due to low confidence (2)
proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto:52
- [nitpick] Update this enum comment to match the new 'OK' semantics, e.g., 'The sensor is functioning correctly.'
// The sensor is up and running.
proto/frequenz/api/common/v1/microgrid/sensors/sensors.proto:53
- Ensure any tests referencing the old
SENSOR_STATE_CODE_ONare updated or new tests coverSENSOR_STATE_CODE_OK.
SENSOR_STATE_CODE_OK = 1;
llucax
approved these changes
May 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Sensor state
ONis misleading, as it can mislead users to think that the API controls the on/off state of the sensor. This is not the case, as the API only provides information about the sensor's state. The sensor's state can beOK(indicating that the sensor is functioning correctly) orERROR(indicating that the sensor is in an error state).This change renames the
SENSOR_STATE_CODE_ONvariant toSENSOR_STATE_CODE_OK, which is more accurate and descriptive.