openxc-dashboard options and arguments

openxc-dashboard is a command-line tool that displays the current values of all OpenXC messages simultaneously. The dashboard uses curses to draw a basic GUI to the terminal.

Only OpenXC messages in the official public set will be displayed. Unofficial messages may be received, but will not appear on the dashboard.

For each message type, the dashboard displays:

  • Message name
  • Last received value
  • A simple graph of the current value and the range seen
  • Total number received since the program started
  • A rough calculation of the frequency the message is sent in Hz

If the terminal window is not wide enough, only a subset of this data will be displayed. The wider you make the window, the more you’ll see. The same goes for the list of messages - if the window is not tall enough, the message list will be truncated.

The dashboard also displays some overall summary data:

  • Total messages received of any type
  • Total amount of data received over the source interface
  • Average data rate since the program started

If the number of message types is large, you can scroll up and down the list with the arrow keys or Page Up / Page Down keys.

This is a screenshot of the dashboard showing all possible columns of data.

../_images/dashboard.png

This screenshot shows the dashboard displaying raw CAN messages (the vehicle interface must have CAN passthrough enabled).

../_images/dashboard-raw.png

Basic use

Open the dashboard:

$ openxc-dashboard

Use a custom USB device:

$ openxc-dashboard --usb-vendor 4424

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

$ openxc-dashboard --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-dashboard --trace monday-trace.json

Command-line options

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

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.