retropilot
/
openpilot
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
openpilot/tools
History
cydia2020 e87d88490b
README.md for SSH (#20365) 
* SSH README

* table of contents fix

* fix ambiguity

* removed some useless sections

* Update README.md

* fix line

* cleanup

* add link

* this is correct

* Add notice that key is only fetched once

* Update README.md

* end of sentence

* Even more

* Update tools/ssh/README.md

* move ssh above tools

* remove useless sections

* succint

* note

Co-authored-by: Adeeb Shihadeh <adeebshihadeh@gmail.com>
 		2021-03-21 18:58:58 -07:00
..
carcontrols improving tools readme (#20305) 2021-03-11 15:28:37 -08:00
clib NUI comma api intergration (#1186) 2020-03-01 22:06:33 -08:00
lib fix log values with non-utf8 characters and remove index_log (#20173) 2021-03-01 13:03:44 -08:00
nui tools: cleanup + setup CI (#20104) 2021-02-17 20:37:01 -08:00
plotjuggler Fix warning popup for file not found, batman. (#20364) 2021-03-16 19:31:24 -07:00
replay LateralPlanner should only compute curvature (#20289) 2021-03-11 21:08:51 -08:00
scripts merge tools/misc and tools/scripts 2021-03-08 20:37:21 -08:00
sim update simulator README 2021-03-17 00:42:32 -07:00
ssh README.md for SSH (#20365) 2021-03-21 18:58:58 -07:00
webcam update to python 3.8.5 (#20217) 2021-03-09 13:38:22 -08: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 cached mac CI run (#20294) 2021-03-09 19:37:17 -08: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
ubuntu_setup.sh improving tools readme (#20305) 2021-03-11 15:28:37 -08: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