Handle unknown OffReason and AlarmReason values gracefully#86
Open
rajlaud wants to merge 2 commits into
Open
Conversation
Add parse_enum helper function and UNKNOWN members to OffReason and AlarmReason enums. These were changed from Flag to Enum in v0.9.3, which means unknown values now raise ValueError instead of being representable as flag combinations. Changes: - Added parse_enum(enum_class, value) helper in base.py - Added UNKNOWN member to OffReason and AlarmReason - Updated parsing to use parse_enum for these enums Affected devices: - DcDcConverter, SmartBatteryProtect, OrionXS (OffReason) - BatteryMonitor, SmartBatteryProtect, DcEnergyMeter (AlarmReason)
20 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
When a Victron device sends an enum value that isn't defined in the library (e.g., a new
OffReasonorAlarmReasonvalue from a firmware update), the library raises aValueError. This causes the entire advertisement to be dropped, losing all sensor data from that reading.This became more likely after #74 changed
OffReasonandAlarmReasonfromFlagtoEnum, since previously unknown combinations could still be represented as flag combinations.Solution
Added a
parse_enum()helper function andUNKNOWNmembers toOffReasonandAlarmReason. When an unrecognized value is encountered, the enum now returnsUNKNOWNinstead of raising an exception.Changes
parse_enum(enum_class, value)helper inbase.pyUNKNOWNmember toOffReasonandAlarmReasonparse_enumfor these enumsAffected devices:
OffReason)AlarmReason)Testing
All existing tests pass. The change is backward-compatible—known enum values behave identically, only unknown values now return
UNKNOWNinstead of raising an exception.