docs: add examples for modifying launch parameters in English and Chinese documentation

This commit is contained in:
ob-yalian
2026-06-08 15:11:33 +08:00
parent 74e6cac337
commit 54b26328dc
4 changed files with 27 additions and 4 deletions
@@ -24,6 +24,12 @@ Launch parameters can be modified in two ways:
This is useful when you want a setting to become a long-term default, such as a fixed resolution, frame rate, camera name, or synchronization mode. Device launch files are located in [orbbec_camera/launch](https://github.com/orbbec/OrbbecSDK_ROS2/tree/v2-main/orbbec_camera/launch). Choose the `*.launch.py` file that matches your camera model. This is useful when you want a setting to become a long-term default, such as a fixed resolution, frame rate, camera name, or synchronization mode. Device launch files are located in [orbbec_camera/launch](https://github.com/orbbec/OrbbecSDK_ROS2/tree/v2-main/orbbec_camera/launch). Choose the `*.launch.py` file that matches your camera model.
For example, modify the default camera name to `camera_02`:
```python
DeclareLaunchArgument('camera_name', default_value='camera_02')
```
If you build from source and do not use `--symlink-install`, you usually need to rebuild the workspace and source it again after modifying a launch file: If you build from source and do not use `--symlink-install`, you usually need to rebuild the workspace and source it again after modifying a launch file:
```bash ```bash
@@ -49,7 +55,7 @@ The following are the launch parameters available:
* **`device_preset`** * **`device_preset`**
* The default value is determined by the launch file. See [predefined presets](../5_advanced_guide/configuration/predefined_presets.md) for available presets and recommended scenarios. You can use the following command to view the configurable modes; the tool also prints the preset list and preset version information. * The default value is determined by the launch file. See [predefined presets](../5_advanced_guide/configuration/predefined_presets.md) for available presets and recommended scenarios. You can use the following command to view the configurable modes; the tool also prints the preset list and preset version information.
```bash ```bash
ros2 run orbbec_camera list_camera_profile_mode_node ros2 run orbbec_camera list_devices_node
``` ```
* **`[color|depth|left_ir|right_ir|ir]_[width|height|fps|format]`** * **`[color|depth|left_ir|right_ir|ir]_[width|height|fps|format]`**
* The resolution and frame rate of the sensor stream. * The resolution and frame rate of the sensor stream.
@@ -2,6 +2,12 @@
This document lists available presets, features, and recommended scenarios by product. Please select a preset name that matches the product model and set it as the value of the `device_preset` parameter. This document lists available presets, features, and recommended scenarios by product. Please select a preset name that matches the product model and set it as the value of the `device_preset` parameter.
For example, modify the default device preset to `High Accuracy` in the launch file:
```python
DeclareLaunchArgument('device_preset', default_value='High Accuracy')
```
## Gemini 330 / Gemini 330L / Gemini 335 / Gemini 335L ## Gemini 330 / Gemini 330L / Gemini 335 / Gemini 335L
| Defaults | Features | Recommended usage scenarios | | Defaults | Features | Recommended usage scenarios |
@@ -24,6 +24,12 @@
适合将参数作为长期默认配置使用,例如团队固定使用某个分辨率、帧率、相机名称或同步模式。各设备的 launch 文件位于 [orbbec_camera/launch](https://github.com/orbbec/OrbbecSDK_ROS2/tree/v2-main/orbbec_camera/launch),请选择与设备型号对应的 `*.launch.py` 文件。 适合将参数作为长期默认配置使用,例如团队固定使用某个分辨率、帧率、相机名称或同步模式。各设备的 launch 文件位于 [orbbec_camera/launch](https://github.com/orbbec/OrbbecSDK_ROS2/tree/v2-main/orbbec_camera/launch),请选择与设备型号对应的 `*.launch.py` 文件。
例如,将相机名称的默认值修改为 `camera_02`:
```python
DeclareLaunchArgument('camera_name', default_value='camera_02')
```
如果您是从源码构建并且没有使用 `--symlink-install`,修改 launch 文件后通常需要回到工作空间重新编译并重新 source: 如果您是从源码构建并且没有使用 `--symlink-install`,修改 launch 文件后通常需要回到工作空间重新编译并重新 source:
```bash ```bash
@@ -49,7 +55,7 @@
* **`device_preset`** * **`device_preset`**
* 默认值由启动文件决定。可选 preset 和推荐场景请参考 [设备预设](../5_advanced_guide/configuration/predefined_presets.md)。可以使用下面命令查看可设置模式;该工具会同时打印 preset 列表和 preset 版本信息。 * 默认值由启动文件决定。可选 preset 和推荐场景请参考 [设备预设](../5_advanced_guide/configuration/predefined_presets.md)。可以使用下面命令查看可设置模式;该工具会同时打印 preset 列表和 preset 版本信息。
```bash ```bash
ros2 run orbbec_camera list_camera_profile_mode_node ros2 run orbbec_camera list_devices_node
``` ```
* **`[color|depth|left_ir|right_ir|ir]_[width|height|fps|format]`** * **`[color|depth|left_ir|right_ir|ir]_[width|height|fps|format]`**
* 传感器流的分辨率和帧率。 * 传感器流的分辨率和帧率。
@@ -2,6 +2,12 @@
本文档按产品列出可用预设、特点与推荐场景。请选择匹配产品型号的预设名称,并将其设置为`device_preset`参数的值。 本文档按产品列出可用预设、特点与推荐场景。请选择匹配产品型号的预设名称,并将其设置为`device_preset`参数的值。
例如,在 launch 文件中将设备预设的默认值修改为 `High Accuracy`:
```python
DeclareLaunchArgument('device_preset', default_value='High Accuracy')
```
## Gemini 330 / Gemini 330L / Gemini 335 / Gemini 335L ## Gemini 330 / Gemini 330L / Gemini 335 / Gemini 335L
| 预设 | 特点 | 推荐使用场景 | | 预设 | 特点 | 推荐使用场景 |
@@ -75,4 +81,3 @@ ros2 launch orbbec_camera gemini2L.launch.py config_file_path:=gemini2L_dual_ir.
| --- | --- | --- | | --- | --- | --- |
| G336X AMR Default | 优化其在阳光照射和重复纹理的仓库场景中具有可靠的深度性能<br> 推荐深度分辨率:1280x800 / 640x400 / 424x266 | 仓库AMRs | | G336X AMR Default | 优化其在阳光照射和重复纹理的仓库场景中具有可靠的深度性能<br> 推荐深度分辨率:1280x800 / 640x400 / 424x266 | 仓库AMRs |