From 61f3cd937d020827e674e4a922a7c3b8ae2ecf6c Mon Sep 17 00:00:00 2001 From: zhonghong322 <142879755+zhonghong322@users.noreply.github.com> Date: Sat, 30 Nov 2024 17:34:26 +0800 Subject: [PATCH] Update README.md --- README.md | 149 +++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 120 insertions(+), 29 deletions(-) diff --git a/README.md b/README.md index 3c6af85..adbdcc5 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,11 @@ ![stability](https://img.shields.io/badge/stability-stable-green) ![version](https://img.shields.io/badge/version-1.10.16-green) +> [!IMPORTANT] +> +> Welcome to the Orbbec SDK. Before you begin using this version of Orbbec SDK, it's crucial to check the following device support list to verify the compatibility. +> - -## Introduction The Orbbec 3D camera product software development kit fully supports UVC, enabling driver-free plug-and-play. It provides both low-level and high-level APIs that are simple and easy to use, allowing developers to use it flexibly in different scenarios. 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. @@ -13,6 +15,122 @@ With the major update in a new branch v2-main in 2024 October, Orbbec SDK become If you are a user in China, it is recommended to use Gitee([gitee Repo](https://gitee.com/orbbecdeveloper/OrbbecSDK)). +Here is the device support list of main branch (v1.x) and v2-main branch (v2.x): + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Product SeriesProductBranch mainBranch v2-main
Gemini 330Gemini 335full maintenancerecommended for new designs
Gemini 336full maintenancerecommended for new designs
Gemini 330full maintenancerecommended for new designs
Gemini 335Lfull maintenancerecommended for new designs
Gemini 336Lfull maintenancerecommended for new designs
Gemini 330Lfull maintenancerecommended for new designs
Gemini 335Lgnot supportedrecommended for new designs
Gemini 2Gemini 2full maintenancerecommended for new designs
Gemini 2 Lfull maintenancerecommended for new designs
Gemini 2 XLrecommended for new designsto be supported
FemtoFemto Boltfull maintenancerecommended for new designs
Femto Megafull maintenancerecommended for new designs
Femto Mega Ifull maintenanceto be supported
AstraAstra 2full maintenancerecommended for new designs
Astra+limited maintenancenot supported
Astra Pro Pluslimited maintenancenot supported
Astra MiniAstra Mini Profull maintenancenot supported
+ +**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. + + ## What is included in the repository * **library** : Orbbec SDK core library files and C/C++ header files. @@ -42,33 +160,6 @@ More information about the license of each module can be found in the [license f * 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. -## Product support - -| **Products List** | **Firmware Version** | -|-------------------|-----------------------------| -| Gemini 335 | 1.2.20 | -| Gemini 335L | 1.2.20 | -| Gemini 336 | 1.2.20 | -| Gemini 336L | 1.2.20 | -| Femto Bolt | 1.0.6/1.0.9/1.1.2 | -| Femto Mega | 1.1.7/1.2.7/1.2.9 | -| Femto Mega I | 2.0.2 | -| Gemini 2 XL | Obox: V1.2.5 VL:1.4.54 | -| Astra 2 | 2.8.20 | -| Gemini 2 L | 1.4.32 | -| Gemini 2 | 1.4.60 /1.4.76 | -| Astra+ | 1.0.22/1.0.21/1.0.20/1.0.19 | -| Femto | 1.6.7 | -| Femto W | 1.1.8 | -| DaBai | 2436 | -| DaBai DCW | 2460 | -| DaBai DW | 2606 | -| Astra Mini Pro | 1007 | -| Gemini E | 3460 | -| Gemini E Lite | 3606 | -| Gemini | 3.0.18 | -| Astra Mini S Pro | 1.0.05 | - ## OrbbecViewer