插件参考
本页详细说明每个插件的寄存器地址格式、插件属性(通道/设备级配置)和变量属性(变量级配置)。
- 插件属性:配置在通道或设备级别,用于设定通讯参数、连接方式等
- 变量属性:配置在变量级别,用于设定变量特有的参数,如数据类型、RPC使能等
- 寄存器地址格式:仅在采集插件中存在,用于指定变量在设备中的地址
- 地址数据转换参数:可在寄存器地址中通过分号附加,用于覆盖默认的数据解析方式
地址数据转换参数
在寄存器地址中,可以通过分号(;)附加数据转换参数,覆盖插件默认的数据解析方式。这些参数由 GetTransByAddress 机制解析,允许同一个插件的不同变量使用不同的数据转换规则。
通用转换参数仅适用于基于原始字节通讯的采集插件(Modbus主站、Siemens S7、DLT645-2007等)。OPC UA、OPC DA、MQTT等插件由服务端或JSON直接提供类型化数据,不需要也不支持这些字节级转换参数。
通用转换参数
以下参数适用于所有采集插件:
| 参数 | 格式 | 可选值 | 说明 |
|---|---|---|---|
| 数据格式 | data=ABCD | ABCD(大端)、BADC(大端字节交换)、CDAB(小端字节交换)、DCBA(小端) | 4字节数据(float/int/uint等)的字节序 |
| 字符串长度 | len=N | 正整数 | 字符串类型变量的字节长度,字符串读写时必须指定 |
| BCD格式 | bcd=C8421 | C8421、C5421、C2421、C3、Gray | BCD编码格式 |
| 字符编码 | encoding=UTF-8 | UTF-8、ASCII、Default、Unicode等 | 字符串编码类型 |
| 变长字符串 | vsl=true | true/false | 是否为变长字符串(S7中变长字符串前2字节为长度) |
通用示例:
40001;data=CDAB— 保持寄存器,使用小端字节交换格式解析float/int40001;len=10;encoding=UTF-8— 保持寄存器,读取10字节UTF-8编码字符串40001;bcd=C8421— 保持寄存器,使用BCD 8421编码DB1.DBW0;vsl=true;len=20— S7数据块,变长字符串,最大20字节
插件特有转换参数
部分插件在通用参数之外,还支持特有的地址参数:
| 插件 | 参数 | 格式 | 说明 | 示例 |
|---|---|---|---|---|
| Modbus主站 | 站号 | s=N | 指定设备站号,覆盖通道默认站号 | 40001;s=2 |
| Modbus主站 | 写入功能码 | w=N | 指定写入时使用的功能码(6或16) | 40001;w=16 |
| Modbus主站 | 功能码 | f=N | 直接指定读取功能码 | 40001;f=3 |
| Siemens S7 | 宽字符串 | W=true | 启用WString(宽字符串/Unicode),S7中前4字节为长度头 | DB1.DBW0;W=true |
- 转换参数与地址之间、参数与参数之间均使用分号(
;)分隔 - 参数不区分大小写(参数名和枚举值均不区分)
- 如果未指定任何转换参数,则使用插件属性中配置的默认值
- 字符串类型的变量必须在地址中指定
len=N,否则读写会报错
采集插件
采集插件用于从外部设备或系统读取数据,每个采集插件对应一种通讯协议或数据源。
Modbus主站
寄存器地址格式
| 地址范围 | 寄存器类型 | 功能码 | 示例 |
|---|---|---|---|
| 00001~09999 | 线圈寄存器 | 01(读)/ 05(写) | 00001 |
| 10001~19999 | 离散输入寄存器 | 02(只读) | 10001 |
| 30001~39999 | 输入寄存器 | 04(只读) | 30001 |
| 40001~49999 | 保持寄存器 | 03(读)/ 06/16(写) | 40001 |
Modbus特有地址参数(分号分隔,通用转换参数见地址数据转换参数):
| 参数 | 格式 | 说明 | 示例 |
|---|---|---|---|
| 站号 | s=N | 指定设备站号,覆盖通道默认站号 | 40001;s=2 |
| 写入功能码 | w=N | 指定写入时使用的功能码(6或16) | 40001;w=16 |
| 功能码 | f=N | 直接指定读取功能码 | 40001;f=3 |
| 位索引 | .N | 指定寄存器中的位索引 | 40001.3 |
示例:
40001— 保持寄存器第一个寄存器40001;s=2— 站号为2的保持寄存器第一个寄存器40001;w=16— 保持寄存器第一个寄存器,写入时采用0x10功能码40001;data=CDAB— 保持寄存器,使用小端字节交换格式解析40001;len=10;encoding=UTF-8— 保持寄存器,读取10字节UTF-8字符串
插件属性
Modbus主站属性继承自 CollectFoundationDtuPackPropertyBase,包含以下配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| Modbus类型 | 枚举 | - | ModbusTcp(TCP格式)/ ModbusRtu(RTU格式) |
| 默认站号 | Byte | 1 | 默认设备站号 |
| 最大打包长度 | UInt16 | 100 | 单次请求最大打包寄存器数量 |
| 读写超时时间 | UInt16 | 3000 | 读写操作超时时间(ms) |
| 帧前时间 | Int32 | 0 | 发送帧前延时时间(ms) |
| 字符串反转字节 | Boolean | false | 字符串是否按字反转 |
| 数据解析顺序 | 枚举 | - | 数据字节序(ABCD/DCBA/BADC/CDAB) |
| DTU ID | String | - | 默认DTU ID |
| 失败重试次数 | Int32 | 3 | 读写失败重试次数 |
| 读写占空比 | Int32 | 3 | n次写入操作会执行一次读取 |
| 写优先 | Boolean | false | 写入时强制取消读取操作 |
Siemens S7
寄存器地址格式
| 前缀 | 寄存器类型 | 示例 | 说明 |
|---|---|---|---|
I | 输入(I区) | I0.0、IB0、IW0、ID0 | 支持位/字节/字/双字 |
Q | 输出(Q区) | Q0.0、QB0、QW0、QD0 | 支持位/字节/字/双字 |
M | 中间存储(M区) | M0.0、MB0、MW0、MD0 | 支持位/字节/字/双字 |
DB | 数据块(DB区) | DB1.DBX0.0、DB1.DBB0、DB1.DBW0、DB1.DBD0 | 格式:DB号.地址 |
AI | 模拟输入 | AI0、AIW0 | 模拟量输入 |
AQ | 模拟输出 | AQ0、AQW0 | 模拟量输出 |
T | 定时器 | T0 | Timer寄存器 |
C | 计数器 | C0 | Counter寄存器 |
V | V区(S200专用) | V0、VB0、VW0、VD0 | 等同于DB1 |
S7特有地址参数(分号分隔,通用转换参数见地址数据转换参数):
| 参数 | 格式 | 说明 | 示例 |
|---|---|---|---|
| 宽字符串 | W=true/false | 是否启用宽字符串(WString),启用后字符串按Unicode编码,非SMART200前4字节为长度头 | DB1.DBW0;W=true |
S7字符串说明:
- 普通字符串(
vsl=true):非SMART200前2字节为长度头,SMART200前1字节为长度头 - 宽字符串(
W=true):非SMART200前4字节为长度头,SMART200前1字节为长度头 - 固定长度字符串(
len=N):无长度头,直接读取N字节
示例:
DB1.DBW0— DB1数据块,字地址0DB1.DBW0;W=true— DB1数据块,宽字符串DB1.DBW0;vsl=true;len=20— DB1数据块,变长字符串,最大20字节DB1.DBW0;data=CDAB— DB1数据块,使用小端字节交换格式
地址类型前缀说明:
| 前缀 | 说明 |
|---|---|
X | 位(Bit) |
B | 字节(Byte) |
W | 字(Word,16位) |
D | 双字(DWord,32位) |
插件属性
Siemens S7属性继承自 CollectFoundationPackPropertyBase,包含以下配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| PLC类型 | 枚举 | - | S200/S200Smart/S300/S400/S1200/S1500 |
| Rack | Byte | 0 | 机架号 |
| Slot | Byte | 0 | 槽号 |
| LocalTSAP | Int32 | 0 | 本地TSAP |
| 最大打包长度 | UInt16 | 200 | 单次请求最大打包长度 |
| 读写超时时间 | UInt16 | 3000 | 读写操作超时时间(ms) |
| 帧前时间 | Int32 | 0 | 发送帧前延时时间(ms) |
| 字符串反转字节 | Boolean | false | 字符串是否按字反转 |
| 数据解析顺序 | 枚举 | - | 数据字节序 |
| 失败重试次数 | Int32 | 3 | 读写失败重试次数 |
| 读写占空比 | Int32 | 3 | n次写入操作会执行一次读取 |
| 写优先 | Boolean | false | 写入时强制取消读取操作 |
DLT645-2007
寄存器地址格式
DLT645-2007使用数据标识作为地址,格式为8位十六进制数据标识码。通用转换参数见地址数据转换参数。
DLT645特有地址参数(分号分隔):
| 参数 | 格式 | 说明 | 示例 |
|---|---|---|---|
| 站号 | s=XXXXXXXXXXXX | 12位表地址 | 02010100;s=111111111111 |
常用数据标识:
| 地址 | 说明 |
|---|---|
02010100 | A相电压 |
02020100 | A相电流 |
02030000 | 瞬时总有功功率 |
00000000 | (当前)组合有功总电能 |
00010000 | (当前)正向有功总电能 |
完整的数据标识请参考DL/T 645-2007协议文档。
插件属性
DLT645-2007属性继承自 CollectFoundationDtuPropertyBase,包含以下配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 默认地址 | String | 111111111111 | 默认表地址(12位) |
| 密码 | String | - | 通信密码 |
| 操作员代码 | String | - | 操作员代码 |
| 前导符报文头 | String | FEFEFEFE | 前导符报文头 |
| 读写超时时间 | UInt16 | 3000 | 读写操作超时时间(ms) |
| 帧前时间 | Int32 | 0 | 发送帧前延时时间(ms) |
| 字符串反转字节 | Boolean | false | 字符串是否按字反转 |
| 数据解析顺序 | 枚举 | - | 数据字节序 |
| DTU ID | String | - | 默认DTU ID |
| 失败重试次数 | Int32 | 3 | 读写失败重试次数 |
| 读写占空比 | Int32 | 3 | n次写入操作会执行一次读取 |
| 写优先 | Boolean | false | 写入时强制取消读取操作 |
OPC UA客户端
寄存器地址格式
OPC UA使用节点的ItemId作为地址,直接填写OPC UA服务器的节点标识即可。
示例:
ns=2;s=Channel1.Device1.Tag1ns=2;i=1001
插件属性
OPC UA客户端属性继承自 CollectPropertyRetryBase,包含以下配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 连接Url | String | opc.tcp://127.0.0.1:49320 | OPC UA服务器地址 |
| 登录账号 | String | - | 用户名认证 |
| 登录密码 | String | - | 密码认证 |
| 数据变化触发条件 | 枚举 | StatusValue | 订阅数据变化触发条件 |
| 安全策略 | Boolean | true | 是否使用安全策略 |
| 名称标识 | String | ThingsGateway OPC UA Master | 应用名称标识 |
| 证书 | 证书选择 | - | 客户端证书(从证书管理获取) |
| 是否使用SourceTime | Boolean | true | 是否使用服务端时间戳 |
| 加载服务端数据类型 | Boolean | true | 是否加载服务端数据类型 |
| 激活订阅 | Boolean | true | 是否使用订阅模式 |
| 更新频率 | Int32 | 1000 | 订阅更新频率(ms) |
| 死区 | Double | 0 | 订阅死区百分比 |
| 最大组大小 | Int32 | 500 | 单个订阅组最大节点数 |
| 心跳频率 | Int32 | 3000 | 心跳间隔(ms) |
| 失败重试次数 | Int32 | 3 | 读写失败重试次数 |
| 读写占空比 | Int32 | 3 | n次写入操作会执行一次读取 |
| 写优先 | Boolean | false | 写入时强制取消读取操作 |
OPC DA插件仅支持Windows系统。
OPC DA客户端
寄存器地址格式
OPC DA使用节点的ItemName作为地址,直接填写OPC DA服务器的项名称即可。
示例:
Channel1.Device1.Group1.Tag1
插件属性
OPC DA客户端属性继承自 CollectPropertyRetryBase,包含以下配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| OPC服务器IP | String | localhost | OPC DA服务器IP地址 |
| OPC服务器名称 | String | Kepware.KEPServerEX.V6 | OPC DA服务器ProgID |
| 服务端时间 | Boolean | true | 是否使用服务端时间戳 |
| 订阅模式 | Boolean | true | 是否使用订阅模式 |
| 检测重连频率(min) | Int32 | 10 | 检测重连间隔(分钟) |
| 死区 | Float | 0 | 订阅死区百分比 |
| 最大组大小 | Int32 | 500 | 单个订阅组最大项数 |
| 订阅更新频率 | Int32 | 1000 | 订阅更新频率(ms) |
| 失败重试次数 | Int32 | 3 | 读写失败重试次数 |
| 读写占空比 | Int32 | 3 | n次写入操作会执行一次读取 |
| 写优先 | Boolean | false | 写入时强制取消读取操作 |
OPC DA插件仅支持Windows系统,基于COM/DCOM技术。
MQTT采集客户端
寄存器地址格式
MQTT采集客户端的变量地址格式为:
${mqtt_topic};${payload_item};${Condition}
| 部分 | 说明 |
|---|---|
mqtt_topic | MQTT主题 |
payload_item | JSON负载中的字段路径(支持.嵌套) |
Condition | 可选,条件名称(通过脚本判断) |
负载示例:
{
"ModuleUnoccupied": {
"EquipId": "E12",
"CarrierId": "C12",
"SubstrateLocId": "S12",
"LotId": 1,
"DesignId": "D12",
"EventTime": "12322131"
}
}
示例:
vendor/device;ModuleUnoccupied.EquipId— 结果为"E12"vendor/device;ModuleUnoccupied.EquipId;Condition名称— 通过脚本判断LotId等于1时返回"E12"
插件属性
MQTT采集客户端属性继承自 CollectPropertyBase,包含以下配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 连接类型 | 枚举 | Tcp | Tcp/WebSocket |
| IP地址 | String | localhost | MQTT服务器地址 |
| 端口 | Int32 | 1883 | MQTT服务器端口 |
| WebSocket路径 | String | /mqtt | WebSocket连接路径 |
| 启用SSL | Boolean | false | 是否使用SSL/TLS |
| SSL目标主机名 | String | - | SSL证书验证主机名 |
| 客户端证书名称 | 证书选择 | - | 客户端SSL证书 |
| CA名称 | 证书选择 | - | CA证书 |
| 允许不受信任证书 | Boolean | true | 是否允许不受信任的证书 |
| SSL协议版本 | 枚举 | None | SSL/TLS协议版本 |
| 检查证书吊销 | Boolean | false | 是否检查证书吊销 |
| 客户端ID | String | - | MQTT客户端标识 |
| 用户名 | String | - | 认证用户名 |
| 密码 | String | - | 认证密码 |
| 保活时间 | Int32 | 60 | Keep Alive时间(秒) |
| 清除会话 | Boolean | true | 是否清除会话 |
| MQTT协议版本 | 枚举 | V311 | MQTT协议版本 |
| QoS等级 | 枚举 | AtMostOnce | QoS等级(0/1/2) |
| 详细日志 | Boolean | false | 是否显示详细日志 |
| 连接超时时间 | Int32 | 3000 | 连接超时时间(ms) |
| 检查清除时间 | Int32 | 60000 | 检查清除时间(ms) |
MQTT采集服务端
寄存器地址格式
与MQTT采集客户端地址格式相同:
${mqtt_topic};${payload_item};${Condition}
插件属性
MQTT采集服务端属性继承自 CollectPropertyBase,包含以下配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 连接类型 | 枚举 | Tcp | Tcp/WebSocket |
| 端口 | Int32 | 1883 | MQTT服务监听端口 |
| WebSocket路径 | String | /mqtt | WebSocket路径 |
| 启用SSL | Boolean | false | 是否使用SSL/TLS |
| 服务器证书名称 | 证书选择 | - | 服务器SSL证书 |
| CA名称 | 证书选择 | - | CA证书 |
| 允许不受信任证书 | Boolean | true | 是否允许不受信任的证书 |
| SSL协议版本 | 枚举 | None | SSL/TLS协议版本 |
| 检查证书吊销 | Boolean | false | 是否检查证书吊销 |
| 允许连接ID前缀 | String | - | 允许连接的客户端ID前缀 |
| 用户名 | String | - | 认证用户名 |
| 密码 | String | - | 认证密码 |
| 详细日志 | Boolean | false | 是否显示详细日志 |
| 检查清除时间 | Int32 | 60000 | 检查清除时间(ms) |
业务插件
业务插件用于数据处理和转发,将采集到的数据推送到外部系统。
Modbus从站
插件属性
Modbus从站属性继承自 BusinessPropertyBase,包含以下配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| Modbus类型 | 枚举 | - | ModbusTcp/ModbusRtu |
| 默认站号 | Byte | 1 | 默认设备站号 |
| 数据解析顺序 | 枚举 | - | 数据字节序 |
| 字符串反转字节 | Boolean | false | 字符串是否按字反转 |
| 多站点模式 | Boolean | true | 是否启用多站点模式 |
| 允许RPC写入 | Boolean | true | 是否允许RPC写入 |
| 立即写入内存 | Boolean | true | 是否立即写入内存 |
| 发送延时时间 | Int32 | 0 | 发送延时时间(ms) |
变量属性
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| 是否启用 | Boolean | true | 否 | 变量是否启用 |
| 从站变量地址 | String | - | 是 | Modbus从站变量地址 |
| 数据类型 | 枚举 | Int16 | 否 | 变量数据类型 |
| 允许RPC写入 | Boolean | false | 否 | 是否允许RPC写入 |
MQTT客户端生产者
插件属性
MQTT客户端生产者属性继承自 BusinessPropertyWithCacheIntervalScript,包含以下配置:
MQTT连接配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 连接类型 | 枚举 | Tcp | Tcp/WebSocket |
| IP地址 | String | localhost | MQTT服务器地址 |
| 端口 | Int32 | 1883 | MQTT服务器端口 |
| WebSocket路径 | String | /mqtt | WebSocket连接路径 |
| 启用SSL | Boolean | false | 是否使用SSL/TLS |
| SSL目标主机名 | String | - | SSL证书验证主机名 |
| 客户端证书名称 | 证书选择 | - | 客户端SSL证书 |
| CA名称 | 证书选择 | - | CA证书 |
| 允许不受信任证书 | Boolean | true | 是否允许不受信任的证书 |
| SSL协议版本 | 枚举 | None | SSL/TLS协议版本 |
| 检查证书吊销 | Boolean | false | 是否检查证书吊销 |
| 客户端ID | String | - | MQTT客户端标识 |
| 用户名 | String | - | 认证用户名 |
| 密码 | String | - | 认证密码 |
| 保活时间 | Int32 | 60 | Keep Alive时间(秒) |
| 清除会话 | Boolean | true | 是否清除会话 |
| MQTT协议版本 | 枚举 | V311 | MQTT协议版本 |
| QoS等级 | 枚举 | AtMostOnce | QoS等级(0/1/2) |
| 保留消息 | Boolean | false | 是否保留消息 |
RPC配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| RPC写入Topic | String | - | 写入主题,实际为{RpcWrite/+},返回为{RpcWrite/+/Response} |
| 数据请求Topic | String | - | 接收数据后触发全量上传 |
| RPC脚本 | 脚本选择 | - | MQTT动态RPC脚本 |
数据上传配置(继承自 BusinessPropertyWithCacheIntervalScript):
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 启用缓存 | Boolean | false | 是否启用离线缓存 |
| 缓存文件最大行数 | Int32 | 262144 | 缓存文件最大行数 |
| 上传列表最大数量 | Int32 | 2000 | 单次上传最大数量 |
| 内存队列最大数量 | Int32 | 100000 | 内存队列最大数量 |
| 在线过滤 | Boolean | false | 仅上传在线设备数据 |
| 组更新 | Boolean | false | 是否按组更新 |
| 全部变量 | Boolean | false | 是否使用全部变量 |
| 上传模式 | 枚举 | - | 变化上传/定时上传 |
| 间隔上传时间 | String | 1000 | 定时上传间隔(ms) |
| 原子批量入队 | Boolean | false | 保证一组数据同一时间点可见 |
| 详细日志 | Boolean | false | 是否显示详细日志 |
| JSON缩进格式化 | Boolean | true | JSON是否缩进格式化 |
| JSON忽略Null | Boolean | true | JSON是否忽略Null值 |
| 设备列表上传 | Boolean | true | 是否上传设备列表 |
| 变量列表上传 | Boolean | true | 是否上传变量列表 |
| 报警列表上传 | Boolean | true | 是否上传报警列表 |
| 插件事件列表上传 | Boolean | true | 是否上传插件事件列表 |
| 设备Topic模板 | String | - | 设备数据上传主题,支持${key}匹配 |
| 变量Topic模板 | String | ThingsGateway/Variable | 变量数据上传主题 |
| 报警Topic模板 | String | - | 报警数据上传主题 |
| 插件事件Topic模板 | String | - | 插件事件上传主题 |
| 设备实体脚本 | 脚本选择 | - | 自定义设备实体模型脚本 |
| 变量实体脚本 | 脚本选择 | - | 自定义变量实体模型脚本 |
| 报警实体脚本 | 脚本选择 | - | 自定义报警实体模型脚本 |
| 插件事件实体脚本 | 脚本选择 | - | 自定义插件事件实体模型脚本 |
变量属性
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| 是否启用 | Boolean | true | 否 | 变量是否启用 |
| 数据1~数据10 | String | - | 否 | 自定义数据字段 |
| 允许RPC写入 | Boolean | false | 否 | 是否允许RPC写入 |
MQTT服务端生产者
插件属性
MQTT服务端生产者属性继承自 BusinessPropertyWithCacheIntervalScript,与MQTT客户端生产者类似,但作为服务端运行:
MQTT服务端配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 连接类型 | 枚举 | Tcp | Tcp/WebSocket |
| 端口 | Int32 | 1883 | MQTT服务监听端口 |
| WebSocket路径 | String | /mqtt | WebSocket路径 |
| 启用SSL | Boolean | false | 是否使用SSL/TLS |
| 服务器证书名称 | 证书选择 | - | 服务器SSL证书 |
| CA名称 | 证书选择 | - | CA证书 |
| 允许不受信任证书 | Boolean | true | 是否允许不受信任的证书 |
| SSL协议版本 | 枚举 | None | SSL/TLS协议版本 |
| 检查证书吊销 | Boolean | false | 是否检查证书吊销 |
| 允许连接ID前缀 | String | - | 允许连接的客户端ID前缀 |
| 用户名 | String | - | 认证用户名 |
| 密码 | String | - | 认证密码 |
| QoS等级 | 枚举 | AtMostOnce | QoS等级 |
| 保留消息 | Boolean | false | 是否保留消息 |
| RPC写入Topic | String | - | 写入主题 |
| 数据请求Topic | String | - | 接收数据后触发全量上传 |
| RPC脚本 | 脚本选择 | - | MQTT动态RPC脚本 |
数据上传配置与MQTT客户端生产者相同。
变量属性
与MQTT客户端生产者变量属性相同。
OPC UA服务端
插件属性
OPC UA服务端属性继承自 BusinessPropertyBase,包含以下配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 启用全部变量 | Boolean | false | 是否使用全部变量 |
| 服务地址 | String | opc.tcp://127.0.0.1:49321 | OPC UA服务地址(分号分隔可设置多个URL) |
| 名称标识 | String | ThingsGateway OPC UA Server | 应用名称标识 |
| 安全策略 | Boolean | false | 是否启用安全策略 |
| 用户名 | String | - | 认证用户名 |
| 密码 | String | - | 认证密码 |
| 服务器证书名称 | 证书选择 | - | 服务器证书(从证书管理获取) |
变量属性
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| 是否启用 | Boolean | true | 否 | 变量是否启用 |
| 数据类型 | 枚举 | Object | 否 | 变量数据类型 |
Kafka生产者
插件属性
Kafka生产者属性继承自 BusinessPropertyWithCacheIntervalScript,包含以下配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 服务地址 | String | 127.0.0.1:9092 | Kafka Bootstrap服务器地址 |
| 发布超时时间 | Int32 | 5000 | 发布超时时间(ms) |
| 用户名 | String | - | SASL认证用户名 |
| 密码 | String | - | SASL认证密码 |
| 安全协议 | 枚举 | Plaintext | 安全协议类型 |
| SASL机制 | 枚举 | Plain | SASL认证机制 |
数据上传配置与MQTT客户端生产者相同。
变量属性
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| 是否启用 | Boolean | true | 否 | 变量是否启用 |
| 数据1~数据10 | String | - | 否 | 自定义数据字段 |
RabbitMQ生产者
插件属性
RabbitMQ生产者属性继承自 BusinessPropertyWithCacheIntervalScript,包含以下配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| IP地址 | String | localhost | RabbitMQ服务器地址 |
| 端口 | Int32 | 5672 | RabbitMQ服务器端口 |
| 用户名 | String | guest | 认证用户名 |
| 密码 | String | guest | 认证密码 |
| 声明队列 | Boolean | false | 是否自动声明队列 |
| 声明交换机 | Boolean | false | 是否自动声明交换机 |
| 交换机类型 | String | topic | 交换机类型(direct/topic/fanout/headers) |
| 发布超时时间 | Int32 | 5000 | 发布超时时间(ms) |
| 虚拟主机 | String | / | RabbitMQ虚拟主机 |
| 交换机名称 | String | TG | 交换机名称 |
数据上传配置与MQTT客户端生产者相同。
变量属性
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| 是否启用 | Boolean | true | 否 | 变量是否启用 |
| 数据1~数据10 | String | - | 否 | 自定义数据字段 |
SQL数据库
插件属性
SQL数据库生产者属性继承自 BusinessPropertyWithCacheInterval,包含以下配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 数据库类型 | 枚举 | SqlServer | 数据库类型 |
| 分区类型 | 枚举 | - | 表分区类型 |
| 连接字符串 | String | - | 数据库连接字符串(必填) |
| 数值表名 | String | historyNumberValue | 数值类型历史数据表名 |
| 字符串表名 | String | historyStringValue | 字符串类型历史数据表名 |
| 实时表名 | String | realValue | 实时数据表名 |
| 保存天数 | Int32 | 3650 | 历史数据保存天数 |
| 是否保存历史数据 | Boolean | true | 是否保存历史数据 |
| 是否保存实时数据 | Boolean | true | 是否保存实时数据 |
| 历史表脚本 | 脚本选择 | - | 自定义历史表建表脚本 |
| 实时表脚本 | 脚本选择 | - | 自定义实时表建表脚本 |
缓存和上传配置继承自 BusinessPropertyWithCacheInterval。
变量属性
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| 是否启用 | Boolean | true | 否 | 变量是否启用 |
| 数据1~数据10 | String | - | 否 | 自定义数据字段 |
QuestDB
插件属性
QuestDB生产者属性继承自 BusinessPropertyWithCacheInterval,包含以下配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 连接字符串 | String | host=localhost;port=9000;username=admin;password=quest;database=qdb; | QuestDB连接字符串(必填) |
| 历史表脚本 | 脚本选择 | - | 自定义历史表建表脚本 |
| 数值表名 | String | historyNumberValue | 数值类型历史数据表名 |
| 字符串表名 | String | historyStringValue | 字符串类型历史数据表名 |
| 保存天数 | Int32 | 3650 | 历史数据保存天数 |
QuestDB的表名会自动转为小写。
TDengine
插件属性
TDengine生产者属性继承自 BusinessPropertyWithCacheInterval,包含以下配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 连接字符串 | String | protocol=WebSocket;host=localhost;port=6041;useSSL=false;username=root;password=taosdata;db=power; | TDengine连接字符串(必填) |
| 历史表脚本 | 脚本选择 | - | 自定义历史表建表脚本 |
| 数值表名 | String | historyNumberValue | 数值类型历史数据表名 |
| 字符串表名 | String | historyStringValue | 字符串类型历史数据表名 |
| 保存天数 | Int32 | 3650 | 历史数据保存天数 |
TDengine的表名会自动转为小写。
SQL历史报警
插件属性
SQL历史报警属性继承自 BusinessPropertyWithCache,包含以下配置:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 数据库类型 | 枚举 | SqlServer | 数据库类型 |
| 分区类型 | 枚举 | - | 表分区类型 |
| 连接字符串 | String | - | 数据库连接字符串(必填) |
| 表名 | String | historyAlarm | 报警历史表名 |
| 保存天数 | Int32 | 3650 | 报警数据保存天数 |
| 历史表脚本 | 脚本选择 | - | 自定义历史表建表脚本 |
Webhook
插件属性
Webhook属性继承自 BusinessPropertyWithCacheIntervalScript,默认变量Topic为 http://127.0.0.1:7502/ThingsGateway/Variable。
除默认值外,其余配置与 BusinessPropertyWithCacheIntervalScript 相同。
变量属性
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| 是否启用 | Boolean | true | 否 | 变量是否启用 |
| 数据1~数据10 | String | - | 否 | 自定义数据字段 |
公共属性说明
以下属性在多个插件中通用,此处统一说明。
采集插件公共属性
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 最大并发数量 | Int32 | 1 | 最大并发采集数量 |
| 离线恢复间隔 | Int32 | 0 | 离线后恢复运行的间隔时间 |
| 失败重试次数 | Int32 | 3 | 读写失败重试次数 |
| 读写占空比 | Int32 | 3 | n次写入操作会执行一次读取 |
| 写优先 | Boolean | false | 写入时强制取消读取操作 |
缓存公共属性
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 启用缓存 | Boolean | false | 是否启用离线缓存 |
| 缓存文件最大行数 | Int32 | 262144 | 单个缓存文件最大行数 |
| 上传列表最大数量 | Int32 | 2000 | 单次上传最大数量 |
| 内存队列最大数量 | Int32 | 100000 | 内存队列最大数量,超出转入文件缓存 |
| 在线过滤 | Boolean | false | 仅上传在线设备数据 |
| 组更新 | Boolean | false | 是否按组更新 |
变量属性公共字段
业务插件的变量属性默认包含以下自定义数据字段:
| 属性 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| 是否启用 | Boolean | true | 变量是否启用 |
| 数据1 | String | - | 自定义数据字段1 |
| 数据2 | String | - | 自定义数据字段2 |
| 数据3 | String | - | 自定义数据字段3 |
| 数据4 | String | - | 自定义数据字段4 |
| 数据5 | String | - | 自定义数据字段5 |
| 数据6 | String | - | 自定义数据字段6 |
| 数据7 | String | - | 自定义数据字段7 |
| 数据8 | String | - | 自定义数据字段8 |
| 数据9 | String | - | 自定义数据字段9 |
| 数据10 | String | - | 自定义数据字段10 |