i/OrbbecSDK_ROS2
1
0
Fork 0
mirror of https://github.com/orbbec/OrbbecSDK_ROS2.git synced 2026-10-04 20:17:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

[docs]Update docs

Browse Source
This commit is contained in:
jj
2024-12-18 18:35:58 +08:00
parent eca5beffcc
commit 0fcf1ea16f
152 changed files with 4338 additions and 589 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/1_overview/overview.rst
Executable
+51
View File
@@ -0,0 +1,51 @@
.. 这一页是模块目录树
.. image:: ../image/product_h5.png
======================================================
Overview
======================================================
.. image:: http://badges.github.io/stability-badges/dist/stable.svg
.. image:: https://img.shields.io/badge/version-2.0.8-green
-------------------------------------------------------------------
OrbbecSDK_ROS2 is a wrapper for the Orbbec 3D camera that provides seamless integration with the ROS2 environment. It
supports ROS2 Foxy, Humble, Iron, and Jazzy distributions.
OrbbecSDK ROS2 souce code link:
`https://github.com/orbbec/OrbbecSDK_ROS2/tree/v2-main <https://github.com/orbbec/OrbbecSDK_ROS2/tree/v2-main>`_
With the major update of the new branch v2-main in October 2024, OrbbecSDK_ROS2 is connected to the open source version of OrbbecSDK v2,
which will make OrbbecSDK_ROS2 more flexible and extensible. This update in v2-main ensures compatibility with all new Orbbec USB products
that comply with the UVC standard. However, OrbbecSDK_ROS2 v2 no longer supports Orbbec's traditional OpenNI protocol devices.
We encourage you to check whether your device is supported by OrbbecSDK_ROS2 v2 and use the new version if supported.
For the usage of orbbecSDK, please refer to the link for more detailed introduction:
OrbbecSDK souce code link:
`https://github.com/orbbec/OrbbecSDK_v2 <https://github.com/orbbec/OrbbecSDK_v2>`_
======================================================
.. toctree::
:maxdepth: 2
:caption: This Section Covers:
supported_cameras.md
supported_platforms.md
======================================================
.. image:: ../image/product_h1.png
docs/source/1_overview/supported_cameras.md
Executable
+48
View File
@@ -0,0 +1,48 @@
# Supported cameras
> **Important**
>
> Welcome to the OrbbecSDK ROS2 Wrapper. Before you begin using this version of ROS2 wrapper, it's crucial to check the following device support list to verify the compatibility.
OrbbecSDK ROS2 Wrapper provides seamless integration of Orbbec cameras with ROS 2 environment. It supports ROS2 Foxy, Humble, and Jazzy distributions.
With a major update in October 2024, we release the [OrbbecSDK ROS2 Wrapper v2](https://github.com/orbbec/OrbbecSDK_ROS2/tree/v2-main) connected to the open source [OrbbecSDK v2](https://github.com/orbbec/OrbbecSDK_v2/releases) with enhanced flexibility and extensibility. This update ensures compatibility with all Orbbec USB products adhering to UVC standard. However, it no longer supports Orbbec's traditional OpenNI protocol devices. We strongly encourage you to use the v2-main branch if your device is supported.
Here is the device support list of main branch (v1.x) and v2-main branch (v2.x):
| Product Series | Product | [Branch main](https://github.com/orbbec/OrbbecSDK_ROS2/tree/main) | [Branch v2-main](https://github.com/orbbec/OrbbecSDK_ROS2/tree/v2-main) |
| -------------- | --------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------------- |
| Gemini 330 | 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 | |
| Femto | Femto Bolt | full maintenance | recommended for new designs |
| Femto Mega | full maintenance | recommended for new designs | |
| Femto Mega I | full maintenance | to be supported | |
| 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 Pro | full maintenance | not 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.
&nbsp;
- For more product information, please refer to the official website link:[https://www.orbbec.com/products](https://www.orbbec.com/products/)
&nbsp;
docs/source/1_overview/supported_platforms.md
Executable
+26
View File
@@ -0,0 +1,26 @@
# Supported platforms
&nbsp;
- The verified supported platforms and OS are as follows:
| No. | Platform | CPU | OS | ROS2 |
| --- | ------------------------ | --- | ------------ | -------- |
| 1 | X64 PC | X86 | Ubuntu 20.04 | humble |
| 2 | X64 PC | X86 | Ubuntu 22.04 | humble |
| 3 | X64 PC | X86 | Ubuntu 24.04 | foxy |
| 4 | NVIDIA Jetson Orin Nano | Arm | Ubuntu 20.04 | humble |
| 5 | NVIDIA Jetson Orin NX | Arm | Ubuntu 20.04 | humble |
| 6 | NVIDIA Jetson AGX Orin | Arm | Ubuntu 20.04 | humble |
| 7 | NVIDIA Jetson AGX Orin | Arm | Ubuntu 22.04 | humble |
| 8 | NVIDIA Jetson AGX Xavier | Arm | Ubuntu 20.04 | humble |
| 9 | Qualcomm RB5 | Arm | Ubuntu 20.04 | humble |
| 10 | RK3399 | Arm | Ubuntu 20.04 | humble |
| 11 | RK3588 | Arm | Ubuntu 20.04 | Galactic |
| 12 | RK3588 | Arm | Ubuntu 22.04 | humble |
&nbsp;
&nbsp;
&nbsp;
docs/source/1_overview/typical_applications.md
Executable
+23
View File
@@ -0,0 +1,23 @@
![product](../image/product_h2.png)
&nbsp;
# Typical applications
OrbbecSDK_ROS2 is a wrapper for the Orbbec 3D camera that provides seamless integration with the ROS2 environment. It
supports ROS2 Foxy, Humble, and Jazzy distributions.
**Applications scenarios:**
* Depth Sensing
* Object Detection
* Body Tracking
* Positional Tracking
* Geo Tracking
* Spatial Mapping
* Camera Control
* Plane Detection
* Multi Camera Fusion
* [OPDK ![OPDK](../image/opdk_logo.png)](https://www.orbbec.com/opdk/)
&nbsp;