Orbbec SDK provides a development kit for Orbbec depth cameras, enabling integration of depth sensing and point cloud data. It targets developers working with Orbbec hardware, offering a unified codebase for both legacy OpenNI (v1) and modern UVC (v2) devices. The recent open-sourcing of v2 enhances flexibility and scalability for new Orbbec USB products.

How It Works

The SDK features two main branches: v1, supporting legacy OpenNI protocol devices with bug fixes, and v2, a newly open-sourced (Oct 2024) release for enhanced flexibility and scalability with UVC-compliant devices. This dual approach allows developers to maintain compatibility with older hardware while adopting newer Orbbec cameras.

Quick Start & Requirements

• Install: Clone from GitHub (git clone https://github.com/orbbec/OrbbecSDK.git) or use binary packages.
• Prerequisites: Windows 10+ (x64), Linux Ubuntu 16.04+ (x64, Arm32/64), macOS (M/Intel x86). Requires VS2015+ (Windows) or GCC 7.5+ (Linux/Arm). CMake is used for building. Linux requires udev rule installation. Rendering on Linux/Arm samples needs OpenCV 4.2+.
• Links: Docs Overview: https://orbbec.github.io/OrbbecSDK/; API Reference: doc/api/English/index.html.

Highlighted Details

• Dual protocol support: v1 for legacy OpenNI, v2 for modern UVC devices.
• v2 open-sourced in Oct 2024, emphasizing flexibility and scalability for new USB products.
• Includes OrbbecViewer, a GUI tool for camera data visualization and control across Windows, Linux, and macOS.
• Provides core library files, C/C++ headers, sample projects, API docs, and Windows drivers for OpenNI devices.

Maintenance & Community

• v1 branch receives bug fixes for legacy OpenNI devices.
• v2 is recommended for new designs.
• Gitee is provided as an alternative repository for users in China.
• Community link: Orbbec 3D Club.

Licensing & Compatibility

• License details are found in a separate license file; the specific license type is not explicitly stated in the README.
• Commercial use compatibility is not detailed.

Limitations & Caveats

• Orbbec SDK v2 explicitly does not support legacy OpenNI protocol devices; these are exclusively handled by the v1 branch.
• Device compatibility differs significantly between v1 and v2, requiring careful verification.
• Cross-compilation may be necessary for some Arm platforms.
• MacOS examples require sudo and manual library copying.