Hướng dẫn sử dụng Camera SDK

Tổng quan

Hướng dẫn này dành cho nhà phát triển tích hợp thiết bị camera. Tài liệu bao quát các API Camera SDK cho các sản phẩm M4, M4 Mega, M4 Pro, V1 Pro, S2, S2 Max và dòng H3. SDK chạy trên x86 Windows và hệ thống x86 hoặc Arm Linux. Camera SDK cung cấp các API thống nhất để truy cập thiết bị và cấu hình tham số. SDK hỗ trợ thu nhận đồng bộ và bất đồng bộ dữ liệu độ sâu, cường độ, đám mây điểm và RGB. Một số model camera còn cung cấp dữ liệu tránh chướng ngại vật, docking hoặc định vị.

Ví dụ và mô tả API dựa trên phiên bản SDK được cung cấp cùng sản phẩm. Các tham số khả dụng có thể thay đổi theo sản phẩm, firmware và phiên bản SDK.

Các ví dụ chỉ nhằm hướng dẫn phát triển và có thể không bao quát mọi thiết bị hoặc trường hợp sử dụng.

Thiết lập môi trường

Cấu hình máy chủ khuyến nghị

Hạng mục cấu hình	Cấu hình khuyến nghị
Hệ điều hành	Windows 7, Windows 10 hoặc Windows 11; Ubuntu 16.04 trở lên
Bộ nhớ	4 GB trở lên
CPU	Cortex-A57 bốn lõi hoặc tương đương trở lên
Bộ điều hợp mạng	Gigabit Ethernet trở lên

Kết nối và cài đặt

Kết nối phần cứng

Camera được nối với nguồn điện 24V bên ngoài và kết nối với máy tính chủ bằng cáp mạng như minh họa trong Hình 2.1. Hình 2.1 Sơ đồ kết nối camera

Cấu hình mạng

Phân đoạn mạng IP mặc định của camera là: 192.168.100.*
Trên máy tính chủ, đặt địa chỉ IP của cổng mạng kết nối với camera thành địa chỉ thuộc phân đoạn mạng 192.168.100.x và đảm bảo không xung đột với thiết bị. Mặt nạ mạng con là 255.255.255.0 như minh họa bên dưới:
Khi kết nối với camera, nên tắt tường lửa để tránh các gói dữ liệu của camera bị máy chủ chạy SDK chặn, như minh họa trong hình sau:
Cấu hình mạng trên Linux giống với Windows. Lệnh tường lửa thay đổi tùy bản phân phối. Trên Ubuntu, chạy:

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

Install the SDK

Windows

Mở gói cài đặt và cài đặt Lanxin-MRDVS-xxx.exe. Nếu cần cài đặt cho tất cả người dùng, bạn phải có quyền quản trị để chạy gói cài đặt. Hình bên dưới minh họa quy trình cài đặt.

Linux

Giải nén gói và chạy script cài đặt:

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

Script cài đặt SDK vào /opt/Lanxin-MRDVS và thiết lập biến môi trường cho người dùng hiện tại. Nếu chương trình chạy dưới người dùng khác, hãy chạy lại script cho người dùng đó hoặc thêm dòng sau vào ~/.bashrc của người dùng đó:

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

Đối với các phiên terminal đã mở trước khi cài đặt, hãy chạy lệnh sau trước khi khởi động chương trình:

source ~/.bashrc

Sử dụng Camera SDK

Cấu trúc thư mục

Thư mục Camera SDK có các thành phần sau:

Document chứa nhiều tài liệu khác nhau về SDK
FirmWare chứa gói nâng cấp firmware camera
Sample chứa mã mẫu sử dụng Camera SDK bằng nhiều ngôn ngữ lập trình
SDK chứa các tệp header và tệp thư viện của Camera SDK

Quy trình phát triển

Cấu hình dự án

Khuyến nghị sử dụng C/C++ để tích hợp SDK. SDK có tệp CMakeLists.txt phục vụ quá trình build bằng CMake, còn thư mục Sample chứa ví dụ bằng nhiều ngôn ngữ. Để biết chi tiết, xem các ví dụ trong Sample và hướng dẫn ví dụ Linux.

Luồng gọi đồng bộ

Luồng gọi bất đồng bộ

Yêu cầu khi gọi

Loại tham số và API tương ứng

Với các kiểu enum có tiền tố LX_INT, sử dụng DcSetIntValue hoặc DcGetIntValue để đặt hoặc lấy tham số kiểu INT;
Với các kiểu enum có tiền tố LX_FLOAT, sử dụng DcSetFloatValue hoặc DcGetFloatValue để đặt hoặc lấy tham số kiểu FLOAT;
Với các kiểu enum có tiền tố LX_BOOL, sử dụng DcSetBoolValue hoặc DcGetBoolValue để đặt hoặc lấy tham số kiểu BOOL;
Với các kiểu enum có tiền tố LX_STRING, sử dụng DcSetStringValue hoặc DcGetStringValue để đặt hoặc lấy tham số kiểu string;
Sử dụng DcSetCmd để thực thi lệnh cho các kiểu enum có tiền tố LX_CMD;
Với các kiểu enum có tiền tố LX_PTR, sử dụng DcGetPtrValue để lấy kết quả kiểu con trỏ;

Điều kiện trước khi gọi API

Khi luồng đang hoạt động hoặc khi LX_INT_WORK_MODE được đặt ở chế độ luôn bật, không được đặt các chức năng dưới đây.

1. Khi luồng đã khởi động hoặc chế độ làm việc (LX_INT_WORK_MODE) là chế độ thường mở, không được đặt các chức năng sau:

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. Không được đặt tham số ngay cả khi chế độ làm việc (LX_INT_WORK_MODE) là chế độ thường mở:

LX_INT_TOF_FREQMODE

3. Khi bật phơi sáng tự động 3D (LX_BOOL_ENABLE_3D_AUTO_EXPOSURE), không được thao tác các enum chức năng sau:

LX_BOOL_ENABLE_MULTI_EXPOSURE_HDR ;
LX_INT_FIRST_EXPOSURE;
LX_INT_SECOND_EXPOSURE;
LX_INT_THIRD_EXPOSURE;
LX_INT_GAIN;

4. Khi tắt phơi sáng tự động 3D (LX_BOOL_ENABLE_3D_AUTO_EXPOSURE), không được thao tác enum chức năng sau:

LX_INT_3D_AUTO_EXPOSURE_LEVEL

Không được đặt giá trị lớn nhất (LX_INT_3D_AUTO_EXPOSURE_MAX) và giá trị nhỏ nhất của phơi sáng tự động 3D

(LX_INT_3D_AUTO_EXPOSURE_MIN)

5. Khi bật phơi sáng tự động 2D (LX_BOOL_ENABLE_2D_AUTO_EXPOSURE), không được thao tác enum chức năng sau:

LX_INT_2D_MANUAL_EXPOSURE

6. Khi tắt phơi sáng tự động 2D (LX_BOOL_ENABLE_2D_AUTO_EXPOSURE), không được thao tác enum chức năng sau:

LX_INT_2D_AUTO_EXPOSURE_LEVEL;

7.Trong chế độ lọc đặc biệt, không được đặt các tham số sau:

LX_INT_FILTER_SMOOTH_LEVEL LX_INT_FILTER_NOISE_LEVEL
LX_INT_FILTER_TIME_LEVEL

8.Khi bật khử méo 2D, trước tiên phải bật căn chỉnh RGB-D:

LX_BOOL_ENABLE_2D_TO_DEPTH

9.Với thiết bị không thuộc loại S2, khi bật thuật toán tích hợp, trước tiên phải đặt thuật toán tof. Chỉ được đặt tham số thuật toán khi thuật toán tích hợp (LX_INT_ALGORITHM_MODE) đã bật.

(LX_STRING_ALGORITHM_PARAMS)

10.Để lấy dữ liệu đám mây điểm (LX_PTR_XYZ_DATA), trước tiên phải bật bản đồ độ sâu

(LX_BOOL_ENABLE_3D_DEPTH_STREAM)

Kiểu dữ liệu

5.1 LX_STATE

Chức năng: mã trạng thái giá trị trả về của hàm giao diện SDK

Từ khóa	Mô tả
LX_SUCCESS	Thực thi hàm thành công
LX_ERROR	Thực thi hàm thất bại
LX_E_NOT_SUPPORT	Camera đã kết nối không hỗ trợ chức năng này
LX_E_NETWORK_ERROR	Lỗi giao tiếp mạng
LX_E_INPUT_ILLEGAL	Tham số hàm truyền vào không hợp lệ
LX_E_RECONNECTING	Thiết bị đang kết nối lại
LX_E_DEVICE_ERROR	Lỗi thiết bị
LX_E_DEVICE_NEED_UPDATE	Phiên bản thiết bị quá thấp, cần nâng cấp firmware
LX_E_API_NEED_UPDATE	Phiên bản API quá thấp, cần nâng cấp SDK
LX_E_CTRL_PERMISS_ERROR	Quyền điều khiển độc quyền thất bại (thiết bị chỉ có thể có một kết nối SDK tại một thời điểm)
LX_E_GET_DEVICEINFO_ERROR	Không lấy được thông tin thiết bị
LX_E_IMAGE_SIZE_ERROR	Kích thước ảnh không khớp, hãy mở lại camera
LX_E_IMAGE_PARTITION_ERROR	Phân tích ảnh thất bại
LX_E_DEVICE_NOT_CONNECTED	Camera chưa kết nối
LX_E_DEVICE_INIT_FAILED	Khởi tạo camera thất bại
LX_E_DEVICE_NOT_FOUND	Không tìm thấy camera phù hợp
LX_E_FILE_INVALID	Lỗi tệp (sai tên, kiểu hoặc định dạng tệp)
LX_E_CRC_CHECK_FAILED	Xác minh crc hoặc md5 của tệp thất bại
LX_E_TIME_OUT	Hết thời gian chờ
LX_E_FRAME_LOSS	Thiếu khung hình
LX_E_ENABLE_ANYSTREAM_FAILED	Không mở được bất kỳ luồng nào
LX_E_NOT_RECEIVE_STREAM	Chưa nhận được dữ liệu luồng
LX_E_PARSE_STREAM_FAILED	Đã khởi động luồng nhưng phân tích dữ liệu luồng thất bại
LX_E_PROCESS_IMAGE_FAILED	Xử lý tính toán ảnh thất bại
LX_E_SETTING_NOT_ALLOWED	Không được phép đặt trong chế độ thường mở
LX_E_LOAD_DATAPROCESSLIB_ERROR	Lỗi tải thư viện thuật toán xử lý ảnh
LX_E_FUNCTION_CALL_LOGIC_ERROR	Lỗi logic khi gọi hàm
LX_E_IPAPPDR_UNREACHABLE_ERROR	Không thể truy cập IP hoặc lỗi cấu hình mạng
LX_E_FRAME_ID_NOT_MATCH	Lỗi lệch đồng bộ khung hình trong khoảng thời gian chờ
LX_E_FRAME_MULTI_MACHINE	Phát hiện tín hiệu nhiễu đa máy trong khung hình

5.2 LX_DATA_TYPE

Chức năng: định dạng dữ liệu. Bản đồ cường độ 3D và bản đồ độ sâu có định dạng dữ liệu khác nhau. Để lấy con trỏ dữ liệu, cần sử dụng feature tương ứng.

Từ khóa	Mô tả
LX_DATA_UNSIGNED_CHAR	Kiểu ký tự không dấu
LX_DATA_UNSIGNED_SHORT	Số nguyên short không dấu
LX_DATA_SIGNED_SHORT	Số short có dấu
LX_DATA_FLOAT	Kiểu số dấu phẩy động
LX_DATA_OBSTACLE	Kiểu cấu trúc thuật toán tránh chướng ngại vật
LX_DATA_PALLET	Kiểu cấu trúc thuật toán pallet
LX_DATA_LOCATION	Kiểu cấu trúc thuật toán định vị trực quan
LX_DATA_OBSTACLE	Kiểu cấu trúc thuật toán tránh chướng ngại vật V2

5.3 LX_BINNING_MODE

Chức năng: chế độ Binning

Từ khóa	Mô tả
LX_BINNING_1X1	Binning 1x1
LX_BINNING_2X2	Binning 2x2
LX_BINNING_4X4	Binning 4x4

5.4 LX_STRUCT_LIGHT_CODE_MODE

Chức năng:

Từ khóa	Mô tả
LX_CODE_NORMAL	Thông thường
LX_CODE_STATBLE	Ổn định
LX_CODE_ENHANCE	Tăng cường độ chính xác cao

5.5 LX_ALGORITHM_MODE

Chức năng:

Từ khóa	Mô tả
MODE_ALL_OFF	Tắt thuật toán tích hợp của camera
MODE_AVOID_OBSTACLE	Thuật toán tránh chướng ngại vật tích hợp
MODE_PALLET_LOCATE	Thuật toán pallet tích hợp
MODE_VISION_LOCATION	Thuật toán định vị trực quan tích hợp
MODE_AVOID_OBSTACLE2	Thuật toán tránh chướng ngại vật V2 tích hợp

5.6 LX_CAMERA_WORK_MODE

Chức năng:

Từ khóa	Mô tả
KEEP_HEARTBEAT	Chế độ heartbeat, camera SDK chuyển sang trạng thái chờ sau khi heartbeat bị gián đoạn
WORK_FOREVER	Chế độ luôn bật, camera luôn duy trì hoạt động

5.7 LX_TRIGGER_MODE

Chức năng:

Từ khóa	Mô tả
LX_TRIGGER_MODE_OFF	Đóng chế độ trigger, chế độ streaming, mặc định
LX_TRIGGER_SOFTWARE	Chế độ trigger mềm
LX_TRIGGER_HARDWARE	Chế độ trigger cứng

5.8 LX_CAMERA_FEATURE

Chức năng: các tham số có thể đọc và ghi

5.8.1 int type parameters

5.8.1.1 Tham số chung

Từ khóa	Mô tả
LX_INT_FIRST_EXPOSURE	Giá trị phơi sáng, đơn vị us; với nhiều điểm, đây là thời gian phơi sáng của điểm đầu tiên
LX_INT_SECOND_EXPOSURE	Với nhiều điểm, thời gian phơi sáng của điểm thứ hai
LX_INT_THIRD_EXPOSURE	Với nhiều điểm, thời gian phơi sáng của điểm thứ ba; một số model hỗ trợ
LX_INT_FOURTH_EXPOSURE	Với nhiều điểm, thời gian phơi sáng của điểm thứ tư; một số model hỗ trợ
LX_INT_GAIN	Độ lợi, tương đương hiệu ứng phơi sáng. Độ lợi tạo thêm nhiễu; có thể điều chỉnh phù hợp để tránh tham số phơi sáng quá lớn
LX_INT_MIN_DEPTH	Giá trị độ sâu nhỏ nhất; giá trị ngoài phạm vi không hợp lệ
LX_INT_MAX_DEPTH	Giá trị độ sâu lớn nhất; giá trị ngoài phạm vi không hợp lệ
LX_INT_MIN_AMPLITUDE	Giá trị cường độ tín hiệu hiệu dụng nhỏ nhất; giá trị độ sâu ngoài phạm vi không hợp lệ
LX_INT_MAX_AMPLITUDE	Giá trị cường độ lớn nhất của tín hiệu hợp lệ; giá trị độ sâu ngoài phạm vi được đặt là không hợp lệ
LX_INT_CODE_MODE	Chế độ mã hóa của camera ánh sáng cấu trúc, tham chiếu CODE_MODE (một số model hỗ trợ)
LX_INT_WORK_MODE	Chế độ làm việc, tham chiếu LX_CAMERA_WORK_MODE
LX_INT_LINK_SPEED	Tốc độ card mạng đã thương lượng là 100-100 Mbit/s hoặc 1000-1000 Mbit/s; chỉ hỗ trợ đọc, không thể đặt
LX_INT_TOF_GLOBAL_OFFSET	Độ lệch dữ liệu độ sâu ToF
LX_INT_ALGORITHM_MODE	Chế độ bật thuật toán tích hợp, một số model hỗ trợ; giá trị tương ứng tham chiếu LX_ALGORITHM_MODE
LX_INT_TRIGGER_MODE	Chế độ trigger, giá trị tương ứng tham chiếu LX_TRIGGER_MODE
LX_INT_MODBUS_ADDR	Địa chỉ modbus; một số model hỗ trợ xuất giao thức MODBUS qua cổng nối tiếp
LX_INT_HEART_TIME	Thời gian heartbeat; camera tự chuyển sang chờ nếu hết thời gian mà không nhận được heartbeat
LX_INT_GVSP_PACKET_SIZE	Kích thước gói dữ liệu đơn GVSP, đơn vị byte
LX_INT_CALCULATE_UP	Cho phép thuật toán tof hoặc rgb dịch lên xuống, giảm tải tính toán cho máy chủ hoặc camera nhưng có thể ảnh hưởng tốc độ khung hình và độ trễ
LX_INT_CAN_BAUD_RATE	Giá trị tốc độ baud của can, đơn vị bps
LX_INT_SAVE_PARAMS_GROUP	Lưu cấu hình camera hiện tại thành nhóm tham số được chỉ định
LX_INT_LOAD_PARAMS_GROUP	Tải nhóm tham số của chỉ mục được chỉ định bằng một lần nhấp

5.8.1.2 Tham số ảnh 3D

Từ khóa	Mô tả
LX_INT_3D_IMAGE_WIDTH	Chiều rộng hiện tại của độ phân giải ảnh 3D
LX_INT_3D_IMAGE_HEIGHT	Chiều cao hiện tại của độ phân giải ảnh 3D
LX_INT_3D_IMAGE_OFFSET_X	Số pixel lệch ngang ROI, sử dụng DcSetRoI để đặt tham số
LX_INT_3D_IMAGE_OFFSET_Y	Số pixel lệch dọc ROI, sử dụng DcSetRoI để đặt tham số
LX_INT_3D_BINNING_MODE	Gộp pixel, tham chiếu LX_BINNING_MODE
LX_INT_3D_DEPTH_DATA_TYPE	Định dạng dữ liệu ảnh độ sâu, chỉ có thể đọc. Giá trị tương ứng tham chiếu LX_DATA_TYPE
LX_INT_3D_AMPLITUDE_CHANNEL	Số kênh ảnh cường độ 3D, dùng chung với số kênh ảnh độ sâu
LX_INT_3D_AMPLITUDE_DATA_TYPE	Định dạng dữ liệu ảnh cường độ, chỉ có thể đọc. Giá trị tương ứng tham chiếu LX_DATA_TYPE
LX_INT_3D_AUTO_EXPOSURE_LEVEL	Mức phơi sáng khi bật phơi sáng tự động 3D; trong thời gian này không được đặt giá trị phơi sáng và độ lợi
LX_INT_3D_AUTO_EXPOSURE_MAX	Giới hạn trên của phơi sáng tự động 3D
LX_INT_3D_AUTO_EXPOSURE_MIN	Giới hạn dưới của phơi sáng tự động 3D
LX_INT_3D_UNDISTORT_SCALE	Hệ số khử méo ảnh 3D

5.8.1.4 Tham số ảnh 2D

Từ khóa	Mô tả
LX_INT_2D_IMAGE_CHANNEL	Số kênh ảnh 2D; ảnh đơn sắc là 1, ảnh màu là 3
LX_INT_2D_IMAGE_WIDTH	Chiều rộng hiện tại của độ phân giải ảnh 2D
LX_INT_2D_IMAGE_HEIGHT	Chiều cao hiện tại của độ phân giải ảnh 2D
LX_INT_2D_IMAGE_OFFSET_X	Số pixel lệch ngang ROI ảnh 2D, chỉ có thể đọc; sử dụng DcSetRoI để đặt tham số
LX_INT_2D_IMAGE_OFFSET_Y	Số pixel lệch dọc ROI ảnh 2D, chỉ có thể đọc; sử dụng DcSetRoI để đặt tham số
LX_INT_2D_BINNING_MODE	Gộp pixel, tham chiếu LX_BINNING_MODE
LX_INT_2D_MANUAL_EXPOSURE	Giá trị phơi sáng khi phơi sáng thủ công 2D
LX_INT_2D_MANUAL_GAIN	Giá trị độ lợi khi phơi sáng thủ công 2D
LX_INT_2D_AUTO_EXPOSURE_LEVEL	Mức phơi sáng khi phơi sáng tự động ảnh 2D
LX_INT_2D_IMAGE_DATA_TYPE	Định dạng dữ liệu ảnh 2D, chỉ có thể đọc. Giá trị tương ứng tham chiếu LX_DATA_TYPE
LX_INT_2D_UNDISTORT_SCALE	Hệ số khử méo ảnh 2D

5.8.1.5 Tham số trigger

Từ khóa	Mô tả
LX_INT_TRIGGER_MODE	Chế độ trigger, giá trị tương ứng tham chiếu LX_TRIGGER_MODE
LX_INT_HARDWARE_TRIGGER_FILTER_TIME	Thời gian lọc trigger cứng, đơn vị us
LX_INT_TRIGGER_MIN_PERIOD_TIME	Khoảng thời gian trigger tối thiểu, đơn vị us
LX_INT_TRIGGER_DELAY_TIME	Thời gian trễ trigger tính bằng µs. Giá trị <= 1000 có hiệu lực ngay; giá trị lớn hơn 1000 có hiệu lực sau một khoảng trễ. Tính năng này được dành riêng.
LX_INT_TRIGGER_FRAME_COUNT	Số khung hình của một trigger
LX_INT_IO_WORK_MODE	Chế độ điều khiển đầu ra tín hiệu GPIO, tham chiếu LX_IO_WORK_MODE
LX_INT_IO_OUTPUT_STATE	Chế độ điều khiển đầu ra tín hiệu GPIO của người dùng, tham chiếu LX_IO_OUTPUT_STATE

5.8.1.6 Tham số bộ lọc

Từ khóa	Mô tả
LX_INT_FILTER_MODE	Chế độ bộ lọc, tham chiếu LX_FILTER_MODE
LX_INT_FILTER_SMOOTH_LEVEL	Khi LX_INT_FILTER_MODE là FILTER_NORMAL, có thể đặt mức làm mượt bộ lọc trong [0, 3]; giá trị càng lớn, mức lọc càng mạnh
LX_INT_FILTER_NOISE_LEVEL	Khi LX_INT_FILTER_MODE là FILTER_NORMAL, có thể đặt mức nhiễu của bộ lọc trong [0, 3]; giá trị càng lớn, mức lọc càng mạnh
LX_INT_FILTER_TIME_LEVEL	Khi LX_INT_FILTER_MODE là FILTER_NORMAL, có thể đặt mức miền thời gian của bộ lọc trong [0, 3]. Giá trị càng lớn, mức lọc càng mạnh

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

​Tổng quan

​Thiết lập môi trường

​Cấu hình máy chủ khuyến nghị

​Kết nối và cài đặt

​Kết nối phần cứng

​Cấu hình mạng

​Install the SDK

Windows

Linux

​Sử dụng Camera SDK

​Cấu trúc thư mục

​Quy trình phát triển

​Cấu hình dự án

​Luồng gọi đồng bộ

​Luồng gọi bất đồng bộ

​Yêu cầu khi gọi

​Loại tham số và API tương ứng

​Điều kiện trước khi gọi API

​Kiểu dữ liệu

​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 type parameters

5.8.1.1 Tham số chung

5.8.1.2 Tham số ảnh 3D

5.8.1.4 Tham số ảnh 2D

5.8.1.5 Tham số trigger

5.8.1.6 Tham số bộ lọc

​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

Tổng quan

Thiết lập môi trường

Cấu hình máy chủ khuyến nghị

Kết nối và cài đặt

Kết nối phần cứng

Cấu hình mạng

Install the SDK

Sử dụng Camera SDK

Cấu trúc thư mục

Quy trình phát triển

Cấu hình dự án

Luồng gọi đồng bộ

Luồng gọi bất đồng bộ

Yêu cầu khi gọi

Loại tham số và API tương ứng

Điều kiện trước khi gọi API

Kiểu dữ liệu

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 type 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

6.9.2 DcUnregisterCameraStatusCallback

Versions and updates