Expand description
Narrative documentation: tutorials, design notes and protocol tables.
These modules contain no code; they exist so the chapters render as part of the API documentation (and so their examples are compiled and run as doctests).
| Chapter | Read this if you want to… |
|---|---|
| Getting started | get a node online and exchange an event in five minutes |
| Architecture | understand the sans-IO design and wire it to tokio, a browser or a microcontroller |
| Writing a throttle | find, acquire, drive and release a train |
| Events | build a panel or sensor that produces and consumes events |
| The hub | run rolcb-hub or embed the hub in your own server |
no_std and WASM | use the crate without std |
| Protocol reference | look up MTIs, header bits, flags and codes |
Modules§
- architecture
- Architecture and the sans-IO model
- events
- Consuming and producing events
- getting_
started - Getting started
- hub
- Running and embedding the hub
- no_std
no_stdand WASM- reference
- Protocol reference
- throttle
- Writing a throttle