Connecting to your comma device using SSH

openpilot is developed and tested on Ubuntu 20.04, which is the primary development target aside from the supported embdedded hardware. We also have a CI test to verify that openpilot builds on macOS, but the tools are untested. For the best experience, stick to Ubuntu 20.04, otherwise openpilot and the tools should work with minimal to no modifications on macOS and other Linux systems.

1. Clone openpilot into home directory:

cd ~

git clone --recurse-submodule https://github.com/commaai/openpilot.git

2. Run setup script:

Ubuntu:

openpilot/tools/ubuntu_setup.sh

MacOS:

openpilot/tools/mac_setup.sh

3. Compile openpilot by running SCons in openpilot directory

cd openpilot && scons -j$(nproc)

4. Try out some tools!

Easily plot openpilot logs with PlotJuggler, an open source tool for visualizing time series data.

Test openpilots performance in a simulated environment. The CARLA simulator allows you to set a variety of features like:

• Weather
• Environment physics
• Cars
• Traffic and pedestrians

Review video and log data from routes and stream CAN messages to your device.

Use a joystick to control your car.

• Documentation: code comments, better tutorials, etc..
• Support for other platforms other than Ubuntu 20.04.
• Performance improvements: the tools have been developed on high-performance workstations (12+ logical cores with 32+ GB of RAM), so they are not optimized for running efficiently. For example, ui.py might not be able to run real-time on most PCs.
• More tools: anything that you think might be helpful to others.