APM:Libraries
Public Member Functions | List of all members
Empty::UARTDriver Class Reference

#include <UARTDriver.h>

Inheritance diagram for Empty::UARTDriver:
[legend]
Collaboration diagram for Empty::UARTDriver:
[legend]

Public Member Functions

 UARTDriver ()
 
void begin (uint32_t b)
 
void begin (uint32_t b, uint16_t rxS, uint16_t txS)
 
void end ()
 
void flush ()
 
bool is_initialized ()
 
void set_blocking_writes (bool blocking)
 
bool tx_pending ()
 
uint32_t available () override
 
uint32_t txspace () override
 
int16_t read () override
 
size_t write (uint8_t c)
 
size_t write (const uint8_t *buffer, size_t size)
 
- Public Member Functions inherited from AP_HAL::UARTDriver
 UARTDriver ()
 
virtual bool lock_port (uint32_t key)
 
virtual size_t write_locked (const uint8_t *buffer, size_t size, uint32_t key)
 
virtual void set_flow_control (enum flow_control flow_control_setting)
 
virtual enum flow_control get_flow_control (void)
 
virtual void configure_parity (uint8_t v)
 
virtual void set_stop_bits (int n)
 
virtual bool set_unbuffered_writes (bool on)
 
virtual bool wait_timeout (uint16_t n, uint32_t timeout_ms)
 
virtual void _timer_tick (void)
 
virtual uint64_t receive_time_constraint_us (uint16_t nbytes)
 
- Public Member Functions inherited from AP_HAL::BetterStream
virtual void printf (const char *,...) FMT_PRINTF(2
 
virtual void virtual void vprintf (const char *, va_list)
 
void print (const char *str)
 
void println (const char *str)
 
size_t write (const char *str)
 

Additional Inherited Members

- Public Types inherited from AP_HAL::UARTDriver
enum  flow_control { FLOW_CONTROL_DISABLE =0, FLOW_CONTROL_ENABLE =1, FLOW_CONTROL_AUTO =2 }
 

Detailed Description

Definition at line 5 of file UARTDriver.h.

Constructor & Destructor Documentation

◆ UARTDriver()

UARTDriver::UARTDriver ( )

Definition at line 6 of file UARTDriver.cpp.

Member Function Documentation

◆ available()

uint32_t UARTDriver::available ( void  )
overridevirtual

Implements AP_HAL::BetterStream.

Definition at line 17 of file UARTDriver.cpp.

◆ begin() [1/2]

void UARTDriver::begin ( uint32_t  b)
virtual

Implements AP_HAL::UARTDriver.

Definition at line 8 of file UARTDriver.cpp.

◆ begin() [2/2]

void UARTDriver::begin ( uint32_t  baud,
uint16_t  rxSpace,
uint16_t  txSpace 
)
virtual

Extended port open method

Allows for both opening with specified buffer sizes, and re-opening to adjust a subset of the port's settings.

Note
Buffer sizes greater than ::_max_buffer_size will be rounded down.
Parameters
baudSelects the speed that the port will be configured to. If zero, the port speed is left unchanged.
rxSpaceSets the receive buffer size for the port. If zero then the buffer size is left unchanged if the port is open, or set to ::_default_rx_buffer_size if it is currently closed.
txSpaceSets the transmit buffer size for the port. If zero then the buffer size is left unchanged if the port is open, or set to ::_default_tx_buffer_size if it is currently closed.

Implements AP_HAL::UARTDriver.

Definition at line 9 of file UARTDriver.cpp.

◆ end()

void UARTDriver::end ( )
virtual

Implements AP_HAL::UARTDriver.

Definition at line 10 of file UARTDriver.cpp.

◆ flush()

void UARTDriver::flush ( void  )
virtual

Implements AP_HAL::UARTDriver.

Definition at line 11 of file UARTDriver.cpp.

◆ is_initialized()

bool UARTDriver::is_initialized ( )
virtual

Implements AP_HAL::UARTDriver.

Definition at line 12 of file UARTDriver.cpp.

◆ read()

int16_t UARTDriver::read ( void  )
overridevirtual

Implements AP_HAL::BetterStream.

Definition at line 19 of file UARTDriver.cpp.

◆ set_blocking_writes()

void UARTDriver::set_blocking_writes ( bool  blocking)
virtual

Implements AP_HAL::UARTDriver.

Definition at line 13 of file UARTDriver.cpp.

◆ tx_pending()

bool UARTDriver::tx_pending ( )
virtual

Implements AP_HAL::UARTDriver.

Definition at line 14 of file UARTDriver.cpp.

◆ txspace()

uint32_t UARTDriver::txspace ( void  )
overridevirtual

Implements AP_HAL::BetterStream.

Definition at line 18 of file UARTDriver.cpp.

◆ write() [1/2]

size_t UARTDriver::write ( uint8_t  c)
virtual

Implements AP_HAL::BetterStream.

Definition at line 22 of file UARTDriver.cpp.

Referenced by write().

Here is the caller graph for this function:

◆ write() [2/2]

size_t UARTDriver::write ( const uint8_t *  buffer,
size_t  size 
)
virtual

Reimplemented from AP_HAL::BetterStream.

Definition at line 24 of file UARTDriver.cpp.

Here is the call graph for this function:

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