docs: add runtime configuration options for image streams and registration modes

This commit is contained in:
ob-yalian
2026-07-14 15:48:08 +08:00
parent bfbfb7e3ab
commit dea4214b16
10 changed files with 102 additions and 0 deletions
@@ -166,6 +166,10 @@
* 设置激光能量级别。
* **`enable_ldp`** / **`ldp_power_level`**
* 启用LDP并设置其功率级别。
* **`enable_lrm_obstacle_distance_publish`**
* 发布 LRM 障碍物距离话题 `/camera/lrm/obstacle_distance`。默认值为 `false`;启用时会同时启用 LDP。
* **`lrm_obstacle_distance_publish_rate`**
* 设置 LRM 障碍物距离话题的发布频率,单位为 Hz。默认值为 `10.0`;非正数会回退为 `10.0`。
## 设备、同步与高级功能
@@ -256,9 +260,15 @@
* **`depth_decimation_factor`** / **`left_ir_decimation_factor`** / **`right_ir_decimation_factor`**
* 设置下采样倍数。可用`ros2 run orbbec_camera list_camera_profile_mode_node`查看可设置分辨率。**默认值:** `1`
> **支持模组**:Gemini 301 系列。
* **`color_mjpeg_quality`**
* 设置彩色 MJPEG 编码质量。**范围:** `1–100`,**默认值:** `-1`(不修改设备当前值)。需要固件版本大于等于 `1.8.11`。
> **支持模组**:Gemini 330 系列。
* **`enable_false_positive_filter`**
* 启用鬼影滤波。可减少重影噪声,使用示例和运行时调参方法请参考 [Gemini 330 系列鬼影滤波](../5_advanced_guide/configuration/false_positive_filter.md)。
> **支持模组**:Gemini 330 系列 / Gemini 340 系列。
* **`enable_fps_boost`**
* 启用设备 FPS Boost。默认值为 `false`;仅在设备支持 `FPS Boost` 属性时生效。
> **支持模组**:Gemini 330 系列。
* **`enable_edge_noise_removal_filter`**
* 启用 EdgeNoiseRemovalFilter,用于减少深度图边缘噪声。
> **支持模组**:DaBai Max Pro。
@@ -108,6 +108,24 @@
ros2 service call /camera/set_streams_enable std_srvs/srv/SetBool '{data: false}'
```
### 运行时数据流配置
* `/camera/set_stream_profile`
用于在节点运行期间切换一个或多个已启用图像流的 Profile。`stream_name` 支持 `color`、`left_color`、`right_color`、`depth`、`ir`、`left_ir` 和 `right_ir`。宽、高、帧率或格式可以只填写需要修改的字段;未修改的数值字段填写 `0`,格式填写空字符串。切换时节点会停止并重新启动数据流;如果目标 Profile 已经生效,服务会返回失败。
```bash
ros2 service call /camera/set_stream_profile orbbec_camera_msgs/srv/SetStreamProfile "{profiles: [{stream_name: color, width: 1280, height: 720, fps: 30, format: MJPG}]}"
```
* `/camera/set_image_registration_mode`
运行时切换深度和彩色图像对齐模式。可选值为 `OFF`、`HW_D2C`、`SW_D2C` 和 `SW_C2D`,大小写不敏感。除 `OFF` 外,彩色流和深度流必须同时启用。切换时节点会自动重启数据流;失败时会恢复原对齐模式。
```bash
ros2 service call /camera/set_image_registration_mode orbbec_camera_msgs/srv/SetString "{data: HW_D2C}"
```
### 传感器与发射器控制
* `/camera/set_auto_white_balance` & `/camera/get_auto_white_balance`
@@ -30,6 +30,12 @@
* `/camera/ir/metadata`
* 来自IR流固件的底层元数据。
### LRM 障碍物距离
* `/camera/lrm/obstacle_distance`
* 发布 LRM 测得的障碍物距离,消息类型为 `std_msgs/msg/Int32`,单位为毫米。
* **条件:** 仅在 `enable_lrm_obstacle_distance_publish` 为 `true` 时发布。发布频率由 `lrm_obstacle_distance_publish_rate` 设置,默认值为 `10.0` Hz。
### 点云话题
* `/camera/depth/points`
@@ -24,6 +24,21 @@
这将启动带有深度到彩色配准的相机节点并打开查看器以显示叠加图像。
### 运行时切换对齐模式
相机节点启动后,可以通过 `/camera/set_image_registration_mode` 服务切换对齐模式,无需重启节点。支持以下模式:
* `OFF`:关闭图像对齐。
* `HW_D2C`:使用硬件将深度对齐到彩色。
* `SW_D2C`:使用软件将深度对齐到彩色。
* `SW_C2D`:使用软件将彩色对齐到深度。
除 `OFF` 外,彩色流和深度流必须同时启用。服务会在切换过程中自动停止并重新启动数据流;切换失败时恢复原模式。
```bash
ros2 service call /camera/set_image_registration_mode orbbec_camera_msgs/srv/SetString "{data: SW_D2C}"
```
### 在 RViz2 中选择话题
要在 RViz2 中可视化对齐的图像:
@@ -10,6 +10,8 @@
v2.8.x 之后,该工具会额外输出固件版本、preset 列表、preset 版本、网口设备本地网卡名和 IP 来源类型(`NONE`、`LLA`、`DHCP`、`PERSISTENT`)。当某个设备枚举失败时,工具会继续枚举其他设备。
对于网络设备,该工具还会输出设备访问状态,包括 `UNKNOWN`、`UNSUPPORTED`、`AVAILABLE`、`CONTROLLED`、`EXCLUSIVE`、`UNREACHABLE` 和 `FW_NOT_SUPPORTED`。可通过该状态判断设备当前是否可访问、已被其他客户端控制或暂时不可达。
```bash
ros2 run orbbec_camera list_devices_node
```