update doc

orbbec · Jan 20, 2025 · 4954b94 · 4954b94
1 parent 075c6b7
commit 4954b94
Show file tree

Hide file tree

Showing 127 changed files with 12,868 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -20,43 +20,12 @@ The v2-main branch, C# Wrapper is based the open source version of [Orbbec SDK v
 | Femto Mega        | 1.1.7/1.2.7                  |
 
 
-# Compile and run sample
-Here, it is assumed that you have installed Cmake correctly. If you have not installed Cmake, you can refer to the Cmake official website for installation.
-- Open Cmake, set the source code path, and set the “build” folder as the path for generating binary files, as shown in the following figure.
-
-- First, click Configure, then select x64 in the dialog box that appears, and finally click Finish.
-![compile-1](image/compile-1.png)
-
-- Click “Generate”, as shown below:
-![compile-2](image/compile-2.png)
-
-- Use the file explorer to directly start the Visual Studio project in the build directory, as shown in the following figure:
-![compile-3](image/compile-3.png)
-
-- Open the project, as shown below, First, select Release, then choose ALL BUILD to compile, and finally select INSTALL.
-![compile-4](image/compile-4.png)
-
-- The compiled sample is located in the build/install/bin directory. 
-![compile-5](image/compile-5.png)
-- Click on 0.basic.quick_start.exe, and the running result is as follows:
-![compile-6](image/compile-6.png)
-
-# Sample Features
-| Example                | Description              |      level              |
-| --------------------- | ------------------------ |----------------|
-| 0.basic.quick_start | Quickly use the camera to capture color and depth video streams.|  ⭐   |
-| 1.stream.color | Displays the color stream from the camera.|    ⭐   |
-| 1.stream.depth | Displays the depth stream from the camera.|    ⭐   |
-| 1.stream.imu | Demonstrates how to read IMU data.|   ⭐   |
-| 1.stream.infrared | Displays the infrared stream from the camera.|   ⭐   |
-| 1.stream.multi_streams | Use SDK to obtain multiple camera data streams and output them.|      ⭐   |
-| 2.device.control | The SDK can be used to modify camera-related parameters, including laser switch, laser level intensity, white balance switch, etc.|   ⭐⭐  |
-| 2.device.firmware_update | This sample demonstrates how to read a firmware file to perform firmware upgrades on the device.|   ⭐⭐    |
-| 2.device.hot_plugin | Demonstrates how to detect hot plug events.| ⭐⭐    |
-| 3.advanced.coordinate_transform | Use the SDK interface to transform different coordinate systems.| ⭐⭐⭐    |
-| 3.advanced.hw_d2c_align | Demonstrates how to use hardware D2C.|  ⭐⭐⭐    |
-| 3.advanced.multi_devices | Demonstrates how to use multiple devices.| ⭐⭐⭐    | 
-| 3.advanced.point_cloud | Demonstrates how to save the point cloud to disk using a point cloud filter.| ⭐⭐⭐    |
-| 3.advanced.post_processing | Demonstrates how to use post-processing filters.| ⭐⭐⭐    |
+# Documentation
+
+For compilation and API reference, please refer to [UserGuide](https://orbbec.github.io/OrbbecSDK_CSharp/index.html) documentation.
+
+# License
+This project is licensed under the Apache License 2.0.
+
                                                                                
 
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 45773a445e0cde04ee9f0497f3595d1a
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.html b/docs/README.html
diff --git a/docs/_images/compile-1.png b/docs/_images/compile-1.png
diff --git a/docs/_images/compile-10.png b/docs/_images/compile-10.png
diff --git a/docs/_images/compile-11.png b/docs/_images/compile-11.png
diff --git a/docs/_images/compile-2.png b/docs/_images/compile-2.png
diff --git a/docs/_images/compile-3.png b/docs/_images/compile-3.png
diff --git a/docs/_images/compile-4.png b/docs/_images/compile-4.png
diff --git a/docs/_images/compile-5.png b/docs/_images/compile-5.png
diff --git a/docs/_images/compile-6.png b/docs/_images/compile-6.png
diff --git a/docs/_images/compile-7.png b/docs/_images/compile-7.png
diff --git a/docs/_images/compile-8.png b/docs/_images/compile-8.png
diff --git a/docs/_images/compile-9.png b/docs/_images/compile-9.png
diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt
@@ -0,0 +1,92 @@
+# Docs应用文档
+
+**编译：**
+
+```bash
+cd docs
+./autobuild.sh all
+
+```
+
+**打开文档：**
+
+```bash
+cd docs
+./autobuild.sh run
+
+```
+
+或
+
+进入_html目录，手动点击index.html打开
+
+# Docs应用文档详细说明
+
+**采用方式：**
+
+1、文档格式 markdown
+
+2、文档转换工具 Sphinx
+
+3、托管 github
+
+<br>
+
+# gitlab：
+
+本项目源码地址： https://code.orbbec.com.cn/OrbbecSDK/pyorbbecsdk
+
+# github （待上线）
+
+本项目源码地址 ：  待上线
+本应用文档阅读链接 ： 待上线
+
+<br>
+
+# 文档编写规范
+
+1、框图、软件框架建议原则上采用processon、visio工具绘图，目的是为了保持风格统一（特殊图除外）
+
+2、采用标准markdown格式，可使用vscode的Editor插件编辑
+
+<br>
+
+# 编译环境
+
+pip3 install sphinx
+
+pip3 install recommonmark
+
+pip3 install sphinx_markdown_tables
+
+pip3 install sphinx_rtd_theme
+
+pip3 install sphinx_book_theme
+
+# 编译
+
+- 执行编译脚本 ./autobuild 编译（推荐，该脚本编译后会打包docs文档及渲染设置）。 也支持sphinx原生编译指令make html
+- 打开docs/index.html查看效果
+
+<br>
+
+# 提交
+
+git add 、git commit 添加注释、git push提交代码
+
+提交完后，务必要上线网页打开检查一下，检查网页效果无误
+
+<br>
+
+# 定制化部分
+
+说明：定制化的配置都在**conf.py**中设置。也需要安装一些支持库
+
+1. 更改样式主题。我这里以 `sphinx_rtd_theme`为例子，其他主题可自行百度。
+
+* 安装 `sphinx_rtd_theme`:    ` pip install sphinx_rtd_theme`
+
+2. 安装markdown语法支持插件：`pip install myst-parser`
+3. 安装支持mermaid渲染插件: `pip install sphinxcontrib.mermaid`
+4. 安装代码块一键复制按钮插件：`pip install sphinx_copybutton`
+5. 可以使用vscode 编辑markdown文件文档，推荐安装markdown预览编辑插件
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -0,0 +1,19 @@
+.. [奥比中光]OOrbbec SDK C# wrapper v2 User Guide 应用文档.用户手册
+.. 这一页是目录树
+..     :titlesonly:
+
+
+
+
+OrbbecSDK v2 C# Wrapper User's Guide
+======================================================
+
+
+.. toctree::
+    :maxdepth: 3  
+    :numbered:
+
+    source/1_overview/overview.rst
+    source/2_installation/installation.rst
+    source/4_Application_Guide/Application_Guide.rst
+    source/license.md
diff --git a/docs/_sources/source/1_overview/Introduction.md.txt b/docs/_sources/source/1_overview/Introduction.md.txt
@@ -0,0 +1,24 @@
+# Introduction
+
+This C# wrapper serves as an interface for the Orbbec SDK, offering a streamlined and user-friendly access point to the Orbbec camera functionality. It enables essential operations including the capture of depth and color images, as well as the generation of point clouds.
+
+Regarding the versioning of the C# wrapper, the 'v2-main' branch corresponds to the open source [Orbbec SDK v2](https://github.com/orbbec/OrbbecSDK_v2), whereas the 'main' branch C# wrapper corresponds to the close source [Orbbec SDK v1](https://github.com/orbbec/OrbbecSDK).
+
+*   Obtain Depth, IR, and Color data streams.
+
+*   Obtain IMU data streams.
+
+*   Hardware D2C, Software D2C, and Software C2D.
+
+*   Obtain Depth point cloud and RGBD point cloud.
+
+*   Obtain multiple devices data .
+
+*   Coordinate transformations between different coordinate systems.
+
+*   Post-processing filters and HDR merge functionality (supported by the Gemini 330 series).
+
+*   Presets (supported by Gemini 330 series).
+
+*   Update Firmware.
+
diff --git a/docs/_sources/source/1_overview/Support_Hardware_Products.md.txt b/docs/_sources/source/1_overview/Support_Hardware_Products.md.txt
@@ -0,0 +1,15 @@
+## Support Hardware Products
+
+```markdown
+| **Products List** | **Minimal Firmware Version** |
+|-------------------|------------------------------|
+| Gemini 330        | 1.2.20                       |
+| Gemini 330L       | 1.2.20                       |
+| Gemini 335        | 1.2.20                       |
+| Gemini 335L       | 1.2.20                       |
+| Gemini 336        | 1.2.20                       |
+| Gemini 336L       | 1.2.20                       |
+| Femto Bolt        | 1.0.6/1.0.9                  |
+| Femto Mega        | 1.1.7/1.2.7                  |
+
+```
diff --git a/docs/_sources/source/1_overview/Support_platform.md.txt b/docs/_sources/source/1_overview/Support_platform.md.txt
@@ -0,0 +1,3 @@
+## Support Platforms
+
+Windows: Windows 10 (x64)
diff --git a/docs/_sources/source/1_overview/overview.rst.txt b/docs/_sources/source/1_overview/overview.rst.txt
@@ -0,0 +1,24 @@
+.. 这一页是模块目录树
+..     :titlesonly:
+
+
+
+
+Overview
+======================================================
+
+======================================================
+
+.. toctree::
+    :maxdepth: 2
+    :caption: This Section Covers:
+
+    Introduction.md
+    Support_platform.md
+    Support_Hardware_Products.md
+
+
+
+
+
+---------------------
diff --git a/docs/_sources/source/2_installation/Compilation.md.txt b/docs/_sources/source/2_installation/Compilation.md.txt
@@ -0,0 +1,37 @@
+# Windows C# SDK Compilation and Installation
+
+Here, it is assumed that you have installed Cmake correctly. If you have not installed Cmake,you can refer to the Cmake official website for installation.
+
+2.1  Open Cmake, set the source code path, and set the “build” folder as the path for generating binary files, as shown in the following figure.
+
+2.2 First, click Configure, then select x64 in the dialog box that appears, and finally click Finish.
+
+![compile-1.png](../image/compile-1.png)
+
+2.3 Click “Generate”, as shown below:
+
+![compile-2.png](../image/compile-2.png)
+
+2.4 Use the file explorer to directly start the Visual Studio project in the build directory, as shown in the following figure:
+
+![compile-3.png](../image/compile-3.png)
+
+2.5 Open the project, as shown below, First, select Release, then choose ALL BUILD to compile, and finally select INSTALL.
+
+![compile-4.png](../image/compile-4.png)
+
+2.6 The compiled sample is located in the build/install/bin directory. 
+
+![compile-5.png](../image/compile-5.png)
+
+2.7 Click on 0.basic.quick_start.exe, and the running result is as follows
+
+![compile-6.png](../image/compile-6.png)
+
+2.8 You can also use a script to generate the project project file as follows,The name of the script is build.bat, put it in the same directory as CMakeLists.txt.
+
+![compile-7.png](../image/compile-7.png)
+
+Double click build.bat will create a new build folder, the generated project files will be placed in the build folder, so that you can avoid the project files and source code together!
+
+![compile-8.png](../image/compile-8.png)
diff --git a/docs/_sources/source/2_installation/installation.rst.txt b/docs/_sources/source/2_installation/installation.rst.txt
@@ -0,0 +1,23 @@
+.. 这一页是模块目录树
+
+
+
+
+
+Installation
+======================================================
+
+
+This section offers a comprehensive guide to configuring the C# wrapper. It encompasses the preparation of the development environment, the installation of necessary dependencies, and the compilation process. This document is crafted to facilitate a seamless setup experience, ensuring efficient development and deployment of your applications.
+
+======================================================
+
+
+
+.. toctree::
+    :maxdepth: 2
+    :caption: This Section Covers:
+
+    Compilation.md
+
+
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## Support Platforms

		Windows: Windows 10 (x64)