mirror
/
MeshCore
mirror of https://github.com/meshcore-dev/MeshCore
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

* updates to packet/payload structure docs

pull/535/head
Scott Powell 11 months ago
parent
e9a8fcb1cd
commit
855e4831f5
2 changed files with 34 additions and 30 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 14
      docs/packet_structure.md
  2. 50
      docs/payloads.md

14
docs/packet_structure.md
View File

@ -1,11 +1,12 @@
# Packet Structure # Packet Structure
| Field | Size (bytes) | Description | | Field | Size (bytes) | Description |
|----------|----------------------------------|-----------------------------------------------------------| |-----------------|----------------------------------|-----------------------------------------------------------|
| header | 1 | Contains routing type, payload type, and payload version. | | header | 1 | Contains routing type, payload type, and payload version. |
| path_len | 1 | Length of the path field in bytes. | | transport_codes | 4 (optional) | 2x 16-bit transport codes (if ROUTE_TYPE_TRANSPORT_*) |
| path | up to 64 (`MAX_PATH_SIZE`) | Stores the routing path if applicable. | | path_len | 1 | Length of the path field in bytes. |
| payload | up to 184 (`MAX_PACKET_PAYLOAD`) | The actual data being transmitted. | | path | up to 64 (`MAX_PATH_SIZE`) | Stores the routing path if applicable. |
| payload | up to 184 (`MAX_PACKET_PAYLOAD`) | The actual data being transmitted. |
Note: see the [payloads doc](./payloads.md) for more information about the content of payload. Note: see the [payloads doc](./payloads.md) for more information about the content of payload.
@ -42,6 +43,7 @@ bit 0 means the lowest bit (1s place)
| `0x07` | `PAYLOAD_TYPE_ANON_REQ` | Anonymous request. | | `0x07` | `PAYLOAD_TYPE_ANON_REQ` | Anonymous request. |
| `0x08` | `PAYLOAD_TYPE_PATH` | Returned path. | | `0x08` | `PAYLOAD_TYPE_PATH` | Returned path. |
| `0x09` | `PAYLOAD_TYPE_TRACE` | trace a path, collecting SNI for each hop. | | `0x09` | `PAYLOAD_TYPE_TRACE` | trace a path, collecting SNI for each hop. |
| `0x0A` | `PAYLOAD_TYPE_MULTIPART` | packet is part of a sequence of packets. |
| `0x0F` | `PAYLOAD_TYPE_RAW_CUSTOM` | Custom packet (raw bytes, custom encryption). | | `0x0F` | `PAYLOAD_TYPE_RAW_CUSTOM` | Custom packet (raw bytes, custom encryption). |
## Payload Version Values ## Payload Version Values

50
docs/payloads.md
View File

@ -10,13 +10,16 @@ Inside of each [meshcore packet](./packet_structure.md) is a payload, identified
* Anonymous request. * Anonymous request.
* Group text message (unverified). * Group text message (unverified).
* Group datagram (unverified). * Group datagram (unverified).
* Multi-part packet
* Custom packet (raw bytes, custom encryption). * Custom packet (raw bytes, custom encryption).
This document defines the structure of each of these payload types This document defines the structure of each of these payload types.
NOTE: all 16 and 32-bit integer fields are Little Endian.
## Important concepts: ## Important concepts:
* Node/channel hash: the first byte of the node or channel's public key * Node hash: the first byte of the node's public key
# Node advertisement # Node advertisement
This kind of payload notifies receivers that a node exists, and gives information about the node This kind of payload notifies receivers that a node exists, and gives information about the node
@ -33,10 +36,10 @@ Appdata
| Field | Size (bytes) | Description | | Field | Size (bytes) | Description |
|---------------|-----------------|-------------------------------------------------------| |---------------|-----------------|-------------------------------------------------------|
| flags | 1 | specifies which of the fields are present, see below | | flags | 1 | specifies which of the fields are present, see below |
| latitude | 4 | decimal latitude multiplied by 1000000, integer | | latitude | 4 (optional) | decimal latitude multiplied by 1000000, integer |
| longitude | 4 | decimal longitude multiplied by 1000000, integer | | longitude | 4 (optional) | decimal longitude multiplied by 1000000, integer |
| feature 1 | 2 | reserved for future use | | feature 1 | 2 (optional) | reserved for future use |
| feature 2 | 2 | reserved for future use | | feature 2 | 2 (optional) | reserved for future use |
| name | rest of appdata | name of the node | | name | rest of appdata | name of the node |
Appdata Flags Appdata Flags
@ -46,6 +49,7 @@ Appdata Flags
| `0x01` | is chat node | advert is for a chat node | | `0x01` | is chat node | advert is for a chat node |
| `0x02` | is repeater | advert is for a repeater | | `0x02` | is repeater | advert is for a repeater |
| `0x03` | is room server | advert is for a room server | | `0x03` | is room server | advert is for a room server |
| `0x04` | is sensor | advert is for a sensor server |
| `0x10` | has location | appdata contains lat/long information | | `0x10` | has location | appdata contains lat/long information |
| `0x20` | has feature 1 | Reserved for future use. | | `0x20` | has feature 1 | Reserved for future use. |
| `0x40` | has feature 2 | Reserved for future use. | | `0x40` | has feature 2 | Reserved for future use. |
@ -92,13 +96,15 @@ Returned path messages provide a description of the route a packet took from the
Request type Request type
| Value | Name | Description | | Value | Name | Description |
|--------|--------------------|---------------------------------------| |--------|----------------------|---------------------------------------|
| `0x01` | get status | get status of repeater or room server | | `0x01` | get stats | get stats of repeater or room server |
| `0x02` | keepalive | TODO | | `0x02` | keepalive | (deprecated) |
| `0x03` | get telemetry data | TODO | | `0x03` | get telemetry data | TODO |
| `0x04` | get min,max,avg data | sensor nodes - get min, max, average for given time span |
| `0x05` | get access list | get node's approved access list |
### Get status ### Get stats
Gets information about the node, possibly including the following: Gets information about the node, possibly including the following:
@ -121,10 +127,6 @@ Gets information about the node, possibly including the following:
* Number posted (?) * Number posted (?)
* Number of post pushes (?) * Number of post pushes (?)
### Keepalive
No-op request.
### Get telemetry data ### Get telemetry data
Request data about sensors on the node, including battery level. Request data about sensors on the node, including battery level.
@ -138,11 +140,11 @@ Request data about sensors on the node, including battery level.
## Plain text message ## Plain text message
| Field | Size (bytes) | Description | | Field | Size (bytes) | Description |
|--------------|-----------------|--------------------------------------------------------------| |-----------------|-----------------|--------------------------------------------------------------|
| timestamp | 4 | send time (unix timestamp) | | timestamp | 4 | send time (unix timestamp) |
| flags + TODO | 1 | first six bits are flags (see below), last two bits are TODO | | flags + attempt | 1 | upper six bits are flags (see below), lower two bits are attempt number (0..3) |
| message | rest of payload | the message content, see next table | | message | rest of payload | the message content, see next table |
Flags Flags
@ -150,7 +152,7 @@ Flags
|--------|---------------------------|------------------------------------------------------------| |--------|---------------------------|------------------------------------------------------------|
| `0x00` | plain text message | the plain text of the message | | `0x00` | plain text message | the plain text of the message |
| `0x01` | CLI command | the command text of the message | | `0x01` | CLI command | the command text of the message |
| `0x02` | signed plain text message | two bytes of sender prefix, followed by plain text message | | `0x02` | signed plain text message | first four bytes is sender pubkey prefix, followed by plain text message |
# Anonymous request # Anonymous request
@ -166,14 +168,14 @@ Plaintext message
| Field | Size (bytes) | Description | | Field | Size (bytes) | Description |
|----------------|-----------------|-------------------------------------------------------------------------------| |----------------|-----------------|-------------------------------------------------------------------------------|
| timestamp | 4 | send time (unix timestamp) | | timestamp | 4 | send time (unix timestamp) |
| sync timestamp | 4 | for room server, otherwise absent: sender's "sync messages SINCE x" timestamp | | sync timestamp | 4 | NOTE: room server only! - sender's "sync messages SINCE x" timestamp |
| password | rest of message | password for repeater/room | | password | rest of message | password for repeater/room |
# Group text message / datagram # Group text message / datagram
| Field | Size (bytes) | Description | | Field | Size (bytes) | Description |
|--------------|-----------------|--------------------------------------------| |--------------|-----------------|--------------------------------------------|
| channel hash | 1 | the first byte of the channel's public key | | channel hash | 1 | first byte of SHA256 of channel's shared key |
| cipher MAC | 2 | MAC for encrypted data in next field | | cipher MAC | 2 | MAC for encrypted data in next field |
| ciphertext | rest of payload | encrypted message, see below for details | | ciphertext | rest of payload | encrypted message, see below for details |

Write Preview
Loading…
Cancel
Save