Core: voyant_logger_binary

Record sensor data to binary format file.

🚧 These docs are out of date as of May, 2026. 🚧

They reflect the Meadowlark (Carbon dev kit) API and may not apply to Carbon systems.

Questions? Reach out to us at: support@voyantphotonics.com

This function records sensor data to a binary format file. This is the recommended method for logging Voyant LiDAR data, preserving all data in the native format for analysis and playback.

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:4444 --group-addr 224.0.0.0 --interface-addr 192.168.20.100

Time-Limited Recording

voyant_logger_binary --output session.bin --duration 60 --bind-addr 0.0.0.0:4444 --group-addr 224.0.0.0 --interface-addr 192.168.20.100

Frame-Limited Recording

voyant_logger_binary --output test.bin --frames 1000 --bind-addr 0.0.0.0:4444 --group-addr 224.0.0.0 --interface-addr 192.168.20.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 the native Voyant protobuf format and can be:

Played back with voyant_playback_check or voyant_playback_foxglove
Converted to other formats using data conversion tools
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