nopenpilot/tools/plotjuggler
Adeeb Shihadeh f295d51fe9 tools: auto plotjuggler install 2022-01-24 15:32:27 -08:00
..
layouts plotjuggler: plotjuggler: tuning layout w/ cruise setpoint, use carControl.enable not carControl.active (#22908) 2021-11-15 13:20:53 -08:00
.gitignore juggle: gitignore leftover rlog files 2021-02-25 18:40:19 +01:00
README.md plotjuggler: support segment names (#23263) 2022-01-04 15:55:46 +01:00
juggle.py tools: auto plotjuggler install 2022-01-24 15:32:27 -08:00
test_plotjuggler.py plotjuggler: add mac support (#23344) 2021-12-31 16:44:57 -08:00

README.md

PlotJuggler

PlotJuggler is a tool to quickly visualize time series data, and we've written plugins to parse openpilot logs. Check out our plugins: https://github.com/commaai/PlotJuggler.

Installation

Once you've cloned and are in openpilot, this command will download PlotJuggler and install our plugins:

cd tools/plotjuggler && ./juggle.py --install

Usage

$ ./juggle.py -h
usage: juggle.py [-h] [--demo] [--qlog] [--can] [--stream] [--layout [LAYOUT]] [--install]
                 [route_or_segment_name] [segment_count]

A helper to run PlotJuggler on openpilot routes

positional arguments:
  route_or_segment_name
                        The route or segment name to plot (cabana share URL accepted) (default: None)
  segment_count         The number of segments to plot (default: None)

optional arguments:
  -h, --help         show this help message and exit
  --demo             Use the demo route instead of providing one (default: False)
  --qlog             Use qlogs (default: False)
  --can              Parse CAN data (default: False)
  --stream           Start PlotJuggler in streaming mode (default: False)
  --layout [LAYOUT]  Run PlotJuggler with a pre-defined layout (default: None)
  --install          Install or update PlotJuggler + plugins (default: False)

Examples using route name:

./juggle.py "4cf7a6ad03080c90|2021-09-29--13-46-36"

Examples using segment name:

./juggle.py "4cf7a6ad03080c90|2021-09-29--13-46-36--1"

Streaming

Explore live data from your car! Follow these steps to stream from your comma device to your laptop:

  • Enable wifi tethering on your comma device
  • SSH into your device and run cd /data/openpilot && ./cereal/messaging/bridge
  • On your laptop, connect to the device's wifi hotspot
  • Start PlotJuggler with ZMQ=1 ./juggle.py --stream, find the Cereal Subscriber plugin in the dropdown under Streaming, and click Start.

If streaming to PlotJuggler from a replay on your PC, simply run: ./juggle.py --stream and start the cereal subscriber.

Demo

For a quick demo, go through the installation step and run this command:

./juggle.py --demo --qlog --layout=layouts/demo.xml

Layouts

If you create a layout that's useful for others, consider upstreaming it.

Tuning

Use this layout to improve your car's tuning and generate plots for tuning PRs. Also see the tuning wiki and tuning PR template.

--layout layouts/tuning.xml

screenshot