Camera SDK ユーザーガイド

概要

本ガイドは、カメラデバイスを統合する開発者向けです。M4、M4 Mega、M4 Pro、V1 Pro、S2、S2 Max、H3 シリーズ製品の Camera SDK API を説明します。SDK は x86 Windows、x86 Linux、Arm Linux システムで動作します。 Camera SDK は、統一されたデバイスアクセスおよびパラメーター設定 API を提供します。深度、強度、点群、RGB データの同期・非同期取得に対応します。一部のカメラモデルでは、障害物回避、ドッキング、自己位置推定のデータも提供します。

サンプルと API 説明は製品に同梱される SDK バージョンに基づいています。使用可能なパラメーターは、製品、ファームウェア、SDK のバージョンによって異なる場合があります。

サンプルは開発のためのガイドであり、すべてのデバイスやユースケースを網羅するものではありません。

環境設定

推奨ホスト構成

構成項目	推奨構成
オペレーティングシステム	Windows 7、Windows 10、Windows 11、Ubuntu 16.04 以降
メモリ	4 GB 以上
CPU	4 コア Cortex-A57 または同等以上
ネットワークアダプター	ギガビット Ethernet 以上

接続とインストール

ハードウェア接続

図 2.1 のように、カメラを外部 24V 電源へ接続し、ネットワークケーブルでホストコンピューターへ接続します。図 2.1 カメラ接続図

ネットワーク設定

カメラの既定 IP ネットワークセグメントは 192.168.100.* です。
ホストコンピューターで、カメラに接続するネットワークポートの IP アドレスを 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 のヘッダーファイルおよびライブラリファイルが含まれます。

開発ワークフロー

プロジェクトを設定する

C/C++ による SDK 統合を推奨します。SDK には CMake ビルド用の CMakeLists.txt が含まれ、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

3D 自動露出の最大値（LX_INT_3D_AUTO_EXPOSURE_MAX）および最小値も設定できません。

(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 接続できるのは 1 つだけ）
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	符号なし char 型
LX_DATA_UNSIGNED_SHORT	符号なし short 整数
LX_DATA_SIGNED_SHORT	符号付き 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

機能:

Keywords	Description
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 type parameters

5.8.1.1 一般パラメーター

キーワード	説明
LX_INT_FIRST_EXPOSURE	露出値（単位: us）。複数点では第 1 点の露出時間
LX_INT_SECOND_EXPOSURE	複数点における第 2 点の露出時間
LX_INT_THIRD_EXPOSURE	複数点における第 3 点の露出時間。一部モデルで対応
LX_INT_FOURTH_EXPOSURE	複数点における第 4 点の露出時間。一部モデルで対応
LX_INT_GAIN	ゲイン。露出と同様の効果を持つ。ノイズを伴うため、露出パラメーターが過大にならないよう適切に調整する
LX_INT_MIN_DEPTH	最小深度値。範囲外の値は無効
LX_INT_MAX_DEPTH	最大深度値。範囲外の値は無効
LX_INT_MIN_AMPLITUDE	有効信号強度の最小値。範囲外の深度値は無効
LX_INT_MAX_AMPLITUDE	有効信号強度の最大値。範囲外の深度値は無効
LX_INT_CODE_MODE	Structural light camera encoding mode, refer to CODE_MODE (supported by some models)
LX_INT_WORK_MODE	Working mode, refer to LX_CAMERA_WORK_MODE
LX_INT_LINK_SPEED	The negotiated network card speed is 100-100 Mbit/s, 1000-1000 Mbit/s, only supports acquisition and cannot be set
LX_INT_TOF_GLOBAL_OFFSET	ToF depth data offset
LX_INT_ALGORITHM_MODE	Built-in algorithm enable mode, supported by some models, the corresponding values refer to LX_ALGORITHM_MODE
LX_INT_TRIGGER_MODE	Trigger mode, the corresponding value refers to LX_TRIGGER_MODE
LX_INT_MODBUS_ADDR	modbus address, some models support MODBUS protocol output through the serial port
LX_INT_HEART_TIME	Heartbeat time, the camera will automatically standby if it times out and does not receive a heartbeat
LX_INT_GVSP_PACKET_SIZE	GVSP single packet data packet size, unit byte
LX_INT_CALCULATE_UP	Allow the tof or rgb algorithm to move up and down, saving the computing power of the host computer or camera, which may affect the frame rate and delay
LX_INT_CAN_BAUD_RATE	baud rate value of can, unit bps
LX_INT_SAVE_PARAMS_GROUP	Save the current camera configuration as the specified parameter group
LX_INT_LOAD_PARAMS_GROUP	Load the parameter group of the specified index with one click

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	2D 画像 ROI の水平オフセットピクセル。取得のみ可能。設定には `DcSetRoI` を使用
LX_INT_2D_IMAGE_OFFSET_Y	2D 画像 ROI の垂直オフセットピクセル。取得のみ可能。設定には `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

機能: デバイス属性情報構造体

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

機能: デバイス属性情報構造体

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

機能: デバイス属性情報構造体

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

機能: デバイスタイプ

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

機能: デバイスタイプ

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

機能: 画像表示情報構造体

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

機能: データフレーム情報構造体

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リファレンス

APIプロトタイプはSDKヘッダーと配布済みSDKのバージョンで定義されます。特記がない限り、LX_SUCCESS は呼び出し成功を示します。

6.1 カメラの検索、接続、切断

6.1.1 DcGetDeviceList

関数プロトタイプ： 機能： 対応するカメラの一覧を取得します。 パラメータ：

[out]devlist：検出されたカメラ一覧です。
[out]devnum：検出されたカメラ数です。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 **備考：**メモリは内部で管理されるため、外部での確保は不要です。検索のたびに前回の内容が消去されるため、呼び出し側でスレッド安全性を確保してください。

6.1.2 DcOpenDevice

関数プロトタイプ：

機能： カメラに接続します。 パラメータ：

[in]open_mode：オープンモードです。詳細は OpenMode を参照してください。
[in]param：オープン方法に応じたパラメータです。
[out]handle：接続成功時に返されるデバイスハンドルです。以降のAPI呼び出しで使用します。
[out]info：接続成功時に返されるカメラ詳細情報です。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.1.3 DcCloseDevice

関数プロトタイプ：

機能： デバイスを閉じます。 パラメータ：

[in]handle：デバイスハンドル

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.2 ストリーミングの開始と停止

6.2.1 DcStartStream

関数プロトタイプ：

**機能：**データストリームを開始します。 パラメータ：

[in]handle：デバイスハンドル

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.2.2 DcStopStream

関数プロトタイプ：

**機能：**データストリームを停止します。 パラメータ：

[in]handle：デバイスハンドル

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.3 カメラパラメータの取得と設定

6.3.1 DcSetIntValue

関数プロトタイプ：

機能： Set int type parameters パラメータ：

[in]handle：デバイスハンドル
[in]cmd reference LX_CAMERA_FEATURE
[in]value：設定するパラメータ値です。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.3.2 DcGetIntValue

関数プロトタイプ：

機能： Get int type parameters パラメータ：

[in]handle：デバイスハンドル
[in]cmd reference LX_CAMERA_FEATURE
[out]value：パラメータ構造体を返します。最大値、最小値、現在値などを含みます。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.3.3 DcSetFloatValue

関数プロトタイプ：

機能： float型パラメータを設定します。 パラメータ：

[in]handle：デバイスハンドル
[in]cmd reference LX_CAMERA_FEATURE
[in]value：設定するパラメータ値です。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.3.4 DcGetFloatValue

関数プロトタイプ：

機能： float型パラメータを取得します。 パラメータ：

[in]handle：デバイスハンドル
[in]cmd reference LX_CAMERA_FEATURE
[out]value：パラメータ構造体を返します。最大値、最小値、現在値などを含みます。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.3.5 DcSetBoolValue

関数プロトタイプ：

機能： bool型パラメータを設定します。 パラメータ：

[in]handle：デバイスハンドル
[in]cmd reference LX_CAMERA_FEATURE
[in]value：設定するパラメータ値です。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.3.6 DcGetBoolValue

関数プロトタイプ：

機能： bool型パラメータを取得します。 パラメータ：

[in]handle：デバイスハンドル
[in]cmd reference LX_CAMERA_FEATURE
[out]value：パラメータを返します。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.3.7 DcSetStringValue

関数プロトタイプ：

機能： string型パラメータを設定します。 パラメータ：

[in]handle：デバイスハンドル
[in]cmd refer to LX_CAMERA_FEATURE
[in]value：設定するパラメータ値です。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.3.8 DcGetStringValue

関数プロトタイプ：

機能： string型パラメータを取得します。 パラメータ：

[in]handle：デバイスハンドル
[in]cmd reference LX_CAMERA_FEATURE
[out]value：外部メモリ確保なしでパラメータを返します。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.3.9 DcGetPtrValue

関数プロトタイプ：

機能： ポインター型パラメータを取得します。 パラメータ：

[in]handle：デバイスハンドル
[in]cmd reference LX_CAMERA_FEATURE
[out]value：外部メモリ確保なしでパラメータを返します。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.3.10 DcSetCmd

関数プロトタイプ：

機能： 対応するCMD型コマンドを実行します。 パラメータ：

[in]handle：デバイスハンドル
[in]cmd reference LX_CAMERA_FEATURE

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.4 点群の保存

6.4.1 DcSaveXYZ

関数プロトタイプ：

機能： 点群を保存します。直接呼び出して使用します。 パラメータ：

handle：デバイスハンドルです。
filename：ファイル名です。txt、ply、pcd 形式に対応します。txt は画像順にすべてのデータを保存し、ply と pcd はゼロ以外のデータのみ保存します。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.5 特殊制御

6.5.1 DcSpecialControl

関数プロトタイプ：

機能： LX_CAMERA_FEATURE で定義される特別操作です。 パラメータ：

[in]handle：デバイスハンドル
[in]param operation
[inout]value：設定時は入力パラメータ、取得時は出力パラメータです。外部メモリ確保は不要です。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.6 ROIとパラメータパスの設定

6.6.1 DcSetRoI

関数プロトタイプ：

機能： ROI領域を設定します。入力値が8の整数倍でない場合、内部で最も近い8の整数倍に丸められます。設定後に画像サイズパラメータを更新してください。 パラメータ：

[in]handle：デバイスハンドル
[in]offsetx：開始位置の水平方向オフセット（ピクセル）です。
[in]offsety：開始位置の垂直方向オフセット（ピクセル）です。
[in]widthroi width of the target area
[in]heightroi height of the target area
[in]type0-3D image 1-2D image

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.7 カメラIPの設定

6.7.1 DcSetCameraIp

関数プロトタイプ： 機能： カメラのIPアドレス、サブネットマスク、ゲートウェイを設定します。 パラメータ：

[in]handle：デバイスハンドル,
[in]ip：デバイスIPアドレスです。
[in]netmask：サブネットマスクです。空の場合は内部既定値 255.255.0.0 を使用します。
[in]gateway：ゲートウェイIPです。空の場合、IPアドレスの最終オクテットを 1 にした値を使用します。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 **注：**未接続のデバイスは、先に検索で取得する必要があります。ゲートウェイとサブネットマスクを変更する場合、ゲートウェイを同一ネットワークセグメントに設定し、サブネットマスクを 255.255.0.0 に設定してください。変更後は DcGetDeviceList を再度呼び出してデバイス一覧を取得します。

6.8 ログ情報とバージョン情報

6.8.1 DcGetApiVersion

関数プロトタイプ：

機能： APIバージョン番号を取得します。 パラメータ： 戻り値： char ポインター型のデータです。 備考：

6.8.2 DcSetInfoOutput

関数プロトタイプ： 機能： ログ出力レベルを設定します。 パラメータ：

[in]print_level：0 はすべてのデバッグ情報、1 は重要情報と警告、2 はエラーのみを出力します。
[in]enable_screen_print：ウィンドウへ出力するかを指定します。
[in]log_path：ログファイルの保存先パスです（ファイル名は含みません）。空にできます。Windowsでは現在のユーザーパス、Linuxでは /var/log が既定です。
[in]language：言語です（現在は未使用）。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.8.3 DcLog

関数プロトタイプ：

機能： デバッグ情報をログファイルへ出力できます。 パラメータ：

[in]str：出力する文字列です。\0 で終端します。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.8.4 DcRegisterFrameCallback

関数プロトタイプ： 機能： データフレームのコールバック関数を登録します。新しいデータを受信すると自動的に呼び出されます。 パラメータ：

[in]handle：デバイスハンドル,
[in]func：フレームデータのコールバック関数です。
[in]usr_data：ユーザー定義パラメータです。空で渡せます。

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.8.5 DcUnregisterFrameCallback

関数プロトタイプ：

機能： フレームコールバックを解除します。 パラメータ：

[in]handle：デバイスハンドル,

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

6.9 デバイス状態コールバック

6.9.1 DcRegisterCameraStatusCallback

関数プロトタイプ： 機能： カメラ状態コールバックを登録します。カメラ状態が変わると自動的に呼び出されます。 パラメータ：

[in]handle：デバイスハンドル,
[in]func：フレームデータのコールバック関数です。
[in]usr_data：ユーザー定義パラメータです。空で渡せます。

注：渡すパラメータが有効であることを確認してください。

6.9.2 DcUnregisterCameraStatusCallback

関数プロトタイプ：

機能： カメラ状態コールバックの登録を解除します。 パラメータ：

[in]handle：デバイスハンドル,

戻り値： Int 型の戻り値です。LX_SUCCESS は呼び出し成功を示します。 注：渡すパラメータが有効であることを確認してください。

バージョンと更新内容

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

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リファレンス

​6.1 カメラの検索、接続、切断

​6.1.1 DcGetDeviceList

​6.1.2 DcOpenDevice

​6.1.3 DcCloseDevice

​6.2 ストリーミングの開始と停止

​6.2.1 DcStartStream

​6.2.2 DcStopStream

​6.3 カメラパラメータの取得と設定

​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 点群の保存

​6.4.1 DcSaveXYZ

​6.5 特殊制御

​6.5.1 DcSpecialControl

​6.6 ROIとパラメータパスの設定

​6.6.1 DcSetRoI

​6.7 カメラIPの設定

​6.7.1 DcSetCameraIp

​6.8 ログ情報とバージョン情報

​6.8.1 DcGetApiVersion

​6.8.2 DcSetInfoOutput

​6.8.3 DcLog

​6.8.4 DcRegisterFrameCallback

​6.8.5 DcUnregisterFrameCallback

​6.9 デバイス状態コールバック

​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 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リファレンス

6.1 カメラの検索、接続、切断

6.1.1 DcGetDeviceList

6.1.2 DcOpenDevice

6.1.3 DcCloseDevice

6.2 ストリーミングの開始と停止

6.2.1 DcStartStream

6.2.2 DcStopStream

6.3 カメラパラメータの取得と設定

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 点群の保存

6.4.1 DcSaveXYZ

6.5 特殊制御

6.5.1 DcSpecialControl

6.6 ROIとパラメータパスの設定

6.6.1 DcSetRoI

6.7 カメラIPの設定

6.7.1 DcSetCameraIp

6.8 ログ情報とバージョン情報

6.8.1 DcGetApiVersion

6.8.2 DcSetInfoOutput

6.8.3 DcLog

6.8.4 DcRegisterFrameCallback

6.8.5 DcUnregisterFrameCallback

6.9 デバイス状態コールバック

6.9.1 DcRegisterCameraStatusCallback

6.9.2 DcUnregisterCameraStatusCallback

バージョンと更新内容