pyorbbecsdk2 2.0.18

pyorbbecsdk is a python wrapper for the OrbbecSDK

Python Bindings for Orbbec SDK

the v2-main branch provides Python bindings for the Orbbec SDK v2.x, enabling developers to interface with Orbbec devices using Python. The Orbbec SDK v.2.x is an open-source cross-platform SDK library based on Orbbec RGB-D cameras. The differences between Orbbec SDK v2.x and Orbbec SDK v1.x can be found in the README.

If you are a user in China, it is recommended to use gitee Repo.

[!IMPORTANT]

Welcome to the python wrapper . Before you begin using this version of python wrapper , it's crucial to check the following device support list to verify the compatibility.

Here is the device support list of main branch (v1.x) and v2-main branch (v2.x):

Product Series	Product	Branch main	Branch v2-main
Gemini 435Le	Gemini 435Le	not supported	recommended for new designs
Gemini 330	Gemini 335Le	not supported	recommended for new designs
	Gemini 335	full maintenance	recommended for new designs
	Gemini 336	full maintenance	recommended for new designs
	Gemini 330	full maintenance	recommended for new designs
	Gemini 335L	full maintenance	recommended for new designs
	Gemini 336L	full maintenance	recommended for new designs
	Gemini 330L	full maintenance	recommended for new designs
	Gemini 335Lg	not supported	recommended for new designs
Gemini 2	Gemini 2	full maintenance	recommended for new designs
	Gemini 2 L	full maintenance	recommended for new designs
	Gemini 2 XL	recommended for new designs	to be supported
	Gemini 215	not supported	recommended for new designs
	Gemini 210	not supported	recommended for new designs
Femto	Femto Bolt	full maintenance	recommended for new designs
	Femto Mega	full maintenance	recommended for new designs
	Femto Mega I	full maintenance	recommended for new designs
Astra	Astra 2	full maintenance	recommended for new designs
	Astra+	limited maintenance	not supported
	Astra Pro Plus	limited maintenance	not supported
Astra Mini	Astra Mini (S) Pro	full maintenance	recommended for new designs

Note:

• If you do not find your device, please contact our FAE or sales representative for help.
• Starting from October 2025 (Orbbec SDK v2.5.5), we will begin upgrading devices that use the OpenNI protocol to the UVC protocol, Already upgraded devices and future upgrade schedule and how to upgrade from openni protocol to uvc protocol,please refer to the document.

Definition:

1. recommended for new designs: we will provide full supports with new features, bug fix and performance optimization;
2. full maintenance: we will provide bug fix support;
3. limited maintenance: we will provide critical bug fix support;
4. not supported: we will not support specific device in this version;
5. to be supported: we will add support in the near future.

Hardware Products Supported by Python SDK

Products List	Minimal Firmware Version	Recommended Firmware Version
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.2
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

Supported Platforms

• Windows: Windows 10 (x64)
• Linux: 18.04/20.04/22.04 (x64)
• Arm64: Ubuntu18.04/20.04/22.04

Supported Python Versions

python 3.8 to python 3.13

Environment Setup

Windows

For windows, you need to register the metadata associated with frames (this includes things like timestamps and other information about the video frame).

• Connect the device and confirm that the device is online;

• Open PowerShell with administrator privileges, then use the cd command to enter the directory where the obsensor_metadata_win10.ps1 script is located;

• Execute the Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser command, and enter Y as prompted to confirm;

  Try to execute the Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser command if the previous command fails in some cases;

• Execute .\obsensor_metadata_win10.ps1 -op install_all to complete the registration.

Notes: If the metadata is not registered, the device timestamp will be abnormal, thereby affecting the SDK's internal frame synchronization functionality.

Linux

For Linux, we have provided a script to help you set up the environment. You can run the script as follows:

  cd pyorbbecsdk/scripts/env_setup
  sudo chmod +x ./install_udev_rules.sh
  sudo ./install_udev_rules.sh
  sudo udevadm control --reload && sudo udevadm trigger

Notes: If this script is not executed, open the device will fail due to permission issues.

How to Use install package

To make Python more user-friendly, We provide two installation methods: online installation and offline installation.

Windows

We provide both online and offline installation packages for Python versions 3.8 to 3.13.

Follow the windows install documentation to install the SDK online or offline. Then verify the package and run the sample.

Linux

We provide online installation packages for Python versions 3.9 to 3.13 and provide offline installation packages for Python versions 3.8 to 3.13.

Follow the linux install documentation to install the SDK online or offline. Then verify the package and run the sample.

Documentation

Orbbec SDK V2 Python Wrapper User Guide provides an overview of the concepts and architecture of Orbbec SDK v2, details on the Python Wrapper installation packages and source compilation, an introduction to commonly used Python Wrapper interfaces, and a FAQ section. Please read it carefully.

License

This project is licensed under the Apache License 2.0.