T_UserSerial Class Reference

#include <tactigon_UserSerial.h>

Public Types
enum	BAUDRATE {   B_1200 = 1200, B_2400 = 2400, B_4800 = 4800, B_9600 = 9600,   B_19200 = 19200, B_38400 = 38400, B_57600 = 57600, B_115200 = 115200,   B_230400 = 230400 }
enum	INSTANCE { T_SERIAL1 = 1, T_SERIAL3 = 2 }

Public Member Functions
	T_UserSerial ()
void	init (BAUDRATE b, INSTANCE i)
void	write (char *pData, int size)
void	setRxByteCB (uartRxByteCBType pFunc)
int	available (void)
uint8_t	read (void)

Detailed Description

User Serials Handler Class

Member Enumeration Documentation

BAUDRATE

enum T_UserSerial::BAUDRATE

Available baudrates

Enumerator
B_1200	1200bps
B_2400	2400bps
B_4800	4800bps
B_9600	9600bps
B_19200	19200bps
B_38400	38400bps
B_57600	57600bps
B_115200	115200bps
B_230400	115200bps

INSTANCE

enum T_UserSerial::INSTANCE

Serial Instance

Enumerator
T_SERIAL1	available on CN3 (HW V2) or J502 (HW V1)
T_SERIAL3	available on CN1 - (HW V2 only)

Constructor & Destructor Documentation

T_UserSerial()

T_UserSerial::T_UserSerial

(

)

UserSerial Class constructor

Member Function Documentation

available()

int T_UserSerial::available

(

void

)

Return the number of available byte in rx buffer

init()

void T_UserSerial::init	(	BAUDRATE	b,
		INSTANCE	i
	)

UserSerial Class init

Parameters

b	baudrate
i	serial instance

read()

uint8_t T_UserSerial::read

(

void

)

Read one byte from serial buffer

setRxByteCB()

void T_UserSerial::setRxByteCB

(

uartRxByteCBType

pFunc

)

Set a CallBack on rx byte event on user uart

Parameters

pFunc

user provided callback. It Must be of type: void callBackName(uint8_t byte)

write()

void T_UserSerial::write	(	char *	pData,
		int	size
	)

write to serial

Parameters

pData	pointer to data to write
size	number of byte to write

---

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

• tactigon_UserSerial.h
• tactigon_UserSerial.cpp