3.12. UART¶

serial_ctrl.serial_config(baud_rate, data_bit, odd_even, stop_bit)¶

描述:	设置串口的波特率、数据位、校验位以及停止位属性
参数:	baud_rate – 设置波特率，可选波特率为 9600、19200、38400、57600、115200 data_bit – 设置数据位，可选的数据位为 cs7、cs8 odd_even_crc – 设置奇偶校验，详细见表格 `odd_even_crc` stop_bit – 设置停止位，可选的停止位为 1、2
返回:	无
示例:	`serial_ctrl.serial_config(9600, 'cs8', 'none', 1)`
示例说明:	设置串口的波特率为 9600，数据位 8 位，不使用奇偶校验，停止位为 1 位

serial_ctrl.write_line(msg_string)¶

描述:	发送字符串信息，自动添加换行 `'\n'`
参数:	msg_string (string) – 需要发送的字符串信息，发送时字符串后自动添加 `'\n'`
返回:	无
示例:	`serial_ctrl.write_line('RoboMaster EP')`
示例说明:	向串口写入 `'RoboMaster EP\n'` ，最后的换行自动添加，用户只需要发送 `'RoboMaster EP'`

serial_ctrl.write_string(msg_string)¶

描述:	发送字符串信息
参数:	msg_string (string) – 需要发送的字符串信息
返回:	无
示例:	`serial_ctrl.write_string('RoboMaster EP')`
示例说明:	向串口写入 `'RoboMaster EP'`

serial_ctrl.write_number(value)¶

serial_ctrl.write_numbers(value1, value2, value3...)¶

描述:	将数字列表转换成字符串，并通过串口发送出去
参数:	value1 (int) – 需要发送数字列表的值 value2 (int) – 需要发送数字列表的值 value3 (int) – 需要发送数字列表的值
返回:	无
示例:	`serial_ctrl.write_numbers(12,13,14)`
示例说明:	向串口中写入字符串 `'12,13,14'`

serial_ctrl.write_value(key, value)¶

描述:	将参数以键值对的形式组成字符串，并通过串口发送出去
参数:	key (string) – 需要发送的关键字 value (int) – 需要发送的值
返回:	无
示例:	`serial_ctrl.write_value('x', 12)`
示例说明:	向串口中写入字符串 `'x:12'`

serial_ctrl.read_line([timeout])¶

描述:	从串口中读取以 `'\n'` 结尾的字符串
参数:	timeout (float) – 可选，超时时间，单位为秒，默认为永久阻塞
返回:	通过串口读取到的字符串
返回类型:	string
示例:	`recv = serial_ctrl.read_line()`
示例说明:	从串口读取一行以 `'\n'` 结尾的字符串

serial_ctrl.read_string([timeout])¶

描述:	从串口中读取字符串（字符串可以不以 `'\n'` 结尾）
参数:	timeout (float) – 可选，超时时间，单位为秒，默认为永久阻塞
返回:	通过串口读取到的字符串
返回类型:	string
示例:	`recv = serial_ctrl.read_string()`
示例说明:	从串口读取一个字符串

serial_ctrl.read_until(stop_sig[, timeout])¶

描述:	从串口中读取字符串，直到匹配到指定的结束字符 `'stop_sig'`
参数:	stop_sig – 指定的结束字符，参数类型为字符，范围为[ `'\n'` \| `'$'` \| `'#'` \| `'.'` \| `':'` \| `';'` ] timeout (float) – 可选，超时时间，单位为秒，默认为永久阻塞
返回:	通过串口读取到的匹配字符串
返回类型:	string
示例:	`serial_ctrl.read_until('#')`
示例说明:	从串口中读取字符串，直到匹配到 `'#'` 停止读取

odd_even_crc¶

提示

模块说明请参考 UART