DrvRedis Communicator Driver (Custom)

Functional Description

DrvRedis is a custom Communicator driver in ScadaV6CommExt for field device connectivity. Protocol details follow the source implementation.

Scope and Version

Source: ScadaV6CommExt/DrvRedis.Logic
TFM: net8.0
Version: 6.1.6

Install and Enable

Deploy driver binaries to Communicator folders.
Activate driver in Administrator → Communicator → Drivers.
Upload configuration and restart Communicator.

Line and Device Configuration

Create a communication line with the proper channel type.
Add device and set address/timeouts.
Set polling options and CmdLine as required by this driver; see Functional notes and configuration (template and source) below for file names, address format, and line keys.

CustomOptions (extracted)

Key	Default	Note
`RedisConn`	""	Extracted from source; confirm meaning in driver implementation.

Code hints

41: protected class TemplateDict : Dictionary
58: DeviceTemplate deviceTemplate;
69: ConnectionRequired = false;//不使用默认链接
105: protected virtual DeviceTemplate GetDeviceTemplate()
107: DeviceTemplate deviceTemplate = null;
108: string fileName = PollingOptions.CmdLine.Trim();
118: if (templateDict.TryGetValue(fileName, out DeviceTemplate existingTemplate))
126: DeviceTemplate newTemplate = CreateDeviceTemplate();
142: protected virtual DeviceTemplate CreateDeviceTemplate()
144: return new DeviceTemplate();
161: redisConn = LineContext.LineConfig.CustomOptions.GetValueAsString("RedisConn", "");
177: deviceTemplate = GetDeviceTemplate();

Administrator UI (DrvRedis.View)

Configure in Administrator → Communicator. Labels below come from the View language pack.

View source: ScadaV6CommExt/DrvRedis.View
Main forms:
- FrmDeviceProps.cs
- FrmDeviceTemplate.cs
- FrmTemplateOptions.cs

Phrase key	Text
`gbCmd`	Command Parameters
`lblCmdCode`	Command code
`lblCmdNum`	Command number
`lblCmdAddress`	Element address
`lblTemplateFileName`	Device template
`ConfigDirRequired`	The device template file must be located inside {0}
`TemplateNotExists`	The device template file does not exist.
`btnAddCmd.ToolTip`	Add Command
`gbTemplate`	Device Template
`TemplateTitle`	{0} - Device Template Editor
`DuplicatedCmdNums`	Duplicated command numbers:
`EmptyCmdCodes`	Empty command codes found.
`AddressHint`	{0}, starting from {1}
`lblCmdName`	Name
`lblCmdCodeWarn`	Fill out code
`lblCmdDataBlock`	Data block
`cbCmdDataBlock.Items[0]`	Coils (0X)
`cbCmdDataBlock.Items[1]`	Holding Registers (4X)
`cbCmdDataBlock.Items[2]`	Custom
`chkCmdMultiple`	Multiple
`lblCmdFuncCode`	Function code
`lblCmdFuncCodeHex`	Hexadecimal
`lblCmdElemType`	Element type
`cbCmdElemType.Items[0]`	Undefined
`cbCmdElemType.Items[1]`	ushort (2 bytes)
`cbCmdElemType.Items[2]`	short (2 bytes)
`cbCmdElemType.Items[3]`	uint (4 bytes)
`cbCmdElemType.Items[4]`	int (4 bytes)
`cbCmdElemType.Items[5]`	ulong (8 bytes)
`cbCmdElemType.Items[6]`	long (8 bytes)

Functional notes and configuration (template and source)

Derived from Logic/Common and device template XML: driver behavior and the Administrator/Communicator fields to set (address, CmdLine, line CustomOptions, template nodes).

Logic location

ScadaV6CommExt/DrvRedis.Logic
Common: DrvRedis.Common

Overrides

OnCommLineStart(), InitDeviceTags(), Session()

CmdLine / template

PollingOptions.CmdLine.Trim();

DeviceConfig properties referenced

Property	Note
未检测到 DeviceConfig.* 引用（可能使用基类封装）。

Line CustomOptions

Key	Default
`RedisConn`	""

XML keys (Common)

Node	Note
`Elem`	来自 Common 配置加载/保存相关源码中的 XML 节点名
`ZeroAddr`	来自 Common 配置加载/保存相关源码中的 XML 节点名
`DecAddr`	来自 Common 配置加载/保存相关源码中的 XML 节点名
`DefByteOrder2`	来自 Common 配置加载/保存相关源码中的 XML 节点名
`DefByteOrder4`	来自 Common 配置加载/保存相关源码中的 XML 节点名
`DefByteOrder8`	来自 Common 配置加载/保存相关源码中的 XML 节点名
`Options`	来自 Common 配置加载/保存相关源码中的 XML 节点名
`ElemGroups`	来自 Common 配置加载/保存相关源码中的 XML 节点名
`ElemGroup`	来自 Common 配置加载/保存相关源码中的 XML 节点名
`Cmds`	来自 Common 配置加载/保存相关源码中的 XML 节点名
`Cmd`	来自 Common 配置加载/保存相关源码中的 XML 节点名

Code excerpt

102:         /// 
103:         protected virtual DeviceTemplate GetDeviceTemplate()
104:         {
105:             DeviceTemplate deviceTemplate = null;

105:             DeviceTemplate deviceTemplate = null;
106:             string fileName = PollingOptions.CmdLine.Trim();
107: 
108:             if (string.IsNullOrEmpty(fileName))

158:         {
159:             redisConn = LineContext.LineConfig.CustomOptions.GetValueAsString("RedisConn", "");
160:             InitRedisConn();
161:         }

172:         /// 
173:         public override void InitDeviceTags()
174:         {
175:             deviceTemplate = GetDeviceTemplate();

174:         {
175:             deviceTemplate = GetDeviceTemplate();
176: 
177:             if (deviceTemplate == null)

226:         /// 
227:         public override void Session()
228:         {
229:             base.Session();

Troubleshooting

No data: line, address, template, connectivity.
Template load errors: check logs.
Options ignored: verify option scope (line vs device).

DrvRedis Driver (Custom)