swaits
a031c6e266
Rewrites lingering github.com / *.sr.ht references to this Gitea instance, translating GitHub and Sourcehut URL shapes to Gitea's (/blob/<ref>/ and sr.ht /tree/<ref>/item/ -> /src/branch/<ref>/, /tree/<tag> -> /src/tag/<tag>, /actions/workflows/X -> /actions?workflow=X, /edit/ -> /_edit/). Left pointing at the old hosts on purpose: pull-request links (PRs were not migrated), forks that were never migrated, and GitHub-only surfaces Gitea lacks. OpenPGP identity proofs are untouched by design.
50 lines
1.3 KiB
Markdown
50 lines
1.3 KiB
Markdown
# MeshCore Protocol Specification
|
|
|
|
## Section 13: Payload — Raw Custom
|
|
|
|
### Overview
|
|
|
|
The RAW_CUSTOM payload carries application-defined raw bytes with no prescribed
|
|
structure. It is intended for applications that implement their own encryption,
|
|
framing, or payload formats on top of the MeshCore transport.
|
|
|
|
### Payload Type
|
|
|
|
Header payload type field: `0x0F` (RAW_CUSTOM)
|
|
|
|
### Wire Format
|
|
|
|
```
|
|
0
|
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
|
| Raw Data (1-184 bytes) |
|
|
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|
|
```
|
|
|
|
### Fields
|
|
|
|
| Field | Offset | Size | Type | Description |
|
|
|-------|--------|------|------|-------------|
|
|
| data | 0 | 1-184 bytes | raw | Application-defined payload |
|
|
|
|
### Routing
|
|
|
|
In the current reference implementation, RAW_CUSTOM packets are only processed
|
|
when received via direct routing. They are NOT flood-routed.
|
|
|
|
### Constraints
|
|
|
|
- Payload MUST be at least 1 byte.
|
|
- Maximum payload: 184 bytes (MAX_PACKET_PAYLOAD).
|
|
- Maximum total data: limited by `sizeof(Packet::payload)` which is
|
|
MAX_PACKET_PAYLOAD (184).
|
|
|
|
### Cross-References
|
|
|
|
- Test vectors: [`corpus/payloads/raw-custom/`](https://git.swaits.com/swaits/meshcore-spec/src/branch/main/versions/v0.1.0/corpus/payloads/raw-custom/)
|
|
|
|
### Reference Implementation
|
|
|
|
- `Mesh::createRawData()` in `src/Mesh.cpp` — Encoding
|
|
- `Mesh::onRecvPacket()`, case `PAYLOAD_TYPE_RAW_CUSTOM` — Processing (direct only)
|