Update installation and FAQ documentation

This commit is contained in:
ob-yalian
2026-01-13 14:13:03 +08:00
parent 28d68daaa0
commit afc88fb282
4 changed files with 88 additions and 4 deletions
@@ -12,7 +12,7 @@ sudo apt install libgflags-dev nlohmann-json3-dev \
ros-$ROS_DISTRO-image-transport ros-${ROS_DISTRO}-image-transport-plugins ros-${ROS_DISTRO}-compressed-image-transport \ ros-$ROS_DISTRO-image-transport ros-${ROS_DISTRO}-image-transport-plugins ros-${ROS_DISTRO}-compressed-image-transport \
ros-$ROS_DISTRO-image-publisher ros-$ROS_DISTRO-camera-info-manager \ ros-$ROS_DISTRO-image-publisher ros-$ROS_DISTRO-camera-info-manager \
ros-$ROS_DISTRO-diagnostic-updater ros-$ROS_DISTRO-diagnostic-msgs ros-$ROS_DISTRO-statistics-msgs ros-$ROS_DISTRO-xacro \ ros-$ROS_DISTRO-diagnostic-updater ros-$ROS_DISTRO-diagnostic-msgs ros-$ROS_DISTRO-statistics-msgs ros-$ROS_DISTRO-xacro \
ros-$ROS_DISTRO-backward-ros libdw-dev libssl-dev ros-$ROS_DISTRO-backward-ros libdw-dev libssl-dev libgoogle-glog-dev
``` ```
Enable ROS 2 auto-completion: Enable ROS 2 auto-completion:
+43 -1
View File
@@ -28,7 +28,8 @@ If the camera node crashes unexpectedly, it will generate a crash log in the cur
### Additional Troubleshooting ### Additional Troubleshooting
- If you encounter other issues, set the `log_level` parameter to `debug`. This will generate an SDK log file in the running directory: `Log/OrbbecSDK.log.txt`. Please provide this file to the support team for further assistance. - If you encounter other issues, set the `log_level` parameter to `debug`. This will generate an SDK log file in the running directory: `Log/OrbbecSDK.log.txt`. Please provide this file to the support team for further assistance.
- If firmware logs are required, set `enable_heartbeat` to `true` to activate this feature. - If firmware logs are required, set the `log_level` parameter to `debug` and set `enable_heartbeat` to `true` to activate this feature.
- If you set the `log_level` parameter to `debug` and do not want the terminal to refresh too many logs, you can change `output="screen"` to `output="log"` in `launch`, and the logs will be saved in the `~/.ros/log` directory.
### Why Are There So Many Launch Files? ### Why Are There So Many Launch Files?
@@ -75,3 +76,44 @@ This module depends on the OpenGL library at runtime. If OpenGL is not installed
```bash ```bash
glxinfo -B glxinfo -B
``` ```
### The image does not reach the preset frame rate
First you need to confirm whether the image does not reach the preset frame rate. There are several ways to view framerate in ROS 2, such as:
* `ros2 topic hz`
* `rqt`
* Custom tools (such as the `benchmark` tool provided by this ROS package)
It should be noted that different tools have different statistical methods and QoS configurations, so the frame rate results obtained may be different. When you find that the frame rate is lower than expected, please prioritize whether the error is caused by the frame rate statistics tool itself.
If you confirm that the image frame rate does not reach the preset value, you can try the following troubleshooting steps:
1. **Reduce the resolution or frame rate** to determine whether the frame rate is reduced due to USB/network bandwidth limitations;
2. **Confirm whether the camera firmware version and ROS package version are the latest**. Older versions may have performance or compatibility issues.
If the above methods still cannot solve the problem, please contact our company **FAE**, or submit an issue in **GitHub Issue** for further support.
### Issues related to soft trigger mode
* **Each sensor does not flow out at the same time when the signal is triggered**
Please enable the frame aggregation function and set the parameter `frame_aggregate_mode` to `full_frame` to ensure that multiple sensor data are output synchronously under the same trigger.
* **The preset frame rate cannot be reached in auto trigger mode**
When setting `software_trigger_period`, you need to consider the actual open stream frame rate and exposure time. For example, when `color_fps` is set to 10 FPS, `software_trigger_period` cannot be lower than the following calculated value:
```
software_trigger_period ≥ 1000000 / fps × N + 2 × expo
```
Among them:
* `fps`: sensor frame rate
* `N`: The number of frames collected in a single trigger
* `expo`: exposure time
* `Unit`: µs
If `software_trigger_period` is set too small, the trigger frequency will be limited, resulting in frame loss.
@@ -11,7 +11,7 @@ sudo apt install libgflags-dev nlohmann-json3-dev \
ros-$ROS_DISTRO-image-transport ros-${ROS_DISTRO}-image-transport-plugins ros-${ROS_DISTRO}-compressed-image-transport \ ros-$ROS_DISTRO-image-transport ros-${ROS_DISTRO}-image-transport-plugins ros-${ROS_DISTRO}-compressed-image-transport \
ros-$ROS_DISTRO-image-publisher ros-$ROS_DISTRO-camera-info-manager \ ros-$ROS_DISTRO-image-publisher ros-$ROS_DISTRO-camera-info-manager \
ros-$ROS_DISTRO-diagnostic-updater ros-$ROS_DISTRO-diagnostic-msgs ros-$ROS_DISTRO-statistics-msgs ros-$ROS_DISTRO-xacro \ ros-$ROS_DISTRO-diagnostic-updater ros-$ROS_DISTRO-diagnostic-msgs ros-$ROS_DISTRO-statistics-msgs ros-$ROS_DISTRO-xacro \
ros-$ROS_DISTRO-backward-ros libdw-dev libssl-dev ros-$ROS_DISTRO-backward-ros libdw-dev libssl-dev libgoogle-glog-dev
``` ```
启用 ROS 2 自动补全: 启用 ROS 2 自动补全:
+43 -1
View File
@@ -28,7 +28,8 @@
### 其他故障排除 ### 其他故障排除
- 如果遇到其他问题,将 `log_level` 参数设置为 `debug`。这将在运行目录中生成SDK日志文件:`Log/OrbbecSDK.log.txt`。请将此文件提供给支持团队以获得进一步帮助。 - 如果遇到其他问题,将 `log_level` 参数设置为 `debug`。这将在运行目录中生成SDK日志文件:`Log/OrbbecSDK.log.txt`。请将此文件提供给支持团队以获得进一步帮助。
- 如果需要固件日志,将 `enable_heartbeat` 设置为 `true` 以激活此功能。 - 如果需要固件日志,将`log_level` 参数设置为 `debug`的同时,将 `enable_heartbeat` 设置为 `true` 以激活此功能。
- 若将`log_level` 参数设置为 `debug`的同时,又不想终端刷新太多日志,可以在`launch`中将`output="screen"`改为`output="log"`,日志会被保存在`~/.ros/log`目录下。
### 为什么有这么多启动文件? ### 为什么有这么多启动文件?
@@ -77,3 +78,44 @@ ros2 launch orbbec_camera femto_bolt.launch.py serial_number:=CL8H741005J
```bash ```bash
glxinfo -B glxinfo -B
``` ```
### 图像未达到预设帧率
首先需要确认图像是否确实未达到预设帧率。在 ROS 2 中可通过多种方式查看帧率,例如:
* `ros2 topic hz`
* `rqt`
* 自定义工具(如本 ROS 包提供的 `benchmark` 工具)
需要注意的是,不同工具的统计方式和 QoS 配置不同,因此得到的帧率结果可能存在差异。当发现帧率低于预期时,请优先排查是否为帧率统计工具本身导致的误差。
若确认图像帧率确实未达到预设值,可尝试以下排查步骤:
1. **降低分辨率或帧率**,判断是否由于 USB / 网络带宽受限导致帧率下降;
2. **确认相机固件版本及 ROS 包版本是否为最新**,旧版本可能存在性能或兼容性问题。
若以上方法仍无法解决问题,请联系我司 **FAE**,或在 **GitHub Issue** 中提交问题以获得进一步支持。
### 软触发模式相关问题
* **信号触发时各传感器未同时出流**
请开启帧汇聚功能,将参数`frame_aggregate_mode`设置为`full_frame`,以保证多传感器数据在同一次触发下同步输出。
* **自动触发模式下无法达到预设帧率**
设置 `software_trigger_period` 时,需要综合考虑实际开流帧率与曝光时间。例如,当 `color_fps` 设置为 10 FPS 时,`software_trigger_period` 不能低于以下计算值:
```
software_trigger_period ≥ 1000000 / fps × N + 2 × expo
```
其中:
* `fps`:传感器帧率
* `N`:单次触发采集的帧数量
* `expo`:曝光时间
* `单位`:µs
若 `software_trigger_period` 设置过小,将导致触发频率受限,从而丢帧。