add docs _htmi file

orbbec · Nov 5, 2024 · db0ebd6 · db0ebd6
1 parent c38dbf1
commit db0ebd6
Show file tree

Hide file tree

Showing 326 changed files with 25,373 additions and 0 deletions.
diff --git a/docs/_html/.buildinfo b/docs/_html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 8a074fd878bc867c27faa974d4f8361f
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_html/.nojekyll b/docs/_html/.nojekyll
diff --git a/docs/_html/3d-vision-for-a-world-2.png b/docs/_html/3d-vision-for-a-world-2.png
diff --git a/docs/_html/3d-vision-for-a-world.png b/docs/_html/3d-vision-for-a-world.png
diff --git a/docs/_html/Linux_Install_1.png b/docs/_html/Linux_Install_1.png
diff --git a/docs/_html/Linux_Install_2.png b/docs/_html/Linux_Install_2.png
diff --git a/docs/_html/Linux_Install_3.png b/docs/_html/Linux_Install_3.png
diff --git a/docs/_html/Linux_Install_4.png b/docs/_html/Linux_Install_4.png
diff --git a/docs/_html/Linux_Install_5.png b/docs/_html/Linux_Install_5.png
diff --git a/docs/_html/MultiStream.png b/docs/_html/MultiStream.png
diff --git a/docs/_html/Multi_camera1.png b/docs/_html/Multi_camera1.png
diff --git a/docs/_html/Multi_camera2.png b/docs/_html/Multi_camera2.png
diff --git a/docs/_html/Multi_camera3.png b/docs/_html/Multi_camera3.png
diff --git a/docs/_html/Multi_camera4.png b/docs/_html/Multi_camera4.png
diff --git a/docs/_html/OrbbecSDK-Architecture.png b/docs/_html/OrbbecSDK-Architecture.png
diff --git a/docs/_html/OrbbecSDK-Get-Frame-Sequence-Diagram.png b/docs/_html/OrbbecSDK-Get-Frame-Sequence-Diagram.png
diff --git a/docs/_html/OrbbecSDK_C++_API_user_guide-v1.0.pdf b/docs/_html/OrbbecSDK_C++_API_user_guide-v1.0.pdf
diff --git a/docs/_html/OrbbecViewer.png b/docs/_html/OrbbecViewer.png
diff --git a/docs/_html/README.html b/docs/_html/README.html
diff --git a/docs/_html/_images/3d-vision-for-a-world-2.png b/docs/_html/_images/3d-vision-for-a-world-2.png
diff --git a/docs/_html/_images/Linux_Install_1.png b/docs/_html/_images/Linux_Install_1.png
diff --git a/docs/_html/_images/Linux_Install_2.png b/docs/_html/_images/Linux_Install_2.png
diff --git a/docs/_html/_images/Linux_Install_3.png b/docs/_html/_images/Linux_Install_3.png
diff --git a/docs/_html/_images/Linux_Install_4.png b/docs/_html/_images/Linux_Install_4.png
diff --git a/docs/_html/_images/Linux_Install_5.png b/docs/_html/_images/Linux_Install_5.png
diff --git a/docs/_html/_images/Multi_camera1.png b/docs/_html/_images/Multi_camera1.png
diff --git a/docs/_html/_images/Multi_camera2.png b/docs/_html/_images/Multi_camera2.png
diff --git a/docs/_html/_images/Multi_camera3.png b/docs/_html/_images/Multi_camera3.png
diff --git a/docs/_html/_images/Multi_camera4.png b/docs/_html/_images/Multi_camera4.png
diff --git a/docs/_html/_images/backward_ros.png b/docs/_html/_images/backward_ros.png
diff --git a/docs/_html/_images/gdb_1.png b/docs/_html/_images/gdb_1.png
diff --git a/docs/_html/_images/gmsl_1.png b/docs/_html/_images/gmsl_1.png
diff --git a/docs/_html/_images/image1.jpg b/docs/_html/_images/image1.jpg
diff --git a/docs/_html/_images/image10.png b/docs/_html/_images/image10.png
diff --git a/docs/_html/_images/image2.jpg b/docs/_html/_images/image2.jpg
diff --git a/docs/_html/_images/image3.png b/docs/_html/_images/image3.png
diff --git a/docs/_html/_images/image4.jpg b/docs/_html/_images/image4.jpg
diff --git a/docs/_html/_images/image5.jpg b/docs/_html/_images/image5.jpg
diff --git a/docs/_html/_images/image6.jpg b/docs/_html/_images/image6.jpg
diff --git a/docs/_html/_images/image7.png b/docs/_html/_images/image7.png
diff --git a/docs/_html/_images/image8.png b/docs/_html/_images/image8.png
diff --git a/docs/_html/_images/image9.png b/docs/_html/_images/image9.png
diff --git a/docs/_html/_images/list_camera_profile_mode_node.png b/docs/_html/_images/list_camera_profile_mode_node.png
diff --git a/docs/_html/_images/list_depth_work_mode_node.png b/docs/_html/_images/list_depth_work_mode_node.png
diff --git a/docs/_html/_images/list_devices_node.png b/docs/_html/_images/list_devices_node.png
diff --git a/docs/_html/_images/multi_save_rgbir_node.png b/docs/_html/_images/multi_save_rgbir_node.png
diff --git a/docs/_html/_images/product_h1.png b/docs/_html/_images/product_h1.png
diff --git a/docs/_html/_images/product_h11.png b/docs/_html/_images/product_h11.png
diff --git a/docs/_html/_images/product_h2.png b/docs/_html/_images/product_h2.png
diff --git a/docs/_html/_images/product_h3.png b/docs/_html/_images/product_h3.png
diff --git a/docs/_html/_images/product_h4.png b/docs/_html/_images/product_h4.png
diff --git a/docs/_html/_images/product_h5.png b/docs/_html/_images/product_h5.png
diff --git a/docs/_html/_images/product_h7.png b/docs/_html/_images/product_h7.png
diff --git a/docs/_html/_images/product_h8.png b/docs/_html/_images/product_h8.png
diff --git a/docs/_html/_images/product_h9.png b/docs/_html/_images/product_h9.png
diff --git a/docs/_html/_images/single_cam_tf.png b/docs/_html/_images/single_cam_tf.png
diff --git a/docs/_html/_images/supported_cameras.png b/docs/_html/_images/supported_cameras.png
diff --git a/docs/_html/_images/windows_install_1.png b/docs/_html/_images/windows_install_1.png
diff --git a/docs/_html/_images/windows_install_2.png b/docs/_html/_images/windows_install_2.png
diff --git a/docs/_html/_images/windows_install_3.png b/docs/_html/_images/windows_install_3.png
diff --git a/docs/_html/_images/windows_install_4.png b/docs/_html/_images/windows_install_4.png
diff --git a/docs/_html/_images/windows_install_5.png b/docs/_html/_images/windows_install_5.png
diff --git a/docs/_html/_images/windows_install_6.png b/docs/_html/_images/windows_install_6.png
diff --git a/docs/_html/_sources/README.md.txt b/docs/_html/_sources/README.md.txt
@@ -0,0 +1,92 @@
+# Docs应用文档
+
+**编译：**
+
+```bash
+cd docs
+./autobuild.sh all
+
+```
+
+**打开文档：**
+
+```bash
+cd docs
+./autobuild.sh run
+
+```
+
+或
+
+进入_html目录，手动点击index.html打开
+
+# Docs应用文档详细说明
+
+**采用方式：**
+
+1、文档格式 markdown
+
+2、文档转换工具 Sphinx
+
+3、托管 github
+
+<br>
+
+# gitlab：
+
+本项目源码地址： https://code.orbbec.com.cn/OrbbecSDK/OrbbecSDK_ROS2.git
+
+# github （待上线）
+
+本项目源码地址 ：  待上线
+本应用文档阅读链接 ： 待上线
+
+<br>
+
+# 文档编写规范
+
+1、框图、软件框架建议原则上采用processon、visio工具绘图，目的是为了保持风格统一（特殊图除外）
+
+2、采用标准markdown格式，可使用vscode的Editor插件编辑
+
+<br>
+
+# 编译环境
+
+pip3 install sphinx
+
+pip3 install recommonmark
+
+pip3 install sphinx_markdown_tables
+
+pip3 install sphinx_rtd_theme
+
+pip3 install sphinx_book_theme
+
+# 编译
+
+- 执行编译脚本 ./autobuild 编译（推荐，该脚本编译后会打包docs文档及渲染设置）。 也支持sphinx原生编译指令make html
+- 打开docs/index.html查看效果
+
+<br>
+
+# 提交
+
+git add 、git commit 添加注释、git push提交代码
+
+提交完后，务必要上线网页打开检查一下，检查网页效果无误
+
+<br>
+
+# 定制化部分
+
+说明：定制化的配置都在**conf.py**中设置。也需要安装一些支持库
+
+1. 更改样式主题。我这里以 `sphinx_rtd_theme`为例子，其他主题可自行百度。
+
+* 安装 `sphinx_rtd_theme`:    ` pip install sphinx_rtd_theme`
+
+2. 安装markdown语法支持插件：`pip install myst-parser`
+3. 安装支持mermaid渲染插件: `pip install sphinxcontrib.mermaid`
+4. 安装代码块一键复制按钮插件：`pip install sphinx_copybutton`
+5. 可以使用vscode 编辑markdown文件文档，推荐安装markdown预览编辑插件
diff --git a/docs/_html/_sources/index.rst.txt b/docs/_html/_sources/index.rst.txt
@@ -0,0 +1,31 @@
+.. [奥比中光]OrbbecSDK ROS2 应用文档.用户手册
+.. 这一页是目录树
+..     :titlesonly:
+
+
+
+.. image:: source/image/product_h5.png
+
+======================================================
+
+
+OrbbecSDK ROS2
+======================================================
+
+
+.. toctree::
+    :maxdepth: 2
+    :caption:   Application Document
+    :numbered:
+
+    source/1_overview/overview.rst
+    source/2_installation/installation.rst
+    .. source/3_start_single_camera/single_camera.rst
+    .. source/4_start_multi_camera/multi_camera.rst
+    source/3_start_single_camera/start_single_camera.md
+    source/4_start_multi_camera/start_multi_camera.md
+    source/5_robot_integrations/robot_integra.rst
+    source/6_advanced/advanced.rst
+    source/7_tools/tool.rst
+    source/8_help_center/help_center.rst
+    source/9_license/license.rst
diff --git a/docs/_html/_sources/source/1_overview/overview.rst.txt b/docs/_html/_sources/source/1_overview/overview.rst.txt
@@ -0,0 +1,55 @@
+.. 这一页是模块目录树
+
+.. 3d-vision-for-a-world-2.png
+.. image::  ../image/product_h1.png
+
+======================================================
+
+
+Overview
+======================================================
+
+
+
+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.
+
+
+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:
+
+    typical_applications.md
+    supported_cameras.md
+    supported_platforms.md
+
+
+
+
+---------------------
+
+.. image:: http://badges.github.io/stability-badges/dist/stable.svg
+.. image:: https://img.shields.io/badge/version-1.5.11-green
+
+---------------------
+
+
+.. image::  ../image/3d-vision-for-a-world-2.png
diff --git a/docs/_html/_sources/source/1_overview/supported_cameras.md.txt b/docs/_html/_sources/source/1_overview/supported_cameras.md.txt
@@ -0,0 +1,30 @@
+# Supported cameras
+
+&nbsp;
+
+- The specific supported cameras model are as follows:
+
+| No. | **Products List** | **Firmware Version** | Port interface types        | product link                                                            | dataset |
+| --- | ----------------------- | -------------------------- | --------------------------- | ----------------------------------------------------------------------- | ------- |
+| 1   | Gemini 335              | 1.2.20                     | USB 3.0                     | [link](https://www.orbbec.com/products/stereo-vision-camera/gemini-335/)   |         |
+| 2   | Gemini 335L             | 1.2.20                     | USB 3.0                     | [link](https://www.orbbec.com/products/stereo-vision-camera/gemini-335l/)  |         |
+| 3   | Gemini 335Lg            | 1.3.46                     | USB 3.0、GMSL interface     | [link](https://www.orbbec.com/products/stereo-vision-camera/gemini-335lg/) |         |
+| 4   | Gemini 336              | 1.2.20                     | USB 3.0                     | [link](https://www.orbbec.com/products/stereo-vision-camera/gemini-336)    |         |
+| 5   | Gemini 336L             | 1.2.20                     | USB 3.0                     | [link](https://www.orbbec.com/products/stereo-vision-camera/gemini-336l)   |         |
+| 6   | Gemini 2                | 1.4.60 /1.4.76             | USB 3.0                     | [link](https://www.orbbec.com/products/stereo-vision-camera/gemini-2/)     |         |
+| 7   | Gemini 2 L              | 1.4.32                     | USB 3.0                     | [link](https://www.orbbec.com/products/stereo-vision-camera/gemini-2l/)    |         |
+| 8   | Astra 2                 | 2.8.20                     | USB 3.0                     | [link](https://www.orbbec.com/products/structured-light-camera/astra-2/)   |         |
+| 9   | Femto Bolt              | 1.0.6/1.0.9                | USB 3.0                     | [link](https://www.orbbec.com/products/tof-camera/femto-bolt/)             |         |
+| 10  | Femto Mega              | 1.1.7/1.2.7                | USB 3.0、Ethernet interface | [link](https://www.orbbec.com/products/tof-camera/femto-mega/)             |         |
+
+&nbsp;
+
+&nbsp;
+
+- For more product information, please refer to the official website link:[https://www.orbbec.com/products](https://www.orbbec.com/products/)
+
+![supported_cameras](../image/supported_cameras.png)
+
+&nbsp;
+
+&nbsp;
diff --git a/docs/_html/_sources/source/1_overview/supported_platforms.md.txt b/docs/_html/_sources/source/1_overview/supported_platforms.md.txt
@@ -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;
diff --git a/docs/_html/_sources/source/1_overview/typical_applications.md.txt b/docs/_html/_sources/source/1_overview/typical_applications.md.txt
@@ -0,0 +1,26 @@
+![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.
+
+&nbsp;
+
+&nbsp;
+
+**Applications scenarios:**
+
+* Depth Sensing
+* Object Detection
+* Body Tracking
+* Positional Tracking
+* Geo Tracking
+* Spatial Mapping
+* Camera Control
+* Plane Detection
+* Multi Camera Fusion
+
+&nbsp;