Machine Vision Camera SDK (C)Developer Guide
Legal Informaon© 2022 Hangzhou Hikrobot Technology Co., Ltd. All rights reserved.This Document (hereinaer referred to be "the Document") is the property of Hangzhou HikrobotDigital Technology Co., Ltd. or its aliates (hereinaer referred to as "Hikrobot"), and it cannot bereproduced, changed, translated, or distributed, parally or wholly, by any means, without theprior wrien permission of Hikrobot. Unless otherwise expressly stated herein, Hikrobot does notmake any warranes, guarantees or representaons, express or implied, regarding to theDocument, any informaon contained herein.LEGAL DISCLAIMERTO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE DOCUMENT IS PROVIDED "AS IS"AND "WITH ALL FAULTS AND ERRORS". HIKROBOT MAKES NO REPRESENTATIONS OR WARRANTIES,EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. IN NO EVENT WILL HIKROBOT BELIABLE FOR ANY SPECIAL, CONSEQUENTIAL, INCIDENTAL, OR INDIRECT DAMAGES, INCLUDING,AMONG OTHERS, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION OR LOSSOF DATA, CORRUPTION OF SYSTEMS, OR LOSS OF DOCUMENTATION, WHETHER BASED ON BREACHOF CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE, IN CONNECTION WITH THE USEOF THE DOCUMENT, EVEN IF HIKROBOT HAS BEEN ADVISED OF THE POSSIBILITY OF SUCHDAMAGES OR LOSS.TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, THE DOCUMENT IS PROVIDED "AS IS"AND "WITH ALL FAULTS AND ERRORS". OUR COMPANY MAKES NO REPRESENTATIONS ORWARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. IN NO EVENTWILL OUR COMPANY BE LIABLE FOR ANY SPECIAL, CONSEQUENTIAL, INCIDENTAL, OR INDIRECTDAMAGES, INCLUDING, AMONG OTHERS, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESSINTERRUPTION OR LOSS OF DATA, CORRUPTION OF SYSTEMS, OR LOSS OF DOCUMENTATION,WHETHER BASED ON BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), OR OTHERWISE, INCONNECTION WITH THE USE OF THE DOCUMENT, EVEN IF OUR COMPANY HAS BEEN ADVISED OFTHE POSSIBILITY OF SUCH DAMAGES OR LOSS.Machine Vision Camera SDK (C) Developer Guidei
ContentsChapter 1 Overview .................................................................................................................... 11.1 Introducon ........................................................................................................................... 11.2 Development Environment .................................................................................................... 11.3 Update History ....................................................................................................................... 21.4 Noce ..................................................................................................................................... 7Chapter 2 Connect Device ........................................................................................................... 9Chapter 3 Image Acquision and Display .................................................................................. 113.1 Get Image Directly ............................................................................................................... 113.2 Get Image in Callback Funcon ............................................................................................ 14Chapter 4 API Reference ........................................................................................................... 184.1 General ................................................................................................................................ 184.1.1 MV_CC_GetSDKVersion .............................................................................................. 184.1.2 MV_CC_EnumDevices ................................................................................................. 184.1.3 MV_CC_EnumDevicesEx ............................................................................................. 194.1.4 MV_CC_EnumDevicesEx2 ........................................................................................... 204.1.5 MV_CC_IsDeviceAccessible ........................................................................................ 214.1.6 MV_CC_SetSDKLogPath .............................................................................................. 234.1.7 MV_CC_CreateHandle ................................................................................................ 234.1.8 MV_CC_CreateHandleWithoutLog ............................................................................. 244.1.9 MV_CC_DestroyHandle ............................................................................................... 254.1.10 MV_CC_OpenDevice ................................................................................................. 254.1.11 MV_CC_CloseDevice ................................................................................................. 274.1.12 MV_CC_GetDeviceInfo .............................................................................................. 274.1.13 MV_CC_GetValidImageNum ..................................................................................... 284.2 Parameter Sengs ............................................................................................................... 284.2.1 MV_CC_GetBoolValue ................................................................................................ 28Machine Vision Camera SDK (C) Developer Guideii
4.2.2 MV_CC_SetBoolValue ................................................................................................. 294.2.3 MV_CC_GetEnumValue .............................................................................................. 304.2.4 MV_CC_SetEnumValue ............................................................................................... 314.2.5 MV_CC_SetEnumValueByString .................................................................................. 314.2.6 MV_CC_GetEnumEntrySymbolic ................................................................................ 324.2.7 MV_CC_GetFloatValue ................................................................................................ 334.2.8 MV_CC_SetFloatValue ................................................................................................ 344.2.9 MV_CC_GetIntValueEx ................................................................................................ 354.2.10 MV_CC_SetIntValueEx .............................................................................................. 354.2.11 MV_CC_GetStringValue ............................................................................................ 364.2.12 MV_CC_SetStringValue ............................................................................................. 374.2.13 MV_CC_SetCommandValue ...................................................................................... 374.2.14 MV_CC_ReadMemory .............................................................................................. 384.2.15 MV_CC_WriteMemory .............................................................................................. 394.3 Funconal ............................................................................................................................ 404.3.1 General APIs ................................................................................................................ 404.3.2 GigE APIs ..................................................................................................................... 644.3.3 CameraLink Camera .................................................................................................... 744.3.4 GenTL APIs .................................................................................................................. 864.4 Image Acquision ................................................................................................................ 894.4.1 MV_CC_ClearImageBuer .......................................................................................... 894.4.2 MV_CC_FreeImageBuer ............................................................................................ 904.4.3 MV_CC_GetImageBuer ............................................................................................. 914.4.4 MV_CC_GetImageForBGR ........................................................................................... 924.4.5 MV_CC_GetImageForRGB ........................................................................................... 934.4.6 MV_CC_GetOneFrameTimeout .................................................................................. 944.4.7 MV_CC_RegisterImageCallBackEx .............................................................................. 954.4.8 MV_CC_RegisterImageCallBackForBGR ...................................................................... 96Machine Vision Camera SDK (C) Developer Guideiii
4.4.9 MV_CC_RegisterImageCallBackForRGB ...................................................................... 974.4.10 MV_CC_StartGrabbing .............................................................................................. 984.4.11 MV_CC_StopGrabbing .............................................................................................. 994.5 Image Processing ............................................................................................................... 1004.5.1 MV_CC_DisplayOneFrame ........................................................................................ 1004.5.2 MV_CC_SaveImageEx2 ............................................................................................. 1004.5.3 MV_CC_ConvertPixelType ......................................................................................... 1014.5.4 MV_CC_SetBayerCvtQuality ..................................................................................... 1024.5.5 MV_CC_SetBayerGammaValue ................................................................................. 1024.5.6 MV_CC_SetBayerGammaParam ............................................................................... 1034.5.7 MV_CC_SetBayerCCMParam .................................................................................... 1044.5.8 MV_CC_SetBayerCCMParamEx ................................................................................. 1044.5.9 MV_CC_LSCCalib ....................................................................................................... 1054.5.10 MV_CC_LSCCorrect ................................................................................................. 1054.5.11 MV_CC_HB_Decode ................................................................................................ 1064.5.12 MV_CC_RotateImage .............................................................................................. 1074.5.13 MV_CC_FlipImage ................................................................................................... 1074.5.14 MV_CC_StartRecord ............................................................................................... 1084.5.15 MV_CC_InputOneFrame ......................................................................................... 1084.5.16 MV_CC_StopRecord ................................................................................................ 1094.5.17 MV_CC_SaveImageToFile ........................................................................................ 1094.5.18 MV_CC_SavePointCloudData .................................................................................. 1104.5.19 MV_CC_DrawCircle ................................................................................................. 1124.5.20 MV_CC_DrawLines .................................................................................................. 1124.5.21 MV_CC_DrawRect ................................................................................................... 1134.5.22 MV_CC_ImageContrast ........................................................................................... 1134.5.23 MV_CC_ReconstructImage ..................................................................................... 1144.5.24 MV_CC_SetBayerFilterEnable ................................................................................. 114Machine Vision Camera SDK (C) Developer Guideiv
4.6 Advanced Sengs .............................................................................................................. 1154.6.1 General APIs .............................................................................................................. 1154.6.2 GigE APIs ................................................................................................................... 1164.6.3 U3V APIs .................................................................................................................... 1184.7 Camera Internal APIs ......................................................................................................... 1224.7.1 MV_CC_GetUpgradeProcess ..................................................................................... 1224.7.2 MV_CC_LocalUpgrade .............................................................................................. 1234.7.3 MV_XML_GetGenICamXML ...................................................................................... 1244.7.4 MV_XML_GetNodeInterfaceType ............................................................................. 1244.7.5 MV_XML_GetNodeAccessMode ............................................................................... 1284.8 Obsolete APIs ..................................................................................................................... 1324.8.1 MV_CC_BayerSpaalDenoise ................................................................................... 1324.8.2 MV_CC_ColorCorrect ................................................................................................ 1334.8.3 MV_CC_Display ......................................................................................................... 1334.8.4 MV_CC_GetImageInfo .............................................................................................. 1404.8.5 MV_CC_GetIntValue ................................................................................................. 1424.8.6 MV_CC_GetOneFrame .............................................................................................. 1444.8.7 MV_CC_GetOneFrameEx .......................................................................................... 1474.8.8 MV_GIGE_ForceIp ..................................................................................................... 1514.8.9 MV_CC_ImageContrast ............................................................................................. 1534.8.10 MV_CC_ImageSharpen ........................................................................................... 1534.8.11 MV_CC_NoiseEsmate ........................................................................................... 1544.8.12 MV_CC_RegisterEventCallBack ............................................................................... 1544.8.13 MV_CC_RegisterImageCallBack .............................................................................. 1574.8.14 MV_CC_SaveImage ................................................................................................. 1614.8.15 MV_CC_SaveImageEx ............................................................................................. 1644.8.16 MV_CC_SetBayerCLUTParam .................................................................................. 1684.8.17 MV_CC_SetIntValue ................................................................................................ 169Machine Vision Camera SDK (C) Developer Guidev
4.8.18 MV_CC_SpaalDenoise .......................................................................................... 171Chapter 5 Data Structure and Enumeraon ............................................................................. 1735.1 Data Structure .................................................................................................................... 1735.1.1 MV_ACTION_CMD_INFO .......................................................................................... 1735.1.2 MV_ACTION_CMD_RESULT ...................................................................................... 1745.1.3 MV_ACTION_CMD_RESULT_LIST .............................................................................. 1745.1.4 MV_ALL_MATCH_INFO ............................................................................................. 1755.1.5 MV_CamL_DEV_INFO ............................................................................................... 1755.1.6 MV_CC_CCM_PARAM ............................................................................................... 1765.1.7 MV_CC_CCM_PARAM_EX ......................................................................................... 1775.1.8 MV_CC_CONTRAST_PARAM ..................................................................................... 1775.1.9 MV_CC_CLUT_PARAM .............................................................................................. 1785.1.10 MV_CC_COLOR_CORRECT_PARAM ........................................................................ 1785.1.11 MV_CC_CONTRAST_PARAM ................................................................................... 1795.1.12 MV_CC_DEVICE_INFO ............................................................................................. 1805.1.13 MV_CC_DEVICE_INFO_LIST .................................................................................... 1815.1.14 MV_CC_FILE_ACCESS .............................................................................................. 1825.1.15 MV_CC_FILE_ACCESS_PROGRESS ........................................................................... 1825.1.16 MV_CC_FLIP_IMAGE_PARAM ................................................................................. 1835.1.17 MV_CC_FRAME_SPEC_INFO ................................................................................... 1835.1.18 MV_CC_GAMMA_PARAM ....................................................................................... 1845.1.19 MV_CC_HB_DECODE_PARAM ................................................................................ 1855.1.20 MV_CC_INPUT_FRAME_INFO ................................................................................. 1855.1.21 MV_CC_LSC_CALIB_PARAM .................................................................................... 1865.1.22 MV_CC_LSC_CORRECT_PARAM .............................................................................. 1875.1.23 MV_CC_NOISE_ESTIMATE_PARAM ......................................................................... 1875.1.24 MV_CC_PIXEL_CONVERT_PARAM .......................................................................... 1895.1.25 MV_CC_RECORD_PARAM ....................................................................................... 190Machine Vision Camera SDK (C) Developer Guidevi
5.1.26 MV_CC_RECT_I ....................................................................................................... 1915.1.27 MV_CC_ROTATE_IMAGE_PARAM ........................................................................... 1925.1.28 MV_CC_SHARPEN_PARAM ..................................................................................... 1925.1.29 MV_CC_SPATIAL_DENOISE_PARAM ........................................................................ 1935.1.30 MV_DISPLAY_FRAME_INFO .................................................................................... 1955.1.31 MV_EVENT_OUT_INFO ........................................................................................... 1965.1.32 MV_FRAME_OUT .................................................................................................... 1975.1.33 MV_FRAME_OUT_INFO .......................................................................................... 1985.1.34 MV_FRAME_OUT_INFO_EX .................................................................................... 1995.1.35 MV_GENTL_DEV_INFO ........................................................................................... 2015.1.36 MV_GENTL_DEV_INFO_LIST ................................................................................... 2025.1.37 MV_GENTL_IF_INFO ............................................................................................... 2035.1.38 MV_GENTL_IF_INFO_LIST ....................................................................................... 2035.1.39 MV_GIGE_DEVICE_INFO ......................................................................................... 2045.1.40 MV_IMAGE_BASIC_INFO ........................................................................................ 2055.1.41 MV_MATCH_INFO_NET_DETECT ............................................................................ 2075.1.42 MV_MATCH_INFO_USB_DETECT ............................................................................ 2075.1.43 MV_NETTRANS_INFO ............................................................................................. 2085.1.44 MV_OUTPUT_IMAGE_INFO .................................................................................... 2095.1.45 MV_RECORD_FORMAT_TYPE .................................................................................. 2095.1.46 MV_RECONSTRUCT_IMAGE_PARAM ...................................................................... 2095.1.47 MV_SAVE_IMAGE_PARAM ...................................................................................... 2105.1.48 MV_SAVE_IMAGE_PARAM_EX ................................................................................ 2115.1.49 MV_SAVE_IMG_TO_FILE_PARAM ........................................................................... 2125.1.50 MV_SAVE_POINT_CLOUD_PARAM ......................................................................... 2135.1.51 MV_TRANSMISSION_TYPE ...................................................................................... 2145.1.52 MV_USB3_DEVICE_INFO ........................................................................................ 2155.1.53 MV_XML_FEATURE_Base ........................................................................................ 216Machine Vision Camera SDK (C) Developer Guidevii
5.1.54 MV_XML_FEATURE_Boolean .................................................................................. 2175.1.55 MV_XML_FEATURE_Category ................................................................................. 2185.1.56 MV_XML_FEATURE_Command ............................................................................... 2185.1.57 MV_XML_FEATURE_EnumEntry ............................................................................. 2195.1.58 MV_XML_FEATURE_Enumeraon .......................................................................... 2215.1.59 MV_XML_FEATURE_Float ....................................................................................... 2225.1.60 MV_XML_FEATURE_Integer .................................................................................... 2235.1.61 MV_XML_FEATURE_Port ........................................................................................ 2245.1.62 MV_XML_FEATURE_Register .................................................................................. 2255.1.63 MV_XML_FEATURE_String ...................................................................................... 2265.1.64 MV_XML_FEATURE_Value ...................................................................................... 2275.1.65 MV_XML_NODE_FEATURE ...................................................................................... 2285.1.66 MV_XML_NODES_LIST ............................................................................................ 2285.1.67 MVCC_CIRCLE_INFO ............................................................................................... 2295.1.68 MVCC_COLORF ....................................................................................................... 2305.1.69 MVCC_ENUMENTRY ............................................................................................... 2305.1.70 MVCC_ENUMVALUE ............................................................................................... 2305.1.71 MVCC_FLOATVALUE ................................................................................................ 2315.1.72 MVCC_INTVALUE .................................................................................................... 2325.1.73 MVCC_INTVALUE_EX .............................................................................................. 2325.1.74 MVCC_LINES_INFO ................................................................................................. 2335.1.75 MVCC_POINTF ........................................................................................................ 2335.1.76 MVCC_RECT_INFO .................................................................................................. 2345.1.77 MVCC_STRINGVALUE .............................................................................................. 2345.2 Enumeraon ...................................................................................................................... 2355.2.1 MV_CAM_ACQUISITION_MODE ............................................................................... 2355.2.2 MV_CAM_BALANCEWHITE_AUTO ............................................................................ 2355.2.3 MV_CAM_EXPOSURE_AUTO_MODE ........................................................................ 236Machine Vision Camera SDK (C) Developer Guideviii
5.2.4 MV_CAM_GAIN_MODE ............................................................................................ 2365.2.5 MV_CAM_GAMMA_SELECTOR ................................................................................. 2375.2.6 MV_CAM_TRIGGER_MODE ...................................................................................... 2375.2.7 MV_CAM_TRIGGER_SOURCE ................................................................................... 2375.2.8 MV_CC_BAYER_NOISE_FEATURE_TYPE .................................................................... 2385.2.9 MV_CC_GAMMA_TYPE ............................................................................................. 2385.2.10 MV_CC_STREAM_EXCEPTION_TYPE ....................................................................... 2395.2.11 MV_GIGE_EVENT .................................................................................................... 2405.2.12 MV_GIGE_TRANSMISSION_TYPE ............................................................................ 2415.2.13 MV_GRAB_STRATEGY ............................................................................................. 2415.2.14 MV_IMAGE_RECONSTRUCTION_METHOD ............................................................. 2425.2.15 MV_IMG_FLIP_TYPE ............................................................................................... 2425.2.16 MV_IMG_ROTATION_ANGLE .................................................................................. 2435.2.17 MV_SAVE_IAMGE_TYPE .......................................................................................... 2435.2.18 MV_SAVE_POINT_CLOUD_FILE_TYPE ..................................................................... 2445.2.19 MV_SORT_METHOD ............................................................................................... 2445.2.20 MV_XML_AccessMode ........................................................................................... 2455.2.21 MV_XML_InterfaceType ......................................................................................... 2455.2.22 MV_XML_Visibility .................................................................................................. 2475.2.23 MvGvspPixelType .................................................................................................... 247Chapter 6 FAQ (Frequently Asked Queson) ........................................................................... 2536.1 GigE Vision Camera ............................................................................................................ 2536.1.1 Why is there packet loss? .......................................................................................... 2536.1.2 Why does link error occur in the normal compiled Demo? ...................................... 2536.1.3 Why can't I set the stac IP under DHCP? ................................................................. 2536.1.4 Why do I failed to perform the soware trigger command when calling SDK? ........ 2546.1.5 Why does the camera oen be oine? .................................................................... 2546.1.6 Why is no permission returned when calling API MV_CC_OpenDevice? ................. 254Machine Vision Camera SDK (C) Developer Guideix