The GenericProtocol tab contains specific settings for this Driver.
GenericProtocol tab
The available options on this tab are described on the next table.
Available options on the GenericProtocol tab
Option |
Description |
|---|---|
New Project |
Allows creating a new project |
Existing Project |
Allows selecting an existing project file, in XML format |
Project Name |
Specifies a name for a project. This field is disabled when selecting the New Project option |
Folder Path |
Shows the directory where a project is saved |
Browse |
When selecting the New Project option, this option allows selecting a directory to save this new project. When selecting the Existing Project option, this option allows selecting a project file, in XML format |
Name |
Specifies a name for a frame |
Type |
Specifies a type for a frame. Possible values for this option are TX: Transmission frame or RX: Reception frame |
Delete All |
Deletes all frames from the current project |
New Frame |
Opens the Frame configuration window, described next, to create a new frame |
To change the name of a registered frame in a project, right-click the name of a frame and select the Change Name option to open the window on the next figure.
Change Name window
To remove a registered frame in a project, right-click the name of a frame and select the Delete option. To edit a frame, double-click the name of a frame on the list.
Frame Configuration window
The available options on this window are described on the next table.
Available options on the Frame Configuration window
Option |
Description |
|---|---|
Max Size (bytes) |
Indicates the maximum valid size, in bytes, for a frame. This value must be in the range between 1 (one) and 1500 |
Accept Multiple Answers |
Enables the configuration of the maximum number of frames received and not read. These frames are stored until the older frames are deleted |
Indica the maximum number of frames received and not read. This value must be in the range between 1 (one) and 256 |
|
Field Name |
Name of a field |
Type of a field. Possible values for this option are Data [DT], Delimiter [DL], CheckSum8 [SUM], or CRC |
|
Optional |
Indicates whether this field is optional |
Requires that another field exists |
Indicates whether this field depends on the existence of another field |
Add Field |
Opens the Data Field Configuration window if the Field Type option was configured with the Data [DT] value, the Delimiter Field Configuration window if the Field Type option was configured with the Delimiter [DL] value, the CheckSum8 Field Configuration window if the Field Type option was configured with the CheckSum8 [SUM] value, or the CRC Field Configuration window if the Field Type option was configured with the CRC value |
To change the name of a field registered in a project, right-click the name of a field and select the Change Name option to open the window on the next figure.
Change Name window
To remove a field registered in a frame, right-click the name of a field and select the Delete option. To edit a field, double-click the name of a field on the list. The Message Formats list shows the result of the configured frames, displaying up to 255 valid frames. The Number of Valid Formats option on this window's footer shows the number of valid paths in a frame.
Data Field Configuration window
The available options on this window are described on the next table.
Available options on the Data Field Configuration window
Option |
Description |
|---|---|
Size Type |
Indicates the size of a field. Possible values for this option are Fixed: Fixed size in bytes, Automatic: Variable size without limits, or Bounded: Size in bytes with the possibility of defining a minimum size and a maximum size |
Fixed Size |
Fixed size of a field, in bytes. This option is only available when selecting the Fixed value in the Size Type option |
Minimum Size |
Minimum size of a field. This option is only available when selecting the Bounded value in the Size Type option |
Maximum Size |
Maximum size of a field. This option is only available when selecting the Bounded value in the Size Type option |
Type |
Indicates how a received data must be interpreted. Possible values for this option are Signed Integer, Unsigned Integer, Decimal, or String |
Format |
Indicates the format for receiving data. Possible values for this option are ASCII: Text format or HEX: Hexadecimal format (Raw) |
'+' Sign in Positive Values |
Indicates the presence of a plus (+) sign for positive values when the reception format is equal to ASCII and the data type is a number. Possible values for this option are Optional, Mandatory, or Forbidden |
Reverse bits |
Applies a bit reversing on received data before processing |
Swap WORDS |
Applies a swapping of Word values on received data before processing |
Swap Bytes |
Applies a swapping of bytes on received data before processing |
Swap DWORDS |
Applies a swapping of DWord values on received data before processing |
Validation Type |
Indicates whether any additional validation must be performed on the received data. Possible values for this option are No Validation: No validation, Value Limits: Allows setting minimum and maximum limits for a received number, or Value List: Allows defining a list of valid number or String values, based on the data type selected in the Type option |
Lower Limit |
Minimum value of a field. This option is only available when selecting the Value Limits value in the Validation Type option. By default, the minimum value includes the typed value. To exclude it, select the Exclusive option |
Upper Limit |
Maximum value of a field. This option is only available when selecting the Value Limits value in the Validation Type option. By default, the maximum value includes the typed value. To exclude it, select the Exclusive option |
Valid Value |
Allows adding a valid value for the received field. The Valid Values list contains all valid values already registered |
To remove a valid value, right-click a value on the Valid Values list and select the Delete option.
Delimiter Field Configuration window
The available options on this window are described on the next table.
Available options on the Delimiter Field Configuration window
Option |
Description |
|---|---|
Delimiter |
Field delimiter |
Format |
Format of a delimiter. Possible values for this option are ASCII: Delimiter in text format or HEX: Delimiter in hexadecimal format. NOTE: The ASCII option accepts spaces both in the beginning and in the end and the HEX option does not accept spaces and the 0x prefix must be omitted |
CheckSum8 Field Configuration window
The available options on this window are described on the next table.
Available options on the CheckSum8 Field Configuration window
Option |
Description |
|---|---|
Method |
Indicates a calculation method for the checksum. Possible values for this option are XOR: Uses the Exclusive Or method, Modulo: Sums all bytes from the selected region and gets the rest of the division by 256, or Two's Complement: Sums all bytes from the selected region, inverts all bits from the result, and adds 1 (one) |
Format |
Indicates the format for receiving the data. The possible values for this option are ASCII: Hexadecimal in text format (0xFF represented as "FF") or HEX: Hexadecimal format (Raw) |
Swap Nibble |
Applies a four-bit permutation to the received data before processing |
Start |
Selects a frame field where the calculation of the checksum starts |
End |
Selects a frame field where the calculation of the checksum ends |
CRC Field Configuration window
The available options on this window are described on the next table.
Available options on the CRC Field Configuration window
Option |
Description |
|---|---|
Bit Length |
Indicates the size of a CRC (Cyclic Redundancy Check) code in bits. Possible values for this option are CRC-8: 8-bit size, CRC-16: 16-bit size, or CRC-32: 32-bit size |
Predefined |
Indicates a pre-defined type of CRC. Possible values for this option are CRC8, CRC8_8H2F, CRC8_CDMA200, CRC8_DARC, CRC8_DVB_S2, CRC8_EBU, CRC8_ICODE, CRC8_ITU, CRC8_MAXIM, CRC8_ROHC, CRC8_SAE_J1850, CRC8_SAE_J1850_ZERO, or CRC8_WCDMA |
Custom |
Allows customizing a type of CRC. Selecting this option enables the next options |
Input Reflected |
Reverts the received bytes |
Result Reflected |
Reverts the calculated CRC code |
Polynomial |
Polynomial value of the CRC code, in hexadecimal format without spaces and omitting the 0x prefix |
Initial Value |
Initial value of the Exclusive Or method of the CRC code, in hexadecimal format without spaces and omitting the 0x prefix |
Final Xor Value |
Final value of the Exclusive Or method of the CRC code, in hexadecimal format without spaces and omitting the 0x prefix |
Format |
Indicates the format for receiving a CRC. Possible values for this option are ASCII: Hexadecimal in text format (0xFF represented as "FF") or HEX: Hexadecimal format (Raw) |
Reverse bits |
Applies a bit reversing on the received CRC before processing |
Swap WORDS |
Applies a swapping of Word values on the received CRC before processing |
Swap Bytes |
Applies a swapping of bytes on the received CRC before processing |
Start |
Select the frame field where the calculation of the CRC code starts |
End |
Select the frame field where the calculation of the CRC code ends |
NOTE |
All windows automatically save their changes, except the main window to configure this Driver. In this case, click Apply to save in-memory changes and click OK to save all changes and close the window. |