mawei
/
openpilot0
mirror of https://github.com/commaai/openpilot.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
openpilot0/tools
History
Adeeb Shihadeh ec47e0fef0 break up selfdrive.config (#23959) 
* break up selfdrive.config

* add to release files

* fix import order
old-commit-hash: 5c3f3e44bc
 		2022-03-13 21:42:39 -07:00
..
camerastream add script to receive camerastream supported by camerad 2022-03-11 20:05:59 -08:00
joystick linter: don't allow implicitly concatenated strings (#23513) 2022-01-13 14:19:38 -08:00
lib can_print_changes improvements 2022-03-10 14:32:19 -08:00
plotjuggler Add --dbc argument to plotjuggler (#23919) 2022-03-07 16:04:02 -08:00
replay break up selfdrive.config (#23959) 2022-03-13 21:42:39 -07:00
scripts MultiLogIterator: remove wraparound mode (#23360) 2022-01-02 15:16:44 -08:00
serial faster connect 2021-09-22 12:31:48 -07:00
sim sim: fix bridge after default values removed from CANParser 2022-01-29 18:22:14 -08:00
ssh
…
webcam smaller docker image (#23469) 2022-01-10 11:43:18 -08:00
zookeeper cleanup unused pip packages (#22947) 2021-11-17 16:23:03 +01:00
CTF.md Sphinx docs generation (#22697) 2021-10-28 15:14:37 +02:00
README.md tools: update README.md (#23447) 2022-01-07 14:03:27 -08:00
__init__.py
…
mac_setup.sh mac setup: add catch2 2022-03-05 15:29:06 -08:00
openpilot_build.sh
…
openpilot_env.sh mac: fix setup and re-enable CI (#23365) 2022-01-07 15:15:18 -08:00
ubuntu_setup.sh Revert "collect C++ code coverage (#23619)" 2022-01-26 10:59:21 +01:00

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