xcp.Channel Properties

Properties of the xcp.Channel object

Use the following properties to examine or configure xcp.Channel object settings. Use xcpChannel to create an XCP channel object.

xcp.Channel

ServerName — Name of connected server

Read-only: char

This property is read-only.

Name of the server node as specified in the A2L file, returned as a character vector. For example:

xcpch = xcpChannel(a2lfile,'CAN','Vector','Virtual 1',1);
sn = xcpch.ServerName

sn =

    'CPP'

Data Types: char

A2LFileName — Name of referenced A2L file

Read-only: char

This property is read-only.

Name of the referenced A2L file, returned as a character vector.

Data Types: char

TransportLayer — Type of transport layer used for XCP connection

Read-only: char

This property is read-only.

Type of transport layer used for XCP connection, returned as a character vector. For example:

xcpch = xcpChannel(a2lfile,'CAN','Vector','Virtual 1',1);
tl = xcpch.TransportLayer

tl =

    'CAN'

Data Types: char

TransportLayerDevice — XCP transport layer connection details

Read-only: struct

This property is read-only.

XCP transport layer connection details, including information about the device through which the channel communicates with the server, returned as a structure. For example:

xcpch = xcpChannel(a2lfile,'CAN','Vector','Virtual 1',1);
tld = xcpch.TransportLayerDevice

tld = 

  struct with fields:

          Vendor: 'Vector'
          Device: 'Virtual 1'
    ChannelIndex: 1

Data Types: struct

SeedKeyDLL — DLL file containing seed and key access algorithm

char

The SeedKeyDLL property indicates the name of the DLL file that contains the seed and key security algorithm used to unlock an XCP server module. The file defines the algorithm for generating the access key from a given seed according to ASAM standard definitions. For information on the file format and API, see the Vector web page Steps to Use Seed&Key Option in CANape or "Seed and Key Algorithm" in the NI™ CAN ECU Measurement and Calibration Toolkit User Manual. Note: The DLL must be the same bitness as MATLAB (64-bit).

Data Types: char

ConnectMode — Connection mode to server

char

The ConnectMode property specifies if custom connect modes are allowed. The supported property values are 'normal' (default) and 'user-defined' (allow custom modes). You set this property after creating the channel object, and before connecting. For example:

xcpch = xcpChannel(a2lfile,'CAN','Vector','Virtual 1',1);
xcpch.ConnectMode = 'user-defined';
connect(xcpch);

Data Types: char

Version History

Introduced in R2013a

R2024a: ConnectMode Property Added

The xcp.Channel object has a new property called ConnectMode, to support custom connect modes.