arcs::common_interface::Serial类 参考

#include <serial.h>

Public 成员函数
	Serial ()
virtual	~Serial ()
int	serialOpen (const std::string &device, int baud, float stop_bits, int even, const std::string &serial_name="serial_0")
	打开TCP/IP以太网通信串口
int	serialClose (const std::string &serial_name="serial_0")
	关闭TCP/IP串口通信 关闭与服务器的串口连接。
int	serialReadByte (const std::string &variable, const std::string &serial_name="serial_0")
	从串口读取指定数量的字节。字节为网络字节序。一次最多可读取30个值。
int	serialReadByteList (int number, const std::string &variable, const std::string &serial_name="serial_0")
	从串口读取指定数量的字节。字节为网络字节序。一次最多可读取30个值。 返回读取到的数字列表（int列表，长度=number+1）。
int	serialReadString (const std::string &variable, const std::string &serial_name="serial_0", const std::string &prefix="", const std::string &suffix="", bool interpret_escape=false)
	从串口读取所有数据，并将数据作为字符串返回。 字节为网络字节序。
int	serialSendByte (char value, const std::string &serial_name="serial_0")
	发送一个字节到服务器 通过串口发送字节 。不期望有响应。可用于发送特殊的ASCII字符；10为换行符，2为文本开始，3为文本结束。
int	serialSendInt (int value, const std::string &serial_name="serial_0")
	发送一个整数（int32_t）到服务器 通过串口发送整数 。以网络字节序发送。不期望有响应。
int	serialSendLine (const std::string &str, const std::string &serial_name="serial_0")
	发送带有换行符的字符串到服务器 以ASCII编码通过串口发送字符串<str>，并在末尾添加换行符。不期望有响应。
int	serialSendString (const std::string &str, const std::string &serial_name="serial_0")
	发送字符串到服务器 以ASCII编码通过串口发送字符串<str>。不期望有响应。
int	serialSendAllString (bool is_check, const std::vector< char > &str, const std::string &serial_name="serial_0")

Protected 属性
void *	d_

详细描述

在文件 serial.h 第 16 行定义.

构造及析构函数说明

Serial()

arcs::common_interface::Serial::Serial

(

)

~Serial()

virtual arcs::common_interface::Serial::~Serial ( )

virtual

成员函数说明

serialClose()

int arcs::common_interface::Serial::serialClose

(

const std::string &

serial_name = "serial_0"

)

关闭TCP/IP串口通信 关闭与服务器的串口连接。

参数

serial_name

串口名称

返回

返回值

Python函数原型

serialClose(self: pyaubo_sdk.Serial, arg0: str) -> int

Lua函数原型

serialClose(serial_name: string) -> nil

serialOpen()

int arcs::common_interface::Serial::serialOpen	(	const std::string &	device,
		int	baud,
		float	stop_bits,
		int	even,
		const std::string &	serial_name = "serial_0"
	)

打开TCP/IP以太网通信串口

参数

device	设备名
baud	波特率
stop_bits	停止位
even	校验位
serial_name	串口名称

返回

返回值

Python函数原型

serialOpen(self: pyaubo_sdk.Serial, arg0: str, arg1: int, arg2: float, arg3: int, arg4: str) -> int

Lua函数原型

serialOpen(device: string, baud: number, stop_bits: number, even: number, serial_name: string) -> nil

serialReadByte()

int arcs::common_interface::Serial::serialReadByte	(	const std::string &	variable,
		const std::string &	serial_name = "serial_0"
	)

从串口读取指定数量的字节。字节为网络字节序。一次最多可读取30个值。

参数

variable	变量
serial_name	串口名称

返回

返回值

Python函数原型

serialReadByte(self: pyaubo_sdk.Serial, arg0: str, arg1: str) -> int

Lua函数原型

serialReadByte(variable: string, serial_name: string) -> number

serialReadByteList()

int arcs::common_interface::Serial::serialReadByteList	(	int	number,
		const std::string &	variable,
		const std::string &	serial_name = "serial_0"
	)

从串口读取指定数量的字节。字节为网络字节序。一次最多可读取30个值。 返回读取到的数字列表（int列表，长度=number+1）。

参数

number	读取的字节数
variable	变量
serial_name	串口名称

返回

返回值

Python函数原型

serialReadByteList(self: pyaubo_sdk.Serial, arg0: int, arg1: str, arg2: str) -> int

Lua函数原型

serialReadByteList(number: number, variable: string, serial_name: string) -> number

serialReadString()

int arcs::common_interface::Serial::serialReadString	(	const std::string &	variable,
		const std::string &	serial_name = "serial_0",
		const std::string &	prefix = "",
		const std::string &	suffix = "",
		bool	interpret_escape = false
	)

从串口读取所有数据，并将数据作为字符串返回。 字节为网络字节序。

可选参数 "prefix" 和 "suffix" 用于指定从串口提取的内容。 "prefix" 指定提取子串（消息）的起始位置。直到 "prefix" 结束的数据会被忽略并从串口移除。 "suffix" 指定提取子串（消息）的结束位置。串口中 "suffix" 之后的剩余数据会被保留。 例如，如果串口服务器发送字符串 "noise>hello<"，控制器可以通过设置 prefix=">" 和 suffix="<" 来接收 "hello"。 通过使用 "prefix" 和 "suffix"，还可以一次向控制器发送多条字符串，因为 "suffix" 定义了消息的结束位置。 例如发送 ">hello<>world<"

参数

variable	变量
serial_name	串口名称
prefix	前缀
suffix	后缀
interpret_escape	是否解释转义字符

返回

返回值

Python函数原型

serialReadString(self: pyaubo_sdk.Serial, arg0: str, arg1: str, arg2: str, arg3: str, arg4: bool) -> int

Lua函数原型

serialReadString(variable: string, serial_name: string, prefix: string, suffix: string, interpret_escape: boolean) -> number

serialSendAllString()

int arcs::common_interface::Serial::serialSendAllString	(	bool	is_check,
		const std::vector< char > &	str,
		const std::string &	serial_name = "serial_0"
	)

参数

is_check	是否校验
str	字符串数组
serial_name	串口名称

返回

返回值

Python函数原型

serialSendAllString(self: pyaubo_sdk.Serial, arg0: bool, arg1: List[str], arg2: str) -> int

Lua函数原型

serialSendAllString(is_check: boolean, str: table, serial_name: string) -> nil

serialSendByte()

int arcs::common_interface::Serial::serialSendByte	(	char	value,
		const std::string &	serial_name = "serial_0"
	)

发送一个字节到服务器 通过串口发送字节 。不期望有响应。可用于发送特殊的ASCII字符；10为换行符，2为文本开始，3为文本结束。

参数

value	字节值
serial_name	串口名称

返回

返回值

Python函数原型

serialSendByte(self: pyaubo_sdk.Serial, arg0: str, arg1: str) -> int

Lua函数原型

serialSendByte(value: string, serial_name: string) -> nil

serialSendInt()

int arcs::common_interface::Serial::serialSendInt	(	int	value,
		const std::string &	serial_name = "serial_0"
	)

发送一个整数（int32_t）到服务器 通过串口发送整数 。以网络字节序发送。不期望有响应。

参数

value	整数值
serial_name	串口名称

返回

返回值

Python函数原型

serialSendInt(self: pyaubo_sdk.Serial, arg0: int, arg1: str) -> int

Lua函数原型

serialSendInt(value: number, serial_name: string) -> nil

serialSendLine()

int arcs::common_interface::Serial::serialSendLine	(	const std::string &	str,
		const std::string &	serial_name = "serial_0"
	)

发送带有换行符的字符串到服务器 以ASCII编码通过串口发送字符串<str>，并在末尾添加换行符。不期望有响应。

参数

str	字符串
serial_name	串口名称

返回

返回值

Python函数原型

serialSendLine(self: pyaubo_sdk.Serial, arg0: str, arg1: str) -> int

Lua函数原型

serialSendLine(str: string, serial_name: string) -> nil

serialSendString()

int arcs::common_interface::Serial::serialSendString	(	const std::string &	str,
		const std::string &	serial_name = "serial_0"
	)

发送字符串到服务器 以ASCII编码通过串口发送字符串<str>。不期望有响应。

参数

str	字符串
serial_name	串口名称

返回

返回值

Python函数原型

serialSendString(self: pyaubo_sdk.Serial, arg0: str, arg1: str) -> int

Lua函数原型

serialSendString(str: string, serial_name: string) -> nil

类成员变量说明

d_

void* arcs::common_interface::Serial::d_

protected

在文件 serial.h 第 390 行定义.

---

该类的文档由以下文件生成:

• include/aubo/serial.h