nopenpilot/tools
HaraldSchafer 74b6c87254
cleanup old nidec accel override logic (#22181)
* cleanup old nidec accel override logic

* add ref without deprecated fields

* no more override
2021-09-10 10:34:18 -07:00
..
joystick Fixup joystick (#21129) 2021-06-11 14:33:17 -07:00
lib Less open file permissions (#21922) 2021-08-28 18:25:05 -07:00
plotjuggler Update plotjuggler readme for streaming, and cabana url input (#21938) 2021-08-16 22:23:42 -07:00
replay cleanup old nidec accel override logic (#22181) 2021-09-10 10:34:18 -07:00
scripts fix: spelling typos (#21861) 2021-08-05 12:05:49 -07:00
serial add login info to serial readme for c3 (#22016) 2021-08-23 11:32:43 -07:00
sim Change car controller interface from gas/brake to acceleration (#21911) 2021-08-30 09:32:52 -07:00
ssh update ssh readme for c3 2021-08-07 11:36:34 -07:00
webcam update to python 3.8.5 (#20217) 2021-03-09 13:38:22 -08:00
zookeeper use same env variable for loggerd, deleter, and uploader 2021-08-07 18:58:11 -07:00
README.md fix typo 2021-06-16 23:56:35 -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 Fix path issues in ubuntu_setup.sh and openpilot_env.sh (#21380) 2021-06-23 13:31:28 -07:00
ubuntu_setup.sh Fix path issues in ubuntu_setup.sh and openpilot_env.sh (#21380) 2021-06-23 13:31:28 -07: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 your home directory:
cd ~
git clone --recurse-submodules https://github.com/commaai/openpilot.git
  1. Run the setup script:

Ubuntu:

openpilot/tools/ubuntu_setup.sh

MacOS:

openpilot/tools/mac_setup.sh
  1. Build openpilot by running SCons in the root of the 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 platforms other than Ubuntu 20.04
  • Performance improvements
  • More tools: anything that you think might be helpful to others.

Imgur