CLPE-G-Series API list

Owned by 선동우
Last updated: Jan 29, 2024
6 min read

Int Clpe_Connection(string password, int isAttachedSlave)

Description

  • PC 와 CLPE-G-Series 간의 통신 연결을 수행한다.

Parameters

  • string password :[in] 루트 계정 암호.

Ex ) “password1234”

  • int isAttachedSlave : [in] Slave 보드 장착 여부.

  • 0인 경우 보드 1대 장착(Master 보드)

  • 1인 경우 보드 2대 장착(Master & Slave 보드)

Returns

  • int : Error status.

0 = no error.

-1 = can not probe driver.

-2 = can not find network.

-3 = can not set address.

-4 = can not ping.

-5 = can not create socket.

-6 = can not connect socket.

Example code

ClpeClientApi clpe_api; string password = “password1234”; int ret = clpe_api.Clpe_Connection(password, 1);  if(ret == 0) { printf("Connection successed\n"); }

해당 함수는 다른 함수들이 호출하기 전에 반드시 수행하여야 한다.

 

Int Clpe_Connection(int isAttachedSlave)

Description

  • PC 와 CLPE-G-Series 간의 통신 연결을 수행한다.

Parameters

  • int isAttachedSlave : [in] Slave 보드 장착 여부.

  • 0인 경우 보드 1대 장착(Master 보드)

  • 1인 경우 보드 2대 장착(Master & Slave 보드)

Returns

  • int : Error status.

0 = no error.

-4 = can not ping.

-5 = can not create socket.

-6 = can not connect socket.

Example code

ClpeClientApi clpe_api; int ret = clpe_api.Clpe_Connection(1); if(ret == 0) { printf("Connection successed\n"); }

  • 해당 함수는 다른 함수들이 호출하기 전에 반드시 수행하여야 한다.

  • 해당 함수를 사용하고자 할 경우 반드시 첨부파일의 no_password.sh 파일을 실행하거나 해당 쉘 파일이 수행하고자 하는 작업을 API 실행 전 수행하여야 한다.

 

int Clpe_GetMicomVersion(unsigned char* version_master, unsigned char* version_slave) 

Description

  • CLPE-G-Series의 MICOM 펌웨어 버전 정보를 읽어온다.

Parameters

  • unsigned char* version_master : [out] Master MICOM version 정보를 읽어 올 buffer pointer. Ex ) [ ‘r’, ‘2’, ‘.’, ‘0’, ‘.’, ‘0’ ] ( Size : 6 Bytes )

  • unsigned char* version_slave : [out] Slave MICOM version 정보를 읽어 올 buffer pointer. Ex ) [ ‘r’, ‘2’, ‘.’, ‘0’, ‘.’, ‘0’ ] ( Size : 6 Bytes )

Returns

  • int :  Error status.

0 = no error.

-1 = invalid command id.

-3 = failed communication.

-4 = error data checksum.

Example code

ClpeClientApi clpe_api; unsigned char *master_micomVer = (unsigned char*) malloc(6); unsigned char *slave_micomVer = (unsigned char*) malloc(6); int ret = clpe_api.Clpe_GetMicomVersion(master_micomVer, slave_micomVer); if(ret == 0) { printf("Master Micom Version = %s\n", master_micomVer); printf("Slave Micom Version = %s\n", slave_micomVer); } 

‘version_master’ 와 ‘version_slave’ 의 buffer 크기는 6bytes 이상이어야 한다.


int Clpe_GetXavierVersion(unsigned char* versison_master, unsigned char* versison_slave)

Description

  • CLPE-G-Series의 XavierNX 펌웨어 버전 정보를 읽어온다.

Parameters

  • unsigned char* versison_master : [out] Master CLPE-G-Series 의 XavierNX version 정보를 읽어 올 buffer pointer. Ex ) [ ‘r’, ‘1’, ‘.’, ‘0’, ‘.’, ‘0’ ] ( Size : 6 Bytes )

  • unsigned char* versison_slave : [out] Slave CLPE-G-Series의  XavierNX version 정보를 읽어 올 buffer pointer. Ex ) [ ‘r’, ‘1’, ‘.’, ‘0’, ‘.’, ‘0’ ] ( Size : 6 Bytes )

Returns

  • int :  Error status.

0 = no error.

-1 = invalid command id.

-3 = failed communication.

-4 = error data checksum.

Example code

 

int Clpe_GetSDKVersion (unsigned char* version)

Description

  • CLPE-G-Series의 SDK 버전 정보를 읽어온다.

Parameters

  • unsigned char* version : [out] CLPE-G-Series SDK version 정보를 읽어 올 buffer pointer. Ex ) [ ‘r’, ‘1’, ‘.’, ‘0’, ‘.’, ‘0’ ] ( Size : 6 Bytes )

Returns

  • int :  Error status.

0 = no error.

Example code

 

int Clpe_GetCamStatus(int* status)

Description

  • 카메라의 연결 상태 정보를 읽어온다.

Parameters

  • int* status : [out] 각 카메라 채널 별 연결 상태를 읽어 올 buffer pointer. Ex ) [ 1, 1, 1, 1, 1, 1, 1, 1] ( Size : 8*sizeof(int) Bytes )

Returns

  • int :  Error status.

0 = no error.

-1 = invalid command id.

-3 = failed communication.

-4 = error data checksum.

Example code

 

int Clpe_SetXavierPowerOff()

Description

  • XavierNX 의 전원을 끄도록 요청.

Parameters

  • None.

Returns

  • int :  Error status.

0 = no error.

-1 = invalid command id.

-3 = failed communication.

-4 = error data checksum.

 

int Clpe_CheckPci()

Description

  • CLPE-G-Series 가 PC 에서 PCIe 디바이스로 인식되었는지 여부를 확인.

Parameters

  • None.

Returns

  • int :  Error status.

0 = no error.

-1 = pci device is not connected.

Example code

 

int Clpe_CheckNetwork()

Description

  • CLPE-G-Series 와 PC 가 네트워크에 정상적으로 연결되었는지 확인.

Parameters

  • None.

Returns

  • int :  Error status.

0 = no error.

-1 = network device is not connected.

Example code

 

int Clpe_CheckPing()

Description

  • Ping 을 통해 CLPE-G-Series 와 PC가 정상적으로 통신이 가능한지를 확인.

Parameters

  • None.

Returns

  • int :  Error status.

0 = no error.

-1 = ping failed.

Example code

  

int Clpe_CheckTimeSyncStatus()

Description

  • CLPE-G-Series 가 PC의 시간에 동기화가 되었는지 확인.

Parameters

  • None.

Returns

  • int :  Error status.

0 = no error.

-1 = time sync failed.

Example code

 

int Clpe_ReqResyncTime()

Description

  • CLPE-G-Series 가 PC와의 시간 동기화를 재요청.

Parameters

  • None.

Returns

  • int :  Error status.

0 = no error.

-1 = time sync failed.

Example code

  

int Clpe_StartStream (T_CB_APP cb_app, int use_cam_0, int use_cam_1, int use_cam_2, int use_cam_3, int use_cam_4, int use_cam_5, int use_cam_6, int use_cam_7, int display_on)

Description

  • 선택된 카메라의 영상 전송 시작.

Parameters

  • int use_cam_0 : [in] 0th camera 사용 유무 (1 : use, 0 : no use).

  • int use_cam_1 : [in] 1st camera 사용 유무 (1 : use, 0 : no use)

  • int use_cam_2 : [in] 2nd camera 사용 유무 (1 : use, 0 : no use)

  • int use_cam_3 : [in] 3rd camera 사용 유무 (1 : use, 0 : no use)

  • int use_cam_4 : [in] 4st camera 사용 유무 (1 : use, 0 : no use)

  • int use_cam_5 : [in] 5st camera 사용 유무 (1 : use, 0 : no use)

  • int use_cam_6 : [in] 6st camera 사용 유무 (1 : use, 0 : no use)

  • int use_cam_7 : [in] 7st camera 사용 유무 (1 : use, 0 : no use)

  • int display_on  : [in] 카메라 영상을 display할지 유무 (1 : display, 0 : no display)

Returns

  • int :  Error status.

0 = no error.

-1 = Fail to create task.

 Example code

 

int Clpe_StopStream ()

Description

  • 모드 카메라의 영상 전송을 멈춤.

Parameters

  • None.

Returns

  • int :  Error status.

0 = no error.

-1 = Stop error.

Example code

 

int Clpe_GetFrameAllCam (int *p_camera_id, unsigned char **p_buffer, unsigned int *p_size, struct timeval *pt_camera_timeStamp)

Description

  • 호출되는 시점 기준으로 가장 최신의 카메라 채널 영상 이미지를 획득.

Parameters

  • int *p_camera_id : [out] camera id of frame

  • unsigned char **p_buffer : [out] buffer of frame

  • unsigned int *p_size : [out] size of frame

  • struct timeval *pt_camera_timeStamp : [out] timestamp of frame in XavierNX

Returns

  • int :  Error status.

0 = no error.

-2 = There is no the updated frame.

Example code

 

int Clpe_GetFrameOneCam (int camera_id, unsigned char **p_buffer, unsigned int *p_size, struct timeval *pt_camera_timeStamp) 

Description

  • 호출되는 시점 기준으로 사용자가 지정한 카메라 채널의 가장 최신 영상 이미지를 획득.

Parameters

  • int camer_id : [in] camera id of frame

  • unsigned char **p_buffer : [out] buffer of frame

  • unsigned int *p_size : [out] size of frame

  • struct timeval *pt_camera_timeStamp : [out] timestamp of frame in XavierNX

Returns

  • int :  Error status.

0 = no error.

-2 = There is no the updated frame.

-3 = Not available camera id

Example code

 

int ClpeClientApi::Clpe_SelectFormat(int format)

Description

  • 카메라 영상 전송 시 원하는 포맷 설정

Parameters

  • int format : [in] 포맷 선택 (0 : JPEG, 1 : UYVY)

Returns

  • int :  Error status.

0 = no error.

-1 = invalid command id.

-3 = failed communication.

-4 = error data checksum.

Example code