Using pyXCP Command-Line Tools#

Note

New in v0.26.5+: For comprehensive CLI tools documentation, see cli_tools.

This page provides a quick overview. The new guide includes:

  • Detailed usage for all 7 CLI tools

  • Complete troubleshooting matrix

  • Transport-specific tips

  • Common workflows

  • Environment variables

pyXCP provides several command-line tools to help you work with XCP devices. These tools are installed automatically when you install the pyXCP package.

Quick Reference#

See cli_tools for detailed documentation of all tools.

Available Command-Line Tools#

pyXCP includes the following command-line tools:

  1. pyxcp-probe-can-drivers: Probes and lists available CAN drivers on your system.

  2. xcp-id-scanner: Scans for XCP slaves on a CAN bus.

  3. xcp-fetch-a2l: Fetches A2L file from an XCP slave.

  4. xcp-info: Displays information about an XCP slave. It supports skipping certain categories of information (DAQ, PAG, PGM, IDs) to speed up the process or avoid issues with specific slaves.

  5. xcp-profile: Creates new configuration files and converts legacy configuration files.

  6. xcp-examples: Shows available examples and how to run them.

  7. xmraw-converter: Converts XMRAW measurement files to other formats.

Basic Usage#

All command-line tools follow a similar pattern for specifying the transport layer and connection parameters:

<tool-name> -t <transport> --config <config-file>

Where: - <tool-name> is one of the tools listed above - <transport> is the transport layer (eth, can, usb, sxi) - <config-file> is the path to a configuration file

Examples#

Probe available CAN drivers:

pyxcp-probe-can-drivers

Display information about an XCP slave using Ethernet with Python configuration (recommended):

xcp-info -t eth --config conf_eth.py

You can also skip certain parts of the information gathering:

# Skip DAQ and PAG information
xcp-info -t eth --host 127.0.0.1 --port 5555 --no-daq --no-pag

Display information about an XCP slave using Ethernet with legacy TOML configuration:

xcp-info -t eth --config conf_eth.toml

Scan for XCP slaves on a CAN bus with Python configuration (recommended):

xcp-id-scanner -t can --config conf_can.py

Scan for XCP slaves on a CAN bus with legacy TOML configuration:

xcp-id-scanner -t can --config conf_can.toml

Convert an XMRAW file to CSV:

xmraw-converter measurement.xmraw -o csv

Using the xcp-profile Tool#

The xcp-profile tool helps you manage configuration files for pyXCP. It supports two main use cases:

  1. create: Generate a new Python-based configuration file with all available options

  2. convert: Convert a legacy .json/.toml configuration file to the new Python-based format

Create a New Configuration#

To create a new configuration file with all available options:

# Output to a file
xcp-profile create -o my_config.py

# Preview in terminal
xcp-profile create | less