Logboy

Logboy is a ROS 2 .mcap recording tool with both a CLI and a web-based GUI. It provides real-time topic monitoring, interactive topic selection, and integrates with Bagman for recording management.

Note: This tool is in development. Some features are not yet implemented.

Table of Contents

• Features
• Prerequisites
• Installation
• Usage
  • GUI
  • CLI
• Contributing

Features

• Recording: Record ROS 2 topics to .mcap files with configurable storage path, robot name, max duration, and delay.
• Topic Monitoring: Real-time FPS, drop rate, and age tracking for all subscribed topics.
• Interactive Topic Selection: Select and filter topics interactively from the CLI or GUI.
• Web GUI: Browser-based interface with live topic monitor, recording controls, and a storage browser.
• YAML Configuration: Flexible .yaml file for storage path, robot name, topic list, and expected FPS values.
• Integration with Bagman: Simplified upload and management of recordings.

Prerequisites

TBD

Installation

TBD

Usage

GUI

Start the GUI:

logboy_gui --config path/to/config.yaml

Record page — live topic monitor with FPS, drops, and message counts. Controls for max duration, start delay, and pause/resume.

Topic selection dialog — filter and select topics with live FPS, message type, and configurable expected FPS.

Storage page — browse, inspect, and delete recordings.

CLI

Record topics:

logboy record -c path/to/config.yaml

Monitor topics without recording:

logboy monitor -c path/to/config.yaml

Select topics interactively:

logboy topics -c path/to/config.yaml

Use ↑↓ to navigate, Space to toggle, type to filter, and Enter to confirm. The selection is saved back to the config file.

Browse recordings:

logboy recordings -c path/to/config.yaml

Contributing

Use pre-commit:

1. Install pre-commit:

   pip install pre-commit

2. Run pre-commit:

   pre-commit