openxc-dump options and arguments

openxc-dump is a command-line tool to view the raw data stream from an attached vehicle interface or trace file. It attempts to read OpenXC messages from the interface specified at the command line (USB, serial or a trace file) and prints each message received to stdout.

Basic use

View everything:

$ openxc-dump

View only a particular message:

$ openxc-dump | grep steering_wheel_angle

Use a custom USB device:

$ openxc-dump --usb-vendor 4424

Use a a vehicle interface connected via serial instead of USB:

$ openxc-dump --serial --serial-device /dev/ttyUSB1

The serial-device option is only required if the virtual COM port is different than the default /dev/ttyUSB0.

Play back a trace file in real-time:

$ openxc-dump --trace monday-trace.json

Command-line options

A quick overview of all possible command line options can be found via --help.

--corrupted

Dump unparseable messages (assumed to be corrupted) in addition to valid messages.

Common interface options

These command-line options are common to all of the tools that connect to a CAN translator.

--usb

Use a vehicle interface connected via USB as the data source. USB is the default data source. This option is mutually exclusive with --serial and --trace.

--serial

Use a vehicle interface connected via a USB-to-serial adapter as the data source. This option is mutually exclusive with --usb and --trace.

--trace <tracefile>

Use a previously recorded OpenXC trace file as the data source. This option is mutually exclusive with --usb and --serial.

--usb-vendor <vendor_id>

Specify the USB vendor ID of the attached vehicle interface to use. Defaults to the Ford Motor Company vendor ID, 0x1bc4.

If the data source is not set to USB, this option has no effect.

--serial-port <port>

Specify the path to the virtual COM port of the vehicle interface. Defaults to /dev/ttyUSB0.

If the data source is not set to serial, this option has no effect.

--serial-baudrate <baudrate>

Specify the baudrate to use with the serial-based vehicle interface. Defaults to 115200.

If the data source is not set to serial, this option has no effect.

Traces

You can record a trace of JSON messages from the CAN reader with openxc-dump. Simply redirect the output to a file, and you’ve got your trace. This can be used directly by the openxc-android library, for example.

$ openxc-dump > vehicle-data.trace