Create packet_structure.md #80
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
As mentioned by @mofosyne at issue meshcore-dev#72
Comment on lines
+1
to
+9
| # Packet Structure | ||
|
|
||
| | Field | Size (bytes) | Description | | ||
| |--------------|------------------------|-------------| | ||
| | `header` | 1 | Contains routing type, payload type, and payload version. | | ||
| | `payload_len` | 2 | Length of the payload in bytes. | | ||
| | `path_len` | 2 | Length of the path field in bytes. | | ||
| | `path` | `MAX_PATH_SIZE` | Stores the routing path if applicable. | | ||
| | `payload` | `MAX_PACKET_PAYLOAD` | The actual data being transmitted. | |
There was a problem hiding this comment.
This is not correct. The actual over the air format is:
| Field | Size (bytes) | Description |
|---|---|---|
header |
1 | Contains routing type, payload type, and payload version. |
path_len |
1 (uint8) | Length of the path field in bytes. |
path |
MAX_PATH_SIZE |
Stores the routing path if applicable. |
payload |
MAX_PACKET_PAYLOAD |
The actual data being transmitted. |
See packet serialization here:
https://github.com/ripplebiz/MeshCore/blob/main/src/Packet.cpp#L24-L31
Contributor
|
Can we get this PR to a mergeable state @tbb98 ? It looks like you could just incorporate the feedback directly and then we’re done. I’d do it myself but I don’t want to take undeserved credit for your work |
Contributor
Author
|
Hello @mattsains ! Sorry, I don't have much time for this at the moment. We rolling open source, I don't care about the credit, only the end product, so I'd be really happy if you do it! :) |
|
Thanks for the correction to the packet structure @mattsains in 9d53fc2 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
As mentioned by @mofosyne at issue #72