DepthAI API Docs
2.27.0.0.dev0+6c40528c69493b6c488fb9173552ce84c17ea0b4

Content:

  • Home

Components:

  • Device
    • Device API
    • Connect to specified device
    • Host clock syncing
    • Multiple devices
    • Device queues
    • Output queue - maxSize and blocking
      • Some additional information
    • Watchdog
      • Customizing the Watchdog Timeout
    • Environment Variables
    • Reference
  • Bootloader
    • Device Manager
      • About Device
      • Configuration settings
      • Applications settings
      • Danger Zone
    • Factory and User bootloader
    • Boot switches
    • API
    • DepthAI Application Package (.dap)
    • MAC address
  • Pipeline
    • Pipeline first steps
    • Specifying OpenVINO version
    • Using multiple devices
    • How to place it
    • Reference
  • Nodes
    • Camera
      • How to place it
      • Inputs and Outputs
      • Usage
      • Limitations
      • Examples of functionality
      • Reference
    • ColorCamera
      • How to place it
      • Inputs and Outputs
      • Full FOV
      • Usage
      • Limitations
      • Examples of functionality
      • Reference
    • EdgeDetector
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • FeatureTracker
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
      • Image cells
      • Initial Harris Threshold
      • Entry conditions for new features
      • Harris Threshold for Tracked Features
      • Feature Maintenance
      • New position calculation
    • ImageManip
      • How to place it
      • Inputs and Outputs
      • Usage
      • Image formats supported
      • Limitations
      • Examples of functionality
      • Reference
    • IMU
      • How to place it
      • Inputs and Outputs
      • Limitations
      • IMU sensor frequencies
      • Usage
      • IMU sensors
      • Examples of functionality
      • Reference
    • MessageDemux
      • How to Place It
      • Inputs and Outputs
      • Usage
      • Examples of Functionality
      • Reference
    • MobileNetDetectionNetwork
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • MobileNetSpatialDetectionNetwork
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
        • Spatial coordinate system
      • Reference
    • MonoCamera
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • NeuralNetwork
      • How to place it
      • Inputs and Outputs
      • Passthrough mechanism
      • Usage
      • Examples of functionality
      • Reference
    • ObjectTracker
      • How to place it
      • Inputs and Outputs
      • Zero term tracking
      • Short term tracking
      • Supported object tracker types
      • Maximum number of tracked objects
      • Usage
      • Examples of functionality
      • Reference
    • PointCloud
      • How to place it
      • Inputs and Outputs
      • Example visualization with Open3D
      • Examples using PointCloud
      • Reference
    • Script
      • How to place it
      • Inputs and Outputs
      • Usage
      • Interfacing with GPIOs
      • Time synchronization
      • Using DepthAI Messages
      • Available modules and libraries
      • Examples of functionality
      • Reference
    • SpatialLocationCalculator
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
        • Spatial coordinate system
      • Reference
    • SPIIn
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • SPIOut
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • StereoDepth
      • How to place it
      • Inputs and Outputs
      • Internal block diagram of StereoDepth node
        • Currently configurable blocks
      • Limitations
      • Stereo depth FPS
      • Usage
      • Examples of functionality
      • Reference
      • Disparity
      • Calculate depth using disparity map
      • Min stereo depth distance
        • Disparity shift to lower min depth perception
      • Max stereo depth distance
      • Depth perception accuracy
      • Limitation
      • Measuring real-world object dimensions
    • Sync
      • How to Place it
      • Inputs and Outputs
      • Message Synchronization
      • Usage
      • Examples of Functionality
      • Reference
    • SystemLogger
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • ToF
      • How to place it
      • Inputs and Outputs
      • ToF Settings
      • Phase unwrapping
      • ToF motion blur
      • Max distance
      • Usage
      • Examples of functionality
      • Reference
    • UVC
      • What is UVC?
      • How Does the UVC Node Work?
      • Examples of UVC Node Usage
      • Reference
    • VideoEncoder
      • How to place it
      • Inputs and Outputs
      • Usage
      • Limitations
      • Examples of functionality
      • Reference
    • Warp
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • XLinkIn
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • XLinkOut
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • YoloDetectionNetwork
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
      • Reference
    • YoloSpatialDetectionNetwork
      • How to place it
      • Inputs and Outputs
      • Usage
      • Examples of functionality
        • Spatial coordinate system
      • Reference
  • Messages
    • Buffer
      • Reference
    • CameraControl
      • Examples of functionality
      • Reference
    • EdgeDetectorConfig
      • Examples of functionality
      • Reference
    • EncodedFrame
      • Structure
        • FrameType
        • Profile
      • Reference
    • FeatureTrackerConfig
      • Reference
    • ImageManipConfig
      • Examples of functionality
      • Reference
    • ImgDetections
      • Examples of functionality
      • Reference
    • ImgFrame
      • Examples of functionality
      • Reference
    • IMUData
      • Reference
    • MessageGroup
      • Creating MessageGroup
      • Reference
    • NNData
      • Creating NNData
      • Reference
    • PointCloudConfig
      • Configuration Options
      • Usage
      • Examples of Functionality
      • Reference
    • PointCloudData
      • Reference
    • SpatialImgDetections
      • Examples of functionality
      • Reference
    • SpatialLocationCalculatorConfig
      • Examples of functionality
      • Reference
    • SpatialLocationCalculatorData
      • Examples of functionality
      • Reference
    • StereoDepthConfig
      • Examples of functionality
      • Reference
    • SystemInformation
      • Examples of functionality
      • Reference
    • ToFConfig
      • Examples of functionality
      • Reference
    • TrackedFeatures
      • Reference
    • Tracklets
      • Examples of functionality
      • Reference

Code:

  • Code Samples
    • Bootloader Config
      • Demo
      • Setup
      • Source code
    • Bootloader Version
      • Demo
      • Setup
      • Source code
    • Flash Bootloader
      • Demo
      • Setup
      • Source code
    • Flash User Bootloader
      • Demo
      • Setup
      • Source code
    • POE set IP
      • Demo
      • Setup
      • Source code
    • Calibration Flash
      • Demo
      • Setup
      • Source code
    • Calibration Flash v5
      • Setup
      • Source code
    • Calibration Load
      • Setup
      • Source code
    • Calibration Reader
      • Camera intrinsics
        • Setup
        • Source code
    • Undistort camera stream
      • Demo
      • Setup
      • Source code
    • Auto Exposure on ROI
      • Demo
      • Setup
      • Source code
    • RGB Camera Control
      • Demo
      • Setup
      • Source code
    • RGB Preview
      • Demo
      • Setup
      • Source code
    • RGB scene
      • Demo
      • Setup
      • Source code
    • RGB video
      • Demo
      • Setup
      • Source code
    • Crash report
      • Demo
      • Setup
      • Source code
    • Edge Detector
      • Demo
      • Setup
      • Source code
    • Feature Detector
      • Demo
      • Setup
      • Source code
    • Feature Tracker with Motion Estimation
      • Demo
      • Setup
      • Source code
    • Feature Tracker
      • Demo
      • Setup
      • Source code
    • Device information
      • Demo
      • Setup
      • Source code
    • Device Queue Event
      • Demo
      • Setup
      • Source code
    • Latency measurement
      • Demo
      • Setup
      • Source code
    • OpenCV support
      • Demo
      • Setup
      • Source code
    • Queue add callback
      • Demo
      • Setup
      • Source code
    • ImageManip Rotate
      • Demos
      • Setup
      • Source code
    • ImageManip Tiling
      • Demo
      • Setup
      • Source code
    • RGB Rotate Warp
      • Setup
      • Demo
      • Source code
    • IMU Accelerometer & Gyroscope
      • Demo
      • Setup
      • Source code
    • IMU Rotation Vector
      • Demo
      • Setup
      • Source code
    • Collision avoidance
      • Similar examples
      • Demo
      • Setup
      • Source code
    • Frame syncing on OAK
      • Demo
      • Setup
      • Source code
    • Mono & MobilenetSSD & Depth
      • Demo
      • Setup
      • Source code
    • Multiple devices
      • Demo
      • Setup
      • Source code
    • RGB Encoding & MobilenetSSD
      • Demo
      • Setup
      • Source code
    • RGB Encoding & Mono & MobilenetSSD
      • Demo
      • Setup
      • Source code
    • RGB Encoding & Mono with MobilenetSSD & Depth
      • Demo
      • Setup
      • Source code
    • Spatial detections on rotated OAK
      • Setup
      • Source code
    • Mono & MobilenetSSD
      • Demo
      • Setup
      • Source code
    • RGB & MobilenetSSD
      • Demo
      • Setup
      • Source code
    • RGB & MobileNetSSD @ 4K
      • Demo
      • Setup
      • Source code
    • Video & MobilenetSSD
      • Demo
      • Setup
      • Source code
    • Mono Camera Control
      • Demo
      • Setup
      • Source code
    • Mono Full Resolution Saver
      • Demo
      • Setup
      • Source code
    • Mono Preview
      • Demo
      • Setup
      • Source code
    • Mono preview - Alternate between dot projector and illumination LED
      • Demo
      • Setup
      • Source code
    • Multi-Input Frame Concationation
      • Demo
      • Setup
      • Source code
    • Frame Normalization
      • Setup
      • Source code
    • Object tracker on RGB
      • Demo
      • Setup
      • Source code
    • Object tracker on video
      • Demo
      • Setup
      • Source code
    • Spatial object tracker on RGB
      • Demo
      • Setup
      • Source code
    • Script camera control
      • Demo
      • Setup
      • Source code
    • Script change pipeline flow
      • Demo
      • Pipeline Graph
      • Setup
      • Source code
    • Script EMMC access
      • Setup
      • Prerequisites
      • Source code
    • Script forward frames
      • Demo
      • Setup
      • Source code
    • Script get local IP
      • Demo
      • Setup
      • Source code
    • Script HTTP client
      • Demo
      • Setup
      • Source code
    • Script HTTP server
      • Demo
      • Setup
      • Source code
    • Script JSON communication
      • Demo
      • Setup
      • Source code
    • Script MJPEG server
      • Demo
      • Setup
      • Source code
    • Script NNData example
      • Demo
      • Setup
      • Source code
    • Script UART communication
      • Demo
      • Setup
      • Source code
    • Spatial Calculator Multi-ROI
      • Demo
      • Setup
      • Source code
    • Spatial location calculator
      • Demo
      • Setup
      • Source code
    • RGB & MobilenetSSD with spatial data
      • Demo
      • Setup
      • Source code
    • Mono & MobilenetSSD with spatial data
      • Demo
      • Setup
      • Source code
    • RGB & TinyYolo with spatial data
      • Demo
      • Setup
      • Source code
    • Depth Crop Control
      • Demo
      • Setup
      • Source code
    • Depth Post-Processing
      • Demo
      • Depth filters
      • Setup
      • Source code
    • Depth Preview
      • Demo
      • Setup
      • Source code
    • RGB Depth alignment
      • Host alignment
        • Demo
        • Setup
        • Source code
    • Stereo Depth custom Mesh
      • Demo
      • Setup
      • Source code
    • Stereo Depth from host
      • Setup
      • Source code
    • Stereo Depth Video
      • Stereo Alpha Param
      • Setup
      • Source code
    • PointCloud Control
      • Demo
      • Setup
      • Source code
    • PointCloud Visualization
      • Key Concepts
      • Demo
      • Setup
      • Source code
    • Demuxing Synchronized Script Outputs
      • Demo
      • Setup
      • Source code
      • How it Works
    • Depth and Video Sync
      • Demo
      • Setup
      • Source code
      • How it Works
    • IMU and Video Sync
      • Demo
      • Setup
      • Source code
      • How it Works
    • Multiple Scripts Sync
      • Demo
      • Setup
      • Source code
      • How it Works
    • System information
      • Demo
      • Setup
      • Source code
    • ToF depth
      • Demo
      • Setup
      • Source code
    • Disparity encoding
      • Demo
      • Setup
      • Source code
    • Video Encoded Frame Type
      • Example script output
      • Setup
      • Source code
    • Encoding Max Limit
      • Demo
      • Setup
      • Source code
    • RGB Encoding
      • Demo
      • Setup
      • Source code
    • RGB Full Resolution Saver
      • Demo
      • Setup
      • Source code
    • RGB & Mono Encoding
      • Demo
      • Setup
      • Source code
    • Warp Mesh
      • Setup
      • Demo
      • Source code
    • Interactive Warp Mesh
      • Setup
      • Demo
      • Source code
    • UVC & Disparity
      • Setup
      • Code used for testing
      • Source code
    • UVC & Mono Camera
      • Setup
      • Code used for testing
      • Source code
    • UVC & Color Camera
      • Setup
      • Code used for testing
      • Source code
    • RGB & Tiny YOLO
      • Demo
      • Setup
      • Source code
  • Experiments (Gitee)

Tutorials:

  • Standalone mode
    • Communication with the camera
    • Converting a demo to standalone mode
    • Flash the bootloader
    • Flash the pipeline
    • DepthAI Application Package (.dap)
    • Clear flash
    • Factory reset
  • Message syncing
    • Software syncing
      • Sequence number syncing
      • Timestamp syncing
  • Configuring Stereo Depth
    • 1. Stereo Depth Basics
      • Depth from disparity
      • How baseline distance and focal length affect depth
    • 2. Fixing noisy depth
      • Scene Texture
      • Stereo depth confidence threshold
      • Stereo camera pair noise
      • Stereo postprocessing filters
        • Median filter
        • Speckle filter
        • Temporal filter
        • Spatial filter
        • Brightness filter
        • Threshold filter
        • Decimation filter
    • 3. Improving depth accuracy
      • Move the camera closer to the object
      • Stereo Subpixel mode
        • Stereo subpixel effect on layering
    • 4. Short range stereo depth
      • How to get lower MinZ
        • Lowering resolution to decrease MinZ
        • Stereo Extended Disparity mode
        • Disparity shift
      • Close range depth limitations
    • 5. Long range stereo depth
    • 6. Fixing noisy pointcloud
      • Decimation filter for pointcloud
      • Invalidating pixels around the corner
      • Host-side pointcloud filtering
  • Multiple DepthAI per Host
    • Discovering OAK cameras
    • Selecting a Specific DepthAI device to be used
      • Specifying POE device to be used
  • Maximizing FOV
    • Change aspect ratio
    • Letterboxing
    • Cropping
  • Debugging DepthAI pipeline
    • DepthAI debugging level
      • In code
      • Using an environmental variable DEPTHAI_LEVEL
    • Script node logging
    • Resource Debugging
    • CPU usage
  • RAM usage
    • Decreasing RAM consumption
  • Displaying detections in High-Res
    • 1. Passthrough
    • 2. Crop high resolution frame
    • 3. Stretch the frame
    • 4. Edit bounding boxes
  • Improving Image Quality
    • Color camera ISP configuration
    • Low-light increased sensitivity
    • Camera tuning
    • Motion blur
  • Low Latency
    • Encoded frames
    • PoE latency
    • Bandwidth
    • Measuring operation times
    • Reducing latency when running NN
      • 1. Increasing NN resources
      • 2. Lowering camera FPS to match NN FPS
      • 3. NN input queue size and blocking behavior
  • Hello World
    • Demo
    • Dependencies
    • Code Overview
    • File Setup
    • Install pip dependencies
    • Test your environment
    • Define a pipeline
    • Initialize the DepthAI Device
    • Adding helpers
    • Consuming the results
    • Display the results
    • Running the example

References:

  • Python API Reference
    • Nodes
  • C++ API Reference
DepthAI API Docs
  • »
  • Search

Built with Sphinx using a theme provided by Read the Docs.