retropilot
/
openpilot
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
openpilot/tools
History
Kevin Roscom 74d47446a9 joystick controls working 2022-02-21 14:05:24 -07:00
..
carcontrols joystick controls working 2022-02-21 14:05:24 -07:00
clib Cleanup selfdrive/ includes (#20822) 2021-05-08 22:15:17 -07:00
lib tools/lib/auth.py update oauth redirect url 2021-05-17 14:51:29 +02:00
plotjuggler support file in juggle.py 2021-05-05 12:15:48 -07:00
replay fix unlog_segment.py 2021-05-18 11:14:42 +02:00
scripts merge tools/misc and tools/scripts 2021-03-08 20:37:21 -08:00
sim Set standstill bit in sim (#20921) 2021-05-15 21:09:17 -07:00
ssh tools/ssh cleanup 2021-04-06 15:00:11 -07:00
webcam tool to interactively create warp mesh 2022-01-19 12:34:18 -07:00
zookeeper Zookeeper support (#20000) 2021-04-13 15:08:00 -07:00
README.md README.md for SSH (#20365) 2021-03-21 18:58:58 -07:00
__init__.py merge in tools 2020-01-17 10:07:22 -08:00
mac_setup.sh fix mac setup script for zsh (#20708) 2021-04-20 17:28:10 -07:00
openpilot_build.sh build script that uses docker container (#1944) 2020-08-30 17:02:36 -07:00
openpilot_env.sh Setup script improvements to MacOS / Ubuntu (#2012) 2020-08-14 18:03:55 -07:00
test_ignition.py fake ignition script 2022-02-16 22:44:09 -06:00
ubuntu_setup.sh Mapbox widget (#20751) 2021-05-17 14:57:07 +02:00

README.md

openpilot tools

SSH

Connecting 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

  1. Clone openpilot into home directory:
cd ~

git clone --recurse-submodule https://github.com/commaai/openpilot.git
  1. Run setup script:

Ubuntu:

openpilot/tools/ubuntu_setup.sh

MacOS:

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

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 other platforms other than Ubuntu 20.04.
  • Performance improvements: the tools have been developed on high-performance workstations (12+ logical cores with 32+ GB of RAM), so they are not optimized for running efficiently. For example, ui.py might not be able to run real-time on most PCs.
  • More tools: anything that you think might be helpful to others.

Imgur