Skip to content

Commit 4fe65f8

Browse files
committed
Update FAQ documentation
1 parent 0763e8c commit 4fe65f8

File tree

2 files changed

+93
-14
lines changed
  • docs
    • en/source/camera_devices/8_FAQ
    • zh/source/camera_devices/8_FAQ

2 files changed

+93
-14
lines changed

docs/en/source/camera_devices/8_FAQ/FAQ.md

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22

33
### Unexpected Crash
44

5-
If the camera node crashes unexpectedly, it will generate a crash log in the current running directory: `~/.ros/Log/camera_crash_stack_trace_xx.log`. Additionally, **regardless of whether the camera node crashes or not**, the OrbbecSDK will always generate a log file: `~/.ros/Log/OrbbecSDK.log.txt`, which contains detailed records of the SDK's operations.
6-
7-
Please send these log files to the support team or submit them to a GitHub issue for further assistance.
5+
- If you encounter other problems, set the `log_level` parameter to `debug`. This will generate the SDK log file in the run directory: `~/.ros/Log/OrbbecSDK.log.txt`.
6+
Please provide this file to the support team for further assistance.
7+
- If firmware logs are required, set the `log_level` parameter to `debug` and set `enable_heartbeat` to `true` to activate this feature.
8+
- 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.
89

910
### No Data Stream from Multiple Cameras
1011

@@ -87,3 +88,42 @@ Multi-camera systems place high demands on USB bandwidth and device initializati
8788
When invoking stream control services (such as `set_streams_enable`, `toggle_depth`, and `toggle_color`), avoid triggering multiple service calls at the same time. Instead, introduce a reasonable interval between operations (e.g., **20 ms**) to ensure reliable stream state transitions.
8889

8990
Following these timing control guidelines can significantly improve the stability of multi-camera systems during startup and runtime, reducing errors and unexpected behavior.
91+
92+
### The image does not reach the preset frame rate
93+
94+
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:
95+
96+
* `ros2 topic hz`
97+
* `rqt`
98+
* Custom tools (such as the `benchmark` tool provided by this ROS package)
99+
100+
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.
101+
102+
If you confirm that the image frame rate does not reach the preset value, you can try the following troubleshooting steps:
103+
104+
1. **Reduce the resolution or frame rate** to determine whether the frame rate is reduced due to USB/network bandwidth limitations;
105+
2. **Confirm whether the camera firmware version and ROS package version are the latest**. Older versions may have performance or compatibility issues.
106+
107+
If the above methods still cannot solve the problem, please contact our company **FAE**, or submit an issue in **GitHub Issue** for further support.
108+
109+
110+
### Issues related to soft trigger mode
111+
112+
* **Each sensor does not flow out at the same time when the signal is triggered**
113+
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.
114+
115+
* **The preset frame rate cannot be reached in auto trigger mode**
116+
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:
117+
118+
```
119+
software_trigger_period ≥ 1000000 / fps × N + 2 × expo
120+
```
121+
122+
Among them:
123+
124+
* `fps`: sensor frame rate
125+
* `N`: The number of frames collected in a single trigger
126+
* `expo`: exposure time
127+
* `Unit`: µs
128+
129+
If `software_trigger_period` is set too small, the trigger frequency will be limited, resulting in frame loss.

docs/zh/source/camera_devices/8_FAQ/FAQ.md

Lines changed: 50 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,21 +18,20 @@
1818

1919
### 多相机无数据流
2020

21-
**Insufficient Power Supply**:
21+
**电源供应不足**
2222

23-
- Ensure that each camera is connected to a separate hub.
24-
- Use a powered hub to provide sufficient power to each camera.
23+
- 确保每个相机连接到单独的集线器。
24+
- 使用有源集线器为每个相机提供足够的电力。
2525

26-
**High Resolution**:
26+
**高分辨率**
2727

28-
- Try lowering the resolution to resolve data stream issues.
28+
- 尝试降低分辨率以解决数据流问题。
2929

30-
**Increase usbfs_memory_mb Value**:
30+
**增加usbfs_memory_mb值**
3131

32-
- Increase the `usbfs_memory_mb` value to 128MB (this is a reference value and can be adjusted based on your system’s needs)
33-
by running the following command:
32+
- 通过运行以下命令将 `usbfs_memory_mb` 值增加到128MB(这是参考值,可根据系统需求调整):
3433

35-
```bash
34+
```
3635
echo 128 | sudo tee /sys/module/usbcore/parameters/usbfs_memory_mb
3736
```
3837

@@ -63,7 +62,8 @@ find_package(OpenCV REQUIRED)
6362

6463
- 如果您遇到其他问题,请将`log_level`参数设置为`debug`。这将在运行目录中生成SDK日志文件:`~/.ros/Log/OrbbecSDK.log.txt`
6564
请将此文件提供给支持团队以获得进一步帮助。
66-
- 如果需要固件日志,请将`enable_heartbeat`设置为`true`以激活此功能。
65+
- 如果需要固件日志,将`log_level` 参数设置为 `debug`的同时,将 `enable_heartbeat` 设置为 `true` 以激活此功能。
66+
- 若将`log_level` 参数设置为 `debug`的同时,又不想终端刷新太多日志,可以在`launch`中将`output="screen"`改为`output="log"`,日志会被保存在`~/.ros/log`目录下。
6767

6868
### 为什么有这么多启动文件?
6969

@@ -96,4 +96,43 @@ roslaunch orbbec_camera femto_bolt.launch serial_number:=CL8H741005J
9696

9797
在调用开关流相关服务(如 `set_streams_enable``toggle_depth``toggle_color`)时,不建议同时触发多个接口调用,应在各操作之间设置合理的时间间隔(例如 **20 ms**),以保证流状态切换的可靠性。
9898

99-
遵循上述时序控制原则,有助于提升多相机系统在启动和运行过程中的稳定性,减少异常和不可预期行为的发生。
99+
遵循上述时序控制原则,有助于提升多相机系统在启动和运行过程中的稳定性,减少异常和不可预期行为的发生。
100+
101+
### 图像未达到预设帧率
102+
103+
首先需要确认图像是否确实未达到预设帧率。在 ROS 2 中可通过多种方式查看帧率,例如:
104+
105+
* `ros2 topic hz`
106+
* `rqt`
107+
* 自定义工具(如本 ROS 包提供的 `benchmark` 工具)
108+
109+
需要注意的是,不同工具的统计方式和 QoS 配置不同,因此得到的帧率结果可能存在差异。当发现帧率低于预期时,请优先排查是否为帧率统计工具本身导致的误差。
110+
111+
若确认图像帧率确实未达到预设值,可尝试以下排查步骤:
112+
113+
1. **降低分辨率或帧率**,判断是否由于 USB / 网络带宽受限导致帧率下降;
114+
2. **确认相机固件版本及 ROS 包版本是否为最新**,旧版本可能存在性能或兼容性问题。
115+
116+
若以上方法仍无法解决问题,请联系我司 **FAE**,或在 **GitHub Issue** 中提交问题以获得进一步支持。
117+
118+
119+
### 软触发模式相关问题
120+
121+
* **信号触发时各传感器未同时出流**
122+
请开启帧汇聚功能,将参数`frame_aggregate_mode`设置为`full_frame`,以保证多传感器数据在同一次触发下同步输出。
123+
124+
* **自动触发模式下无法达到预设帧率**
125+
设置 `software_trigger_period` 时,需要综合考虑实际开流帧率与曝光时间。例如,当 `color_fps` 设置为 10 FPS 时,`software_trigger_period` 不能低于以下计算值:
126+
127+
```
128+
software_trigger_period ≥ 1000000 / fps × N + 2 × expo
129+
```
130+
131+
其中:
132+
133+
* `fps`:传感器帧率
134+
* `N`:单次触发采集的帧数量
135+
* `expo`:曝光时间
136+
* `单位`:µs
137+
138+
`software_trigger_period` 设置过小,将导致触发频率受限,从而丢帧。

0 commit comments

Comments
 (0)