8aaf2fb168
* Condense plotjuggler streaming instructions
* add cabana share link to help output
* update juggle.py -h output
* redundant idiom
* Update tools/plotjuggler/juggle.py
* Update tools/plotjuggler/README.md
* Update README.md
Co-authored-by: Adeeb Shihadeh <adeebshihadeh@gmail.com>
old-commit-hash: f52dcd468c
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
- Clone openpilot into your home directory:
cd ~
git clone --recurse-submodules https://github.com/commaai/openpilot.git
- Run the setup script:
Ubuntu:
openpilot/tools/ubuntu_setup.sh
MacOS:
openpilot/tools/mac_setup.sh
- Build openpilot by running SCons in the root of the openpilot directory
cd openpilot && scons -j$(nproc)
- 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.
