Руководство пользователя Camera SDK

Обзор

Это руководство предназначено для разработчиков, интегрирующих камеры. В нем описаны API Camera SDK для продуктов M4, M4 Mega, M4 Pro, V1 Pro, S2, S2 Max и H3 Series. SDK работает в системах Windows x86 и Linux x86 или Arm. Camera SDK предоставляет унифицированные API для доступа к устройству и настройки параметров. SDK поддерживает синхронный и асинхронный сбор данных глубины, интенсивности, облака точек и RGB. Некоторые модели камер также предоставляют данные для объезда препятствий, стыковки или локализации.

Примеры и описания API основаны на версии SDK, поставляемой с продуктом. Доступные параметры могут различаться в зависимости от продукта, версии прошивки и версии SDK.

Примеры предназначены для помощи при разработке и могут не охватывать все устройства и сценарии использования.

Настройка среды

Параметр конфигурации	Рекомендуемая конфигурация
Операционная система	Windows 7, Windows 10 или Windows 11; Ubuntu 16.04 или более поздняя версия
Память	4 ГБ или больше
ЦП	Четырехъядерный Cortex-A57 или эквивалентный процессор и выше
Сетевой адаптер	Gigabit Ethernet или выше

Подключение и установка

Подключение оборудования

Камера подключается к внешнему источнику напряжения 24 В и к хост-компьютеру сетевым кабелем, как показано на рисунке 2.1. Рисунок 2.1. Схема подключения камеры

Настройка сети

Сетевой сегмент IP-адресов камеры по умолчанию: 192.168.100.*
На хост-компьютере задайте для сетевого порта, подключенного к камере, адрес из сегмента 192.168.100.x и убедитесь, что он не конфликтует с устройством. Маска подсети — 255.255.255.0, как показано на рисунке ниже:
При подключении к камере рекомендуется отключить брандмауэр, чтобы хост с SDK не перехватывал пакеты данных камеры, как показано на следующем рисунке:
Настройка сети в Linux аналогична настройке в Windows. Команды управления брандмауэром зависят от дистрибутива. В Ubuntu выполните:

sudo systemctl stop ufw.service
sudo systemctl disable ufw.service
sudo ufw status

Установка SDK

Windows

Откройте установочный пакет и установите Lanxin-MRDVS-xxx.exe. Для установки для всех пользователей запустите установочный пакет с правами администратора. На рисунках ниже показан процесс установки.

Linux

Распакуйте пакет и запустите скрипт установки:

tar xvf Lanxin-MRDVS-xxx.tar.gz
cd Lanxin-MRDVS
sudo su root
chmod +x install.sh
./install.sh

Скрипт установки размещает SDK в /opt/Lanxin-MRDVS и задает переменные среды для текущего пользователя. Если программа запускается от имени другого пользователя, повторно выполните скрипт для этого пользователя или добавьте следующую строку в его ~/.bashrc:

export LD_LIBRARY_PATH=/opt/Lanxin-MRDVS/lib/:$LD_LIBRARY_PATH

Для сеансов терминала, открытых до установки, перед запуском программы выполните следующую команду:

source ~/.bashrc

Использование Camera SDK

Структура каталогов

В каталоге Camera SDK находятся следующие материалы:

Document содержит различную документацию по SDK
FirmWare содержит пакет обновления прошивки камеры
Sample содержит примеры использования Camera SDK на разных языках программирования
SDK содержит заголовочные и библиотечные файлы Camera SDK

Рабочий процесс разработки

Настройка проекта

Для интеграции SDK рекомендуется использовать C/C++. SDK включает файл CMakeLists.txt для сборки с помощью CMake, а каталог Sample содержит примеры на нескольких языках. Подробнее см. в примерах из каталога Sample и руководстве по примерам для Linux.

Синхронный процесс вызова

Асинхронный процесс вызова

Требования к вызовам

Типы параметров и соответствующие API

Для перечислений с префиксом LX_INT используйте DcSetIntValue или DcGetIntValue для задания или получения параметров типа INT.
Для перечислений с префиксом LX_FLOAT используйте DcSetFloatValue или DcGetFloatValue для задания или получения параметров типа FLOAT.
Для перечислений с префиксом LX_BOOL используйте DcSetBoolValue или DcGetBoolValue для задания или получения параметров типа BOOL.
Для перечислений с префиксом LX_STRING используйте DcSetStringValue или DcGetStringValue для задания или получения строковых параметров.
Для выполнения команд перечислений с префиксом LX_CMD используйте DcSetCmd.
Для перечислений с префиксом LX_PTR используйте DcGetPtrValue для получения результатов типа указателя.

Предварительные условия API

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

1. Когда поток запущен или для рабочего режима (LX_INT_WORK_MODE) установлен постоянно включенный режим, нельзя задавать следующие функции:

DcSetRoi
LX_INT_3D_BINNING_MODE;
LX_INT_2D_BINNING_MODE;
LX_BOOL_ENABLE_2D_TO_DEPTH;
LX_BOOL_ENABLE_MULTI_EXPOSURE_HDR;
LX_BOOL_ENABLE_MULTI_MACHINE;
LX_INT_TRIGGER_MODE;
LX_INT_CALCULATE_UP;
LX_BOOL_ENABLE_HDR;
LX_BOOL_ENABLE_TOF_DEPTH_CALIBE;
LX_BOOL_ENABLE_SYNC_FRAME
LX_INT_SAVE_PARAMS_GROUP

2. Эти параметры нельзя задавать даже при постоянно включенном рабочем режиме (LX_INT_WORK_MODE):

LX_INT_TOF_FREQMODE

3. Когда включена автоматическая экспозиция 3D (LX_BOOL_ENABLE_3D_AUTO_EXPOSURE), нельзя выполнять следующие операции с перечислениями функций:

LX_BOOL_ENABLE_MULTI_EXPOSURE_HDR ;
LX_INT_FIRST_EXPOSURE;
LX_INT_SECOND_EXPOSURE;
LX_INT_THIRD_EXPOSURE;
LX_INT_GAIN;

4. Когда автоматическая экспозиция 3D (LX_BOOL_ENABLE_3D_AUTO_EXPOSURE) выключена, нельзя выполнять следующие операции с перечислением функции:

LX_INT_3D_AUTO_EXPOSURE_LEVEL

Нельзя задавать максимальное (LX_INT_3D_AUTO_EXPOSURE_MAX) и минимальное значение автоматической экспозиции 3D

(LX_INT_3D_AUTO_EXPOSURE_MIN)

5. Когда включена автоматическая экспозиция 2D (LX_BOOL_ENABLE_2D_AUTO_EXPOSURE), нельзя выполнять следующие операции с перечислениями функций:

LX_INT_2D_MANUAL_EXPOSURE

6. Когда автоматическая экспозиция 2D (LX_BOOL_ENABLE_2D_AUTO_EXPOSURE) выключена, нельзя выполнять следующие операции с перечислением функции:

LX_INT_2D_AUTO_EXPOSURE_LEVEL;

7.В специальном режиме фильтрации нельзя задавать следующие параметры:

LX_INT_FILTER_SMOOTH_LEVEL LX_INT_FILTER_NOISE_LEVEL
LX_INT_FILTER_TIME_LEVEL

8.Перед включением устранения искажений 2D сначала включите выравнивание RGB-D:

LX_BOOL_ENABLE_2D_TO_DEPTH

9.Для устройств, не относящихся к S2, перед включением встроенного алгоритма сначала задайте алгоритм ToF. Параметры алгоритма можно задавать только при включенном встроенном алгоритме (LX_INT_ALGORITHM_MODE).

(LX_STRING_ALGORITHM_PARAMS)

10.Для получения данных облака точек (LX_PTR_XYZ_DATA) сначала включите карту глубины.

(LX_BOOL_ENABLE_3D_DEPTH_STREAM)

Типы данных

5.1 LX_STATE

Назначение: код состояния, возвращаемый функцией интерфейса SDK

Ключевые слова	Описание
LX_SUCCESS	Функция выполнена успешно
LX_ERROR	Ошибка выполнения функции
LX_E_NOT_SUPPORT	Подключенная камера не поддерживает эту функцию
LX_E_NETWORK_ERROR	Ошибка сетевого обмена данными
LX_E_INPUT_ILLEGAL	Переданы недопустимые параметры функции
LX_E_RECONNECTING	Выполняется повторное подключение устройства
LX_E_DEVICE_ERROR	Сбой оборудования
LX_E_DEVICE_NEED_UPDATE	Версия устройства слишком старая, требуется обновить прошивку
LX_E_API_NEED_UPDATE	Версия API слишком старая, требуется обновить SDK
LX_E_CTRL_PERMISS_ERROR	Не удалось получить исключительное право управления: к устройству одновременно может подключаться только один SDK
LX_E_GET_DEVICEINFO_ERROR	Не удалось получить сведения об устройстве
LX_E_IMAGE_SIZE_ERROR	Размер изображения не совпадает, повторно откройте камеру
LX_E_IMAGE_PARTITION_ERROR	Не удалось разобрать изображение
LX_E_DEVICE_NOT_CONNECTED	Камера не подключена
LX_E_DEVICE_INIT_FAILED	Не удалось инициализировать камеру
LX_E_DEVICE_NOT_FOUND	Подходящая камера не найдена
LX_E_FILE_INVALID	Ошибка файла: неверное имя, тип или формат
LX_E_CRC_CHECK_FAILED	Не удалось проверить CRC или MD5 файла
LX_E_TIME_OUT	Истекло время ожидания
LX_E_FRAME_LOSS	Пропущен кадр
LX_E_ENABLE_ANYSTREAM_FAILED	Не удалось открыть ни один поток
LX_E_NOT_RECEIVE_STREAM	Потоковые данные не получены
LX_E_PARSE_STREAM_FAILED	Поток запущен, но не удалось разобрать потоковые данные
LX_E_PROCESS_IMAGE_FAILED	Не удалось обработать изображение
LX_E_SETTING_NOT_ALLOWED	Настройка запрещена в постоянно включенном режиме
LX_E_LOAD_DATAPROCESSLIB_ERROR	Ошибка загрузки библиотеки алгоритмов обработки изображений
LX_E_FUNCTION_CALL_LOGIC_ERROR	Ошибка логики вызова функции
LX_E_IPAPPDR_UNREACHABLE_ERROR	IP-адрес недоступен или возникла ошибка настройки сети
LX_E_FRAME_ID_NOT_MATCH	Ошибка рассинхронизации кадра в пределах времени ожидания
LX_E_FRAME_MULTI_MACHINE	В кадре обнаружен сигнал помехи от нескольких устройств

5.2 LX_DATA_TYPE

Назначение: формат данных. Карты интенсивности 3D и глубины имеют разные форматы данных. Для получения указателя на данные используйте соответствующий параметр.

Ключевые слова	Описание
LX_DATA_UNSIGNED_CHAR	Тип беззнакового символа
LX_DATA_UNSIGNED_SHORT	Беззнаковое короткое целое
LX_DATA_SIGNED_SHORT	Знаковое короткое целое
LX_DATA_FLOAT	Тип с плавающей точкой
LX_DATA_OBSTACLE	Тип структуры алгоритма объезда препятствий
LX_DATA_PALLET	Тип структуры алгоритма паллетирования
LX_DATA_LOCATION	Тип структуры алгоритма визуального позиционирования
LX_DATA_OBSTACLE	Тип структуры алгоритма объезда препятствий V2

5.3 LX_BINNING_MODE

Назначение: режим объединения пикселей

Ключевые слова	Описание
LX_BINNING_1X1	Объединение 1x1
LX_BINNING_2X2	Объединение 2x2
LX_BINNING_4X4	Объединение 4x4

5.4 LX_STRUCT_LIGHT_CODE_MODE

Назначение:

Ключевые слова	Описание
LX_CODE_NORMAL	Общий режим
LX_CODE_STATBLE	Стабильный режим
LX_CODE_ENHANCE	Повышение точности

5.5 LX_ALGORITHM_MODE

Назначение:

Ключевые слова	Описание
MODE_ALL_OFF	Выключить встроенный алгоритм камеры
MODE_AVOID_OBSTACLE	Встроенный алгоритм объезда препятствий
MODE_PALLET_LOCATE	Встроенный алгоритм паллетирования
MODE_VISION_LOCATION	Встроенный алгоритм визуального позиционирования
MODE_AVOID_OBSTACLE2	Встроенный алгоритм объезда препятствий V2

5.6 LX_CAMERA_WORK_MODE

Назначение:

Ключевые слова	Описание
KEEP_HEARTBEAT	Режим контрольных сигналов: камера SDK переходит в режим ожидания после прерывания контрольных сигналов
WORK_FOREVER	Постоянно включенный режим: камера продолжает работать

5.7 LX_TRIGGER_MODE

Назначение:

Ключевые слова	Описание
LX_TRIGGER_MODE_OFF	Режим без триггера, потоковый режим, по умолчанию
LX_TRIGGER_SOFTWARE	Программный триггер
LX_TRIGGER_HARDWARE	Аппаратный триггер

5.8 LX_CAMERA_FEATURE

Назначение: различные доступные для чтения и записи параметры

5.8.1 Параметры типа int

5.8.1.1 Общие параметры

Ключевые слова	Описание
LX_INT_FIRST_EXPOSURE	Значение экспозиции в мкс; при нескольких точках — время экспозиции первой точки
LX_INT_SECOND_EXPOSURE	При нескольких точках — время экспозиции второй точки
LX_INT_THIRD_EXPOSURE	При нескольких точках — время экспозиции третьей точки; поддерживается некоторыми моделями
LX_INT_FOURTH_EXPOSURE	При нескольких точках — время экспозиции четвертой точки; поддерживается некоторыми моделями
LX_INT_GAIN	Усиление, эквивалентное эффекту экспозиции. Усиление добавляет шум; его можно настроить, чтобы значения параметров экспозиции не были слишком большими
LX_INT_MIN_DEPTH	Минимальное значение глубины; значения за пределами диапазона недействительны
LX_INT_MAX_DEPTH	Максимальное значение глубины; значения за пределами диапазона недействительны
LX_INT_MIN_AMPLITUDE	Минимальная эффективная сила сигнала; значение глубины за пределами диапазона недействительно
LX_INT_MAX_AMPLITUDE	Максимальная сила действительного сигнала; значение глубины за пределами диапазона считается недействительным
LX_INT_CODE_MODE	Режим кодирования камеры со структурированным светом; см. CODE_MODE, поддерживается некоторыми моделями
LX_INT_WORK_MODE	Рабочий режим; см. LX_CAMERA_WORK_MODE
LX_INT_LINK_SPEED	Согласованная скорость сетевой карты: 100–100 Мбит/с или 1000–1000 Мбит/с; доступна только для чтения
LX_INT_TOF_GLOBAL_OFFSET	Смещение данных глубины ToF
LX_INT_ALGORITHM_MODE	Режим включения встроенного алгоритма, поддерживается некоторыми моделями; соответствующие значения см. в LX_ALGORITHM_MODE
LX_INT_TRIGGER_MODE	Режим триггера; соответствующие значения см. в LX_TRIGGER_MODE
LX_INT_MODBUS_ADDR	Адрес Modbus; некоторые модели поддерживают вывод по протоколу MODBUS через последовательный порт
LX_INT_HEART_TIME	Интервал контрольного сигнала; при истечении времени без получения сигнала камера автоматически переходит в режим ожидания
LX_INT_GVSP_PACKET_SIZE	Размер одного пакета данных GVSP в байтах
LX_INT_CALCULATE_UP	Разрешает алгоритму ToF или RGB перемещать вычисления вверх или вниз, снижая нагрузку на хост-компьютер или камеру; может повлиять на частоту кадров и задержку
LX_INT_CAN_BAUD_RATE	Значение скорости передачи CAN в бит/с
LX_INT_SAVE_PARAMS_GROUP	Сохранить текущую конфигурацию камеры в указанную группу параметров
LX_INT_LOAD_PARAMS_GROUP	Одним действием загрузить группу параметров с указанным индексом

5.8.1.2 Параметры изображения 3D

Ключевые слова	Описание
LX_INT_3D_IMAGE_WIDTH	Текущая ширина изображения 3D
LX_INT_3D_IMAGE_HEIGHT	Текущая высота изображения 3D
LX_INT_3D_IMAGE_OFFSET_X	Горизонтальное смещение ROI в пикселях; для задания параметров используйте DcSetRoI
LX_INT_3D_IMAGE_OFFSET_Y	Вертикальное смещение ROI в пикселях; для задания параметров используйте DcSetRoI
LX_INT_3D_BINNING_MODE	Объединение пикселей; см. LX_BINNING_MODE
LX_INT_3D_DEPTH_DATA_TYPE	Формат данных изображения глубины, доступен только для чтения; соответствующие значения см. в LX_DATA_TYPE
LX_INT_3D_AMPLITUDE_CHANNEL	Число каналов изображения интенсивности 3D, общее с каналами изображения глубины
LX_INT_3D_AMPLITUDE_DATA_TYPE	Формат данных изображения интенсивности, доступен только для чтения; соответствующие значения см. в LX_DATA_TYPE
LX_INT_3D_AUTO_EXPOSURE_LEVEL	Уровень экспозиции при включенной автоматической экспозиции 3D; в этом режиме нельзя задавать значение экспозиции и усиление
LX_INT_3D_AUTO_EXPOSURE_MAX	Верхний предел автоматической экспозиции 3D
LX_INT_3D_AUTO_EXPOSURE_MIN	Нижний предел автоматической экспозиции 3D
LX_INT_3D_UNDISTORT_SCALE	Коэффициент устранения искажений изображения 3D

5.8.1.4 Параметры изображения 2D

Ключевые слова	Описание
LX_INT_2D_IMAGE_CHANNEL	Число каналов изображения 2D: 1 для монохромного изображения и 3 для цветного
LX_INT_2D_IMAGE_WIDTH	Текущая ширина изображения 2D
LX_INT_2D_IMAGE_HEIGHT	Текущая высота изображения 2D
LX_INT_2D_IMAGE_OFFSET_X	Горизонтальное смещение ROI изображения 2D в пикселях, доступно только для чтения; для задания параметров используйте DcSetRoI
LX_INT_2D_IMAGE_OFFSET_Y	Вертикальное смещение ROI изображения 2D в пикселях, доступно только для чтения; для задания параметров используйте DcSetRoI
LX_INT_2D_BINNING_MODE	Объединение пикселей; см. LX_BINNING_MODE
LX_INT_2D_MANUAL_EXPOSURE	Значение экспозиции при ручной экспозиции 2D
LX_INT_2D_MANUAL_GAIN	Значение усиления при ручной экспозиции 2D
LX_INT_2D_AUTO_EXPOSURE_LEVEL	Уровень экспозиции при автоматической экспозиции изображений 2D
LX_INT_2D_IMAGE_DATA_TYPE	Формат данных изображения 2D, доступен только для чтения; соответствующие значения см. в LX_DATA_TYPE
LX_INT_2D_UNDISTORT_SCALE	Коэффициент устранения искажений изображения 2D

5.8.1.5 Trigger parameters

Keywords	Description
LX_INT_TRIGGER_MODE	Trigger mode, the corresponding value refers to LX_TRIGGER_MODE
LX_INT_HARDWARE_TRIGGER_FILTER_TIME	Hard trigger filter time, unit us
LX_INT_TRIGGER_MIN_PERIOD_TIME	Minimum trigger time interval, unit us
LX_INT_TRIGGER_DELAY_TIME	Trigger delay time in µs. A value <= 1000 takes effect immediately. Values greater than 1000 take effect after a delay. This feature is reserved.
LX_INT_TRIGGER_FRAME_COUNT	Single trigger frame number
LX_INT_IO_WORK_MODE	GPIO signal output control mode, refer to LX_IO_WORK_MODE
LX_INT_IO_OUTPUT_STATE	User control mode of GPIO signal output, refer to LX_IO_OUTPUT_STATE

5.8.1.6 Filter parameters

Keywords	Description
LX_INT_FILTER_MODE	Filter mode, refer to LX_FILTER_MODE
LX_INT_FILTER_SMOOTH_LEVEL	When LX_INT_FILTER_MODE is FILTER_NORMAL, can set the filter smoothing level, [0, 3], the larger the value, the stronger the filtering
LX_INT_FILTER_NOISE_LEVEL	When LX_INT_FILTER_MODE is FILTER_NORMAL, can set the filter noise level, [0, 3], the larger the value, the stronger the filtering
LX_INT_FILTER_TIME_LEVEL	When LX_INT_FILTER_MODE is FILTER_NORMAL, can set the filter time domain level, [0, 3]. The larger the value, the stronger the filtering

5.8.2 float type parameters

Keywords	Description
LX_FLOAT_FILTER_LEVEL	Filtering level, 0-1, the larger the value, the higher the filtering intensity
LX_FLOAT_EST_OUT_EXPOSURE	Whether to evaluate overexposure data, 0-1, if 1, the overexposure data is invalid
LX_FLOAT_LIGHT_INTENSITY	Light intensity, supported by some models
LX_FLOAT_3D_DEPTH_FPS	Current frame rate of depth map
LX_FLOAT_3D_AMPLITUDE_FPS	Current frame rate of intensity map
LX_FLOAT_2D_IAMGE_FPS	RGB image current frame rate
LX_FLOAT_DEVICE_TEMPERATURE	Get the current camera temperature

5.8.3 bool type parameter

Keywords	Description
LX_BOOL_CONNECT_STATE	Current connection status
LX_BOOL_ENABLE_3D_DEPTH_STREAM	Turn on/off the depth map (supported by some cameras)
LX_BOOL_ENABLE_3D_AMP_STREAM	Turn on/off intensity map (supported by some cameras)
LX_BOOL_ENABLE_3D_AUTO_EXPOSURE	3D automatic exposure enablement
LX_BOOL_ENABLE_3D_UNDISTORT	3D anti-distortion enable
LX_BOOL_ENABLE_BACKGROUND_AMP	Intensity background light enable
LX_BOOL_ENABLE_ANTI_FLICKER	Anti-stroboscopic enablement, LED ambient lighting may cause obvious ripples in data, some models support
LX_BOOL_ENABLE_2D_STREAM	Turn on/off RGB
LX_BOOL_ENABLE_2D_AUTO_EXPOSURE	2D automatic exposure enable
LX_BOOL_ENABLE_2D_UNDISTORT	2D anti-distortion enable
LX_BOOL_ENABLE_2D_TO_DEPTH	RGB-D coordinate alignment enable
LX_BOOL_ENABLE_MULTI_MACHINE	Multi-machine mode enabled, supported by some models
LX_BOOL_ENABLE_MULTI_EXPOSURE_HDR	HDR (multi-exposure high dynamic range mode) enabled
LX_BOOL_ENABLE_SYNC_FRAME	Whether to enable forced frame synchronization, the default data real-time priority is given, if RGB-D synchronization is required, needs to enable this mode

5.8.4 string type parameters

Keywords	Description
LX_STRING_DEVICE_VERSION	Device version number
LX_STRING_FIRMWARE_NAME	Firmware file name, used to upgrade device version, can only be set
LX_STRING_FILTER_PARAMS	Filter algorithm parameters, string in json format
LX_STRING_ALGORITHM_PARAMS	Built-in algorithm parameters, different opening modes, corresponding to different json format strings, prerequisite needs to be set LX_ALGORITHM_MODE
LX_STRING_ALGORITHM_VERSION	Built-in algorithm version number, different opening modes, return the corresponding version number, can only be obtained, prerequisite needs to be set LX_ALGORITHM_MODE
LX_STRING_DEVICE_OS_VERSION	Device system image version number
LX_STRING_IMPORT_PARAMS_FROM_FILE	Load parameters from local file to camera
LX_STRING_EXPORT_PARAMS_TO_FILE	Export the current parameters of the camera to a local file

5.8.5 Command type parameters

Keywords	Description
LX_CMD_GET_NEW_FRAME	Update data once, default timeout is 1s
LX_CMD_RETURN_VERSION	Roll back to the previous version
LX_CMD_RESTART_DEVICE	Restart camera
LX_CMD_WHITE_BALANCE	Auto white balance
LX_CMD_RESET_PARAM	Restore default parameters

5.8.6 ptr type parameters

Keywords	Description
LX_PTR_2D_IMAGE_DATA	Get the 2D image data pointer, the data length is determined by the 2D image size, channel number and data format (LX_INT_2D_IMAGE_DATA_TYPE)
LX_PTR_3D_AMP_DATA	Get the 3D intensity map data pointer. The data length is determined by the 3D image size, channel number and data format (LX_INT_3D_AMPLITUDE_DATA_TYPE)
LX_PTR_3D_DEPTH_DATA	Get the 3D depth map data pointer. The data length is determined by the 3D image size, channel number and data format (LX_INT_3D_DEPTH_DATA_TYPE)
LX_PTR_XYZ_DATA	Get the point cloud data pointer, three channels of float* type (x, y, z are a set of data, looped in sequence), the data length is LX_INT_3D_IMAGE_WIDTH_LX_INT_3D_IMAGE_HEIG HT_sizeof(float)*3
LX_PTR_ALGORITHM_OUTPUT	Get the built-in algorithm output, related to the algorithm mode. MODE_AVOID_OBSTACLE is the LxAvoidanceOutput pointer, MODE_PALLET_LOCATE is the LxPalletPose pointer, and MODE_VISION_LOCATION is the reference LxLocation pointer
LX_PTR_2D_INTRIC_PARAM	Get 2D image internal parameters, float* type pointer, length is fixed at 9*sizeof(float)(fx,fy,cx,cy,k1,k2,p1,p2,k3)
LX_PTR_3D_INTRIC_PARAM	Get 3D image internal parameters, float* type pointer, length is fixed at 9*sizeof(float)(fx,fy,cx,cy,k1,k2,p1,p2,k3)
LX_PTR_3D_EXTRIC_PARAM	Get the 3D image external parameters, float* type pointer, the length of is fixed at 12*sizeof(float) (the first 9 represent the rotation matrix, the last 3 represent the translation vector)
LX_PTR_FRAME_DATA	Obtain a complete frame of data, and the output result refers to the structure FrameInfo

5.9 LxDeviceInfo

Function: Device attribute information structure

Field	Type	Description
handle	DcHandle	device unique identifier
dev_type	LX_DEVICE_TYPE	Device type
id	Char array	device id
ip	Char array	Device ip:port
sn	Char array	Device serial number
mac	Char array	device mac address
firmware_ver	Char array	Device software version number
algor_ver	Char array	Device algorithm version number
name	Char array	Device name, such as: camera_M3_192.168.11.13_9803
reserve	Char array	reserved field, subnet mask
reserve2	Char array	Reserved field 2, gateway
reserve3	Char array	Reserved field 3
reserve4	Char array	Reserved field 4

5.10 LxIntValueInfo

Function: Device attribute information structure

Field	Type	Description
set_available	Bool	Whether the current value is settable, true - can be set, false - cannot be set
cur_value	Int	Current value
max_value	Int	maximum value
min_value	Int	Minimum value
reserve	Int array	reserved field

5.11 LxFloatValueInfo

Function: Device attribute information structure

Field	Type	Description
set_available	Bool	Whether the current value can be set, true - can be set, false - cannot be set
cur_value	float	current value
max_value	float	maximum value
min_value	float	minimum value
reserve	float array	reserved field

5.12 LX_DEVICE_TYPE

Function: device type

Keywords	Description
LX_DEVICE_M2	M2 Camera
LX_DEVICE_M3	M3 camera
LX_DEVICE_M4 Pro	M4 Pro Camera
LX_DEVICE_M4_MEGA	M4 Mega Camera
LX_DEVICE_M4	M4 camera
LX_DEVICE_S1	S1 Camera
LX_DEVICE_S2	S2 Camera
LX_DEVICE_I1	I1 camera
LX_DEVICE_I2	I2 camera
LX_DEVICE_T1	T1 camera
LX_DEVICE_T2	T2 camera
LX_DEVICE_H3	H3 Camera
LX_DEVICE_V1Pro	V1Pro camera
LX_DEVICE_NULL	Reserved

5.13 LX_OPEN_MODE

Function: device type

Keywords	Description
OPEN_BY_INDEX	Open according to the index subscript in the search list. The corresponding parameter is the index number. When the searched device list changes, the device selected by to open will also be different
OPEN_BY_IP	Open according to the corresponding ip in the search list, and the corresponding parameter is the device ip or ip:port
OPEN_BY_SN	Open according to the corresponding sn mode in the search list, and the corresponding parameter is the device sn
OPEN_BY_ID	Open according to the corresponding id in the search list, and the corresponding parameter is the device id

5.14 FrameDataInfo

Function: Image display information structure

Field	Type	Description
frame_data_type	LX_DATA_TYPE	Frame data type
frame_width	Int	Frame data image width
frame_height	Int	Frame data image height
frame_channel	Int	Number of frame data channels
frame_data	Void *pointer type	frame data content
sensor_timestamp	Unsigned long long type	sensor image timestamp
recv_timestamp	Unsigned long long type	The timestamp when the frame data is received

5.15 FrameInfo

Function: Data frame information structure

Field	Type	Description
frame_state	LX_STATE	Frame data status
handle	DcHandle	device unique identifier
depth_data	FrameDataInfo type	Depth map frame data structure
amp_data	FrameDataInfo type	Intensity map frame data structure
rgb_data	FrameDataInfo type	Rgb frame data structure
app_data	FrameDataInfo type	Algorithm output structure
reserve_data	Void *pointer type	extended reserved field

API reference

API prototypes are defined by the SDK headers and the shipped SDK version. Unless noted otherwise, LX_SUCCESS indicates a successful call.

6.1 Find, connect and close the camera

6.1.1 DcGetDeviceList

Function prototype: Function function: Get a list of supported cameras. Function parameters:

[out]devlist Found camera list
[out]devnum Number of cameras found

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Remarks: The memory is maintained internally, and there is no need to allocate external memory. However, because the original content will be cleared before each search, external thread safety needs to be ensured.

6.1.2 DcOpenDevice

Function prototype:

Function function: Connect your device. Function parameters:

[in]open_mode open mode, see OpenMode for details
[in]param different opening methods, fill in different parameters
[out]handle is the device handle returned after successful connection. All subsequent interface access depends on this handle.
[out]info Camera details returned after successful connection

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.1.3 DcCloseDevice

Function prototype:

Function function: Turn off the device Function parameters:

[in]handle device handle

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.2 Start streaming and close streaming

6.2.1 DcStartStream

Function prototype:

**Function:**Open data stream Function parameters:

[in]handle device handle

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.2.2 DcStopStream

Function prototype:

**Function:**Close data flow Function parameters:

[in]handle device handle

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.3 Reading and setting camera parameters

6.3.1 DcSetIntValue

Function prototype:

Function function: Set int type parameters Function parameters:

[in]handle device handle
[in]cmd reference LX_CAMERA_FEATURE
[in]value sets parameter value

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.3.2 DcGetIntValue

Function prototype:

Function function: Get int type parameters Function parameters:

[in]handle device handle
[in]cmd reference LX_CAMERA_FEATURE
[out]value returns the parameter structure, the maximum and minimum values of the parameters, the current value, etc.

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.3.3 DcSetFloatValue

Function prototype:

Function function: Set float type parameters Function parameters:

[in]handle device handle
[in]cmd reference LX_CAMERA_FEATURE
[in]value sets parameter value

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.3.4 DcGetFloatValue

Function prototype:

Function function: Get float type parameters Function parameters:

[in]handle device handle
[in]cmd reference LX_CAMERA_FEATURE
[out]value returns the parameter structure, the maximum and minimum values of the parameters, the current value, etc.

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.3.5 DcSetBoolValue

Function prototype:

Function function: Set bool type parameters Function parameters:

[in]handle device handle
[in]cmd reference LX_CAMERA_FEATURE
[in]value sets parameter value

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.3.6 DcGetBoolValue

Function prototype:

Function function: Get bool type parameter Function parameters:

[in]handle device handle
[in]cmd reference LX_CAMERA_FEATURE
[out]value return parameters

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.3.7 DcSetStringValue

Function prototype:

Function function: Set string type parameters Function parameters:

[in]handle device handle
[in]cmd refer to LX_CAMERA_FEATURE
[in]value sets parameter value

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.3.8 DcGetStringValue

Function prototype:

Function function: Get string type parameters Function parameters:

[in]handle device handle
[in]cmd reference LX_CAMERA_FEATURE
[out]value returns parameters without external allocation of memory

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.3.9 DcGetPtrValue

Function prototype:

Function function: Get pointer type parameters Function parameters:

[in]handle device handle
[in]cmd reference LX_CAMERA_FEATURE
[out]value returns parameters without external allocation of memory

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.3.10 DcSetCmd

Function prototype:

Function function: Execute corresponding CMD type command operation Function parameters:

[in]handle device handle
[in]cmd reference LX_CAMERA_FEATURE

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.4 Save point cloud

6.4.1 DcSaveXYZ

Function prototype:

Function function: Save the point cloud and call it directly Function parameters:

handle device handle
filename file name, supports txt, ply and pcd formats. txt format saves all data in image order, ply and pcd only save non-zero data

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.5 Special Controls

6.5.1 DcSpecialControl

Function prototype:

Function function: LX_CAMERA_FEATURE Special operations beyond the definition Function parameters:

[in]handle device handle
[in]param operation
[inout]value is the corresponding input parameter when set, and the corresponding outgoing parameter when obtained, without external allocation of memory.

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.6 Set ROI and parameter path

6.6.1 DcSetRoI

Function prototype:

Function function: Set the ROI area. If the input value is not an integer multiple of 8, it will be automatically processed internally as the nearest integer multiple of 8 to the target value. Image size parameters need to be updated after setting Function parameters:

[in]handle device handle
[in]offsetx horizontal offset of starting point in pixels
[in]offsety vertical offset of starting point in pixels
[in]widthroi width of the target area
[in]heightroi height of the target area
[in]type0-3D image 1-2D image

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.7 Set camera IP

6.7.1 DcSetCameraIp

Function prototype: Function function: Set camera IP and subnet mask, gateway Function parameters:

[in]handle device handle,
[in]ip device IP,
[in]netmask subnet mask (if empty, the internal default is “255.255.0.0”)
[in]gateway gateway ip (if empty, the internal default is to set the last network segment of ip to “1” as the gateway)

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: When the device is not connected, you need to obtain it through search first. If the device supports modifying the gateway and subnet mask, set the gateway to the same network segment and the subnet mask to “255.255.0.0”. After modification, the device list will change, and you need to call the DcGetDeviceList interface again to obtain the new device list.

6.8 Log information and version information

6.8.1 DcGetApiVersion

Function prototype:

Function function: Get API version number Function parameters: Return value: char pointer data. Remark:

6.8.2 DcSetInfoOutput

Function prototype: Function function: Set printing information level Function parameters:

[in]print_level 0: info all debugging information; 1: warn important and warning debugging information; 2: error only output error information
[in]enable_screen_print whether to print in the window
[in]log_path The log file saving path (does not include the log file name), can be empty. Windows defaults to the current user path, and Linux defaults to the /var/log path.
[in]language language (not used yet)

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.8.3 DcLog

Function prototype:

Function function: Allow users to output debugging information to the log file Function parameters:

[in]str The string to be output, terminated by ‘\0’

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.8.4 DcRegisterFrameCallback

Function prototype: Function function: Register a data frame callback function and automatically call it when new data is received. Function parameters:

[in]handle device handle,
[in]func frame data callback function,
[in]usr_data user-defined parameters, can be passed empty

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.8.5 DcUnregisterFrameCallback

Function prototype:

Function function: Cancel frame callback Function parameters:

[in]handle device handle,

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

6.9 Device status callback

6.9.1 DcRegisterCameraStatusCallback

Function prototype: Function function: Register the camera status callback function, which is automatically called when the camera status changes. Function parameters:

[in]handle device handle,
[in]func frame data callback function,
[in]usr_data user-defined parameters, can be passed empty

Note: Make sure the parameters passed in are valid

6.9.2 DcUnregisterCameraStatusCallback

Function prototype:

Function function: Cancel camera status registration callback Function parameters:

[in]handle device handle,

Return value: Int data, this value is equal to LX_SUCCESS, indicating that the interface call is successful. Note: Make sure the parameters passed in are valid

Versions and updates

Version number	Update instructions
2.4.16	1. Support S2 camera 2. Add parameter import and export and parameter group switching 3. Add related function settings
2.4.9	1. Optimize and add some functions and configuration parameters 2. Change the timestamp to us
2.4.2	Support M4/M4 Mega/M4 Pro/V1Pro/S2/H3 cameras
2.0.2	Fix some known issues, adjust some interfaces and parameters

​Обзор

​Настройка среды

​Рекомендуемая конфигурация хоста

​Подключение и установка

​Подключение оборудования

​Настройка сети

​Установка SDK

Windows

Linux

​Использование Camera SDK

​Структура каталогов

​Рабочий процесс разработки

​Настройка проекта

​Синхронный процесс вызова

​Асинхронный процесс вызова

​Требования к вызовам

​Типы параметров и соответствующие API

​Предварительные условия API

​Типы данных

​5.1 LX_STATE

​5.2 LX_DATA_TYPE

​5.3 LX_BINNING_MODE

​5.4 LX_STRUCT_LIGHT_CODE_MODE

​5.5 LX_ALGORITHM_MODE

​5.6 LX_CAMERA_WORK_MODE

​5.7 LX_TRIGGER_MODE

​5.8 LX_CAMERA_FEATURE

​5.8.1 Параметры типа int

5.8.1.1 Общие параметры

5.8.1.2 Параметры изображения 3D

5.8.1.4 Параметры изображения 2D

5.8.1.5 Trigger parameters

5.8.1.6 Filter parameters

​5.8.2 float type parameters

​5.8.3 bool type parameter

​5.8.4 string type parameters

​5.8.5 Command type parameters

​5.8.6 ptr type parameters

​5.9 LxDeviceInfo

​5.10 LxIntValueInfo

​5.11 LxFloatValueInfo

​5.12 LX_DEVICE_TYPE

​5.13 LX_OPEN_MODE

​5.14 FrameDataInfo

​5.15 FrameInfo

​API reference

​6.1 Find, connect and close the camera

​6.1.1 DcGetDeviceList

​6.1.2 DcOpenDevice

​6.1.3 DcCloseDevice

​6.2 Start streaming and close streaming

​6.2.1 DcStartStream

​6.2.2 DcStopStream

​6.3 Reading and setting camera parameters

​6.3.1 DcSetIntValue

​6.3.2 DcGetIntValue

​6.3.3 DcSetFloatValue

​6.3.4 DcGetFloatValue

​6.3.5 DcSetBoolValue

​6.3.6 DcGetBoolValue

​6.3.7 DcSetStringValue

​6.3.8 DcGetStringValue

​6.3.9 DcGetPtrValue

​6.3.10 DcSetCmd

​6.4 Save point cloud

​6.4.1 DcSaveXYZ

​6.5 Special Controls

​6.5.1 DcSpecialControl

​6.6 Set ROI and parameter path

​6.6.1 DcSetRoI

​6.7 Set camera IP

​6.7.1 DcSetCameraIp

​6.8 Log information and version information

​6.8.1 DcGetApiVersion

​6.8.2 DcSetInfoOutput

​6.8.3 DcLog

​6.8.4 DcRegisterFrameCallback

​6.8.5 DcUnregisterFrameCallback

​6.9 Device status callback

​6.9.1 DcRegisterCameraStatusCallback

Обзор

Настройка среды

Рекомендуемая конфигурация хоста

Подключение и установка

Подключение оборудования

Настройка сети

Установка SDK

Использование Camera SDK

Структура каталогов

Рабочий процесс разработки

Настройка проекта

Синхронный процесс вызова

Асинхронный процесс вызова

Требования к вызовам

Типы параметров и соответствующие API

Предварительные условия API

Типы данных

5.1 LX_STATE

5.2 LX_DATA_TYPE

5.3 LX_BINNING_MODE

5.4 LX_STRUCT_LIGHT_CODE_MODE

5.5 LX_ALGORITHM_MODE

5.6 LX_CAMERA_WORK_MODE

5.7 LX_TRIGGER_MODE

5.8 LX_CAMERA_FEATURE

5.8.1 Параметры типа int

5.8.2 float type parameters

5.8.3 bool type parameter

5.8.4 string type parameters

5.8.5 Command type parameters

5.8.6 ptr type parameters

5.9 LxDeviceInfo

5.10 LxIntValueInfo

5.11 LxFloatValueInfo

5.12 LX_DEVICE_TYPE

5.13 LX_OPEN_MODE

5.14 FrameDataInfo

5.15 FrameInfo

API reference

6.1 Find, connect and close the camera

6.1.1 DcGetDeviceList

6.1.2 DcOpenDevice

6.1.3 DcCloseDevice

6.2 Start streaming and close streaming

6.2.1 DcStartStream

6.2.2 DcStopStream

6.3 Reading and setting camera parameters

6.3.1 DcSetIntValue

6.3.2 DcGetIntValue

6.3.3 DcSetFloatValue

6.3.4 DcGetFloatValue

6.3.5 DcSetBoolValue

6.3.6 DcGetBoolValue

6.3.7 DcSetStringValue

6.3.8 DcGetStringValue

6.3.9 DcGetPtrValue

6.3.10 DcSetCmd

6.4 Save point cloud

6.4.1 DcSaveXYZ

6.5 Special Controls

6.5.1 DcSpecialControl

6.6 Set ROI and parameter path

6.6.1 DcSetRoI

6.7 Set camera IP

6.7.1 DcSetCameraIp

6.8 Log information and version information

6.8.1 DcGetApiVersion

6.8.2 DcSetInfoOutput

6.8.3 DcLog

6.8.4 DcRegisterFrameCallback

6.8.5 DcUnregisterFrameCallback

6.9 Device status callback

6.9.1 DcRegisterCameraStatusCallback

6.9.2 DcUnregisterCameraStatusCallback

Versions and updates