Char encode and decode rework #165
Merged
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 pull request updates the documentation and usage patterns for Bluetooth GATT characteristic value parsing, standardizing the method naming and clarifying the recommended APIs. The most significant changes are the switch from
decode_valuetoparse_valuefor public APIs, the renaming of internal implementation methods to_decode_value, and improvements to documentation and examples in both the README and instruction files.API and Method Naming Standardization:
parse_valueinstead ofdecode_valuefor parsing characteristic values, ensuring consistency and clarity in the recommended API. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]_decode_valuefor private/protected characteristic parsing logic, reflecting the intended encapsulation and usage patterns. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]Documentation and Example Improvements:
README.mdto clarify the distinction between type-safe characteristic class usage and dynamic parsing via UUID strings, with new code examples and clearer recommendations for both approaches. [1] [2]Testing and Validation:
parse_value, ensuring that tests align with the new public API and reinforcing the intended usage for developers. [1] [2] [3] [4] [5] [6] [7] [8]These changes collectively improve the clarity, consistency, and usability of the Bluetooth GATT characteristic parsing APIs and documentation.