1.1. Introduction
Python Wrapper bindings for the Orbbec SDK, enabling developers to interface with Orbbec devices using Python. With the major update of the new branch v2-main in October 2024, Python Wrapper is connected to the open source version of Orbbec SDK v2, which will make Python Wrapper more flexible and extensible.
This update in v2-main ensures compatibility with all new Orbbec USB products that comply with the UVC standard. However, Python Wrapper v2 no longer supports Orbbec’s traditional OpenNI protocol devices. We encourage you to check whether your device is supported by Python Wrapper v2 and use the new version if supported.
The Python Wrapper uses pybind11 to convert the interfaces of the Orbbec SDK into Python interfaces.
The implementation principle of the Python Wrapper is as follows:
1.1.1. Device Support Comparison
| Product Series | Product | main (v1.x) | v2-main (v2.x) |
|---|---|---|---|
| Gemini 305 | Gemini 305 | ❌ Not Supported | ✅ Recommended |
| Gemini 340 | Gemini 345 | ❌ Not Supported | ✅ Recommended |
| Gemini 345Lg | ❌ Not Supported | ✅ Recommended | |
| Gemini 435Le | Gemini 435Le | ❌ Not Supported | ✅ Recommended |
| Gemini 330 | Gemini 335Le | ❌ Not Supported | ✅ Recommended |
| Gemini 335 | ⚠️ Maintenance | ✅ Recommended | |
| Gemini 336 | ⚠️ Maintenance | ✅ Recommended | |
| Gemini 330 | ⚠️ Maintenance | ✅ Recommended | |
| Gemini 335L | ⚠️ Maintenance | ✅ Recommended | |
| Gemini 336L | ⚠️ Maintenance | ✅ Recommended | |
| Gemini 330L | ⚠️ Maintenance | ✅ Recommended | |
| Gemini 335Lg | ❌ Not Supported | ✅ Recommended | |
| Gemini 2 | Gemini 2 | ⚠️ Maintenance | ✅ Recommended |
| Gemini 2 L | ⚠️ Maintenance | ✅ Recommended | |
| Gemini 2 XL | ✅ Recommended | ⏳ Planned | |
| Gemini 215 | ❌ Not Supported | ✅ Recommended | |
| Gemini 210 | ❌ Not Supported | ✅ Recommended | |
| Femto | Femto Bolt | ⚠️ Maintenance | ✅ Recommended |
| Femto Mega | ⚠️ Maintenance | ✅ Recommended | |
| Femto Mega I | ⚠️ Maintenance | ✅ Recommended | |
| Astra | Astra 2 | ⚠️ Maintenance | ✅ Recommended |
| Astra+ | ⚠️ Maintenance | ❌ Not Supported | |
| Astra Pro Plus | ⚠️ Maintenance | ❌ Not Supported | |
| Astra Mini | Astra Mini Pro | ⚠️ Maintenance | ✅ Recommended |
| Astra Mini S Pro | ⚠️ Maintenance | ✅ Recommended | |
| LiDAR | Pulsar ME450 | ❌ Not Supported | ✅ Recommended |
| Pulsar SL450 | ❌ Not Supported | ✅ Recommended |
Legend:
✅ Recommended: Full support with new features, bug fixes, and performance optimization
⚠️ Maintenance: Bug fix support only
❌ Not Supported: Device not supported in this version
⏳ Planned: Support will be added in the near future
1.1.2. Supported Platforms
pyorbbecsdk supports the following operating systems and architectures:
| Platform | OS Version | Architecture |
|---|---|---|
| Windows | Windows 10+ | x64 |
| Linux | Ubuntu 18.04 / 20.04 / 22.04 | x64 |
| ARM64 | ||
| macOS | macOS 13.2+ | Apple Silicon (M1 and later) |
Supported Python versions: 3.8 to 3.13
Pre-built wheels are available for all platforms via pip install --upgrade pyorbbecsdk2.
1.1.3. Support Hardware Products
This document is based on the v2-main branch code, which is a Python Wrapper built on Orbbec SDK v2. It supports the following devices. If your device is included in this supported list, we recommend using the v2-main branch. If not, you can use the main branch instead.
1.1.3.1. v2-main Branch
| Products List | Minimal Firmware Version | Recommended Firmware Version |
|---|---|---|
| Gemini 305 | 1.0.30 | 1.0.30 |
| Gemini 345 | 1.7.04 | 1.9.03 |
| Gemini 345Lg | 1.7.04 | 1.9.03 |
| Gemini 435Le | 1.2.4 | 1.3.6 |
| Gemini 335Le | 1.5.31 | 1.6.00 |
| Gemini 330 | 1.2.20 | 1.6.00 |
| Gemini 330L | 1.2.20 | 1.6.00 |
| Gemini 335 | 1.2.20 | 1.6.00 |
| Gemini 335L | 1.2.20 | 1.6.00 |
| Gemini 336 | 1.2.20 | 1.6.00 |
| Gemini 336L | 1.2.20 | 1.6.00 |
| Gemini 335Lg | 1.3.46 | 1.6.00 |
| Femto Bolt | 1.1.2 | 1.1.3 |
| Femto Mega | 1.3.0 | 1.3.1 |
| Femto Mega I | 2.0.4 | 2.0.4 |
| Astra 2 | 2.8.20 | 2.8.20 |
| Gemini 2 L | 1.4.53 | 1.5.2 |
| Gemini 2 | 1.4.92 | 1.4.98 |
| Gemini 215 | 1.0.9 | 1.0.9 |
| Gemini 210 | 1.0.9 | 1.0.9 |
| Astra Mini Pro | 2.0.03 | 2.0.03 |
| Astra Mini S Pro | 2.0.03 | 2.0.03 |
| Pulsar SL450 | 2.2.4.5 | 2.2.4.5 |
| Pulsar ME450 | 1.0.0.6 | 1.0.0.6 |
1.1.3.2. main Branch (v1.x)
the main branch supports the following devices with maintenance only:
| Products List | Minimal Firmware Version |
|---|---|
| Gemini 330 | 1.2.20 |
| Gemini 330L | 1.2.20 |
| Gemini 335 | 1.2.20 |
| Gemini 335L | 1.2.20 |
| Gemini 336 | 1.2.20 |
| Gemini 336L | 1.2.20 |
| Gemini 2 | 1.4.60 |
| Gemini 2 L | 1.4.32 |
| Gemini 2 XL | Obox: V1.2.5 VL:1.4.54 |
| Femto Bolt | 1.0.6 |
| Femto Mega | 1.1.7 |
| Femto Mega I | 2.0.2 |
| Astra 2 | 2.8.20 |
| Astra+ | 1.0.19 |
| Astra Pro Plus | 1.0.19 |
| Astra Mini Pro | 1007 |
| Astra Mini S Pro | 1005 |
1.1.4. Support Platforms
Windows: Windows 10 (x64)
Linux: 18.04/20.04/22.04/24.04 (x64)
Arm64: Ubuntu18.04/20.04/22.04