Record: voyant_logger_binary
Record sensor data to a binary (.bin) file.
Records the live sensor stream to a binary file in Voyant’s native format, preserving all data for later analysis and playback.
The visualizer can also record a live session interactively. Use
voyant_logger_binaryfor headless or scripted recording.
Use voyant_logger_binary --help to see all available options.
Usage
Basic Recording
voyant_logger_binary --output my_recording.bin --bind-addr 0.0.0.0:5678 --group-addr 239.255.48.84 --interface-addr 192.168.1.100
Time-Limited Recording
voyant_logger_binary --output session.bin --duration 60 --bind-addr 0.0.0.0:5678 --group-addr 239.255.48.84 --interface-addr 192.168.1.100
Frame-Limited Recording
voyant_logger_binary --output test.bin --frames 1000 --bind-addr 0.0.0.0:5678 --group-addr 239.255.48.84 --interface-addr 192.168.1.100
Expected Output
When recording starts:
Starting frame receiver...
Creating binary log file at "my_recording.bin"...
Starting recording with limit: unlimited (press Ctrl+C to stop)...
Recorded 50 frames (in 5s)
Recorded 100 frames (in 10s)
When stopped:
Stopping recording due to termination signal received
The log file has been closed and is ready for playback.
Options
--output <FILE>- Path for the binary output file (required)--duration <SECONDS>- Maximum recording duration (0 = unlimited) (default: 0)--frames <COUNT>- Maximum number of frames (0 = unlimited) (default: 0)--keep-invalid-points- Include invalid points in recordings
File Format
Binary files use Voyant’s native format and can be:
- Played back with
voyant_playback_checkor opened directly in the visualizer - Converted to ROS2 bag format via the voyant-ros repository
- Shared between systems without data loss
Troubleshooting
If recording fails:
- Verify network connectivity to the sensor
- Check that the output directory exists and is writable
- Ensure sufficient disk space for the recording
- Monitor frame rate — if 0 frames recorded, check network configuration