Skip to Content

面向用户: 实施工程师 / 项目经理 版本: viSCADA 1.8.0 及以上

本手册指导通过导入 YAML 协议文件、创建设备类并配置技术参数,将新协议接入 viSCADA 平台的端到端主流程。适用于首次接入新协议(如 OPCDA)或追加接入第三方协议脚本的场景。脚本的查看、导出与编辑操作参见 附录 A 查看、导出或编辑设备类脚本。

1 整体流程

图 1 YAML 协议导入与设备类创建主流程

步骤操作目标对应章节
① 新增协议脚本在平台中注册 YAML 协议脚本2 新增协议脚本
② 新增设备类并关联协议创建设备类并绑定已上传的协议3 新增设备类并关联协议
③ 配置技术参数按对接文档要求填写设备技术参数4 配置技术参数

2 新增协议脚本

2.1 操作入口

进入 「后台管理」 → 「协议管理」 菜单。

协议管理入口 图 2 协议管理 - 导航入口

2.2 字段说明

点击 「新增协议」 按钮,弹出 「新增协议」 对话框。

字段是否必填示例说明
「协议名称」是OPCDA协议唯一名称,建议与 YAML 文件内声明的协议保持一致
「协议文件」是opcda.yaml上传 YAML 格式的协议脚本文件

2.3 操作步骤

  1. 点击 「新增协议」 按钮。
  2. 填写 「协议名称」。
  3. 上传 「协议文件」(YAML 格式)。
  4. 点击 「添加协议」 完成提交。

新增协议按钮 图 3 协议管理 - 新增协议按钮

填写协议信息并上传 YAML 图 4 协议管理 - 新增协议填写页

添加协议确认 图 5 协议管理 - 添加协议确认

3 新增设备类并关联协议

3.1 操作入口

进入 「设备管控」 → 「设备类」 菜单,点击 「新增设备类」 按钮。

3.2 字段说明

字段是否必填示例说明
「设备类 ID」是deviceType001设备类唯一标识,用于脚本与属性绑定
「设备类名称」是OPCDA 测试设备用户自定义的中文名称
「标准化名称」是opcdaDevice与上位平台对接时使用的模型名称
「通讯协议」是OPCDA下拉选择 2 新增协议脚本 中上传的协议
「设备通讯类型」是直连设备直连设备 / 网关设备

3.3 操作步骤

  1. 填写 「设备类 ID」、「设备类名称」、「标准化名称」。
  2. 在 「通讯协议」 下拉框中选择 2 新增协议脚本 中上传的协议(例如 OPCDA)。
  3. 将 「设备通讯类型」 设置为 「直连设备」。
  4. 点击 「确认」 完成提交。

新增设备类填写页 图 6 设备类 - 新增填写页

⚠️ 「标准化名称」 不填写时,数据不会推送到 Kafka。

4 配置技术参数

📌 是否需要配置、配置哪些参数,以对应协议配置文档或数据对接文档为准。本章以 address 为示例说明通用操作;实际参数名称、取值格式、校验规则请严格按对接文档填写。

4.1 操作入口

在设备类详情页打开 「技术参数编辑」 模块。

技术参数编辑模块 图 7 设备类 - 技术参数编辑模块

4.2 操作步骤

  1. 点击 「+ 新增项」。
  2. 在 「参数名称」 下拉框中选择对接文档指定的参数。
  3. 在 「参数值」 中按对接文档要求的格式填写。
  4. 格式校验通过后点击 「确认」。

4.3 示例:OPCDA 协议配置 address

以 OPCDA 协议为例,其协议文件要求配置 address 参数:

字段是否必填示例说明
「参数名称」是address下拉选择协议文件声明的参数
「参数值」是127.0.0.1:4444设备通讯地址,格式为 IP:端口

⚠️ 配置 OPCDA 的 address 时,参数值仅填写 IP/域名及端口(如 127.0.0.1:4444),切勿携带 http://、https:// 等协议前缀,否则校验不通过。其他协议的参数名称与格式约束以对接文档为准。

5 常见问题

现象可能原因处理建议
上传 YAML 提示解析失败YAML 文件格式不合法或缩进错误使用 YAML Lint 工具校验文件后重新上传
新增设备类时 「通讯协议」 下拉框无目标协议协议脚本未成功添加返回 「后台管理」 → 「协议管理」 确认协议已存在,必要时重新上传
技术参数保存后数据仍无法采集address 填写带了 http:// 等前缀,或 IP/端口与现场设备不一致按 4.3 示例:OPCDA 协议配置 address 修正参数值
「标准化名称」 填写了但 Kafka 未收到数据上位平台的模型名称与 「标准化名称」 不一致与上位平台确认模型名后修正
设备类脚本修改后设备解析异常脚本改动破坏了已有解析逻辑通过 「重置脚本」 回退为协议初始配置,参见 附录 A 查看、导出或编辑设备类脚本

附录 A 查看、导出或编辑设备类脚本

📌 可选操作,仅在需要备份、修改或回退脚本时执行。

操作路径: 设备类详情页 → 「脚本」 页签

操作用途注意事项
「导出脚本」备份当前脚本文件到本地修改脚本前务必先导出备份
「保存」将编辑器内的脚本改动提交生效改动会影响该设备类下所有设备的解析逻辑
「重置脚本」恢复为协议初始配置重置后自定义修改全部丢失,不可撤销

设备类脚本页签 图 8 设备类 - 脚本页签

⚠️ 脚本修改会影响该设备类下所有设备的解析逻辑,修改前请先点击 「导出脚本」 备份。

01 设备类创建（单设备推送）