mirror of
https://github.com/orbbec/OrbbecSDK_ROS2.git
synced 2026-10-04 20:17:47 +08:00
docs: update firmware update tool documentation
This commit is contained in:
@@ -40,4 +40,5 @@ Configuration & Modes
|
|||||||
configuration/disparity_search_offset.md
|
configuration/disparity_search_offset.md
|
||||||
configuration/interleave_ae_mode.md
|
configuration/interleave_ae_mode.md
|
||||||
configuration/predefined_presets.md
|
configuration/predefined_presets.md
|
||||||
|
configuration/firmware_update_tool.md
|
||||||
configuration/net_camera.md
|
configuration/net_camera.md
|
||||||
|
|||||||
@@ -0,0 +1,34 @@
|
|||||||
|
# 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
|
||||||
|
```
|
||||||
@@ -1,40 +1,5 @@
|
|||||||
# Other Tools
|
# Other Tools
|
||||||
|
|
||||||
## 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
|
|
||||||
```
|
|
||||||
|
|
||||||
## Frame Timestamp CSV Logging
|
## Frame Timestamp CSV Logging
|
||||||
|
|
||||||
When `enable_frame_timestamp_csv` is enabled, the camera node records Color and Depth frame timestamp data to a CSV file. This is useful for frame synchronization, publish latency, and timestamp debugging.
|
When `enable_frame_timestamp_csv` is enabled, the camera node records Color and Depth frame timestamp data to a CSV file. This is useful for frame synchronization, publish latency, and timestamp debugging.
|
||||||
|
|||||||
@@ -40,5 +40,5 @@
|
|||||||
configuration/disparity_search_offset.md
|
configuration/disparity_search_offset.md
|
||||||
configuration/interleave_ae_mode.md
|
configuration/interleave_ae_mode.md
|
||||||
configuration/predefined_presets.md
|
configuration/predefined_presets.md
|
||||||
|
configuration/firmware_update_tool.md
|
||||||
configuration/net_camera.md
|
configuration/net_camera.md
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,34 @@
|
|||||||
|
# firmware_update_tool 工具
|
||||||
|
|
||||||
|
`firmware_update_tool` 用于从 ROS 2 命令行升级设备固件或烧录 preset 文件。升级前请确认设备连接稳定;多设备连接时建议指定序列号,避免升级到错误设备。
|
||||||
|
|
||||||
|
查看帮助:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ros2 run orbbec_camera firmware_update_tool -- --help
|
||||||
|
```
|
||||||
|
|
||||||
|
升级单个设备固件:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ros2 run orbbec_camera firmware_update_tool -- \
|
||||||
|
--serial_number <SN> \
|
||||||
|
--firmware_path /path/to/firmware.bin
|
||||||
|
```
|
||||||
|
|
||||||
|
烧录 preset 文件:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ros2 run orbbec_camera firmware_update_tool -- \
|
||||||
|
--serial_number <SN> \
|
||||||
|
--preset_path /path/to/preset.bin
|
||||||
|
```
|
||||||
|
|
||||||
|
批量升级多个设备时,`--serial_number` 支持逗号分隔;如希望某个设备失败后继续处理后续设备,可增加 `--continue_on_error`。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
ros2 run orbbec_camera firmware_update_tool -- \
|
||||||
|
--serial_number SN1,SN2 \
|
||||||
|
--firmware_path /path/to/firmware.bin \
|
||||||
|
--continue_on_error
|
||||||
|
```
|
||||||
@@ -1,40 +1,5 @@
|
|||||||
# 其他工具
|
# 其他工具
|
||||||
|
|
||||||
## firmware_update_tool 工具
|
|
||||||
|
|
||||||
`firmware_update_tool` 用于从 ROS 2 命令行升级设备固件或烧录 preset 文件。升级前请确认设备连接稳定;多设备连接时建议指定序列号,避免升级到错误设备。
|
|
||||||
|
|
||||||
查看帮助:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
ros2 run orbbec_camera firmware_update_tool -- --help
|
|
||||||
```
|
|
||||||
|
|
||||||
升级单个设备固件:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
ros2 run orbbec_camera firmware_update_tool -- \
|
|
||||||
--serial_number <SN> \
|
|
||||||
--firmware_path /path/to/firmware.bin
|
|
||||||
```
|
|
||||||
|
|
||||||
烧录 preset 文件:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
ros2 run orbbec_camera firmware_update_tool -- \
|
|
||||||
--serial_number <SN> \
|
|
||||||
--preset_path /path/to/preset.bin
|
|
||||||
```
|
|
||||||
|
|
||||||
批量升级多个设备时,`--serial_number` 支持逗号分隔;如希望某个设备失败后继续处理后续设备,可增加 `--continue_on_error`。
|
|
||||||
|
|
||||||
```bash
|
|
||||||
ros2 run orbbec_camera firmware_update_tool -- \
|
|
||||||
--serial_number SN1,SN2 \
|
|
||||||
--firmware_path /path/to/firmware.bin \
|
|
||||||
--continue_on_error
|
|
||||||
```
|
|
||||||
|
|
||||||
## 帧时间戳 CSV 记录
|
## 帧时间戳 CSV 记录
|
||||||
|
|
||||||
开启 `enable_frame_timestamp_csv` 后,相机节点会记录彩色和深度帧的时间戳数据到 CSV 文件,用于分析帧同步、发布延迟和时间戳异常。
|
开启 `enable_frame_timestamp_csv` 后,相机节点会记录彩色和深度帧的时间戳数据到 CSV 文件,用于分析帧同步、发布延迟和时间戳异常。
|
||||||
|
|||||||
Reference in New Issue
Block a user