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.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Willem Melching 67f41f32f1 Sphinx docs generation (#22697) 4 years ago
..
joystick Fixup joystick (#21129) 4 years ago
lib Sphinx docs generation (#22697) 4 years ago
plotjuggler update demo route (#22381) 4 years ago
replay Sphinx docs generation (#22697) 4 years ago
scripts fix: spelling typos (#21861) 4 years ago
serial faster connect 4 years ago
sim sim: set fingerprint with environment variable (#22679) 4 years ago
ssh update ssh readme for c3 4 years ago
webcam update to python 3.8.5 (#20217) 4 years ago
zookeeper do not run on import 4 years ago
CTF.md Sphinx docs generation (#22697) 4 years ago
README.md ubuntu_setup.sh: add 21.10 support and change packages (#22628) 4 years ago
__init__.py merge in tools 5 years ago
mac_setup.sh tools: use .python-version in setup scripts (#22511) 4 years ago
openpilot_build.sh build script that uses docker container (#1944) 5 years ago
openpilot_env.sh Fix path issues in ubuntu_setup.sh and openpilot_env.sh (#21380) 4 years ago
ubuntu_setup.sh tools/setup: add missing package for plotjuggler (#22713) 4 years ago

README.md

openpilot tools

SSH

Connect to your comma device using SSH

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

  1. Clone openpilot into your home directory:
cd ~
git clone --recurse-submodules https://github.com/commaai/openpilot.git
  1. Run the setup script:

Ubuntu 20.04 LTS:

openpilot/tools/ubuntu_setup.sh

MacOS:

openpilot/tools/mac_setup.sh
  1. Build openpilot by running SCons in the root of the openpilot directory
cd openpilot && scons -j$(nproc)
  1. Try out some tools!

NOTE: you can always run update_requirements.sh to pull in new python dependencies.

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.

Tools

Plot logs

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

Run openpilot in a simulator

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

Replay a drive

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

Debug car controls

Use a joystick to control your car.

Welcomed contributions

  • Documentation: code comments, better tutorials, etc
  • Support for platforms other than Ubuntu 20.04
  • Performance improvements
  • More tools: anything that you think might be helpful to others.

Imgur