字符串通信读入

## 字符串通讯读入

![](/media/202601/4956bdbe-d585-42fd-b725-1a9370a6ec3a_1768457995.png)

## 模块原理
从普通串口、TCP客户端或者服务端等类型的通讯口执行读取当前电脑收到的字符数据。

## 使用场景
常用于通讯流程中读取通讯口收到字符数据，在通过字符串类的模块或Lua脚本工具等解析收到的字符数据，并根据解析后的字符执行启动、停止、触发流程、切换配方等功能。

## 使用方法
前提条件：VG3的工程中配置一个普通串口、TCP客户端或者服务端等类型的通讯口，并建议在全局流程树中创建一个连续运行的通讯流程，并选中编辑这个通讯流程。
1、函数添加树 &rArr; 辅助工具 &rArr; 硬件控制 &rArr; 字符串通讯读入模块，拖拽或者双击添加到指定位置。
2、选中需要读取的通讯口，当通讯口为服务端时，根据具体情况填写指定客户端IP，一般情况下不用填写。
3、根据具体使用情况添加分割头尾字符、超时时间等，一般情况下不用填写。
注意：由于字符串通讯读入模块常添加到连续运行的通讯流程中，一般一个通讯口有且只会使用一个字符串通讯读入模块；多个模块时，大概率会出现某些模块读取不到数据的问题。

### 前后序模块
模块后面通常为==字符串类的模块(字符串拆分、字符串转换等)、Lua脚本工具、条件检测==。

## 参数配置说明

![](/media/202601/3fc841fc-1367-4701-936c-9efd4e8fb539_1768459400.png)
1、通讯口选择：选需要读取的通讯口，灰色灯表示通讯口未使用；红色灯表示通讯口连接失败；绿色灯表示通讯口正常连接。指定的通讯口类型为服务端时，第二行显示客户端IP地址；否则显示指定通讯口的类型。
2、客户端IP：只有在指定的通讯口类型为服务端时，才显示。可以根据情况填写客户端IP。当为空时，则读取所有连接到服务端上的客户端发送的数据；填写了IP地址，则只读取对应IP地址的客户端发送的数据。
以下3个参数常用于串口通讯（波特率较低、发送内容较多）时，经常性会出现一次性接收不完整的问题。
3、分割头字符：用于判断通讯口读取的数据是否开始
4、分割尾字符：用于判断通讯口读取的数据是否已经结束。
5、读取超时(ms):从读取字符到等待读取到分割尾字符最长时间，单位：ms。

## 输出说明

![](/media/202601/962519a9-be50-4ce3-ac09-fb640cda59bd_1768459410.png)
1、运行结果：返回是否指定的通讯口读取字符串是否成功，如果通讯口未使用或者连接有问题则返回f假，否则为真
2、读取字符串：返回指定通讯口读取到的字符串。
3、读取字符串长度：返回指定通讯口读取到的字符串的字节长度。

## 注意事项
1、字符串通讯读入模块是一个非阻塞模式，不会等待通讯口的数据发送了数据才向下执行，千万不要用于逻辑控制。
2、在使用字符串类的模块或者Lua脚本工具前建议先判断一下读取的字符串长度，有数据才解析。

点击此处跳转到对应的中文说明书文章页:&nbsp;[String Communication Read](/doc/555)