Skip to content

Update plotjuggler documentation with route syntax #37010

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mvl-boston wants to merge 9 commits into
base: master
Choose a base branch
from
+7 −4
Open

Update plotjuggler documentation with route syntax #37010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
2e2b682
Align route examples with logreader readme, and add references to rea…
mvl-boston Jan 20, 2026
b10b8d8
Change README to a link.
mvl-boston Jan 20, 2026
c1b9dcb
improve link
mvl-boston Jan 20, 2026
2197252
Link typo fix
mvl-boston Jan 20, 2026
a86a606
Align capitalization for LogReader
mvl-boston Jan 20, 2026
f2961e3
Add that example route syntax is in README.md
mvl-boston Jan 20, 2026
bf375e8
Remove README reference as help text does not refer here.
mvl-boston Jan 20, 2026
7d03b11
Merge branch 'commaai:master' into plotjuggler-route
mvl-boston Jan 20, 2026
2e4bae7
Fix line too long CI
mvl-boston Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions tools/plotjuggler/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,15 @@ Example using route name:

Examples using segment:

`./juggle.py "a2a0ccea32023010/2023-07-27--13-01-19/1"`
`./juggle.py "a2a0ccea32023010/2023-07-27--13-01-19/4" # 4th segment`

`./juggle.py "a2a0ccea32023010/2023-07-27--13-01-19/1/q" # use qlogs`
`./juggle.py "a2a0ccea32023010/2023-07-27--13-01-19/4/q" # use qlogs`

Example using segment range:

`./juggle.py "a2a0ccea32023010/2023-07-27--13-01-19/0:1"`
`./juggle.py "a2a0ccea32023010/2023-07-27--13-01-19/4:6" # 4th and 5th segment`

Additional examples at [LogReader README.md](../lib/README.md)

## Streaming

Expand Down
3 changes: 2 additions & 1 deletion tools/plotjuggler/juggle.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,8 @@ def juggle_route(route_or_segment_name, can, layout, dbc, should_migrate):
parser.add_argument("--layout", nargs='?', help="Run PlotJuggler with a pre-defined layout")
parser.add_argument("--install", action="store_true", help="Install or update PlotJuggler + plugins")
parser.add_argument("--dbc", help="Set the DBC name to load for parsing CAN data. If not set, the DBC will be automatically inferred from the logs.")
parser.add_argument("route_or_segment_name", nargs='?', help="The route or segment name to plot (cabana share URL accepted)")
parser.add_argument("route_or_segment_name", nargs='?', help="The route or segment name to plot (cabana share URL accepted)." + \
" See README.md for example route syntax.")

if len(sys.argv) == 1:
parser.print_help()
Expand Down