Dialog: Edit Receive Sequence

<< Click to Display Table of Contents >>

Navigation:  Reference >

Dialog: Edit Receive Sequence

This dialog is used to define new Receive Sequences and edit existing ones (See also Editing and Managing Sequences).



The index of the sequence displayed below. The first sequence has index 0 (zero).


1 - Name

Unique name for this sequence (e.g. "Ping received"). This name is for referencing the sequence. It is not the sequence received through the serial port. See "2 - Sequence" below.


2 - Sequence

The character sequence which should be detected by Docklight within the incoming serial data.


TIP: Special Function Characters are available for detecting inter-character delays, evaluating handshake signal changes or detecting a break state.


3 - Action

The action(s) performed when Docklight detects the sequence defined above.


You may choose from the following actions:

Answer - After receiving the sequence, transmit one of the Send Sequences. Only Send Sequences that do not contain wildcards can be used as an automatic answer.

Comment - After receiving the sequence, insert a user-defined comment into the communication window (and log file, if available). Various comment macros are available for creating dynamic comment texts.

Trigger - Trigger a snapshot when the sequence is detected. This is an advanced feature described in the section Catching a specific sequence...

Stop - Stop communications and end the test run.

Checksum - Perform automatic validation of a checksum, including any type of CRC standard such as Modbus, CCITT, CRC32.
Set the Checksum Specification, as well as what should be done with the result:
Detect Checksum OK - the received data must have the same checksum than the calculated value from Docklight.
Checksum Wrong - the opposite. A mismatching checksum constitutes a "sequence match".
Both OK/Wrong - the sequence is always detected. The checksum area will contain all ASCII "1" (HEX 31) for a matching checksum, or ASCII "0" (HEX 30) for a wrong checksum.


TIP: See Calculating and Validating Checksums for a general overview, and Checksum Specification for the text format used to define a checksum.




Wildcards can be used to test for sequences that have a variable part with changing values (e.g. measurement or status values). See section Checking for sequences with random characters for details and examples.


Control Character Shortcuts

Using keyboard shortcuts is a great help when editing a sequence that contains both printing characters (letters A-z, digits 0-9, ...) and non-printing control characters (ASCII code 0 to 31). Predefined shortcuts are:

Ctrl+Enter for carriage return / <CR> / decimal code 13

Ctrl+Shift+Enter for line feed / <LF> / decimal code 10


Use WRENCH Options... --> Control Character Shortcuts to define other shortcuts you find useful.


Sequence Documentation

Add some documentation about this sequence here. This documentation is also shown in the main window when selecting the sequence in the Send Sequences list.