Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Documentation Regarding raw_packet_data, raw_value, and value #87

Closed
medley56 opened this issue Oct 2, 2024 · 0 comments · Fixed by #106
Closed

Add Documentation Regarding raw_packet_data, raw_value, and value #87

medley56 opened this issue Oct 2, 2024 · 0 comments · Fixed by #106
Labels
documentation Improvements or additions to documentation

Comments

@medley56
Copy link
Owner

medley56 commented Oct 2, 2024

The definition of raw_value is especially fuzzy since it's not perfectly consistent between Data Encoding types.

Add a discussion of what we mean by

  • raw packet data: full packet worth of bytes
  • raw_value: as direct a representation as possible of the encoded value (int, float, bytes)
  • value: calibrated, derived, fully parsed, enumerated lookup value. The value that the user probably cares about.
@medley56 medley56 added the documentation Improvements or additions to documentation label Oct 2, 2024
@medley56 medley56 linked a pull request Oct 9, 2024 that will close this issue
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant