serial::hard::UATX< USART_ > Class Template Reference

Hardware serial transmitter API. More...

#include <fastarduino/uart.h>

Inheritance diagram for serial::hard::UATX< USART_ >:

Collaboration diagram for serial::hard::UATX< USART_ >:

Public Member Functions
template<uint8_t SIZE_TX>
	UATX (char(&output)[SIZE_TX])
	Construct a new hardware serial transmitter and provide it with a buffer for interrupt-based transmission. More...
void	begin (uint32_t rate, Parity parity=Parity::NONE, StopBits stop_bits=StopBits::ONE)
	Enable the transmitter. More...
void	end (BufferHandling buffer_handling=BufferHandling::KEEP)
	Stop all transmissions. More...
Public Member Functions inherited from serial::UARTErrors
void	clear_errors ()
	Reset UART errors to no error. More...
uint8_t	has_errors () const
	Indicate if there are UART errors pending. More...
bool	frame_error () const
	Indicate if a frame error has occurred. More...
bool	data_overrun () const
	Indicate if a data overrun has occurred. More...
bool	queue_overflow () const
	Indicate if a queue overflow has occurred. More...
bool	parity_error () const
	Indicate if a parity error has occurred. More...

Static Public Attributes
static constexpr const board::USART	USART = USART_
	The hardware board::USART used by this UATX. More...

Friends
struct	isr_handler

Detailed Description

template<board::USART USART_>
class serial::hard::UATX< USART_ >

Hardware serial transmitter API.

For this API to be fully functional, you must register the right ISR in your program, through REGISTER_UATX_ISR(). You must also register this class as a streams::ostreambuf callback listener through REGISTER_OSTREAMBUF_LISTENERS().

Template Parameters

USART_

the hardware board::USART to use

See also

REGISTER_UATX_ISR()

REGISTER_OSTREAMBUF_LISTENERS()

Definition at line 240 of file uart.h.

Constructor & Destructor Documentation

UATX()

template<board::USART USART_>

template<uint8_t SIZE_TX>

serial::hard::UATX< USART_ >::UATX ( char(&)  output[SIZE_TX] )

inlineexplicit

Construct a new hardware serial transmitter and provide it with a buffer for interrupt-based transmission.

Parameters

output

an array of characters used by this transmitter to buffer output during transmission so that write methods are not blocking.

See also

REGISTER_UATX_ISR()

Definition at line 254 of file uart.h.

Member Function Documentation

begin()

template<board::USART USART_>

void serial::hard::UATX< USART_ >::begin ( uint32_t  rate, Parity  parity = Parity::NONE, StopBits  stop_bits = StopBits::ONE  )

inline

Enable the transmitter.

This is needed before any transmission can take place. Once called, it is possible to push content to out(), which will be then transmitted through the serial connection.

Parameters

rate	the transmission rate in bits per second (bps)
parity	the kind of parity check used by transmission
stop_bits	the number of stop bits used by transmission

Definition at line 269 of file uart.h.

end()

template<board::USART USART_>

void serial::hard::UATX< USART_ >::end ( BufferHandling  buffer_handling = BufferHandling::KEEP )

inline

Stop all transmissions.

Once called, it is possible to re-enable transmission again by calling begin().

Parameters

buffer_handling

how to handle output buffer before ending transmissions

See also

BufferHandling

Definition at line 282 of file uart.h.

Friends And Related Function Documentation

isr_handler

template<board::USART USART_>

friend struct isr_handler

friend

Definition at line 301 of file uart.h.

Member Data Documentation

USART

template<board::USART USART_>

constexpr const board::USART serial::hard::UATX< USART_ >::USART = USART_

staticconstexpr

The hardware board::USART used by this UATX.

Definition at line 244 of file uart.h.

---

The documentation for this class was generated from the following file:

• fastarduino/uart.h