# 插件：物联网协议连接器

**Repository Path**: low-code-dev-lab/hzg-plugin-iot-bridge

## Basic Information

- **Project Name**: 插件：物联网协议连接器
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-06-05
- **Last Updated**: 2026-06-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# IoTBridge 服务端命令帮助文档

本文基于当前代码中的服务端命令定义整理，按命令分类列出可用操作、每个操作的实际动作、传入参数清单和返回值的结构清单。

通用约定

- 所有命令都在服务端执行。
- `ResultTo` 表示返回值的变量名。命令执行完成后，会把结构化结果对象写入该变量。
- 所有结果对象中的 `success` 表示命令是否成功，`errCode` 为统一错误码，`0` 表示成功，`message` 为错误或状态消息，`elapsedMs` 为命令耗时，单位毫秒。
- 连接类命令成功后返回 `connectionId`，后续读、写、发送、接收、断开、订阅等命令都通过该 ID 复用连接。

## 分类：Modbus TCP 连接器

### 操作：Modbus TCP 连接

实际动作

- 根据主机和端口建立 Modbus TCP 连接。
- 如果启用复用并且已存在相同端点的健康连接，则直接复用原连接。
- 如果启用强制重连，则先断开相同端点的已有连接，再重新建立连接。
- 连接级参数会保存默认 `UnitId` 和地址基准，后续读写命令共用这些设置。

传入参数

- `主机`：必填。Modbus TCP 设备的 IP 地址或主机名。
- `端口`：默认 `502`。
- `默认UnitId`：默认 `1`。
- `复用已有连接`：默认 `true`。
- `强制重连`：默认 `false`。
- `连接超时毫秒`：默认 `3000`。
- `请求超时毫秒`：默认 `3000`。
- `重试次数`：默认 `1`，不包含首次请求。
- `地址基准`：默认 `ZeroBased`。`ZeroBased` 表示输入地址直接作为协议地址，`OneBased` 表示发送前减 1。
- `结果变量`：默认 `连接信息`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.connectionId`：连接唯一标识。
- `ResultTo.reused`：是否复用了已有连接。

### 操作：Modbus TCP 读取

实际动作

- 使用指定 `ConnectionId` 读取 Modbus 数据区。
- 支持线圈、离散输入、输入寄存器、保持寄存器。
- 地址按连接命令中的地址基准解释。
- 读取数量为 `1` 时，结果中的 `value` 仍然是数组。

传入参数

- `连接ID`：必填。由 Modbus TCP 连接命令返回。
- `读取区域`：默认 `HoldingRegister`。可选 `Coil`、`DiscreteInput`、`InputRegister`、`HoldingRegister`。
- `起始地址`：默认 `0`。
- `读取数量`：默认 `1`。
- `结果变量`：默认 `读取结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.value`：读取值数组。线圈和离散输入返回布尔数组，寄存器返回数值数组。

### 操作：Modbus TCP 写入

实际动作

- 使用指定 `ConnectionId` 写入 Modbus 数据区。
- 支持写线圈和保持寄存器。
- 单点写会根据写入区域使用对应功能码，多点写会根据数组或多值输入使用批量写功能码。
- 地址按连接命令中的地址基准解释。

传入参数

- `连接ID`：必填。由 Modbus TCP 连接命令返回。
- `写入区域`：默认 `HoldingRegister`。可选 `Coil`、`HoldingRegister`。
- `起始地址`：默认 `0`。
- `值`：必填。线圈写入 `true/false` 或 `1/0`；保持寄存器写入 `0` 到 `65535`；多点写可传数组、JSON 数组或逗号分隔值。
- `结果变量`：默认 `写入结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.value`：写入值数组。即使只写入一个点，也返回数组。

### 操作：Modbus TCP 断开

实际动作

- 根据 `ConnectionId` 关闭并移除 Modbus TCP 连接。

传入参数

- `连接ID`：必填。
- `结果变量`：默认 `断开操作结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。

## 分类：Modbus RTU 连接器

### 操作：Modbus RTU 连接

实际动作

- 通过串口建立 Modbus RTU 连接。
- 如果启用复用并且已存在相同端点的健康连接，则直接复用原连接。
- 如果启用强制重连，则先断开相同端点的已有连接，再重新建立连接。
- 连接级参数会保存默认 `SlaveId`、请求超时、重试次数和地址基准，后续读写命令共用这些设置。

传入参数

- `串口名`：必填，例如 `COM3`。测试台架可使用 `pipe:<pipeName>`。
- `波特率`：默认 `Baud9600`。
- `数据位`：默认 `Eight`。
- `校验位`：默认 `None`。
- `停止位`：默认 `One`。
- `串口流控`：默认 `None`。
- `请求超时毫秒`：默认 `3000`。
- `默认SlaveId`：默认 `1`。
- `重试次数`：默认 `2`。读取请求失败后重试；写入请求默认不重试，避免重复触发设备动作。
- `地址基准`：默认 `OneBased`。`ZeroBased` 表示输入地址直接作为协议地址，`OneBased` 表示发送前减 1。
- `复用已有连接`：默认 `true`。
- `强制重连`：默认 `false`。
- `结果变量`：默认 `连接信息`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.connectionId`：连接唯一标识。
- `ResultTo.reused`：是否复用了已有连接。

### 操作：Modbus RTU 读取

实际动作

- 使用指定 `ConnectionId` 读取 Modbus RTU 数据区。
- 支持线圈、离散输入、输入寄存器、保持寄存器。
- 地址按连接命令中的地址基准解释。
- 读取数量为 `1` 时，结果中的 `value` 仍然是数组。

传入参数

- `连接ID`：必填。由 Modbus RTU 连接命令返回。
- `读取区域`：默认 `HoldingRegister`。可选 `Coil`、`DiscreteInput`、`InputRegister`、`HoldingRegister`。
- `起始地址`：默认 `0`。
- `读取数量`：默认 `1`。
- `结果变量`：默认 `读取结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.value`：读取值数组。线圈和离散输入返回布尔数组，寄存器返回数值数组。

### 操作：Modbus RTU 写入

实际动作

- 使用指定 `ConnectionId` 写入 Modbus RTU 数据区。
- 支持写线圈和保持寄存器。
- 单点写会根据写入区域使用对应功能码，多点写会根据数组或多值输入使用批量写功能码。
- 地址按连接命令中的地址基准解释。

传入参数

- `连接ID`：必填。由 Modbus RTU 连接命令返回。
- `写入区域`：默认 `HoldingRegister`。可选 `Coil`、`HoldingRegister`。
- `起始地址`：默认 `0`。
- `值`：线圈写入 `true/false` 或 `1/0`；保持寄存器写入 `0` 到 `65535`；多点写可传数组、JSON 数组或逗号分隔值。
- `结果变量`：默认 `写入结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.value`：写入值数组。即使只写入一个点，也返回数组。

### 操作：Modbus RTU 断开

实际动作

- 根据 `ConnectionId` 关闭并移除 Modbus RTU 连接。

传入参数

- `连接ID`：必填。
- `结果变量`：默认 `断开操作结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。

## 分类：OPC UA 连接器

### 操作：OPC UA 连接

实际动作

- 根据 `EndpointUrl` 建立 OPC UA 会话。
- 支持匿名认证和用户名密码认证。
- 支持安全策略、消息安全模式、证书目录和未信任证书处理。
- 如果启用复用并且已存在相同端点和认证设置的健康连接，则直接复用原连接。
- 如果启用强制重连，则先断开相同端点的已有连接，再重新建立连接。

传入参数

- `EndpointUrl`：OPC UA 端点地址，必填，例如 `opc.tcp://host:4840/server`。
- `应用名称`：默认 `IoTBridge`。
- `安全策略`：默认 `None`。可选 `None`、`Basic256Sha256`。
- `消息安全模式`：默认 `None`。可选 `None`、`Sign`、`SignAndEncrypt`。
- `认证方式`：默认 `Anonymous`。可选 `Anonymous`、`UserName`。
- `用户名`：认证方式为 `UserName` 时使用。
- `密码`：认证方式为 `UserName` 时使用。
- `证书目录`：默认留空。
- `接受未信任证书`：默认 `true`。
- `会话超时毫秒`：默认 `60000`。
- `KeepAlive间隔毫秒`：默认 `5000`。
- `复用已有连接`：默认 `true`。
- `强制重连`：默认 `false`。
- `结果变量`：默认 `连接信息`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.connectionId`：连接唯一标识。
- `ResultTo.reused`：是否复用了已有连接。

### 操作：OPC UA 探测

实际动作

- 使用指定 `ConnectionId` 读取服务器当前时间节点。
- 用于快速判断连接是否存在、会话是否可用、服务器是否仍能响应。

传入参数

- `连接ID`：必填。由 OPC UA 连接命令返回。
- `结果变量`：默认 `侦测结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。

### 操作：OPC UA 读取

实际动作

- 使用指定 `ConnectionId` 读取一个 OPC UA 节点。
- 默认读取节点 `Value` 属性。
- `IndexRange` 可用于数组或矩阵变量的切片读取。
- 结果中的 `value` 始终为数组；读取单个节点值时也返回单元素数组。

传入参数

- `连接ID`：必填。由 OPC UA 连接命令返回。
- `NodeId`：节点 ID，必填，例如 `ns=3;i=1003`。
- `属性`：默认 `Value`。可选 `Value`、`DisplayName`、`Description`、`BrowseName`、`NodeClass`、`DataType`、`ValueRank`。
- `索引范围`：默认留空。用于数组或矩阵变量切片，例如 `0`、`0:9`、`2:5`；普通标量值留空。
- `请求超时毫秒`：默认 `15000`。
- `结果变量`：默认 `读取结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.value`：读取值数组。即使只读取一个节点，也返回数组。

### 操作：OPC UA 写入

实际动作

- 使用指定 `ConnectionId` 写入一个 OPC UA 节点。
- 默认写入节点 `Value` 属性。
- `DataType` 为 `Auto` 时尽量沿用输入值或目标节点类型；也可以显式指定写入数据类型。
- `IndexRange` 可用于数组或矩阵变量的切片写入。

传入参数

- `连接ID`：必填。由 OPC UA 连接命令返回。
- `NodeId`：节点 ID，必填，例如 `ns=3;i=1003`。
- `属性`：默认 `Value`。可选 `Value`、`DisplayName`、`Description`、`BrowseName`、`NodeClass`、`DataType`、`ValueRank`。
- `数据类型`：默认 `Auto`。可选 `Auto`、`Boolean`、`SByte`、`Byte`、`Int16`、`UInt16`、`Int32`、`UInt32`、`Int64`、`UInt64`、`Float`、`Double`、`Decimal`、`String`、`DateTime`、`Guid`、`ByteString`、`XmlElement`、`NodeId`、`ExpandedNodeId`、`StatusCode`、`QualifiedName`、`LocalizedText`。
- `值`：必填。可传单值或数组。
- `索引范围`：默认留空。用于数组或矩阵变量切片，例如 `0`、`0:9`、`2:5`；普通标量值留空。
- `请求超时毫秒`：默认 `15000`。
- `结果变量`：默认 `写入结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.value`：写入值数组。即使只写入一个节点，也返回数组。

### 操作：OPC UA 开始订阅

实际动作

- 使用指定 `ConnectionId` 创建一个 OPC UA 监听。
- 本命令监听一个 `NodeId`。
- 监听名用于停止监听、替换同名监听、查看监听列表和回调参数。
- 收到节点变化通知后，会把订阅消息写入回调变量，并执行本命令下配置的子命令。
- 推荐在计划任务的“应用重新启动”中执行本命令，用于应用启动后自动恢复订阅监听。

传入参数

- `连接ID`：必填。由 OPC UA 连接命令返回。
- `监听名`：监听名。
- `NodeId`：节点 ID，必填，例如 `ns=3;i=1003`。
- `属性`：默认 `Value`。可选 `Value`、`DisplayName`、`Description`、`BrowseName`、`NodeClass`、`DataType`、`ValueRank`。
- `索引范围`：默认留空。用于数组或矩阵变量切片监听，例如 `0`、`0:9`、`2:5`；普通标量值留空。
- `发布间隔毫秒`：默认 `1000`。服务器按此周期把已采样到的变化批量推送给客户端。
- `采样间隔毫秒`：默认 `1000`。服务器按此间隔检查该节点值是否变化。
- `队列大小`：默认 `1`。控制服务器在两次发布之间为该监控项缓存的变化通知数量；`1` 表示只缓存最新值，较大值可缓存更多连续变化，队列满时丢弃最早通知。
- `替换同名订阅`：默认 `false`。勾选后，如果监听名已存在，会先停止原监听，再用当前配置重新创建；默认不替换，重名时返回错误。
- `子命令列表`：必须至少配置一个子命令，否则开始订阅会返回参数错误。
- `结果变量`：默认 `开始订阅结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.connectionId`：连接唯一标识。
- `ResultTo.online`：连接是否可用。
- `ResultTo.subscriptionName`：监听名。
- `ResultTo.itemCount`：监听节点数量。本命令监听一个节点，因此为 `1`。

订阅回调返回值的结构

- `IoTMessage`：当前订阅消息的简化对象。
- `IoTMessage.subscriptionName`：当前监听名。
- `IoTMessage.connectionId`：当前连接 ID。
- `IoTMessage.nodeId`：当前节点 ID。
- `IoTMessage.value`：当前节点的新值。
- `IoTMessage.oldValue`：当前节点的上一次值。
- `IoTMessage.statusCode`：OPC UA 状态码。
- `IoTMessage.sourceTimestamp`：源时间戳。
- `IoTMessage.serverTimestamp`：服务端时间戳。
- `IoTSubscriptionName`：当前监听名。
- `IoTConnectionId`：当前连接 ID。
- `IoTNodeId`：当前节点 ID。
- `IoTValue`：当前节点的新值。
- `IoTOldValue`：当前节点的上一次值。
- `IoTStatusCode`：OPC UA 状态码。
- `IoTSourceTimestamp`：源时间戳。
- `IoTServerTimestamp`：服务端时间戳。

### 操作：OPC UA 停止订阅

实际动作

- 根据监听名停止并移除 OPC UA 监听。

传入参数

- `订阅名称`：必填。填写开始订阅时使用的监听名。
- `结果变量`：默认 `停止订阅操作结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.subscriptionName`：监听名。

### 操作：OPC UA 列出订阅

实际动作

- 获取当前应用内已创建的 OPC UA 监听列表。
- 列表中的每一项对应一个监听，包含监听名、连接 ID、节点 ID、属性、采样间隔、队列大小、发布间隔和启动时间。

传入参数

- `结果变量`：默认 `订阅列表`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.count`：当前订阅数量。
- `ResultTo.value`：订阅信息列表。
- `ResultTo.value.name`：监听名。
- `ResultTo.value.connectionId`：连接唯一标识。
- `ResultTo.value.nodeId`：监听节点 ID。
- `ResultTo.value.attribute`：监听的 OPC UA 属性。
- `ResultTo.value.samplingIntervalMs`：采样间隔，单位毫秒。
- `ResultTo.value.queueSize`：队列大小。
- `ResultTo.value.publishingIntervalMs`：发布间隔，单位毫秒。
- `ResultTo.value.startedAt`：订阅启动时间，ISO 8601 格式。

### 操作：OPC UA 断开连接

实际动作

- 根据 `ConnectionId` 关闭 OPC UA 会话。
- 断开连接时会停止该连接上的订阅监听。

传入参数

- `连接ID`：必填。
- `结果变量`：默认 `断开连接的处理结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。

## 分类：RS232 连接器

### 操作：RS232 连接

实际动作

- 打开 RS232 串口链路。
- 如果启用复用并且已存在相同端点的健康连接，则直接复用原连接。
- 如果启用强制重连，则先断开相同端点的已有连接，再重新建立连接。

传入参数

- `串口名`：必填，例如 `COM1`。测试台架可使用 `pipe:<pipeName>`。
- `波特率`：默认 `Baud9600`。
- `数据位`：默认 `Eight`。
- `校验位`：默认 `None`。
- `停止位`：默认 `One`。
- `串口流控`：默认 `None`。
- `方向控制`：默认 `AutoAdapter`。RS232 通常保持默认。
- `方向切换延时毫秒`：默认 `0`。
- `连接超时毫秒`：默认 `3000`。
- `响应超时毫秒`：默认 `1000`。
- `空闲结束毫秒`：默认 `50`。
- `复用已有连接`：默认 `true`。
- `强制重连`：默认 `false`。
- `结果变量`：默认 `连接信息`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.connectionId`：连接唯一标识。
- `ResultTo.reused`：是否复用了已有连接。

### 操作：RS232 发送

实际动作

- 使用指定 `ConnectionId` 发送串口数据。
- 可按文本、十六进制或 Base64 解析发送内容。
- 可选择追加终止符。
- 可选择发送后不接收、读取当前可用响应、读取固定长度响应或读取到终止符。

传入参数

- `连接ID`：必填。由 RS232 连接命令返回。
- `发送内容`：必填。
- `内容格式`：默认 `Text`。可选 `Text`、`Hex`、`Base64`。
- `文本编码`：默认 `Utf8`。可选 `Utf8`、`Ascii`、`Unicode`。
- `追加终止符`：默认 `false`。
- `终止符`：默认换行符 `\r\n`。
- `终止符格式`：默认 `Text`。可选 `Text`、`Hex`、`Base64`。
- `接收模式`：默认 `None`。可选 `None`、`ReadAvailable`、`FixedLength`、`Terminator`。
- `期望响应字节数`：默认 `0`。接收模式为 `FixedLength` 时使用。
- `响应超时毫秒`：默认 `1000`。
- `空闲结束毫秒`：默认 `50`。
- `结果变量`：默认 `发送结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.payload`：发送或接收命令得到的有效载荷。
- `ResultTo.payload.length`：payload 字节数。
- `ResultTo.payload.text`：payload 按所选编码解码后的文本。
- `ResultTo.payload.hex`：payload 的十六进制文本。
- `ResultTo.payload.base64`：payload 的 Base64 文本。

### 操作：RS232 接收

实际动作

- 使用指定 `ConnectionId` 从串口读取数据。
- 支持读取当前可用响应、读取固定字节数或读取到终止符。

传入参数

- `连接ID`：必填。由 RS232 连接命令返回。
- `接收模式`：默认 `ReadAvailable`。可选 `ReadAvailable`、`FixedLength`、`Terminator`。
- `期望响应字节数`：默认 `0`。接收模式为 `FixedLength` 时使用。
- `终止符`：默认换行符 `\r\n`。接收模式为 `Terminator` 时使用。
- `终止符格式`：默认 `Text`。可选 `Text`、`Hex`、`Base64`。
- `文本编码`：默认 `Utf8`。可选 `Utf8`、`Ascii`、`Unicode`。
- `响应超时毫秒`：默认 `1000`。
- `空闲结束毫秒`：默认 `50`。
- `结果变量`：默认 `接收结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.payload`：接收到的有效载荷。
- `ResultTo.payload.length`：payload 字节数。
- `ResultTo.payload.text`：payload 按所选编码解码后的文本。
- `ResultTo.payload.hex`：payload 的十六进制文本。
- `ResultTo.payload.base64`：payload 的 Base64 文本。

### 操作：RS232 断开

实际动作

- 根据 `ConnectionId` 关闭并移除 RS232 串口链路。

传入参数

- `连接ID`：必填。
- `结果变量`：默认 `断开操作结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。

## 分类：RS485 连接器

### 操作：RS485 连接

实际动作

- 打开 RS485 串口链路。
- 如果启用复用并且已存在相同端点的健康连接，则直接复用原连接。
- 如果启用强制重连，则先断开相同端点的已有连接，再重新建立连接。
- 半双工 RS485 适配器可通过方向控制参数设置发送期间 RTS 的电平和发送后的恢复延时。

传入参数

- `串口名`：必填，例如 `COM1`。测试台架可使用 `pipe:<pipeName>`。
- `波特率`：默认 `Baud9600`。
- `数据位`：默认 `Eight`。
- `校验位`：默认 `None`。
- `停止位`：默认 `One`。
- `串口流控`：默认 `None`。
- `方向控制`：默认 `AutoAdapter`。可选 `AutoAdapter`、`RtsHighDuringSend`、`RtsLowDuringSend`。
- `方向切换延时毫秒`：默认 `0`。
- `连接超时毫秒`：默认 `3000`。
- `响应超时毫秒`：默认 `1000`。
- `空闲结束毫秒`：默认 `50`。
- `复用已有连接`：默认 `true`。
- `强制重连`：默认 `false`。
- `结果变量`：默认 `连接信息`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.connectionId`：连接唯一标识。
- `ResultTo.reused`：是否复用了已有连接。

### 操作：RS485 发送

实际动作

- 使用指定 `ConnectionId` 发送串口数据。
- 可按文本、十六进制或 Base64 解析发送内容。
- 可选择追加终止符。
- 可选择发送后不接收、读取当前可用响应、读取固定长度响应或读取到终止符。
- 发送时会按连接配置处理 RS485 方向控制。

传入参数

- `连接ID`：必填。由 RS485 连接命令返回。
- `发送内容`：必填。
- `内容格式`：默认 `Text`。可选 `Text`、`Hex`、`Base64`。
- `文本编码`：默认 `Utf8`。可选 `Utf8`、`Ascii`、`Unicode`。
- `追加终止符`：默认 `false`。
- `终止符`：默认换行符 `\r\n`。
- `终止符格式`：默认 `Text`。可选 `Text`、`Hex`、`Base64`。
- `接收模式`：默认 `None`。可选 `None`、`ReadAvailable`、`FixedLength`、`Terminator`。
- `期望响应字节数`：默认 `0`。接收模式为 `FixedLength` 时使用。
- `响应超时毫秒`：默认 `1000`。
- `空闲结束毫秒`：默认 `50`。
- `结果变量`：默认 `发送结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.payload`：发送或接收命令得到的有效载荷。
- `ResultTo.payload.length`：payload 字节数。
- `ResultTo.payload.text`：payload 按所选编码解码后的文本。
- `ResultTo.payload.hex`：payload 的十六进制文本。
- `ResultTo.payload.base64`：payload 的 Base64 文本。

### 操作：RS485 接收

实际动作

- 使用指定 `ConnectionId` 从串口读取数据。
- 支持读取当前可用响应、读取固定字节数或读取到终止符。

传入参数

- `连接ID`：必填。由 RS485 连接命令返回。
- `接收模式`：默认 `ReadAvailable`。可选 `ReadAvailable`、`FixedLength`、`Terminator`。
- `期望响应字节数`：默认 `0`。接收模式为 `FixedLength` 时使用。
- `终止符`：默认换行符 `\r\n`。接收模式为 `Terminator` 时使用。
- `终止符格式`：默认 `Text`。可选 `Text`、`Hex`、`Base64`。
- `文本编码`：默认 `Utf8`。可选 `Utf8`、`Ascii`、`Unicode`。
- `响应超时毫秒`：默认 `1000`。
- `空闲结束毫秒`：默认 `50`。
- `结果变量`：默认 `接收结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。
- `ResultTo.payload`：接收到的有效载荷。
- `ResultTo.payload.length`：payload 字节数。
- `ResultTo.payload.text`：payload 按所选编码解码后的文本。
- `ResultTo.payload.hex`：payload 的十六进制文本。
- `ResultTo.payload.base64`：payload 的 Base64 文本。

### 操作：RS485 断开

实际动作

- 根据 `ConnectionId` 关闭并移除 RS485 串口链路。

传入参数

- `连接ID`：必填。
- `结果变量`：默认 `断开操作结果`。

返回值的结构

- `ResultTo.success`：命令是否执行成功。
- `ResultTo.errCode`：统一错误码，`0` 表示成功。
- `ResultTo.message`：错误或状态消息。
- `ResultTo.elapsedMs`：命令耗时，单位毫秒。