voyant_playback_foxglove

🚧 These docs are currently out of date. 🚧

They reflect the Meadowlark (Carbon dev kit) API and may not apply to Carbon systems.
Fully updated documentation will be published when Carbon Alpha ships in April 2026.

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

Replay recorded data in Foxglove Studio for visualization and analysis. Opens a WebSocket server, converts binary frames to Foxglove format, and streams for visualization.

Use voyant_playback_foxglove --help to see all available options.

Usage

Basic Playback

voyant_playback_foxglove --input my_recording.bin

Continuous Looping

voyant_playback_foxglove --input my_recording.bin --loopback

Custom WebSocket Port

voyant_playback_foxglove --input my_recording.bin --ws-port 9000

You can download sample datasets from the Playback Tools section.

For more detailed Foxglove user instructions, please see our Pointcloud Visualization guide.

Expected Output

When starting playback:

Starting foxglove websocket on port 8765...
Found valid Voyant data log file: DataLogPrefix { magic: [86, 89, 78, 84], file_header_size: 28 }
Log created at: 1743622138.467240245
Logged using API version: 0.1.0
Starting playback at 1.00x speed (filtering invalid points)...
(Press Ctrl+C to stop)

Connect to ws://localhost:8765 in Foxglove Studio to view the visualization.

Options

  • --input <FILE> - Path to the binary recording file
  • --rate <MULTIPLIER> - Playback speed (1.0 = real-time, 2.0 = double speed) (default: 1.0)
  • --loopback - Repeat playback when reaching end of file
  • --ws-port <PORT> - WebSocket port for Foxglove connection (default: 8765)
  • --keep-invalid-points - Include invalid points in visualization

Troubleshooting

If playback fails:

  • Verify the file is a valid Voyant .bin recording
  • Check that port 8765 (or custom port) isn’t already in use
  • Ensure Foxglove Studio can connect to the WebSocket address

Copyright © Voyant Photonics, Inc.

This site uses Just the Docs, a documentation theme for Jekyll.