update README.md

Signed-off-by: Takayuki Murooka <[email protected]>
autowarefoundation · Nov 21, 2024 · 2d534c3 · 2d534c3
1 parent df2570d
commit 2d534c3
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 1 deletion.
diff --git a/common/autoware_debug_tools/README.md b/common/autoware_debug_tools/README.md
@@ -107,3 +107,15 @@ ros2 run autoware_debug_tools cpu_usage_plotter <bag-path> -n 20
 ```
 
 ![cpu_usage_plot_example](images/cpu_usage_plot_example.png)
+
+## Rosout Log Reconstructor
+
+This script shows the log from the `/rosout` topic on the terminal.
+
+### Usage
+
+```bash
+ros2 run autoware_debug_tools rosout_log_reconstructor
+```
+
+![rosout_log_example](images/rosout_log_example.png)
diff --git a/common/autoware_debug_tools/autoware_debug_tools/rosout_log_reconstructor.py b/common/autoware_debug_tools/autoware_debug_tools/rosout_log_reconstructor.py
@@ -79,7 +79,11 @@ def on_rosout(self, msg):
             print(text)
 
 
-if __name__ == "__main__":
+def main():
     rclpy.init()
     node = RosoutLogReconstructor()
     rclpy.spin(node)
+
+
+if __name__ == "__main__":
+    main()
diff --git a/common/autoware_debug_tools/images/rosout_log_example.png b/common/autoware_debug_tools/images/rosout_log_example.png
diff --git a/common/autoware_debug_tools/setup.py b/common/autoware_debug_tools/setup.py
@@ -27,6 +27,7 @@
             "memory_usage_plotter = autoware_debug_tools.system_performance_plotter.memory_usage_plotter:main",
             "topic_connection_checker = autoware_debug_tools.topic_connection_checker.topic_connection_checker_node:main",
             "topic_localizer = autoware_debug_tools.topic_connection_checker.localize_topic:main",
+            "rosout_log_reconstructor = autoware_debug_tools.rosout_log_reconstructor:main",
         ],
     },
 )