[docs]Update docs

This commit is contained in:
jj
2024-12-18 18:35:58 +08:00
parent eca5beffcc
commit 0fcf1ea16f
152 changed files with 4338 additions and 589 deletions
+69
View File
@@ -0,0 +1,69 @@
# FAQ
## Unexpected crash
If the camera node crashes unexpectedly, it will generate a crash log in the current running directory: `Log/camera_crash_stack_trace_xx.log`.
Please send this log to the support team or submit it to a GitHub issue for further assistance.
**Regarding logging, please refer to the following log recommendations:**
In ROS, the location of the log directory is typically associated with the ROS workspace, but the specific log path may vary depending on the installation method and operating system.
Here are some common locations for ROS log directories:
1. **Default Global ROS Log Directory** : Global logs are typically recorded in the `~/.ros/log` directory. Here, `~` represents the user's home directory.
2. **Workspace-Specific Log Directories** : In some cases, ROS nodes may log to specific directories within their workspace. This can often be achieved by setting the `ROS_LOG_DIR` environment variable.
For the underlying Orbbec SDK, the log level can be configured via the `log_level` field in the `common.yaml` file.
## How to Quickly Modify the Default Resolution
How to Quickly Modify the Default Resolution, Video Format, and Frame Rate Parameters of a Product?
1.Locate the corresponding product yaml configuration file, such as gemini330_series.yaml, in the orbbec_camera/config directory.
2.Open the corresponding product yaml configuration file, such as gemini330_series.yaml, and modify the resolution, format, and frame rate settings for the video stream.
For example:
![1733990376409](../image/faq_1.png)
3.Compile and Run
```
colcon build --event-handlers console_direct+ --cmake-args -DCMAKE_BUILD_TYPE=Release
source install/setup.bash
ros2 launch orbbec_camera orbbec_camera.launch.py config_file_path:=gemini330_series.yaml
```
## No data stream from multiple cameras
**Insufficient Power Supply**:
- Ensure that each camera is connected to a separate hub.
- Use a powered hub to provide sufficient power to each camera.
**High Resolution**:
- Try lowering the resolution to resolve data stream issues.
**Increase usbfs_memory_mb Value**:
- Increase the `usbfs_memory_mb` value to 128MB (this is a reference value and can be adjusted based on your system’s needs)
by running the following command:
```bash
echo 128 | sudo tee /sys/module/usbcore/parameters/usbfs_memory_mb
```
- To make this change permanent, check [this link](https://github.com/OpenKinect/libfreenect2/issues/807).
## 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 firmware logs are required, set `enable_heartbeat` to `true` to activate this feature.
## Why are there so many yaml files?
- Different yaml files have varying default resolutions and image formats.
- To simplify usage, each camera has its own yaml file.
+31
View File
@@ -0,0 +1,31 @@
.. 这一页是模块目录树
.. image:: ../image/product_h5.png
======================================================
Help center
======================================================
This section offers insights into common issues encountered during Orbbec SDK ROS2 development, along with their solutions, ensuring smoother progress in robotics projects.
======================================================
.. toctree::
:maxdepth: 2
:caption: This Section Covers:
FAQ.md
issues.md
======================================================
.. image:: ../image/product_h1.png
+5
View File
@@ -0,0 +1,5 @@
# Issue
Regarding issues with OrbbecSDK_ROS 2, please refer to the detailed descriptions on the GitHub issue page for reference:
[https://github.com/orbbec/OrbbecSDK_ROS2/issues](https://github.com/orbbec/OrbbecSDK_ROS2/issues)
+15
View File
@@ -0,0 +1,15 @@
# Purchase link
Purchase channels:
Taobao Direct Enterprise Store:[Click to go to the mall](https://shop142544700.taobao.com/)
JD.com Direct Flagship Store:[Click to go to the mall](https://mall.jd.com/index-1000467272.html)
Gemini2 VL Camera: [Click to purchase on JD.com](https://item.jd.com/100063076495.html)
Official Website Purchase Link:[Click to go to the official product area](https://www.orbbec.com/products)
Gemini2 VL Camera: [Click to purchase on the official website](https://www.orbbec.com/products/stereo-vision-camera/gemini-335l)
G335L Camera: [Click to purchase on the official website](https://www.orbbec.com/products/stereo-vision-camera/gemini-335l)
+12
View File
@@ -0,0 +1,12 @@
# Technical support
Developer Community Technical Support:
Orbbec
Email: [[email protected]](https://file+10-002e8-002e190-002e12.vscode-resource.vscode-cdn.net/guojia/OrbbecSDK_ROS2/docs/source/mailto:[email protected])
3D Vision Developer Community: [developer.orbbec.com.cn/](https://developer.orbbec.com.cn/)
Orbbec Official Website: Chinese: [www.orbbec.com.cn](https://www.orbbec.com.cn/) English: [www.orbbec.com](https://www.orbbec.com/)
Orbbec Official ad