SerialTerminal Class Reference

#include <src/SerialTermClass.h>

Public Member Functions
void	init (const uint32_t speed, void(*processing)(String)=NULL, const String *title=NULL, const String *ver=NULL, const int msg_size=64)
	Terminal speed and callbacks initialisation.
void	handler (void)
	handler for SerialTerminal class
void	setBreakoutChar (const char breakout) __attribute__((always_inline))
	write breakoutChar
char	getBreakoutChar (void) __attribute__((always_inline))
	reads breakoutChar

Public Attributes
String	SCIIn = ""
	Empty String which receives chars from serial.
int	SCIInNbChar = 0
	Received chars count.

Member Function Documentation

getBreakoutChar()

char SerialTerminal::getBreakoutChar ( void )

inline

reads breakoutChar

Returns

breakoutChar

handler()

void SerialTerminal::handler

(

void

)

handler for SerialTerminal class

Note

this method is public for serialEvent to use it, but shall not be called directly (serialEvent does)

Returns

nothing

init()

void SerialTerminal::init	(	const uint32_t	speed,
		void(*	processing )(String) = NULL,
		const String *	title = NULL,
		const String *	ver = NULL,
		const int	msg_size = 64 )

Terminal speed and callbacks initialisation.

Parameters

[in]	speed	- terminal baud rate
[in]	processing	- pointer to message processing function
[in]	title	- pointer to terminal title String
[in]	ver	- pointer to version String
[in]	msg_size	- maximum serial input size

Returns

nothing

setBreakoutChar()

void SerialTerminal::setBreakoutChar ( const char breakout )

inline

write breakoutChar

Parameters

[in]

breakout

- New ASCII digit as breakout

Returns

nothing

Member Data Documentation

SCIIn

String SerialTerminal::SCIIn = ""

Empty String which receives chars from serial.

SCIInNbChar

int SerialTerminal::SCIInNbChar = 0

Received chars count.

---

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

• src/SerialTermClass.h
• src/SerialTermClass.cpp