# tk_iostream_serial_t

# 概述

image
image

基于串口实现的输入输出流。 备注:如果需要在 Windows 平台运行,请在应用程序初始化时,调用 tk_socket_init 函数初始化 socket。

# 函数

函数名称 说明
tk_iostream_serial_config 配置串口。
tk_iostream_serial_create 创建iostream对象。
tk_iostream_serial_wait_for_data 等待串口数据。

# tk_iostream_serial_config 函数

  • 函数功能:

配置串口。 备注:如果需要在 Windows 平台运行,请在应用程序初始化时,调用 tk_socket_init 函数初始化 socket。

  • 函数原型:
ret_t tk_iostream_serial_config (tk_iostream_t* iostream, int32_t baudrate, bytesize_t bytesize, parity_t parity, stopbits_t stopbits, flowcontrol_t flowcontrol);
  • 参数说明:
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功,否则表示失败。
iostream tk_iostream_t* 串口对象。
baudrate int32_t 波特率。
bytesize bytesize_t 字节位数。
parity parity_t 奇偶校验。
stopbits stopbits_t 停止位。
flowcontrol flowcontrol_t 流控。

# tk_iostream_serial_create 函数

  • 函数功能:

创建iostream对象。

缺省配置: baudrate=115200 bytesize=8 stopbits=1 flowcontrol=0 parity=0

  • 函数原型:
tk_iostream_t* tk_iostream_serial_create (const char* port);
  • 参数说明:
参数 类型 说明
返回值 tk_iostream_t* 返回iostream对象。
port const char* port name。

# tk_iostream_serial_wait_for_data 函数

  • 函数功能:

等待串口数据。

  • 函数原型:
ret_t tk_iostream_serial_wait_for_data (tk_iostream_t* iostream, uint32_t timeout);
  • 参数说明:
参数 类型 说明
返回值 ret_t 返回RET_OK表示成功,否则表示失败。
iostream tk_iostream_t* 串口对象。
timeout uint32_t 等待时间(ms)。