DepthAI Library

DepthAI library for interfacing with Luxonis DepthAI hardware. It’s written in C++ and offers Python bindings out of the box.

Important — You’re viewing the v3.x.y release-candidate branch.

• For production projects that still rely on v2, check out the v2_stable branch.
• Need to migrate? Follow the step-by-step v2 → v3 Porting Guide.

Documentation

Documentation is available over at Luxonis DepthAI API

Disclaimer

DepthAI library doesn’t yet provide API stability guarantees. While we take care to properly deprecate old functions, some changes might still be breaking.

Examples

Examples for both C++ and Python are available in the examples folder. To see how to build and run them see README.md for more information. To build the examples in C++ configure with the following option added:

cmake -S. -Bbuild -D'DEPTHAI_BUILD_EXAMPLES=ON'
cmake --build build

Dependencies

• CMake >= 3.20
• C/C++17 compiler
• [Linux] libudev >= 1.0.0
• [optional] OpenCV 4 (required if building examples and for record and replay)
• [optional] PCL (required for point cloud example)

To install libudev on Debian based systems (Ubuntu, etc.): sudo apt install libudev-dev

To install OpenCV: MacOS: brew install opencv Linux: sudo apt install libopencv-dev Windows: choco install opencv

To install PCL: MacOS: brew install pcl Linux: sudo apt install libpcl-dev

Using Python bindings

Installing the latest pre-released version of the library can be done with:

python3 -m pip install --extra-index-url https://artifacts.luxonis.com/artifactory/luxonis-python-release-local/ --pre -U depthai

or by running:

python3 examples/python/install_requirements.py on the branch you want to install

For more specific information about Python bindings, see Python README.

Building

Make sure submodules are updated

git submodule update --init --recursive

Then configure and build

cmake -S . -B build
cmake --build build --parallel [num CPU cores]

On Windows it’s often required to specify the location of the OpenCV installation. In case you used chocolatey to install OpenCV, you can use the following command:

cmake -S . -B build -DOpenCV_DIR=C:/tools/opencv/build -DCMAKE_BUILD_TYPE=Release
cmake --build build --config Release --parallel [num CPU cores]

ℹ️ To speed up build times, use cmake --build build --parallel [num CPU cores].

Dynamic library

To build a dynamic version of the library configure with the following option added

cmake -S . -B build -D'BUILD_SHARED_LIBS=ON'
cmake --build build --parallel [num CPU cores]

Installation and Integration

Installation of the DepthAI library is currently only available as a dynamic library. To install the library, use the following command:

cmake -S . -B build -D'BUILD_SHARED_LIBS=ON' -D'CMAKE_INSTALL_PREFIX=[path/to/install/dir]'
cmake --build build --target install --parallel [num CPU cores]

Verifying installation

To verify the installation works as expected, you can test if the integration project compiles and runs. This is done by running the following command:

File truncated at 100 lines see the full file