sadmen
/
openpilot_comma
mirror of https://github.com/commaai/openpilot.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
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.
6136 Commits
122 Branches
82 Tags
5.1 GiB
 
 
 
 
 
 
Tag: Branch: Tree: f7df13244f
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'f7df13244f'
${ noResults }
openpilot_comma/tools
Adeeb Shihadeh 02f1866b61
CI: use ubuntu_setup.sh (#23349) 		3 years ago
..
joystick Python: Replace more lists with generators (#23116) 3 years ago
lib LogReader: add arg to sort by time (#23346) 3 years ago
plotjuggler plotjuggler: fix layout param (#23348) 3 years ago
replay Convert format strings strings to f-strings (#23241) 3 years ago
scripts Convert format strings strings to f-strings (#23241) 3 years ago
serial faster connect 4 years ago
sim Pyupgrade 3.6: Update syntax with Python 3.6+ features (#23305) 3 years ago
ssh update ssh readme for c3 4 years ago
webcam update to python 3.8.5 (#20217) 4 years ago
zookeeper cleanup unused pip packages (#22947) 3 years ago
CTF.md Sphinx docs generation (#22697) 4 years ago
README.md link to ctf in tools readme 3 years ago
__init__.py merge in tools 5 years ago
mac_setup.sh CI: use ubuntu_setup.sh (#23349) 3 years ago
openpilot_build.sh build script that uses docker container (#1944) 5 years ago
openpilot_env.sh CI: use ubuntu_setup.sh (#23349) 3 years ago
ubuntu_setup.sh CI: use ubuntu_setup.sh (#23349) 3 years ago

README.md

openpilot tools

CTF

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

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. Ensure you have a working OpenCL runtime:

You can verify your OpenCL installation with the clinfo command.

If you do not have any working platforms, you can download drivers from your GPU vendor's site. On Ubuntu you can just install one of the packages returned by apt search opencl-icd.

  1. Activate the Python environment:

Execute the following command in root openpilot directory:

pipenv shell

Your shell prompt should change to something similar to (openpilot) user@machine:~/openpilot$ .

  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.

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.

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