FastArduino  v1.9
C++ library to build fast but small Arduino/AVR projects
serial::UARTErrors Class Reference

Holder of latest UART errors. More...

#include <fastarduino/uart_commons.h>

Inheritance diagram for serial::UARTErrors:

Public Member Functions

void clear_errors ()
 Reset UART errors to no error.
 
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...
 

Detailed Description

Holder of latest UART errors.

Used as public interface to check what errors occurred lately on UATX/UARX/UART devices.

Definition at line 95 of file uart_commons.h.

Member Function Documentation

◆ has_errors()

uint8_t serial::UARTErrors::has_errors ( ) const
inline

Indicate if there are UART errors pending.

Return values
trueif some errors are pending; other methods will indicate the exact error(s).
falseif no error is pending

Definition at line 118 of file uart_commons.h.

◆ frame_error()

bool serial::UARTErrors::frame_error ( ) const
inline

Indicate if a frame error has occurred.

Return values
trueif a frame error has occurred
falseif no frame error has occurred

Definition at line 128 of file uart_commons.h.

◆ data_overrun()

bool serial::UARTErrors::data_overrun ( ) const
inline

Indicate if a data overrun has occurred.

Return values
trueif a data overrun has occurred
falseif no data overrun has occurred

Definition at line 138 of file uart_commons.h.

◆ queue_overflow()

bool serial::UARTErrors::queue_overflow ( ) const
inline

Indicate if a queue overflow has occurred.

Return values
trueif a queue overflow has occurred
falseif no queue overflow has occurred

Definition at line 148 of file uart_commons.h.

◆ parity_error()

bool serial::UARTErrors::parity_error ( ) const
inline

Indicate if a parity error has occurred.

Return values
trueif a parity error has occurred
falseif no parity error has occurred

Definition at line 158 of file uart_commons.h.


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