diff --git a/.gitignore b/.gitignore
index 2181d2b6..f0ca0d45 100644
--- a/.gitignore
+++ b/.gitignore
@@ -764,8 +764,6 @@ FodyWeavers.xsd
# JetBrains Rider
*.sln.iml
-docs/
-_html/
### VisualStudio Patch ###
# Additional files built by Visual Studio
diff --git a/docs/.gitignore b/docs/.gitignore
deleted file mode 100755
index e76724e0..00000000
--- a/docs/.gitignore
+++ /dev/null
@@ -1,2 +0,0 @@
-_build
-.vscode
diff --git a/docs/.gitlab-ci.yml b/docs/.gitlab-ci.yml
deleted file mode 100755
index 6781d05b..00000000
--- a/docs/.gitlab-ci.yml
+++ /dev/null
@@ -1,16 +0,0 @@
-# This file is a template, and might need editing before it works on your project.
-# Full project: https://gitlab.com/pages/plain-html
-pages:
- tags:
- - html
- stage: deploy
- script:
- - mkdir .public
- - cp -r * .public
- - mv .public public
- artifacts:
- paths:
- - public
- only:
- - master
-
diff --git a/docs/.nojekyll b/docs/.nojekyll
deleted file mode 100755
index e69de29b..00000000
diff --git a/docs/Makefile b/docs/Makefile
deleted file mode 100755
index d4bb2cbb..00000000
--- a/docs/Makefile
+++ /dev/null
@@ -1,20 +0,0 @@
-# Minimal makefile for Sphinx documentation
-#
-
-# You can set these variables from the command line, and also
-# from the environment for the first two.
-SPHINXOPTS ?=
-SPHINXBUILD ?= sphinx-build
-SOURCEDIR = .
-BUILDDIR = _build
-
-# Put it first so that "make" without argument is like "make help".
-help:
- @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-
-.PHONY: help Makefile
-
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
- @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/README.md b/docs/README.md
deleted file mode 100755
index 581b5679..00000000
--- a/docs/README.md
+++ /dev/null
@@ -1,87 +0,0 @@
-# Docs应用文档
-
-**编译：**
-
-```bash
-cd docs
-./autobuild.sh all
-
-```
-
-**打开文档：**
-
-```bash
-cd docs
-./autobuild.sh run
-
-```
-
-或
-
-进入_html目录，手动点击index.html打开
-
-# Docs应用文档详细说明
-
-**采用方式：**
-
-1、文档格式 markdown
-
-2、文档转换工具 Sphinx
-
-3、托管 github
-
-
-# gitlab：
-
-本项目源码地址： https://code.orbbec.com.cn/OrbbecSDK/OrbbecSDK_ROS2.git
-
-# github （待上线）
-
-本项目源码地址 ： 待上线
-本应用文档阅读链接 ： 待上线
-
-
-# 文档编写规范
-
-1、框图、软件框架建议原则上采用processon、visio工具绘图，目的是为了保持风格统一（特殊图除外）
-
-2、采用标准markdown格式，可使用vscode的Editor插件编辑
-
-
-# 编译环境
-
-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查看效果
-
-
-# 提交
-
-git add 、git commit 添加注释、git push提交代码
-
-提交完后，务必要上线网页打开检查一下，检查网页效果无误
-
-
-# 定制化部分
-
-说明：定制化的配置都在**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/align_depth_color.MD b/docs/align_depth_color.MD
new file mode 100644
index 00000000..b4f57ced
--- /dev/null
+++ b/docs/align_depth_color.MD
@@ -0,0 +1,40 @@
+## Aligning Depth to Color in ROS 2
+
+This section explains how to align depth images with color images to create an overlay image using ROS 2. This is particularly useful for applications requiring synchronized visual information from different sensor modalities.
+
+### Commands to Align and View Depth and Color Images
+
+1. **Basic Depth to Color Alignment:**
+
+ To simply align the depth image to the color image, use the following command:
+
+ ```bash
+ ros2 launch orbbec_camera gemini_330_series.launch.py depth_registration:=true
+ ```
+
+ This command activates the depth registration feature without opening a viewer.
+
+2. **Viewing Depth to Color Overlay:**
+
+ If you wish to view the depth to color overlay, you need to enable the viewer by using the command below:
+
+ ```bash
+ ros2 launch orbbec_camera gemini_330_series.launch.py depth_registration:=true enable_d2c_viewer:=true
+ ```
+
+ This launches the camera node with depth to color registration and opens a viewer to display the overlay image.
+
+### Selecting Topics in RViz2
+
+To visualize the aligned images in RViz2:
+
+1. Launch RViz2 after running one of the above commands.
+2. Select the topic for the depth to color overlay image. An example topic selection is shown here:
+
+ 
+
+### Example of Depth to Color Overlay
+
+After selecting the appropriate topic in RViz2, you will be able to see the depth to color overlay image. Here's what it might look like:
+
+
diff --git a/docs/align_depth_color_CN.MD b/docs/align_depth_color_CN.MD
new file mode 100644
index 00000000..32ef58a5
--- /dev/null
+++ b/docs/align_depth_color_CN.MD
@@ -0,0 +1,40 @@
+## 在ROS 2中将深度图像与彩色图像对齐
+
+本节介绍如何使用ROS 2将深度图像与彩色图像对齐，以创建叠加图像。这对于需要来自不同传感器模态的同步视觉信息的应用程序特别有用。
+
+### 对齐并查看深度和彩色图像的命令
+
+1. **基本的深度到彩色对齐：**
+
+ 要简单地将深度图像对齐到彩色图像，使用以下命令：
+
+ ```bash
+ ros2 launch orbbec_camera gemini_330_series.launch.py depth_registration:=true
+ ```
+
+ 此命令激活深度注册功能，但不打开查看器。
+
+2. **查看深度到彩色叠加：**
+
+ 如果您希望查看深度到彩色叠加，您需要通过使用以下命令来启用查看器：
+
+ ```bash
+ ros2 launch orbbec_camera gemini_330_series.launch.py depth_registration:=true enable_d2c_viewer:=true
+ ```
+
+ 这将启动具有深度到彩色注册的相机节点，并打开一个查看器以显示叠加图像。
+
+### 在RViz2中选择主题
+
+要在RViz2中可视化对齐的图像：
+
+1. 在运行上述命令之一后启动RViz2。
+2. 选择深度到彩色叠加图像的主题。这里显示了一个示例主题选择：
+
+ 
+
+### 深度到彩色叠加示例
+
+在RViz2中选择合适的主题后，您将能够看到深度到彩色叠加图像。这是它可能看起来的样子：
+
+
\ No newline at end of file
diff --git a/docs/autobuild.sh b/docs/autobuild.sh
deleted file mode 100755
index e9d7ad8b..00000000
--- a/docs/autobuild.sh
+++ /dev/null
@@ -1,172 +0,0 @@
-#!/bin/bash
-
-#set -e
-
-##################################################################
-
-##################################################################
-#Function List
-print_help()
-{
- echo ""
- echo "------------------------ help menu --------------------------"
- echo " help menu option: "
- echo "./autobuild.sh all ------build all"
- echo "./autobuild.sh senddoc ----- send doc to server"
- echo "./autobuild.sh syncdoc -----syncdoc"
- echo "./autobuild.sh clean ----clean all"
- echo "./autobuild.sh run ---- open html"
- echo "./autobuild.sh help (-h, --help) show help menu"
- echo "-------------------------------------------------------------"
-}
-
-echo_autobuild_start()
-{
- echo ""
- echo -e "\e[32m*********** ./autobuild.sh $1 **************\e[0m"
-}
-
-build_all()
-{
- echo "make clean && make html"
- make clean
- rm -rf _html
- rm -rf _build
- rm -rf docs
- make html
- cp -R _build/html _html
- cp .nojekyll _html/
- cp _html/ docs/ -af
- echo "create _html finished"
-}
-
-clean()
-{
- echo "clean all"
- make clean
-}
-
-sync_doc_old()
-{
- echo "copy ../robot_sdk/ ../robot_ref/ ../robot_actuator file to robot_doc/source/syncdoc/"
- echo "search README.md"
- readme_files=$(find ../robot_sdk/ ../robot_ref/ ../robot_actuator/ -name 'README.md')
- for file in $readme_files; do
- dir=$(dirname "$file")
-
- new_dir=$(echo "$dir" | cut -d'/' -f2-)
- #echo "copy $file to source/syncdoc/$new_dir/README.md"
- echo "source/syncdoc/$new_dir/README.md"
- mkdir -p "source/syncdoc/$new_dir"
- cp -r "$file" "source/syncdoc/$new_dir/"
- if [ -d "$dir/image" ]; then
- cp -r "$dir/image" "source/syncdoc/$new_dir/"
- fi
- done
-}
-sync_doc()
-{
- echo "search *.rst and *.md from source code"
- # readme_files=$(find ../robot_sdk/ ../robot_ref/ ../robot_actuator/ -name 'README.rst')
- # readme_files=$(find ../robot_sdk/ ../robot_ref/ ../robot_actuator/ -name '*.rst' -o -name '*.md')
- readme_files=$(find ../robot_sdk/ ../robot_ref/ ../robot_actuator/ -name 'README.rst' -o -name 'README.md')
- for file in $readme_files; do
- dir=$(dirname "$file")
- new_dir=$(echo "$dir" | cut -d'/' -f2-)
- #echo "copy $file to source/syncdoc/$new_dir/README.md"
- mkdir -p "source/syncdoc/$new_dir"
- cp -r "$file" "source/syncdoc/$new_dir/"
- echo "copy $file --> source/syncdoc/$new_dir/README.rst"
- echo "search image in $dir"
- find "$dir" -type f \( -name "*.png" -o -name "*.gif" -o -name "*.jpg" \) | while read -r serach_file; do
- target_path="source/syncdoc/$new_dir/$(echo "$serach_file" | sed "s|^$dir/||")"
- mkdir -p "$(dirname "$target_path")"
- cp "$serach_file" "$target_path"
- echo "copy $serach_file --> $target_path"
- done
- done
-}
-
-#####################################################################
-# 初始化
-#####################################################################
-
-datetime=$(date +%Y%m%d_%H%M)
-echo_autobuild_start;
-
-##################################################################
-if [ "$#" -eq "0" ]; then
- echo "unknown option: $1 [$#]. pls enter correct cmd:"
- print_help;
- exit 0
-fi
-
-while [ $# -gt 0 ]; do
- echo "option=$1 total=$#:"
- case $1 in
-
- -h | --help | help | h | --h)
- print_help
- ;;
-
- clear | clean | cl)
- clean
- ;;
-
- build | all)
- build_all
- ;;
-
- syncdoc | sync | sd)
- sync_doc
- ;;
-
- run | r)
- echo "open html"
- # Google Chrome的完整路径
- CHROME_PATH="/usr/bin/google-chrome"
- # get full path name of html.html
- HTML_FILE="$(pwd)/_build/html/index.html"
- # 使用绝对路径确保脚本在任何目录下都能正确执行
- CHROME_EXECUTABLE="$(which "$CHROME_PATH")"
- # 使用绝对路径确保脚本在任何目录下都能正确执行
- CHROME_EXECUTABLE="$(which "$CHROME_PATH")"
- # x-www-browser _build/html/index
- # open -a /Applications/Firefox.app _build/html/index
- "$CHROME_EXECUTABLE" "$HTML_FILE"
- ;;
- senddoc | send)
- echo "send doc update to 20.13"
- # echo "send doc update to 10.8.170.85"
- # sshpass -p pwd@123 scp -r _html/* orbbec@10.8.170.85:/var/www/html/robot_doc/
- OUT_IMAGE_SERVER_FOLDER=orbbec_sdk_ros2_doc
- sshpass -p 123 ssh guojia@10.8.180.197 "[ -d /home/orbbec/.SDKBuild/20_13_build_sdk/${OUT_IMAGE_SERVER_FOLDER} ] && echo 20.13 server ready || mkdir -p /home/orbbec/.SDKBuild/20_13_build_sdk/${OUT_IMAGE_SERVER_FOLDER}"
- sshpass -p 123 scp -r _html guojia@10.8.180.197:/home/orbbec/.SDKBuild/20_13_build_sdk/orbbec_sdk_ros2_doc/
-
- ;;
- test1 )
- echo "test1"
-
- ;;
- test2 )
- echo "test2"
-
- ;;
- test3 )
- echo "test3"
-
- ;;
- *)
- echo "unknown option: $1"
- print_help
- ;;
- esac
- shift
-done
-
-
-
-echo "autobuild.sh end"
-
-##################################################################
-
diff --git a/docs/backup_index.txt b/docs/backup_index.txt
deleted file mode 100755
index 2e4f2aa3..00000000
--- a/docs/backup_index.txt
+++ /dev/null
@@ -1,106 +0,0 @@
-.. [奥比中光]OrbbecSDK ROS2 应用文档.用户手册
-.. 这一页是目录树
-
-OrbbecSDK ROS2 application docs
-======================================================
-
-
-.. toctree::
- :maxdepth: 2
- :caption: 1.Overview
- :titlesonly:
- :numbered:
-
- source/overview/typical_applications.md
- source/overview/supported_cameras.md
- source/overview/supported_platforms.md
-
-
-.. toctree::
- :maxdepth: 2
- :caption: 2.Installation
- :titlesonly:
- :numbered:
-
- source/installation/build_the_package.md
- source/installation/package_description.md
- .. source/installation/prerequisites.md
-
-.. toctree::
- :maxdepth: 2
- :caption: 3.Start single camera
- :titlesonly:
- :numbered:
-
- source/start_single_camera.md
-
-
-.. toctree::
- :maxdepth: 1
- :caption: 4.Start multi camera
- :titlesonly:
- :numbered:
-
- source/start_multi_camera.md
-
-
-.. toctree::
- :maxdepth: 2
- :caption: 5.Robot integrations
- :titlesonly:
- :numbered:
-
- source/robot_integrations.md
-
-
-.. toctree::
- :maxdepth: 2
- :caption: 6.Advanced
- :titlesonly:
- :numbered:
-
- source/advanced/multi_camera_sync.md
- source/advanced/component_node.md
- source/advanced/zero_copy.md
- source/advanced/gdb_debug.md
- source/advanced/backward_ros.md
-
-
-.. toctree::
- :maxdepth: 2
- :caption: 7.Tools
- :titlesonly:
- :numbered:
-
- source/tools.md
-
-.. toctree::
- :maxdepth: 2
- :caption: 8.Help center
- :titlesonly:
- :numbered:
-
- source/help_center/question_and_answer.md
- source/help_center/issues.md
-
-.. toctree::
- :maxdepth: 2
- :caption: 9.(参考,待移除)
- :titlesonly:
- :numbered:
-
- source/temp/point_cloud.md
- source/temp/align_depth_color.md
- source/temp/fastdds_tuning.md
- .. source/temp/necessary_configurations.md
- source/temp/orbbec_viewer_tool.md
- .. source/temp/data_display_with_rviz2.md
-
-
-.. toctree::
- :maxdepth: 1
- :caption: 10.license
-
- source/license.md
- LICENSE
-
diff --git a/docs/conf.py b/docs/conf.py
deleted file mode 100755
index 335f40d6..00000000
--- a/docs/conf.py
+++ /dev/null
@@ -1,200 +0,0 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
-
-import os
-import shutil
-import sphinx
-
-import recommonmark
-from recommonmark.transform import AutoStructify
-
-# import sphinx_book_theme
-# import sphinx_rtd_theme
-# import furo
-
-
-#choice theme default
-# html_theme = 'sphinx_book_theme'
-html_theme = 'sphinx_rtd_theme'
-# html_theme = "furo"
-
-# -- Project information -----------------------------------------------------
-
-project = 'OrbbecSDK ROS2'
-# project = """
-# OrbbecSDK ROS2 documentation
-# """
-copyright = '2023, ORBBEC INC. www.orbbec.com.cn'
-author = 'ORBBEC INC. www.orbbec.com.cn'
-
-
-# -- General configuration ---------------------------------------------------
-# The master toctree document.
-master_doc = 'index'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = ['recommonmark',
- 'sphinx_markdown_tables',
-
- 'sphinx.ext.autosectionlabel',
-
-# 'myst_parser',
-]
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-source_suffix = ['.rst', 'rest', '.md', '.MD']
-
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-# language = 'zh_CN'
-language = 'en'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-
-
-# -- Options for HTML output -------------------------------------------------
-
-# html_logo = "source/_static/orbbec_logo2.png"
-# html_favicon = "source/_static/orbbec_logo2.png"
-
-html_logo = "source/_static/orbbec-light_no_colour.svg"
-html_favicon = "source/_static/web_html_logo.png"
-# html_logo = "source/_static/orbbec_footerlogo_3d_world.svg"
-# html_favicon = "source/_static/orbbec_footerlogo_3d_world.svg"
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['source/_static','source/image']
-
-html_extra_path = ['source/image']
-
-html_theme_options = {
- # 'analytics_id': 'G-EVD5Z6G6NH',
- 'collapse_navigation': False,
- # 启用导航栏的“粘性”头部，这样导航栏会固定在页面顶部
- 'sticky_navigation': True,
- # 配置导航栏的深度，-1 表示显示所有层级的标题
- 'navigation_depth': 5,
- # 'show_navbar_depth': 4,
- # 导航栏显示+号
- 'collapse_navigation': False,
-
- # 'analytics_anonymize_ip': False,
- # 'logo_only': False,
- # 'display_version': True,
- # 'prev_next_buttons_location': 'bottom',
- # 'style_external_links': False,
- # 'vcs_pageview_mode': '',
- # 'style_nav_header_background': 'white',
- # # Toc options
- # 'collapse_navigation': True,
- # 'sticky_navigation': True,
- # 'navigation_depth': 5,
- # 'includehidden': True,
- # 'titles_only': False
-}
-
-
-
-
-
-
-# # 添加自定义的 JavaScript 文件
-# html_js_files = ["theme.js"]
-
-
-# #不需要添加_static目录，加了会不起作用
-html_css_files = ["custom.css"]
-
-# 与文档无关的其他资源的路径，由于无需构建此文件夹的文件，会自动忽略
-# 默认情况下，此路径下的文件会输出到生成的html的根目录
-# html_extra_path = ["_extra"]
-
-# 在页面底部显示上一次更新于某某时间
-html_last_updated_fmt = "%Y-%m-%d %H:%M:%S"
-
-# 以下为 sphinx_book_theme 的主题配置/定制（sphinx_book_theme）
-# html_theme_options = {
-# # ----------------主题内容中导航栏的功能按钮配置--------
-# # 添加存储库链接
-# "repository_url": "https://github.com/Eugene-Forest/NoteBook",
-# # 添加按钮以链接到存储库
-# "use_repository_button": True,
-# # 要添加按钮以打开有关当前页面的问题
-# "use_issues_button": True,
-# # 添加一个按钮来建议编辑
-# "use_edit_page_button": True,
-# # 默认情况下，编辑按钮将指向master分支，但如果您想更改此设置，请使用以下配置
-# "repository_branch": "main",
-# # 默认情况下，编辑按钮将指向存储库的根目录；而我们 sphinx项目的 doc文件其实是在 source 文件夹下的，包括 conf.py 和 index(.rst) 主目录
-# "path_to_docs": "source",
-# # 您可以添加 use_download_button 按钮，允许用户以多种格式下载当前查看的页面
-# "use_download_button": True,
-
-# # --------------------------右侧辅助栏配置---------
-# # 重命名右侧边栏页内目录名，标题的默认值为Contents。
-# "toc_title": "页内目录",
-# # 通常，右侧边栏页内目录中仅显示页面的第 2 级标题，只有当它们是活动部分的一部分时（在屏幕上滚动时），才会显示更深的级别。可以使用以下配置显示更深的级别，指示应显示多少级别
-# "show_toc_level": 2,
-
-# # --------------------------左侧边栏配置--------------
-# # logo 配置
-# "logo_only": True,
-# # 控制左侧边栏列表的深度展开,默认值为1，它仅显示文档的顶级部分
-# "show_navbar_depth": 1,
-# # 自定义侧边栏页脚,默认为 Theme by the Executable Book Project
-# # "extra_navbar": "
Your HTML
",
-# "home_page_in_toc": True,
-# # ------------------------- 单页模式 -----------------
-# # 如果您的文档只有一个页面，并且您不需要左侧导航栏，那么您可以 使用以下配置将其配置sphinx-book-theme 为以单页模式运行
-# # "single_page": True,
-# }
-
-# 是否显示页面下方的由sphinx创建, 默认为True
-html_show_sphinx = False
-
-# Function to copy video files to output directory
-def setup(app):
- app.connect('build-finished', copy_videos)
-
-def copy_videos(app, exception):
- if exception is None: # Only copy if build succeeded
- src_dir = os.path.join(app.srcdir, '_static/videos')
- dest_dir = os.path.join(app.outdir, '_static/videos')
- if os.path.exists(src_dir):
- shutil.copytree(src_dir, dest_dir)
-
-# 20201030
-def setup(app):
- app.add_config_value('recommonmark_config', {
- 'url_resolver': lambda url: github_doc_root + url,
- 'auto_toc_tree_section': 'Contents',
- }, True)
- app.add_transform(AutoStructify)
\ No newline at end of file
diff --git a/docs/source/5_advanced/fastdds_tuning.md b/docs/fastdds_tuning.md
old mode 100755
new mode 100644
similarity index 88%
rename from docs/source/5_advanced/fastdds_tuning.md
rename to docs/fastdds_tuning.md
index 0ae3fbfd..1e1ad021
--- a/docs/source/5_advanced/fastdds_tuning.md
+++ b/docs/fastdds_tuning.md
@@ -1,12 +1,12 @@
-# FastDDS tuning
+# Fast DDS Optimization for Orbbec Camera with ROS2
-When operating with the default configuration, FastDDS exhibits suboptimal transmission efficiency, resulting in
+When operating with the default configuration, Fast DDS exhibits suboptimal transmission efficiency, resulting in
significant image transmission delays when used with the Orbbec camera in ROS2. This document provides guidance on
-optimizing FastDDS to enhance image transfer efficiency.
+optimizing Fast DDS to enhance image transfer efficiency.
-## Adjusting system parameters
+## 1. Adjusting System Parameters
-### IP fragmentation time
+### IP Fragmentation Time
- **Path**: `/proc/sys/net/ipv4/ipfrag_time` (default: 30 seconds)
- **Purpose**: Defines the duration that IP fragments are kept in memory.
@@ -19,7 +19,7 @@ optimizing FastDDS to enhance image transfer efficiency.
sudo sysctl net.ipv4.ipfrag_time=3
```
-### IP fragmentation memory threshold
+### IP Fragmentation Memory Threshold
- **Path**: `/proc/sys/net/ipv4/ipfrag_high_thresh` (default: 262144 bytes)
- **Purpose**: Sets the maximum memory used to reassemble IP fragments.
@@ -32,7 +32,7 @@ optimizing FastDDS to enhance image transfer efficiency.
sudo sysctl net.ipv4.ipfrag_high_thresh=134217728
```
-### Maximum buffer sizes
+### Maximum Buffer Sizes
- **Purpose**: Configures the maximum buffer sizes for receiving and sending data, which is critical for high-throughput
data transmission.
@@ -67,12 +67,12 @@ then save and exit the file. run `sudo sysctl -p` to apply the changes.
For detailed guidance, refer
to [ROS 2 DDS Tuning Documentation](https://docs.ros.org/en/foxy/How-To-Guides/DDS-tuning.html).
-## 2. FastDDS configuration
+## 2. Fast DDS Configuration
-Below is an example of a FastDDS configuration file optimized for ROS2 usage with the Orbbec camera. This configuration
+Below is an example of a Fast DDS configuration file optimized for ROS2 usage with the Orbbec camera. This configuration
enhances the overall data transmission by adjusting buffer sizes and transport settings.
-### Configuration file: `shm_fastdds.xml`
+### Configuration File: `shm_fastdds.xml`
Place this file in the `$HOME` directory.
@@ -140,9 +140,9 @@ Place this file in the `$HOME` directory.
```
-### Environment variables
+### Environment Variables
-Set the following environment variables to use the custom FastDDS profile:
+Set the following environment variables to use the custom Fast DDS profile:
```bash
export RMW_IMPLEMENTATION=rmw_fastrtps_cpp
diff --git a/docs/source/image/image1.jpg b/docs/images/image1.jpg
old mode 100755
new mode 100644
similarity index 100%
rename from docs/source/image/image1.jpg
rename to docs/images/image1.jpg
diff --git a/docs/source/image/image2.jpg b/docs/images/image2.jpg
old mode 100755
new mode 100644
similarity index 100%
rename from docs/source/image/image2.jpg
rename to docs/images/image2.jpg
diff --git a/docs/source/image/image3.png b/docs/images/image3.png
old mode 100755
new mode 100644
similarity index 100%
rename from docs/source/image/image3.png
rename to docs/images/image3.png
diff --git a/docs/source/image/image4.jpg b/docs/images/image4.jpg
old mode 100755
new mode 100644
similarity index 100%
rename from docs/source/image/image4.jpg
rename to docs/images/image4.jpg
diff --git a/docs/source/image/image5.jpg b/docs/images/image5.jpg
old mode 100755
new mode 100644
similarity index 100%
rename from docs/source/image/image5.jpg
rename to docs/images/image5.jpg
diff --git a/docs/source/image/image6.jpg b/docs/images/image6.jpg
old mode 100755
new mode 100644
similarity index 100%
rename from docs/source/image/image6.jpg
rename to docs/images/image6.jpg
diff --git a/docs/index.rst b/docs/index.rst
deleted file mode 100755
index f69ec8fa..00000000
--- a/docs/index.rst
+++ /dev/null
@@ -1,35 +0,0 @@
-.. [奥比中光]OrbbecSDK ROS2 应用文档.用户手册
-.. 这一页是目录树
-.. :titlesonly:
-
-
-
-.. image:: source/image/product_h5.png
-
-======================================================
-
-
-OrbbecSDK_ROS2
-======================================================
-
-
-.. toctree::
- :maxdepth: 2
- :caption: Table of Contents
- :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/5_advanced/advanced.rst
- source/6_tools/tool.rst
- source/7_help_center/help_center.rst
- source/8_license/sdk_license.rst
-
-
-
-
-======================================================
-
-.. image:: source/image/product_h1.png
diff --git a/docs/make.bat b/docs/make.bat
deleted file mode 100755
index 2119f510..00000000
--- a/docs/make.bat
+++ /dev/null
@@ -1,35 +0,0 @@
-@ECHO OFF
-
-pushd %~dp0
-
-REM Command file for Sphinx documentation
-
-if "%SPHINXBUILD%" == "" (
- set SPHINXBUILD=sphinx-build
-)
-set SOURCEDIR=.
-set BUILDDIR=_build
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% >NUL 2>NUL
-if errorlevel 9009 (
- echo.
- echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
- echo.installed, then set the SPHINXBUILD environment variable to point
- echo.to the full path of the 'sphinx-build' executable. Alternatively you
- echo.may add the Sphinx directory to PATH.
- echo.
- echo.If you don't have Sphinx installed, grab it from
- echo.http://sphinx-doc.org/
- exit /b 1
-)
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd
diff --git a/docs/multi_camera.MD b/docs/multi_camera.MD
new file mode 100644
index 00000000..15a67f29
--- /dev/null
+++ b/docs/multi_camera.MD
@@ -0,0 +1,108 @@
+## Using Multiple Cameras with the Orbbec ROS 2 Package
+
+This section describes how to configure and use multiple Orbbec cameras simultaneously in a ROS 2 environment.
+
+### Identifying Camera USB Ports
+
+#### Script to List Connected Cameras
+
+To determine which USB ports the cameras are connected to, you can use the following bash script. This script lists all Orbbec devices attached to the system along with their USB port and serial number.
+
+```bash
+#!/bin/bash
+
+VID="2bc5"
+
+for dev in /sys/bus/usb/devices/*; do
+ if [ -e "$dev/idVendor" ]; then
+ vid=$(cat "$dev/idVendor")
+ if [ "$vid" == "${VID}" ]; then
+ port=$(basename $dev)
+ product=$(cat "$dev/product" 2>/dev/null) # product name
+ serial=$(cat "$dev/serial" 2>/dev/null) # serial number
+ echo "Found Orbbec device $product, usb port $port, serial number $serial"
+ fi
+ fi
+done
+```
+
+Save this script to a file and execute it in your terminal to output a list of connected cameras.
+
+### Launching Multiple Cameras
+
+#### Setup for Multiple Camera Launch
+
+You can launch multiple cameras by specifying different USB ports for each camera. Below is an example Python script that uses the ROS 2 launch system to start two cameras with individual configurations.
+
+```python
+from launch import LaunchDescription
+from launch.actions import DeclareLaunchArgument, IncludeLaunchDescription, GroupAction, ExecuteProcess
+from launch.launch_description_sources from ament_index_python.packages import get_package_share_directory
+import os
+
+def generate_launch_description():
+ package_dir = get_package_share_directory('orbbec_camera')
+ launch_file_dir = os.path.join(package_dir, 'launch')
+
+ launch1_include = IncludeLaunchDescription(
+ PythonLaunchDescriptionSource(os.path.join(launch_file_dir, 'gemini_330_series.launch.py')),
+ launch_arguments={'camera_name': 'camera_01', 'usb_port': '2-3.4.4.4.1', 'device_num': '2', 'sync_mode': 'free_run'}.items()
+ )
+
+ launch2_include = IncludeLaunchDescription(
+ PythonLaunchDescriptionSource(os.path.join(launch_file_dir, 'gemini_330_series.launch.py')),
+ launch_arguments={'camera_name': 'camera_02', 'usb_port': '2-3.4.4.4.3', 'device_num': '2', 'sync_mode': 'free_run'}.items()
+ )
+
+ ld = LaunchDescription([
+ GroupAction([launch1_include]),
+ GroupAction([launch2_include])
+ ])
+
+ return ld
+```
+
+#### Running the Launch File
+
+To execute the launch configuration for multiple cameras, use the command:
+
+```bash
+ros2 launch orbbec_camera multi_camera.launch.py
+```
+
+### Configuring the TF Tree for Multiple Cameras
+
+#### Example TF Configuration for Two Cameras
+
+When using multiple cameras, it's essential to calibrate them and publish a static TF tree for each camera. The following Python script configures the TF tree based on your calibration results:
+
+```python
+from launch import LaunchDescription
+from launch_ros.actions import Node
+
+def generate_launch_description():
+ ld = LaunchDescription([
+ Node(
+ package='tf2_ros',
+ executable='static_transform_publisher',
+ name='camera_01_tf',
+ arguments=['0', '0', '0', '0', '0', '0', 'base_link', 'camera_01_link'],
+ output='screen'
+ ),
+ Node(
+ package='tf2_ros',
+ executable='static_transform_publisher',
+ name='camera_02_tf',
+ arguments=['0', '0', '0', '0', '0', '0', 'base_link', 'camera_02_link'],
+ output='screen'
+ )
+ ])
+
+ return ld
+```
+
+Save this configuration as `multi_camera_tf.launch.py` in the launch directory of the Orbbec camera package. To run it, use:
+
+```bash
+ros2 launch orbbec_camera multi_camera_tf.launch.py
+```
diff --git a/docs/multi_camera_CN.MD b/docs/multi_camera_CN.MD
new file mode 100644
index 00000000..7ca6b054
--- /dev/null
+++ b/docs/multi_camera_CN.MD
@@ -0,0 +1,109 @@
+## 使用Orbbec ROS 2包配置多个摄像头
+
+本节介绍如何在ROS 2环境中同时配置和使用多个Orbbec摄像头。
+
+### 识别摄像头USB端口
+
+#### 列出连接的摄像头的脚本
+
+要确定摄像头连接到哪些USB端口，您可以使用以下bash脚本。该脚本列出了连接到系统的所有Orbbec设备及其USB端口和序列号。
+
+```bash
+#!/bin/bash
+
+VID="2bc5"
+
+for dev in /sys/bus/usb/devices/*; do
+ if [ -e "$dev/idVendor" ]; then
+ vid=$(cat "$dev/idVendor")
+ if [ "$vid" == "${VID}" ]; then
+ port=$(basename $dev)
+ product=$(cat "$dev/product" 2>/dev/null) # 产品名称
+ serial=$(cat "$dev/serial" 2>/dev/null) # 序列号
+ echo "发现Orbbec设备 $product，usb端口 $port，序列号 $serial"
+ fi
+ fi
+done
+```
+
+将此脚本保存为一个文件，并在您的终端中执行，以输出连接的摄像头列表。
+
+### 启动多个摄像头
+
+#### 多摄像头启动配置
+
+您可以通过为每个摄像头指定不同的USB端口来启动多个摄像头。下面是一个使用ROS 2启动系统启动两个摄像头的Python脚本示例。
+
+```python
+from launch import LaunchDescription
+from launch.actions import DeclareLaunchArgument, IncludeLaunchDescription, GroupAction, ExecuteProcess
+from launch.launch_description_sources import PythonLaunchDescriptionSource
+from ament_index_python.packages import get_package_share_directory
+import os
+
+def generate_launch_description():
+ package_dir = get_package_share_directory('orbbec_camera')
+ launch_file_dir = os.path.join(package_dir, 'launch')
+
+ launch1_include = IncludeLaunchDescription(
+ PythonLaunchDescriptionSource(os.path.join(launch_file_dir, 'gemini_330_series.launch.py')),
+ launch_arguments={'camera_name': 'camera_01', 'usb_port': '2-3.4.4.4.1', 'device_num': '2', 'sync_mode': 'free_run'}.items()
+ )
+
+ launch2_include = IncludeLaunchDescription(
+ PythonLaunchDescriptionSource(os.path.join(launch_file_dir, 'gemini_330_series.launch.py')),
+ launch_arguments={'camera_name': 'camera_02', 'usb_port': '2-3.4.4.4.3', 'device_num': '2', 'sync_mode': 'free_run'}.items()
+ )
+
+ ld = LaunchDescription([
+ GroupAction([launch1_include]),
+ GroupAction([launch2_include])
+ ])
+
+ return ld
+```
+
+#### 运行启动文件
+
+要执行多摄像头的启动配置，请使用命令：
+
+```bash
+ros2 launch orbbec_camera multi_camera.launch.py
+```
+
+### 配置多摄像头的TF树
+
+#### 两个摄像头的TF配置示例
+
+使用多个摄像头时，校准它们并为每个摄像头发布静态TF树是必不可少的。以下Python脚本基于您的校准结果配置TF树：
+
+```python
+from launch import LaunchDescription
+from launch_ros.actions import Node
+
+def generate_launch_description():
+ ld = LaunchDescription([
+ Node(
+ package='tf2_ros',
+ executable='static_transform_publisher',
+ name='camera_01_tf',
+ arguments=['0', '0', '0', '0', '0', '0', 'base_link', 'camera_01_link'],
+ output='screen'
+ ),
+ Node(
+ package='tf2_ros',
+ executable='static_transform_publisher',
+ name='camera_02_tf',
+ arguments=['0', '0', '0', '0', '0', '0', 'base_link', 'camera_02_link'],
+ output='screen'
+ )
+ ])
+
+ return ld
+```
+
+将此配置保存为 `multi_camera_tf.launch.py` 在Orbbec摄像头包的启动目录中。运行它，请使用：
+
+```bash
+ros2 launch orbbec_camera multi_camera_tf.launch.py
+```
\ No newline at end of file
diff --git a/docs/openHtml.bat b/docs/openHtml.bat
deleted file mode 100755
index db0fa7d0..00000000
--- a/docs/openHtml.bat
+++ /dev/null
@@ -1,13 +0,0 @@
-@echo off
-
-echo *****************************************
-echo *** jacky.li tools ***
-echo *****************************************
-set CURRENT_TIME=%time:~0,2%:%time:~3,2%:%time:~6,2%
-Echo %CURRENT_TIME%
-
-
-echo current patch %~dp0%
-start chrome.exe "file://%~dp0%_html\index.html"
-
-echo start chrome.exe "file://%~dp0%_html\index.html"
\ No newline at end of file
diff --git a/docs/point_cloud.MD b/docs/point_cloud.MD
new file mode 100644
index 00000000..692e9991
--- /dev/null
+++ b/docs/point_cloud.MD
@@ -0,0 +1,53 @@
+## Enabling and Visualizing Point Cloud in ROS 2
+
+This section demonstrates how to enable point cloud data output from the camera node and visualize it using RViz2, similarly to the initial camera node setup discussed in the [Starting Camera Node](./start_camera_node.MD) document.
+
+### Enabling Depth Point Cloud
+
+#### Command to Enable Depth Point Cloud
+
+To activate the point cloud data stream for depth information, use the following command:
+
+```bash
+ros2 launch orbbec_camera gemini_330_series.launch.py enable_point_cloud:=true
+```
+
+#### Visualizing Depth Point Cloud in RViz2
+
+After running the above command, perform the following steps to visualize the depth point cloud:
+
+1. Open RViz2.
+2. Add a `PointCloud2` display.
+3. Select the `/camera/depth/points` topic for visualization.
+4. Set the fixed frame to `camera_link` to properly align the data.
+
+##### Example Visualization
+
+Here is what the depth point cloud might look like in RViz2:
+
+
+
+### Enabling Colored Point Cloud
+
+#### Command to Enable Colored Point Cloud
+
+To enable the colored point cloud feature, enter the following command:
+
+```bash
+ros2 launch orbbec_camera gemini_330_series.launch.py enable_colored_point_cloud:=true
+```
+
+#### Visualizing Colored Point Cloud in RViz2
+
+To visualize the colored point cloud data:
+
+1. Launch RViz2 following the command execution.
+2. Add a `PointCloud2` display panel.
+3. Choose the `/camera/depth_registered/points` topic from the list.
+4. Ensure the fixed frame is set to `camera_link`.
+
+##### Example Visualization
+
+The result of the colored point cloud in RViz2 should look similar to this:
+
+
diff --git a/docs/point_cloud_CN.MD b/docs/point_cloud_CN.MD
new file mode 100644
index 00000000..8ebb419b
--- /dev/null
+++ b/docs/point_cloud_CN.MD
@@ -0,0 +1,53 @@
+## 在ROS 2中启用和可视化点云
+
+本节演示如何从相机节点启用点云数据输出，并使用RViz2进行可视化，类似于之前讨论的[启动相机节点](./start_camera_node.MD)文档中的初始相机节点设置。
+
+### 启用深度点云
+
+#### 启用深度点云的命令
+
+要激活深度信息的点云数据流，请使用以下命令：
+
+```bash
+ros2 launch orbbec_camera gemini_330_series.launch.py enable_point_cloud:=true
+```
+
+#### 在RViz2中可视化深度点云
+
+运行上述命令后，执行以下步骤来可视化深度点云：
+
+1. 打开RViz2。
+2. 添加一个`PointCloud2`显示。
+3. 选择`/camera/depth/points`主题进行可视化。
+4. 将固定帧设置为`camera_link`以正确对齐数据。
+
+##### 示例可视化
+
+以下是在RViz2中可能看到的深度点云的样子：
+
+
+
+### 启用彩色点云
+
+#### 启用彩色点云的命令
+
+要启用彩色点云功能，请输入以下命令：
+
+```bash
+ros2 launch orbbec_camera gemini_330_series.launch.py enable_colored_point_cloud:=true
+```
+
+#### 在RViz2中可视化彩色点云
+
+要可视化彩色点云数据：
+
+1. 在执行命令后启动RViz2。
+2. 添加一个`PointCloud2`显示面板。
+3. 从列表中选择`/camera/depth_registered/points`主题。
+4. 确保固定帧设置为`camera_link`。
+
+##### 示例可视化
+
+在RViz2中彩色点云的结果应类似于这样：
+
+
\ No newline at end of file
diff --git a/docs/requirements.txt b/docs/requirements.txt
deleted file mode 100755
index ea30deb3..00000000
--- a/docs/requirements.txt
+++ /dev/null
@@ -1,20 +0,0 @@
-# markdown suport
-recommonmark
-# markdown table suport
-sphinx-markdown-tables
-
-# theme default rtd
-
-# crate-docs-theme
-sphinx-rtd-theme
-
-doc8
-docutils
-pip
-sphinx
-sphinx-copybutton
-sphinx-lint
-sphinx-multiversion
-sphinx-rtd-theme
-sphinx-tabs
-sphinxcontrib-mermaid
\ No newline at end of file
diff --git a/docs/source/1_overview/overview.rst b/docs/source/1_overview/overview.rst
deleted file mode 100755
index 599224b4..00000000
--- a/docs/source/1_overview/overview.rst
+++ /dev/null
@@ -1,51 +0,0 @@
-.. 这一页是模块目录树
-
-
-.. 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 `_
-
-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 `_
-
-
-
-======================================================
-
-.. toctree::
- :maxdepth: 2
- :caption: This Section Covers:
-
- supported_cameras.md
- supported_platforms.md
-
-
-
-
-======================================================
-
-.. image:: ../image/product_h1.png
\ No newline at end of file
diff --git a/docs/source/1_overview/supported_cameras.md b/docs/source/1_overview/supported_cameras.md
deleted file mode 100755
index 91ebdd94..00000000
--- a/docs/source/1_overview/supported_cameras.md
+++ /dev/null
@@ -1,48 +0,0 @@
-# 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.
-
-
-
-- For more product information, please refer to the official website link:[https://www.orbbec.com/products](https://www.orbbec.com/products/)
-
-
diff --git a/docs/source/1_overview/supported_platforms.md b/docs/source/1_overview/supported_platforms.md
deleted file mode 100755
index 4f3531af..00000000
--- a/docs/source/1_overview/supported_platforms.md
+++ /dev/null
@@ -1,26 +0,0 @@
-# Supported platforms
-
-
-
-- 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 |
-
-
-
-
-
-
diff --git a/docs/source/1_overview/typical_applications.md b/docs/source/1_overview/typical_applications.md
deleted file mode 100755
index a2a622d5..00000000
--- a/docs/source/1_overview/typical_applications.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-
-
-
-# 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 ](https://www.orbbec.com/opdk/)
-
-
diff --git a/docs/source/2_installation/build_the_package.md b/docs/source/2_installation/build_the_package.md
deleted file mode 100755
index 01439a39..00000000
--- a/docs/source/2_installation/build_the_package.md
+++ /dev/null
@@ -1,156 +0,0 @@
-
-
-# Build the package
-
-This section provides a comprehensive guide to installing, compiling, and running the OrbbecSDK_ROS2, covering all necessary steps for setup.
-
-- Table of contents
- - [Get source code of OrbbecSDK_ROS2](#get-source-code-of-orbbecsdk-ros2)
- - [Install environment](#install-environment)
- - [Build project](#build-project)
- - [Performance Optimization Suggestions](#performance-ptimization-suggestions)
-
-## Get source code of OrbbecSDK_ROS2
-
-**Get source code from github:** [https://github.com/orbbec/OrbbecSDK_ROS2](https://github.com/orbbec/OrbbecSDK_ROS2)
-
-```bash
-mkdir -p ~/ros2_ws/src # Create colcon workspace on your local disk
-cd ~/ros2_ws/src
-git clone -b v2-main https://github.com/orbbec/OrbbecSDK_ROS2.git #Get source code
-```
-
-
-## Install environment
-
-**Install ROS 2 environment**, refer to the official documentation: [ROS2 installation guide: https://docs.ros.org/en/humble/Installation/Ubuntu-Install-Debians.html](https://docs.ros.org/en/humble/Installation/Ubuntu-Install-Debians.html)
-
-```bash
-# Tips: If your ROS2 command does not auto-complete, put the following two lines into your `.bashrc` or `.zshrc`
-
-eval "$(register-python-argcomplete3 ros2)"
-eval "$(register-python-argcomplete3 colcon)"
-```
-
-**Install deb dependencies:**
-
-```bash
-# assume you have sourced ROS environment, same blow
-sudo apt install libgflags-dev nlohmann-json3-dev \
-ros-$ROS_DISTRO-image-transport ros-$ROS_DISTRO-image-publisher ros-$ROS_DISTRO-camera-info-manager \
-ros-$ROS_DISTRO-diagnostic-updater ros-$ROS_DISTRO-diagnostic-msgs ros-$ROS_DISTRO-statistics-msgs \
-ros-$ROS_DISTRO-backward-ros libdw-dev ros-$ROS_DISTRO-image-transport \
-ros-$ROS_DISTRO-image-transport-plugins ros-$ROS_DISTRO-compressed-image-transport \
-ros-$ROS_DISTRO-rqt-tf-tree -y
-```
-
-**Install udev rules:**
-
-```bash
-tar -zxvf OrbbecSDK_ROS2_xxx.tar.gz -C ~/ros2_ws/src
-cd ~/ros2_ws/src/OrbbecSDK_ROS2/orbbec_camera/scripts
-sudo bash install_udev_rules.sh
-sudo udevadm control --reload-rules && sudo udevadm trigger
-```
-
-## Build project
-
-```bash
-cd ~/ros2_ws/
-colcon build --event-handlers console_direct+ --cmake-args -DCMAKE_BUILD_TYPE=Release
-```
-
-Verify the build results.
-[start single camera](../3_start_single_camera/start_single_camera.md)
-
-## Performance Optimization Suggestions
-
-### Optimization of usbfs_memory Parameters in USB Camera
-
-**Increase usbfs_memory_mb Value**
-
-- Increase the `usbfs_memory_mb` value to 128MB (this is a reference value and can be adjusted based on your system’s needs)
- by running the following command:
-
-```bash
-echo 128 | sudo tee /sys/module/usbcore/parameters/usbfs_memory_mb
-```
-
-- To make this change permanent, check [this link](https://github.com/OpenKinect/libfreenect2/issues/807).
- There are two ways to persist the configuration: by modifying GRUB or by adding a systemd service.
-
-**by modifying GRUB**
-
-Open /etc/default/grub file,Find and replace
-
-```bash
-GRUB_CMDLINE_LINUX_DEFAULT="quiet splash"
-```
-
- with this
-
-```bash
-GRUB_CMDLINE_LINUX_DEFAULT="quiet splash usbcore.usbfs_memory_mb=128"
-```
-
- Update grub
-
-```bash
-$ sudo update-grub
-```
-
- Reboot and check
-
-```bash
-$ cat /sys/module/usbcore/parameters/usbfs_memory_mb
-```
-
-**by adding a systemd service**
-
- Create the `/etc/systemd/system/usbfs-memory.service` file
-
-```bash
-sudo vi /etc/systemd/system/usbfs-memory.service
-```
-
- Paste the following content into the file:
-
-```bash
-[Unit]
-Description=Set USBFS memory limit
-After=multi-user.target
-
-[Service]
-ExecStart=/bin/bash -c 'echo 128 | tee /sys/module/usbcore/parameters/usbfs_memory_mb'
-ExecStartPost=/bin/bash -c 'echo "USBFS memory limit set to 128 MB"'
-
-[Install]
-WantedBy=multi-user.target
-```
-
- Reload the systemd configuration to apply the new service
-
-```bash
-sudo systemctl daemon-reload
-sudo systemctl enable usbfs-memory.service
-sudo systemctl start usbfs-memory.service
-```
-
- Verify the service status
-
-```bash
-sudo systemctl status usbfs-memory.service
-cat /sys/module/usbcore/parameters/usbfs_memory_mb
-```
-
-### Optimizing ROS DDS Configuration
-
-**CycloneDDS Tuning**
-
-If you use CycloneDDS, please refer to the [CycloneDDS Tuning](../6_advanced/cyclonedds_tuning.md) file.
-
-The default DDS settings may not be optimal for data transmission. Different DDS settings can have varying performance. For more detailed information, please refer to the [CycloneDDS official website](https://docs.ros.org/en/humble/How-To-Guides/DDS-tuning.html).
-
-**FastDDS Tuning**
-
-If you use FastDDS, please refer to the [FastDDS Tuning](../6_advanced/fastdds_tuning.md) file.
diff --git a/docs/source/2_installation/installation.rst b/docs/source/2_installation/installation.rst
deleted file mode 100755
index bae1c230..00000000
--- a/docs/source/2_installation/installation.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 这一页是模块目录树
-
-.. image:: ../image/product_h5.png
-
-======================================================
-
-
-Installation
-======================================================
-
-
-This section provides instructions for setting up OrbbecSDK_ROS2, including environment preparation, compilation, installation, and detailed configuration options for customized deployments.
-
-======================================================
-
-
-
-.. toctree::
- :maxdepth: 2
- :caption: This Section Covers:
-
- build_the_package.md
- package_description.md
-
-
-
-
-======================================================
-
-.. image:: ../image/product_h1.png
\ No newline at end of file
diff --git a/docs/source/2_installation/package_description.md b/docs/source/2_installation/package_description.md
deleted file mode 100755
index aa05aada..00000000
--- a/docs/source/2_installation/package_description.md
+++ /dev/null
@@ -1,354 +0,0 @@
-
-
-# Package description
-
-This section provides a detailed overview of the topics, services, launch scripts, and YAML configuration parameters encompassed within the OrbbecSDK_ROS2 package.
-
-- Table of contents
- - [All available topics](#all-available-topics)
- - [All available services](#all-available-services)
- - [All available launch files](#all-available-launch-files)
- - [All available yaml files](#all-available-yaml-files)
- - [Coordinate systems](#coordinate-systems)
- - [Useful configurations](#useful-configurations)
-
-## All available topics
-
-When orbbec camera starts, it will, by default, publish the following topics:
-
-| No. | Published topics | Type | description |
-| --- | :-------------------------------------- | :-------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------- |
-| 1 | /camera/color/image_raw | [sensor_msgs/msg/Image] | The color stream image |
-| 2 | /camera/color/image_raw/compressed | [sensor_msgs/msg/CompressedImage] | The color stream image compressed |
-| 3 | /camera/color/image_raw/compressedDepth | [sensor_msgs/msg/CompressedImage] | |
-| 4 | /camera/color/image_raw/theora | [theora_image_transport/msg/Packet] | The color image metadata |
-| 5 | /camera/color/metadata | [orbbec_camera_msgs/msg/Metadata] | |
-| 6 | /camera/depth/camera_info | [sensor_msgs/msg/CameraInfo] | The depth camera information |
-| 7 | /camera/depth/image_raw | [sensor_msgs/msg/Image] | The depth stream image |
-| 8 | /camera/depth/image_raw/compressed | [sensor_msgs/msg/CompressedImage] | The depth stream image compressed |
-| 9 | /camera/depth/image_raw/compressedDepth | [sensor_msgs/msg/CompressedImage] | |
-| 10 | /camera/depth/image_raw/theora | [theora_image_transport/msg/Packet] | |
-| 11 | /camera/depth/metadata | [orbbec_camera_msgs/msg/Metadata] | The depth image metadata |
-| 12 | /camera/left_ir/camera_info | [sensor_msgs/msg/CameraInfo] | The left_ir camera information |
-| 13 | /camera/left_ir/image_raw | [sensor_msgs/msg/Image] | The left ir stream image |
-| 14 | /camera/left_ir/metadata | [orbbec_camera_msgs/msg/Metadata] | |
-| 15 | /camera/right_ir/camera_info | [sensor_msgs/msg/CameraInfo] | The right_ir camera information |
-| 16 | /camera/right_ir/image_raw | [sensor_msgs/msg/Image] | The right ir stream image |
-| 17 | /camera/right_ir/metadata | [orbbec_camera_msgs/msg/Metadata] | |
-| 18 | /camera/ir/camera_info | [sensor_msgs/msg/CameraInfo] | The ir camera information |
-| 19 | /camera/ir/image_raw | [sensor_msgs/msg/Image] | The ir stream image |
-| 20 | /camera/depth/points | [sensor_msgs/msg/PointCloud2] | The point cloud, only available when `enable_point_cloud` is `true` |
-| 21 | /camera/depth_filter_status | [std_msgs/msg/String] | The depth filter status |
-| 22 | /camera/depth_registered/points | [sensor_msgs/msg/PointCloud2] | The colored point cloud, only available when `enable_colored_point_cloud` is `true`. |
-| 23 | /camera/depth_to_color | [orbbec_camera_msgs/msg/Extrinsics] | |
-| 24 | /camera/depth_to_left_ir | [orbbec_camera_msgs/msg/Extrinsics] | |
-| 25 | /camera/depth_to_right_ir | [orbbec_camera_msgs/msg/Extrinsics] | |
-| 26 | /camera/depth_to_accel | [orbbec_camera_msgs/msg/Extrinsics] | |
-| 27 | /camera/depth_to_gyro | [orbbec_camera_msgs/msg/Extrinsics] | |
-| 28 | /camera/gyro/imu_info | [orbbec_camera_msgs/msg/IMUInfo] | The imu information |
-| 29 | /camera/gyro_accel/sample | [sensor_msgs/msg/Imu] | Synchronized data stream of acceleration and gyroscope，`enable_sync_output_accel_gyro` `turned on` |
-| 30 | /clicked_point | [geometry_msgs/msg/PointStamped] | |
-| 31 | /diagnostics | [diagnostic_msgs/msg/DiagnosticArray] | The diagnostic information of the camera, Currently, the diagnostic information only includes the temperature of the camera. |
-| 32 | /goal_pose | [geometry_msgs/msg/PoseStamped] | |
-| 33 | /initialpose | [geometry_msgs/msg/PoseWithCovarianceStamped] | |
-| 34 | /parameter_events | [rcl_interfaces/msg/ParameterEvent] | |
-| 35 | /rosout | [rcl_interfaces/msg/Log] 8 | |
-| 36 | /tf | [tf2_msgs/msg/TFMessage] | |
-| 37 | /tf_static | [tf2_msgs/msg/TFMessage] | |
-
-## All available services
-
-The name of the following services already expresses its function.
-However, it should be noted that the corresponding `set_[ir|depth|color]*`
-and `get[ir|depth|color]*` **services are only available if you set** `enable[ir|depth|color]` to `true` in the stream that corresponds to the argument of the launch file.
-
-Servies can be called like this:
-
-```bash
-# Get device info
-ros2 service call /camera/get_device_info orbbec_camera_msgs/srv/GetDeviceInfo '{}'
-# Get SDK version
-ros2 service call /camera/get_sdk_version orbbec_camera_msgs/srv/GetString '{}'
-# Set auto exposure
-ros2 service call /camera/set_color_auto_exposure std_srvs/srv/SetBool '{data: false}'
-# Save point cloud
-ros2 service call /camera/save_point_cloud std_srvs/srv/Empty "{}"
-```
-
-| No. | Service | type | description |
-| --- | :------------------------------- | :------------------------------------- | :-------------------------- |
-| 1 | /camera/get_auto_white_balance | [orbbec_camera_msgs/srv/GetInt32] | Get auto white balance |
-| 2 | /camera/get_color_exposure | [orbbec_camera_msgs/srv/GetInt32] | Get color exposure |
-| 3 | /camera/get_color_gain | [orbbec_camera_msgs/srv/GetInt32] | Get color gain |
-| 4 | /camera/get_depth_exposure | [orbbec_camera_msgs/srv/GetInt32] | Get depth exposure |
-| 5 | /camera/get_depth_gain | [orbbec_camera_msgs/srv/GetInt32] | Get depth information |
-| 6 | /camera/get_device_info | [orbbec_camera_msgs/srv/GetDeviceInfo] | Get device information |
-| 7 | /camera/get_ldp_measure_distance | [orbbec_camera_msgs/srv/GetInt32] | Get ldp distance |
-| 8 | /camera/get_ldp_status | [orbbec_camera_msgs/srv/GetBool] | Get ldp status |
-| 9 | /camera/get_sdk_version | [orbbec_camera_msgs/srv/GetString] | Get sdk version |
-| 10 | /camera/get_white_balance | [orbbec_camera_msgs/srv/GetInt32] | Get white balance |
-| 11 | /camera/reboot_device | [std_srvs/srv/Empty] | Reboot device |
-| 12 | /camera/save_images | [std_srvs/srv/Empty] | Save images |
-| 13 | /camera/save_point_cloud | [std_srvs/srv/Empty] | Save point cloud |
-| 14 | /camera/set_auto_white_balance | [std_srvs/srv/SetBool] | Set auto white balance |
-| 15 | /camera/set_color_auto_exposure | [std_srvs/srv/SetBool] | Set color auto exposure |
-| 16 | /camera/set_color_exposure | [orbbec_camera_msgs/srv/SetInt32] | Set color exposure |
-| 17 | /camera/set_color_gain | [orbbec_camera_msgs/srv/SetInt32] | Set color gain |
-| 18 | /camera/set_color_mirror | [std_srvs/srv/SetBool] | Set color mirror |
-| 19 | /camera/set_depth_auto_exposure | [std_srvs/srv/SetBool] | Set depth auto exposure |
-| 20 | /camera/set_depth_exposure | [orbbec_camera_msgs/srv/SetInt32] | Set depth exposure |
-| 21 | /camera/set_depth_gain | [orbbec_camera_msgs/srv/SetInt32] | Set depth gain |
-| 22 | /camera/set_depth_mirror | [std_srvs/srv/SetBool] | Set depth mirror |
-| 23 | /camera/set_fan_work_mode | [orbbec_camera_msgs/srv/SetInt32] | Set fan work mode |
-| 24 | /camera/set_floor_enable | [std_srvs/srv/SetBool] | Set floor enable |
-| 25 | /camera/set_ir_long_exposure | [std_srvs/srv/SetBool] | Set ir long exposure |
-| 26 | /camera/set_laser_enable | [std_srvs/srv/SetBool] | Set laser enable |
-| 27 | /camera/set_ldp_enable | [std_srvs/srv/SetBool] | Set ldp enable |
-| 28 | /camera/set_white_balance | [orbbec_camera_msgs/srv/SetInt32] | Set white balance |
-| 29 | /camera/switch_ir | [orbbec_camera_msgs/srv/SetString] | switch left ir and right ir |
-| 30 | /camera/toggle_color | [std_srvs/srv/SetBool] | Toggle color |
-| 31 | /camera/toggle_depth | [std_srvs/srv/SetBool] | Toggle depth |
-
-## All available launch files
-
-| launch file list | description |
-| ---------------------------- | ------------------------------------------------- |
-| orbbec_camera.launch.py | Generic ros launch script for a 3D camera product |
-| orbbec_multicamera.launch.py | Multicamera devices startup example script |
-
-**Run Command:**
-
-**1. Launch Script for Specifying Device Type:**
-The `orbbec_camera.launch.py` supports two optional input parameters: camera_model and config_file_path.
-
-```bash
-ros2 launch orbbec_camera orbbec_camera.launch.py camera_model:=gemini330_series
-```
-
-or
-
-```bash
-# default startup script
-ros2 launch orbbec_camera orbbec_camera.launch.py config_file_path:=gemini330_series.yaml
-```
-
-**Note:**
-**camera_model:**
-
-* The value of the camera_model parameter is the product type corresponding to the camera product being used.
-
-**config_file_path:**
-
-* The YAML configuration file located in the `config/` directory is used. By default, `gemini330_series.yaml` is selected.
-* The value of the config_file_path parameter is the path to the yaml configuration file corresponding to the camera product being used.
-* Supports the transmission of both absolute paths and relative paths to the config, or YAML files under the config can be specified without a path.
-* Supports use intra-process communication. config param use_intra_process_comms: true
-
-**2.multicamera launch:**
-The multicamera startup
-
-```bash
-ros2 launch orbbec_camera orbbec_multicamera.launch.py
-```
-
-or
-
-```bash
-ros2 launch orbbec_camera orbbec_multicamera.launch.py config_file_path:=multicamera.yaml
-```
-
-**Note:**
-
-1. Multiple devices default config reference config/multicamera.yaml
-2. Multiple cameras synced config reference config/multicamera_synced.yaml
-
-## All available yaml files
-
-| product serials | yaml file | description |
-| :--------------- | :-------------------- | :------------------------------------- |
-| astra2 | astra2.yaml | astra2 camera default params |
-| femto | femto.yaml | femto camera default params |
-| femtomega | femtomega.yaml | femtomega camera default params |
-| femtobolt | femtobolt.yaml | femtobolt camera default params |
-| gemini2 | gemini2.yaml | gemini2 camera default params |
-| gemini2L | gemini2L.yaml | gemini2L camera default params |
-| gemini330 series | gemini330_series.yaml | gemini330_series camera default params |
-
-*All yaml files are fundamentally similar, with the primary differences being the default parameter values set for various models within the same series.
-Differences in USB standards, such as USB 2.0 versus USB 3.0, may require parameter adjustments. In case of startup issues, please refer to the specification manual carefully. Pay particular attention to resolution settings and other parameters in the YAML file to ensure compatibility and optimal performance.*
-
-Relationship Between Product yaml Configuration File and common.yaml Configuration File, and a Rough Flowchart of Their Invocation Process
-
-
-
-**yaml Configuration Instructions：**
-
-1.common.yaml
-
-Contains all basic default parameters and common default values.
-
-2.product xxx.yaml
-
-The yaml corresponding to a specific product, such as gemini2.yaml, will configure its product-specific difference parameters and default values based on common.yaml.
-
-3.yaml Loading order description：
-
-Orbbec_camera.launch.py When started, it will load first.commcon.yaml. Reload the corresponding product yaml. For example gemini2.yaml The same parameter value will overwrite the corresponding default parameter value in common.yaml.
-
-**Launch Startup Instructions：**
-
-1.orbbec_camera.launch.py Command line parameters have the highest priority. That is, parameters carried in the command line will override the default values of the same parameters in the yaml file.
-
-2.orbbec_multicamera.launch.py The command line configuration corresponds to multicamera.yaml or multicamera_synced.yaml. For multi-machine yaml configuration, you can refer to the modification guide to modify the multi-machine configuration.
-
-## Coordinate systems
-
-### ROS2(Robot) vs Optical(Camera) coordination systems
-
-* Point Of View:
- * Imagine we are standing behind of the camera, and looking forward.
- * Always use this point of view when talking about coordinates, left vs right IRs, position of sensor, etc..
-
-
-
-* ROS2 Coordinate System: (X: Forward, Y:Left, Z: Up)
-* Camera Optical Coordinate System: (X: Right, Y: Down, Z: Forward)
-* All data published in our wrapper topics is optical data taken directly from our camera sensors.
-* static and dynamic TF topics publish optical CS and ROS CS to give the user the ability to move from one CS to other CS.
-
-### Camera sensor structure
-
-
-
-
-
-### TF from coordinate A to coordinate B:
-
-In Orbbec cameras, the origin point (0,0,0) is taken from the camera_link position
-
-Our wrapper provide static TFs between each sensor coordinate to the camera base (camera_link)
-
-Also, it provides TFs from each sensor ROS coordinates to its corrosponding optical coordinates.
-
-Example of static TFs of RGB sensor and right infra sensor of Gemini335 module as it shown in rviz2:
-
-```bash
-ros2 launch orbbec_description view_model.launch.py model:=gemini_335_336.urdf.xacro
-```
-
-
-
-## Useful configurations
-
-### Use V4L2 backend
-
-To enable the V4L2 backend for the Gemini2 series cameras, follow these steps:
-
-1. The Gemini2 series cameras support the V4L2 backend.
-2. Open the `config/OrbbecSDKConfig_v2.0.xml` file.
-3. Set the navigation option to `LinuxUVCBackend`.
-4. Change the backend setting to `V4L2`.
-
-Note: The V4L2 backend is not enabled by default.
-
-Config V4L2 in `config/OrbbecSDKConfig_v2.0.xml` file.
-
-```
-
-
-
-
- false
-
-
- Auto
-
-
-
- V4L2
-
-```
-
-### Predefined presets
-
-| Preset | Features | Recommended use cases |
-| :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Default | - Best visual perception - Overall good performance in accuracy, fill rate, tiny objects, etc. | - Generic - Robotics |
-| Hand | - Clear hand and finger edges | - Gesture recognition |
-| High Accuracy | - Depth of high confidence - Barely noise depth values - Lower fill rate | - Collision avoidance - Object scanning |
-| High Density | - Higher fill rate - More tiny objects - May suffer from noise depth values | - Object recognition - Pick & place - Foreground & background animation |
-| Medium Density | - Balanced performance in fill rate and accuracy - In comparison to Default: lower fill rate, better edge quality | - Generic and alternative to Default |
-| Custom | - User defined Preset - Derived from Presets above, with customized modifications, e.g. a new configuration for the post-processing pipeline, modified mean intensity set point of depth AE function, etc. | - Better depth performance achieved using customized configurations in comparison to using predefined presets - For well-established custom configurations |
-
-Choose the appropriate preset name based on your specific use case and set it as the value for the `device_preset`
-parameter.
-
-### Depth work mode switch
-
-OrbbecSDK_ROS2 supports the depth work mode switch. The depth work mode switch is supported by Gemini 2, Gemini 2 L,
-and Femto and Femto Bolt cameras.
-
-- Before starting the camera, depth work mode (depth_work_mode) can be configured for the corresponding xxx.launch.py
- file's support.
-- The depth work mode switch is supported by Gemini 2, Gemini 2 L, and Gemini 2 XL cameras.
-- The default depth work mode configuration of xxx.launch.py is the camera's default configuration. If you need to
- modify it, you can switch to the corresponding mode as needed.
-- The specific camera depth work mode support types can be found in the comments of the depth mode.
-
-```python
-# Depth work mode support is as follows:
-# Unbinned Dense Default
-# Unbinned Sparse Default
-# Binned Sparse Default
-# Obstacle Avoidance
-DeclareLaunchArgument('depth_work_mode', default_value='')
-```
-
-- View depth work modes:
-
-```bash
-ros2 run orbbec_camera list_depth_work_mode_node
-```
-
-### Configuration of depth NFOV and WFOV modes
-
-For the Femto Mega and Femto Bolt devices, the NFOV and WFOV modes are implemented by configuring the resolution of
-Depth and IR in the launch file.
-In launch file, depth_width、depth_height、ir_width、ir_height represents the resolution of the depth and the resolution of
-the IR.
-The frame fps and resolution of IR must be consistent with the depth. The correspondence between different modes and
-resolutions is as follows:
-
-- NFOV unbinned: 640 x 576.
-- NFOV binned: 320 x 288.
-- WFOV unbinned: 1024 x 1024.
-- WFOV binned: 512 x 512.
-
-### Network device enumeration
-
-Currently, the network device enumeration function is supported only by the Femto Mega device. When accessing this
-device over the network, if `enumerate_net_device` is set to `true`, the device will be automatically enumerated,
-eliminating the need to configure the IP address in advance or set the enable switch to true. The specific configuration
-methods are as follows:
-
-- `enumerate_net_device`: enumeration network device automatically, only supported by Femto Mega.
- if `enumerate_net_device` set to `true`, the device will be enumerated automatically,No need to set
- the `net_device_ip`
- and `net_device_port` parameters.
-- `net_device_ip`: The IP address of the device.
-- `net_device_port`: The port number of the device.
-
-### Compressed Image
-
-You can use image_transport to compress the image using jpeg. Below is an example of how to use it:
-To access the compressed color image, you can use the following command:
-
-```bash
-ros2 topic echo /camera/color/image_raw/compressed --no-arr
-```
-
-This command will allow you to receive the compressed color image from the specified topic.
-
-**Note:** The compressed topic for depth is /camera/depth/image_raw/compressedDepth. The compressed topics for color and IR are /camera/color/image_raw/compressed and /camera/ir/image_raw/compressed, respectively.
diff --git a/docs/source/3_start_single_camera/single_camera.rst b/docs/source/3_start_single_camera/single_camera.rst
deleted file mode 100755
index 3e36451c..00000000
--- a/docs/source/3_start_single_camera/single_camera.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-.. 这一页是模块目录树
-
-.. .. image:: ../image/product_h7.png
-
-.. image:: ../image/product_h5.png
-
-======================================================
-
-Single camera
-======================================================
-
-This guide provides instructions on how to launch the camera node with a colored point cloud feature enabled using ROS 2.
-
-
-
-
-======================================================
-
-.. toctree::
- :maxdepth: 2
- :caption: This Section Covers:
-
-
- start_single_camera.md
-
-
-
-
-======================================================
-
-.. image:: ../image/product_h1.png
diff --git a/docs/source/3_start_single_camera/start_single_camera.md b/docs/source/3_start_single_camera/start_single_camera.md
deleted file mode 100755
index e961b3d8..00000000
--- a/docs/source/3_start_single_camera/start_single_camera.md
+++ /dev/null
@@ -1,267 +0,0 @@
-# Single camera
-
-This guide provides instructions on how to launch the camera node with a colored point cloud feature enabled using ROS 2.
-
-- Table of contents
- - [Start single camera](#start-single-camera)
- - [Visualizing data in rviz2](#visualizing-data-in-rviz2)
- - [Display view topics service](#display-view-topics-service)
- - [Example visualizations](#example-visualizations)
- - [TF tree diagram](#tf-tree-diagram)
-
-## Start single camera
-
-For how to compile and build methods, please refer to Chapter `Installation/Build_the_package `documentation and follow the steps provided
-[build_the_package](../2_installation/build_the_package.md)
-
-- Command to start single camera node
-
-On terminal 1: Launch camera node, example of gemini330 series :
-
-```bash
-cd ~/ros2_ws/
-source /opt/ros/$ROS_DISTRO/setup.bash
-source install/setup.bash
-ros2 launch orbbec_camera orbbec_camera.launch.py config_file_path:=gemini330_series.yaml
-```
-
-config_file_path:=gemini330_series.yaml means orbbec_camera.launch.py uses the parameters set in gemini330_series.yaml
-
-## Launch parameters
-
-For the definition and function of launch parameters, please refer to common.yaml. All open parameters are in common.yaml.The following is a partial common.yaml display:
-
-```yaml
-# config/*.yaml files are used to configure the camera parameters
----
-orbbec_ros:
- camera_parameters:
- general:
- # Camera model. upport product models by referencing config/*.yaml
- camera_model: "gemini330_series"
- # The configuration file for yaml params.
- config_file_path: "gemini330_series.yaml"
- # Log level. Supported levels are 'debug', 'info', 'warning' and 'error'. Default is 'none'.
- log_level: "none"
-
- deivce:
- # camera name, usually overwritten by launch file
- camera_name: "camera"
- # camera serial number, usually overwritten by launch file
- serial_number: ""
- # The USB port of the camera. This parameter is required when using multiple cameras.
- usb_port: ""
- # Number of devices. If multiple cameras are required, this parameter must be filled in launch file
- device_num: 1
- # Optional values: v4l2, libuvc
- uvc_backend: "libuvc"
- # Usually no need to change
- vendor_id: "0x2bc5"
-```
-
-Notice:If you run orbbec_camera.launch.py, the default combination of launch parameters used is common.yaml+gemini330_series.yaml, and the parameters in gemini330_series.yaml have higher priority than common.yaml
-
-## Visualizing data in rviz2
-
-- view_display launch
-
-`view_display.launch.py` supports loading different `.rviz` files through yaml configuration. For example, loading the default `.rviz` file to display four streams. config in different `.model.yaml `files through yaml configuration.
-
-On terminal 2:
-
-```bash
-cd ~/ros2_ws/
-source /opt/ros/$ROS_DISTRO/setup.bash
-source install/setup.bash
-ros2 launch orbbec_description view_display.launch.py camera_model:=gemini335_336
-```
-
-
-
-- view_model launch
-
-`view_model.launch.py` supports loading different `.model.yaml `files through yaml configuration. For example, loading the default model file to display gemini335_336 model .
-
-On terminal 3:
-
-```bash
-cd ~/ros2_ws/
-source /opt/ros/$ROS_DISTRO/setup.bash
-source install/setup.bash
-ros2 launch orbbec_description view_model.launch.py camera_model:=gemini335_336
-```
-
-
-
-- Or you can run rviz2 and configure it by yourself
-
-```bash
-cd ~/ros2_ws/
-source /opt/ros/$ROS_DISTRO/setup.bash
-source install/setup.bash
-rviz2
-```
-
-When runing rviz2, select the topic you wish to visualize from the list of published topics.
-Add the selected topic to rviz2 to start viewing the data.
-
-## Display view topic/service/param
-
-Once the camera node is running, it will publish data on several ROS topics. Below is a list of the available topics:
-By executing `ros2 topic list`, the following topics are displayed:
-
-On terminal 4:
-
-```bash
-ros2 topic list
-```
-
-Other , to display services/ parameters , example as follows
-
-```bash
-ros2 service list
-ros2 param list
-```
-
-Get device info:
-
-```bash
-ros2 service call /camera/get_device_info orbbec_camera_msgs/srv/GetDeviceInfo '{}'
-```
-
-Get SDK version:
-
-```bash
-ros2 service call /camera/get_sdk_version orbbec_camera_msgs/srv/GetString '{}'
-```
-
-Set auto exposure:
-
-```bash
-ros2 service call /camera/set_color_auto_exposure std_srvs/srv/SetBool '{data: false}'
-```
-
-Save point cloud:
-
-```bash
-ros2 service call /camera/save_point_cloud std_srvs/srv/Empty "{}"
-```
-
-
-
-## Example visualizations
-
-Here are examples of how the visualization might appear in rviz2:
-
-- **PointCloud Visualization**
-
-
-
-
-
-- **Image Data Visualization**
-
-
-
-
-
-## Aligning Depth to Color
-
-### Commands to Align and View Depth and Color Images
-
-1. **Basic Depth to Color Alignment:**
- To simply align the depth image to the color image, use the following command:
-
- ```shell
- ros2 launch orbbec_camera gemini_330_series.launch.py depth_registration:=true
- ```
-
- This command activates the depth registration feature without opening a viewer.
-2. **Viewing Depth to Color Overlay:**
- If you wish to view the depth to color overlay, you need to enable the viewer by using the command below:
-
- ```shell
- ros2 launch orbbec_camera gemini_330_series.launch.py depth_registration:=true enable_d2c_viewer:=true
- ```
-
- This launches the camera node with depth to color registration and opens a viewer to display the overlay image.
-
-### Selecting Topics in RViz2
-
-To visualize the aligned images in RViz2:
-
-1. Launch RViz2 after running one of the above commands.
-2. Select the topic for the depth to color overlay image. An example topic selection is shown here:
-
-
-
-### Example of Depth to Color Overlay
-
-After selecting the appropriate topic in RViz2, you will be able to see the depth to color overlay image. Here's what it might look like:
-
-
-
-## Enabling and Visualizing Point Cloud
-
-### Enabling Depth Point Cloud
-
-#### Command to Enable Depth Point Cloud
-
-To activate the point cloud data stream for depth information, use the following command:
-
-```shell
-ros2 launch orbbec_camera gemini_330_series.launch.py enable_point_cloud:=true
-```
-
-#### Visualizing Depth Point Cloud in RViz2
-
-After running the above command, perform the following steps to visualize the depth point cloud:
-
-1. Open RViz2.
-2. Add a `PointCloud2` display.
-3. Select the `/camera/depth/points` topic for visualization.
-4. Set the fixed frame to `camera_link` to properly align the data
-
-#### Example Visualization
-
-Here is what the depth point cloud might look like in RViz2:
-
-
-
-### Enabling Colored Point Cloud
-
-#### Command to Enable Colored Point Cloud
-
-To enable the colored point cloud feature, enter the following command:
-
-```shell
-ros2 launch orbbec_camera gemini_330_series.launch.py enable_colored_point_cloud:=true
-```
-
-#### Visualizing Colored Point Cloud in RViz2
-
-To visualize the colored point cloud data:
-
-1. Launch RViz2 following the command execution.
-2. Add a `PointCloud2` display panel.
-3. Choose the `/camera/depth_registered/points` topic from the list.
-4. Ensure the fixed frame is set to `camera_link`.
-
-#### Example Visualization
-
-The result of the colored point cloud in RViz2 should look similar to this:
-
-
-
-## TF tree diagram
-
-To get the TF tree
-
-```bash
-ros2 run rqt_tf_tree rqt_tf_tree --force-discover
-```
-
-
-
-The TF tree diagram for the OrbbecSDK_ROS2 is illustrated below:
- ``
diff --git a/docs/source/4_start_multi_camera/multi_camera.rst b/docs/source/4_start_multi_camera/multi_camera.rst
deleted file mode 100755
index f6002251..00000000
--- a/docs/source/4_start_multi_camera/multi_camera.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-.. 这一页是模块目录树
-
-.. .. image:: ../image/product_h4.png
-
-.. image:: ../image/product_h5.png
-
-======================================================
-
-Multiple cameras
-======================================================
-
- This section describes how to configure and use multiple Orbbec cameras simultaneously in a ROS 2 environment.
-
-
-
-======================================================
-
-.. toctree::
- :maxdepth: 2
- :caption: This Section Covers:
-
-
-
- start_multi_camera.md
-
-
-
-======================================================
-
-.. image:: ../image/product_h1.png
\ No newline at end of file
diff --git a/docs/source/4_start_multi_camera/start_multi_camera.md b/docs/source/4_start_multi_camera/start_multi_camera.md
deleted file mode 100755
index 5fafa46f..00000000
--- a/docs/source/4_start_multi_camera/start_multi_camera.md
+++ /dev/null
@@ -1,97 +0,0 @@
-
-
-# Multiple cameras
-
-This section describes how to configure and use multiple Orbbec cameras simultaneously in a ROS 2 environment.
-
-- Table of contents
- - [Script to list connected cameras](#script-to-list-connected-cameras)
- - [Setup for multiple camera launch](#setup-for-multiple-camera-launch)
- - [Running the launch file](#running-the-launch-file)
- - [Configuring the TF tree for multiple cameras](#configuring-the-tf-tree-for-multiple-cameras)
- - [Example TF configuration for two cameras](#example-tf-configuration-for-two-cameras)
-
-
-## List connected cameras
-
-To determine which USB ports the cameras are connected to, you can execute the following command.
-This Command lists all Orbbec devices attached to the system along with their USB port and serial number:
-
-```bash
-$ ros2 run orbbec_camera list_devices_node
-
-```
-
-As follows:
-
-```
-USB port_id: 4-1.1-3
-Modified USB port_id: 4-1.1
-[INFO]serial: CP7X54P0004D
-[INFO]usb port: 4-1.1
-[INFO]usb connect type: USB3.2
-USB port_id: 4-1.2-5
-Modified USB port_id: 4-1.2
-[INFO]serial: CP7X54P000AA
-[INFO]usb port: 4-1.2
-[INFO]usb connect type: USB3.2
-```
-
-From the log above, it appears that the two USB cameras you are connected to are using USB ports **4-1.1 and 4-1.2**.
-
-## Setup for multiple camera launch
-
-You can launch multiple cameras by specifying different USB ports for each camera. You can refer to orbbec_multicamera.launch.py to implement the multicamera launch script you need..
-
-## Running the launch file
-
-To execute the launch configuration for multiple cameras, use the command:
-
-```
-ros2 launch orbbec_camera orbbec_multicamera.launch.py config_file_path:=multicamera.yaml
-```
-
-**Note:**
-
-1. Multiple devices default config reference config/multicamera.yaml
-2. Multiple cameras synced config reference config/multicamera_synced.yaml
-
-## Example TF configuration for two cameras
-
-When using multiple cameras, it's essential to calibrate them and publish a static TF tree for each camera. The following Python script configures the TF tree based on your calibration results:
-
-```python
-from launch import LaunchDescription
-from launch_ros.actions import Node
-
-# Define the extrinsics for each camera (x, y, z, roll, pitch, yaw)
-camera_01_transform = ['0.1', '0', '0.2', '0', '0', '1.57'] # Example parameters
-camera_02_transform = ['-0.1', '0', '0.2', '0', '0', '-1.57'] # Example parameters
-
-def generate_launch_description():
- ld = LaunchDescription([
- Node(
- package='tf2_ros',
- executable='static_transform_publisher',
- name='camera_01_tf',
- arguments=camera_01_transform + ['base_link', 'camera_01_link'],
- output='screen'
- ),
- Node(
- package='tf2_ros',
- executable='static_transform_publisher',
- name='camera_02_tf',
- arguments=camera_02_transform + ['base_link', 'camera_02_link'],
- output='screen'
- )
- ])
-
- return ld
-
-```
-
-Save this configuration as `multi_camera_tf.launch.py` in the launch directory of the Orbbec camera package. To run it, use:
-
-```bash
-ros2 launch orbbec_camera multi_camera_tf.launch.py
-```
diff --git a/docs/source/5_advanced/advanced.rst b/docs/source/5_advanced/advanced.rst
deleted file mode 100755
index a3199c7a..00000000
--- a/docs/source/5_advanced/advanced.rst
+++ /dev/null
@@ -1,35 +0,0 @@
-.. 这一页是模块目录树
-
-.. .. image:: ../image/product_h9.png
-
-.. image:: ../image/product_h5.png
-
-======================================================
-
-
-Advanced
-======================================================
-
-This section explores the advanced usage of Orbbec SDK ROS2, specifically tailored for product application scenarios. It offers comprehensive guidance on how to fully harness the SDK's capabilities, enabling you to unlock the potential of your robotics projects. Discover the optimal ways to enhance your projects using the cutting-edge features provided by Orbbec SDK ROS2 environments.
-
-
-======================================================
-
-.. toctree::
- :maxdepth: 2
- :caption: This Section Covers:
-
-
- multi_camera_sync.md
- component_node.md
- zero_copy.md
- gdb_debug.md
- backward_ros.md
- cyclonedds_tuning.md
- fastdds_tuning.md
-
-
-
-======================================================
-
-.. image:: ../image/product_h1.png
\ No newline at end of file
diff --git a/docs/source/5_advanced/backward_ros.md b/docs/source/5_advanced/backward_ros.md
deleted file mode 100755
index 8312b723..00000000
--- a/docs/source/5_advanced/backward_ros.md
+++ /dev/null
@@ -1,44 +0,0 @@
-# Backward ros
-
-To use the `backward_ros` package for debugging your ROS2 project named `OrbbecSDK_ROS2`, you can follow these steps:
-
-## Add `backward_ros` as a dependency:
-
- In your `package.xml`, add `backward_ros` as a dependency:
-
-xml
-
-```
-backward_ros
-```
-
-## Configure `CMakeLists.txt`:
-
- In your `CMakeLists.txt`, find the `backward_ros` package and link it to your executable:
-
-cmake
-
-```
-find_package(backward_ros REQUIRED)
-include_directories(${backward_INCLUDE_DIRS})
-add_executable(your_node src/your_node.cpp)
-target_link_libraries(your_node ${backward_LIBRARIES})
-```
-
-## Build your project with debug information:
-
- Use `colcon build` with the `RelWithDebInfo` or `Debug` option to ensure that your executable is built with debug information:
-
-```
-colcon build --cmake-args '-DCMAKE_BUILD_TYPE=RelWithDebInfo'
-```
-
-## Run your node:
-
- After building, you can run your node as you normally would with ROS 2. If your node crashes, `backward_ros` will automatically generate a stack trace with detailed information, including line numbers, to help you debug the issue.
-
-## Example `backward_ros`
-
- When your program crashes, you can go to the Log folder under the workspace to find the stack trace of the crash.
-
-
diff --git a/docs/source/5_advanced/component_node.md b/docs/source/5_advanced/component_node.md
deleted file mode 100755
index e8a75ad6..00000000
--- a/docs/source/5_advanced/component_node.md
+++ /dev/null
@@ -1,157 +0,0 @@
-# Component node
-
-In ROS2, component nodes enable efficient resource management and modularity by allowing multiple nodes to be loaded into a single process, called a component container. Here’s an overview of setting up a component node and adding it to a container, both for a single node and through a `launch.py` file.
-
-### Creating a component node
-
-To define a node as a component, the following steps are required:
-
-1. **Create a node class**: The node class should inherit from `rclcpp::Node` (C++) or `Node` (Python) and implement the core functionalities within it.
-2. **Add plugin export**: In `CMakeLists.txt`, export the node as a plugin by adding it to a component library using `rclcpp_components`. For example:
-
- ```cmake
- # CMakeLists.txt
- find_package(rclcpp_components REQUIRED)
-
- add_library(my_component SHARED src/my_component.cpp)
- target_link_libraries(my_component PUBLIC rclcpp::rclcpp)
- ament_target_dependencies(my_component rclcpp rclcpp_components)
-
- rclcpp_components_register_nodes(my_component "mypackage::MyComponent")
- ```
-3. **Declare the plugin in package.xml**: Add the node as a plugin in the package manifest:
-
-```xml
-
-
-
-
-
-```
-
-### Loading a single node into a component container
-
-To load a node directly into a component container, use the ComponentManager node. Run the command:
-
-```bash
- ros2 run rclcpp_components component_container
-```
-
-Then load the component into this container with the load_component service:
-
-```bash
- ros2 component load /ComponentManager mypackage my_component
-```
-
-Replace /ComponentManager with the actual name of your container, if different.
-3. Adding Component Nodes via a Launch File
-In launch.py, you can define a component container and load nodes into it. Here’s an example launch.py file:
-
-```python
-from launch import LaunchDescription
-from launch_ros.actions import ComposableNodeContainer
-from launch_ros.descriptions import ComposableNode
-
-def generate_launch_description():
- container = ComposableNodeContainer(
- name='my_container',
- namespace='',
- package='rclcpp_components',
- executable='component_container_mt', # use 'component_container' for single-threaded
- composable_node_descriptions=[
- ComposableNode(
- package='mypackage',
- plugin='mypackage::MyComponent',
- name='my_component'
- ),
- ComposableNode(
- package='another_package',
- plugin='another_package::AnotherComponent',
- name='another_component'
- )
- ],
- output='screen',
- )
-
- return LaunchDescription([container])
-```
-
-**explanation**
-
-- ComposableNodeContainer: This creates a component container to hold nodes. Use component_container_mt for multi-threading or component_container for - single-threaded operation.
-- ComposableNode: Specifies each component to load, with arguments for the package name, plugin type, and node name.
-- output: Set to 'screen' to display output in the terminal.
- Running the Launch File
- To run the launch file, use the command:
-
-```bash
-ros2 launch mypackage my_launch_file.launch.py
-```
-
-This starts the component container and loads the specified nodes into it, enabling efficient component management in ROS2.
-
-### Loading a launch.py into a component container
-
-```python
-from launch import LaunchDescription
-from launch.actions import DeclareLaunchArgument
-from launch.conditions import UnlessCondition
-from launch_ros.actions import Node, IncludeLaunchDescription
-from launch.launch_description_sources import PythonLaunchDescriptionSource
-import os
-
-def generate_launch_description():
- bringup_dir = os.path.join(get_package_share_directory('mypackage'))
-
- # Define the shared container name
- shared_container_name = "shared_nvblox_container"
-
- # Create the shared component container
- shared_container = Node(
- name=shared_container_name,
- package='rclcpp_components',
- executable='component_container_mt', # or 'component_container' for single-threaded
- output='screen'
- )
-
- # Include another launch file to attach nodes to the shared container
- orbbec_launch = IncludeLaunchDescription(
- PythonLaunchDescriptionSource([os.path.join(
- bringup_dir, 'launch', 'sensors', 'orbbec.launch.py')]),
- launch_arguments={
- 'attach_to_shared_component_container': 'True',
- 'component_container_name': shared_container_name
- }.items(),
- condition=UnlessCondition(LaunchConfiguration('from_bag'))
- )
-
- # Declare any required launch arguments
- from_bag_arg = DeclareLaunchArgument(
- 'from_bag',
- default_value='false',
- description='Condition to use data from a bag file'
- )
-
- # Return LaunchDescription with shared container and nodes attached
- return LaunchDescription([from_bag_arg, shared_container, orbbec_launch])
-```
-
-**Explanation**
-
-- **shared_container_name**: The name of the shared container, which other nodes can reference for attaching.
-- **shared_container**: Defines the shared container as a `Node`, using `component_container_mt` for multi-threading. This container will host multiple component nodes.
-- **IncludeLaunchDescription**: Loads and attaches nodes from another launch file (in this example, orbbec.launch.py) to the shared container.
- - launch_arguments: The arguments passed to the included launch file.
- - **attach_to_shared_component_container**: Set to `'True'`, specifying that nodes in `orbbec.launch.py` should be added to the existing shared container.
- - **component_container_name**: References the `shared_container_name`, linking nodes from the included launch file to the shared container.
- - **condition**: Only includes the `orbbec.launch.py` nodes in the shared container if the `from_bag` parameter is `false`.
-
-**Running the launch File**
-
-Execute the following command to start the launch file:
-
-```
-ros2 launch mypackage my_main_launch_file.launch.py
-```
-
-This command will start the shared component container and attach the nodes specified in `orbbec.launch.py` to it if the `from_bag` condition is not met.
diff --git a/docs/source/5_advanced/cyclonedds_tuning.md b/docs/source/5_advanced/cyclonedds_tuning.md
deleted file mode 100755
index ae14694d..00000000
--- a/docs/source/5_advanced/cyclonedds_tuning.md
+++ /dev/null
@@ -1,56 +0,0 @@
-# CycloneDDS tuning
-
-● Edit cyclonedds configuration file
-
-```bash
-sudo gedit /etc/cyclonedds/config.xml
-```
-
-Add
-
-```xml
-
-
-
-
- lo
- false
-
-
- 16MB
-
-
- auto
- 30
-
-
-
-
-
-
-```
-
-● Set the environment variables, add to `.zshrc` or `.bashrc`
-
-```bash
-export ROS_DOMAIN_ID=42 # Numbers from 0 to 232
-export ROS_LOCALHOST_ONLY=1
-export CYCLONEDDS_URI=file:///etc/cyclonedds/config.xml
-```
-
-Tips:to understand why the maximum ROS_DOMAIN_ID is 232, please visit [The ROS DOMAIN ID](https://docs.ros.org/en/humble/Concepts/About-Domain-ID.html)
-
-● Increase UDP receive buffer size
-Edit
-
-```bash
-/etc/sysctl.d/10-cyclone-max.conf
-```
-
-Add
-
-```bash
-net.core.rmem_max=2147483647
-net.core.rmem_default=2147483647
-```
diff --git a/docs/source/5_advanced/gdb_debug.md b/docs/source/5_advanced/gdb_debug.md
deleted file mode 100755
index d5eecce9..00000000
--- a/docs/source/5_advanced/gdb_debug.md
+++ /dev/null
@@ -1,37 +0,0 @@
-# GDB debug
-
-Debugging ROS 2 programs with GDB involves several steps:
-
-## Config debug
-
-Set `CMAKE_BUILD_TYPE` to `Debug` in ` orbbec_camera/CMakeLists.txt`
-
-```
-set(CMAKE_BUILD_TYPE Debug)
-```
-
-## Use xterm terminal to open gdb debugging
-
-Install xterm
-
-```bash
-sudo apt install xterm
-```
-
-Take orbbec_camera.launch.py as an example to use xterm terminal to open gdb
-
-```python
- def create_composable_node(camera_name, params, use_intra_process):
- common_arguments = [{'use_intra_process_comms': use_intra_process}]
- composable_node = ComposableNode(
- namespace=camera_name,
- name=camera_name,
- package=default_package_name,
- plugin='orbbec_camera::OBCameraNodeDriver',
- parameters=params,
- #extra_arguments=[{'use_intra_process_comms': LaunchConfiguration("use_intra_process_comms")}],
- extra_arguments=common_arguments,
- prefix=['xterm -e gdb -ex run --args'],
- )
- return composable_node
-```
diff --git a/docs/source/5_advanced/image/multi_camera_sync/1731474090291.png b/docs/source/5_advanced/image/multi_camera_sync/1731474090291.png
deleted file mode 100644
index 730aed4e..00000000
Binary files a/docs/source/5_advanced/image/multi_camera_sync/1731474090291.png and /dev/null differ
diff --git a/docs/source/5_advanced/multi_camera_sync.md b/docs/source/5_advanced/multi_camera_sync.md
deleted file mode 100755
index 0d93605e..00000000
--- a/docs/source/5_advanced/multi_camera_sync.md
+++ /dev/null
@@ -1,128 +0,0 @@
-
-
-# Multiple cameras synchronization
-
-- Table of contents
-
- - [Preparation](#preparation)
- - [Check the camera usb port](#check-the-camera-usb-port)
- - [Configure multi_camera_synced.launch.py](#configure-multi_camera_synced.launch.py)
- - [Run multi_camera_synced.launch.py](#run-multi_camera_synced.launch.py)
- - [Advanced Parameters](#advanced-parameters)
- - [Gmsl example](#gmsl-example)
- - [suggestions for multiple cameras synchronization](#suggestions for multiple cameras synchronization)
-
-## Preparation
-
-First, please read the user documentation:[https://www.orbbec.com/docs/set-up-cameras-for-external-synchronization_v1-2/](https://www.orbbec.com/docs/set-up-cameras-for-external-synchronization_v1-2/)
-
-Secondly,make sure the cameras are properly connected to the multi-camera synchronizer
-
-
-
-## Check the camera usb port
-
-```bash
-ros2 run orbbec_camera list_devices_node
-```
-
-Output:
-
-
-
-## Configure multiple cameras synced
-
-Open `orbbec_multicamera.launch.py`, the camera configuration is as shown below
-
-You can replace `multicamera.yaml `with other yaml files, such as `multicamera_synced.yaml`
-
-
-
-Open `multicamera_synced.yaml`，the camera configuration is as shown below
-
-
-
-```
-note: gemini330_series_sync_front_camera.yaml is the camera configuration file.
-```
-
-
-**When configuring multiple cameras sync, you need to pay attention to the following parameters:**
-
-1.**camera_name**
-
-camera_name is set to front_camera, for example, the color image topic name is /front_camera/color/image_raw"
-
-2.**usb_port**
-
-The `usb_port` parameter specifies the USB port number to which the camera is connected. In your example, "2-7" indicates that the camera devices connected to USB ports 2 through 7 are started. You can use the command `ros2 run orbbec_camera list_devices_node` to view the device port numbers.
-
-Please ensure that these port numbers match your actual hardware cameras. If you have more cameras or cameras connected to different ports, you need to configure the corresponding port number for each device.
-
-3.**device_num**
-
-The device_num parameter indicates the number of cameras to be started. Please ensure that this value matches the number of cameras you want to start and does not exceed the number of cameras actually connected or the system's processing capacity.
-
-4.**sync_mode**
-
-sync_mode is set to software_triggering, indicating that the 2-7 camera device is set to software trigger mode, and the selection of multiple cameras synchronization mode can refer to the following table.
-
-Please refer to the[multi-camera synchronization mode definition description](https://www.orbbec.com/docs-general/set-up-cameras-for-external-synchronization_v1-2/#) for details.
-
-
-
-
-`multicamera_synced.yaml` describes the camera startup order, the host must be started last
-
-
-
-## Run `multicamera_synced.launch.py`
-
-```bash
-ros2 launch orbbec_camera multicamera_synced.launch.py
-```
-
-## Advanced sync parameters
-
-Some camera parameters are related to multi-camera sync
-
-| Camera parameters | action |
-| ----------------------- | ------------------------------------------------------------- |
-| trigger_out_enabled | Trigger signal switch setting |
-| trigger2image_delay_us | Configure the secondarydepth delay and secondarycolor delay |
-| trigger_out_delay_us | Trigger signal delay |
-| frames_per_trigger | Software trigger frequency(used with software_trigger_period) |
-| software_trigger_period | Software trigger interval(used with frames_per_trigger) |
-
-
-
-
-## GMSL camera example
-
-**Key Distinctions Between GMSL and USB Devices:**
-
-**1.usb_port Configuration:**
-
-• For USB cameras, the port is specified as: usb_port: "2-3"
-
-• For GMSL cameras, the port should be designated as: usb_port: "gmsl2-3"
-
-**2.Color Stream Format Compatibility:**
-
-• It is important to note that GMSL devices do not support the MJPG color format. Consequently, the format must be switched to YUYV when utilizing GMSL equipment.
-
-
-
-## suggestions for multiple cameras synchronization
-
-When configuring multiple cameras, there are several additional points to consider:
-
-1.Power Supply: Ensure that each camera receives sufficient power supply. Simultaneous operation of multiple high-power devices can put strain on the USB bus.
-
-2.Bandwidth Limitations: Simultaneous data transfer from multiple cameras can strain the USB bus or network bandwidth. Consider using higher bandwidth connections (such as USB 3.0 or higher) or optimizing data transfer settings.
-
-3.Synchronization Issues: If you require time synchronization between multiple cameras, ensure that your system supports and is properly configured for camera synchronization.
-
-4.Software Configuration: In ROS, you may need to configure separate nodes and topics for each camera to ensure they do not conflict. Using namespaces and the parameter server can help manage these configurations.
-
-Finally, do not forget to conduct thorough testing before deployment to ensure that all cameras function correctly and that system performance meets expectations.
diff --git a/docs/source/5_advanced/zero_copy.md b/docs/source/5_advanced/zero_copy.md
deleted file mode 100755
index ff9842d6..00000000
--- a/docs/source/5_advanced/zero_copy.md
+++ /dev/null
@@ -1,54 +0,0 @@
-# Zero-copy communications
-
-## Efficient intra-process communication:
-
-[](https://github.com/orbbec/OrbbecSDK_ROS2?tab=readme-ov-file#efficient-intra-process-communication)
-
-Our ROS2 Wrapper node supports zero-copy communications if loaded in the same process as a subscriber node. This can reduce copy times on ../image/pointcloud topics, especially with big frame resolutions and high FPS.
-
-You will need to launch a component container and launch our node as a component together with other component nodes. Further details on "Composing multiple nodes in a single process" can be found [here](https://docs.ros.org/en/rolling/Tutorials/Composition.html).
-
-Further details on efficient intra-process communication can be found [here](https://docs.ros.org/en/humble/Tutorials/Intra-Process-Communication.html#efficient-intra-process-communication).
-
-## Zero-copy example
-
-[](https://github.com/orbbec/OrbbecSDK_ROS2?tab=readme-ov-file#example)
-
-## Manually loading multiple components into the same process
-
-[](https://github.com/orbbec/OrbbecSDK_ROS2?tab=readme-ov-file#manually-loading-multiple-components-into-the-same-process)
-
-* Start the component:
-
- ```shell
- ros2 run rclcpp_components component_container
- ```
-* Add the wrapper:
-
- ```shell
- ros2 component load /ComponentManager orbbec_camera orbbec_camera::OBCameraNodeDriver -e use_intra_process_comms:=true
- ```
-
- Load other component nodes (consumers of the wrapper topics) in the same way.
-
-## Using a launch file
-
-[](https://github.com/orbbec/OrbbecSDK_ROS2?tab=readme-ov-file#using-a-launch-file)
-
-```shell
-ros2 launch orbbec_camera orbbec_camera.launch.py use_intra_process_comms:=true
-```
-
-```bash
-$ ros2 component list
-/camera/camera_container
- 1 /camera/camera
- 2 /camera/frame_latency
-```
-
-## Limitations
-
-[](https://github.com/orbbec/OrbbecSDK_ROS2?tab=readme-ov-file#limitations)
-
-* Node components are currently not supported on RCLPY
-* Compressed images using `image_transport` will be disabled as this isn't supported with intra-process communication
diff --git a/docs/source/6_tools/tool.rst b/docs/source/6_tools/tool.rst
deleted file mode 100755
index d10306d9..00000000
--- a/docs/source/6_tools/tool.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-.. 这一页是模块目录树
-.. :titlesonly:
-
-
-.. image:: ../image/product_h5.png
-
-======================================================
-
-
-Tools
-======================================================
-
-This chapter details the tools integrated with Orbbec SDK ROS2 and their usage methods, providing a guide for developers to effectively utilize these functionalities in robotic applications.
-
-
-
-
-======================================================
-
-.. toctree::
- :maxdepth: 2
- :caption: This Section Covers:
-
-
-
- tools.md
-
-
-======================================================
-
-.. image:: ../image/product_h1.png
\ No newline at end of file
diff --git a/docs/source/6_tools/tools.md b/docs/source/6_tools/tools.md
deleted file mode 100755
index f3607098..00000000
--- a/docs/source/6_tools/tools.md
+++ /dev/null
@@ -1,122 +0,0 @@
-# Some practical tools
-
-| Tool Name | effect |
-| ----------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| list_devices_node | check the camera USB port number |
-| list_depth_work_mode_node | view depth work modes |
-| list_camera_profile_mode_node | check which profiles the camera supports |
-| topic_statistics_node | topic statistics |
-| multi_save_rgbir_node | Multi camera sync save image, used to test synchronization quality |
-| metadata_save_files_node | Save the depth, left and right ir images and metadata data |
-| metadata_export_files_node | Compared with metadata_save_files_node, it has one more color collection but reduces some metadata data saving |
-
-## list_devices_node
-
-If you have connected multiple cameras, but you want to start a specific camera, you can run the list_devices_node tool to view the USB port of each camera.
-
-```bash
-ros2 run orbbec_camera list_devices_node
-```
-
-
-
-## list_depth_work_mode_node
-
-OrbbecSDK_ROS2 supports the depth work mode switch. The depth work mode switch is supported by Gemini 2, Gemini 2 L, and Femto and Femto Bolt cameras.
-
-View depth work modes:
-
-```bash
-ros2 run orbbec_camera list_depth_work_mode_node
-```
-
-
-
-## list_camera_profile_mode_node
-
-Check which profiles the camera supports:
-
-```bash
-ros2 run orbbec_camera list_camera_profile_mode_node
-```
-
-
-
-The above image only shows part of the output
-
-## multi_save_rgbir_node
-
-The purpose of multi_save_rgbir_node is to test the synchronization effect of using multiple Orbbec cameras in OrbbecSDK ROS2
-
-This tool will save the color and left IR images of each camera and the timestamp information
-
-The configuration parameter file of this tool node is multi_save_rgbir_params.json
-
-```json
-{
- "save_rgbir_params": {
- "time_domain": "device",
- "usb_ports": [
- "2-3",
- "2-1"
- ],
- "camera_name": [
- "G330_0",
- "G330_1"
- ]
- }
-}
-```
-
-* time_domain: timestamp type
-* usb_ports parameter order: "host", "slave 1", "slave 2", "slave 3", fill in as many usb_ports as there are cameras
-* camera_name: the name set for the camera, for example: G330_0
-
-## metadata_save_files_node
-
-The metadata_save_files_node tool will save the depth, left and right IR, images and metadata data
-
-The configuration parameter file of this tool node is metadata_save_params.json
-
-```json
-{
- "metadata_save_params": {
- "left_ir_image_topic": "/camera/left_ir/image_raw",
- "right_ir_image_topic": "/camera/right_ir/image_raw",
- "depth_image_topic": "/camera/depth/image_raw",
- "left_ir_metadata_topic": "/camera/left_ir/metadata",
- "right_ir_metadata_topic": "/camera/right_ir/metadata",
- "depth_metadata_topic": "/camera/depth/metadata"
- }
-}
-```
-
-```bash
-ros2 run orbbec_camera metadata_save_files_node
-```
-
-## metadata_export_files_node
-
-The metadata_save_files_node tool will save depth, color, left and right IR images and some metadata data
-
-The configuration parameter file of this tool node is metadata_save_params.json
-
-```json
-{
- "metadata_export_params": {
- "sn": "CP1L44P00085",
- "left_ir_image_topic": "/camera/left_ir/image_raw",
- "right_ir_image_topic": "/camera/right_ir/image_raw",
- "depth_image_topic": "/camera/depth/image_raw",
- "color_image_topic": "/camera/color/image_raw",
- "left_ir_metadata_topic": "/camera/left_ir/metadata",
- "right_ir_metadata_topic": "/camera/right_ir/metadata",
- "depth_metadata_topic": "/camera/depth/metadata",
- "color_metadata_topic": "/camera/color/metadata"
- }
-}
-```
-
-```bash
-ros2 run orbbec_camera metadata_export_files_node
-```
diff --git a/docs/source/7_help_center/FAQ.md b/docs/source/7_help_center/FAQ.md
deleted file mode 100755
index 13e82fc0..00000000
--- a/docs/source/7_help_center/FAQ.md
+++ /dev/null
@@ -1,69 +0,0 @@
-# FAQ
-
-## Unexpected crash
-
-If the camera node crashes unexpectedly, it will generate a crash log in the current running directory: `Log/camera_crash_stack_trace_xx.log`.
-Please send this log to the support team or submit it to a GitHub issue for further assistance.
-
-**Regarding logging, please refer to the following log recommendations:**
-
-In ROS, the location of the log directory is typically associated with the ROS workspace, but the specific log path may vary depending on the installation method and operating system.
-
-Here are some common locations for ROS log directories:
-
-1. **Default Global ROS Log Directory** : Global logs are typically recorded in the `~/.ros/log` directory. Here, `~` represents the user's home directory.
-2. **Workspace-Specific Log Directories** : In some cases, ROS nodes may log to specific directories within their workspace. This can often be achieved by setting the `ROS_LOG_DIR` environment variable.
-
-For the underlying Orbbec SDK, the log level can be configured via the `log_level` field in the `common.yaml` file.
-
-## How to Quickly Modify the Default Resolution
-
-How to Quickly Modify the Default Resolution, Video Format, and Frame Rate Parameters of a Product?
-
-1.Locate the corresponding product yaml configuration file, such as gemini330_series.yaml, in the orbbec_camera/config directory.
-2.Open the corresponding product yaml configuration file, such as gemini330_series.yaml, and modify the resolution, format, and frame rate settings for the video stream.
-
-For example:
-
-
-
-3.Compile and Run
-
-```
-colcon build --event-handlers console_direct+ --cmake-args -DCMAKE_BUILD_TYPE=Release
-source install/setup.bash
-ros2 launch orbbec_camera orbbec_camera.launch.py config_file_path:=gemini330_series.yaml
-```
-
-## No data stream from multiple cameras
-
-**Insufficient Power Supply**:
-
-- Ensure that each camera is connected to a separate 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 the `usbfs_memory_mb` value to 128MB (this is a reference value and can be adjusted based on your system’s needs)
- by running the following command:
-
-```bash
-echo 128 | sudo tee /sys/module/usbcore/parameters/usbfs_memory_mb
-```
-
-- To make this change permanent, check [this link](https://github.com/OpenKinect/libfreenect2/issues/807).
-
-## Additional troubleshooting
-
-- If you encounter other issues, set the `log_level` parameter to `debug`. This will generate an SDK log file in the running directory: `Log/OrbbecSDK.log.txt`.
- Please provide this file to the support team for further assistance.
-- If firmware logs are required, set `enable_heartbeat` to `true` to activate this feature.
-
-## Why are there so many yaml files?
-
-- Different yaml files have varying default resolutions and image formats.
-- To simplify usage, each camera has its own yaml file.
diff --git a/docs/source/7_help_center/help_center.rst b/docs/source/7_help_center/help_center.rst
deleted file mode 100755
index d0206d4f..00000000
--- a/docs/source/7_help_center/help_center.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-.. 这一页是模块目录树
-
-
-.. image:: ../image/product_h5.png
-
-======================================================
-
-
-Help center
-======================================================
-
-This section offers insights into common issues encountered during Orbbec SDK ROS2 development, along with their solutions, ensuring smoother progress in robotics projects.
-
-
-
-
-======================================================
-
-.. toctree::
- :maxdepth: 2
- :caption: This Section Covers:
-
-
- FAQ.md
- issues.md
-
-
-
-======================================================
-
-.. image:: ../image/product_h1.png
\ No newline at end of file
diff --git a/docs/source/7_help_center/issues.md b/docs/source/7_help_center/issues.md
deleted file mode 100755
index fc43253b..00000000
--- a/docs/source/7_help_center/issues.md
+++ /dev/null
@@ -1,5 +0,0 @@
-# Issue
-
-Regarding issues with OrbbecSDK_ROS 2, please refer to the detailed descriptions on the GitHub issue page for reference:
-
-[https://github.com/orbbec/OrbbecSDK_ROS2/issues](https://github.com/orbbec/OrbbecSDK_ROS2/issues)
diff --git a/docs/source/7_help_center/purchase.md b/docs/source/7_help_center/purchase.md
deleted file mode 100755
index 619d5155..00000000
--- a/docs/source/7_help_center/purchase.md
+++ /dev/null
@@ -1,15 +0,0 @@
-# Purchase link
-
-Purchase channels:
-
-Taobao Direct Enterprise Store:[Click to go to the mall](https://shop142544700.taobao.com/)
-
-JD.com Direct Flagship Store：[Click to go to the mall](https://mall.jd.com/index-1000467272.html)
-
-Gemini2 VL Camera: [Click to purchase on JD.com](https://item.jd.com/100063076495.html)
-
-Official Website Purchase Link：[Click to go to the official product area](https://www.orbbec.com/products)
-
-Gemini2 VL Camera: [Click to purchase on the official website](https://www.orbbec.com/products/stereo-vision-camera/gemini-335l)
-
-G335L Camera: [Click to purchase on the official website](https://www.orbbec.com/products/stereo-vision-camera/gemini-335l)
diff --git a/docs/source/7_help_center/technical_support.md b/docs/source/7_help_center/technical_support.md
deleted file mode 100755
index 63218c02..00000000
--- a/docs/source/7_help_center/technical_support.md
+++ /dev/null
@@ -1,12 +0,0 @@
-# Technical support
-
-Developer Community Technical Support:
-
-Orbbec
-Email: [developer@orbbec.com](https://file+10-002e8-002e190-002e12.vscode-resource.vscode-cdn.net/guojia/OrbbecSDK_ROS2/docs/source/mailto:developer@orbbec.com)
-
-3D Vision Developer Community: [developer.orbbec.com.cn/](https://developer.orbbec.com.cn/)
-
-Orbbec Official Website: Chinese: [www.orbbec.com.cn](https://www.orbbec.com.cn/) English: [www.orbbec.com](https://www.orbbec.com/)
-
-Orbbec Official ad
diff --git a/docs/source/8_license/license.md b/docs/source/8_license/license.md
deleted file mode 100755
index 0d8b7f9e..00000000
--- a/docs/source/8_license/license.md
+++ /dev/null
@@ -1,14 +0,0 @@
-## OrbbecSDK_ROS2 license
-
-Copyright 2024 Orbbec Ltd.
-
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with
-the License. You may obtain a copy of the License at
-
-[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
-
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "
-AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific
-language governing permissions and limitations under the License.
-
-Other names and brands may be claimed as the property of others
diff --git a/docs/source/8_license/sdk_license.rst b/docs/source/8_license/sdk_license.rst
deleted file mode 100755
index 091fc91f..00000000
--- a/docs/source/8_license/sdk_license.rst
+++ /dev/null
@@ -1,28 +0,0 @@
-.. 这一页是模块目录树
-
-
-.. image:: ../image/product_h5.png
-
-======================================================
-
-
-License
-======================================================
-
-Copyright 2024 Orbbec Ltd.
-
-
-
-======================================================
-
-.. toctree::
- :maxdepth: 2
- :caption: This Section Covers:
-
-
- license.md
-
-
-======================================================
-
-.. image:: ../image/product_h1.png
\ No newline at end of file
diff --git a/docs/source/LICENSE.txt b/docs/source/LICENSE.txt
deleted file mode 100755
index b86a0979..00000000
--- a/docs/source/LICENSE.txt
+++ /dev/null
@@ -1,1115 +0,0 @@
-## License for this repository
-
-This repository is licensed under the MIT license.
-
-```
-Copyright (c) 2023 OrbbecDeveloper
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-```
-
-## License for the Orbbec SDK library
-
-The Orbbec SDK library binary files are provided at the "lib" directory of this
-repository. The license for the Orbbec SDK library is provided below:
-
-```
-Copyright (c) 2023 OrbbecDeveloper
-
-Scope of License: This license grants, free of charge, to any person obtaining a
-copy of this repository or substantial portions of this repository, the right to
-use the files in this repository for ultilizing products from Orbbec Inc.You may
-apply this repository for personal, academic, and commercial use. The above copyright
-notice and this permission notice shall be included in all copies or substantial
-portions of the repository.
-
-Prohibited Actions: You are prohibited from modifying, decompiling, or reverse
-engineering any part of this library. You cannot use this library for products
-other than those of Orbbec.
-
-Reservation of Rights: The author reserves the right to modify this license at
-any time without prior notice. The author reserves all rights to this library.
-
-Disclaimer: This library is provided "as is," and the author assumes no responsibility
-for any direct, indirect, incidental, special, or consequential damages resulting
-from the use of this library.
-
-License Updates: If the author releases a new version of the license, you agree
-to comply with the new version after receiving notice.
-```
-
-## License for the third party libraries dependencies of Orbbec SDK library
-
-The Orbbec SDK library uses third party libraries that may have their own licenses.
-
-### Third party libraries under the MIT license
-
-1. spdlog
-
- * By: Gabi Melman
- * Version: v1.11.0
- * Repository: https://github.com/gabime/spdlog
-
-2. dylib
-
- * By: Martin Olivier
- * Version: v2.2.1
- * Repository: https://github.com/martin-olivier/dylib
-
-3. cmrc
-
- * By: vectorofbool@gmail.com
- * Version: v2.0.1
- * Repository: https://github.com/vector-of-bool/cmrc
-
-4. jsoncpp
-
- * By: chenguopingdota@163.com
- * Version: v1.9.5
- * Repository: https://github.com/open-source-parsers/jsoncpp
-
-Terms of the MIT License:
-
-```
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-```
-
-### Third party libraries under the BSD license
-
-1. libuvc
-
- * By: libuvc organization
- * Version: v0.0.7
- * Repository: https://github.com/libuvc/libuvc
-
-2. libjpeg-turbo
-
- * By: libjpeg-turbo organization (libjpeg-turbo.org)
- * Version: v2.0.90
- * Repository: https://github.com/libjpeg-turbo/libjpeg-turbo
-
-Terms of the BSD License:
-
-```
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this
- list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice,
- this list of conditions and the following disclaimer in the documentation
- and/or other materials provided with the distribution.
-
-3. Neither the name of the copyright holder nor the names of its
- contributors may be used to endorse or promote products derived from
- this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-```
-
-### Third party libraries under the Apache license
-
-1. OpenCV
-
- * By: OpenCV Organization (opencv.org)
- * Version: v3.4.16
- * Repository: https://github.com/opencv/opencv
-
-Terms of the Apache License:
-
-```
-
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright [yyyy] [name of copyright owner]
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-```
-
-### Third party libraries under the LGPL license
-
-1. libusb
-
- * By: libusb organization (libusb.info)
- * Version: v1.0.26
- * Repository: https://github.com/libusb/libusb
-
-2. live555
-
- * By: http://www.live555.com/
- * Version: v2019.08.13
- * Repository: https://github.com/rgl/live555
-
-Terms of the LGPL license:
-
-```
-GNU LESSER GENERAL PUBLIC LICENSE
- Version 2.1, February 1999
-
- Copyright (C) 1991, 1999 Free Software Foundation, Inc.
- 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-[This is the first released version of the Lesser GPL. It also counts
- as the successor of the GNU Library Public License, version 2, hence
- the version number 2.1.]
-
- Preamble
-
- The licenses for most software are designed to take away your
-freedom to share and change it. By contrast, the GNU General Public
-Licenses are intended to guarantee your freedom to share and change
-free software--to make sure the software is free for all its users.
-
- This license, the Lesser General Public License, applies to some
-specially designated software packages--typically libraries--of the
-Free Software Foundation and other authors who decide to use it. You
-can use it too, but we suggest you first think carefully about whether
-this license or the ordinary General Public License is the better
-strategy to use in any particular case, based on the explanations below.
-
- When we speak of free software, we are referring to freedom of use,
-not price. Our General Public Licenses are designed to make sure that
-you have the freedom to distribute copies of free software (and charge
-for this service if you wish); that you receive source code or can get
-it if you want it; that you can change the software and use pieces of
-it in new free programs; and that you are informed that you can do
-these things.
-
- To protect your rights, we need to make restrictions that forbid
-distributors to deny you these rights or to ask you to surrender these
-rights. These restrictions translate to certain responsibilities for
-you if you distribute copies of the library or if you modify it.
-
- For example, if you distribute copies of the library, whether gratis
-or for a fee, you must give the recipients all the rights that we gave
-you. You must make sure that they, too, receive or can get the source
-code. If you link other code with the library, you must provide
-complete object files to the recipients, so that they can relink them
-with the library after making changes to the library and recompiling
-it. And you must show them these terms so they know their rights.
-
- We protect your rights with a two-step method: (1) we copyright the
-library, and (2) we offer you this license, which gives you legal
-permission to copy, distribute and/or modify the library.
-
- To protect each distributor, we want to make it very clear that
-there is no warranty for the free library. Also, if the library is
-modified by someone else and passed on, the recipients should know
-that what they have is not the original version, so that the original
-author's reputation will not be affected by problems that might be
-introduced by others.
-
- Finally, software patents pose a constant threat to the existence of
-any free program. We wish to make sure that a company cannot
-effectively restrict the users of a free program by obtaining a
-restrictive license from a patent holder. Therefore, we insist that
-any patent license obtained for a version of the library must be
-consistent with the full freedom of use specified in this license.
-
- Most GNU software, including some libraries, is covered by the
-ordinary GNU General Public License. This license, the GNU Lesser
-General Public License, applies to certain designated libraries, and
-is quite different from the ordinary General Public License. We use
-this license for certain libraries in order to permit linking those
-libraries into non-free programs.
-
- When a program is linked with a library, whether statically or using
-a shared library, the combination of the two is legally speaking a
-combined work, a derivative of the original library. The ordinary
-General Public License therefore permits such linking only if the
-entire combination fits its criteria of freedom. The Lesser General
-Public License permits more lax criteria for linking other code with
-the library.
-
- We call this license the "Lesser" General Public License because it
-does Less to protect the user's freedom than the ordinary General
-Public License. It also provides other free software developers Less
-of an advantage over competing non-free programs. These disadvantages
-are the reason we use the ordinary General Public License for many
-libraries. However, the Lesser license provides advantages in certain
-special circumstances.
-
- For example, on rare occasions, there may be a special need to
-encourage the widest possible use of a certain library, so that it becomes
-a de-facto standard. To achieve this, non-free programs must be
-allowed to use the library. A more frequent case is that a free
-library does the same job as widely used non-free libraries. In this
-case, there is little to gain by limiting the free library to free
-software only, so we use the Lesser General Public License.
-
- In other cases, permission to use a particular library in non-free
-programs enables a greater number of people to use a large body of
-free software. For example, permission to use the GNU C Library in
-non-free programs enables many more people to use the whole GNU
-operating system, as well as its variant, the GNU/Linux operating
-system.
-
- Although the Lesser General Public License is Less protective of the
-users' freedom, it does ensure that the user of a program that is
-linked with the Library has the freedom and the wherewithal to run
-that program using a modified version of the Library.
-
- The precise terms and conditions for copying, distribution and
-modification follow. Pay close attention to the difference between a
-"work based on the library" and a "work that uses the library". The
-former contains code derived from the library, whereas the latter must
-be combined with the library in order to run.
-
- GNU LESSER GENERAL PUBLIC LICENSE
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
- 1. This License Agreement applies to any software library or other
-program which contains a notice placed by the copyright holder or
-other authorized party saying it may be distributed under the terms of
-this Lesser General Public License (also called "this License").
-Each licensee is addressed as "you".
-
- A "library" means a collection of software functions and/or data
-prepared so as to be conveniently linked with application programs
-(which use some of those functions and data) to form executables.
-
- The "Library", below, refers to any such software library or work
-which has been distributed under these terms. A "work based on the
-Library" means either the Library or any derivative work under
-copyright law: that is to say, a work containing the Library or a
-portion of it, either verbatim or with modifications and/or translated
-straightforwardly into another language. (Hereinafter, translation is
-included without limitation in the term "modification".)
-
- "Source code" for a work means the preferred form of the work for
-making modifications to it. For a library, complete source code means
-all the source code for all modules it contains, plus any associated
-interface definition files, plus the scripts used to control compilation
-and installation of the library.
-
- Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of
-running a program using the Library is not restricted, and output from
-such a program is covered only if its contents constitute a work based
-on the Library (independent of the use of the Library in a tool for
-writing it). Whether that is true depends on what the Library does
-and what the program that uses the Library does.
-
- 1. You may copy and distribute verbatim copies of the Library's
-complete source code as you receive it, in any medium, provided that
-you conspicuously and appropriately publish on each copy an
-appropriate copyright notice and disclaimer of warranty; keep intact
-all the notices that refer to this License and to the absence of any
-warranty; and distribute a copy of this License along with the
-Library.
-
- You may charge a fee for the physical act of transferring a copy,
-and you may at your option offer warranty protection in exchange for a
-fee.
-
- 2. You may modify your copy or copies of the Library or any portion
-of it, thus forming a work based on the Library, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
- a) The modified work must itself be a software library.
-
- b) You must cause the files modified to carry prominent notices
- stating that you changed the files and the date of any change.
-
- c) You must cause the whole of the work to be licensed at no
- charge to all third parties under the terms of this License.
-
- d) If a facility in the modified Library refers to a function or a
- table of data to be supplied by an application program that uses
- the facility, other than as an argument passed when the facility
- is invoked, then you must make a good faith effort to ensure that,
- in the event an application does not supply such function or
- table, the facility still operates, and performs whatever part of
- its purpose remains meaningful.
-
- (For example, a function in a library to compute square roots has
- a purpose that is entirely well-defined independent of the
- application. Therefore, Subsection 2d requires that any
- application-supplied function or table used by this function must
- be optional: if the application does not supply it, the square
- root function must still compute square roots.)
-
-These requirements apply to the modified work as a whole. If
-identifiable sections of that work are not derived from the Library,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works. But when you
-distribute the same sections as part of a whole which is a work based
-on the Library, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote
-it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Library.
-
-In addition, mere aggregation of another work not based on the Library
-with the Library (or with a work based on the Library) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
- 3. You may opt to apply the terms of the ordinary GNU General Public
-License instead of this License to a given copy of the Library. To do
-this, you must alter all the notices that refer to this License, so
-that they refer to the ordinary GNU General Public License, version 2,
-instead of to this License. (If a newer version than version 2 of the
-ordinary GNU General Public License has appeared, then you can specify
-that version instead if you wish.) Do not make any other change in
-these notices.
-
- Once this change is made in a given copy, it is irreversible for
-that copy, so the ordinary GNU General Public License applies to all
-subsequent copies and derivative works made from that copy.
-
- This option is useful when you wish to copy part of the code of
-the Library into a program that is not a library.
-
- 4. You may copy and distribute the Library (or a portion or
-derivative of it, under Section 2) in object code or executable form
-under the terms of Sections 1 and 2 above provided that you accompany
-it with the complete corresponding machine-readable source code, which
-must be distributed under the terms of Sections 1 and 2 above on a
-medium customarily used for software interchange.
-
- If distribution of object code is made by offering access to copy
-from a designated place, then offering equivalent access to copy the
-source code from the same place satisfies the requirement to
-distribute the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
- 5. A program that contains no derivative of any portion of the
-Library, but is designed to work with the Library by being compiled or
-linked with it, is called a "work that uses the Library". Such a
-work, in isolation, is not a derivative work of the Library, and
-therefore falls outside the scope of this License.
-
- However, linking a "work that uses the Library" with the Library
-creates an executable that is a derivative of the Library (because it
-contains portions of the Library), rather than a "work that uses the
-library". The executable is therefore covered by this License.
-Section 6 states terms for distribution of such executables.
-
- When a "work that uses the Library" uses material from a header file
-that is part of the Library, the object code for the work may be a
-derivative work of the Library even though the source code is not.
-Whether this is true is especially significant if the work can be
-linked without the Library, or if the work is itself a library. The
-threshold for this to be true is not precisely defined by law.
-
- If such an object file uses only numerical parameters, data
-structure layouts and accessors, and small macros and small inline
-functions (ten lines or less in length), then the use of the object
-file is unrestricted, regardless of whether it is legally a derivative
-work. (Executables containing this object code plus portions of the
-Library will still fall under Section 6.)
-
- Otherwise, if the work is a derivative of the Library, you may
-distribute the object code for the work under the terms of Section 6.
-Any executables containing that work also fall under Section 6,
-whether or not they are linked directly with the Library itself.
-
- 6. As an exception to the Sections above, you may also combine or
-link a "work that uses the Library" with the Library to produce a
-work containing portions of the Library, and distribute that work
-under terms of your choice, provided that the terms permit
-modification of the work for the customer's own use and reverse
-engineering for debugging such modifications.
-
- You must give prominent notice with each copy of the work that the
-Library is used in it and that the Library and its use are covered by
-this License. You must supply a copy of this License. If the work
-during execution displays copyright notices, you must include the
-copyright notice for the Library among them, as well as a reference
-directing the user to the copy of this License. Also, you must do one
-of these things:
-
- a) Accompany the work with the complete corresponding
- machine-readable source code for the Library including whatever
- changes were used in the work (which must be distributed under
- Sections 1 and 2 above); and, if the work is an executable linked
- with the Library, with the complete machine-readable "work that
- uses the Library", as object code and/or source code, so that the
- user can modify the Library and then relink to produce a modified
- executable containing the modified Library. (It is understood
- that the user who changes the contents of definitions files in the
- Library will not necessarily be able to recompile the application
- to use the modified definitions.)
-
- b) Use a suitable shared library mechanism for linking with the
- Library. A suitable mechanism is one that (1) uses at run time a
- copy of the library already present on the user's computer system,
- rather than copying library functions into the executable, and (2)
- will operate properly with a modified version of the library, if
- the user installs one, as long as the modified version is
- interface-compatible with the version that the work was made with.
-
- c) Accompany the work with a written offer, valid for at
- least three years, to give the same user the materials
- specified in Subsection 6a, above, for a charge no more
- than the cost of performing this distribution.
-
- d) If distribution of the work is made by offering access to copy
- from a designated place, offer equivalent access to copy the above
- specified materials from the same place.
-
- e) Verify that the user has already received a copy of these
- materials or that you have already sent this user a copy.
-
- For an executable, the required form of the "work that uses the
-Library" must include any data and utility programs needed for
-reproducing the executable from it. However, as a special exception,
-the materials to be distributed need not include anything that is
-normally distributed (in either source or binary form) with the major
-components (compiler, kernel, and so on) of the operating system on
-which the executable runs, unless that component itself accompanies
-the executable.
-
- It may happen that this requirement contradicts the license
-restrictions of other proprietary libraries that do not normally
-accompany the operating system. Such a contradiction means you cannot
-use both them and the Library together in an executable that you
-distribute.
-
- 7. You may place library facilities that are a work based on the
-Library side-by-side in a single library together with other library
-facilities not covered by this License, and distribute such a combined
-library, provided that the separate distribution of the work based on
-the Library and of the other library facilities is otherwise
-permitted, and provided that you do these two things:
-
- a) Accompany the combined library with a copy of the same work
- based on the Library, uncombined with any other library
- facilities. This must be distributed under the terms of the
- Sections above.
-
- b) Give prominent notice with the combined library of the fact
- that part of it is a work based on the Library, and explaining
- where to find the accompanying uncombined form of the same work.
-
- 8. You may not copy, modify, sublicense, link with, or distribute
-the Library except as expressly provided under this License. Any
-attempt otherwise to copy, modify, sublicense, link with, or
-distribute the Library is void, and will automatically terminate your
-rights under this License. However, parties who have received copies,
-or rights, from you under this License will not have their licenses
-terminated so long as such parties remain in full compliance.
-
- 9. You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or
-distribute the Library or its derivative works. These actions are
-prohibited by law if you do not accept this License. Therefore, by
-modifying or distributing the Library (or any work based on the
-Library), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Library or works based on it.
-
- 10. Each time you redistribute the Library (or any work based on the
-Library), the recipient automatically receives a license from the
-original licensor to copy, distribute, link with or modify the Library
-subject to these terms and conditions. You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties with
-this License.
-
- 11. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Library at all. For example, if a patent
-license would not permit royalty-free redistribution of the Library by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Library.
-
-If any portion of this section is held invalid or unenforceable under any
-particular circumstance, the balance of the section is intended to apply,
-and the section as a whole is intended to apply in other circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system which is
-implemented by public license practices. Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
- 12. If the distribution and/or use of the Library is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Library under this License may add
-an explicit geographical distribution limitation excluding those countries,
-so that distribution is permitted only in or among countries not thus
-excluded. In such case, this License incorporates the limitation as if
-written in the body of this License.
-
- 13. The Free Software Foundation may publish revised and/or new
-versions of the Lesser General Public License from time to time.
-Such new versions will be similar in spirit to the present version,
-but may differ in detail to address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Library
-specifies a version number of this License which applies to it and
-"any later version", you have the option of following the terms and
-conditions either of that version or of any later version published by
-the Free Software Foundation. If the Library does not specify a
-license version number, you may choose any version ever published by
-the Free Software Foundation.
-
- 14. If you wish to incorporate parts of the Library into other free
-programs whose distribution conditions are incompatible with these,
-write to the author to ask for permission. For software which is
-copyrighted by the Free Software Foundation, write to the Free
-Software Foundation; we sometimes make exceptions for this. Our
-decision will be guided by the two goals of preserving the free status
-of all derivatives of our free software and of promoting the sharing
-and reuse of software generally.
-
- NO WARRANTY
-
- 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
-WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
-EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
-OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
-KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
-LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
-THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
- 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
-AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
-FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
-CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
-LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
-RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
-FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
-SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-
- END OF TERMS AND CONDITIONS
-
- How to Apply These Terms to Your New Libraries
-
- If you develop a new library, and you want it to be of the greatest
-possible use to the public, we recommend making it free software that
-everyone can redistribute and change. You can do so by permitting
-redistribution under these terms (or, alternatively, under the terms of the
-ordinary General Public License).
-
- To apply these terms, attach the following notices to the library. It is
-safest to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least the
-"copyright" line and a pointer to where the full notice is found.
-
- 和
也自动拉伸 */
-th,
-td {
- width: auto;
-}
-
-ul {
- width: 100%;
- /* 列表宽度占满整个容器 */
- }
-
-
-/* 修改 Sphinx Theme 项目标题的字体大小 Book和rtd 均OK */
-.wy-side-nav-search>a {
- font-size: 16px;
-}
-
-/* 修改项目标题的字体大小 Book和rtd 均OK*/
-.wy-side-nav-search>div.version {
- font-size: 16px;
-}
-
-
-.sidebar-logo {
- width: 500px;
- /* 或者使用百分比 */
- height: auto;
- max-width: 90%;
- max-height: 90%;
-}
-
-
-.sidebar-content {
- line-height: 1.0;
- /* 行间距是字体大小的1.5倍 */
-}
-
-.sidebar {
- padding: 20px;
- /* 内边距 */
- margin-bottom: 20px;
- /* 外边距 */
-}
-
-.sidebar-text {
- font-size: 30px;
-}
-/* 修改侧边栏的背景颜色 */
-.wy-nav-side {
- background-color: #cecece !important;
-}
-
-/* 针对导航栏链接的选择器 */
-.wy-nav-side a {
- color: #000000;
- /* 修改为您需要的颜色 */
-}
-
-/* 鼠标悬停位置 hover 和 激活位置active 状态的样式 */
-/* .wy-nav-side a:hover {
- background-color: #ebebeb !important;
- } */
-
-/* .wy-nav-side .current li.toctree-l1 a:hover,
-.wy-nav-side .current li.toctree-l2 a:hover,
-.wy-nav-side .current li.toctree-l3 a:hover {
- background-color: #ebebeb !important;
- color: #108bf0 !important;
- font-weight: bold !important;
-} */
-.wy-nav-side .current li[class^="toctree-l"] a:hover {
- background-color: #ebebeb !important;
- color: #108bf0 !important;
- font-weight: bold !important;
- }
-
- /* .wy-nav-side .current li[class^="toctree-l"] a:active {
- background-color: #ffffff !important;
- color: #108bf0 !important;
- font-weight: bold !important;
-}
-
-*/
-/* 当前活动项的颜色 */
-.wy-nav-side .current>a {
- color: #108bf0 !important;
- font-weight: bold !important;
-}
-
-
-h1.wy-banner-title {
- color: #0267da !important;
-}
-
-/* 如果也需要修改小标题 */
-h2.wy-banner-subtitle {
- color: #7b7b7b !important;
-}
-
-.wy-side-nav-search>a {
- color: #ffffff !important;
-}
-
-/* 调整最大宽度 OK */
-.wy-nav-content {
- max-width: 1100px;
- }
-
-
-/* 设置选中标题的背景色 */
-.wy-menu-vertical li.current>a {
- background-color: #e9e9e9 !important;
- /* 你可以选择任何颜色 */
- color: #ffffff;
- /* 可选：设置选中标题的文本颜色 */
-}
-
-/* 设置选中标题下所有子标题（包括二级和三级）的背景色 */
-/* .wy-menu-vertical li.current ul li a,
-.wy-menu-vertical li.current li.current ul li a {
- background-color: #ffffff !important;
-} */
-.wy-menu-vertical li.toctree-l1.current>ul li.toctree-l2>a,
-.wy-menu-vertical li.toctree-l2.current>ul li.toctree-l3>a,
-.wy-menu-vertical li.toctree-l3.current>ul li.toctree-l4>a {
- background-color: #ffffff ;
-
-}
\ No newline at end of file
diff --git a/docs/source/_static/custom.js b/docs/source/_static/custom.js
deleted file mode 100755
index f405b0d4..00000000
--- a/docs/source/_static/custom.js
+++ /dev/null
@@ -1,34 +0,0 @@
-// custom.js 可以禁止自动折叠，但不能跳转
-// document.addEventListener('DOMContentLoaded', function () {
-// // 展开所有侧边栏目录项
-// var toctreeItems = document.querySelectorAll('.toctree-l1');
-// toctreeItems.forEach(function (item) {
-// item.classList.add('current');
-// });
-
-// // 监听点击事件，确保点击标题时不会折叠其他标题，并且能够跳转到相应的文档部分
-// document.querySelectorAll('.toctree-l1 a').forEach(function (link) {
-// link.addEventListener('click', function (event) {
-// // 阻止默认的折叠行为
-// event.preventDefault();
-// // 展开点击的标题
-// var parentLi = this.closest('li');
-// parentLi.classList.add('current');
-// // 移除其他同级目录项的 'current' 类
-// parentLi.parentElement.children.forEach(function (sibling) {
-// if (sibling !== parentLi) {
-// sibling.classList.remove('current');
-// }
-// });
-// // 跳转到相应的文档部分
-// var target = this.getAttribute('href');
-// if (target.startsWith('#')) {
-// document.querySelector(target).scrollIntoView();
-// } else {
-// // 如果链接不是锚点，则在新窗口或当前窗口打开链接
-// window.open(target, '_blank');
-// }
-// });
-// });
-// });
-
diff --git a/docs/source/_static/orbbec-light_no_colour.svg b/docs/source/_static/orbbec-light_no_colour.svg
deleted file mode 100755
index a3b6a754..00000000
--- a/docs/source/_static/orbbec-light_no_colour.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/docs/source/_static/orbbec_footerlogo_3d_world.svg b/docs/source/_static/orbbec_footerlogo_3d_world.svg
deleted file mode 100755
index 7f702a6d..00000000
--- a/docs/source/_static/orbbec_footerlogo_3d_world.svg
+++ /dev/null
@@ -1 +0,0 @@
-
\ No newline at end of file
diff --git a/docs/source/_static/orbbec_logo.png b/docs/source/_static/orbbec_logo.png
deleted file mode 100755
index 7a60b4c3..00000000
Binary files a/docs/source/_static/orbbec_logo.png and /dev/null differ
diff --git a/docs/source/_static/orbbec_logo2.png b/docs/source/_static/orbbec_logo2.png
deleted file mode 100755
index 3cd81012..00000000
Binary files a/docs/source/_static/orbbec_logo2.png and /dev/null differ
diff --git a/docs/source/_static/orbbec_logo4.png b/docs/source/_static/orbbec_logo4.png
deleted file mode 100755
index 92f681ca..00000000
Binary files a/docs/source/_static/orbbec_logo4.png and /dev/null differ
diff --git a/docs/source/_static/orbbec_only_english_logo.svg b/docs/source/_static/orbbec_only_english_logo.svg
deleted file mode 100755
index 775cbc0b..00000000
--- a/docs/source/_static/orbbec_only_english_logo.svg
+++ /dev/null
@@ -1,53 +0,0 @@
-
diff --git a/docs/source/_static/theme.js b/docs/source/_static/theme.js
deleted file mode 100755
index 966d5ee6..00000000
--- a/docs/source/_static/theme.js
+++ /dev/null
@@ -1,212 +0,0 @@
-// 创建一个自执行的函数，用于封装模块定义和执行逻辑
-!function (n) {
- // 定义模块存储对象和模块导出相关函数
- var e = {};
- function t(i) {
- // 模块缓存逻辑，避免重复执行
- if (e[i]) return e[i].exports;
- var o = e[i] = { i: i, l: !1, exports: {} };
- // 执行模块定义函数并缓存结果
- return n[i].call(o.exports, o, o.exports, t),
- o.l = !0,
- o.exports
- }
- // 初始化模块系统，定义模块数组、缓存对象、导出函数等
- t.m = n,
- t.c = e,
- t.d = function (n, e, i) {
- t.o(n, e) || Object.defineProperty(n, e, { enumerable: !0, get: i })
- },
- t.r = function (n) {
- "undefined" != typeof Symbol && Symbol.toStringTag && Object.defineProperty(n, Symbol.toStringTag, { value: "Module" }),
- Object.defineProperty(n, "__esModule", { value: !0 })
- },
- t.t = function (n, e) {
- if (1 & e && (n = t(n)), 8 & e) return n;
- if (4 & e && "object" == typeof n && n && n.__esModule) return n;
- var i = Object.create(null);
- if (t.r(i), Object.defineProperty(i, "default", { enumerable: !0, value: n }),
- 2 & e && "string" != typeof n) for (var o in n)
- t.d(i, o, function (e) { return n[e] }.bind(null, o));
- return i
- },
- t.n = function (n) {
- var e = n && n.__esModule ? function () { return n.default } : function () { return n };
- return t.d(e, "a", e), e
- },
- t.o = function (n, e) { return Object.prototype.hasOwnProperty.call(n, e) },
- t.p = "",
- // 执行入口模块
- t(t.s = 0)
-}([
- // 定义模块数组，每个模块是一个函数
- function (n, e, t) {
- // 执行依赖模块并导出结果
- t(1),
- n.exports = t(3)
- },
- function (n, e, t) {
- // 根据环境获取jQuery对象
- (function () {
- var e = "undefined" != typeof window ? window.jQuery : t(2);
- // 定义并导出ThemeNav对象
- n.exports.ThemeNav = {
- navBar: null,
- win: null,
- winScroll: !1,
- winResize: !1,
- linkScroll: !1,
- winPosition: 0,
- winHeight: null,
- docHeight: null,
- isRunning: !1,
- // 启用导航栏功能
- enable: function (n) {
- var t = this;
- void 0 === n && (n = !0),
- t.isRunning || (t.isRunning = !0,
- e((function (e) {
- t.init(e),
- t.reset(),
- t.win.on("hashchange", t.reset),
- n && t.win.on("scroll", (function () {
- t.linkScroll || t.winScroll || (t.winScroll = !0,
- requestAnimationFrame((function () {
- t.onScroll()
- })))
- })),
- t.win.on("resize", (function () {
- t.winResize || (t.winResize = !0,
- requestAnimationFrame((function () {
- t.onResize()
- })))
- })),
- t.onResize()
- })))
- },
- // 启用粘性导航栏
- enableSticky: function () {
- this.enable(!0)
- },
- // 初始化导航栏
- init: function (n) {
- n(document);
- var e = this;
- this.navBar = n("div.wy-side-scroll:first"),
- this.win = n(window),
- n(document).on("click", "[data-toggle='wy-nav-top']", (function () {
- n("[data-toggle='wy-nav-shift']").toggleClass("shift"),
- n("[data-toggle='rst-versions']").toggleClass("shift")
- })).on("click", ".wy-menu-vertical .current ul li a", (function () {
- var t = n(this);
- n("[data-toggle='wy-nav-shift']").removeClass("shift"),
- n("[data-toggle='rst-versions']").toggleClass("shift"),
- e.toggleCurrent(t),
- e.hashChange()
- })).on("click", "[data-toggle='rst-current-version']", (function () {
- n("[data-toggle='rst-versions']").toggleClass("shift-up")
- })),
- n("table.docutils:not(.field-list,.footnote,.citation)").wrap(""),
- n("table.docutils.footnote").wrap(""),
- n("table.docutils.citation").wrap(""),
- n(".wy-menu-vertical ul").not(".simple").siblings("a").each((function () {
- var t = n(this);
- expand = n(''),
- expand.on("click", (function (n) {
- return e.toggleCurrent(t),
- n.stopPropagation(),
- !1
- })),
- t.prepend(expand)
- }))
- },
- // 重置导航栏状态
- reset: function () {
- var n = encodeURI(window.location.hash) || "#";
- try {
- var e = $(".wy-menu-vertical"),
- t = e.find('[href="' + n + '"]');
- if (0 === t.length) {
- var i = $('.document [id="' + n.substring(1) + '"]').closest("div.section");
- 0 === (t = e.find('[href="#' + i.attr("id") + '"]')).length && (t = e.find('[href="#"]'))
- }
- if (t.length > 0) {
- $(".wy-menu-vertical .current").removeClass("current").attr("aria-expanded", "false"),
- t.addClass("current").attr("aria-expanded", "true"),
- t.closest("li.toctree-l1").parent().addClass("current").attr("aria-expanded", "true");
- for (let n = 1; n <= 10; n++)
- t.closest("li.toctree-l" + n).addClass("current").attr("aria-expanded", "true");
- t[0].scrollIntoView()
- }
- } catch (n) {
- console.log("Error expanding nav for anchor", n)
- }
- },
- // 滚动事件处理
- onScroll: function () {
- this.winScroll = !1;
- var n = this.win.scrollTop(),
- e = n + this.winHeight,
- t = this.navBar.scrollTop() + (n - this.winPosition);
- n < 0 || e > this.docHeight || (this.navBar.scrollTop(t),
- this.winPosition = n)
- },
- // 窗口大小变化事件处理
- onResize: function () {
- this.winResize = !1,
- this.winHeight = this.win.height(),
- this.docHeight = $(document).height()
- },
- // hash变化事件处理
- hashChange: function () {
- this.linkScroll = !0,
- this.win.one("hashchange", (function () {
- this.linkScroll = !1
- }))
- },
- // 切换当前导航项
- toggleCurrent: function (n) {
- var e = n.closest("li");
- // 20201030 a
- e.siblings("li.current").removeClass("current").attr("aria-expanded", "false"),
- e.siblings().find("li.current").removeClass("current").attr("aria-expanded", "false");
- var t = e.find("> ul li");
- t.length && (t.removeClass("current").attr("aria-expanded", "false"),
- e.toggleClass("current").attr("aria-expanded", (function (n, e) {
- return "true" == e ? "false" : "true"
- })))
- }
- },
- "undefined" != typeof window && (window.SphinxRtdTheme = {
- Navigation: n.exports.ThemeNav,
- StickyNav: n.exports.ThemeNav
- }),
- // 实现跨浏览器的requestAnimationFrame和cancelAnimationFrame方法
- function () {
- for (var n = 0, e = ["ms", "moz", "webkit", "o"], t = 0; t < e.length && !window.requestAnimationFrame; ++t)
- window.requestAnimationFrame = window[e[t] + "RequestAnimationFrame"],
- window.cancelAnimationFrame = window[e[t] + "CancelAnimationFrame"] || window[e[t] + "CancelRequestAnimationFrame"];
- window.requestAnimationFrame || (window.requestAnimationFrame = function (e, t) {
- var i = (new Date).getTime(),
- o = Math.max(0, 16 - (i - n)),
- r = window.setTimeout((function () {
- e(i + o)
- }), o);
- return n = i + o,
- r
- }),
- window.cancelAnimationFrame || (window.cancelAnimationFrame = function (n) {
- clearTimeout(n)
- })
- }()
- }).call(window)
- },
- function (n, e) {
- // 导出jQuery对象
- n.exports = jQuery
- },
- function (n, e, t) {
- // 未定义的模块体
- }
-]);
-
diff --git a/docs/source/_static/web_html_logo.png b/docs/source/_static/web_html_logo.png
deleted file mode 100755
index edf4b80f..00000000
Binary files a/docs/source/_static/web_html_logo.png and /dev/null differ
diff --git a/docs/source/_templates/disable-layout.html b/docs/source/_templates/disable-layout.html
deleted file mode 100755
index 1ff02ee7..00000000
--- a/docs/source/_templates/disable-layout.html
+++ /dev/null
@@ -1,292 +0,0 @@
-{# TEMPLATE VAR SETTINGS #}
-{%- set url_root = pathto('', 1) %}
-{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
-{%- if not embedded and docstitle %}
-{%- set titlesuffix = " — "|safe + docstitle|e %}
-{%- else %}
-{%- set titlesuffix = "" %}
-{%- endif %}
-{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
-{%- set sphinx_writer = 'writer-html5' if html5_doctype else 'writer-html4' -%}
-
-{# Build sphinx_version_info tuple from sphinx_version string in pure Jinja #}
-{%- set (_ver_major, _ver_minor) = (sphinx_version.split('.') | list)[:2] | map('int') -%}
-{%- set sphinx_version_info = (_ver_major, _ver_minor, -1) -%}
-
-
-= (7, 2) %} data-content_root="{{
-content_root }}"{% endif %}>
-
-
-
- {{- metatags }}
-
- {%- block htmltitle %}
- {{ title|striptags|e }}{{ titlesuffix }}
- {%- endblock -%}
-
- {#- CSS #}
- {%- if sphinx_version_info
- < (4, 0) -%}
-
- {%- endif %}
- {%- for css_file in css_files %}
- {%- if css_file|attr("filename") %}
- {{ css_tag(css_file) }}
- {%- else %}
-
- {%- endif %}
- {%- endfor %}
-
- {# "extra_css_files" is a theme option and it's always a string #}
- {%- for css_file in extra_css_files %}
-
- {%- endfor -%}
-
- {#- FAVICON
- favicon_url is the only context var necessary since Sphinx 4.
- In Sphinx
- <4, we use favicon but need to prepend path info. #} {%- set _favicon_url=favicon_url | default(pathto('_static/' +
- (favicon or "" ), 1)) %} {%- if favicon_url or favicon %}
- {%- endif %}
-
- {#- CANONICAL URL (deprecated) #}
- {%- if theme_canonical_url and not pageurl %}
-
- {%- endif -%}
-
- {#- CANONICAL URL #}
- {%- if pageurl %}
-
- {%- endif -%}
-
- {#- JAVASCRIPTS #}
- {%- block scripts %}
-
- {%- if not embedded %}
- {# XXX Sphinx 1.8.0 made this an external js-file, quick fix until we refactor the template to inherert more blocks
- directly from sphinx #}
- {%- if sphinx_version_info >= (1, 8) -%}
- {%- if sphinx_version_info < (4, 0) -%}
- {%- endif -%}
- {%- for scriptfile in script_files %}
- {{ js_tag(scriptfile) }}
- {%- endfor %}
- {%- else %}
-
- {%- for scriptfile in script_files %}
-
- {%- endfor %}
- {%- endif %}
-
-
- {#- OPENSEARCH #}
- {%- if use_opensearch %}
-
- {%- endif %}
- {%- endif %}
- {%- endblock %}
-
- {%- block linktags %}
- {%- if hasdoc('about') %}
-
- {%- endif %}
- {%- if hasdoc('genindex') %}
-
- {%- endif %}
- {%- if hasdoc('search') %}
-
- {%- endif %}
- {%- if hasdoc('copyright') %}
-
- {%- endif %}
- {%- if next %}
-
- {%- endif %}
- {%- if prev %}
-
- {%- endif %}
- {%- endblock %}
- {%- block extrahead %} {% endblock %}
-
-
-
-
- {%- block extrabody %} {% endblock %}
-
- {#- SIDE NAV, TOGGLES ON MOBILE #}
-
-
-
-
- {#- MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
- {#- Translators: This is an ARIA section label for the navigation menu that is visible when viewing the page
- on mobile devices -#}
-
-
-