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.
 
 
 
 
 
 
Kacper Rączy 1a5f29ecc6
macOS: disable camerad and sensord build (#28164)
2 years ago
..
cabana cabana: remove dead image from readme 2 years ago
camerastream compressed vipc: fix client connect 2 years ago
gpstest LaikaD new cache version (#27596) 2 years ago
joystick joystickd: add controller mapping (#25986) 3 years ago
latencylogger pre-commit: add codespell (#25571) 3 years ago
lib loggerd: move to system/ (#27534) 2 years ago
plotjuggler can states plotjuggler layout 2 years ago
replay tools: improved CAN replay (#27975) 2 years ago
scripts add pyside2 package (#25602) 3 years ago
serial use correct tty device for serial 3 years ago
sim scons: set warnings as error (#28004) 2 years ago
ssh ssh docs: corrections and readability improvements (#25482) 3 years ago
tuning tuning: measure steering accuracy for existing routes (#25722) 2 years ago
webcam Fix OpenCL driver URL (#26650) 2 years ago
zookeeper always show avg power 3 years ago
CTF.md move replay from selfdrive/ui/replay to tools/replay (#24971) 3 years ago
README.md tools: add cabana to README 2 years ago
__init__.py merge in tools 5 years ago
mac_setup.sh macOS: disable camerad and sensord build (#28164) 2 years ago
openpilot_env.sh mac: fix setup and re-enable CI (#23365) 3 years ago
ubuntu_setup.sh add libncurses5 to ubuntu_setup.sh (#27751) 2 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 embedded 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 Python dependencies installed:

cd openpilot && poetry 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 similar 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
├── cabana/             # View and plot CAN messages from drives or in realtime
├── 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