Repository files navigation

This main branch is based on Orbbec SDK v1 and it is compatible with Orbbec's original OpenNI protocol devices through built-in code, enabling developers to migrate to Orbbec SDK to support both new and old products with one set of code.

With the major update in 2024 October, Orbbec SDK becomes open-source with enhanced flexibility and scalability. This update ensures compatibility with all new Orbbec USB products that adhere to the UVC standard. However,Orbbec SDK v2 no longer supports Orbbec's legacy OpenNI protocol devices, which will continue to receive bug fixes support in the Orbbec SDK v1 branch. We encourage you to check out whether your devices is supported by Orbbec SDK v2 and use the new release if it is supported there.

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

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

Note: If you do not find your device, please contact our FAE or sales representative for help.

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.

• library : Orbbec SDK core library files and C/C++ header files.
• examples : C/C++ samples project source code.
• doc : API reference documentation and sample documentation.
• driver : Windows device driver for OpenNI protocol devices (Dabai, Dabai DCW, Dabai DW, Astra mini Pro, Astra Pro Plus, A1 Pro, Gemini E, Gemini E Lite, Gemini). While modules that use the standard UVC protocol do not need to install drivers.
• scripts : Linux udev rules for resolving permission issues and Windows timestamp registration scripts for resolving timestamp and metadata issues.

The current software license structure is as follows

More information about the license of each module can be found in thelicense file.

• Note: supported Arm platforms: NVIDIA Jetson AGX Orin (arm64), NVIDIA Jetson Orin NX (arm64), NVIDIA Jetson Orin Nano (arm64), NVIDIA Jetson AGX Xavier (arm64), NVIDIA Jetson Xavier NX (arm64), NVIDIA Jetson Nano (arm64), A311D (arm64), Raspberry Pi 4 (arm64), Raspberry Pi 3 (arm32), RK3399 (arm64), other Arm platforms, may need to Cross-compile.

OrbbecViewer is a useful tool based on Orbbec SDK, that can be used to view the data stream from the Orbbec camera and control the camera.

Supported platforms: Windows x64, Linux x64 & ARM64, MacOS M series chip & Intel x86 chip

Download link:Releases

OrbbecViewer User Manual:OrbbecViewer User Manual

git clone https://github.com/orbbec/OrbbecSDK.git

Alternatively, you can install via binary packages, please refer toinstallation guidance for more information.

• Linux:

If you installed via a debian package, you can skip the installation of the udev rules file. If not, please install it using the following commands:

cd OrbbecSDK/misc/scriptssudo chmod +x ./install_udev_rules.shsudo ./install_udev_rules.shsudo udevadm control --reload&& sudo udevadm trigger

• Windows:

  Timestamp registration:follow this: obsensor_metadata_win10

• For more information, please refer to：Environment Configuration

The sample code is located in the./examples directory and can be built using CMake.

cd OrbbecSDK&& mkdir build&&cd build&& cmake ..&& cmake --build. --config Release

To connect your Orbbec camera to your PC, run the following steps:

cd OrbbecSDK/build/bin# build output dir./OBMultiStream# OBMultiStream.exe on Windows

Notes: On MacOS, sudo privileges are required.

# MacOScd OrbbecSDK/build/bin# build output dircp ../../lib/macOS/*.# copy lib to output dirsudo ./OBMultiStream

The following image is the result of running MultiStream on the Gemini2 device. Other Devices run result maybe different.

Notes:On the Linux/Arm platform ,this sample requires users to compile with Opencv4.2 or above,otherwise, it cannot be rendered.

Find and link Orbbec SDK in your CMakeLists.txt file like this:

cmake_minimum_required(VERSION 3.1.15)project(OrbbecSDKTest)add_executable(${PROJECT_NAME} main.cpp)# find Orbbec SDKset(OrbbecSDK_DIR"/your/path/to/OrbbecSDK")find_package(OrbbecSDK REQUIRED)# link Orbbec SDKtarget_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK)

• Github Pages：https://orbbec.github.io/OrbbecSDK/
• Overview Document：doc/tutorial/English/OverviewDocument.md

• Quick Start：doc/tutorial/English/Environment_Configuration.md
• Examples:examples/README.md

• API Reference:doc/api/English/index.html
• OrbbecSDK C++ API user guide：doc/tutorial/English/OrbbecSDK_C++_API_user_guide-v1.0.pdf

• Multi Camera Sync Document:Multi Camera Sync

Insufficient Power Supply:

• Ensure that all cameras are not connected to the same hub.
• Use a powered hub to provide sufficient power to each camera.

High Resolution:

• Try lowering the resolution to resolve data stream issues.

Increase usbfs_memory_mb Value:

• Increase theusbfs_memory_mb value to 128MB by running the following command:

  echo 128| sudo tee /sys/module/usbcore/parameters/usbfs_memory_mb

• For making this change permanent, checkthis link.

• Orbbec SDK Repo
• Orbbec Main Page
• Orbbec 3D Club