i/OrbbecSDK_ROS2
1
0
Fork 0
mirror of https://github.com/orbbec/OrbbecSDK_ROS2.git synced 2026-10-10 06:29:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

Refactor benchmark documentation and tools

Browse Source
This commit is contained in:
ob-yalian
2026-06-10 09:35:30 +08:00
parent fcd63bfeb5
commit 5a568621ed
14 changed files with 608 additions and 378 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/source/camera_devices/5_advanced_guide/advanced_guide.rst
-1
View File
@@ -40,5 +40,4 @@ Configuration & Modes
configuration/disparity_search_offset.md
configuration/interleave_ae_mode.md
configuration/predefined_presets.md
configuration/firmware_update_tool.md
configuration/net_camera.md
docs/en/source/camera_devices/5_advanced_guide/configuration/firmware_update_tool.md
-43
View File
@@ -1,43 +0,0 @@
# firmware_update_tool
`firmware_update_tool` upgrades device firmware or writes preset files from the ROS 2 command line. Before upgrading, make sure the device connection is stable. When multiple devices are connected, specify the serial number to avoid updating the wrong device.
Show help:
```bash
ros2 run orbbec_camera firmware_update_tool -- --help
```
Upgrade firmware for one device:
```bash
ros2 run orbbec_camera firmware_update_tool -- \
--serial_number <SN> \
--firmware_path /path/to/firmware.bin
```
Write a preset file:
```bash
ros2 run orbbec_camera firmware_update_tool -- \
--serial_number <SN> \
--preset_path /path/to/preset.bin
```
For batch updates, `--serial_number` accepts comma-separated values. Add `--continue_on_error` if later devices should still be processed after one device fails.
```bash
ros2 run orbbec_camera firmware_update_tool -- \
--serial_number SN1,SN2 \
--firmware_path /path/to/firmware.bin \
--continue_on_error
```
To enable SDK file logs and also attempt to enable firmware logs, add `--sdk_log_level`. Optional values are `debug`, `info`, `warn`, `error`, `fatal`, and `off`; the default is `off`.
```bash
ros2 run orbbec_camera firmware_update_tool -- \
--serial_number <SN> \
--preset_path /path/to/preset.bin \
--sdk_log_level debug
```
docs/en/source/camera_devices/5_advanced_guide/configuration/net_camera.md
+2 -91
View File
@@ -44,98 +44,9 @@ For [multi_net_camera.launch.py](https://github.com/orbbec/OrbbecSDK_ROS2/blob/v
ros2 launch orbbec_camera multi_net_camera.launch.py
```
Use `list_devices_node` to inspect connected devices. Since v2.8.x, this tool also prints firmware version, preset list, preset version, local network interface name for Ethernet devices, and IP source type (`NONE`, `LLA`, `DHCP`, `PERSISTENT`). If one device fails during enumeration, the tool continues enumerating the remaining devices.
Use `list_devices_node` to inspect connected devices. For its output fields and usage, see [Device Query and Basic Maintenance Tools](../../6_benchmark/device_query_tools.md#list_devices_node).
To enable SDK and firmware logs, add `--sdk_log_level debug`:
```bash
ros2 run orbbec_camera list_devices_node -- --sdk_log_level debug
```
## ip_config_tool Utility
The **`ip_config_tool`** executable allows you to configure network camera IP settings directly from ROS 2, including DHCP, static IP, Force IP, and DHCP address assignment timeout. This is useful for quickly assigning or updating IP addresses without modifying launch files.
> **Note:** DHCP / persistent IP configuration applied with `set_ip` is written to the device. `force_ip` is temporary and must be applied again after the device is powered off or restarted.
> **Compatibility**: `set_device_ip` is still kept as a legacy alias and calls `ip_config_tool`. The old `old_ip` argument has been renamed to `current_ip`.
**Example Usage**
Show help:
```bash
ros2 run orbbec_camera ip_config_tool -- --help
```
Enable DHCP:
```bash
ros2 run orbbec_camera ip_config_tool -- \
set_ip \
--current_ip 192.168.1.10 \
--enable_dhcp true \
--enable_persistent_ip false
```
Disable DHCP and set a 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
```
Enable both DHCP and persistent IP (requires a device/firmware that supports IP config 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
```
Force IP by MAC address:
```bash
ros2 run orbbec_camera ip_config_tool -- \
force_ip \
--force_ip_mac 54:14:FD:06:07:DA \
--new_ip 192.168.1.50 \
--mask 255.255.255.0 \
--gateway 192.168.1.1
```
Set DHCP address assignment timeout:
```bash
ros2 run orbbec_camera ip_config_tool -- \
set_dhcp_timeout \
--current_ip 192.168.1.10 \
--timeout 10
```
**Parameters**
- **`current_ip`** – Current IP address of the device.
- **`enable_dhcp`** – Enable or disable DHCP for the `set_ip` or `force_ip` subcommand.
- **`enable_persistent_ip`** – Enable or disable persistent IP for the `set_ip` subcommand.
- **`new_ip`** – Persistent IP or Force IP address to assign.
- **`mask`** – Subnet mask for the new IP.
- **`gateway`** – Gateway address for the new IP.
- **`force_ip_mac`** – Target MAC address for Force IP.
- **`timeout`** / **`dhcp_assign_ip_timeout`** – DHCP address assignment timeout in seconds.
- **`sdk_log_level`** – SDK file log level. Optional values: `debug`, `info`, `warn`, `error`, `fatal`, `off`. Any non-`off` value also attempts to enable firmware logs.
> **Version notes**: The `LLA` switch was supported only by Gemini 335Le firmware `1.7.05` and above and Gemini 435Le firmware `1.3.17` and above.
To directly modify DHCP, persistent IP, Force IP, or DHCP address assignment timeout for network cameras, use [Network Configuration Tools](../../6_benchmark/network_config_tools.md) in Chapter 6.
## Force IP Function