/
Generic User Protocol

Generic User Protocol

okt 21, 2020

Supported device types and versions
Communication line configuration
Communication station configuration
I/O tag configuration
Literature
Changes and modifications
Document revisions

 

Supported device types and versions

 

Generic User Protocol is intended to support an application-level implementation of simple and lightweight communication protocols directly in the D2000 Event process via an ESL script or Java code. It supports several types of lines including line-redundant and system-redundant ones. Data read from the communication are published into input I/O tags (IN) without waiting for any confirmation from the ESL script's side, therefore it is recommended to implement data handling via Server Event using the action ON CHANGE, eventually by a trigger event with a request queue configured, eventually by enabling multiple executions of the script (action ENABLE) so that all the published data is handled even under heavier load.

 

Communication line configuration

 

Category of communication line:

 

 

Communication line protocol parameters

 

Configuration line dialog box - tab Protocol parameters.
They influence some of the optional protocol parameters. The following line parameters can be set:

 

Table 1

 

Keyword

Full name

Description

Unit

Default value

RT

Read Wait Timeout

Waiting between individual data readouts from the communication. If no data was received during this period and previously some data was read, it will be published as a value of input I/O tag IN.
If some data was received during this period, it will be appended to a buffer, until a timeout occurs or the buffer becomes full (see a parameter Read Size). If a parameter Log Each Read is set to True, data will be published immediately regardless of the value of parameter Read Wait Timeout.

sec.mss

1.000

RS

Read Size

Maximum size (in bytes) of input data. Longer data will be published in several chunks.

-

1024

LE

Log Each Read

If this parameter is set to True, data will be published immediately regardless of the value of parameter Read Wait Timeout.

-

False

LF

Log Format

Format of data traces in log files: "0 - Hexa log" or "1 - Text log".
Setting the correct format helps to make a communication log file more readable depending on whether the specific protocol is text-oriented or binary by dumping the data in text or hexadecimal format.

-

0 - Hexa log

SL

Single Log

Setting this parameter to True will make all logs to go to a single file on redundant lines.
Setting this parameter to False means that two log files will be created for the primary/secondary line (Serial Line Redundant, SerialOverUDP Line Redundant, TCP/IP-TCP Redundant), or four log files will be created for the primary/secondary line of A/B system (Serial System&Line Redundant, SerialOverUDP System&Line Redundant).

-

False

 

Communication station configuration

 

  • Communication protocol Generic User.

  • The station address is not configured; it is recommended to configure a single station per line, but multiple stations are supported too. In this case, when data is received from the communication, it will be published via input I/O tags IN on all configured stations. Likewise, it will be possible to use output I/O tags OUT on any configured station.

 

I/O tag configuration

 

Possible value types of I/O tag: TxtI, TxtO.

 

Input I/O tags: