Skip to content

Commit a01e424

Browse files
author
jj
committed
add v2-main's readme description
1 parent 05ac5a2 commit a01e424

File tree

1 file changed

+40
-42
lines changed

1 file changed

+40
-42
lines changed

README.MD

Lines changed: 40 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
1-
# Orbbec ROS SDK
1+
# OrbbecSDK ROS
22

3-
[![stable](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges) ![version](https://img.shields.io/badge/version-1.5.12-green)
3+
[![stable](http://badges.github.io/stability-badges/dist/stable.svg)](http://github.com/badges/stability-badges) ![version](https://img.shields.io/badge/version-2.0.9-green)
44

5-
Orbbec ROS SDK is a wrapper for Orbbec SDK that supports ROS Kinetic, Melodic, and Noetic distributions.
5+
OrbbecSDK_ROS1 is a wrapper for Orbbec SDK that supports ROS Kinetic, Melodic, and Noetic distributions.
66
It enables smooth integration of Orbbec 3D cameras into ROS projects.
77

8+
With the major update of the new branch [v2-main](https://github.com/orbbec/OrbbecSDK_ROS1/tree/v2-main) in October 2024, OrbbecSDK_ROS1 is connected to the open source version of [OrbbecSDK v2](https://github.com/orbbec/OrbbecSDK_v2/releases), which will make OrbbecSDK_ROS1 more flexible and extensible. This update in v2-main ensures compatibility with all new Orbbec USB products that comply with the UVC standard. However, OrbbecSDK_ROS1 v2 no longer supports Orbbec's traditional OpenNI protocol devices. We encourage you to check whether your device is supported by OrbbecSDK_ROS1 v2 and use the new version if supported.
9+
810
## Table of Contents
11+
912
<!-- TOC -->
10-
* [Orbbec ROS SDK](#orbbec-ros-sdk)
13+
14+
* [OrbbecSDK ROS](#orbbec-ros-sdk)
1115
* [Table of Contents](#table-of-contents)
1216
* [Install Dependencies](#install-dependencies)
1317
* [ROS](#ros)
@@ -34,6 +38,7 @@ It enables smooth integration of Orbbec 3D cameras into ROS projects.
3438
* [Why Are There So Many Launch Files?](#why-are-there-so-many-launch-files)
3539
* [Other useful links](#other-useful-links)
3640
* [License](#license)
41+
3742
<!-- TOC -->
3843

3944
## Install Dependencies
@@ -244,14 +249,13 @@ The following launch parameters are available:
244249
recognized as USB 2.0.
245250
It is recommended to set this parameter to `false` when using a USB 2.0 connection to avoid unnecessary resets.
246251
Here is a refined version of the two sentences:
247-
248-
- `enable_heartbeat`: This option enables the heartbeat function. By default, it is set to `false`.
249-
If set to `true`, the camera will send heartbeat messages and generate firmware logs.
250-
251-
- `enable_hardware_reset`: This option enables the hardware reset function. By default, it is set to `false`.
252-
If set to `true`, the camera will reboot upon its first connection.
252+
- `enable_heartbeat`: This option enables the heartbeat function. By default, it is set to `false`.
253+
If set to `true`, the camera will send heartbeat messages and generate firmware logs.
254+
- `enable_hardware_reset`: This option enables the hardware reset function. By default, it is set to `false`.
255+
If set to `true`, the camera will reboot upon its first connection.
253256

254257
**IMPORTANT**: *Please carefully read the instructions regarding software filtering settings at [this link](https://www.orbbec.com/docs/g330-use-depth-post-processing-blocks/). If you are uncertain, do not modify these settings.*
258+
255259
## Depth work mode switch:
256260

257261
- Before starting the camera, depth work mode (depth_work_mode) can be configured for the corresponding xxx.launch
@@ -356,7 +360,7 @@ launch file's stream argument.
356360

357361
- `/camera/color/camera_info`: The color camera info.
358362
- `/camera/color/image_raw`: The color stream image.
359-
- `/camera/depth/camera_info`: The depth camera info.
363+
- `/camera/depth/camera_info`: The depth camera info.c
360364
- `/camera/depth/image_raw`: The depth stream image.
361365
- `/camera/depth/points`: The point cloud, only available when `enable_point_cloud` is `true`.
362366
- `/camera/depth_registered/points`: The colored point cloud, only available when `enable_colored_point_cloud`
@@ -384,36 +388,18 @@ bash .make_deb.sh
384388

385389
## Launch files
386390

387-
| product serials | launch file |
388-
|-------------------------------------|--------------------------|
389-
| astra+ | astra_adv.launch |
390-
| astra mini/astra mini pro/astra pro | astra.launch |
391-
| astra mini s pro | astra.launch |
392-
| astra2 | astra2.launch |
393-
| astra stereo s | stereo_s_u3.launch |
394-
| astra pro2 | astra_pro2.launch |
395-
| dabai | dabai.launch |
396-
| dabai d1 | dabai_d1.launch |
397-
| dabai dcw | dabai_dcw.launch |
398-
| dabai dw | dabai_dw.launch |
399-
| dabai pro | dabai_pro.launch |
400-
| deeya | deeya.launch |
401-
| femto / femto w | femto.launch |
402-
| femto mega | femto_mega.launch |
403-
| femto bolt | femto_bolt.launch |
404-
| gemini | gemini.launch |
405-
| gemini2 / dabai DCL | gemini2.launch |
406-
| gemini2L | gemini2L.launch |
407-
| gemini e | gemini_e.launch |
408-
| gemini e lite | gemini_e_lite.launch |
409-
| dabai max | dabai_max.launch |
410-
| dabai max pro | dabai_max_pro.launch |
411-
| gemini uw | gemini_uw.launch |
412-
| dabai dcw2 | dabai_dcw2.launch |
413-
| dabai dw2 | dabai_dw2.launch |
414-
| gemini ew | gemini_ew.launch |
415-
| gemini ew lite | gemini_ew_lite.launch |
416-
| gemini 330 series | gemini_330_series.launch |
391+
| product serials | Firmware Version | launch file |
392+
| :-------------: | :--------------: | :----------------------: |
393+
| Astra2 | 2.8.20 | astra2.launch |
394+
| Femto mega | 1.1.7/1.2.7 | femto_mega.launch |
395+
| Femto bolt | 1.0.6/1.0.9 | femto_bolt.launch |
396+
| Ggemini2 | 1.4.60 /1.4.76 | gemini2.launch |
397+
| Gemini2L | 1.4.32 | gemini2L.launch |
398+
| Gemini 335 | 1.2.20 | gemini_330_series.launch |
399+
| Gemini 335L | 1.2.20 | gemini_330_series.launch |
400+
| Gemini 335Lg | 1.3.46 | gemini_330_series.launch |
401+
| Gemini 336 | 1.2.20 | gemini_330_series.launch |
402+
| Gemini 336L | 1.2.20 | gemini_330_series.launch |
417403

418404
**All launch files are essentially similar, with the primary difference being the default values of the parameters set for different models
419405
within the same series. Differences in USB standards, such as USB 2.0 versus USB 3.0, may require adjustments to these parameters. If you
@@ -425,6 +411,7 @@ file, as well as other parameters, to ensure compatibility and optimal performan
425411
For users who need to use nodelet, please refer to `gemini2_nodelet.launch`
426412

427413
## Supported hardware products
414+
428415
Please refer to the OrbbecSDK supported products: [Product Support](https://github.com/orbbec/OrbbecSDK?tab=readme-ov-file#product-support)
429416

430417
## Frequently Asked Questions
@@ -438,30 +425,41 @@ Please send these log files to the support team or submit them to a GitHub issue
438425
### No Data Stream from Multiple Cameras
439426

440427
**Insufficient Power Supply**:
428+
441429
- Ensure that each camera is connected to a separate hub.
442430
- Use a powered hub to provide sufficient power to each camera.
443431

444432
**High Resolution**:
433+
445434
- Try lowering the resolution to resolve data stream issues.
446435

447436
**Increase usbfs_memory_mb Value**:
437+
448438
- Increase the `usbfs_memory_mb` value to 128MB (this is a reference value and can be adjusted based on your system’s needs)
449439
by running the following command:
440+
450441
```bash
451442
echo 128 | sudo tee /sys/module/usbcore/parameters/usbfs_memory_mb
452443
```
444+
453445
- To make this change permanent, check [this link](https://github.com/OpenKinect/libfreenect2/issues/807).
454446

455447
### Compilation Failure Due to OpenCV Version Issues
448+
456449
In some cases, you may have multiple versions of OpenCV on your host, which can lead to compilation failures. You can resolve this by specifying the OpenCV version. Find the CMakeLists.txt file in the cmake folder and locate the following code:
450+
457451
```cmake
458452
find_package(OpenCV REQUIRED)
459453
```
454+
460455
Either add OpenCV_dir or specify the version before it:
456+
461457
```cmake
462458
find_package(OpenCV 4.2.0 REQUIRED)
463459
```
460+
464461
Or:
462+
465463
```cmake
466464
set(OpenCV_DIR "/path_to_your_opencv_dir")
467465
find_package(OpenCV REQUIRED)
@@ -480,7 +478,7 @@ find_package(OpenCV REQUIRED)
480478

481479
## Other useful links
482480

483-
- [Orbbec SDK](https://orbbec.github.io/OrbbecSDK/)
481+
- [OrbbecSDK v2](https://github.com/orbbec/OrbbecSDK_v2/releases)
484482
- [Gemini 330 depth presets](https://www.orbbec.com/docs/g330-use-depth-presets/)
485483

486484
## License

0 commit comments

Comments
 (0)