View Source Circuits.UART.Framing.FourByte (circuits_uart v1.5.2)

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.

Summary

Functions

add_framing(data, rx_buffer)

Callback implementation for Circuits.UART.Framing.add_framing/2.

flush(atom, rx_buffer)

Callback implementation for Circuits.UART.Framing.flush/2.

frame_timeout(rx_buffer)

Callback implementation for Circuits.UART.Framing.frame_timeout/1.

init(args)

Callback implementation for Circuits.UART.Framing.init/1.

remove_framing(data, rx_buffer)

Callback implementation for Circuits.UART.Framing.remove_framing/2.

Functions

Link to this function

add_framing(data, rx_buffer)

View Source

Callback implementation for Circuits.UART.Framing.add_framing/2.

Link to this function

flush(atom, rx_buffer)

View Source

Callback implementation for Circuits.UART.Framing.flush/2.

Link to this function

frame_timeout(rx_buffer)

View Source

Callback implementation for Circuits.UART.Framing.frame_timeout/1.

Link to this function

init(args)

View Source

Callback implementation for Circuits.UART.Framing.init/1.

Link to this function

remove_framing(data, rx_buffer)

View Source

Callback implementation for Circuits.UART.Framing.remove_framing/2.