Skip to content

Commit 0c6c2b9

Browse files
zhonghong322zhonghong322
committed
Update Quick starts Doc
1 parent e62475d commit 0c6c2b9

File tree

17 files changed

+341
-49
lines changed

17 files changed

+341
-49
lines changed

‎OrbbecSDKv2_API_User_Guide/README.html‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,21 @@
6161
</ul>
6262
</li>
6363
<li class="toctree-l1"><a class="reference internal" href="source/2_QuickStarts/QuickStarts.html">2. QuickStarts</a><ul>
64-
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html">2.1. Quick Start on Windows Platform</a></li>
65-
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#quick-start-on-linux-platform">2.2. Quick Start on Linux Platform</a></li>
64+
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html">2.1. Quick Start on Windows Platform</a><ul>
65+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#metadata-registration">2.1.1. Metadata registration</a></li>
66+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#build-sdk-package-zip">2.1.2. build SDK package(.zip)</a></li>
67+
</ul>
68+
</li>
69+
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#quick-start-on-linux-platform">2.2. Quick Start on Linux Platform</a><ul>
70+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#install-udev-rules-script">2.2.1. install udev rules script</a></li>
71+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#id1">2.2.2. build SDK package(.zip)</a></li>
72+
</ul>
73+
</li>
74+
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#how-to-use-install-package">2.3. How to Use install package</a><ul>
75+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#install-via-deb-package">2.3.1. Install via .deb Package</a></li>
76+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#install-via-exe-package">2.3.2. Install via .exe Package</a></li>
77+
</ul>
78+
</li>
6679
</ul>
6780
</li>
6881
<li class="toctree-l1"><a class="reference internal" href="source/3_Application_Guide/Application_Guide.html">3. Application Guide</a><ul>
@@ -291,7 +304,7 @@ <h1>定制化部分<a class="headerlink" href="#id6" title="Link to this heading
291304

292305
<div role="contentinfo">
293306
<p>&#169; Copyright 2024-2025,Orbbec Inc. All Rights Reserved.
294-
<span class="lastupdated">Last updated on 2025-07-14 20:20:42.
307+
<span class="lastupdated">Last updated on 2025-07-15 21:49:18.
295308
</span></p>
296309
</div>
297310

‎OrbbecSDKv2_API_User_Guide/_sources/source/2_QuickStarts/QuickStart.md.txt‎

Lines changed: 45 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11

22
# Quick Start on Windows Platform
3+
## Metadata registration
4+
For windows,you need to register the metadata associated with frames (this includes things like timestamps and other information about the video frame).
35

6+
Metadata registration follow this:[/scripts/env_setup/obsensor_metadata_win10.md](https://github.com/orbbec/OrbbecSDK_v2/blob/main/scripts/env_setup/obsensor_metadata_win10.md)
7+
8+
**Notes: If the metadata is not registered, the device timestamp will be abnormal, thereby affecting the SDK's internal frame synchronization functionality.**
9+
10+
## build SDK package(.zip)
411
This section demonstrates how to quickly start and build SDK package on the Windows platform. The SDK version used here is [v2.4.3](https://github.com/orbbec/OrbbecSDK_v2/releases/tag/v2.4.3).
512

613
- First, extract the downloaded Orbbec SDK package, then navigate to the examples directory in the extracted folder and use CMake to compile the project.
@@ -33,6 +40,20 @@ The ob_quick_start sample captures and displays data streams as shown below:
3340

3441
# Quick Start on Linux Platform
3542

43+
## install udev rules script
44+
Please install it using the following commands:[/scripts/env_setup/install_udev_rules.sh](https://github.com/orbbec/OrbbecSDK_v2/blob/main/scripts/env_setup/install_udev_rules.sh)
45+
46+
~~~
47+
cd OrbbecSDK_v2/scripts/env_setup
48+
sudo chmod +x ./install_udev_rules.sh
49+
sudo ./install_udev_rules.sh
50+
sudo udevadm control --reload-rules && udevadm trigger
51+
~~~
52+
53+
**Notes: If this script is not executed, open the device will fail due to permission issues. You need to run the sample with sudo (administrator privileges).**
54+
55+
## build SDK package(.zip)
56+
3657
* Build Requirements：
3758

3859
* Operating System：Ubuntu 18.04 or later
@@ -52,7 +73,6 @@ This script ensures that the correct libusb driver is loaded.
5273
After installing the udev script, you can run the samples without sudo privileges.
5374

5475
The installation process is shown below:
55-
5676

5777
![image.png](../Images/Linux_Compile_1.png)
5878

@@ -63,5 +83,28 @@ The installation process is shown below:
6383

6484
- Navigate to the bin directory and run the ob_quick_start sample to capture data streams.
6585

66-
6786
![image.png](../Images/Linux_Quick_Start.png)
87+
88+
89+
# How to Use install package
90+
If you do not want to compile the Orbbec SDK, you can use the SDK installation package. Taking [v2.4.8](https://github.com/orbbec/OrbbecSDK_v2/releases/tag/v2.4.8) as an example, first download the corresponding installation package for your platform.
91+
92+
93+
The file OrbbecSDK_vx.x.x_win64.exe serves as the installation package for the Orbbec SDK and Orbbec Viewer tools on Windows.
94+
The file OrbbecSDK_vx.x.x_amd64.deb serves as the installation package for the Orbbec SDK and Orbbec Viewer tools on Linux x86_64, likes ubuntu.
95+
The file OrbbecSDK_vx.x.x_arm64.deb serves as the installation package for the Orbbec SDK and Orbbec Viewer tools on ARM64，likes NVIDIA Jetson AGX Orin , NVIDIA Jetson Orin NX , NVIDIA Jetson Orin Nano , NVIDIA Jetson AGX Xavier , NVIDIA Jetson Xavier NX.
96+
97+
## Install via .deb Package
98+
- On the Linux x64 (ubuntu) platform, install using the following command. (If you are using the Arm64 platform, please use OrbbecSDK_vx.x.x_arm64.deb)
99+
~~~
100+
sudo dpkg -i OrbbecSDK_v2.x.x_amd64.deb
101+
~~~
102+
- Check the entire package path of the Orbbec SDK using dpkg -L orbbecsdk, while the header files and library files of the Orbbec SDK will be installed in the /usr/local path.
103+
~~~
104+
dpkg -L orbbecsdk
105+
~~~
106+
- Run the Orbbec Viewer.
107+
sudo ./OrbbecViewer
108+
109+
## Install via .exe Package
110+
- On the windows platform, Double-click OrbbecSDK_vx.x.x_win64.exe directly to install, After installation is complete, run OrbbecViewer or the Orbbec SDK from the installation directory.

‎OrbbecSDKv2_API_User_Guide/_sources/source/2_QuickStarts/QuickStarts.rst.txt‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
QuickStarts
44
======================================================
55

6-
This section demonstrates how to quickly start and build the precompiled SDK package on windows and Linux platform. If you want to compile from the OrbbecSDK v2 source code, please refer to https://github.com/orbbec/OrbbecSDK_v2/blob/main/docs/tutorial/building_orbbec_sdk.md.
6+
This section demonstrates how to quickly start, include build the precompiled SDK package on windows and Linux platform, and how to use install package. If you want to compile from the OrbbecSDK v2 source code, please refer to https://github.com/orbbec/OrbbecSDK_v2/blob/main/docs/tutorial/building_orbbec_sdk.md.
77

88
======================================================
99

@@ -12,5 +12,4 @@ QuickStarts
1212
:caption: This Section Covers:
1313

1414

15-
1615
QuickStart.md

‎OrbbecSDKv2_API_User_Guide/genindex.html‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,21 @@
6060
</ul>
6161
</li>
6262
<li class="toctree-l1"><a class="reference internal" href="source/2_QuickStarts/QuickStarts.html">2. QuickStarts</a><ul>
63-
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html">2.1. Quick Start on Windows Platform</a></li>
64-
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#quick-start-on-linux-platform">2.2. Quick Start on Linux Platform</a></li>
63+
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html">2.1. Quick Start on Windows Platform</a><ul>
64+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#metadata-registration">2.1.1. Metadata registration</a></li>
65+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#build-sdk-package-zip">2.1.2. build SDK package(.zip)</a></li>
66+
</ul>
67+
</li>
68+
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#quick-start-on-linux-platform">2.2. Quick Start on Linux Platform</a><ul>
69+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#install-udev-rules-script">2.2.1. install udev rules script</a></li>
70+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#id1">2.2.2. build SDK package(.zip)</a></li>
71+
</ul>
72+
</li>
73+
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#how-to-use-install-package">2.3. How to Use install package</a><ul>
74+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#install-via-deb-package">2.3.1. Install via .deb Package</a></li>
75+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#install-via-exe-package">2.3.2. Install via .exe Package</a></li>
76+
</ul>
77+
</li>
6578
</ul>
6679
</li>
6780
<li class="toctree-l1"><a class="reference internal" href="source/3_Application_Guide/Application_Guide.html">3. Application Guide</a><ul>
@@ -223,7 +236,7 @@ <h1 id="index">Index</h1>
223236

224237
<div role="contentinfo">
225238
<p>&#169; Copyright 2024-2025,Orbbec Inc. All Rights Reserved.
226-
<span class="lastupdated">Last updated on 2025-07-14 20:20:42.
239+
<span class="lastupdated">Last updated on 2025-07-15 21:49:18.
227240
</span></p>
228241
</div>
229242

‎OrbbecSDKv2_API_User_Guide/index.html‎

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,21 @@
6262
</ul>
6363
</li>
6464
<li class="toctree-l1"><a class="reference internal" href="source/2_QuickStarts/QuickStarts.html">2. QuickStarts</a><ul>
65-
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html">2.1. Quick Start on Windows Platform</a></li>
66-
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#quick-start-on-linux-platform">2.2. Quick Start on Linux Platform</a></li>
65+
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html">2.1. Quick Start on Windows Platform</a><ul>
66+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#metadata-registration">2.1.1. Metadata registration</a></li>
67+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#build-sdk-package-zip">2.1.2. build SDK package(.zip)</a></li>
68+
</ul>
69+
</li>
70+
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#quick-start-on-linux-platform">2.2. Quick Start on Linux Platform</a><ul>
71+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#install-udev-rules-script">2.2.1. install udev rules script</a></li>
72+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#id1">2.2.2. build SDK package(.zip)</a></li>
73+
</ul>
74+
</li>
75+
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#how-to-use-install-package">2.3. How to Use install package</a><ul>
76+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#install-via-deb-package">2.3.1. Install via .deb Package</a></li>
77+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#install-via-exe-package">2.3.2. Install via .exe Package</a></li>
78+
</ul>
79+
</li>
6780
</ul>
6881
</li>
6982
<li class="toctree-l1"><a class="reference internal" href="source/3_Application_Guide/Application_Guide.html">3. Application Guide</a><ul>
@@ -232,8 +245,21 @@ <h1>Orbbec SDK V2 C++ API User Guide<a class="headerlink" href="#orbbec-sdk-v2-c
232245
</ul>
233246
</li>
234247
<li class="toctree-l1"><a class="reference internal" href="source/2_QuickStarts/QuickStarts.html">2. QuickStarts</a><ul>
235-
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html">2.1. Quick Start on Windows Platform</a></li>
236-
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#quick-start-on-linux-platform">2.2. Quick Start on Linux Platform</a></li>
248+
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html">2.1. Quick Start on Windows Platform</a><ul>
249+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#metadata-registration">2.1.1. Metadata registration</a></li>
250+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#build-sdk-package-zip">2.1.2. build SDK package(.zip)</a></li>
251+
</ul>
252+
</li>
253+
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#quick-start-on-linux-platform">2.2. Quick Start on Linux Platform</a><ul>
254+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#install-udev-rules-script">2.2.1. install udev rules script</a></li>
255+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#id1">2.2.2. build SDK package(.zip)</a></li>
256+
</ul>
257+
</li>
258+
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#how-to-use-install-package">2.3. How to Use install package</a><ul>
259+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#install-via-deb-package">2.3.1. Install via .deb Package</a></li>
260+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#install-via-exe-package">2.3.2. Install via .exe Package</a></li>
261+
</ul>
262+
</li>
237263
</ul>
238264
</li>
239265
<li class="toctree-l1"><a class="reference internal" href="source/3_Application_Guide/Application_Guide.html">3. Application Guide</a><ul>
@@ -356,7 +382,7 @@ <h1>Orbbec SDK V2 C++ API User Guide<a class="headerlink" href="#orbbec-sdk-v2-c
356382

357383
<div role="contentinfo">
358384
<p>&#169; Copyright 2024-2025,Orbbec Inc. All Rights Reserved.
359-
<span class="lastupdated">Last updated on 2025-07-14 20:20:42.
385+
<span class="lastupdated">Last updated on 2025-07-15 21:49:18.
360386
</span></p>
361387
</div>
362388

‎OrbbecSDKv2_API_User_Guide/objects.inv‎

145 Bytes
Binary file not shown.

‎OrbbecSDKv2_API_User_Guide/search.html‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,21 @@
6363
</ul>
6464
</li>
6565
<li class="toctree-l1"><a class="reference internal" href="source/2_QuickStarts/QuickStarts.html">2. QuickStarts</a><ul>
66-
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html">2.1. Quick Start on Windows Platform</a></li>
67-
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#quick-start-on-linux-platform">2.2. Quick Start on Linux Platform</a></li>
66+
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html">2.1. Quick Start on Windows Platform</a><ul>
67+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#metadata-registration">2.1.1. Metadata registration</a></li>
68+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#build-sdk-package-zip">2.1.2. build SDK package(.zip)</a></li>
69+
</ul>
70+
</li>
71+
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#quick-start-on-linux-platform">2.2. Quick Start on Linux Platform</a><ul>
72+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#install-udev-rules-script">2.2.1. install udev rules script</a></li>
73+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#id1">2.2.2. build SDK package(.zip)</a></li>
74+
</ul>
75+
</li>
76+
<li class="toctree-l2"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#how-to-use-install-package">2.3. How to Use install package</a><ul>
77+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#install-via-deb-package">2.3.1. Install via .deb Package</a></li>
78+
<li class="toctree-l3"><a class="reference internal" href="source/2_QuickStarts/QuickStart.html#install-via-exe-package">2.3.2. Install via .exe Package</a></li>
79+
</ul>
80+
</li>
6881
</ul>
6982
</li>
7083
<li class="toctree-l1"><a class="reference internal" href="source/3_Application_Guide/Application_Guide.html">3. Application Guide</a><ul>
@@ -231,7 +244,7 @@
231244

232245
<div role="contentinfo">
233246
<p>&#169; Copyright 2024-2025,Orbbec Inc. All Rights Reserved.
234-
<span class="lastupdated">Last updated on 2025-07-14 20:20:42.
247+
<span class="lastupdated">Last updated on 2025-07-15 21:49:18.
235248
</span></p>
236249
</div>
237250

‎OrbbecSDKv2_API_User_Guide/searchindex.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎OrbbecSDKv2_API_User_Guide/source/1_overview/EnvironmentSetup.html‎

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,21 @@
6363
</ul>
6464
</li>
6565
<li class="toctree-l1"><a class="reference internal" href="../2_QuickStarts/QuickStarts.html">2. QuickStarts</a><ul>
66-
<li class="toctree-l2"><a class="reference internal" href="../2_QuickStarts/QuickStart.html">2.1. Quick Start on Windows Platform</a></li>
67-
<li class="toctree-l2"><a class="reference internal" href="../2_QuickStarts/QuickStart.html#quick-start-on-linux-platform">2.2. Quick Start on Linux Platform</a></li>
66+
<li class="toctree-l2"><a class="reference internal" href="../2_QuickStarts/QuickStart.html">2.1. Quick Start on Windows Platform</a><ul>
67+
<li class="toctree-l3"><a class="reference internal" href="../2_QuickStarts/QuickStart.html#metadata-registration">2.1.1. Metadata registration</a></li>
68+
<li class="toctree-l3"><a class="reference internal" href="../2_QuickStarts/QuickStart.html#build-sdk-package-zip">2.1.2. build SDK package(.zip)</a></li>
69+
</ul>
70+
</li>
71+
<li class="toctree-l2"><a class="reference internal" href="../2_QuickStarts/QuickStart.html#quick-start-on-linux-platform">2.2. Quick Start on Linux Platform</a><ul>
72+
<li class="toctree-l3"><a class="reference internal" href="../2_QuickStarts/QuickStart.html#install-udev-rules-script">2.2.1. install udev rules script</a></li>
73+
<li class="toctree-l3"><a class="reference internal" href="../2_QuickStarts/QuickStart.html#id1">2.2.2. build SDK package(.zip)</a></li>
74+
</ul>
75+
</li>
76+
<li class="toctree-l2"><a class="reference internal" href="../2_QuickStarts/QuickStart.html#how-to-use-install-package">2.3. How to Use install package</a><ul>
77+
<li class="toctree-l3"><a class="reference internal" href="../2_QuickStarts/QuickStart.html#install-via-deb-package">2.3.1. Install via .deb Package</a></li>
78+
<li class="toctree-l3"><a class="reference internal" href="../2_QuickStarts/QuickStart.html#install-via-exe-package">2.3.2. Install via .exe Package</a></li>
79+
</ul>
80+
</li>
6881
</ul>
6982
</li>
7083
<li class="toctree-l1"><a class="reference internal" href="../3_Application_Guide/Application_Guide.html">3. Application Guide</a><ul>
@@ -248,7 +261,7 @@ <h2><span class="section-number">1.3.3. </span>Development Environment Configura
248261

249262
<div role="contentinfo">
250263
<p>&#169; Copyright 2024-2025,Orbbec Inc. All Rights Reserved.
251-
<span class="lastupdated">Last updated on 2025-07-14 20:20:42.
264+
<span class="lastupdated">Last updated on 2025-07-15 21:49:18.
252265
</span></p>
253266
</div>
254267

0 commit comments

Comments
 (0)