xcpChannel

Create XCP channel

Syntax

xcpch = xcpChannel(a2lFile,CANProtocol,vendor,deviceID)

xcpch = xcpChannel(a2lFile,CANProtocol,vendor,deviceID,deviceChannelIndex)

xcpch = xcpChannel(a2lFile,"TCP",IPAddr,portNmbr)

xcpch = xcpChannel(a2lFile,"UDP",IPAddr,portNmbr)

xcpch = xcpChannel(a2lFile,"TCP")

xcpch = xcpChannel(a2lFile,"UDP")

Description

xcpch = xcpChannel(a2lFile,CANProtocol,vendor,deviceID) creates a channel connected to the CAN bus via the specified vendor and device, using the specified CANProtocol of "CAN" or "CAN FD". The XCP channel accesses the server module via the CAN bus, parsing the attached A2L file.

Use this syntax for vendor "PEAK-System" or "NI". With NI^® CAN devices, the deviceID argument must include the interface number defined for the channel in the NI Measurement & Automation Explorer.

Note: XCP over CAN FD is not supported for PEAK-System devices.

xcpch = xcpChannel(a2lFile,CANProtocol,vendor,deviceID,deviceChannelIndex) creates a channel for the vendor "Vector", "Kvaser", or "MathWorks". Specify a numeric deviceChannelIndex for the channel.

xcpch = xcpChannel(a2lFile,"TCP",IPAddr,portNmbr) or xcpch = xcpChannel(a2lFile,"UDP",IPAddr,portNmbr) creates an XCP channel connected via Ethernet using TCP or UDP on the specified IP address and port.

XCP communication over UDP or TCP assumes a generic Ethernet adaptor. It is not supported on Ethernet connections of devices from specific vendors.

xcpch = xcpChannel(a2lFile,"TCP") and xcpch = xcpChannel(a2lFile,"UDP") use the IP address and port number defined in the A2L file.

Examples

Create an XCP Channel Using a CAN Server Module

Create an XCP channel using a Vector CAN module virtual channel.

Link an A2L file to your session.

a2l = xcpA2L("XCPSIM.a2l");

Create an XCP channel.

xcpch = xcpChannel(a2l,"CAN","Vector","Virtual 1",1)

xcpch = 

  Channel with properties:

              ServerName: 'CPP'
             A2LFileName: 'XCPSIM.a2l'
          TransportLayer: 'CAN'
    TransportLayerDevice: [1x1 struct]
              SeedKeyDLL: []

Create an XCP Channel for Ethernet

Create an XCP channel for TCP communication via Ethernet.

Link an A2L file to your session.

a2l = xcpA2L("XCPSIM.a2l");

Create an XCP channel.

xcpch = xcpChannel(a2l,"TCP","10.255.255.255",80)

xcpch = 

   Channel with properties:

              ServerName: 'CPP'
             A2LFileName: 'XCPSIM.a2l'
          TransportLayer: 'TCP'
    TransportLayerDevice: [1×1 struct]
              SeedKeyDLL: []

Input Arguments

a2lFile — A2L file

xcp.A2L object

A2L file, specified as an xcp.A2L object, used in this connection. You can create an A2L file object using xcpA2L.

CANProtocol — CAN protocol mode

"CAN" | "CAN FD"

CAN protocol mode, specified as "CAN" or "CAN FD".

Example: "CAN"

Data Types: char | string

vendor — Device vendor

"NI" | "Kvaser" | "Vector" | "PEAK-System" | "MathWorks"

Device vendor name, specified as a character vector or string.

Example: "Vector"

Data Types: char | string

deviceID — Device to connect to

character vector | string

Device on the interface to connect to, specified as a character vector or string.

For NI CAN devices, this must include the interface number for the device channel, defined in the NI Measurement & Automation Explorer.

Example: "Virtual 1"

Data Types: char | string

deviceChannelIndex — Index of channel on device

numeric value

Index of channel on the device, specified as a numeric value.

Example: 1

IPAddr — IP address of device

char vector | string

IP address of the device, specified as a character vector or string

Example: "10.255.255.255"

Data Types: char | string

portNmbr — Port number for device connection

numeric

Port number for device connection, specified as a numeric value.

Example: 80

Output Arguments

xcpch — XCP channel

xcp.Channel object

XCP channel, returned as an xcp.Channel object with xcp.Channel Properties.