Voyant API Examples
🚧 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
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
This section contains practical examples demonstrating how to use the Voyant API in various scenarios. Each example includes annotated code, explanations of key concepts, and instructions for running the code.
Python Bindings
Python bindings are available on PyPI starting with v0.4.4 and are compatible with both Meadowlark and Carbon systems:
pip install voyant-api
See the Installation Guide for full details including virtual environment setup.
Available Examples
C++
| Example | Description |
|---|---|
| Live Client (C++) | Connect to a Voyant sensor and capture live frames |
| Playback (C++) | Play back a recorded .bin file and access frame data |
| Data Recording (C++) | Record live sensor data to disk with file splitting options |
Python (available from v0.4.4)
| Example | Description | Since |
|---|---|---|
| Live Client (Python) | Receive and inspect live frames over multicast UDP | v0.4.4 |
| Playback (Python) | Play back a .bin recording and convert frames to pandas DataFrames | v0.4.4 |
| Data Recording (Python) | Record live sensor data to disk | v0.4.4 |
| PCD Conversion (Python) | Convert a .bin recording to per-frame .pcd files | v0.4.5 |
Running the Examples
All examples are available in the voyant-sdk repository.
C++ Examples
- Install the Voyant API (see Installation)
- Clone the
voyant-sdkrepository. - Build the examples (see Developer Quickstart)
Python Examples
- Install the Python bindings:
pip install voyant-api - Download the example scripts from voyant-sdk/python/examples/
- Run directly with Python 3.9+
Using these examples
You are encouraged to:
- Use these examples as starting points for your own applications
- Modify and adapt the examples to suit your needs
- Share your improvements with the community
When using the example code, please retain the copyright notices at the top of each file.