Guida utente di Camera SDK

Panoramica

Questa guida è destinata agli sviluppatori che integrano dispositivi fotografici. Copre le API di Camera SDK per i prodotti delle serie M4, M4 Mega, M4 Pro, V1 Pro, S2, S2 Max e H3. L’SDK funziona su Windows x86 e su Linux x86 o Arm. Camera SDK fornisce API unificate per l’accesso ai dispositivi e la configurazione dei parametri. Supporta l’acquisizione sincrona e asincrona di dati di profondità, intensità, nuvole di punti e RGB. Alcuni modelli forniscono anche dati per l’evitamento degli ostacoli, l’aggancio o la localizzazione.

Gli esempi e le descrizioni delle API si basano sulla versione dell’SDK distribuita con il prodotto. I parametri disponibili possono variare in base al prodotto, al firmware e alla versione dell’SDK.

Gli esempi sono indicazioni per lo sviluppo e potrebbero non coprire tutti i dispositivi o casi d’uso.

Configurazione dell’ambiente

Configurazione host consigliata

Voce di configurazione	Configurazione consigliata
Sistema operativo	Windows 7, Windows 10 o Windows 11; Ubuntu 16.04 o versioni successive
Memoria	4 GB o più
CPU	Cortex-A57 quad-core o equivalente e superiore
Scheda di rete	Gigabit Ethernet o superiore

Connessione e installazione

Connessione hardware

Collega la fotocamera a un’alimentazione esterna da 24 V e al computer host tramite un cavo di rete, come mostrato nella Figura 2.1. Figura 2.1 Diagramma del collegamento della fotocamera

Configurazione di rete

Il segmento di rete IP predefinito della fotocamera è 192.168.100.*.
Sul computer host, imposta l’indirizzo IP della porta di rete collegata alla fotocamera su un indirizzo del segmento 192.168.100.x e assicurati che non entri in conflitto con il dispositivo. La subnet mask è 255.255.255.0, come mostrato nella figura seguente:
Quando colleghi la fotocamera, ti consigliamo di disattivare il firewall per impedire che i pacchetti dati della fotocamera vengano intercettati dall’host su cui si trova l’SDK, come mostrato nella figura seguente:
La configurazione di rete di Linux è uguale a quella di Windows. I comandi del firewall variano in base alla distribuzione. Su Ubuntu, esegui:

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

Installare l’SDK

Windows

Apri il pacchetto di installazione e installa Lanxin-MRDVS-xxx.exe. Per installarlo per tutti gli utenti sono necessari i diritti di amministratore. La figura seguente mostra la procedura di installazione.

Linux

Decomprimi il pacchetto ed esegui lo script di installazione:

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

Lo script installa l’SDK in /opt/Lanxin-MRDVS e configura le variabili d’ambiente per l’utente corrente. Se il programma viene eseguito da un altro utente, esegui nuovamente lo script per quell’utente oppure aggiungi la riga seguente al relativo ~/.bashrc:

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

Per le sessioni del terminale aperte prima dell’installazione, esegui il comando seguente prima di avviare il programma:

source ~/.bashrc

Utilizzare Camera SDK

Struttura delle directory

La directory di Camera SDK contiene i seguenti elementi:

Camera SDK directory structure correlato diagram

Document contiene various documentation per il SDK
FirmWare contiene fotocamera firmware upgrade package
Sample contiene esempio codice using il Camera SDK in various programming languages
SDK includono il header file e library file di Camera SDK

Flusso di sviluppo

Configurare il progetto

Per l’integrazione dell’SDK si consiglia C/C++. L’SDK includono un file CMakeLists.txt per le build CMake e la cartella Sample contiene esempi in più linguaggi. Per i dettagli, consulta gli esempi in Sample e la guida agli esempi Linux.

Synchronous call flow

Asynchronous call flow

Requisiti per le chiamate

Tipi di parametro e API corrispondenti

For enumeration types prefixed con LX_INT, utilizzare DcSetIntValue o DcGetIntValue a impostare o ottenere INT tipo parametri;
For enumeration types prefixed con LX_FLOAT, utilizzare DcSetFloatValue o DcGetFloatValue a impostare o ottenere FLOAT tipo parametri;
For enumeration types prefixed con LX_BOOL, utilizzare DcSetBoolValue o DcGetBoolValue a impostare o ottenere BOOL tipo parametri;
For enumeration types prefixed con LX_STRING, utilizzare DcSetStringValue o DcGetStringValue a impostare o ottenere string tipo parametri;
Use DcSetCmd a execute instructions per enumeration types prefixed con LX_CMD;
For enumeration types prefixed con LX_PTR, utilizzare DcGetPtrValue a obtain pointer tipo risultati;

Precondizioni delle API

When streaming è active, o quando LX_INT_WORK_MODE è impostare a always-on mode, do not impostare il functions listed below.

1. When il flow è avviato o il working mode (LX_INT_WORK_MODE) è normally aprire mode, il seguente functions sono not allowed a be impostare:

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. Settings sono not allowed even quando il working mode (LX_INT_WORK_MODE) è normally aprire:

LX_INT_TOF_FREQMODE

3. When 3D automatic exposure (LX_BOOL_ENABLE_3D_AUTO_EXPOSURE) è turned on, il seguente funzione enumeration operations sono not allowed:

LX_BOOL_ENABLE_MULTI_EXPOSURE_HDR ;
LX_INT_FIRST_EXPOSURE;
LX_INT_SECOND_EXPOSURE;
LX_INT_THIRD_EXPOSURE;
LX_INT_GAIN;

4.When 3D automatic exposure (LX_BOOL_ENABLE_3D_AUTO_EXPOSURE) è turned off, il seguente funzione enumeration è not allowed a operate:

LX_INT_3D_AUTO_EXPOSURE_LEVEL

Setting il 3D automatic exposure massimo valore (LX_INT_3D_AUTO_EXPOSURE_MAX) e minimo valore è not allowed

(LX_INT_3D_AUTO_EXPOSURE_MIN)

5. When 2D automatic exposure (LX_BOOL_ENABLE_2D_AUTO_EXPOSURE) è turned on, il seguente funzione enumeration operations sono not allowed:

LX_INT_2D_MANUAL_EXPOSURE

6. When 2D automatic exposure (LX_BOOL_ENABLE_2D_AUTO_EXPOSURE) is turned off, the following function enumeration is not allowed to operate:

LX_INT_2D_AUTO_EXPOSURE_LEVEL;

7.In extraordinary filtering mode, the following settings are not allowed:

LX_INT_FILTER_SMOOTH_LEVEL LX_INT_FILTER_NOISE_LEVEL
LX_INT_FILTER_TIME_LEVEL

8.When turning on 2D anti-distortion, RGB-D alignment must be turned on first:

LX_BOOL_ENABLE_2D_TO_DEPTH

9.For non-S2 type devices, when turning on the built-in algorithm, you need to set the tof algorithm first. The algorithm parameters are only allowed to be set when the built-in algorithm (LX_INT_ALGORITHM_MODE) is turned on.

(LX_STRING_ALGORITHM_PARAMS)

10.To obtain point cloud data (LX_PTR_XYZ_DATA), you must first open the depth map

(LX_BOOL_ENABLE_3D_DEPTH_STREAM)

Data types

5.1 LX_STATE

Function: SDK interface funzione return valore stato codice

Keywords	Description
LX_SUCCESS	Function esecuzione riuscita
LX_ERROR	Function esecuzione failed
LX_E_NOT_SUPPORT	Il connected fotocamera does not support questo funzione
LX_E_NETWORK_ERROR	Network communication errore
LX_E_INPUT_ILLEGAL	Illegal funzione parametri passed in
LX_E_RECONNECTING	Device reconnecting
LX_E_DEVICE_ERROR	Equipment errore
LX_E_DEVICE_NEED_UPDATE	Il dispositivo versione è too low e il firmware versione needs a be upgraded
LX_E_API_NEED_UPDATE	API versione è too low, SDK needs a be upgraded
LX_E_CTRL_PERMISS_ERROR	Exclusive control permission failed (il dispositivo può solo have one SDK connection at il stesso time)
LX_E_GET_DEVICEINFO_ERROR	Failed a obtain dispositivo informazioni
LX_E_IMAGE_SIZE_ERROR	Image size does not match, reopen il fotocamera
LX_E_IMAGE_PARTITION_ERROR	Image parsing failed
LX_E_DEVICE_NOT_CONNECTED	Camera not connected
LX_E_DEVICE_INIT_FAILED	Camera initialization failed
LX_E_DEVICE_NOT_FOUND	No matching fotocamera found
LX_E_FILE_INVALID	File errore (incorrect file nome o tipo o format)
LX_E_CRC_CHECK_FAILED	File crc o md5 verification failed
LX_E_TIME_OUT	Timeout
LX_E_FRAME_LOSS	Missing frame
LX_E_ENABLE_ANYSTREAM_FAILED	Failed a aprire any stream
LX_E_NOT_RECEIVE_STREAM	Streaming dati not received
LX_E_PARSE_STREAM_FAILED	Streaming avviato successfully but failed a parse stream dati
LX_E_PROCESS_IMAGE_FAILED	Image calculation processing failed
LX_E_SETTING_NOT_ALLOWED	Setting è not allowed in normally aprire mode
LX_E_LOAD_DATAPROCESSLIB_ERROR	Error loading immagine processing algorithm library
LX_E_FUNCTION_CALL_LOGIC_ERROR	Function call logica errore
LX_E_IPAPPDR_UNREACHABLE_ERROR	IP unreachable o network configurazione errore
LX_E_FRAME_ID_NOT_MATCH	Frame out di sync errore within timeout range
LX_E_FRAME_MULTI_MACHINE	Multi-machine interference signal detected in il frame

5.2 LX_DATA_TYPE

Function: dati format. 3D intensità map e profondità map have diverso dati formats. To obtain il dati pointer, you devi a utilizzare il corrispondente feature.

Keywords	Description
LX_DATA_UNSIGNED_CHAR	Unsigned character tipo
LX_DATA_UNSIGNED_SHORT	Unsigned short integer
LX_DATA_SIGNED_SHORT	Signed short
LX_DATA_FLOAT	Floating punto tipo
LX_DATA_OBSTACLE	Obstacle avoidance algorithm structure tipo
LX_DATA_PALLET	Pallet algorithm structure tipo
LX_DATA_LOCATION	Visual positioning algorithm structure tipo
LX_DATA_OBSTACLE	Obstacle avoidance algorithm V2 structure tipo

5.3 LX_BINNING_MODE

Function: Bining mode

Keywords	Description
LX_BINNING_1X1	1x1Binning
LX_BINNING_2X2	2x2Binning
LX_BINNING_4X4	4x4Binning

5.4 LX_STRUCT_LIGHT_CODE_MODE

Function:

Keywords	Description
LX_CODE_NORMAL	General
LX_CODE_STATBLE	Stable
LX_CODE_ENHANCE	High precision enhancement

5.5 LX_ALGORITHM_MODE

Function:

Keywords	Description
MODE_ALL_OFF	Turn off il fotocamera’s built-in algorithm
MODE_AVOID_OBSTACLE	Built-in obstacle avoidance algorithm
MODE_PALLET_LOCATE	Built-in pallet algorithm
MODE_VISION_LOCATION	Built-in visual positioning algorithm
MODE_AVOID_OBSTACLE2	Built-in obstacle avoidance algorithm V2

5.6 LX_CAMERA_WORK_MODE

Function:

Keywords	Description
KEEP_HEARTBEAT	Heartbeat mode, SDK fotocamera enters standby state dopo heartbeat interruption
WORK_FOREVER	Normally on mode, il fotocamera always keeps working

5.7 LX_TRIGGER_MODE

Function:

Keywords	Description
LX_TRIGGER_MODE_OFF	Close trigger mode, streaming mode, predefinito
LX_TRIGGER_SOFTWARE	Soft trigger mode
LX_TRIGGER_HARDWARE	Hard trigger mode

5.8 LX_CAMERA_FEATURE

Function: Various readable e writable parametri

5.8.1 int tipo parametri

5.8.1.1 General parametri

Keywords	Description
LX_INT_FIRST_EXPOSURE	Exposure valore, unit us, per multiple points, it è il exposure time di il prima punto
LX_INT_SECOND_EXPOSURE	For multiple points, il exposure time di il second punto
LX_INT_THIRD_EXPOSURE	In il case di multiple points, il exposure time di il third punto è supportato da some models
LX_INT_FOURTH_EXPOSURE	In il case di multiple points, il exposure time di il fourth punto è supportato da some models
LX_INT_GAIN	Gain, equivalent a exposure effect. Noise sarà be introduced, e il gain può be appropriately adjusted a prevent il exposure parametri da being too large
LX_INT_MIN_DEPTH	Minimum profondità valore, valori outside il range sono invalid
LX_INT_MAX_DEPTH	Maximum profondità valore, valori outside il range sono invalid
LX_INT_MIN_AMPLITUDE	Minimum effective signal strength valore, profondità valore beyond il range è invalid
LX_INT_MAX_AMPLITUDE	Il massimo strength valore di il valid signal, il profondità valore beyond il range è impostare a be invalid
LX_INT_CODE_MODE	Structural light fotocamera encoding mode, refer a CODE_MODE (supportato da some models)
LX_INT_WORK_MODE	Working mode, refer a LX_CAMERA_WORK_MODE
LX_INT_LINK_SPEED	Il negotiated network card speed è 100-100 Mbit/s, 1000-1000 Mbit/s, solo supports acquisition e cannot be impostare
LX_INT_TOF_GLOBAL_OFFSET	ToF profondità dati offset
LX_INT_ALGORITHM_MODE	Built-in algorithm enable mode, supportato da some models, il corrispondente valori refer a LX_ALGORITHM_MODE
LX_INT_TRIGGER_MODE	Trigger mode, il corrispondente valore refers a LX_TRIGGER_MODE
LX_INT_MODBUS_ADDR	modbus address, some models support MODBUS protocol output through il serial port
LX_INT_HEART_TIME	Heartbeat time, il fotocamera sarà automatically standby if it times out e does not receive a heartbeat
LX_INT_GVSP_PACKET_SIZE	GVSP single packet dati packet size, unit byte
LX_INT_CALCULATE_UP	Allow il tof o rgb algorithm a move up e down, saving il computing power di il host computer o fotocamera, which may affect il frame rate e delay
LX_INT_CAN_BAUD_RATE	baud rate valore di può, unit bps
LX_INT_SAVE_PARAMS_GROUP	Save il corrente fotocamera configurazione come il specified parametro group
LX_INT_LOAD_PARAMS_GROUP	Load il parametro group di il specified index con one click

5.8.1.2 3D immagine parametri

Keywords	Description
LX_INT_3D_IMAGE_WIDTH	3D immagine resolution corrente larghezza
LX_INT_3D_IMAGE_HEIGHT	3D immagine resolution corrente altezza
LX_INT_3D_IMAGE_OFFSET_X	ROI horizontal offset pixels, please utilizzare DcSetRoI a impostare parametri
LX_INT_3D_IMAGE_OFFSET_Y	ROI vertical offset pixels, please utilizzare DcSetRoI a impostare parametri
LX_INT_3D_BINNING_MODE	Pixel merging, refer a LX_BINNING_MODE
LX_INT_3D_DEPTH_DATA_TYPE	Depth immagine dati format, può solo be obtained. For il corrispondente valore, refer a LX_DATA_TYPE
LX_INT_3D_AMPLITUDE_CHANNEL	numero di 3D intensità immagine channels, shared con profondità immagine channels
LX_INT_3D_AMPLITUDE_DATA_TYPE	Intensity immagine dati format, può solo be obtained. For il corrispondente valore, refer a LX_DATA_TYPE
LX_INT_3D_AUTO_EXPOSURE_LEVEL	Il exposure level quando 3D automatic exposure è turned on, during which exposure valore e gain sono not allowed a be impostare
LX_INT_3D_AUTO_EXPOSURE_MAX	3D automatic exposure upper limit
LX_INT_3D_AUTO_EXPOSURE_MIN	3D automatic exposure basso limit valore
LX_INT_3D_UNDISTORT_SCALE	3D immagine anti-distortion coefficient

5.8.1.4 2D immagine parametri

Keywords	Description
LX_INT_2D_IMAGE_CHANNEL	2D immagine channel numero, monochrome è 1, color è 3
LX_INT_2D_IMAGE_WIDTH	2D immagine resolution corrente larghezza
LX_INT_2D_IMAGE_HEIGHT	2D immagine resolution corrente altezza
LX_INT_2D_IMAGE_OFFSET_X	2D immagine ROI horizontal offset pixels, può solo be obtained, please utilizzare DcSetRoI a impostare parametri
LX_INT_2D_IMAGE_OFFSET_Y	2D immagine ROI vertical offset pixels, può solo be obtained, please utilizzare DcSetRoI a impostare parametri
LX_INT_2D_BINNING_MODE	Pixel merging, refer a LX_BINNING_MODE
LX_INT_2D_MANUAL_EXPOSURE	Exposure valore during 2D manual exposure
LX_INT_2D_MANUAL_GAIN	Gain valore during 2D manual exposure
LX_INT_2D_AUTO_EXPOSURE_LEVEL	Exposure level during automatic exposure di 2D immagini
LX_INT_2D_IMAGE_DATA_TYPE	2D immagine dati format, può solo be obtained. For il corrispondente valore, refer a LX_DATA_TYPE
LX_INT_2D_UNDISTORT_SCALE	2D immagine anti-distortion coefficient

5.8.1.5 Trigger parametri

Keywords	Description
LX_INT_TRIGGER_MODE	Trigger mode, il corrispondente valore refers a 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 valore <= 1000 takes effect immediately. Values greater than 1000 take effect dopo a delay. Questo feature è reserved.
LX_INT_TRIGGER_FRAME_COUNT	Single trigger frame numero
LX_INT_IO_WORK_MODE	GPIO signal output control mode, refer a LX_IO_WORK_MODE
LX_INT_IO_OUTPUT_STATE	User control mode di GPIO signal output, refer a LX_IO_OUTPUT_STATE

5.8.1.6 Filter parametri

Keywords	Description
LX_INT_FILTER_MODE	Filter mode, refer a LX_FILTER_MODE
LX_INT_FILTER_SMOOTH_LEVEL	When LX_INT_FILTER_MODE è FILTER_NORMAL, può impostare il filter smoothing level, [0, 3], il larger il valore, il stronger il filtering
LX_INT_FILTER_NOISE_LEVEL	When LX_INT_FILTER_MODE è FILTER_NORMAL, può impostare il filter noise level, [0, 3], il larger il valore, il stronger il filtering
LX_INT_FILTER_TIME_LEVEL	When LX_INT_FILTER_MODE è FILTER_NORMAL, può impostare il filter time domain level, [0, 3]. Il larger il valore, il stronger il filtering

5.8.2 float tipo parametri

Keywords	Description
LX_FLOAT_FILTER_LEVEL	Filtering level, 0-1, il larger il valore, il higher il filtering intensità
LX_FLOAT_EST_OUT_EXPOSURE	Whether a evaluate overexposure dati, 0-1, if 1, il overexposure dati è invalid
LX_FLOAT_LIGHT_INTENSITY	Light intensità, supportato da some models
LX_FLOAT_3D_DEPTH_FPS	Current frame rate di profondità map
LX_FLOAT_3D_AMPLITUDE_FPS	Current frame rate di intensità map
LX_FLOAT_2D_IAMGE_FPS	RGB immagine corrente frame rate
LX_FLOAT_DEVICE_TEMPERATURE	Get il corrente fotocamera temperature

5.8.3 bool tipo parametro

Keywords	Description
LX_BOOL_CONNECT_STATE	Current connection stato
LX_BOOL_ENABLE_3D_DEPTH_STREAM	Turn on/off il profondità map (supportato da some fotocamere)
LX_BOOL_ENABLE_3D_AMP_STREAM	Turn on/off intensità map (supportato da some fotocamere)
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 dati, 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, supportato da some models
LX_BOOL_ENABLE_MULTI_EXPOSURE_HDR	HDR (multi-exposure high dynamic range mode) enabled
LX_BOOL_ENABLE_SYNC_FRAME	Whether a enable forced frame synchronization, il predefinito dati real-time priority è given, if RGB-D synchronization è richiesto, needs a enable questo mode

5.8.4 string tipo parametri

Keywords	Description
LX_STRING_DEVICE_VERSION	Device versione numero
LX_STRING_FIRMWARE_NAME	Firmware file nome, used a upgrade dispositivo versione, può solo be impostare
LX_STRING_FILTER_PARAMS	Filter algorithm parametri, string in json format
LX_STRING_ALGORITHM_PARAMS	Built-in algorithm parametri, diverso opening modes, corrispondente a diverso json format strings, prerequisite needs a be impostare LX_ALGORITHM_MODE
LX_STRING_ALGORITHM_VERSION	Built-in algorithm versione numero, diverso opening modes, return il corrispondente versione numero, può solo be obtained, prerequisite needs a be impostare LX_ALGORITHM_MODE
LX_STRING_DEVICE_OS_VERSION	Device sistema immagine versione numero
LX_STRING_IMPORT_PARAMS_FROM_FILE	Load parametri da local file a fotocamera
LX_STRING_EXPORT_PARAMS_TO_FILE	Export il corrente parametri di il fotocamera a a local file

5.8.5 Command tipo parametri

Keywords	Description
LX_CMD_GET_NEW_FRAME	Update dati once, predefinito timeout è 1s
LX_CMD_RETURN_VERSION	Roll back a il previous versione
LX_CMD_RESTART_DEVICE	Restart fotocamera
LX_CMD_WHITE_BALANCE	Auto white balance
LX_CMD_RESET_PARAM	Restore predefinito parametri

5.8.6 ptr tipo parametri

Keywords	Description
LX_PTR_2D_IMAGE_DATA	Get il 2D immagine dati pointer, il dati length è determined da il 2D immagine size, channel numero e dati format (LX_INT_2D_IMAGE_DATA_TYPE)
LX_PTR_3D_AMP_DATA	Get il 3D intensità map dati pointer. Il dati length è determined da il 3D immagine size, channel numero e dati format (LX_INT_3D_AMPLITUDE_DATA_TYPE)
LX_PTR_3D_DEPTH_DATA	Get il 3D profondità map dati pointer. Il dati length è determined da il 3D immagine size, channel numero e dati format (LX_INT_3D_DEPTH_DATA_TYPE)
LX_PTR_XYZ_DATA	Get il punto nuvola dati pointer, three channels di float* tipo (x, y, z sono a impostare di dati, looped in sequence), il dati length è LX_INT_3D_IMAGE_WIDTH_LX_INT_3D_IMAGE_HEIG HT_sizeof(float)*3
LX_PTR_ALGORITHM_OUTPUT	Get il built-in algorithm output, correlato a il algorithm mode. MODE_AVOID_OBSTACLE è il LxAvoidanceOutput pointer, MODE_PALLET_LOCATE è il LxPalletPose pointer, e MODE_VISION_LOCATION è il reference LxLocation pointer
LX_PTR_2D_INTRIC_PARAM	Get 2D immagine internal parametri, float* tipo pointer, length è fixed at 9*sizeof(float)(fx,fy,cx,cy,k1,k2,p1,p2,k3)
LX_PTR_3D_INTRIC_PARAM	Get 3D immagine internal parametri, float* tipo pointer, length è fixed at 9*sizeof(float)(fx,fy,cx,cy,k1,k2,p1,p2,k3)
LX_PTR_3D_EXTRIC_PARAM	Get il 3D immagine external parametri, float* tipo pointer, il length di è fixed at 12*sizeof(float) (il prima 9 represent il rotation matrix, il last 3 represent il translation vector)
LX_PTR_FRAME_DATA	Obtain a complete frame di dati, e il output risultato refers a il structure FrameInfo

5.9 LxDeviceInfo

Function: Device attribute informazioni structure

Field	Type	Description
handle	DcHandle	dispositivo unique identifier
dev_type	LX_DEVICE_TYPE	Device tipo
id	Char array	dispositivo id
ip	Char array	Device ip:port
sn	Char array	Device serial numero
mac	Char array	dispositivo mac address
firmware_ver	Char array	Device software versione numero
algor_ver	Char array	Device algorithm versione numero
nome	Char array	Device nome, such come: fotocamera_M3_192.168.11.13_9803
reserve	Char array	reserved campo, subnet mask
reserve2	Char array	Reserved campo 2, gateway
reserve3	Char array	Reserved campo 3
reserve4	Char array	Reserved campo 4

5.10 LxIntValueInfo

Function: Device attribute informazioni structure

Field	Type	Description
impostare_available	Bool	Whether il corrente valore è settable, true - può be impostare, false - cannot be impostare
cur_value	Int	Current valore
max_value	Int	massimo valore
min_value	Int	Minimum valore
reserve	Int array	reserved campo

5.11 LxFloatValueInfo

Function: Device attribute informazioni structure

Field	Type	Description
impostare_available	Bool	Whether il corrente valore può be impostare, true - può be impostare, false - cannot be impostare
cur_value	float	corrente valore
max_value	float	massimo valore
min_value	float	minimo valore
reserve	float array	reserved campo

5.12 LX_DEVICE_TYPE

Function: dispositivo tipo

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

5.13 LX_OPEN_MODE

Function: dispositivo tipo

Keywords	Description
OPEN_BY_INDEX	Open according a il index subscript in il search elenco. Il corrispondente parametro è il index numero. When il searched dispositivo elenco changes, il dispositivo selected da a aprire sarà anche be diverso
OPEN_BY_IP	Open according a il corrispondente ip in il search elenco, e il corrispondente parametro è il dispositivo ip o ip:port
OPEN_BY_SN	Open according a il corrispondente sn mode in il search elenco, e il corrispondente parametro è il dispositivo sn
OPEN_BY_ID	Open according a il corrispondente id in il search elenco, e il corrispondente parametro è il dispositivo id

5.14 FrameDataInfo

Function: Image visualizzare informazioni structure

Field	Type	Description
frame_data_type	LX_DATA_TYPE	Frame dati tipo
frame_width	Int	Frame dati immagine larghezza
frame_height	Int	Frame dati immagine altezza
frame_channel	Int	numero di frame dati channels
frame_data	Void *pointer tipo	frame dati content
sensor_timestamp	Unsigned long long tipo	sensor immagine timestamp
recv_timestamp	Unsigned long long tipo	Il timestamp quando il frame dati è received

5.15 FrameInfo

Function: Data frame informazioni structure

Field	Type	Description
frame_state	LX_STATE	Frame dati stato
handle	DcHandle	dispositivo unique identifier
profondità_data	FrameDataInfo tipo	Depth map frame dati structure
amp_data	FrameDataInfo tipo	Intensity map frame dati structure
rgb_data	FrameDataInfo tipo	Rgb frame dati structure
app_data	FrameDataInfo tipo	Algorithm output structure
reserve_data	Void *pointer tipo	extended reserved campo

API reference

API prototypes sono defined da il SDK headers e il shipped SDK versione. Unless noted otherwise, LX_SUCCESS indicates a riuscita call.

6.1 Find, connect e chiudere il fotocamera

6.1.1 DcGetDeviceList

Prototipo della funzione: Funzione: Get a elenco di supportato fotocamere. Parametri della funzione:

[out]devlist Found fotocamera elenco
[out]devnum numero di fotocamere found

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Note: Il memoria è maintained internally, e there è no devi a allocate external memoria. However, because il original content sarà be cleared prima each search, external thread safety needs a be ensured.

6.1.2 DcOpenDevice

Prototipo della funzione:

Funzione: Connect tuo dispositivo. Parametri della funzione:

[in]aprire_mode aprire mode, see OpenMode per dettagli
[in]param diverso opening metodi, fill in diverso parametri
[out]handle è il dispositivo handle returned dopo riuscita connection. All subsequent interface access depends on questo handle.
[out]info Camera dettagli returned dopo riuscita connection

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.1.3 DcCloseDevice

Prototipo della funzione:

Funzione: Turn off il dispositivo Parametri della funzione:

[in]handle dispositivo handle

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.2 Start streaming e chiudere streaming

6.2.1 DcStartStream

Prototipo della funzione:

**Function:**Open dati stream Parametri della funzione:

[in]handle dispositivo handle

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.2.2 DcStopStream

Prototipo della funzione:

**Function:**Close dati flow Parametri della funzione:

[in]handle dispositivo handle

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.3 Reading e setting fotocamera parametri

6.3.1 DcSetIntValue

Prototipo della funzione:

Funzione: Set int tipo parametri Parametri della funzione:

[in]handle dispositivo handle
[in]cmd reference LX_CAMERA_FEATURE
[in]valore sets parametro valore

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.3.2 DcGetIntValue

Prototipo della funzione:

Funzione: Get int tipo parametri Parametri della funzione:

[in]handle dispositivo handle
[in]cmd reference LX_CAMERA_FEATURE
[out]valore returns il parametro structure, il massimo e minimo valori di il parametri, il corrente valore, etc.

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.3.3 DcSetFloatValue

Prototipo della funzione:

Funzione: Set float tipo parametri Parametri della funzione:

[in]handle dispositivo handle
[in]cmd reference LX_CAMERA_FEATURE
[in]valore sets parametro valore

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.3.4 DcGetFloatValue

Prototipo della funzione:

Funzione: Get float tipo parametri Parametri della funzione:

[in]handle dispositivo handle
[in]cmd reference LX_CAMERA_FEATURE
[out]valore returns il parametro structure, il massimo e minimo valori di il parametri, il corrente valore, etc.

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.3.5 DcSetBoolValue

Prototipo della funzione:

Funzione: Set bool tipo parametri Parametri della funzione:

[in]handle dispositivo handle
[in]cmd reference LX_CAMERA_FEATURE
[in]valore sets parametro valore

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.3.6 DcGetBoolValue

Prototipo della funzione:

Funzione: Get bool tipo parametro Parametri della funzione:

[in]handle dispositivo handle
[in]cmd reference LX_CAMERA_FEATURE
[out]valore return parametri

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.3.7 DcSetStringValue

Prototipo della funzione:

Funzione: Set string tipo parametri Parametri della funzione:

[in]handle dispositivo handle
[in]cmd refer a LX_CAMERA_FEATURE
[in]valore sets parametro valore

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.3.8 DcGetStringValue

Prototipo della funzione:

Funzione: Get string tipo parametri Parametri della funzione:

[in]handle dispositivo handle
[in]cmd reference LX_CAMERA_FEATURE
[out]valore returns parametri senza external allocation di memoria

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.3.9 DcGetPtrValue

Prototipo della funzione:

Funzione: Get pointer tipo parametri Parametri della funzione:

[in]handle dispositivo handle
[in]cmd reference LX_CAMERA_FEATURE
[out]valore returns parametri senza external allocation di memoria

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.3.10 DcSetCmd

Prototipo della funzione:

Funzione: Esegui corrispondente CMD tipo comando operation Parametri della funzione:

[in]handle dispositivo handle
[in]cmd reference LX_CAMERA_FEATURE

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.4 Save punto nuvola

6.4.1 DcSaveXYZ

Prototipo della funzione:

Funzione: Save il punto nuvola e call it directly Parametri della funzione:

handle dispositivo handle
filename file nome, supports txt, ply e pcd formats. txt format saves tutti dati in immagine order, ply e pcd solo save non-zero dati

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.5 Special Controls

6.5.1 DcSpecialControl

Prototipo della funzione:

Funzione: LX_CAMERA_FEATURE Special operations beyond il definition Parametri della funzione:

[in]handle dispositivo handle
[in]param operation
[inout]valore è il corrispondente input parametro quando impostare, e il corrispondente outgoing parametro quando obtained, senza external allocation di memoria.

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.6 Set ROI e parametro percorso

6.6.1 DcSetRoI

Prototipo della funzione:

Funzione: Set il ROI area. Se il input valore è not an integer multiple di 8, it sarà be automatically processed internally come il nearest integer multiple di 8 a il scelto valore. Image size parametri devi a be updated dopo setting Parametri della funzione:

[in]handle dispositivo handle
[in]offsetx horizontal offset di starting punto in pixels
[in]offsety vertical offset di starting punto in pixels
[in]widthroi larghezza di il scelto area
[in]heightroi altezza di il scelto area
[in]type0-3D immagine 1-2D immagine

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.7 Set fotocamera IP

6.7.1 DcSetCameraIp

Prototipo della funzione: Funzione: Set fotocamera IP e subnet mask, gateway Parametri della funzione:

[in]handle dispositivo handle,
[in]ip dispositivo IP,
[in]netmask subnet mask (if empty, il internal predefinito è “255.255.0.0”)
[in]gateway gateway ip (if empty, il internal predefinito è a impostare il last network segment di ip a “1” come il gateway)

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: When il dispositivo è not connected, you devi a obtain it through search prima. Se il dispositivo supports modifying il gateway e subnet mask, impostare il gateway a il stesso network segment e il subnet mask a “255.255.0.0”. After modification, il dispositivo elenco sarà change, e you devi a call il DcGetDeviceList interface again a obtain il new dispositivo elenco.

6.8 Log informazioni e versione informazioni

6.8.1 DcGetApiVersion

Prototipo della funzione:

Funzione: Get API versione numero Parametri della funzione: Valore restituito: char pointer dati. Nota:

6.8.2 DcSetInfoOutput

Prototipo della funzione: Funzione: Set printing informazioni level Parametri della funzione:

[in]print_level 0: info tutti debugging informazioni; 1: warn important e warning debugging informazioni; 2: errore solo output errore informazioni
[in]enable_screen_print whether a print in il window
[in]log_path Il log file saving percorso (does not includono il log file nome), può be empty. Windows defaults a il corrente user percorso, e Linux defaults a il /var/log percorso.
[in]linguaggio linguaggio (not used yet)

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.8.3 DcLog

Prototipo della funzione:

Funzione: Allow users a output debugging informazioni a il log file Parametri della funzione:

[in]str Il string a be output, terminated da ‘\0’

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.8.4 DcRegisterFrameCallback

Prototipo della funzione: Funzione: Register a dati frame callback funzione e automatically call it quando new dati è received. Parametri della funzione:

[in]handle dispositivo handle,
[in]func frame dati callback funzione,
[in]usr_data user-defined parametri, può be passed empty

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.8.5 DcUnregisterFrameCallback

Prototipo della funzione:

Funzione: Cancel frame callback Parametri della funzione:

[in]handle dispositivo handle,

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

6.9 Device stato callback

6.9.1 DcRegisterCameraStatusCallback

Prototipo della funzione: Funzione: Register il fotocamera stato callback funzione, which è automatically called quando il fotocamera stato changes. Parametri della funzione:

[in]handle dispositivo handle,
[in]func frame dati callback funzione,
[in]usr_data user-defined parametri, può be passed empty

Nota: Make sure il parametri passed in sono valid

6.9.2 DcUnregisterCameraStatusCallback

Prototipo della funzione:

Funzione: Cancel fotocamera stato registration callback Parametri della funzione:

[in]handle dispositivo handle,

Valore restituito: Int dati, questo valore è equal a LX_SUCCESS, indicating that il interface call è riuscita. Nota: Make sure il parametri passed in sono valid

Versions e updates

Version numero	Update instructions
2.4.16	1. Support S2 fotocamera 2. Add parametro import e export e parametro group switching 3. Add correlato funzione settings
2.4.9	1. Optimize e aggiungi some functions e configurazione parametri 2. Change il timestamp a us
2.4.2	Support M4/M4 Mega/M4 Pro/V1Pro/S2/H3 fotocamere
2.0.2	Fix some known issues, adjust some interfaces e parametri

​Panoramica

​Configurazione dell’ambiente

​Configurazione host consigliata

​Connessione e installazione

​Connessione hardware

​Configurazione di rete

​Installare l’SDK

Windows

Linux

​Utilizzare Camera SDK

​Struttura delle directory

​Flusso di sviluppo

​Configurare il progetto

​Synchronous call flow

​Asynchronous call flow

​Requisiti per le chiamate

​Tipi di parametro e API corrispondenti

​Precondizioni delle API

​Data types

​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 tipo parametri

5.8.1.1 General parametri

5.8.1.2 3D immagine parametri

5.8.1.4 2D immagine parametri

5.8.1.5 Trigger parametri

5.8.1.6 Filter parametri

​5.8.2 float tipo parametri

​5.8.3 bool tipo parametro

​5.8.4 string tipo parametri

​5.8.5 Command tipo parametri

​5.8.6 ptr tipo parametri

​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 e chiudere il fotocamera

​6.1.1 DcGetDeviceList

​6.1.2 DcOpenDevice

​6.1.3 DcCloseDevice

​6.2 Start streaming e chiudere streaming

​6.2.1 DcStartStream

​6.2.2 DcStopStream

​6.3 Reading e setting fotocamera parametri

​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 punto nuvola

​6.4.1 DcSaveXYZ

​6.5 Special Controls

​6.5.1 DcSpecialControl

​6.6 Set ROI e parametro percorso

​6.6.1 DcSetRoI

​6.7 Set fotocamera IP

​6.7.1 DcSetCameraIp

​6.8 Log informazioni e versione informazioni

​6.8.1 DcGetApiVersion

​6.8.2 DcSetInfoOutput

​6.8.3 DcLog

​6.8.4 DcRegisterFrameCallback

​6.8.5 DcUnregisterFrameCallback

​6.9 Device stato callback

​6.9.1 DcRegisterCameraStatusCallback

Panoramica

Configurazione dell’ambiente

Configurazione host consigliata

Connessione e installazione

Connessione hardware

Configurazione di rete

Installare l’SDK

Utilizzare Camera SDK

Struttura delle directory

Flusso di sviluppo

Configurare il progetto

Synchronous call flow

Asynchronous call flow

Requisiti per le chiamate

Tipi di parametro e API corrispondenti

Precondizioni delle API

Data types

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 tipo parametri

5.8.2 float tipo parametri

5.8.3 bool tipo parametro

5.8.4 string tipo parametri

5.8.5 Command tipo parametri

5.8.6 ptr tipo parametri

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 e chiudere il fotocamera

6.1.1 DcGetDeviceList

6.1.2 DcOpenDevice

6.1.3 DcCloseDevice

6.2 Start streaming e chiudere streaming

6.2.1 DcStartStream

6.2.2 DcStopStream

6.3 Reading e setting fotocamera parametri

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 punto nuvola

6.4.1 DcSaveXYZ

6.5 Special Controls

6.5.1 DcSpecialControl

6.6 Set ROI e parametro percorso

6.6.1 DcSetRoI

6.7 Set fotocamera IP

6.7.1 DcSetCameraIp

6.8 Log informazioni e versione informazioni

6.8.1 DcGetApiVersion

6.8.2 DcSetInfoOutput

6.8.3 DcLog

6.8.4 DcRegisterFrameCallback

6.8.5 DcUnregisterFrameCallback

6.9 Device stato callback

6.9.1 DcRegisterCameraStatusCallback

6.9.2 DcUnregisterCameraStatusCallback

Versions e updates