#include <ESP32_UART.h>

Inheritance diagram for aruna::driver::ESP32_UART:

Collaboration diagram for aruna::driver::ESP32_UART:

Public Member Functions
	ESP32_UART (uart_port_t UART_NUM, int TXD_PIN, int RXD_PIN, int RTS_PIN, int CTS_PIN, uart_config_t UART_CONFIG, uart_mode_t UART_MODE, unsigned int TX_BUF_SIZE, unsigned int RX_BUF_SIZE)
	Create a uart driver with custom settings. More...

	~ESP32_UART ()

uint32_t	get_read_buffer_length () override
	Get amount of bytes in the read buffer. More...

uint32_t	get_baudrate () override
	Get baudrate of UART. More...

flowcontrol_t	get_flowcontrol () override
	get flowcontrol of UART More...

parity_t	get_parity () override
	Get parity of UART. More...

stop_bit_t	get_stop_bit () override
	get stop bit More...

word_length_t	get_word_length () override
	Set UART data bits length. More...

Public Member Functions inherited from aruna::driver::UART
	UART ()
	UART object to write and read data. More...

	~UART ()

size_t	write (uint8_t *data, size_t dataSize)
	Write data to the UART. More...

size_t	try_write (uint8_t *data, size_t dataSize)
	Write data to the UART. More...

size_t	read (uint8_t *buffer, size_t length)
	read data from the UART. More...

size_t	try_read (uint8_t *buffer, size_t length)
	read data from the UART. More...

uint32_t	set_baudrate (uint32_t new_baudrate)
	Set baudrate of the UART. More...

err_t	set_flowcontrol (flowcontrol_t new_flowcontrol)
	Set software or hardware flowcontrol. More...

err_t	set_parity (parity_t parity_bit)
	Set parity bit. More...

err_t	set_stop_bit (stop_bit_t stop_bit)
	set stop bit More...

err_t	set_word_length (word_length_t word_length)
	Set UART data bits length. More...

uint32_t	get_speed () override
	Get speed of link (bits per second) More...

Public Member Functions inherited from aruna::comm::Link
size_t	transmit (uint8_t *package, size_t package_size)
	directly transmit a package on the link. More...

size_t	receive (uint8_t *buffer, size_t buffer_size)
	Read data from the receive buffer. More...

bool	is_connected ()
	Does the link have an active connection with a client? More...

Private Member Functions
size_t	_write (uint8_t *data, size_t dataSize) override
	write data to the link/bus. More...

size_t	_read (uint8_t *buffer, size_t length) override
	Read bytes and out them in the buffer. More...

uint32_t	_set_baudrate (uint32_t new_baudrate) override
	Set baudrate of the UART. More...

err_t	_set_flowcontrol (flowcontrol_t new_flowcontrol) override
	Set software or hardware flowcontrol. More...

err_t	_set_parity (parity_t parity_bit) override
	Set parity bit. More...

err_t	_set_stop_bit (stop_bit_t stop_bit) override
	set stop bit More...

err_t	_set_word_length (word_length_t word_length) override
	Set UART data bits length. More...

Private Attributes
const uart_port_t	UART_NUM

bool	software_flowcontrol = false

QueueHandle_t	uart_queue

Additional Inherited Members
Public Types inherited from aruna::driver::UART
enum	flowcontrol_t { flowcontrol_t::HARDWARE, flowcontrol_t::SOFTWARE, flowcontrol_t::HARDWARE_SOFTWARE, flowcontrol_t::DISABLED, flowcontrol_t::NONE }

enum	parity_t { parity_t::EVEN, parity_t::ODD, parity_t::DISABLED, parity_t::NONE }

enum	stop_bit_t { stop_bit_t::ONE, stop_bit_t::ONE_HALF, stop_bit_t::TWO, stop_bit_t::NONE }

enum	word_length_t { word_length_t::FIVE, word_length_t::SIX, word_length_t::SEVEN, word_length_t::EIGHT, word_length_t::NONE }

Public Attributes inherited from aruna::comm::Link
err_t	startup_error = err_t::NOT_STARTED

Static Protected Attributes inherited from aruna::driver::UART
static const uint8_t	XON = 0x11

static const uint8_t	XOFF = 0x13

Detailed Description

Definition at line 15 of file ESP32_UART.h.

Constructor & Destructor Documentation

◆ ESP32_UART()

aruna::driver::ESP32_UART::ESP32_UART	(	uart_port_t	UART_NUM = `UART_NUM_0`,
		int	TXD_PIN = `UART_PIN_NO_CHANGE`,
		int	RXD_PIN = `UART_PIN_NO_CHANGE`,
		int	RTS_PIN = `UART_PIN_NO_CHANGE`,
		int	CTS_PIN = `UART_PIN_NO_CHANGE`,
		uart_config_t	UART_CONFIG = `(uart_config_t) { .baud_rate = 115200, .data_bits = UART_DATA_8_BITS, .parity = UART_PARITY_DISABLE, .stop_bits = UART_STOP_BITS_1, .flow_ctrl = UART_HW_FLOWCTRL_DISABLE, .rx_flow_ctrl_thresh = 122, .use_ref_tick = false }`,
		uart_mode_t	UART_MODE = `UART_MODE_UART`,
		unsigned int	TX_BUF_SIZE = `256`,
		unsigned int	RX_BUF_SIZE = `512`
	)

Create a uart driver with custom settings.

Parameters

UART_NUM,0,1	or 2
TXD_PIN,configurate	uart pin.
RXD_PIN,configurate	uart pin.
RTS_PIN,configurate	uart pin.
CTS_PIN,configurate	uart pin.
UART_CONFIG,uart_config_t	object
UART_MODE,use	to enable RS485
TX_BUF_SIZE,transmit	buffer
RX_BUF_SIZE,receive	buffer

Definition at line 15 of file ESP32_UART.cpp.

                                                                            {
                                        .baud_rate = 115200,
                                        .data_bits = UART_DATA_8_BITS,
                                        .parity    = UART_PARITY_DISABLE,
                                        .stop_bits = UART_STOP_BITS_1,
                                        .flow_ctrl = UART_HW_FLOWCTRL_DISABLE,
                                        .rx_flow_ctrl_thresh = 122,
                                        .use_ref_tick = false
                                },
                                uart_mode_t UART_MODE = UART_MODE_UART,
                                unsigned int TX_BUF_SIZE = 256,
                                unsigned int RX_BUF_SIZE = 512) : UART_NUM(UART_NUM) {
             //    TODO logging zou moeten worden uitgeschakeld op de target UART.
 
             /* Configure parameters of an UART driver,
              * communication pins and install the driver */
 //        set config
             ESP_ERROR_CHECK(uart_param_config(UART_NUM, &UART_CONFIG));
 //        set pins
             ESP_ERROR_CHECK(uart_set_pin(UART_NUM, TXD_PIN, RXD_PIN, RTS_PIN, CTS_PIN));
 //        install driver (driver can only be installed once, even if you uart_driver_delete is used)
             ESP_ERROR_CHECK(uart_driver_install(UART_NUM, RX_BUF_SIZE, TX_BUF_SIZE, 20, &uart_queue, 0));
 //        Set correct mode
             ESP_ERROR_CHECK(uart_set_mode(UART_NUM, UART_MODE));
         }

◆ ~ESP32_UART()

aruna::driver::ESP32_UART::~ESP32_UART ( )

Definition at line 56 of file ESP32_UART.cpp.

                                 {
             //    TODO flush tx queue
             //  flush rx queue
             xQueueReset(uart_queue);
             ESP_ERROR_CHECK(uart_flush_input(UART_NUM));
 
             /*
             *      new driver cannot be installed even if uart_delete_driver is called.
             *      this causes an issue in driver selection because the winning driver gets restarted
             */
             ESP_ERROR_CHECK(uart_driver_delete(UART_NUM));
         }

Member Function Documentation

◆ _read()

size_t aruna::driver::ESP32_UART::_read	(	uint8_t *	buffer,
		size_t	buffer_size
	)

overrideprivatevirtual

Read bytes and out them in the buffer.

Parameters

buffer	buffer to read
buffer_size	amount of bytes to read

Returns: amount of byte read

Implements aruna::comm::Link.

Definition at line 69 of file ESP32_UART.cpp.

                                                                {
             return uart_read_bytes(this->UART_NUM, buffer, length, 4);
         }

◆ _set_baudrate()

uint32_t aruna::driver::ESP32_UART::_set_baudrate ( uint32_t new_baudrate )

overrideprivatevirtual

Set baudrate of the UART.

Parameters

new_baudrate baudrate to change to.

Returns: new baudrate

Implements aruna::driver::UART.

Definition at line 73 of file ESP32_UART.cpp.

                                                                 {
             ESP_ERROR_CHECK(uart_set_baudrate(UART_NUM, new_baudrate));
             return get_baudrate();
         }

Here is the call graph for this function:

◆ _set_flowcontrol()

err_t aruna::driver::ESP32_UART::_set_flowcontrol ( flowcontrol_t new_flowcontrol )

overrideprivatevirtual

Set software or hardware flowcontrol.

Parameters

new_flowcontrol

Returns: err_t::OK if set correctly

Implements aruna::driver::UART.

Definition at line 78 of file ESP32_UART.cpp.

                                                                             {
             esp_err_t hw, sw;
             err_t err = err_t::OK;
             switch (new_flowcontrol) {
                 case flowcontrol_t::HARDWARE:
                     hw = uart_set_hw_flow_ctrl(UART_NUM, UART_HW_FLOWCTRL_CTS_RTS, 0);
                     sw = uart_set_sw_flow_ctrl(UART_NUM, false, XON, XOFF);
                     software_flowcontrol = false;
                     break;
                 case flowcontrol_t::SOFTWARE:
                     hw = uart_set_hw_flow_ctrl(UART_NUM, UART_HW_FLOWCTRL_DISABLE, 0);
                     sw = uart_set_sw_flow_ctrl(UART_NUM, true, XON, XOFF);
                     software_flowcontrol = true;
                     break;
                 case flowcontrol_t::HARDWARE_SOFTWARE:
                     hw = uart_set_hw_flow_ctrl(UART_NUM, UART_HW_FLOWCTRL_CTS_RTS, 0);
                     sw = uart_set_sw_flow_ctrl(UART_NUM, true, XON, XOFF);
                     software_flowcontrol = true;
                     break;
                 case flowcontrol_t::NONE:
                 case flowcontrol_t::DISABLED:
                 default:
                     hw = uart_set_hw_flow_ctrl(UART_NUM, UART_HW_FLOWCTRL_DISABLE, 0);
                     sw = uart_set_sw_flow_ctrl(UART_NUM, false, XON, XOFF);
                     software_flowcontrol = false;
                     break;
             }
             err = hw || sw ? err_t::FAIL : err_t::OK;
 
             return err;
         }

◆ _set_parity()

err_t aruna::driver::ESP32_UART::_set_parity ( parity_t parity_bit )

overrideprivatevirtual

Set parity bit.

Parameters

parity_bit EVEN, UNEVEN or DISABLED

Returns: err_t::OK if no errors.

Implements aruna::driver::UART.

Definition at line 110 of file ESP32_UART.cpp.

                                                              {
             uart_parity_t esp_parity;
             switch (parity_bit) {
                 case parity_t::EVEN:
                     esp_parity = UART_PARITY_EVEN;
                     break;
                 case parity_t::ODD:
                     esp_parity = UART_PARITY_ODD;
                     break;
                 case parity_t::DISABLED:
                 default:
                     esp_parity = UART_PARITY_DISABLE;
                     break;
             }
             if (uart_set_parity(UART_NUM, esp_parity))
                 return err_t::INVALID_PARAMETERS;
             else
                 return err_t::OK;
         }

◆ _set_stop_bit()

err_t aruna::driver::ESP32_UART::_set_stop_bit ( stop_bit_t stop_bit )

overrideprivatevirtual

set stop bit

Parameters

stop_bit 1 1.5 or 2 bits

Returns: err_t::OK if no errors

Implements aruna::driver::UART.

Definition at line 130 of file ESP32_UART.cpp.

                                                                {
 //            TODO maak een map of bimap
 //https://stackoverflow.com/questions/21760343/is-there-a-more-efficient-implementation-for-a-bidirectional-map
             uart_stop_bits_t esp_stop;
             switch (stop_bit) {
                 case stop_bit_t::ONE_HALF:
                     esp_stop = UART_STOP_BITS_1_5;
                     break;
                 case stop_bit_t::TWO:
                     esp_stop = UART_STOP_BITS_2;
                     break;
                 case stop_bit_t::ONE:
                 default:
                     esp_stop = UART_STOP_BITS_1;
                     break;
 
             }
             if (uart_set_stop_bits(UART_NUM, esp_stop))
                 return err_t::FAIL;
             else
                 return err_t::OK;
         }

◆ _set_word_length()

err_t aruna::driver::ESP32_UART::_set_word_length ( word_length_t word_length )

overrideprivatevirtual

Set UART data bits length.

Parameters

word_length five to eight bits

Returns: err_t::OK if success.

Implements aruna::driver::UART.

Definition at line 252 of file ESP32_UART.cpp.

                                                                         {
             uart_word_length_t esp_word;
             switch (word_length) {
                 case word_length_t::FIVE:
                     esp_word = UART_DATA_5_BITS;
                     break;
                 case word_length_t::SIX:
                     esp_word = UART_DATA_6_BITS;
                     break;
                 case word_length_t::SEVEN:
                     esp_word = UART_DATA_7_BITS;
                     break;
                 case word_length_t::EIGHT:
                 default:
                     esp_word = UART_DATA_8_BITS;
                     break;
             }
             esp_err_t esp_err = uart_set_word_length(UART_NUM, esp_word);
             err_t err;
             err = esp_err ? err_t::FAIL : err_t::OK;
             return err;
         }

◆ _write()

size_t aruna::driver::ESP32_UART::_write	(	uint8_t *	data,
		size_t	data_size
	)

overrideprivatevirtual

write data to the link/bus.

Parameters

data	bytes to write
data_size	length of data

Returns: amount of bytes written.

Implements aruna::comm::Link.

Definition at line 46 of file ESP32_UART.cpp.

                                                                 {
             return uart_write_bytes(UART_NUM, (const char *) data, dataSize);
         }

◆ get_baudrate()

unsigned int aruna::driver::ESP32_UART::get_baudrate ( )

overridevirtual

Get baudrate of UART.

Returns: baudrate

Reimplemented from aruna::driver::UART.

Definition at line 50 of file ESP32_UART.cpp.

                                               {
             uint32_t br = 0;
             uart_get_baudrate(UART_NUM, &br);
             return br;
         }

Here is the caller graph for this function:

◆ get_flowcontrol()

UART::flowcontrol_t aruna::driver::ESP32_UART::get_flowcontrol ( )

overridevirtual

get flowcontrol of UART

Returns: flowcontrol

Reimplemented from aruna::driver::UART.

Definition at line 159 of file ESP32_UART.cpp.

                                                       {
             uart_hw_flowcontrol_t esp_hw;
             flowcontrol_t aruna_fc;
             ESP_ERROR_CHECK(uart_get_hw_flow_ctrl(UART_NUM, &esp_hw));
             switch (esp_hw) {
                 case UART_HW_FLOWCTRL_DISABLE:
                     aruna_fc = flowcontrol_t::DISABLED;
                     break;
                 case UART_HW_FLOWCTRL_RTS:
                 case UART_HW_FLOWCTRL_CTS:
                 case UART_HW_FLOWCTRL_CTS_RTS:
                     aruna_fc = flowcontrol_t::HARDWARE;
                     break;
                 case UART_HW_FLOWCTRL_MAX:
                 default:
                     aruna_fc = flowcontrol_t::NONE;
                     break;
             }
             if (software_flowcontrol && aruna_fc == flowcontrol_t::HARDWARE)
                 aruna_fc = flowcontrol_t::HARDWARE_SOFTWARE;
             else if (software_flowcontrol)
                 aruna_fc = flowcontrol_t::SOFTWARE;
 
             return aruna_fc;
         }

◆ get_parity()

UART::parity_t aruna::driver::ESP32_UART::get_parity ( )

overridevirtual

Get parity of UART.

Returns: parity bit setting.

Reimplemented from aruna::driver::UART.

Definition at line 185 of file ESP32_UART.cpp.

                                             {
             uart_parity_t esp_parity;
             parity_t aruna_parity;
             ESP_ERROR_CHECK(uart_get_parity(UART_NUM, &esp_parity));
             switch (esp_parity) {
                 case UART_PARITY_EVEN:
                     aruna_parity = parity_t::EVEN;
                     break;
                 case UART_PARITY_ODD:
                     aruna_parity = parity_t::ODD;
                     break;
                 case UART_PARITY_DISABLE:
                 default:
                     aruna_parity = parity_t::DISABLED;
                     break;
             }
             return aruna_parity;
         }

◆ get_read_buffer_length()

uint32_t aruna::driver::ESP32_UART::get_read_buffer_length ( )

overridevirtual

Get amount of bytes in the read buffer.

Returns: number of bytes in read buffer.

Implements aruna::driver::UART.

Definition at line 153 of file ESP32_UART.cpp.

                                                     {
             size_t len = 0;
             ESP_ERROR_CHECK(uart_get_buffered_data_len(UART_NUM, &len));
             return len;
         }

◆ get_stop_bit()

UART::stop_bit_t aruna::driver::ESP32_UART::get_stop_bit ( )

overridevirtual

get stop bit

Returns: ONE ONE_HALF or TWO

Reimplemented from aruna::driver::UART.

Definition at line 204 of file ESP32_UART.cpp.

                                                 {
             uart_stop_bits_t esp_stop;
             stop_bit_t aruna_stop;
             ESP_ERROR_CHECK(uart_get_stop_bits(UART_NUM, &esp_stop));
             switch (esp_stop) {
                 case UART_STOP_BITS_1:
                     aruna_stop = stop_bit_t::ONE;
                     break;
                 case UART_STOP_BITS_1_5:
                     aruna_stop = stop_bit_t::ONE_HALF;
                     break;
                 case UART_STOP_BITS_2:
                     aruna_stop = stop_bit_t::TWO;
                     break;
                 case UART_STOP_BITS_MAX:
                 default:
                     aruna_stop = stop_bit_t::NONE;
                     break;
             }
 
             return aruna_stop;
         }

◆ get_word_length()

UART::word_length_t aruna::driver::ESP32_UART::get_word_length ( )

overridevirtual

Set UART data bits length.

Returns: word length.

Reimplemented from aruna::driver::UART.

Definition at line 227 of file ESP32_UART.cpp.

                                                       {
             uart_word_length_t esp_word;
             word_length_t aruna_word;
             ESP_ERROR_CHECK(uart_get_word_length(UART_NUM, &esp_word));
             switch (esp_word) {
                 case UART_DATA_5_BITS:
                     aruna_word = word_length_t::FIVE;
                     break;
                 case UART_DATA_6_BITS:
                     aruna_word = word_length_t::SIX;
                     break;
                 case UART_DATA_7_BITS:
                     aruna_word = word_length_t::SEVEN;
                     break;
                 case UART_DATA_8_BITS:
                     aruna_word = word_length_t::EIGHT;
                     break;
                 case UART_DATA_BITS_MAX:
                 default:
                     aruna_word = word_length_t::NONE;
                     break;
             }
             return aruna_word;
         }

Member Data Documentation

◆ software_flowcontrol

bool aruna::driver::ESP32_UART::software_flowcontrol = false

private

Definition at line 59 of file ESP32_UART.h.

◆ UART_NUM

const uart_port_t aruna::driver::ESP32_UART::UART_NUM

private

Definition at line 58 of file ESP32_UART.h.

◆ uart_queue

QueueHandle_t aruna::driver::ESP32_UART::uart_queue

private

Definition at line 61 of file ESP32_UART.h.

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

include/aruna/driver/port/ESP32/ESP32_UART.h
src/driver/port/ESP32/ESP32_UART.cpp

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ESP32_UART()

◆ ~ESP32_UART()

Member Function Documentation

◆ _read()

◆ _set_baudrate()

◆ _set_flowcontrol()

◆ _set_parity()

◆ _set_stop_bit()

◆ _set_word_length()

◆ _write()

◆ get_baudrate()

◆ get_flowcontrol()

◆ get_parity()

◆ get_read_buffer_length()

◆ get_stop_bit()

◆ get_word_length()

Member Data Documentation

◆ software_flowcontrol

◆ UART_NUM

◆ uart_queue