Reference#
This section holds the Dictionary, the generated registry tables, the channel catalog reference and the channel grid.
| Page | Contains |
|---|---|
| The Dictionary | Defined terms and their definitions |
| Registry reference | Every wire number, generated from registry.yaml |
| Channel catalog | What a real device's catalog looks like, entry by entry |
| Channel grid | The 0xCDSS channel numbering convention: class, domain, family, and member |
Generated registry pages#
The registry pages are generated from registry.yaml by gen_docs_tables.py.
Where a generated table and prose disagree, the table is correct and the prose
has a defect. CI fails the build when a generated table is out of date.
Dictionary tooltips#
A term defined in the Dictionary shows its definition on hover wherever it
appears on this site. The tooltips and the Dictionary page are both
generated from dictionary.yaml. The generator refuses two definitions for one
written form.
Quick lookups#
- Frame types: every
typebyte - NACK codes: every refusal reason
- Limits and defaults: sizes, rates and timeouts
- CBOR keys: every integer key