openpilot is an open source driver assistance system. openpilot performs the functions of Automated Lane Centering and Adaptive Cruise Control for over 200 supported car makes and models.

History

Shane Smiskol 2fa5a59e3f Fix can replay Jungle warning (#24364 )		3 years ago
..
camerastream	compressed_vipc: make yuv default	3 years ago
joystick	body: remove print spam	3 years ago
latencylogger	Latencylogger list logreader (#24276 )	3 years ago
lib	mypy: enable --warn-unused-ignores (#24287 )	3 years ago
plotjuggler	Fix PlotJuggler saved tuning layout (#24347 )	3 years ago
replay	Fix can replay Jungle warning (#24364 )	3 years ago
scripts	MultiLogIterator: remove wraparound mode (#23360 )	3 years ago
serial	faster connect	4 years ago
sim	Simulator: Fix keyboard input (#24320 )	3 years ago
ssh	remove comma two support (#24248 )	3 years ago
webcam	Don't build OpenCV tests in webcam docker image (#24326 )	3 years ago
zookeeper	pylint: enforce indentation (W0311) (#24039 )	3 years ago
CTF.md	Sphinx docs generation (#22697 )	4 years ago
README.md	tools: update README.md (#23447 )	3 years ago
__init__.py	merge in tools	5 years ago
mac_setup.sh	mac setup: add catch2	3 years ago
openpilot_env.sh	mac: fix setup and re-enable CI (#23365 )	3 years ago
ubuntu_setup.sh	ubuntu_setup.sh: support 22.04 LTS (#24312 )	3 years ago

README.md

openpilot tools

System Requirements

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.

Setup your PC

First, clone openpilot:

cd ~
git clone https://github.com/commaai/openpilot.git

cd openpilot 
git submodule update --init

Then, run the setup script:

# for Ubuntu 20.04 LTS
tools/ubuntu_setup.sh

# for macOS
tools/mac_setup.sh

Activate a shell with the install Python dependencies:

cd openpilot && pipenv shell

Build openpilot with this command:

scons -u -j$(nproc)

Windows

Neither openpilot nor any of the tools are developed or tested on Windows, but the Windows Subsystem for Linux (WSL) should get Windows users a similiar experience to Ubuntu. WSL 2 specifically has been reported by several users to be a seamless experience.

Follow these instructions to setup the WSL and install the Ubuntu-20.04 distribution. Once your Ubuntu WSL environment is setup, follow the Linux setup instructions to finish setting up your environment.

GUI applications do not work with WSL out of the box. You will have to either upgrade your system to Windows 11 or set up an Xorg server.

CTF

Learn about the openpilot ecosystem and tools by playing our CTF.

Directory Structure

├── ubuntu_setup.sh     # Setup script for Ubuntu
├── mac_setup.sh        # Setup script for macOS
├── joystick/           # Control your car with a joystick
├── lib/                # Libraries to support the tools and reading openpilot logs
├── plotjuggler/        # A tool to plot openpilot logs
├── replay/             # Replay drives and mock openpilot services
├── scripts/            # Miscellaneous scripts
├── serial/             # Tools for using the comma serial
├── sim/                # Run openpilot in a simulator
├── ssh/                # SSH into a comma device
└── webcam/             # Run openpilot on a PC with webcams