Software

Use the following links to jump over the step by step intro and dive straight into Luxonis SDK and the full OAK software stack: DepthAI API, tools and examples across OAK USB, PoE and OAK4 cameras.For an easy step by step introduction into OAK4 and OAK devices follow the steps below.

Getting Started

Pick the correct getting started guide for your device.

After you have you camera connected, the quickest way to start is by running OAK Viewer.

Running your first App

Try out our pre-made applications to dip your toes into our ecosystem. Here is an example of how to start the generic neural network app:

Building the App from ground up

Quickest way to get started with developing on your own is to use the template app. This app is a starting point for your own applications and includes all the necessary components to get you up and running.

1# Install core packages
2pip install depthai --force-reinstall
3# Clone the template app
4git clone https://github.com/luxonis/oak-template.git
5# Change directory to the template app
6cd oak-template
7# Install requirements
8pip install -r requirements.txt

This will download the template / cookie-cutter app to your current directory.

1template-app/
2├── main.py
3├── oakapp.toml
4├── requirements.txt
5├── media/ # Optional media files
6└── utils/ # Optional helper functions

Continue developing your template app

Next Steps

We suggest you continue exploring the ecosystem in one of the following ways.