ESP32Serial Class Reference

Inheritance diagram for ESP32Serial:

Public Types
enum	Port_t { PORT0 = 0, PORT1 = 1, PORT2 = 2 }
Public Types inherited from SerialPort
enum	Config_t {   _5N1 = DATABITS_5 | PARITY_NONE | STOPBITS_1, _6N1 = DATABITS_6 | PARITY_NONE | STOPBITS_1, _7N1 = DATABITS_7 | PARITY_NONE | STOPBITS_1, _8N1 = DATABITS_8 | PARITY_NONE | STOPBITS_1,   _5N2 = DATABITS_5 | PARITY_NONE | STOPBITS_2, _6N2 = DATABITS_6 | PARITY_NONE | STOPBITS_2, _7N2 = DATABITS_7 | PARITY_NONE | STOPBITS_2, _8N2 = DATABITS_8 | PARITY_NONE | STOPBITS_2,   _5E1 = DATABITS_5 | PARITY_EVEN | STOPBITS_1, _6E1 = DATABITS_6 | PARITY_EVEN | STOPBITS_1, _7E1 = DATABITS_7 | PARITY_EVEN | STOPBITS_1, _8E1 = DATABITS_8 | PARITY_EVEN | STOPBITS_1,   _5E2 = DATABITS_5 | PARITY_EVEN | STOPBITS_2, _6E2 = DATABITS_6 | PARITY_EVEN | STOPBITS_2, _7E2 = DATABITS_7 | PARITY_EVEN | STOPBITS_2, _8E2 = DATABITS_8 | PARITY_EVEN | STOPBITS_2,   _5O1 = DATABITS_5 | PARITY_ODD | STOPBITS_1, _6O1 = DATABITS_6 | PARITY_ODD | STOPBITS_1, _7O1 = DATABITS_7 | PARITY_ODD | STOPBITS_1, _8O1 = DATABITS_8 | PARITY_ODD | STOPBITS_1,   _5O2 = DATABITS_5 | PARITY_ODD | STOPBITS_2, _6O2 = DATABITS_6 | PARITY_ODD | STOPBITS_2, _7O2 = DATABITS_7 | PARITY_ODD | STOPBITS_2, _8O2 = DATABITS_8 | PARITY_ODD | STOPBITS_2 }

Public Member Functions
	ESP32Serial (Port_t uartNum, int8_t txPin, int8_t rxPin, uint16_t txBufSize=256, uint16_t rxBufSize=256)
void	begin (uint32_t speed=115200, Config_t config=_8N1)
	시리얼 포트를 초기화합니다. More...
void	end ()
	시리얼 포트를 종료합니다. More...
void	listen ()
	포트로부터 문자 입력을 받기 시작합니다. More...
void	stopListening ()
	포트로부터 문자 수신을 중단합니다.
size_t	write (uint8_t val)
	문자 하나를 출력합니다. More...
int	printf (const char *fmt,...)
	printf 출력을 내보냅니다. More...
void	flush ()
Public Member Functions inherited from SerialPort
	SerialPort (uint16_t txBufferSize=64, uint16_t rxBufferSize=64)
bool	isBegan ()
	시리얼 포트가 시작되었는지 확인합니다.
bool	isListening ()
	포트가 현재 수신 중인지 알아봅니다.
virtual int	available ()
	포트 내부 수신버퍼에 수신된 문자의 갯수를 반환합니다.
virtual int	peek ()
	포트 내부 수신버퍼의 가장 앞에 위치한 문자를 반한합니다. More...
virtual int	availableForWrite ()
	포트 내부 송신버퍼의 여유공간을 반환합니다.
virtual int	read ()
	포트 내부 버퍼에 수신된 문자를 하다 꺼냅니다. More...
uint8_t	readBytes (char *buf, uint8_t len)
uint8_t	readBytes (uint8_t *buf, uint8_t len)
uint8_t	readBytesUntil (char terminator, char *buf, uint8_t len)
	readBytes() 와 동일하나 꺼내는 중간에 terminator 문자를 만나면 즉시 반환됩니다.
uint8_t	readBytesUntil (char terminator, uint8_t *buf, uint8_t len)
	readBytes() 와 동일하나 꺼내는 중간에 terminator 문자를 만나면 즉시 반환됩니다.
void	onReceive (void(*func)(void *, SerialPort &), void *ctx, bool interrupt=false)
	포트로 문자가 입력될 때마다 호출될 콜백함수를 지정합니다. More...
void	onReceive (void(*func)(void *), void *ctx, bool interrupt=false)
	포트로 문자가 입력될 때마다 호출될 콜백함수를 지정합니다. More...
void	onReceive (void(*func)(SerialPort &), bool interrupt=false)
	포트로 문자가 입력될 때마다 호출될 콜백함수를 지정합니다. More...
error_t	input (char *str, uint8_t len, char terminator)
	포트로부터 문자열 입력을 받습니다. More...
error_t	inputKeyboard (char *str, uint8_t len)
	포트와 연결된 키보드로부터 문자열 입력을 받습니다. More...
char *	getInputData (uint8_t *len)
	입력이 완료된 문자열을 가져옵니다. More...
char *	getInputData ()
	입력이 완료된 문자열을 가져옵니다.
void	stopInput ()
	input() 또는 inputKeyboard() 로 시작된 문자열 입력을 중단합니다.
bool	isSending ()
virtual size_t	write (uint8_t)=0
	문자 하나를 출력합니다. More...
size_t	write (const char *str)
	문자열을 출력합니다. More...
virtual size_t	write (const uint8_t *buffer, size_t size)
	데이터 배열을 출력합니다. More...
size_t	write (const char *buffer, size_t size)
	데이터 배열을 출력합니다. More...
Public Member Functions inherited from Stream
void	setTimeout (unsigned long timeout)
bool	find (const char *target)
bool	find (uint8_t *target)
bool	find (const char *target, size_t length)
bool	find (const uint8_t *target, size_t length)
bool	find (char target)
bool	findUntil (const char *target, const char *terminator)
bool	findUntil (const uint8_t *target, const char *terminator)
bool	findUntil (const char *target, size_t targetLen, const char *terminate, size_t termLen)
bool	findUntil (const uint8_t *target, size_t targetLen, const char *terminate, size_t termLen)
long	parseInt ()
float	parseFloat ()
size_t	readBytes (char *buffer, size_t length)
size_t	readBytes (uint8_t *buffer, size_t length)
size_t	readBytesUntil (char terminator, char *buffer, size_t length)
size_t	readBytesUntil (char terminator, uint8_t *buffer, size_t length)
String	readString ()
String	readStringUntil (char terminator)
Public Member Functions inherited from Print
int	getWriteError ()
void	clearWriteError ()
size_t	write (const char *str)
	문자열을 출력합니다. More...
virtual size_t	write (const uint8_t *buffer, size_t size)
	데이터 배열을 출력합니다. More...
size_t	write (const char *buffer, size_t size)
	데이터 배열을 출력합니다. More...
size_t	print (const __FlashStringHelper *)
	프로그램 메모리(읽기 전용 플래시) 영역에 저장된 문자열을 출력합니다.
size_t	print (const String &)
	String 형의 문자열을 출력합니다.
size_t	print (const char[])
	NULL로 종료되는 문자열을 출력합니다.
size_t	print (char)
	문자 하나를 출력합니다.
size_t	print (unsigned char, int=DEC)
	부호가 없는(unsigned) 8-byte 정수를 지정한 진수 형태로 출력합니다.
size_t	print (int, int=DEC)
	int 형 정수를 지정한 진수 형태로 출력합니다.
size_t	print (unsigned int, int=DEC)
	unsigned int 형 정수를 지정한 진수 형태로 출력합니다.
size_t	print (long, int=DEC)
	long 형 정수를 지정한 진수 형태로 출력합니다.
size_t	print (unsigned long, int=DEC)
	unsigned long 형 정수를 지정한 진수 형태로 출력합니다.
size_t	print (double, int=2)
	double 형 실수를 지정한 소수점 이하 출력 개수로 출력합니다.
size_t	print (const Printable &)
	Printable을 구현한 클래스를 출력합니다.
size_t	println (const __FlashStringHelper *)
	프로그램 메모리(읽기 전용 플래시) 영역에 저장된 문자열과 개행문자(CR+LF)를 출력합니다.
size_t	println (const String &s)
	String 형의 문자열과 개행문자(CR+LF)를 출력합니다.
size_t	println (const char[])
	NULL로 종료되는 문자열과 개행문자(CR+LF)를 출력합니다.
size_t	println (char)
	문자 하나와 개행문자(CR+LF)를 출력합니다.
size_t	println (unsigned char, int=DEC)
	부호가 없는(unsigned) 8-byte 정수를 지정한 진수 형태로, 개행문자(CR+LF)와 함께 출력합니다.
size_t	println (int, int=DEC)
	int 형 정수를 지정한 진수 형태로, 개행문자(CR+LF)와 함께 출력합니다.
size_t	println (unsigned int, int=DEC)
	unsigned int 형 정수를 지정한 진수 형태로, 개행문자(CR+LF)와 함께 출력합니다.
size_t	println (long, int=DEC)
	long 형 정수를 지정한 진수 형태로, 개행문자(CR+LF)와 함께 출력합니다.
size_t	println (unsigned long, int=DEC)
	unsigned long 형 정수를 지정한 진수 형태로, 개행문자(CR+LF)와 함께 출력합니다.
size_t	println (double, int=2)
	double 형 실수를 지정한 소수점 이하 출력 개수로, 개행문자(CR+LF)와 함께 출력합니다.
size_t	println (const Printable &)
	Printable을 구현한 클래스를, 개행문자(CR+LF)와 함께 출력합니다.
size_t	println (void)
	개행문자(CR+LF)를 출력합니다.

Additional Inherited Members
Protected Member Functions inherited from SerialPort
void	receive (uint8_t data)
Protected Member Functions inherited from Stream
int	timedRead ()
int	timedPeek ()
int	peekNextDigit ()
long	parseInt (char skipChar)
float	parseFloat (char skipChar)
Protected Member Functions inherited from Print
void	setWriteError (int err=1)
Protected Attributes inherited from SerialPort
bool	began = false
bool	rxEnabled = false
bool	notifyImmediatelyOnRx = false
volatile bool	txBusy = false
const uint16_t	RxBufferSize
uint8_t *	rxBuffer = nullptr
volatile uint16_t	rxBufferHead = 0
volatile uint16_t	rxBufferTail = 0
const uint16_t	TxBufferSize
uint8_t *	txBuffer = nullptr
volatile uint16_t	txBufferHead = 0
volatile uint16_t	txBufferTail = 0
void(*	doAfterReceive )(void *ctx) = nullptr
Protected Attributes inherited from Stream
unsigned long	_timeout
unsigned long	_startMillis

Member Function Documentation

begin()

void ESP32Serial::begin ( uint32_t  speed = 115200, Config_t  config = _8N1  )

virtual

시리얼 포트를 초기화합니다.

Parameters

speed	설정 가능한 speed는 300, 600, 1200, 2400, 4800, 9600, 14400, 19200, 28800, 38400, 57600, 또는 115200 입니다.
config	Data bit, parity, stop bit 등을 설정합니다.

Implements SerialPort.

end()

void ESP32Serial::end ( )

virtual

시리얼 포트를 종료합니다.

Tx, Rx 핀들은 input 상태가 됩니다.

Implements SerialPort.

listen()

void ESP32Serial::listen ( )

virtual

포트로부터 문자 입력을 받기 시작합니다.

기본으로는 수신이 불가능한 상태이므로 시리얼 포트를 통해 입력을 받고 싶을 때 호출해야 합니다.

Implements SerialPort.

printf()

int ESP32Serial::printf ( const char *  ,   ...  )

virtual

printf 출력을 내보냅니다.

내보낼 출력은 format string 및 가변인자에 따라 달라집니다.

Parameters

fmt	format string

Reimplemented from Print.

write()

size_t ESP32Serial::write ( uint8_t  )

virtual

문자 하나를 출력합니다.

Parameters

val

전송할 문자

Returns

전송된 문자 수

Reimplemented from SerialPort.

---

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

• nola-sdk/include/esp32/ESP32Serial.hpp