F4Light::UART_PPM Class Reference

#include <UART_PPM.h>

Inheritance diagram for F4Light::UART_PPM:

Collaboration diagram for F4Light::UART_PPM:

Public Member Functions
	UART_PPM (uint8_t n)
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
int16_t	read () override
uint32_t	txspace () 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)

Static Public Member Functions
static void	putch (uint8_t c, uint8_t n)

Private Attributes
bool	_initialized
bool	_blocking
uint8_t	_id

Static Private Attributes
static ring_buffer ppm_rxrb [2]	IN_CCM
static uint8_t rx_buf [2][USART_PPM_BUF_SIZE]	IN_CCM

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 16 of file UART_PPM.h.

Constructor & Destructor Documentation

UART_PPM()

UART_PPM::UART_PPM

(

uint8_t

n

)

Definition at line 29 of file UART_PPM.cpp.

Here is the call graph for this function:

Member Function Documentation

available()

uint32_t UART_PPM::available ( void  )

overridevirtual

Implements AP_HAL::BetterStream.

Definition at line 44 of file UART_PPM.cpp.

Referenced by read(), and tx_pending().

Here is the call graph for this function:

Here is the caller graph for this function:

begin() [1/2]

void UART_PPM::begin ( uint32_t  b )

virtual

Implements AP_HAL::UARTDriver.

Definition at line 37 of file UART_PPM.cpp.

begin() [2/2]

void F4Light::UART_PPM::begin ( uint32_t  baud, uint16_t  rxSpace, uint16_t  txSpace  )

inlinevirtual

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

baud	Selects the speed that the port will be configured to. If zero, the port speed is left unchanged.
rxSpace	Sets 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.
txSpace	Sets 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 22 of file UART_PPM.h.

Referenced by begin().

Here is the call graph for this function:

Here is the caller graph for this function:

end()

void F4Light::UART_PPM::end ( )

inlinevirtual

Implements AP_HAL::UARTDriver.

Definition at line 23 of file UART_PPM.h.

flush()

void F4Light::UART_PPM::flush ( void  )

inlinevirtual

Implements AP_HAL::UARTDriver.

Definition at line 24 of file UART_PPM.h.

is_initialized()

bool F4Light::UART_PPM::is_initialized ( )

inlinevirtual

Implements AP_HAL::UARTDriver.

Definition at line 25 of file UART_PPM.h.

putch()

void UART_PPM::putch ( uint8_t  c, uint8_t  n  )

static

Definition at line 53 of file UART_PPM.cpp.

Referenced by F4Light::PPM_parser::_process_dsm_pulse(), and write().

Here is the call graph for this function:

Here is the caller graph for this function:

read()

int16_t UART_PPM::read ( void  )

overridevirtual

Implements AP_HAL::BetterStream.

Definition at line 48 of file UART_PPM.cpp.

Referenced by tx_pending().

Here is the call graph for this function:

Here is the caller graph for this function:

set_blocking_writes()

void F4Light::UART_PPM::set_blocking_writes ( bool  blocking )

inlinevirtual

Implements AP_HAL::UARTDriver.

Definition at line 27 of file UART_PPM.h.

tx_pending()

bool F4Light::UART_PPM::tx_pending ( )

inlinevirtual

Implements AP_HAL::UARTDriver.

Definition at line 29 of file UART_PPM.h.

Here is the call graph for this function:

txspace()

uint32_t F4Light::UART_PPM::txspace ( void  )

inlineoverridevirtual

Implements AP_HAL::BetterStream.

Definition at line 34 of file UART_PPM.h.

write() [1/2]

size_t F4Light::UART_PPM::write ( uint8_t  c )

inlinevirtual

Implements AP_HAL::BetterStream.

Definition at line 35 of file UART_PPM.h.

write() [2/2]

size_t F4Light::UART_PPM::write ( const uint8_t *  buffer, size_t  size  )

inlinevirtual

Reimplemented from AP_HAL::BetterStream.

Definition at line 36 of file UART_PPM.h.

Here is the call graph for this function:

Member Data Documentation

_blocking

bool F4Light::UART_PPM::_blocking

private

Definition at line 43 of file UART_PPM.h.

Referenced by set_blocking_writes().

_id

uint8_t F4Light::UART_PPM::_id

private

Definition at line 44 of file UART_PPM.h.

Referenced by available(), and read().

_initialized

bool F4Light::UART_PPM::_initialized

private

Definition at line 42 of file UART_PPM.h.

Referenced by begin(), and is_initialized().

IN_CCM [1/2]

ring_buffer ppm_rxrb [2] F4Light::UART_PPM::IN_CCM

staticprivate

Definition at line 46 of file UART_PPM.h.

IN_CCM [2/2]

uint8_t rx_buf [2][USART_PPM_BUF_SIZE] F4Light::UART_PPM::IN_CCM

staticprivate

Definition at line 47 of file UART_PPM.h.

---

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

• libraries/AP_HAL_F4Light/UART_PPM.h
• libraries/AP_HAL_F4Light/UART_PPM.cpp