initial try at documenting payload formats #338
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.
Inspired by #80 , I've read through the firmware and tried to document what I understand of the payload format of meshcore messages.
I am by no means knowlegeable about this format, and this PR is mostly an exercise in Cunningham's Law. I welcome corrections to this PR and will incorporate them.
For the TODOs, I hope that you will be okay with merging these for now, to try to reduce the scope of this PR, as well as to enable others to take a crack at documenting the gaps.