User Guide
ArduCAM USB Camera SDK User Guide
www.ArduCAM.com
1
Table of Contents
1 Introduction ............................................................................................................................. 3
2 USB SDK Library ................................................................................................................... 3
3 Demo Code ............................................................................................................................... 3
3.1 Thread.cpp ....................................................................................................................... 3
3.2 USBTestDlg.cpp ............................................................................................................... 3
3.3 CommonTools.cpp ........................................................................................................... 3
4 ArduCAM APIs ....................................................................................................................... 3
4.1 Data Structures ................................................................................................................ 3
4.1.1 ArduCamCfg Data Structure Members ................................................................ 3
4.1.2 ArduCamIndexinfo Data Structure Members ...................................................... 4
4.2 Function ........................................................................................................................... 4
4.2.1 General Function ..................................................................................................... 5
4.2.1.1 unsigned int ArduCam_autoopen( ArduCamHandle &useHandle,
ArduCamCfg* useCfg ) .................................................................................................. 5
4.2.1.2 unsigned int ArduCam_scan( ArduCamIndexinfo* pstUsbIdxArray ) ..... 5
4.2.1.3 unsigned int ArduCam_open( ArduCamHandle &useHandle,
ArduCamCfg* useCfg, unsigned long usbIdx ) ............................................................ 5
4.2.1.4 unsigned int ArduCam_close( ArduCamHandle useHandle ); ................... 5
4.2.1.5 unsigned int ArduCam_getSensorCfg( ArduCamHandle useHandle,
ArduCamCfg* useCfg ); ................................................................................................. 5
4.2.1.6 Recommend Operation Procedure ................................................................ 5
4.2.2 Image Capture Function ......................................................................................... 6
4.2.2.1 unsigned int ArduCam_beginCaptureImage( ArduCamHandle
useHandle ) ...................................................................................................................... 6
4.2.2.2 unsigned int ArduCam_captureImage( ArduCamHandle useHandle ) ..... 6
4.2.2.3 unsigned int ArduCam_endCaptureImage( ArduCamHandle useHandle )
6
4.2.2.4 Recommend Operation Procedure ................................................................ 6
4.2.3 Image Read Function .............................................................................................. 6
4.2.3.1 unsigned int ArduCam_availableImage( ArduCamHandle useHandle ) ... 6
4.2.3.2 unsigned int ArduCam_readImage( ArduCamHandle useHandle,
unsigned char* &pu8FrameData ) ................................................................................ 6
4.2.3.3 unsigned int ArduCam_del( ArduCamHandle useHandle ) ........................ 6
4.2.3.4 unsigned int ArduCam_flush( ArduCamHandle useHandle ) .................... 6
4.2.3.5 Recommend Operation Procedure ................................................................ 6
4.2.4 Sensor Register Access Function ............................................................................ 6
4.2.4.1 unsigned int ArduCam_writeSensorReg( ArduCamHandle useHandle,
unsigned long regAddr, unsigned long val ) .................................................................. 6
4.2.4.2 unsigned int ArduCam_readSensorReg( ArduCamHandle useHandle,
unsigned long regAddr, unsigned long* pval ) .............................................................. 7
4.2.5 User Data Access Function ..................................................................................... 7
4.2.5.1 unsigned int ArduCam_writeUserData( ArduCamHandle useHandle,