Group baton¶
Public API of the Baton bus library. More...
Modules¶
| Type | Name |
|---|---|
| module | Configuration Build-time configuration for Baton. |
| module | Definitions Frame layout, frame types, payload prefixes and byte-order helpers. |
| module | Link Byte-level half-duplex link between the UART and the node layer. |
| module | Node One bus node (master or slave) on top of the Link . |
| module | Codec CRC-16, incremental stream parser and frame encoder. |
| module | Event queue Byte ring of variable-size event records, used by Node . |
Macros¶
| Type | Name |
|---|---|
| define | BATON_VERSION "1.0.0"Version string "MAJOR.MINOR.PATCH". |
| define | BATON_VERSION_MAJOR 1 |
| define | BATON_VERSION_MINOR 0 |
| define | BATON_VERSION_PATCH 0 |
Detailed Description¶
This module groups the public interface and its supporting submodules: Configuration, Definitions, Codec, Link, Event queue and Node.
Include this single header to use the library: * baton_config.h build-time sizes and the application message lists * baton_defs.h frame layout, frame types, control-byte and byte-order helpers * baton_protocol.h CRC-16, incremental parser, encoder * baton_link.h half-duplex link: receive ring, parser timeout, transmitter * baton_queue.h event queue (used by the node) * baton_node.h master/slave node: events, states, schedule
Macro Definition Documentation¶
define BATON_VERSION¶
Version string "MAJOR.MINOR.PATCH".