Skip to content

Conversation

@RonanB96
Copy link
Owner

@RonanB96 RonanB96 commented Jan 9, 2026

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_value to parse_value for 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:

  • Changed all public-facing documentation and examples to use parse_value instead of decode_value for parsing characteristic values, ensuring consistency and clarity in the recommended API. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]
  • Updated all internal implementation examples and instructions to use _decode_value for 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:

  • Overhauled the README.md to 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]
  • Enhanced instructional markdown files to reflect the new method names and provide up-to-date, consistent usage patterns for both implementation and testing. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13]

Testing and Validation:

  • Updated all test instructions to use 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.

@RonanB96 RonanB96 self-assigned this Jan 11, 2026
@RonanB96 RonanB96 force-pushed the encode_decode_rework branch from e52d7d5 to 522d9c8 Compare January 11, 2026 20:01
@RonanB96 RonanB96 merged commit 05da53a into main Jan 11, 2026
10 of 11 checks passed
@RonanB96 RonanB96 deleted the encode_decode_rework branch January 11, 2026 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants