SDK Orbbec

[!ВАЖНО]

Добро пожаловать в SDK Orbbec. Перед началом использования этой версии SDK Orbbec необходимо проверить следующий список поддерживаемых устройств для подтверждения совместимости.

Основная ветка основана на SDK Orbbec v1 и совместима с устройствами Orbbec, использующими оригинальный протокол OpenNI, благодаря встроенному коду, что позволяет разработчикам мигрировать на SDK Orbbec для поддержки как новых, так и старых продуктов одним набором кода.

С обновлением SDK Orbbec в октябре 2024 года он стал открытым исходным кодом с улучшенной гибкостью и масштабируемостью. Это обновление обеспечивает совместимость со всеми новыми устройствами Orbbec, соответствующими стандарту UVC. Однако SDK Orbbec v2 больше не поддерживает устройства Orbbec с устаревшим протоколом OpenNI, которые продолжат получать поддержку исправлений ошибок в ветке SDK Orbbec v1. Мы рекомендуем проверить, поддерживается ли ваше устройство SDK Orbbec v2, и использовать новую версию, если это так.

Если вы пользователь в Китае, рекомендуется использовать Gitee(репозиторий Gitee).Вот список поддерживаемых устройств основной ветки (v1. x) и SDK Orbbec v2 (v2. x):

1. рекомендовано для новых проектов: мы предоставим полную поддержку с новыми функциями, исправлением ошибок и оптимизацией производительности;
2. полная поддержка: мы предоставим поддержку по исправлению ошибок;
3. ограниченная поддержка: мы предоставим поддержку по исправлению критических ошибок;
4. не поддерживается: мы не будем поддерживать конкретное устройство в этой версии;
5. будет поддерживаться: мы добавим поддержку в ближайшем будущем.

Поддержка продуктов

• библиотека : Основные файлы библиотеки Orbbec SDK и заголовочные файлы C/C++.
• примеры : Исходный код примеров проектов C/C++.
• документация : Документация по API и примерам.
• драйвер : Драйвер Windows для устройств протокола OpenNI (DaBai, DaBai DCW, DaBai DW, Astra mini Pro, Astra Pro Plus, A1 Pro, Gemini E, Gemini E Lite, Gemini). В то время как модули, использующие стандартный протокол UVC, не требуют установки драйверов.
• скрипты : Линуксовые правила udev для решения проблем с разрешениями и скрипты регистрации временных меток Windows для решения проблем с временной меткой и метаданными.

Структура лицензии

Текущая структура лицензии программного обеспечения выглядит следующим образом:

Дополнительная информация о лицензии каждого модуля доступна в файле лицензии.

Поддержка платформ| Операционная система | Требования | Описание |

|----------------------|--------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| | Windows | - Windows 10 April 2018 (версия 1803, сборка операционной системы 17134) или выше, Windows 11 | Генерация проекта VS зависит от установленной версии VS и версии CMake, поддерживает VS2015/VS2017/VS2019 | | Linux | - Linux Ubuntu 16.04/18.04/20.04/22.04 (x64) | Поддерживает GCC 7.5 | | Arm32 | - Linux Ubuntu 16.04/18.04/20.04 | Поддерживает GCC 7.5 | | Arm64 | - Linux Ubuntu 18.04/20.04/22.04 | Поддерживает GCC 7.5 | | MacOS | - Модели чипов M, версия 11.0 и выше; чипы Intel x86, версия 10.15 и выше. | Поддерживаемые аппаратные продукты: Gemini 2, Gemini 2 L, Astra 2, Gemini 2 XL, Femto Mega, Gemini 330 series |* Примечание: поддерживаемые платформы Arm: NVIDIA Jetson AGX Orin (arm64), NVIDIA Jetson Orin NX (arm64), NVIDIA Jetson Orin Nano (arm64), NVIDIA Jetson AGX Xavier (arm64), NVIDIA Jetson Xavier NX (arm64), NVIDIA Jetson Nano (arm64), A311D (arm64), Raspberry Pi 4 (arm64), Raspberry Pi 3 (arm32), RK3399 (arm64), другие платформы Arm могут требовать кросс-компиляции.

OrbbecViewer

OrbbecViewer — это полезный инструмент, основанный на SDK Orbbec, который можно использовать для просмотра потока данных с камеры Orbbec и управления камерой.

Поддерживаемые платформы: Windows x64, Linux x64 & ARM64, MacOS M-серии чипов & Intel x86 чипов

Ссылка на загрузку: Релизы

Руководство пользователя OrbbecViewer: Руководство пользователя OrbbecViewer

Начало работы

Получение исходного кода

git clone https://github.com/orbbec/OrbbecSDK.git

В качестве альтернативы, вы можете установить через двоичные пакеты, для получения дополнительной информации, обратитесь к руководству по установке.

Настройка окружения

• Linux:

Если вы установили через пакет debian, вы можете пропустить установку файла правил udev. Если нет, пожалуйста, установите его с помощью следующих команд:

cd OrbbecSDK/misc/scripts
sudo chmod +x ./install_udev_rules.sh
sudo ./install_udev_rules.sh
sudo udevadm control --reload && sudo udevadm trigger

• Windows: Регистрация временных меток: следуйте этому: obsensor_metadata_win10
• Для получения дополнительной информации, обратитесь к: Настройка окружения## Примеры

Примеры кода расположены в директории ./examples и могут быть собраны с помощью CMake.

Сборка

cd OrbbecSDK && mkdir build && cd build && cmake .. && cmake --build . --config Release

Запуск примера

Чтобы подключить вашу камеру Orbbec к компьютеру, выполните следующие шаги:

cd OrbbecSDK/build/bin # директория вывода сборки
./OBMultiStream  # OBMultiStream.exe на Windows

Примечания: На MacOS требуются привилегии sudo.

# MacOS
cd OrbbecSDK/build/bin # директория вывода сборки
cp ../../lib/macOS/* . # копирование библиотеки в директорию вывода
sudo ./OBMultiStream

Следующее изображение — это результат выполнения MultiStream на устройстве Gemini2. Результат выполнения на других устройствах может отличаться.

Примечания: На платформах Linux/Arm этот пример требует от пользователей собрать с использованием OpenCV 4.2 или выше, в противном случае, он не будет отображаться.

Использование Orbbec SDK в вашем проекте CMake

Найдите и подключите Orbbec SDK в вашем файле CMakeLists.txt следующим образом:

cmake_minimum_required(VERSION 3.1.15)
project(OrbbecSDKTest)

add_executable(${PROJECT_NAME} main.cpp)

# Найдите Orbbec SDK
set(OrbbecSDK_DIR "/ваш/путь/к/OrbbecSDK")
find_package(OrbbecSDK REQUIRED)

# Подключите Orbbec SDK
target_link_libraries(${PROJECT_NAME} OrbbecSDK::OrbbecSDK)

Документация

Обзор

• Github Pages: https://orbbec.github.io/OrbbecSDK/
• Обзор документа: doc/tutorial/English/OverviewDocument.md### Учебные материалы
• Быстрый старт: doc/tutorial/English/Environment_Configuration.md
• Примеры: examples/README.md

Справочник по API

• Справочник по API: doc/api/English/index.html
• Пользовательский справочник OrbbecSDK C++ API: doc/tutorial/English/OrbbecSDK_C++_API_user_guide-v1.0.pdf

Синхронизация нескольких камер

• Документ по синхронизации нескольких камер: Multi Camera Sync

Часто задаваемые вопросы

Отсутствие потока данных с нескольких камер

Недостаточное питание:

• Убедитесь, что все камеры не подключены к одному и тому же хабу.
• Используйте питаемый хаб для обеспечения достаточного питания для каждой камеры.

Высокое разрешение:

• Попробуйте уменьшить разрешение для решения проблем с потоком данных.

Увеличение значения usbfs_memory_mb:

• Увеличьте значение usbfs_memory_mb до OnClickListener 128МБ, выполнив следующую команду:

  echo 128 | sudo tee /sys/module/usbcore/parameters/usbfs_memory_mb
• Для постоянного изменения этого значения проверьте этот ссылку.

Связанные ссылки

• Репозиторий Orbbec SDK
• Главная страница Orbbec
• Клуб Orbbec 3D