From 1c66515bed4401ac233afecee4689b5ea3af7a41 Mon Sep 17 00:00:00 2001
From: Dean Lee <deanlee3@gmail.com>
Date: Fri, 28 Feb 2025 20:48:22 +0800
Subject: [PATCH] cabana: simplify streaming arguments (#34730)

* simplify streaming arguments

* update README
---
 tools/cabana/README.md | 6 +++---
 tools/cabana/cabana.cc | 8 +++++---
 2 files changed, 8 insertions(+), 6 deletions(-)

diff --git a/tools/cabana/README.md b/tools/cabana/README.md
index 1d9a2a2ccc..0b7c5bf3ee 100644
--- a/tools/cabana/README.md
+++ b/tools/cabana/README.md
@@ -14,11 +14,11 @@ Options:
   --demo                         use a demo route instead of providing your own
   --qcam                         load qcamera
   --ecam                         load wide road camera
-  --stream                       read can messages from live streaming
+  --msgq                         read can messages from msgq
   --panda                        read can messages from panda
   --panda-serial <panda-serial>  read can messages from panda with given serial
   --socketcan <socketcan>        read can messages from given SocketCAN device
-  --zmq <zmq>                    the ip address on which to receive zmq
+  --zmq <ip-address>             read can messages from zmq at the specified ip-address
                                  messages
   --data_dir <data_dir>          local directory with routes
   --no-vipc                      do not output video
@@ -68,7 +68,7 @@ cd /data/openpilot/cereal/messaging/
 Then Run Cabana with the device's IP address:
 
 ```shell
-cabana --stream --zmq <ipaddress>
+cabana --zmq <ipaddress>
 ```
 
 Replace &lt;ipaddress&gt; with your comma device's IP address.
diff --git a/tools/cabana/cabana.cc b/tools/cabana/cabana.cc
index cd7a0be0db..d140a323e1 100644
--- a/tools/cabana/cabana.cc
+++ b/tools/cabana/cabana.cc
@@ -26,13 +26,13 @@ int main(int argc, char *argv[]) {
   cmd_parser.addOption({"qcam", "load qcamera"});
   cmd_parser.addOption({"ecam", "load wide road camera"});
   cmd_parser.addOption({"dcam", "load driver camera"});
-  cmd_parser.addOption({"stream", "read can messages from live streaming"});
+  cmd_parser.addOption({"msgq", "read can messages from the msgq"});
   cmd_parser.addOption({"panda", "read can messages from panda"});
   cmd_parser.addOption({"panda-serial", "read can messages from panda with given serial", "panda-serial"});
   if (SocketCanStream::available()) {
     cmd_parser.addOption({"socketcan", "read can messages from given SocketCAN device", "socketcan"});
   }
-  cmd_parser.addOption({"zmq", "the ip address on which to receive zmq messages", "zmq"});
+  cmd_parser.addOption({"zmq", "read can messages from zmq at the specified ip-address", "ip-address"});
   cmd_parser.addOption({"data_dir", "local directory with routes", "data_dir"});
   cmd_parser.addOption({"no-vipc", "do not output video"});
   cmd_parser.addOption({"dbc", "dbc file to open", "dbc"});
@@ -40,7 +40,9 @@ int main(int argc, char *argv[]) {
 
   AbstractStream *stream = nullptr;
 
-  if (cmd_parser.isSet("stream")) {
+  if (cmd_parser.isSet("msgq")) {
+    stream = new DeviceStream(&app);
+  } else if (cmd_parser.isSet("zmq")) {
     stream = new DeviceStream(&app, cmd_parser.value("zmq"));
   } else if (cmd_parser.isSet("panda") || cmd_parser.isSet("panda-serial")) {
     try {