Add some introductory material to the README, and a Tips and Tricks section #1916
Conversation
emersonknapp
force-pushed
the
emerson/tips-n-tricks-readme-section
branch
from
8e2b2ae to
1963f70
Compare
…ection Signed-off-by: Emerson Knapp <[email protected]>
emersonknapp
force-pushed
the
emerson/tips-n-tricks-readme-section
branch
from
1963f70 to
2fb8a48
Compare
| ``` | ||
|
|
||
|
|
||
| ### Custom name with timestamp for bag directory |
There was a problem hiding this comment.
| ``` | |
| ### Custom name with timestamp for bag directory |
Custom name with timestamp for bag directory
| @@ -217,7 +228,7 @@ Topic information: Topic: /chatter | Type: std_msgs/String | Count: 9 | Serializ | |||
| Topic: /my_chatter | Type: std_msgs/String | Count: 18 | Serialization Format: cdr | |||
| ``` | |||
|
|
|||
| ### Converting bags | |||
| ### Converting bags (merge, split, etc.) | |||
There was a problem hiding this comment.
The link to this section in the list of verbs under Using rosbag2 needs to be updated. Search for #converting-bags.
| @@ -403,7 +414,7 @@ def generate_launch_description(): | |||
| ]) | |||
| ``` | |||
|
|
|||
| ## Using with composition | |||
| ### Using recorder and player as composable nodes | |||
There was a problem hiding this comment.
The link to this section under Using rosbag2 needs to be updated. Search for #using-with-composition.
| In shell: | ||
|
|
||
| ```bash | ||
| pushd $MY_BASE_DIR && ros2 bag record ... |
There was a problem hiding this comment.
Given that you used /my/bag/base_dir above, couldn't you use it here?
| pushd $MY_BASE_DIR && ros2 bag record ... | |
| pushd /my/bag/base_dir && ros2 bag record ... |
Same for the Python example below.
| └── rosbag2_2025_02_21-15_37_17_0.mcap | ||
| ``` | ||
|
|
||
| This can be accomplished without features in `rosbag2` itself. |
There was a problem hiding this comment.
We use rosbag2 (not rosbag2) almost everywhere else, so this should probably be:
| This can be accomplished without features in `rosbag2` itself. | |
| This can be accomplished without features in rosbag2 itself. |
|
|
||
| ### Custom name with timestamp for bag directory | ||
|
|
||
| You can fully customize the output bag name, without any `rosbag2` special features. |
There was a problem hiding this comment.
| You can fully customize the output bag name, without any `rosbag2` special features. | |
| You can fully customize the output bag name, without any rosbag2 special features. |
| @@ -2,7 +2,18 @@ | |||
|  | |||
| [](https://github.com/ros2/rosbag2/actions) | |||
|
|
|||
| Repository for implementing rosbag2 as described in its corresponding [design article](https://github.com/ros2/design/blob/ros2bags/articles/rosbags.md). | |||
| Rosbag2 - the tool for recording and playback of messages from ROS 2 topics. | |||
There was a problem hiding this comment.
I would use "rosbag2" here even at the start of a sentence, since this is how it's written in other places.
| Rosbag2 - the tool for recording and playback of messages from ROS 2 topics. | |
| rosbag2 -- the tool for recording and playback of messages from ROS 2 topics. |
There was a problem hiding this comment.
and now it actually supports services too.
There was a problem hiding this comment.
I actually prefer to use Rosbag2 starting from the capital R everywhere in the documentation and presentations.
The "rosbag2" is a package name, and it should be used with the small starting r when we mention this specific package name.
There was a problem hiding this comment.
That makes sense to me, but the README doesn't seem to adhere to that, or at least it's not very consistent. Anyway, we can leave it as-is and improve that later.
I would however do this:
| Rosbag2 - the tool for recording and playback of messages from ROS 2 topics. | |
| Rosbag2 -- the tool for recording and playback of messages from ROS 2 topics. |
| @@ -2,7 +2,18 @@ | |||
|  | |||
| [](https://github.com/ros2/rosbag2/actions) | |||
|
|
|||
| Repository for implementing rosbag2 as described in its corresponding [design article](https://github.com/ros2/design/blob/ros2bags/articles/rosbags.md). | |||
| Rosbag2 - the tool for recording and playback of messages from ROS 2 topics. | |||
There was a problem hiding this comment.
and now it actually supports services too.
The comment "this is already possible, but it's maybe not obvious" came up in two recent issue conversations, so I've added a new section "Tips & Tricks" to the
README.mdand added some clarifying introductory material as well to help navigate to it.Conversations of note at #1910 (comment) and #1595 (comment)