Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions components/dispatcher/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,20 @@ bookkeeping), the Dispatcher owns the one parser and dispatches by module id.
The `module` byte (0..255) is the routing key — a full byte, so up to 256
protocols can coexist on one stream. The message/transaction `type` and the
request/reply direction (`flags`) travel with the frame and are handed to the
module's handler untouched; the Dispatcher does not interpret them. espp
built-in protocols use, for example:

| Module | Protocol |
|-----------|----------------------|
| 0 | OTA |
| 2 | BLDC haptics |
| 4 | crash dump |
| 5 | CAN bridge |
| 6 | MCP266 |
| 0xF0–0xFF | reserved (meta) |
| 0xFF | capability discovery |
module's handler untouched; the Dispatcher does not interpret them. espp's own
protocols and examples use, for example:

| Module | Protocol |
|-----------|-------------------------------------------------|
| 0 | OTA |
| 1 | Core-dump example crash trigger (example only) |
| 2 | BLDC haptics |
| 3 | Telemetry |
| 4 | crash dump |
| 5 | CAN bridge |
| 6 | MCP266 |
| 0xF0–0xFE | reserved (meta) |
| 0xFF | capability discovery |

A device-side dispatcher registers the modules it serves; frames for an
unregistered module are silently ignored. A protocol's replies use the **same**
Expand Down
Loading
Loading