docs: update the documentation to version 2.8.8

2026-10-04 03:57:46 +08:00 · 2026-06-06 15:00:20 +08:00
parent 14e481abfe
commit 64bd2e9145
16 changed files with 212 additions and 73 deletions
@@ -32,3 +32,12 @@ ros2 run orbbec_camera firmware_update_tool -- \
 --firmware_path /path/to/firmware.bin \
 --continue_on_error
 ```
+
+如需开启 SDK 文件日志并同时尝试开启固件日志，可增加 `--sdk_log_level`。可选值为 `debug`、`info`、`warn`、`error`、`fatal`、`off`，默认 `off`。
+
+```bash
+ros2 run orbbec_camera firmware_update_tool -- \
+--serial_number <SN> \
+--preset_path /path/to/preset.bin \
+--sdk_log_level debug
+```
@@ -44,13 +44,19 @@ ros2 launch orbbec_camera femto_mega.launch.py enumerate_net_device:=false net_d
 ros2 launch orbbec_camera multi_net_camera.launch.py
 ```

-可以使用 `list_devices_node` 查看当前连接设备。v2.8.x 之后，该工具会额外输出固件版本、网口设备本地网卡名和 IP 来源类型（`NONE`、`LLA`、`DHCP`、`PERSISTENT`）。
+可以使用 `list_devices_node` 查看当前连接设备。v2.8.x 之后，该工具会额外输出固件版本、preset 列表、preset 版本、网口设备本地网卡名和 IP 来源类型（`NONE`、`LLA`、`DHCP`、`PERSISTENT`）。当某个设备枚举失败时，工具会继续枚举其他设备。
+
+如需开启 SDK 和固件日志，可添加 `--sdk_log_level debug`：
+
+```bash
+ros2 run orbbec_camera list_devices_node -- --sdk_log_level debug
+```

 ## ip_config_tool 工具

 **`ip_config_tool`** 可执行文件允许您直接从 ROS 2 配置网络相机的 IP 设置，包括 DHCP、静态 IP、Force IP 和 DHCP 分配 IP 超时时间。这对于快速分配或更新 IP 地址而无需修改启动文件非常有用。

-> **注意：** 通过 `dhcp` 或 `set_ip` 应用的配置会写入设备。`force_ip` 是临时强制 IP，设备断电或重启后需要重新应用。
+> **注意：** 通过 `set_ip` 应用的 DHCP / persistent IP 配置会写入设备。`force_ip` 是临时强制 IP，设备断电或重启后需要重新应用。
 > **兼容说明**：`set_device_ip` 仍作为兼容别名保留，实际调用 `ip_config_tool`。旧参数 `old_ip` 已更名为 `current_ip`。

 **示例用法**
@@ -65,17 +71,33 @@ ros2 run orbbec_camera ip_config_tool -- --help

 ```bash
 ros2 run orbbec_camera ip_config_tool -- \
-dhcp \
+set_ip \
 --current_ip 192.168.1.10 \
--enable_dhcp true
+--enable_dhcp true \
+--enable_persistent_ip false
 ```

-关闭 DHCP 并设置静态 IP：
+关闭 DHCP 并设置 persistent IP：

 ```bash
 ros2 run orbbec_camera ip_config_tool -- \
 set_ip \
 --current_ip 192.168.1.10 \
+--enable_dhcp false \
+--enable_persistent_ip true \
+--new_ip 192.168.1.11 \
+--mask 255.255.255.0 \
+--gateway 192.168.1.1
+```
+
+同时开启 DHCP 和 persistent IP（仅支持 IP 配置 V2 的设备/固件）：
+
+```bash
+ros2 run orbbec_camera ip_config_tool -- \
+set_ip \
+--current_ip 192.168.1.10 \
+--enable_dhcp true \
+--enable_persistent_ip true \
 --new_ip 192.168.1.11 \
 --mask 255.255.255.0 \
 --gateway 192.168.1.1
@@ -104,12 +126,14 @@ set_dhcp_timeout \
 **参数**

 - **`current_ip`** – 设备的当前 IP 地址。
- **`enable_dhcp`** – 在 `dhcp` 或 `force_ip` 子命令中设置是否启用 DHCP。
- **`new_ip`** – 要分配的静态 IP 地址。
+- **`enable_dhcp`** – 在 `set_ip` 或 `force_ip` 子命令中设置是否启用 DHCP。
+- **`enable_persistent_ip`** – 在 `set_ip` 子命令中设置是否启用 persistent IP。
+- **`new_ip`** – 要分配的 persistent IP 或 Force IP 地址。
 - **`mask`** – 新 IP 的子网掩码。
 - **`gateway`** – 新 IP 的网关地址。
 - **`force_ip_mac`** – Force IP 目标设备 MAC 地址。
 - **`timeout`** / **`dhcp_assign_ip_timeout`** – DHCP 分配 IP 超时时间，单位为秒。
+- **`sdk_log_level`** – SDK 文件日志级别，可选值：`debug`、`info`、`warn`、`error`、`fatal`、`off`。非 `off` 时会同时尝试开启固件日志。

 > **版本说明**：`LLA` 开关仅 Gemini 335Le 固件 `1.7.05` 及以上、Gemini 435Le 固件 `1.3.17` 及以上支持。

@@ -14,6 +14,14 @@
 | `color_format` |                `RGB`                |         CPU使用率低于 `MJPG`         |
 |    `filter`    | 仅使用 `hardware_noise_removal_filter` | 其他滤波器会显著增加CPU使用率 |

+### 彩色流格式与订阅方式
+
+v2.8.8 优化了彩色流图像发布流程：
+
+- 当 `color_format` 为 RGB/YUYV 等非 MJPG 格式时，订阅 `/camera/color/image_raw`。
+- 当 `color_format:=MJPG` 时，建议订阅 `/camera/color/image_raw/compressed`。ROS wrapper 会直接发布压缩图像，避免额外解码，从而显著降低 MJPG 场景下的 CPU 占用。
+- 如果订阅 `/camera/color/image_raw`，MJPG 仍需要在主机侧解码，CPU 占用会更高。
+
 ### 用于测试的启动文件

 * `gemini_330_series_lower_cpu_usage.launch.py`