Update rosbag_blackbox README to reflect current implementation#2
Merged
Merged
Conversation
Co-authored-by: marc-hanheide <1153084+marc-hanheide@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update README.md for rosbag_blackbox package
Update rosbag_blackbox README to reflect current implementation
Mar 12, 2026
marc-hanheide
approved these changes
Mar 12, 2026
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
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.
The README was written against an earlier version of the package and omitted several significant features added since, while also containing incorrect default values.
Corrections
buffer_duration:10s→60s(Features table, Node Parameters, Launch File)snapshot_name_pattern:snapshot_{datetime}→snapshot_{trigger}_{datetime}Missing features documented
type: "sensor_msgs/msg/Image") and combinedpattern+typerulesauto_snapshot:config section, sliding-window behaviour)node_params:config section,node_params.yamlsidecar)/topic_stats/{topic})/rosoutlog querying with level/node/grep filtersREST endpoint table
Added the 5 missing endpoints; corrected image endpoint response format (returns JSON
{"data_url": "data:image/png;base64,…"}, not a raw PNG byte stream). Added query-parameter tables for/rosout, image/sensor, and trajectory endpoints.MCP Tools section rewritten
The old section listed hand-crafted tool names (
list_snapshots,select_snapshot,search_topics, …) that never existed. Tools are auto-derived from FastAPI routes viaFastMCP.from_fastapi; the section now lists the actual function-derived names (list_snapshots_rest,get_metadata_rest,get_rosout_rest, etc.) and shows a corrected example interaction.Configuration Reference restructured
Split into subsections (Buffer Settings, Snapshot Output, Automatic Snapshots, Node Parameter Snapshotting, Topic Recording Rules) and updated all examples to match defaults in the code.
Architecture diagram
Updated to show the auto-snapshot timer,
node_params.yamlwrite path, and the full set of REST endpoints served bysnapshot_server.📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.