Voyant Pre-packaged Tools

Command-line programs for exploring and working with your Voyant sensor.

The voyant-api package installs a set of command-line tools. They are placed on your PATH (system-wide, or inside the provided Docker container) after installation.

Pro tip: every Voyant tool starts with the prefix voyant_. Type voyant_ in your terminal and press Tab to list them.

Most day-to-day work — live viewing and recording — is now done in the visualizer. The other tools cover headless and scripted workflows.

Available Tools

Visualize & connect

voyant_visualizer — 3D point-cloud viewer. Launch it bare for an interactive session (connect live or open a .bin log from the GUI), or pass connection arguments to jump straight into a live stream. Can also record live sessions in-app.
voyant_carbon_client_check — headless connection check: confirm the host is receiving a stream from the sensor.

Simulate (no hardware)

voyant_carbon_simulator — stream synthetic sensor data over UDP, then point the visualizer or any tool at it. Useful for development and testing without a sensor.

Record & play back

voyant_logger_binary — record the live stream to a binary (.bin) file.
voyant_playback_check — validate a recording and print frame metadata.

Verify install

voyant_hello_world — confirm the API is installed.

Getting Help

Each tool has built-in help. Use --help to see its options and examples:

voyant_visualizer --help

Internal tools

The package also bundles a few internal diagnostic utilities used by our test and CI systems. They are intentionally undocumented — if you think you need one, reach out to support@voyantphotonics.com.

Looking for a tool that used to live here? See Retired tools.

Next Steps

Once you’re comfortable with these tools, see the Python or C++ examples to integrate Voyant sensors into your own applications.