DepthAI Python

You can build the documentation website using either Docker or a native Linux setup.

Using Docker

This method uses Docker Compose to watch the docs/source directory and rebuild automatically.

cd docs
sudo docker-compose build
sudo docker-compose up

Access the docs at http://localhost:8000.

Using Linux (Native)

1. Install dependencies and requirements:

   python3 -m pip install -U pip
   python3 -m pip install -r docs/requirements.txt

2. Build the Sphinx documentation:

   cmake -H. -Bbuild -D DEPTHAI_BUILD_DOCS=ON -D DEPTHAI_PYTHON_BUILD_DOCS=ON
   cmake --build build --target sphinx

3. Serve the documentation:

   python3 -m http.server --bind 0.0.0.0 8000 --directory build/docs/sphinx

4. To update the website after making changes, run:

   cmake --build build --target sphinx

For comprehensive usage examples, detailed tutorials, and official code samples, refer to the Luxonis DepthAI API documentation online.

https://docs.luxonis.com/projects/api/en/latest/tutorials/code_samples/

You can build a bundled executable for cam_test.py using pyinstaller. The resulting executable will be located in the dist/cam_test folder.

Prerequisites: Install pyinstaller via pip:

• Linux/macOS: python3 -m pip install pyinstaller
• Windows: python -m pip install pyinstaller

Build Command:

pyinstaller -w cam_test.py --hidden-import PyQt5.sip

To install the prebuilt wheels for the DepthAI Python bindings, first ensure your pip is upgraded, then install depthai using the Luxonis artifact repository as an extra index URL.

Note: This method installs the v2.x.y branch. For v3.x.y (which adds RVC4 support), the bindings are integrated directly into the depthai-core repository.

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

The cam_test.py utility allows you to test camera functionality. By default, it starts with a GUI. You can run it with arguments to start the test without the GUI.

python3 cam_test.py

To run the built-in tests, you must build the library with specific CMake flags enabled to include tests and examples.

1. Build with test flags:

   git submodule update --init --recursive
   cmake -H. -Bbuild -D DEPTHAI_PYTHON_ENABLE_TESTS=ON -D DEPTHAI_PYTHON_ENABLE_EXAMPLES=ON -D DEPTHAI_PYTHON_TEST_EXAMPLES=ON
   cmake --build build

2. Execute tests using `ctest`:
   ```bash
cd build
ctest

To run a specific test (e.g., 01_rgb_preview) with a custom timeout, use the TEST_TIMEOUT environment variable. Setting TEST_TIMEOUT=0 allows the test to run until it naturally ends or is manually stopped.

cd build
TEST_TIMEOUT=0 ctest -R "01_rgb_preview" --verbose

Building from source requires initializing submodules first.

Prerequisites

• cmake >= 3.4
• C++14 compiler (clang, gcc, msvc, etc.)
• Python3
• depthai-core dependencies

Build Steps

1. Initialize submodules:

   git submodule update --init --recursive

2. Build and install locally using pip:

   python3 -m pip install .

   (Use -v to see build output)

3. (Optional) Build a wheel:

   python3 -m pip wheel . -w wheelhouse

Building a Shared Library

To build a shared library manually using CMake:

cmake -H. -Bbuild
cmake --build build

To specify a custom Python executable:

cmake -H. -Bbuild -D PYTHON_EXECUTABLE=/full/path/to/python

Before running the provided usage examples, you must install the necessary dependencies using the included requirements script.

Run the following command in your terminal to prepare the environment:

python3 install_requirements.py

You can package device_manager.py into a single standalone executable using pyinstaller.

Prerequisites: Install pyinstaller via pip:

• Linux/macOS: python3 -m pip install pyinstaller
• Windows: python -m pip install pyinstaller

Build Command:

pyinstaller --onefile -w --icon=assets/icon.ico --add-data="assets/icon.ico;assets" --add-data="assets/icon.png;assets" device_manager.py

Options:

• Use --runtime-tmpdir [path or .] to specify a custom location for the temporary directory created at runtime.