CRUMBS documentation

One home per fact. Signatures and return codes live in the headers; the wire format lives in protocol.md; everything else links to them.

Start here

  1. Platform Setup ā€” install, build, wire and verify on Arduino IDE, PlatformIO and Linux.
  2. examples/core_usage/arduino/hello_* ā€” two boards talking.
  3. Protocol ā€” what is on the wire.
  4. Create a Family ā€” your own device vocabulary.

Reference

Document Purpose
Protocol Normative: frame, CRC-8, SET_REPLY, when the reply is built, address/type/opcode spaces, discovery probes
Architecture Layers, dispatch order, handler tables, measured memory, HAL differences
API Reference Every public symbol by task, one line each, plus the return-code summary
Create a Family The therm walkthrough: header, generated wrappers, peripheral, controller
Examples Every example in learning order; each directory has its own README
LHWIT Family The reference family: four Nano peripherals and two Linux controllers

Project

Document Purpose
CONTRIBUTING.md Build, test, the documentation gates, style, commits, CI, releasing
Roadmap Deferred directions and what is out of scope
CHANGELOG.md Release history

The in-source Doxygen comments are the API contract; CI fails if a public symbol lacks one or is missing from the API reference, and if any link on these pages breaks.

Table of contents