Skip decoding if decode false #12
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
Because it was slightly simpler, we were just always decoding before, and then we were returning the raw or decoded value depending on what had been requested. But there may be instances where the decode logic is failing to handle a value, and it may be beneficial to _not_ run the decode logic at all…hence this change.
There was a problem hiding this comment.
Pull Request Overview
This PR changes the behavior of the decode: false option to actually skip the decoding process entirely, rather than just returning raw encoded values after decoding. This provides better debugging capabilities when decoding fails by allowing users to access truly raw register values.
- Changes
decode: falseto bypass the decoding logic completely - Adds error handling for decoding failures with descriptive error messages
- Refactors the decode function to conditionally apply decoding based on the option
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| lib/modboss.ex | Implements conditional decoding logic and improves error handling for decode failures |
| test/modboss_test.exs | Adds comprehensive tests for decode error handling and raw value bypass functionality |
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.
The decode false option is currently slightly misleading. Rather than skipping decoding, it just returns the raw values from the register (or more accurately, the raw value returned by whatever modbus communication library you're using).
This PR changes that so we actually skip decoding when
decode: falseis passed. This seems like a better option for cases where some value isn't decoding properly, and we're digging in to see what the raw value was.