HighSpeedPort protocol

Debugging with Wireshark

If there is something wrong with the communication, or if the HighSpeedPort Protocol should be implemented in a custom application, it is helpful to be able to analyze the communication. Wireshark is a tool that is able to capture HighspeedPort communication by setting a capture filter port 8001 or host $device_ip_address. 

There is also a Wireshark protocol script available that can decode the HighSpeedPort layer and visualize most of the files in a convenient way.

Usage:

1. Download the file to the Plugins directory in the Wireshark installation directory and rename it to “HighSpeedPort.lua”.
2. Edit (as administrator) the file init.lua from the Wireshark installation. Check if enable_lua = true and add dofile(DATA_DIR..”HighSpeedPort.lua“) at the end of the file.
3. Launch Wireshark. In the Analyze menu, select Enable Protocols… and verify that the HighSpeedPort protocol appears.

This chapter explains the possible commands for HighSpeedPort TCP/UDP.

This command is used to read a single online data frame. All data is coded binary and has to be decoded according to information from the #summary.sta file.

• Input and output data have to be regarded separately for reading and writing. The input data frame contains all data with I and I/O data direction. The output data frame includes all data with Output and Input / Output data direction.
• In the #summary.sta file, the offsets for input and/or output data frames are defined for every value with inSplitDataFieldOffset and/or outSplitDataFieldOffset.
• LengthWrite and LengthRead in parallel to the corresponding offsets are also depending on this configuration and cannot be overlapping these set values.
• To enable precision also for integer data, the #summary.sta file contains the precision (part of format) for every channel.
• For decoding, the integer value has to be multiplied with 10e^x
• All data is processed with a big-endian CPU, so maybe a byte swap at multi-byte elements needs to be done before working with it.

Request

Response

Command 0x01: States

This command is used to receive state information from the controller. Requests and responses have both fixed offsets and lengths. The states are delivered as integer values, which have to be interpreted as bit sets. If a bit according to the state coding format is set, the state is active.

Request

Response

This command is used to read and write date & time information. The data frame for reading and writing has a fixed format.

Date/Time frame:

[Year        -- 2 Bytes Integer]
[Month       -- 1 Byte Integer]
[Day         -- 1 Byte Integer]
[Hour        -- 1 Byte Integer]
[Minute      -- 1 Byte Integer]
[Second      -- 1 Byte Integer]
[Millisecond -- 2 Bytes Integer]

Controllers with an internal clock will not accept impossible values like 0000.00.00 00:00:00.

Request

This command is supported only by the TCP part of this port. HighSpeedPort TCP/IP CircleBuffer is used to read out the circular buffer of a controller. The circular buffer can contain a block of input data frames stored within the synchronization cycle time of the controller or lower if a divider for data reduction is defined. Requests and responses do not always conform to the protocol:

• LengthRead parameter is used to identify an additional sub-command and.
• OffsetRead is used as a buffer index.

The following subcommands are available with the right LengthRead setup:

Buffer States:

This subcommand reads state information from a defined buffer on the controller. Also to read the header size, which is needed for reading header data.

Request

This subcommand is used to read header data, which is needed for data decoding. The binary header data stream is coded in UDBF format (see Universal Data Bin File format on how to decode the data).

Requests

This command is used to read a single CircleBuffer data block. For decoding, the Buffer States and Buffer Header Data must be read first to get information about data types, precisions, and date/time.

Request

This command is used to start a service at the controller, which will periodically send data frames until the connection is terminated. The request is similar to Buffer Data Single, only LengthRead has a value of 3.

Request

Response

Buffer Data Single None Erasing With Preceding State Info:

This subcommand is used to read buffer data blocks, but without deleting the read data.

Request

This subcommand is used to read a single buffer data block from a specific time stamp and optionally to a specified end timestamp. It also returns preceding state information and the length of bytes to be transferred.

Request

This command is used to read files and file-related information from the controller. OffsetRead and LengthRead are used to determine between the following subcommands:

Response

This subcommand is used to read file names from the controller. The result can be cut by defining a specified DriveIndex.

Request

This subcommand is used to read a specified file on the controller as a binary stream.

Request

This command is used to read controller diagnostic information. The command defines if internal, external, or all information should be read. The response is split up into different themes, which give diagnostic information from different points of view:

• The interface theme contains diagnostic information about the field bus, UART, and internal system.
• The transport theme contains diagnostic information on the slave modules. The system variable and virtual variable sections are handled as transport entries.
• The variable theme contains the diagnostic information for every variable.

Command 0x09: DiagnosticsExFull

This command is used to read internal and external diagnostic information from the controller.

Request

Command 0x0A: DiagnosticsExInternal

This command is used to receive only diagnostic information from internal interfaces/modules/channels. Request and Response are similar to DiagnosticsExFull, only the command request - command is 10(A) and the response only delivers internal information.

Command 0x0B: DiagnosticsExExternal

This command is used to receive only diagnostic information from external interfaces/modules/channels. Request and Response are similar to DiagnosticsExFull, only the command request - command is 11(B) and the response only delivers external information.

Command 0x0C: Logger

This command is used to read out the test.con data logger. Reading out the data logger has to be done the same way as reading out the circular buffer. The same subcommands are available for Command 3: CircleBuffer. The request command is 12 (hex C) instead of 3 (exception: Buffer Data Continuous for test.con data loggers is not implemented).

Response

Free OutputCircleBuffer:

This subcommand is used to free, delete, or destroy an already initialized circle buffer (e.g. to change the geometry of the buffer).

Request

Response

GetSize OutputCircleBuffer:

This subcommand is used to get the free space of an OutputCircleBuffer.

Request

Response

AppendData OutputCircleBuffer:

This subcommand is used to append data to an output circle buffer.

Request

Response