HardwareSerial

• int available(void)

• int availableForWrite(void)

• void begin(uint32 baud)

• void begin(uint32 baud,uint8_t config)

• void end()

• bool find(char *target)

• bool find(char *target, size_t length)

• bool findUntil(char target, char terminator)

• void flush(void)

• float parseFloat()

• long parseInt()

• int peek(void)

• size_t print(const String &)

• size_t print(char)

• size_t print(const char[])

• size_t print(uint8, int=DEC)

• size_t print(int, int=DEC)

• size_t print(unsigned int, int=DEC)

• size_t print(long, int=DEC)

• size_t print(unsigned long, int=DEC)

• size_t print(long long, int=DEC)

• size_t print(unsigned long long, int=DEC)

• int printf(const char * format, ...)

• size_t println(void)

• size_t println(const String &s)

• size_t println(char)

• size_t println(const char[])

• size_t println(uint8, int=DEC)

• size_t println(int, int=DEC)

• size_t println(unsigned int, int=DEC)

• size_t println(long, int=DEC)

• size_t println(unsigned long, int=DEC)

• size_t println(long long, int=DEC)

• size_t println(unsigned long long, int=DEC)

• int read(void)

• size_t readBytes( char *buffer, size_t length)

• size_t readBytesUntil( char terminator, char *buffer, size_t length)

• String readString()

• void setTimeout(unsigned long timeout)

• size_t write(uint8_t)

• size_t write(const char *str)

• size_t write(const void *buf, uint32 len)

---

int available(void)

获取串口接收缓冲区上可读取的数据的字节数

• 参数

• 无

• 返回值

• 字节数

int availableForWrite(void)

可以写入到串口缓存中的字节数

• 参数

• 无

• 返回值

• 字节数

void begin(uint32 baud)

串口初始化

• 参数

• baud 设置波特率

• 返回值

• 无

void begin(uint32 baud,uint8_t config)

串口初始化，波特率设置和更详细的参数配置

• 参数

• SERIAL_5N1

• SERIAL_6N1

• SERIAL_7N1

• SERIAL_8N1(默认)

• SERIAL_5N2

• SERIAL_6N2

• SERIAL_7N2

• SERIAL_8N2

• SERIAL_5E1

• SERIAL_6E1

• SERIAL_7E1

• SERIAL_8E1

• SERIAL_5E2

• SERIAL_6E2

• SERIAL_7E2

• SERIAL_8E2

• SERIAL_5O1

• SERIAL_6O1

• SERIAL_7O1

• SERIAL_8O1

• SERIAL_5O2

• SERIAL_6O2

• SERIAL_7O2

• SERIAL_8O2

• baud 波特率设置

• config 其他参数，数据位、校验、停止位

• 返回值

• 无

void end()

关闭串口功能，关闭后可以使rx、tx引脚作为普通输入输出引脚

• 参数

• 无

• 返回值

• 无

bool find(char *target)

从串口缓存读取数据直到找到指定的字符串

• 参数

• target 要查找的字符串

• 返回值

• 找到就返回 true，否则返回false

bool find(char *target, size_t length)

从串口缓存读取数据直到找到指定的给定长度字符串

• 参数

• target 要查找的字符串

• length 指定长度

• 返回值

• 找到就返回 true，否则返回false

bool findUntil(char target, char terminator)

从串口缓存读取数据查找字符串，遇到给定的结束字符串后停止

• 参数

• target 要查找的字符串

• terminator 结束查找的字符串

• 返回值

• 找到就返回 true，否则返回false

void flush(void)

刷新串口缓存，等待串口数据输出完成

• 参数

• 无

• 返回值

• 无

float parseFloat()

返回当前位置第一个有效的浮点数数值

• 参数

• 无

• 返回值

• 获取的数值

long parseInt()

返回当前位置第一个有效的整型数值

• 参数

• 无

• 返回值

• 获取的值

int peek(void)

返回收到的串口数据的下一个字节，但是不从串口缓存中清除

• 参数

• 无

• 返回值

• 收取到的数值

size_t print(const String &)

输出String类型字符串

• 参数

• 要输出的字符串

• 返回值

• 写入的字节数

size_t print(char)

输出char类型字符

• 参数

• 要输出的字符

• 返回值

• 写入的字节数

size_t print(const char[])

输出char数组类型字符串

• 参数

• 要输出的字符串

• 返回值

• 写入的字节数

size_t print(uint8, int=DEC)

输出uint8类型数字，默认十进制

• 参数

• 要输出的数字

• 格式，可以为DEC、 HEX、 OCT、 BIN

• 返回值

• 写入的字节数

size_t print(int, int=DEC)

输出int类型数字，默认十进制

• 参数

• 要输出的数字

• 格式，可以为DEC、 HEX、 OCT、 BIN

• 返回值

• 写入的字节数

size_t print(unsigned int, int=DEC)

输出unsigned int类型数字，默认十进制

• 参数

• 要输出的数字

• 格式，可以为DEC、 HEX、 OCT、 BIN

• 返回值

• 写入的字节数

size_t print(long, int=DEC)

输出long类型数字，默认十进制

• 参数

• 要输出的数字

• 格式，可以为DEC、 HEX、 OCT、 BIN

• 返回值

• 写入的字节数

size_t print(unsigned long, int=DEC)

输出unsigned long类型数字，默认十进制

• 参数

• 要输出的数字

• 格式，可以为DEC、 HEX、 OCT、 BIN

• 返回值

• 写入的字节数

size_t print(long long, int=DEC)

输出long long类型数字，默认十进制

• 参数

• 要输出的数字

• 格式，可以为DEC、 HEX、 OCT、 BIN

• 返回值

• 写入的字节数

size_t print(unsigned long long, int=DEC)

输出unsigned long long类型数字，默认十进制

• 参数

• 要输出的数字

• 格式，可以为DEC、 HEX、 OCT、 BIN

• 返回值

• 写入的字节数

int printf(const char * format, ...)

格式化字符串输出

• 参数

• format 输出的格式

• 返回值

• 写入的字节数

size_t println(void)

输出字符串，并换行

• 参数

• 无

• 返回值

• 写入的字节数

size_t println(const String &s)

输出字符串，并换行

• 参数

• 要输出的字符串

• 返回值

• 写入的字节数

size_t println(char)

输出字符，并换行

• 参数

• 要输出的字符

• 返回值

• 写入的字节数

size_t println(const char[])

输出char类型字符数组，并换行

• 参数

• 要输出的字符数组

• 返回值

• 写入的字节数

size_t println(uint8, int=DEC)

输出uint8类型数字，并换行，默认十进制

• 参数

• 要输出的数字

• 格式，可以为DEC、 HEX、 OCT、 BIN

• 返回值

• 写入的字节数

size_t println(int, int=DEC)

输出int类型数字，并换行，默认十进制

• 参数

• 要输出的数字

• 格式，可以为DEC、 HEX、 OCT、 BIN

• 返回值

• 写入的字节数

size_t println(unsigned int, int=DEC)

输出unsigned int类型数字，并换行，默认十进制

• 参数

• 要输出的数字

• 格式，可以为DEC、 HEX、 OCT、 BIN

• 返回值

• 写入的字节数

size_t println(long, int=DEC)

输出long类型数字，并换行，默认十进制

• 参数

• 要输出的数字

• 格式，可以为DEC、 HEX、 OCT、 BIN

• 返回值

• 写入的字节数

size_t println(unsigned long, int=DEC)

输出unsigned long类型数字，并换行，默认十进制

• 参数

• 要输出的数字

• 格式，可以为DEC、 HEX、 OCT、 BIN

• 返回值

• 写入的字节数

size_t println(long long, int=DEC)

输出long long类型数字，并换行，默认十进制

• 参数

• 要输出的数字

• 格式，可以为DEC、 HEX、 OCT、 BIN

• 返回值

• 写入的字节数

size_t println(unsigned long long, int=DEC)

输出unsigned long long类型数字，并换行，默认十进制

• 参数

• 要输出的数字

• 格式，可以为DEC、 HEX、 OCT、 BIN

• 返回值

• 写入的字节数

int read(void)

从串口读取数据

• 参数

• 无

• 返回值

• 返回串口上第一个有效的字节数据，没有数据则返回 -1

size_t readBytes( char *buffer, size_t length)

从串口读取数据放到给定 buff 中，直到达到给定的长度或超时时结束

• 参数

• buffer 存放读取的数据

• length 要读取的字节数

• 返回值

• 读取的实际字节数

size_t readBytesUntil( char terminator, char *buffer, size_t length)

从串口读取数据放到给定 buff 中，直到出现给定结束的字符

• 参数

• terminator 给定的结束字符

• buffer 存放读取的数据

• length 要读取的字节数

• 返回值

• 读取的实际字节数

String readString()

从串口读取数据转为String类型，直到超时时结束读取

• 参数

• 无

• 返回值

• 读取到的数据

void setTimeout(unsigned long timeout)

设置串口等待读取的超时时间，默认 1000 ms

• 参数

• timeout 超时时间

• 返回值

• 无

size_t write(uint8_t)

写入单个字节的二进制的数据到串口

• 参数

• 要写入的单字节数据

• 返回值

• 写入的字节数

size_t write(const char *str)

写入字符串形式的字节数组到到串口

• 参数

• str要写如的数据数组

• 返回值

• 写入的字节数

size_t write(const void *buf, uint32 len)

写入指定长度的字节数组到串口

• 参数

• buf 要写入的字节数组

• len 指定的长度

• 返回值

• 写入的字节数

---