a04cbced36
* mvp devcontainer. builds, runs and UI works
* fix indentation
* enable color and fix openpilot_env path
* separate dockerfile for devcontainer
* use prebuilt image
* Fix openpilot_env setup
* Add dev container section in readme
* Fix typo
* Fix typo again
* Move dev dockerfile to .devcontainer dir
* Update README
* Add note about x11 forwarding on macos
* Update dev container json
* Fix typo
* Override DISPLAY on macOS
* Mention XAUTHORITY for macOS setup in README
* fix typo
* Add devcontainer CI test
* Rename to devcontainer
* Fix git issues
* ripgrep
* Link instead of vscode manual
* Replace raw path with containerWorkspaceFolder
* Fix typo
* Remove dev tools workflow
* Link away X11 forwarding setup isntructions for mac
* Remove fork consrtaint, add test run of scons
* Add submodules as safe.directories in postStartCommand
* Remove openpilot_env references
* Add scons cache volume
---------
Co-authored-by: Robbe Derks <robbe@localhost.localdomain>
Co-authored-by: Kacper Rączy <gfw.kra@gmail.com>
old-commit-hash: d71a7190f1
3.8 KiB
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 --recurse-submodules https://github.com/commaai/openpilot.git
# or do a partial clone instead for a faster clone and smaller repo size
git clone --filter=blob:none --recurse-submodules --also-filter-submodules https://github.com/commaai/openpilot.git
cd openpilot
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)
Dev Container
openpilot supports Dev Containers. Dev containers provide customizable and consistent development environment wrapped inside a container. This means you can develop in a designated environment matching our primary development target, regardless of your local setup.
Dev containers are supported in multiple editors and IDEs, including Visual Studio Code.
X11 forwarding on macOS
GUI apps like ui or cabana can also run inside the container by leveraging X11 forwarding. To make use of it on macOS, additional configuration steps must be taken. Follow these steps to setup X11 forwarding on macOS.
Windows
Neither openpilot nor any of the tools are developed or tested on Windows, but the Windows Subsystem for Linux (WSL) should provide a similar experience to native 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. See these instructions for running GUI apps.
NOTE: If you are running WSL and any GUIs are failing (segfaulting or other strange issues) even after following the steps above, you may need to enable software rendering with LIBGL_ALWAYS_SOFTWARE=1, e.g. LIBGL_ALWAYS_SOFTWARE=1 selfdrive/ui/ui.
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