Add protocol reference document

Covers all layers: TCP → transport frame → message type dispatcher →
payload schemas. Documents frame format (6-byte header), all message
types, STREAM_OPEN/CLOSE lifecycle, codec/pixel_format/origin tables,
stream events, and discovery announcement wire format.

Also fixes stale channel_id reference in audio section of architecture.md.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
2026-03-26 22:03:02 +00:00
parent 197ab7d5db
commit 57e46af57b
3 changed files with 265 additions and 2 deletions

View File

@@ -7,6 +7,7 @@ Designed to run on resource-constrained hardware (Raspberry Pi capturing raw MJP
## Documentation
- [architecture.md](architecture.md) — system design: graph model, transport protocol, relay design, codec layer, discovery, multi-site plan, device resilience, X11 integration
- [docs/protocol.md](docs/protocol.md) — wire protocol reference: frame format, all message types, payload schemas, stream lifecycle, discovery
- [planning.md](planning.md) — module build order and current status
- [conventions.md](conventions.md) — C code and project conventions