Uart Class Reference

Detailed Description

This file defines the UART interface for libmraa

    // If you have a valid platform configuration use numbers to represent uart
    // device. If not use raw mode where std::string is taken as a constructor
    // parameter
    mraa::Uart* dev;
    try {
        dev = new mraa::Uart(0);
    } catch (std::exception& e) {
        std::cout << e.what() << ", likely invalid platform config" << std::endl;
    }

    try {
        dev = new mraa::Uart("/dev/ttyACM0");
    } catch (std::exception& e) {
        std::cout << "Error while setting up raw UART, do you have a uart?" << std::endl;
        std::terminate();
    }

    if (dev->setBaudRate(115200) != MRAA_SUCCESS) {
        std::cout << "Error setting parity on UART" << std::endl;
    }

    if (dev->setMode(8, MRAA_UART_PARITY_NONE, 1) != MRAA_SUCCESS) {
        std::cout << "Error setting parity on UART" << std::endl;
    }

    if (dev->setFlowcontrol(false, false) != MRAA_SUCCESS) {
        std::cout << "Error setting flow control UART" << std::endl;
    }

    dev->writeStr("Hello monkeys");

Public Member Functions
	Uart (int uart)
	Uart (std::string path)
	~Uart ()
std::string	getDevicePath ()
int	read (char *data, int length)
int	write (const char *data, int length)
std::string	readStr (int length)
int	writeStr (std::string data)
bool	dataAvailable (unsigned int millis=0)
mraa_result_t	flush ()
mraa_result_t	setBaudRate (unsigned int baud)
mraa_result_t	setMode (int bytesize, mraa_uart_parity_t parity, int stopbits)
mraa_result_t	setFlowcontrol (bool xonxoff, bool rtscts)
mraa_result_t	setTimeout (int read, int write, int interchar)

Constructor & Destructor Documentation

Uart ( int  uart )

inline

Uart Constructor, takes a pin number which will map directly to the linux uart number, this 'enables' the uart, nothing more

Parameters

uart	the index of the uart set to use

Here is the call graph for this function:

Uart ( std::string  path )

inline

Uart Constructor, takes a string to the path of the serial interface that is needed.

Parameters

uart	the index of the uart set to use

Here is the call graph for this function:

~Uart ( )

inline

Uart destructor

Here is the call graph for this function:

Member Function Documentation

std::string getDevicePath ( )

inline

Get string with tty device path within Linux For example. Could point to "/dev/ttyS0"

Returns

char pointer of device path

Here is the call graph for this function:

int read ( char *  data, int  length  )

inline

Read bytes from the device into char* buffer

Parameters

data	buffer pointer
length	maximum size of buffer

Returns

numbers of bytes read

Here is the call graph for this function:

int write ( const char *  data, int  length  )

inline

Write bytes in String object to a device

Parameters

data	buffer pointer
length	maximum size of buffer

Returns

the number of bytes written, or -1 if an error occurred

Here is the call graph for this function:

std::string readStr ( int  length )

inline

Read bytes from the device into a String object

Parameters

length

to read

Returns

string of data

Here is the call graph for this function:

int writeStr ( std::string  data )

inline

Write bytes in String object to a device

Parameters

string

to write

Returns

the number of bytes written, or -1 if an error occurred

Here is the call graph for this function:

bool dataAvailable ( unsigned int  millis = 0 )

inline

Check to see if data is available on the device for reading

Parameters

millis

number of milliseconds to wait, or 0 to return immediately

Returns

true if there is data available to read, false otherwise

Here is the call graph for this function:

mraa_result_t flush ( )

inline

Flush the outbound data. Blocks until complete.

Returns

Result of operation

Here is the call graph for this function:

mraa_result_t setBaudRate ( unsigned int  baud )

inline

Set the baudrate. Takes an int and will attempt to decide what baudrate is to be used on the UART hardware.

Parameters

baud	unsigned int of baudrate i.e. 9600

Returns

Result of operation

Here is the call graph for this function:

mraa_result_t setMode ( int  bytesize, mraa_uart_parity_t  parity, int  stopbits  )

inline

Set the transfer mode For example setting the mode to 8N1 would be "dev.setMode(8,MRAA_UART_PARITY_NONE , 1)"

Parameters

bytesize	data bits
parity	Parity bit setting
stopbits	stop bits

Returns

Result of operation

Here is the call graph for this function:

mraa_result_t setFlowcontrol ( bool  xonxoff, bool  rtscts  )

inline

Set the flowcontrol

Parameters

xonxoff	XON/XOFF Software flow control.
rtscts	RTS/CTS out of band hardware flow control

Returns

Result of operation

Here is the call graph for this function:

mraa_result_t setTimeout ( int  read, int  write, int  interchar  )

inline

Set the timeout for read and write operations <= 0 will disable that timeout

Parameters

read	read timeout
write	write timeout
interchar	inbetween char timeout

Returns

Result of operation

Here is the call graph for this function:

---

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

• /var/lib/jenkins/workspace/mraa-doc-stable/api/mraa/uart.hpp