DrvRestGateway 通信驱动(自研)
功能描述
DrvRestGateway 为 ScadaV6CommExt 中的自研 Communicator 驱动,用于与现场设备或系统进行数据采集与命令交互。具体协议与能力以源码实现为准。
适用范围与版本
- 源码目录:
ScadaV6CommExt/DrvRestGateway.Logic - 目标框架:
net8.0 - 程序集版本:
6.0.0
安装与启用
- 按 RapidSCADA 标准流程将驱动 DLL 部署到 Communicator 安装目录(保持目录层级)。
- 在 Administrator 中打开项目 → Communicator → 驱动程序,确认驱动已出现在可用列表并激活。
- 上传配置到服务器并重启 Communicator 服务。
线路与设备配置(使用步骤)
- 在 Communicator → 通信线路 中新建线路,选择与本驱动匹配的通道类型(串口 / TCP / UDP 等,以界面为准)。
- 在线路下添加设备,填写设备地址、超时、重试等通用参数。
- 在设备 轮询选项 中配置命令行与其它选项:该驱动可能不通过标准 DeviceTemplate 文件加载,请以源码与界面配置为准。
- 保存项目并上传配置,观察 Communicator 日志与设备状态。
线路 CustomOptions 参数(源码提取)
下表由源码正则提取,供快速对照;最终以实际配置界面与注释为准。
| 参数键 | 默认值/片段 | 说明 |
|---|---|---|
未在源码中匹配到明显的 GetValueAs* 调用,请在 Administrator 中打开该驱动的设备/线路配置界面逐项确认。 | ||
配置相关源码片段(参考)
37: private const int DefaultHttpTimeoutMs = 30000; // 默认 HTTP 超时时间 30 秒
38: private const int MinHttpTimeoutMs = 1000; // 最小超时时间 1 秒
39: private const int MaxHttpTimeoutMs = 300000; // 最大超时时间 5 分钟
65: ConnectionRequired = false;
85: ScadaClient = new ScadaClient(CommContext.AppConfig.ConnectionOptions),
119: int timeoutMs = Math.Max(MinHttpTimeoutMs, Math.Min(MaxHttpTimeoutMs,
120: deviceOpt.RequestInterval > 0 ? deviceOpt.RequestInterval * 2 : DefaultHttpTimeoutMs));
126: Timeout = TimeSpan.FromMilliseconds(timeoutMs)
管理端配置界面(DrvRestGateway.View)
配置在 RapidSCADA Administrator → Communicator 中完成。以下词条来自 View 工程语言包,便于对照界面字段含义。
- View 源码:
ScadaV6CommExt/DrvRestGateway.View - 主要窗体:
- (无独立 Forms 目录或仅有控件)
| 界面词条 key | 说明(中文) |
|---|---|
DeviceMode.DisplayName | 设备模式 |
DeviceMode.Category | 设备参数 |
DeviceMode.Description | 设备工作模式(发送/接收) |
SendOnCommand.Category | 设备参数 |
RestUrl.DisplayName | REST 地址 |
RestUrl.Description | REST API 的 URL 地址 |
RequestInterval.Category | 设备参数 |
SendOnCommand.DisplayName | 指令触发发送 |
SendOnCommand.Description | 当收到指令时发送 HTTP 请求 |
SendPeriodically.Category | 设备参数 |
FormTitle | 设备 {0} 属性 - REST 网关 |
RestUrl.Category | 基本参数 |
RestMethod.DisplayName | 请求方法 |
RestMethod.Category | 基本参数 |
RestMethod.Description | HTTP 请求方法(GET/POST) |
ContentType.DisplayName | 内容类型 |
ContentType.Category | 基本参数 |
ContentType.Description | HTTP 请求的 Content-Type |
RequestInterval.DisplayName | 请求间隔 |
RequestInterval.Description | 周期请求的时间间隔(毫秒) |
SendPeriodically.DisplayName | 周期发送 |
SendPeriodically.Description | 按配置的周期自动发送 HTTP 请求 |
JsEnabled.DisplayName | 启用发送 JS |
JsEnabled.Category | JavaScript 引擎 |
JsEnabled.Description | 启用 JavaScript 引擎来组装发送请求 |
JsFileName.DisplayName | 发送 JS 文件名 |
JsFileName.Category | JavaScript 引擎 |
JsFileName.Description | 用于组装发送请求的 JS 脚本文件名 |
ResponseJsEnabled.DisplayName | 启用响应解析 JS |
ResponseJsEnabled.Category | JavaScript 引擎 |
完整模板编辑(如存在)一般在「设备模板编辑器」窗体中维护 XML/CSV 导入导出。
功能依据与配置要点(模板与源码)
下列要点依据仓库内 Logic / Common 及设备模板 XML 归纳,用于说明本驱动的行为以及在 Administrator / Communicator 中需要配置的项(设备地址、CmdLine、线路 CustomOptions、模板 XML 节点等)。
逻辑入口
- Logic 目录:
ScadaV6CommExt/DrvRestGateway.Logic - Common 目录:
ScadaV6CommExt/DrvRestGateway.Common
重写的关键方法
OnCommLineStart(), OnCommLineTerminate(), InitDeviceTags(), Session(), SendCommand()
设备模板 / CmdLine
未匹配到 PollingOptions.CmdLine 单行片段。
DeviceConfig 字段引用(源码中出现)
| 属性 | 说明 |
|---|---|
GetFileName | 源码中对 DeviceConfig 的引用 |
线路 CustomOptions(GetValueAs*)
| 参数键 | 默认值/片段 |
|---|---|
| 未在 Logic 中检测到 CustomOptions.GetValueAs*(可能全部从设备模板 XML 读取)。 | |
模板/配置 XML 节点(Common 提取)
| XML 节点 | 备注 |
|---|---|
DeviceOptions | 来自 Common 配置加载/保存相关源码中的 XML 节点名 |
Items | 来自 Common 配置加载/保存相关源码中的 XML 节点名 |
Item | 来自 Common 配置加载/保存相关源码中的 XML 节点名 |
RestUrl | 来自 Common 配置加载/保存相关源码中的 XML 节点名 |
RequestInterval | 来自 Common 配置加载/保存相关源码中的 XML 节点名 |
PublishPeriod | 来自 Common 配置加载/保存相关源码中的 XML 节点名 |
SendOnCommand | 来自 Common 配置加载/保存相关源码中的 XML 节点名 |
SendPeriodically | 来自 Common 配置加载/保存相关源码中的 XML 节点名 |
JsEnabled | 来自 Common 配置加载/保存相关源码中的 XML 节点名 |
JsFileName | 来自 Common 配置加载/保存相关源码中的 XML 节点名 |
ResponseJsEnabled | 来自 Common 配置加载/保存相关源码中的 XML 节点名 |
ResponseJsFileName | 来自 Common 配置加载/保存相关源码中的 XML 节点名 |
RestMethod | 来自 Common 配置加载/保存相关源码中的 XML 节点名 |
ContentType | 来自 Common 配置加载/保存相关源码中的 XML 节点名 |
DeviceMode | 来自 Common 配置加载/保存相关源码中的 XML 节点名 |
关键源码片段(节选)
575: ///
576: public override void InitDeviceTags()
577: {
578: TagGroup tagGroup = new();
602: ///
603: public override void Session()
604: {
605: base.Session();
604: {
605: base.Session();
606:
607: // check fatal error
654:
655: FinishSession();
656: }
657:
排障
- 设备无数据:检查线路通道、地址、模板文件、网络/串口连通性。
- 模板加载失败:查看 Communicator 日志中
Device template/Load template相关错误。 - 参数不生效:确认 CustomOptions 是否写在线路或设备正确层级(以驱动读取位置为准)。