juggle: add demo flag and improve README

old-commit-hash: 920b751888a09192f055241c7db6cfdfc5f1bf57
This commit is contained in:
Adeeb Shihadeh
2021-11-28 14:19:49 -08:00
parent 973a48acef
commit 807e84d900
2 changed files with 22 additions and 11 deletions
+15 -8
View File
@@ -1,10 +1,12 @@
# PlotJuggler
We've extended [PlotJuggler](https://github.com/facontidavide/PlotJuggler) to plot all of your openpilot logs. Check out our plugins: https://github.com/commaai/PlotJuggler.
[PlotJuggler](https://github.com/facontidavide/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, download PlotJuggler and install our plugins with this command:
**NOTE: this is Ubuntu only for now. Pull requests for macOS support are welcome.**
Once you've cloned and are in openpilot, this command will download PlotJuggler and install our plugins:
`cd tools/plotjuggler && ./install.sh`
@@ -12,9 +14,9 @@ Once you've cloned and are in openpilot, download PlotJuggler and install our pl
```
$ ./juggle.py -h
usage: juggle.py [-h] [--qlog] [--can] [--stream] [--layout [LAYOUT]] [route_name] [segment_number] [segment_count]
usage: juggle.py [-h] [--demo] [--qlog] [--can] [--stream] [--layout [LAYOUT]] [route_name] [segment_number] [segment_count]
PlotJuggler plugin for reading openpilot logs
A helper to run PlotJuggler on openpilot routes
positional arguments:
route_name The route name to plot (cabana share URL accepted) (default: None)
@@ -23,9 +25,10 @@ positional arguments:
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 without a route to stream data using Cereal (default: False)
--stream Start PlotJuggler in streaming mode (default: False)
--layout [LAYOUT] Run PlotJuggler with a pre-defined layout (default: None)
```
@@ -47,11 +50,15 @@ If streaming to PlotJuggler from a replay on your PC, simply run: `./juggle.py -
For a quick demo, go through the installation step and run this command:
`./juggle.py "https://commadataci.blob.core.windows.net/openpilotci/d83f36766f8012a5/2020-02-05--18-42-21/0/rlog.bz2" --layout=layouts/demo.xml`
`./juggle.py --demo --qlog --layout=layouts/demo.xml`
## Tuning
## Layouts
Use this layout to generate plots for tuning PRs. Also see tuning wiki and tuning PR template.
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`