Overview

This repository hosts the documentation website for Voyant Photonics products and APIs. For practical implementation guidance, please see our:

  • voyant-sdk - Contains lightweight and easy to augment examples for testing the Voyant API with installed Debian packages
  • 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.

Packages

We package two debian packages that are always available at voyant-sdk/releases/latest.

  • voyant-api: For binaries, command line utilities, etc.
  • voyant-api-dev: Header files, static libraries, etc.
    • Depends on voyant-api

The voyant-api package is all you need to:

  • connect to your sensor
  • stream, record, and visualize data
  • configure your sensor (Coming Soon…)

The voyant-api-dev package exists for the developer community and enables:

  • Building and running the examples contained in this repository
  • Developing your own C++ applications that process Voyant LiDAR data

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.

License 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.

Using This SDK

You are encouraged to:

  • Use this documentation as a reference for working with Voyant Photonics products
  • Use these 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 the community

When using the example code or documentation, please retain the copyright notices at the top of each file.

Questions

If you have any questions or feedback about licensing or usage of either the examples or the device driver, please see our troubleshooting guide for support options. If the problem persists, please reach out! 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!

Copyright © Voyant Photonics, Inc.