diff --git a/tools/replay/README.md b/tools/replay/README.md index 67cfcd75a6..65a1e7a0b3 100644 --- a/tools/replay/README.md +++ b/tools/replay/README.md @@ -1,31 +1,55 @@ # Replay -## Replay driving data +`replay` allows you to simulate a driving session by replaying all messages logged during the use of openpilot. This provides a way to analyze and visualize system behavior as if it were live. -`replay` replays all the messages logged while running openpilot. +## Setup + +Before starting a replay, you need to authenticate with your comma account using `auth.py`. This will allow you to access your routes from the server. ```bash -# Log in via browser to have access to routes from your comma account +# Authenticate to access routes from your comma account: python3 tools/lib/auth.py +``` -# Start a replay +## Replay a Remote Route +You can replay a route from your comma account by specifying the route name. + +```bash +# Start a replay with a specific route: tools/replay/replay # Example: tools/replay/replay 'a2a0ccea32023010|2023-07-27--13-01-19' -# or use --demo to replay the default demo route: + +# Replay the default demo route: tools/replay/replay --demo +``` -# watch the replay with the normal openpilot UI -cd selfdrive/ui && ./ui +## Replay a Local Route +To replay a route stored locally on your machine, specify the route name and provide the path to the directory where the route files are stored. -# or try out radar point visualization in Rerun: -python3 replay/rp_visualization.py +```bash +# Replay a local route +tools/replay/replay --data_dir="/path_to/route" + +# Example: +# If you have a local route stored at /path_to_routes with segments like: +# a2a0ccea32023010|2023-07-27--13-01-19--0 +# a2a0ccea32023010|2023-07-27--13-01-19--1 +# You can replay it like this: +tools/replay/replay "a2a0ccea32023010|2023-07-27--13-01-19" --data-dir="/path_to_routes" +``` -# NOTE: To visualize radar points, make sure tools/replay/replay is running. +## Send Messages via ZMQ +By default, replay sends messages via MSGQ. To switch to ZMQ, set the ZMQ environment variable. + +```bash +# Start replay and send messages via ZMQ: +ZMQ=1 tools/replay/replay ``` -## usage +## Usage +For more information on available options and arguments, use the help command: ``` bash $ tools/replay/replay -h @@ -57,6 +81,30 @@ Arguments: connect.comma.ai ``` +## Visualize the Replay in the Openpilot UI +To visualize the replay within the openpilot UI, run the following commands: + +```bash +tools/replay/replay +cd selfdrive/ui && ./ui +``` + +## Try Radar Point Visualization with Rerun +To visualize radar points, run rp_visualization.py while tools/replay/replay is active. + +```bash +tools/replay/replay +python3 replay/rp_visualization.py +``` + +## Work with plotjuggler +If you want to use replay with plotjuggler, you can stream messages by running: + +```bash +tools/replay/replay +tools/plotjuggler/juggle.py --stream +``` + ## watch3 watch all three cameras simultaneously from your comma three routes with watch3