Update document

This commit is contained in:
obyalian
2025-09-12 13:54:52 +08:00
parent 52bff11d03
commit a20f9e5a78
24 changed files with 30 additions and 29 deletions
+2 -2
View File
@@ -35,5 +35,5 @@ for different models within the same series. Differences in USB standards, such
## Support Platforms
- Linux: 18.04/20.04/22.04/24.04 (x64)
- Arm64: Ubuntu18.04/20.04/22.04
- Linux x64: tested on Ubuntu 20.04
- Linux ARM64: tested on NVIDIA Jetson AGX Orin , NVIDIA Jetson Orin NX , NVIDIA Jetson Orin Nano , NVIDIA Jetson AGX Xavier , NVIDIA Jetson Xavier NX
+9 -10
View File
@@ -23,7 +23,6 @@ This section introduces the Orbbec SDK in C++. Its architecture and concepts are
| 15 | MetaData | Frame metadata is a set of parameters (or attributes) that provide a snapshot of the sensor configuration and/or system state present during the frames generation. |
| 16 | HDR | High Dynamic Range (HDR) imaging allows imaging systems to capture images in extremely dark and bright scenes alike. We propose a software solution running on the host CPU to implement this feature. It utilizes data from two consecutive frames and directly synthesizes these two depth images, thereby enhances the dynamic range of 16-bit depth images. |
| 17 | LDP | Laser close-range protection |
| | | |
## Orbbec SDK v2 Architecture Overview
@@ -57,47 +56,47 @@ The driver implementation of each platform.
## SDK Concept Overview
- Context
Context which provides a set of settings includes settings such as device state change callbacks, log levels, and more. The Context can access multiple devices.
- Device
One actual hardware device corresponds to one Device object, which is used to obtain relevant information of the device and control its attributes.
- Pipeline
The HighLevel corresponding object encapsulates the interface for quick access to the SDK. It has simple functions that allow users to quickly get started and use the SDK.
- Config
Provides configuration for enabling data streams, alignment modes, and frame aggregation modes, It is used to control the behavior of the data output.
- StreamProfile
Stream configuration that defines parameters such as resolution, frame rate, and encoding format, It also provides management of camera parameters.
- Frame
Represents a frame of data in the Stream, and also contains relevant information about that frame of data, such as timestamp, type, etc.
- Filter
It mainly refers to some algorithmic processing modules for the composite stream FrameSet, such as point cloud algorithm processing.
- Record
Recording functionality that captures data streams and saves them as files for later analysis or playback.
- Playback
Playback functionality that plays recorded files and supports control over playback speed and other related parameters.
@@ -1,6 +1,6 @@
### 2.2. Build from Source
### Build from Source
#### 2.2.1. Environment
#### Environment
Install ROS 2 according to the official guide:
@@ -19,7 +19,7 @@ Create a `colcon` workspace:
mkdir -p ~/ros2_ws/src
```
#### 2.2.2. Linux ROS2 Wrapper Compilation
#### Linux ROS2 Wrapper Compilation
Clone source and checkout `v2-main` branch:
@@ -1,4 +1,4 @@
## 2.1. Registration script (required)
## Registration script (required)
To allow the Orbbec cameras to be recognized correctly on Linux, install the udev rules:
+7 -7
View File
@@ -1,6 +1,6 @@
## QuickStarts
### 3.1. Introduction
### Introduction
This section provides a quick start to using the Orbbec ROS 2 wrapper.
You will learn how to:
@@ -11,7 +11,7 @@ You will learn how to:
---
### 3.2. Build your First Camera Application
### Build your First Camera Application
#### Step 1: Source ROS 2 and Workspace
@@ -56,11 +56,11 @@ You should now see the color stream, depth stream, and 3D point cloud in RViz2.
---
### 3.3. Sample Features
### Sample Features
After the node is running, try some ROS 2 CLI commands:
#### 3.3.1. List available topics / services/ parameters
#### List available topics / services/ parameters
```bash
ros2 topic list
@@ -68,7 +68,7 @@ ros2 service list
ros2 param list
```
#### 3.3.2. Echo a topic
#### Echo a topic
View depth camera data:
@@ -76,7 +76,7 @@ View depth camera data:
ros2 topic echo /camera/depth/camera_info
```
#### 3.3.3. Call a service
#### Call a service
For example, get device Information:
@@ -84,7 +84,7 @@ For example, get device Information:
ros2 service call /camera/get_device_info orbbec_camera_msgs/srv/GetDeviceInfo '{}'
```
#### 3.3.4. Record with rosbag2
#### Record with rosbag2
```bash
ros2 bag record /camera/color/image_raw /camera/depth/image_raw
@@ -139,21 +139,23 @@ The following are the launch parameters available:
#### Network Cameras
* **`enumerate_net_device`**
* Enable automatically enumerate network devices. Used for [net camera](../orbbec_camera/examples/net_camera/README.MD).
* Enable automatically enumerate network devices.
* **`net_device_ip`** / **`net_device_port`**
* Set net device's IP address and port (Usually `8090`). Used for [net camera](../orbbec_camera/examples/net_camera/README.MD).
* Set net device's IP address and port (Usually `8090`).
> Used for [net camera](../5_advanced_guide/net_camera.md).
#### Device-Specific
* **`device_preset`**
* The default value is `Default`. Only the G330 series is supported. For more information, refer to the [G330 documentation](https://www.orbbec.com/docs/g330-use-depth-presets/). The value should be one of the preset names listed [in the table](./predefined_presets.md).
* The default value is `Default`. Only the G330 series is supported. For more information, refer to the [G330 documentation](https://www.orbbec.com/docs/g330-use-depth-presets/). The value should be one of the preset names listed [in the table](../5_advanced_guide/predefined_presets.md).
* **`enable_gmsl_trigger`** / **`gmsl_trigger_fps`**
* Enable the gmsl trigger out signal / set gmsl trigger fps. Used for [gmsl camera](../orbbec_camera/examples/gmsl_camera/README.MD).
* Enable the gmsl trigger out signal / set gmsl trigger fps. Used for [gmsl camera](../5_advanced_guide/gmsl_camera.md).
#### Disparity
* **`disparity_to_depth_mode`**
* `HW`: use hardware disparity to depth conversion. `SW`: use software disparity to depth conversion.
* **`disparity_range_mode`**, **`disparity_search_offset`**, **`disparity_offset_config`**
* Parameters for disparity search offset. Used for [disparity search offset](../orbbec_camera/examples/disparity_search_offset/README.MD).
* Parameters for disparity search offset. Used for [disparity search offset](../5_advanced_guide/disparity_search_offset.md).
#### Interleave AE Mode
* **`interleave_ae_mode`**
@@ -162,7 +164,7 @@ The following are the launch parameters available:
* Parameters to control interleave frame mode.
* **`[hdr|laser]_index[0|1]_[...]`**
* In interleave frame mode, set the 0th and 1st frame parameters of hdr or laser interleaving frames.
* *All interleave parameters are used for [interleave ae mode](../orbbec_camera/examples/interleave_ae_mode/README.MD).*
* *All interleave parameters are used for [interleave ae mode](../5_advanced_guide/interleave_ae_mode.md).*
### Basic & General Parameters
Binary file not shown.

After

Width:  |  Height:  |  Size: 208 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 313 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 86 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.7 KiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.4 KiB

BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 193 KiB