Skip to content

Commit bff88b0

Browse files
committed
Add common benchmark data and optimize document layout
1 parent 5a6dd5d commit bff88b0

16 files changed

+54
-365
lines changed

docs/source/3_quickstarts/orbbecviewer.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# OrbbecViewer tutorial
1+
# OrbbecViewer QuickStarts
22

33
## Download
44

@@ -28,18 +28,16 @@ Click the icon at the bottom left corner of the window to view the current camer
2828

2929
Please refer to the list below for the latest camera firmware. [For more information, please click here.](https://www.orbbec.com/docs/g330-explore-camera-functions-in-orbbec-viewer/)
3030

31-
32-
3331
**Repository link:**[Firmware Download](https://github.com/orbbec/OrbbecFirmware?tab=readme-ov-file#firmware-download)
3432

35-
| **Products list** | **Download link** | Latest version |
36-
| ----------------- | ---------------------------------------------------------------------------------------------------- | -------------- |
37-
| Femto Bolt | [Femto Bolt Firmware](https://github.com/orbbec/OrbbecFirmware/releases/tag/Femto-Bolt-Firmware) | v1.1.2 |
38-
| Femto Mega | [Femto Mega Firmware](https://github.com/orbbec/OrbbecFirmware/releases/tag/Femto-Mega-Firmware) | v1.3.1 |
39-
| Gemini 2 | [Gemini 2 Firmware](https://github.com/orbbec/OrbbecFirmware/releases/tag/Gemini2-Firmware) | v1.4.98 |
40-
| Gemini 2 L | [Gemini 2L Firmware](https://github.com/orbbec/OrbbecFirmware/releases/tag/Gemini2L-Firmware) | v1.5.02 |
41-
| Femto Mega I | [Femto Mega I Firmware](https://github.com/orbbec/OrbbecFirmware/releases/tag/Femto-Mega-I-Firmware) | v2.0.4 |
42-
| Gemini 330 series | [Gemini 330 series Firmware](https://www.orbbec.com/docs/g330-firmware-release/?_gl=1) | |
43-
| Gemini 215 | [Gemini 215](https://github.com/orbbec/OrbbecFirmware/releases/tag/Gemini215-Firmware) | v1.0.9 |
44-
| Gemini 210 | [Gemini 210](https://github.com/orbbec/OrbbecFirmware/releases/tag/Gemini210-Firmware) | v1.0.9 |
45-
| Gemini 435Le | [Gemini 435Le](https://github.com/orbbec/OrbbecFirmware/releases/tag/Gemin435Le-Firmware) | v1.3.2 |
33+
| **Products list** | **Download link** | Latest version |
34+
| ----------------------- | ------------------------------------------------------------------------------------------------- | -------------- |
35+
| Femto Bolt | [Femto Bolt Firmware](https://github.com/orbbec/OrbbecFirmware/releases/tag/Femto-Bolt-Firmware) | v1.1.2 |
36+
| Femto Mega | [Femto Mega Firmware](https://github.com/orbbec/OrbbecFirmware/releases/tag/Femto-Mega-Firmware) | v1.3.1 |
37+
| Gemini 2 | [Gemini 2 Firmware](https://github.com/orbbec/OrbbecFirmware/releases/tag/Gemini2-Firmware) | v1.4.98 |
38+
| Gemini 2 L | [Gemini 2L Firmware](https://github.com/orbbec/OrbbecFirmware/releases/tag/Gemini2L-Firmware) | v1.5.02 |
39+
| Femto Mega I | [Femto Mega I Firmware](https://github.com/orbbec/OrbbecFirmware/releases/tag/Femto-Mega-I-Firmware) | v2.0.4 |
40+
| Gemini 330 series | [Gemini 330 series Firmware](https://www.orbbec.com/docs/g330-firmware-release/?_gl=1) | |
41+
| Gemini 215 | [Gemini 215](https://github.com/orbbec/OrbbecFirmware/releases/tag/Gemini215-Firmware) | v1.0.9 |
42+
| Gemini 210 | [Gemini 210](https://github.com/orbbec/OrbbecFirmware/releases/tag/Gemini210-Firmware) | v1.0.9 |
43+
| Gemini 435Le | [Gemini 435Le](https://github.com/orbbec/OrbbecFirmware/releases/tag/Gemin435Le-Firmware) | v1.3.2 |

docs/source/3_quickstarts/quickstart.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## QuickStarts
1+
## ROS Package QuickStarts
22

33
### Introduction
44

@@ -89,4 +89,3 @@ ros2 service call /camera/get_device_info orbbec_camera_msgs/srv/GetDeviceInfo '
8989
```bash
9090
ros2 bag record /camera/color/image_raw /camera/depth/image_raw
9191
```
92-

docs/source/4_application_guide/coordinate_systems.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### ROS2(Robot) vs Optical(Camera) Coordination Systems
1+
### ROS2 Robot vs Camera Optical Coordination Systems
22

33
* Point Of View:
44
* Imagine we are standing behind of the camera, and looking forward.

docs/source/5_advanced_guide/advanced_guide.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,18 @@ Advanced Guide
44
This chapter covers advanced features of the SDK, including multi-camera usage, and special configuration modes.
55

66

7+
8+
Performance & Optimization
9+
------------------------------------------------------
10+
11+
.. toctree::
12+
:maxdepth: 2
13+
14+
performance/lower_cpu_usage.md
15+
performance/efficient_intra_process_communication.md
16+
performance/fastdds_tuning.md
17+
18+
719
Multi-Camera
820
------------------------------------------------------
921

docs/source/6_benchmark/performance/efficient_intra_process_communication.md renamed to docs/source/5_advanced_guide/performance/efficient_intra_process_communication.md

File renamed without changes.

docs/source/6_benchmark/performance/fastdds_tuning.md renamed to docs/source/5_advanced_guide/performance/fastdds_tuning.md

File renamed without changes.

docs/source/6_benchmark/performance/lower_cpu_usage.md renamed to docs/source/5_advanced_guide/performance/lower_cpu_usage.md

File renamed without changes.

docs/source/6_benchmark/benchmark.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ This chapter introduces how to use the benchmark tool and provides test results
99
introduction.md
1010
benchmark_usage.md
1111
benchmark_data.md
12-
performance.md
12+
othertools.md

docs/source/6_benchmark/benchmark_data.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
# Benchmark Data
22

3-
This section records the data of using the benchmark tool to test different cameras
3+
This section records the data of using the benchmark tool to test different cameras. Click the link to download the xlsx data.
4+
5+
6+
## Common Benckmark Data
7+
8+
Use the default launch file to run the `common_benchmark_node` and test for 1 hour of data.
9+
10+
- [Common Benchmark Data](../../_static/ros2_common_benchmark_data.xlsx)
11+
12+
13+
## Service Benchmark Data
14+
15+
Use the default launch file to run the `service_benchmark_node` and `service_benchmark_node.py` separately. Each service is called 10 times, and the data is recorded.
16+
17+
- [Service Benchmark Data cpp](../../_static/ros2_service_benchmark_cpp.xlsx)
18+
- [Service Benchmark Data python](../../_static/ros2_service_benchmark_python.xlsx)
419

5-
- [ROS2 Service Benchmark Data cpp](../service_benchmark_data/ros2_service_benchmark_cpp.xlsx)
6-
- [ROS2 Service Benchmark Data python](../service_benchmark_data/ros2_service_benchmark_python.xlsx)

docs/source/6_benchmark/performance/benchmark.md renamed to docs/source/6_benchmark/othertools.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Ob_benchmark tool
1+
# Other Tools
2+
3+
## Ob_benchmark tool
24

35
> The goal of this tool is to benchmark the performance of various OrbbecSDK_ROS2 camera configurations. The benchmark results depend on the camera and settings used.(Currently only works with ROS2 Humble)
46
@@ -21,18 +23,17 @@ You can find example usage code in the [example](https://github.com/orbbec/Orbbe
2123
"skip_number": 30
2224
}
2325
}
24-
2526
```
2627

27-
* `camera_name`: Names of the cameras to be configured. Example: `"camera_01"`, `"camera_02"`, etc.
28-
* `process_name`: The name of the process to be monitored. For example, `"component_conta"` will monitor the data of the container process.
29-
* `switch_cycle`: The cycle time for switching configurations, in seconds. For example, setting it to `300` means the configuration will switch every 300 seconds.
30-
* `test_cycle`: The testing cycle, in seconds. For example, setting it to `1` means the tool will collect data for the monitored process every 1 second.
31-
* `skip_number`: The number of data points to skip. For example, setting it to `30` means that the first 30 data points will be ignored.
28+
- `camera_name`: Names of the cameras to be configured. Example: `"camera_01"`, `"camera_02"`, etc.
29+
- `process_name`: The name of the process to be monitored. For example, `"component_conta"` will monitor the data of the container process.
30+
- `switch_cycle`: The cycle time for switching configurations, in seconds. For example, setting it to `300` means the configuration will switch every 300 seconds.
31+
- `test_cycle`: The testing cycle, in seconds. For example, setting it to `1` means the tool will collect data for the monitored process every 1 second.
32+
- `skip_number`: The number of data points to skip. For example, setting it to `30` means that the first 30 data points will be ignored.
3233

3334
### Camera configuration (launch files)
3435

35-
In the launch folder, there are multiple\.launch.py files (`ob_benchmark_0.launch.py`, `ob_benchmark_1.launch.py`, ..., `ob_benchmark_19.launch.py`). Each file corresponds to a different camera configuration.
36+
In the launch folder, there are multiple.launch.py files (`ob_benchmark_0.launch.py`, `ob_benchmark_1.launch.py`, ..., `ob_benchmark_19.launch.py`). Each file corresponds to a different camera configuration.
3637

3738
### Running the ob_benchmark tool
3839

@@ -47,5 +48,5 @@ ros2 run orbbec_camera ob_benchmark_node
4748

4849
The output data files will be stored in the ob_benchmark folder with filenames like `0.csv`, `1.csv`, ..., 19.csv. For example:
4950

50-
* `0.csv` contains data from the `ob_benchmark_0.launch.py` configuration.
51-
* `1.csv` contains data from the `ob_benchmark_1.launch.py` configuration.
51+
- `0.csv` contains data from the `ob_benchmark_0.launch.py` configuration.
52+
- `1.csv` contains data from the `ob_benchmark_1.launch.py` configuration.

0 commit comments

Comments
 (0)