add Chinese Document

2026-10-04 20:17:47 +08:00 · 2025-10-19 16:20:38 +08:00
parent 5513cf2882
commit b7bc29ae1c
44 changed files with 2525 additions and 275 deletions
@@ -0,0 +1,46 @@
+# OrbbecViewer 快速入门
+
+> **注意：** 此 ROS 包的参数和功能与 **Orbbec Viewer** 保持一致；有关参数使用或设备型号支持的任何问题，请参考 Orbbec Viewer。
+
+## 下载
+
+**仓库链接：**[OrbbecViewer 下载](https://github.com/orbbec/OrbbecSDK_v2/releases)
+
+根据您的设备类型选择合适版本的 OrbbecViewer。
+
+![orbbecviewer](../image/orbbecviewer1.png)
+
+## 连接设备
+
+当 Orbbec Viewer 打开时，当前设备连接状态将显著地显示在应用程序窗口的左上角。此区域提供关于相机是否已连接并正常工作的即时反馈。
+
+![orbbecviewer](../image/orbbecviewer2.png)
+
+## 相机控制
+
+您可以使用窗口顶部的按钮快速查看图像，并在窗口左侧的相机面板中调整图像参数。
+
+![orbbecviewer](../image/orbbecviewer3.png)
+
+## 设备信息和固件升级
+
+点击窗口左下角的图标以查看当前相机信息并升级固件。
+
+![orbbecviewer](../image/orbbecviewer4.png)
+
+请参考下面的列表获取最新的相机固件。[更多信息请点击这里。](https://www.orbbec.com/docs/g330-explore-camera-functions-in-orbbec-viewer/)
+
+**仓库链接：**[固件下载](https://github.com/orbbec/OrbbecFirmware?tab=readme-ov-file#firmware-download)
+
+| **产品列表**       | **下载链接**                                                                                       | 最新版本   |
+| ------------------ | -------------------------------------------------------------------------------------------------- | ---------- |
+| Femto Bolt         | [Femto Bolt 固件](https://github.com/orbbec/OrbbecFirmware/releases/tag/Femto-Bolt-Firmware)      | v1.1.2     |
+| Femto Mega         | [Femto Mega 固件](https://github.com/orbbec/OrbbecFirmware/releases/tag/Femto-Mega-Firmware)      | v1.3.1     |
+| Gemini 2           | [Gemini 2 固件](https://github.com/orbbec/OrbbecFirmware/releases/tag/Gemini2-Firmware)           | v1.4.98    |
+| Gemini 2 L         | [Gemini 2L 固件](https://github.com/orbbec/OrbbecFirmware/releases/tag/Gemini2L-Firmware)         | v1.5.02    |
+| Femto Mega I       | [Femto Mega I 固件](https://github.com/orbbec/OrbbecFirmware/releases/tag/Femto-Mega-I-Firmware)  | v2.0.4     |
+| Gemini 330 系列    | [Gemini 330 系列固件](https://www.orbbec.com/docs/g330-firmware-release/?_gl=1)                   |            |
+| Gemini 215         | [Gemini 215](https://github.com/orbbec/OrbbecFirmware/releases/tag/Gemini215-Firmware)            | v1.0.9     |
+| Gemini 210         | [Gemini 210](https://github.com/orbbec/OrbbecFirmware/releases/tag/Gemini210-Firmware)            | v1.0.9     |
+| Gemini 435Le       | [Gemini 435Le](https://github.com/orbbec/OrbbecFirmware/releases/tag/Gemin435Le-Firmware)         | v1.3.2     |
+
@@ -0,0 +1,92 @@
+## ROS 包快速入门
+
+### 简介
+
+本节提供 Orbbec ROS 2 包装器的快速入门指南。
+您将学习如何：
+
+* 启动相机节点。
+* 在 **RViz2** 中可视化深度/彩色流。
+* 使用 **ROS 2 CLI 工具**与话题和服务交互。
+
+---
+
+### 构建您的第一个相机应用
+
+#### 步骤 1：配置 ROS 2 和工作空间环境
+
+确保已配置 ROS 2 和工作空间环境：
+
+```bash
+source /opt/ros/$ROS_DISTRO/setup.bash
+source ~/ros2_ws/install/setup.bash
+```
+
+#### 步骤 2：启动相机节点
+
+- 在终端 1 中
+
+```bash
+. ./install/setup.bash
+ros2 run orbbec_camera list_devices_node #检查相机是否已连接
+ros2 launch orbbec_camera gemini_330_series.launch.py # 或其他启动文件，见下表
+```
+
+如果您连接了多个相机，可以指定**序列号**：
+
+```bash
+ros2 launch orbbec_camera gemini_330_series.launch.py serial_number:=<您的相机序列号>
+```
+
+#### 步骤 3：在 RViz2 中可视化
+
+启动 RViz2 并加载默认配置：
+
+- 在终端 2 中
+
+```bash
+rviz2
+```
+
+* 添加一个 **Image** 显示，将话题设置为 `/camera/color/image_raw`。
+* 为 `/camera/depth/image_raw` 添加另一个 **Image** 显示。
+* 可选：为 `/camera/depth/points` 添加 **PointCloud2** 显示。
+
+现在您应该能在 RViz2 中看到彩色流、深度流和 3D 点云。
+
+---
+
+### 示例功能
+
+节点运行后，尝试一些 ROS 2 CLI 命令：
+
+#### 列出可用的话题/服务/参数
+
+```bash
+ros2 topic list
+ros2 service list
+ros2 param list
+```
+
+#### 回显话题
+
+查看深度相机数据：
+
+```bash
+ros2 topic echo /camera/depth/camera_info
+```
+
+#### 调用服务
+
+例如，获取设备信息：
+
+```bash
+ros2 service call /camera/get_device_info orbbec_camera_msgs/srv/GetDeviceInfo '{}'
+```
+
+#### 使用 rosbag2 录制
+
+```bash
+ros2 bag record /camera/color/image_raw /camera/depth/image_raw
+```
+
@@ -0,0 +1,11 @@
+快速开始
+======================================================
+
+本章节提供 SDK 的快速入门指南，帮助用户快速运行基本示例程序。
+
+.. toctree::
+    :maxdepth: 2
+
+    quickstart.md
+    orbbecviewer.md
+