View Source API Reference circuits_uart v1.5.2

Find and use UARTs, serial ports, and more.

A behaviour for implementing framers for data received over a UART.

Each message is 4 bytes. This framer doesn't do anything for the transmit direction, but for receives, it will collect bytes in batches of 4 before sending them up. The user can set up a framer timeout if they don't mind partial frames. This can be useful to resyncronize when bytes are dropped.

Each message is one line. This framer appends and removes newline sequences as part of the framing. Buffering is performed internally, so users can get the complete messages under normal circumstances. Attention should be paid to the following

Don't apply or removing any framing.