Add new ros2 bag Kilted features + updates
#5771
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- These changes are meant to reflect the deprecation of positional topic arguments in favor of using --topics
- The bag directories are correctly explained in 3.1, but in subsequent sections it falls back to referring to the recordings as files. Adjust wording to explain that a bag directory is made - Change commands to capture the .mcap file inside the bag directory
- Add action and service info for ros2 bag info - Add playback controls and playback progress for ros2 bag play
- To make this progression logical, add an extra section where a recording is split into multiple bag files with -d arg in a bag directory called subset_separate - Later, use these separate files when explaining how to play all bag files from a single recording (just call ros2 bag play on the bag directory), as well as how to play multiple select files (using new arg -i!)
chen-harrison
changed the title
ros2 bag Kilted Features + Updatesros2 bag Kilted features + updates
fujitatomoya
reviewed
Jul 9, 2025
There was a problem hiding this comment.
overall lgtm with a few minor comments.
@christophebedard @MichaelOrlov either of you can review this?
...rials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
Show resolved
Hide resolved
...rials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
Show resolved
Hide resolved
...rials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
Outdated
Show resolved
Hide resolved
- Use keyboard syntax where appropriate
christophebedard
requested changes
Jul 16, 2025
...rials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
Outdated
Show resolved
Hide resolved
...rials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
Outdated
Show resolved
Hide resolved
...rials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
Outdated
Show resolved
Hide resolved
...rials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
Outdated
Show resolved
Hide resolved
...rials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
Outdated
Show resolved
Hide resolved
- For examples that involve calling ros2 bag info and ros2 bag play, have the example show it with playing the whole recording instead of individual files
- Change wording around splitting recording - Explain the use case of splitting recording
- Add example where there are two separate record commands, each recording a topic - Explain the use case for this separate recording - Add explanation of --message-order
|
@christophebedard I'm pretty new to open-source still so not sure what the cadence of these things are, but letting you know these changes should be ready for review, in case you were waiting for me to notify you. My only minor concern is that the "play multiple bags" section is a bit lengthy now based on the structure that we discussed, but let me know your thoughts. Thanks! |
Thank you! We're pretty busy, so a simple ping when the PR is ready for review again is helpful :)
I think it's good, and this way it's pretty self-contained. |
There was a problem hiding this comment.
You'll need to make sure that you have only 1 sentence per line (see CI): https://docs.ros.org/en/rolling/The-ROS2-Project/Contributing/Contributing-To-ROS-2-Documentation.html#writing-pages
Other than that and a small fix, this looks good to me!
...rials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
Outdated
Show resolved
Hide resolved
...rials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
Outdated
Show resolved
Hide resolved
...rials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
Outdated
Show resolved
Hide resolved
...rials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
Outdated
Show resolved
Hide resolved
...rials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
Outdated
Show resolved
Hide resolved
...rials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
Outdated
Show resolved
Hide resolved
...rials/Beginner-CLI-Tools/Recording-And-Playing-Back-Data/Recording-And-Playing-Back-Data.rst
Outdated
Show resolved
Hide resolved
christophebedard
added
the
backport-kilted
- Add/remove line breaks so that each sentence lives on its own line, adhering to the CI guidelines
chen-harrison
force-pushed
the
update-ros2-bag-tutorial
branch
from
4e33fbb to
998f0b4
Compare
christophebedard
approved these changes
Aug 29, 2025
christophebedard
pushed a commit
that referenced
this pull request
Aug 29, 2025
(cherry picked from commit b81dc71) Co-authored-by: Harrison Chen <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
ros2 bag playprogress bar-iargument to play multiple bags-iexplanation--topicstoros2 bag recordcommands to reflect the deprecation of positional topic arguments-oargument, if provided), and pathing to .mcap files now reflects thatros2 bag recordandros2 bag play, so as not to confuse the reader when their output differsFixes #5550