add Documents

This commit is contained in:
obyalian
2025-09-12 10:42:29 +08:00
parent 2d2a4e0ec6
commit 52bff11d03
54 changed files with 3884 additions and 65 deletions
+92
View File
@@ -0,0 +1,92 @@
## QuickStarts
### 3.1. Introduction
This section provides a quick start to using the Orbbec ROS 2 wrapper.
You will learn how to:
* Launch a camera node.
* Visualize depth/color streams in **RViz2**.
* Interact with topics and services using **ROS 2 CLI tools**.
---
### 3.2. Build your First Camera Application
#### Step 1: Source ROS 2 and Workspace
Make sure ROS 2 and your workspace environment are sourced:
```bash
source /opt/ros/$ROS_DISTRO/setup.bash
source ~/ros2_ws/install/setup.bash
```
#### Step 2: Launch the Camera Node
- On terminal 1
```bash
. ./install/setup.bash
ros2 run orbbec_camera list_devices_node #Check if the camera is connected
ros2 launch orbbec_camera gemini_330_series.launch.py # Or other launch file, see below table
```
If you have multiple cameras connected, you can specify the **serial number**:
```bash
ros2 launch orbbec_camera gemini_330_series.launch.py serial_number:=<YourCameraSN>
```
#### Step 3: Visualize in RViz2
Launch RViz2 and load the default config:
- On terminal 2
```bash
rviz2
```
* Add an **Image** display, set topic to `/camera/color/image_raw`.
* Add another **Image** display for `/camera/depth/image_raw`.
* Optionally, add a **PointCloud2** display for `/camera/depth/points`.
You should now see the color stream, depth stream, and 3D point cloud in RViz2.
---
### 3.3. Sample Features
After the node is running, try some ROS 2 CLI commands:
#### 3.3.1. List available topics / services/ parameters
```bash
ros2 topic list
ros2 service list
ros2 param list
```
#### 3.3.2. Echo a topic
View depth camera data:
```bash
ros2 topic echo /camera/depth/camera_info
```
#### 3.3.3. Call a service
For example, get device Information:
```bash
ros2 service call /camera/get_device_info orbbec_camera_msgs/srv/GetDeviceInfo '{}'
```
#### 3.3.4. Record with rosbag2
```bash
ros2 bag record /camera/color/image_raw /camera/depth/image_raw
```
+10
View File
@@ -0,0 +1,10 @@
Quickstarts
======================================================
This chapter provides quick start guides for the SDK, allowing users to run basic example programs quickly.
.. toctree::
:maxdepth: 2
quickstart.md