NET iCube Series User Manual Download

Page: 1 / 40

iCube

SERIES SDK API Manual

N E T G m b H A l l R i g h t s R e s e r v e d

NET New Electronic Technology GmbH

Lerchenberg 7
86923 Finning, Germany
Tel: +49 8806 9234 0
Fax: +49 8806 9234 77
[email protected]
www.net-gmbh.com

NET Italia S.r.l.

Via Carlo Pisacane, 9
25128 Brescia, Italy
Tel: +39 030 5237 163
Fax: +39 030 5033 293
[email protected]

www.net-italia.it

NET USA, Inc.

3037 45

Street

Highland IN 46322, USA
Tel: +1 219 934 9042
Fax: +1 219 934 9047
[email protected]

www.net-usa-inc.com

NET Japan Co., Ltd.

2F Shin-Yokohama 214 Bldg.
2-14-2 Shin-Yokohama, Kohoku-ku,
Yokohama-shi, 222-0033, Japan
Tel: +81 45 478 1020
Fax: +81 45 476 2423
[email protected]

www.net-japan.com

iCube

SERIES

SDK API Manual

For USB2.0 Cameras NSxxxx/KSxxxx Models

VERSION 2.0.0.7

Released May 2011

Summary of Contents for iCube Series

Page 1: ...y Tel 39 030 5237 163 Fax 39 030 5033 293 info net italia it www net italia it NET USA Inc 3037 45th Street Highland IN 46322 USA Tel 1 219 934 9042 Fax 1 219 934 9047 info net usa inc com www net usa inc com NET Japan Co Ltd 2F Shin Yokohama 214 Bldg 2 14 2 Shin Yokohama Kohoku ku Yokohama shi 222 0033 Japan Tel 81 45 478 1020 Fax 81 45 476 2423 info net japan com www net japan com iCube SERIES S...

Page 2: ...is equipment The shielded interface cable recommended in this manual must be used with this equipment in order to comply with the limits for a computing device pursuant to Subpart J of Part 15 of FCC Rules For customers in Europe This apparatus has been certified to meet or exceed the standards for CE compliance per the Council Directives Pertinent testing documentation is available for verificati...

Page 3: ...es or detergent in case of cleaning camera body Warranty shall be voided for improper usage or fault caused by user or damage caused by other equipments due to negligence Warranty NET GMBH warrants the original components free of defects for one year from purchase date This warranty covers failures and damage due to defect which may occur during normal use It does not cover damages or failure resu...

Page 4: ...ftware requirements 6 1 3 Supported Plattforms 6 1 4 Enviroment Requirements 7 2 Software 8 2 1 Software CD 8 2 2 Software Installation 9 2 3 Software and Driver update 10 2 4 Problems 10 2 5 Applications 11 3 SDK Interface 14 3 1 Setup 14 3 2 Available Functions 15 3 3 Functions detailed overview 16 3 4 Error Codes 35 4 DirectShow Interfaces 36 4 1 Supported DirectShow Interfaces 36 4 2 iCube Dir...

Page 5: ...GmbH hardware and strictly forbidden to use or build Application for cameras or hardware from other venders with this API The EVALUATION VERSION SOFTWARE is provided to you AS IS without warranty The entire risk of the quality and performance of the software is with its users We would appreciate feedback bug report of any kind however we can not guarantee satisfactory response 0 3 Legal Notice By ...

Page 6: ... 0 on board PCI or PCMCIA USB 2 0 adapters may have a lower performance the iCube need a full powered USB 2 0 interface with 500mA use only USB 2 0 cables for high speed 1 2 Software requirements The following software is required to use NET GmbH Camera API iCube Camera Device Driver Compiler Microsoft Visual C 6 0 C Builder 6 0 C Delphi Visual Basic VB6 NET Microsoft DirectX 9 0b or higher The fo...

Page 7: ... 1 4 Enviroment Requirements The following enviromental conditions are required Ambient temperature 0 C 45 C 32 F 113 F Storage temperature 20 C 60 C 4 F 140 F Do not subject the iCube camera to direct sunlight and moisture The conditions for shock and vibrations are on request by NET ...

Page 8: ...WINDOWS 00_Documentation iCube Operation Manual iCube SDI API Manual 03_Driver iCube Camera Device Driver iCube Cognex AIK Setup 04_Viewer SW iControl viewer Software 05_Interfaces SDK C C C Builder VB6 VB NET DShow 06_Misc dxRegistration LINUX Full software package Visit our website for the latest drivers and documentations about our software www net gmbh com ...

Page 9: ...e setup exe to install the iCube device driver 3 Plug in the USB 2 0 cable into your USB 2 0 port and the iCube 4 Windows plug and play manager recognizes the new hardware 5 Follow the instruction of the windows plug and play manager 6 After the iCube driver was installed you can see on the device Manager imaging devices the recognized iCube camera NET Icube_Cam Device Windows german version Windo...

Page 10: ...device manager imaging devices and select the driver manually 2 4 Problems NET GmbH Camera API iCubeSDK Library is the library consisting functions for the controlling the cameras produced by NET GmbH Due to heavy real time data transfer and processing is involved system performance especially CPU perform crucial for smooth operation The API is may function smoothly under systems equipped with Pen...

Page 11: ...SDK API Manual 2 5 Applications 2 5 1 iCube iControl viewer software The iControl software allows you to test the functionalities of the iCube camera on your own application Apart from controlling the iCube camera you can grab images and save them as jpg bmp and tif files ...

Page 12: ... iCube dx Registration software can be accessed as follows Connect all iCube cameras to PC 1 Choose device to register You will see the connected camera with serial numbers in the ComboBox The selection of the dx capture filter in 2 will change automatically when changing the device 2 Register the selected device The name in the square brackets is the dx friendly name which will appear in amcap fo...

Page 13: ...ed ICube Series SDK API Manual 2 5 3 iCube SDK sample The iCube SDK samples show you how you can develop or integrate the iCube on your own application software On the CD Rom you can find examples for following development software C C C Builder VB6 VB NET ...

Page 14: ...API h file dynamic linking Comment the define define LIBFILE in the NET_iCube_API h file 3 1 2 C Builder Static linking If the user want to use iCubeSDK lib file while compiling add the path lib IcubeSDK lib to library modules Uncomment the define define LIBFILE in the NET_iCube_API h file Uncomment the define define BORLAND_C in the NET_iCube_API h file dynamic linking Comment the define define L...

Page 15: ...tSize iCube SDK_SetMode iCube SDK_GetMode iCube SDK_GetModeList iCube SDK_SetBinSkip iCube SDK_GetBinSkip iCube SDK_GetBinSkipList iCube SDK_SaveToFile iCube SDK_SetTrigger iCube SDK_GetTrigger iCube SDK_SetCamParameter iCube SDK_GetCamParameter iCube SDK_GetCamParameterRange iCube SDK_GetParamAuto iCube SDK_SetParamAuto iCube SDK_SetParamAutoDef iCube SDK_SetParamOnePush iCube SDK_GetName iCube S...

Page 16: ...x Purpose opens the camera interface return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera to open void iCube SDK_Close int nCamIndex Purpose closes the camera interface return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera to close description parameters return value int CamCount description parameters int CamIndex retu...

Page 17: ...n Purpose get the SDK version return value none parameters int nCamIndex index of camera char version the version of the SDK dll void iCube SDK_GetFWVersion int nCamIndex char pVersion Purpose get the firmware version return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera char version the version of the camera firmware description parameters int CamIndex retur...

Page 18: ...size of the frame data buffer PVOID pContext context parameter see below return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera int nMode defines the grabmode CALLBACK_RAW Data format passed to the callback function Color camera 8bit Pixel Bayer raw Data BW camera 8bit Pixel Raw Data CALLBACK_RGB Data format passed to the callback function Color camera 24bit P...

Page 19: ...eview set unset the use of a preview window If preview mode is set and ImgHandle is NULL a default preview window will be used int Callback set unset the use of the callback function void iCube SDK_IsStarted int nCamIndex Purpose checks for open image stream return value int stat IC_SUCCESS image stream is open else image stream is not open parameters int nCamIndex index of camera description para...

Page 20: ...CamIndex ROI_PROPERTY property Purpose set the resolution and position of the Region of Interest ROI enable disable the ROI mode This function can be called anytime after iCubeSDK_Open This function has to be called after iCubeSDK_SetMode if iCubeSDK_SetMode is used return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera ROI_PROPERTY property pointer to the ROI...

Page 21: ...ndex of camera ROI_PROPERTY property pointer to the ROI_PROPERTY structure int iCube SDK_GetResolutionRange int nCamIndex ROI_RANGE_PROPERTY property Purpose get the min max resolution of the Region of Interest ROI return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera ROI_RANGE_PROPERTY property pointer to the ROI_RANGE_PROPERTY structure description paramete...

Page 22: ...ameters int nCamIndex index of camera HWND ImgHandle handle to preview window int Preview set unset the use of a preview window If preview mode is set and ImgHandle is NULL a default preview window will be used int Callback set unset the use of the callback function int iCube SDK_GetSize int nCamIndex int pnXRes int pnYRes Purpose get the current frame sizes return value int stat IC_SUCCESS succes...

Page 23: ...ters int nCamIndex index of camera int nMode this value sets the basis format see table below int iCube SDK_GetMode int nCamIndex int pMode Purpose get the basic format return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera int pMode current format description parameters int CamIndex int nMode return value int stat Mode resolution 0 320x240 QVGA 1 640x480 VGA ...

Page 24: ...tion has to be called before iCubeSDK_Start This function has to be called after iCubeSDK_SetMode if iCubeSDK_SetMode is used The availability of BinSkip modes is camera dependent and can be identified with iCubeSDK_GetBinSkipList return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera int nParameter this value sets how many pixels should skipped or binned BIN_...

Page 25: ...get current binning mode int iCube SDK_GetBinSkipList int nCamIndex int nMode int pLength int pList Purpose get the possible formats of the camera return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera int nMode MODE_SKIP get skipping mode list MODE_BIN get binning mode list int pLength number of bin skip modes in list int pList bin list or skip list BIN_SKIP_...

Page 26: ... nMode Purpose sets the Trigger mode return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera Int nMode TRIG_SW_START starts the software trigger mode TRIG_SW_DO get one software triggered frame TRIG_HW_START starts the hardware trigger mode TRIG_STOP stops soft hardware trigger mode TRIG_SW_START_2 GRR mode 1500CU BU FW x 4 11 x 1300CU FW x 1 12 x TRIG_HW_START...

Page 27: ...current trigger mode int iCube SDK_SetCamParameter ini nCamIndex int Type unsigned long Value Purpose set parameter value return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera int Type type of parameter to set See Parameter Definitions in API Header unsigned long Value value to set description parameters int CamIndex int Type unsigned long Value return value ...

Page 28: ...to get int iCube SDK_GetCamParameterRange int nCamIndex int Type PARAM_PROPERTY property Purpose get parameter min max values default value auto onepush and enabled information return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera int Type type of parameter to get See Parameter Definitions in API Header PARAM_PROPERTY property pointer to PARAM_PROPERTY struct...

Page 29: ...tions in API Header int bAuto 1 supported 0 unsupported int iCube SDK_SetParamAuto ini nCamIndex int Type int bAuto Purpose if auto mode is supported set unset auto mode of parameter return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera int Type type of parameter to set See Parameter Definitions in API Header int bAuto 1 set auto 0 unset auto description para...

Page 30: ...pported set unset one push mode of parameter return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera int Type type of parameter to set See Parameter Definitions in API Header int iCube SDK_GetName int nCamIndex char Name Purpose get the name of the selected camera return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera char ...

Page 31: ...dex of camera int pnFrames the number of broken frames since the last start int iCube SDK_GetGoodFrames int CamIndex int pnFrames Purpose get the number of good frames since the last start return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera int pnFrames the number of good frames since the last start description parameters int CamIndex int pnFrames return va...

Page 32: ...Return value int stat return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera char pVersion SerialNumber int iCube SDK_SetExposure IN int nCamIndex IN float Value Pupose set Exposure time Input description parameters int CamIndex float Value Return value int stat return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera FLOAT ...

Page 33: ...ue int stat IC_SUCCESS success else error parameters int nCamIndex index of camera FLOAT Value exposure time ms int iCube SDK_GetExposureRange IN int nCamIndex PARAM_PROPERTY_f property description parameters int CamIndex PARAM_PROPERTY_f property Return value int stat Pupose get Exposure time Range Output return value int stat IC_SUCCESS success else error parameters int nCamIndex index of camera...

Page 34: ... path and name of the file the extension must be avi int nMode currently only AVI_DIB mode is supported int nTimeInSecs length of the saved stream in secounds int ICubeSDK_SetDisplayMode int nCamIndex int nMode DISP_PROPERTY property description parameters int nCamIndex int nMode DISP_PROPERTY property return value int stat Purpose sets the display mode This function has to be called before ICubeS...

Page 35: ...ecified error IC_IF_NOT_OPEN 1 Camera interface is not open IC_WRONG_PARAM 2 Parameter is out of range IC_OUT_OF_MEMORY 3 memory could not be allocated IC_ALREADY_DONE 4 e g Interface already open IC_WRONG_CLOCK_VAL 5 wrong PLL value more information on operation manual camera specification IC_COM_LIB_INIT 6 AVI init failure IC_NOT_IF_STARTED 7 AVI init failure ...

Page 36: ...ontrolFlag_FlipVertical IID_IAMCameraControl CameraControl_Exposure These are the interfaces for controlling camera parameters Other implemented interfaces e g IAMStreamConfig are not shown here 4 2 iCube DirectShow Interface With the iCube DirectShow interface it is possible to control all camera parameters including Trigger mode ROI mode and Bin Skip modes In DirectShow ROI mode is unlike to the...

Page 37: ...ss Eeprom Contrast Eeprom Gamma Eeprom BlackLevel Eeprom BlackLevel Auto Eeprom Exposure Time Exposure Time Auto Eeprom Rough Eeprom Fine Eeprom Exp Target Eeprom Gain Eeprom Default Registry default parameters Color Enhancement Color Enhancement enable Eeprom Saturation Eeprom White Balance White Balance Eeprom Red Eeprom Green Eeprom Blue Eeprom One Push not saved ...

Page 38: ...era Control Parameters Trigger Trigger enable not saved Software Trigger not saved Hardware Trigger not saved Trigger Delay Eeprom Push SW trigger not saved Strobe Strobe Delay Eeprom Strobe Lenght Eeprom Other flip V Registry flip H Registry color enable Registry RAW Daten on off Clock Registry ...

Page 39: ...ideo Stream Control Parameters Videoformat Videostandard Video Format Registry Framerate calculation PLL H Shutter Resolution Registry Region of Interest Start Position Horizontal Registry Vertical Registry Size Horizontal Registry Vertical Registry Bin Skip Binning Registry Skipping Registry ...

Page 40: ...ntact the agent near you or contact NET directly at the following locations Europe http www net gmbh com USA http www net usa inc com Asia http www net japan com Support Team Email Europe info net gmbh com USA info net usa inc com Asia info net japan com Support Team Phone Europe 49 8806 92 34 0 USA 1 219 934 9042 Asia Support Team Fax Europe 49 8806 92 34 77 USA 1 219 934 9047 Asia 81 45 476 2423...

Search results

Summary of Contents for iCube Series

Reviews:

Related manuals for iCube Series

Brands by name

Popular brands

NET iCube Series, User Manual

Search results

Summary of Contents for iCube Series

Reviews:

Related manuals for iCube Series

Brands by name

Popular brands