Troubleshooting Guide

Possible problems and their solutions.

Common Issues

This section will be expanded as we identify recurring issues.

Connecting

If you are having trouble connecting to your device, or a simulated stream, please refer to our Connections page.

Visualization

Please refer to the Voyant Visualizer Guide — or, for ROS 2 / Foxglove workflows, the Foxglove Visualization Guide.

Getting Help

If you’re experiencing problems with the Voyant SDK or device:

Check for Updates: Ensure you’re using the latest version of the SDK, as issues may have been resolved in newer releases. You can find the latest available release in our SDK repository: voyant-sdk/releases/latest.
GitHub Discussions: For general questions, sharing experiences, or requesting features, please check for or open a discussion in our SDK repository: voyant-sdk/discussions
GitHub Issues: For bug reports, please check for or open an issue in our SDK repository: voyant-sdk/issues
Contact Support: For urgent issues or problems with your device, contact our support team directly: support@voyantphotonics.com

When reporting an issue, please include:

SDK version
Operating system
A detailed description of the problem
Steps to reproduce the issue
Any error messages or logs
For data-quality issues: a support bundle capturing the problem

Capture a Support Bundle (Diagnostic Recording)

For issues with the point cloud itself — missing points, noise, artifacts — our support team will usually ask for a diagnostic recording: a short recording made in diagnostic mode, which keeps the points the sensor rejected (with the reason each was rejected) and captures the raw sensor data stream to a second file alongside the recording. The two files together let us replay exactly what your sensor saw.

Record one with either tool:

Visualizer — check Diagnostic mode when connecting, then record as usual: see Recording a Support Bundle.
Command line — pass --diagnostic-mode to voyant_logger_binary.

Either way the result is two files — the recording (<name>.vynt) and its raw-data sidecar (<name>_peaks.vynt). A few seconds capturing the problem is usually enough. Send both files to support@voyantphotonics.com; the sidecar is for our internal analysis and cannot be opened with the playback tools.

Opening Older Recordings

Recordings made with a pre-v1.0.0 release must be converted once to the current .vynt format — the error message names the exact command, and the visualizer offers the conversion automatically. See voyant_recording_migrate.

API Stability Notice

Releases before v1.0.0 (v0.x.x) were developer previews — breaking changes occurred in minor releases and are documented in our release notes.