Voyant Carbon 30 SDK Documentation
Access and interact with your Carbon 30 LiDAR sensor and its data using Voyant’s SDK, API, and tools.
This repository hosts the documentation website for Voyant Photonics products and APIs. For practical implementation guidance, please see our:
- voyant-sdk - Contains Python and C++ examples for working with the Voyant API
- voyant-ros - Provides a driver for integration with ROS/ROS2 systems
The documentation provides comprehensive information about working with Voyant Photonics, Inc. device drivers and related software components.
What is Carbon 30?
Carbon 30 is a Frequency-Modulated Continuous Wave (FMCW) LiDAR sensor designed for robotics, automation, and research applications.The Carbon 30 LiDAR sensor provides flexible configuration options, and can precisely map in dynamic or complex scenes the following data simultaneously:
- 3D position (X, Y, Z)
- Radial velocity
- Reflectance
- Signal-to-noise ratio (SNR)
What to do with Carbon 30
- Stream live sensor data
- Record and replay datasets
- Visualize point clouds, both static and dynamic
- Access raw packet-level data for analysis
Using this SDK
You are encouraged to:- Use this documentation as a reference for working with Carbon 30
- Use the provided examples as starting points for your own applications
- Modify and adapt the examples to suit your needs
- Suggest improvements or corrections through pull requests
- Share your insights and improvements with Voyant and the community!
Get Started!
Follow this short menu to get acquainted with your Carbon 30 LiDAR sensor, then explore the entire repository once you are set up!
1. Sensor Quickstart 📌
Go quickly from setup to gathering your first set of data in minutes.
2. Visualizer Quickstart 🖼
View, interact with, record, and replay data straight from your Carbon 30 sensor.
3. Developer Tools 💻
Delve into the SDK, programs, and examples.
Need Help?
Common problems and solutions can be found in our troubleshooting guide.
If you have any questions, feedback, or if your problem persists, please reach out to us at support@voyantphotonics.com.
We value your experience, and are committed to ironing out any and all kinks or unnecessary difficulties in the code. All feedback is greatly appreciated!
Additional Information
API Stability Notice
The Voyant API / SDK are currently in an early development stage. All v0.x.x versions should be considered developer previews. While we strive to maintain compatibility, please be aware that breaking changes may occur in early minor releases as we refine the implementation based on user feedback and testing.
We will document all breaking changes in our release notes and provide migration guides where applicable. We appreciate your understanding and feedback during this development phase as we work to create a stable, robust API for our platform.
You can find the latest available release at voyant-sdk/releases/latest.
Licensing
This repository contains documentation for interacting with Voyant Photonics device drivers.
The voyant-sdk repository contains example code for interacting with Voyant Photonics device drivers.
Licensing Information
- Documentation: All documentation in this repository is licensed under the MIT License. You are free to use, modify, and distribute this documentation for both open source and commercial projects.
- Example Code: Example code can be found in the voyant-sdk repository. The example code is also licensed under the MIT License.
- Device Driver: The device driver is proprietary (not covered by the MIT License), but may be called from your application for the evaluation of Voyant sensors.