diff --git a/README.md b/README.md index 473f1bf8..3da7ddff 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ ![stability](https://img.shields.io/badge/stability-stable-green) ![version](https://img.shields.io/badge/version-1.8.3-green) -The Orbbec 3D camera product software development kit，fully supports UVC, realizes driver-free plug-and-play, provides low-level and high-level simple and easy-to-use APIs, and helps developers use it flexibly in different scenarios. +The Orbbec 3D camera product software development kit fully supports UVC, enabling driver-free plug-and-play. It provides both low-level and high-level APIs that are simple and easy to use, allowing developers to use it flexibly in different scenarios. -Besides, this SDK is compatible with Orbbec's original OpenNI protocol devices through built-in code, so that developers can completely migrate to Orbbec SDK to support Orbbec's new generation of products and old products with one set of code. +Additionally, this SDK is compatible with Orbbec's original OpenNI protocol devices through built-in code, enabling developers to migrate to Orbbec SDK to support both new and old products with one set of code. ## What is included in the repository @@ -22,7 +22,7 @@ Windows 10, Ubuntu 16.04/18.04/20.04, ARM Linux 32/64 bit (Raspberry Pi 4B, Jets ## Product support -| **products list** | **firmware version** | +| **Products List** | **Firmware Version** | | --- | --- | | Femto Bolt | 1.0.6 (unsupported ARM32) | | Femto Mega | 1.1.7 (support window10、Linux(ubuntu20.04、ubuntu22.04)、Arm64(AGX orin, orin NX, orin nano)) | @@ -42,6 +42,18 @@ Windows 10, Ubuntu 16.04/18.04/20.04, ARM Linux 32/64 bit (Raspberry Pi 4B, Jets | Gemini | 3.0.18 | | Astra Mini S Pro | 1.0.05 | + + +## OrbbecViewer + +OrbbecViewer is a useful tool based on Orbbec SDK，that can be used to view the data stream from the Orbbec camera and control the camera. +![OrbbecViewer](doc/resources/OrbbecViewer.png) + +**Supported platforms**: Windows x64, Linux x64 & ARM64 + +**Download link**: [Releases](https://github.com/orbbec/OrbbecSDK/releases) + + ## Getting started ### Get source code @@ -60,7 +72,8 @@ git clone https://github.com/orbbec/OrbbecSDK.git ``` bash cd OrbbecSDK/misc/scripts sudo chmod +x ./install_udev_rules.sh - ./install_udev_rules.sh + sudo ./install_udev_rules.sh + sudo udevadm control --reload && sudo udevadm trigger ``` * Windows: @@ -69,23 +82,7 @@ git clone https://github.com/orbbec/OrbbecSDK.git * *For more information, please refer to：[Environment Configuration](doc/tutorial/English/Environment_Configuration.md)* -### Use Orbbec SDK in your CMake project -Find and link Orbbec SDK in your CMakeLists.txt file like this: - -```cmake -cmake_minimum_required(VERSION 3.1.15) -project(OrbbecSDKTest) - -add_executable(${PROJECT_NAME} main.cpp) - -# find Orbbec SDK -set(OrbbecSDK_DIR "/your/path/to/OrbbecSDK") -find_package(OrbbecSDK REQUIRED) - -# link Orbbec SDK -target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK) -``` ## Examples @@ -94,27 +91,40 @@ The sample code is located in the `./examples` directory and can be built using ### Build ```bash -cd OrbbecSDK && mkdir build && cd build && -cmake .. && cmake --build . --config Release +cd OrbbecSDK && mkdir build && cd build && cmake .. && cmake --build . --config Release ``` ### Run example -Connect Orbbec camera to you machine, and then run this: +To connect your Orbbec camera to your PC, run the following steps: ``` bash cd OrbbecSDK/build/bin # build output dir ./OBMultiStream # OBMultiStream.exe on Windows ``` -## OrbbecViewer -OrbbecViewer is a useful tool based on Orbbec SDK，that can be used to view the data stream from the Orbbec camera and control the camera. -![OrbbecViewer](doc/resources/OrbbecViewer.png) -**Supported platforms**: Windows x64, Linux x64&ARM64 -**Download link**: [Releases](https://github.com/orbbec/OrbbecSDK/releases) +### Use Orbbec SDK in your CMake project + +Find and link Orbbec SDK in your CMakeLists.txt file like this: + +```cmake +cmake_minimum_required(VERSION 3.1.15) +project(OrbbecSDKTest) + +add_executable(${PROJECT_NAME} main.cpp) + +# find Orbbec SDK +set(OrbbecSDK_DIR "/your/path/to/OrbbecSDK") +find_package(OrbbecSDK REQUIRED) + +# link Orbbec SDK +target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK) +``` + + ## Documents diff --git a/README_CN.md b/README_CN.md index 38fe6f3a..a7aef5b4 100644 --- a/README_CN.md +++ b/README_CN.md @@ -42,6 +42,17 @@ Windows 10, Ubuntu 16.04/18.04/20.04, ARM Linux 32/64 bit (Raspberry Pi 4B, Jets | Gemini | 3.0.18 | | Astra Mini S Pro | 1.0.05 | + +## OrbbecViewer +OrbbecViewer是一个基于Orbbec SDK的实用工具，用于查看来自Orbbec相机的数据流并控制相机. + +![OrbbecViewer](doc/resources/OrbbecViewer.png) + +**支持平台**: Windows x64, Linux x64&ARM64 + +**下载链接**: [Releases](https://github.com/orbbec/OrbbecSDK/releases) + + ## 快速开始 ### 获取源码 @@ -58,7 +69,8 @@ Windows 10, Ubuntu 16.04/18.04/20.04, ARM Linux 32/64 bit (Raspberry Pi 4B, Jets ``` bash cd OrbbecSDK/misc/scripts sudo chmod +x ./install_udev_rules.sh - ./install_udev_rules.sh + sudo ./install_udev_rules.sh + sudo udevadm control --reload && sudo udevadm trigger ``` * Windows： @@ -66,23 +78,7 @@ Windows 10, Ubuntu 16.04/18.04/20.04, ARM Linux 32/64 bit (Raspberry Pi 4B, Jets * 有关环境配置的更多信息请参考：[Environment Configuration](doc/tutorial/Chinese/Environment_Configuration.md) -### CMake项目中使用Orbbec SDK -在CMakeLists.txt文件中查找并链接Orbbec SDK： - -```cmake -cmake_minimum_required(VERSION 3.1.15) -project(OrbbecSDKTest) - -add_executable(${PROJECT_NAME} main.cpp) - -# find Orbbec SDK -set(OrbbecSDK_DIR "/your/path/to/OrbbecSDK") -find_package(OrbbecSDK REQUIRED) - -# link Orbbec SDK -target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK) -``` ## 示例 示例代码位于./examples目录中，可以使用CMake进行编译 @@ -90,8 +86,7 @@ target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK) ### 编译 ```bash - cd OrbbecSDK && mkdir build && cd build && - cmake .. && cmake --build . --config Release + cd OrbbecSDK && mkdir build && cd build && cmake .. && cmake --build . --config Release ``` ### 运行示例 @@ -101,14 +96,26 @@ target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK) ./OBMultiStream # OBMultiStream.exe on Windows ``` -## OrbbecViewer -OrbbecViewer是一个基于Orbbec SDK的实用工具，用于查看来自Orbbec相机的数据流并控制相机. -![OrbbecViewer](doc/resources/OrbbecViewer.png) -**支持平台**: Windows x64, Linux x64&ARM64 +### CMake项目中使用Orbbec SDK + +在CMakeLists.txt文件中查找并链接Orbbec SDK： + +```cmake +cmake_minimum_required(VERSION 3.1.15) +project(OrbbecSDKTest) + +add_executable(${PROJECT_NAME} main.cpp) + +# find Orbbec SDK +set(OrbbecSDK_DIR "/your/path/to/OrbbecSDK") +find_package(OrbbecSDK REQUIRED) + +# link Orbbec SDK +target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK) +``` -**下载链接**: [Releases](https://github.com/orbbec/OrbbecSDK/releases) ## 文档