Elevator v2.0
Elevator Documenation
Loading...
Searching...
No Matches
SerialComm Struct Reference

Custom SerialComm structure for UART adaptablity. More...

#include <serial_communication.h>

Collaboration diagram for SerialComm:
Collaboration graph

Data Fields

int gpio_rx
 
int gpio_tx
 
int gpio_rts
 
int gpio_cts
 
uart_port_t uart_num
 
uint32_t baud_rate
 
uart_parity_t parity
 
uart_stop_bits_t stop_bits
 
uart_word_length_t data_bits
 

Detailed Description

Custom SerialComm structure for UART adaptablity.

This structure allows the user to select the UART pins, baud rate, stop bits, parity and data bits

Example

typedef strcut {
int gpio_rx; // RX pin
int gpio_tx; // TX pin
int gpio_rts; // RTS pin
int gpio_cts; // CTS pin
uart_port_t uart_num; // UART selection
uint32_t baud_rate; // Baud rate
uart_parity_t parity; // Parity selection
uart_stop_bits_t stop_bits; // Stop bits
uart_word_length_T data_bits;// Data bits
Custom SerialComm structure for UART adaptablity.
Definition: serial_communication.h:73
int gpio_rts
Definition: serial_communication.h:76
uart_parity_t parity
Definition: serial_communication.h:80
uart_word_length_t data_bits
Definition: serial_communication.h:82
uint32_t baud_rate
Definition: serial_communication.h:79
uart_stop_bits_t stop_bits
Definition: serial_communication.h:81
int gpio_rx
Definition: serial_communication.h:74
int gpio_tx
Definition: serial_communication.h:75
int gpio_cts
Definition: serial_communication.h:77
uart_port_t uart_num
Definition: serial_communication.h:78

Field Documentation

◆ baud_rate

uint32_t SerialComm::baud_rate

baud rate

◆ data_bits

uart_word_length_t SerialComm::data_bits

data bits

◆ gpio_cts

int SerialComm::gpio_cts

gpio cts

◆ gpio_rts

int SerialComm::gpio_rts

gpio rts

◆ gpio_rx

int SerialComm::gpio_rx

gpio rx

◆ gpio_tx

int SerialComm::gpio_tx

gpio tx

◆ parity

uart_parity_t SerialComm::parity

parity selection

◆ stop_bits

uart_stop_bits_t SerialComm::stop_bits

stop bits

◆ uart_num

uart_port_t SerialComm::uart_num

uart selection


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