Programmers Guide for Fingerprints SDK

Version: 2.6

1. Features
OR200NOpticalSensor SupportWindows2000/XP/Vista/Windows7

2. SDKFiles
FileName OR200N.Inf, OR200N.sys PTSDK4_WISCMOS2_PTFV.h DriverforOR200N Descriptions

HeaderfileofFingerprintVerificationAlgorithemand thesensorcontrolofOR200N PTSDK4_WISCMOS2_PTFV.dll DLLfilesofFingerprintAlgorithemandthesensor PTSDK4_WISCMOS2_PTFV.lib controlofOR200N PTSDK4_WISCMOS2_PTFV.lib StaticlinklibraryforAPdevelopment

3. SDKFunctions
FunctionName bAPI4_OpenDevice bAPI4_OpenSensor bAPI4_GetDeviceNum bAPI4_SelectDevice bAPI4_CloseSensor bAPI4_GetImage bAPI4_GetBinaryImage bAPI4_StartRealtimeImage bAPI4_GrabRealtimeImage bAPI4_StopImage bAPI4_CheckSensorStatus bAPI4_HMFVOpenLib bAPI4_HMFVCLoseLib bAPI4_HMFVStartEnroll bAPI4_HMFVEnroll bAPI4_HMFVVerify bAPI4_HMFVExtract bAPI4_HMFVVerifyTemplate bAPI4_HMFVSetParas bAPI4_HMFVGetParas bAPI4_ReadPID bAPI4_ReadSN bAPI4_ReadMFS bAPI4_ReadPDS bAPI4_ReadInfo bAPI4_WriteInfo
2

Descriptions OpenthefingerprintUSBdevice Openfingerprintsensor Getdevicenumber Selectdevice Closefingerprintsensor Getthegrayfingerprintimage Getthebinaryfingerprintimage Startrealtimeimagecapturing Grabrealtimeimagewithoutqualitycheck Stopthegetimage Checksensorstatus Enablethefingerprintalgorithmfunctions Disablethefingerprintalgorithmfunctions Startthefingerprintenrollment Fingerprintenrollment Fingerprintverificationbyimage Fingerprintfeatureextraction(Reserved) Fingerprintverificationbyfeature(Reserved) Setparametertofingerprintalgorithm Getparameterfromfingerprintalgorithm ReadProductIDfromEEPROM ReadSerialNumberfromEEPROM ReadManufacturerInformationfromEEPROM ReadProductInformationfromEEPROM ReadCustomerDefinedInformationfromEEPROM WriteCustomerDefinedInformationtoEEPROM

4. Parameters 4.1 FingerprintWindowSize

Definethefingerprintwindowsize,unitinPixel,inthiscase,thefingerprintwindowsizeis 256pixels*288pixels #define SENSOR_WIDTH 256 #define SENSOR_HEIGHT 288

4.2 Resolution
Definethesensorimageresolution. #define SENSOR_RESOLUTION

500

4.3 MaximumTemplateSize
Definethemaximumtemplatesizeofanenrolledfingerprint. #define HMFV_MAX_TEMPLATE_SIZE 500

4.4 AlgorithmKernelStatus
Valuereturnwhilealgorithmkernelfunctionfailstocall. #define HMFV_LIB_NOT_OPENED #define HMFV_STS_MALLOC_FAIL

100 101

4.5 GetImageStatus
Valuereturnwhilegetimagefunctiontimeout. #define HMFV_STS_GI_TIMEOUT

4.6 EnrollmentStatus
#define #define #define #define #define #define HMFV_STS_EN_CONTINUE HMFV_STS_EN_SUCCESS HMFV_STS_EN_FAIL HMFV_STS_EN_NOINIT HMFV_STS_EN_TOOMANY_POORIMG HMFV_STS_EN_TOOMAY_TRIALS 1 0 1 2 3 4

4.7 VerificationStatus
#define #define #define #define HMFV_STS_VF_SUCCESS HMFV_STS_VF_FAIL HMFV_STS_VF_POORIMG HMFV_STS_VF_ERROR 2 1 1 2

4.8 SecurityLevel
#define #define #define #define PARAID_MATCHTHRESHOLD LOW_MATCH_TH MID_MATCH_TH HIGH_MATCH_TH 100 0 1 2

4.9 EEPROMFieldLength
#define #define #define #define #define PID_VALUE_SIZE SN_VALUE_SIZE MFS_VALUE_SIZE PDS_VALUE_SIZE INFO_VALUE_SIZE 2 8 16 16 32

5. Functions 5.1 OpenDevice

Synopsis:bAPI4_OpenDevice() Description:CallthisfunctiontoopenthefingerprintUSBdevice.Thisisunused. Parameter:None. ReturnValue: FALSE(0) OpendeviceNG. TRUE(1) OpendeviceOK.

5.2 OpenSensor
Synopsis:bAPI4_OpenSensor() Description:Callthisfunctiontoopenthefingerprintsensor. Parameter:None. ReturnValue: FALSE(0) OpensensorNG. TRUE(1) OpensensorOK. Synopsis:bAPI4_GetDeviceNum() Description:Callthisfunctiontogetthenumberofdevice. Parameter:None. ReturnValue: IntegerValue Numberofdevice. Synopsis:bAPI4_SelectDevice(intiDevice) Description:Callthisfunctiontoselectthedevicetoopenit. Parameter:None. ReturnValue: FALSE(0) SelectdeviceNG. TRUE(1) SelectdeviceOK.
5

5.3 GetDeviceNumber

5.4 SelectDevice

5.5 CloseSensor
Synopsis:bAPI4_CloseSensor() Description:Callthisfunctiontoclosethefingerprintsensor. Parameter:None. ReturnValue: FALSE(0) OpensensorNG. TRUE(1) OpensensorOK. Synopsis:bAPI4_GetImage(BYTE*picture,inttimeout,intiResolution, int*piWidth,int*piHeight) Description:CallthebAPI4_GetImagetogetthegrayfingerprintimagewithqualitycheck. Parameter: picture Pointertoanimagebuffer timeout Timeoutperiodforgettingimage(millisecond) iResolution Imageresolution(Default:SENSOR_RESOLUTION) piWidth Returnedimagewidth piHeight Returnedimageheight ReturnValue: FALSE(0) GetgrayimageNG. TRUE(1) GetgrayimageOK. Synopsis:bAPI4_GetBinaryImage(BYTE*picture,inttimeout,intiResolution, int*piWidth,int*piHeight) Description:CallthebAPI4_GetBinaryImagetogetthebinaryfingerprintimagewith qualitycheck. Parameter: picture Pointertoanimagebuffer timeout Timeoutperiodforgettingimage(millisecond) iResolution Imageresolution(Default:SENSOR_RESOLUTION) piWidth Returnedimagewidth piHeight Returnedimageheight ReturnValue: FALSE(0) GetbinaryimageNG. TRUE(1) GetbinaryimageOK. 6

5.6 GetFingerprintImage

Synopsis:bAPI4_StartRealtimeImage(intiResolution,int*piWidth,int*piHeight) Description:Callthisfunctiontostartrealtimeimagecapturing.(grayimageonly) Parameter: iResolution Imageresolution(Default:SENSOR_RESOLUTION) piWidth Returnedimagewidth piHeight Returnedimageheight ReturnValue: FALSE(0) StartrealtimeimagecapturingNG. TRUE(1) StartrealtimeimagecapturingOK. Synopsis:bAPI4_GrabRealtimeImage(BYTE*picture) Description:Callthisfunctiontogetthegrayfingerprintimagewithoutqualitycheckfor realtimedisplay. Parameter: picture Pointertoanimagebuffer ReturnValue: FALSE(0) GetrealtimeimageNG. TRUE(1) GetrealtimeimageOK. Synopsis:bAPI4_StopImage() Description:CallthebAPI4_StopImagetostopgettingimage. Parameter:None. ReturnValue: FALSE(0) StopgettingimageNG. TRUE(1) StopgettingimageOK.
7

5.7 CheckSensorStatus
Synopsis:bAPI4_CheckSensorStatus(BOOL*pbStatus) Description:Callthisfunctiontocheckthesensorstatus. Parameter: pbStatus Returnedcurrentstatus FALSE(0):sensorisnotfound TRUE(1):sensorisready ReturnValue: FALSE(0) ChecksensorstatusNG. TRUE(1) ChecksensorstatusOK. 5.8 FingerprintAlgorithm Synopsis:bAPI4_HMFVOpenLib() Description:Callthisfunctiontoenablethefingerprintalogorithmfunctions. Parameter:None. ReturnValue: FALSE(0) OpenalgorithmkernelfunctionsNG. TRUE(1) OpenalgorithmkernelfunctionsOK. Synopsis:bAPI4_HMFVCLoseLib() Description:Callthisfunctiontodisablethefingerprintalogorithmfunctions. Parameter:None. ReturnValue: FALSE(0) ClosealgorithmkernelfunctionsNG. TRUE(1) ClosealgorithmkernelfunctionsOK. Synopsis:bAPI4_HMFVSetParas(intiParaID,intiParaValue) Description:Callthisfunctiontosetparameterstoalgorithmkernel. Parameter: iParaID ParameterID iParaValue ParameterValue
8

 ReturnValue: FALSE(0) SetparameterNG. TRUE(1) SetparameterOK. Synopsis:bAPI4_HMFVGetParas(intiParaID,int*piParaValue) Description:Callthisfunctiontogetparametersfromalgorithmkernel. Parameter: iParaID ParameterID iParaValue ReturnedParameterValue ReturnValue: FALSE(0) GetparameterNG. TRUE(1) GetparameterOK.

5.9 FingerprintEnrollment
Synopsis:bAPI4_HMFVStartEnroll(intiDefaultEnrolledTimes) Description:Callthisfunctiontostartthefingerprintenrollment. Parameter: iDefaultEnrolledTimes Timestoenrollfingerprint(Recommended:10) ReturnValue: FALSE(0) StartingenrollmentNG. TRUE(1) StartingenrollmentOK. Synopsis:bAPI4_HMFVEnroll(intiResolution,intiWidth,intiHeight, BYTE*pFingerImage, BYTE*pEnrolledFeatures,DWORD*pwEnRetSize, int*piStatus) Description:Callthisfunctiontodofingerprintenrollment.

 Parameter: iResolution iWidth iHeight pFingerImage pEnrolledFeatures pwEnRetSize piStatus ReturnValue: FALSE(0) TRUE(1)

ImageResolution ImageWidth ImageHeight Pointertoimagebufferreadyforenrollment Pointertobufferforkeepingreturnedfeatures Returnedenrolledfeaturesize Returnedenrollmentstatus (Referto4.5EnrollmentStatus)

FingerprintenrollmentNG. FingerprintenrollmentOK.

5.10 FingerprintVerificationbyImage
Synopsis:bAPI4_HMFVVerify(intiResolution,intiWidth,intiHeight, BYTE*pFingerImage, BYTE**ppEnrolledfeatures,intiEnrolledNum, int*piMatchedID, int*piStatus) Description:Callthisfunctiontodofingerprintverification. Parameter: iResolution ImageResolution iWidth ImageWidth iHeight ImageHeight pFingerImage Pointertoimagebufferreadyforverification ppEnrolledfeatures PointertoEnrolledfeaturebufferaddress iEnrolledNum NumberofEnrolledfeaturestobeverified piMatchedID ReturnedMatchedID piStatus ReturnedVerificationStatus (Referto4.6VerificationStatus) ReturnValue: FALSE(0) FingerprintVerificationbyImageNG. TRUE(1) FingerprintVerificationbyImageOK.

10

5.11 FingerprintFeatureExtraction
Synopsis:bAPI4_HMFVExtract(intiResolution,intiWidth,intiHeight, BYTE*pFingerImage, BYTE*pFeatures,DWORD*pwFeatSize, int*piQuality) Description:Callthisfunctiontodofingerprintfeatureextraction. Parameter: iResolution ImageResolution iWidth ImageWidth iHeight ImageHeight pFingerImage Pointertoimagebufferreadyforfeatureextraction pFeatures Pointertoextractedfeaturebufferaddress pwFeatSize Sizeofextractedfeature piQuality ReturnedQualityofextractedfeature ReturnValue: FALSE(0) FingerprintFeatureExtractionNG. TRUE(1) FingerprintFeatureExtractionOK.

5.12 FingerprintVerificationbyFeature
Synopsis:bAPI4_HMFVVerifyTemplate(BYTE*pTemplate, BYTE**ppEnrolledfeatures,intiEnrolledNum, int*piMatchedID,int*piStatus) Description:Callthisfunctiontodofingerprintverificationbyextractedfeature. Parameter: pTemplate Pointertoextractedfeaturebufferreadyfor verification ppEnrolledfeatures PointertoEnrolledfeaturebufferaddress iEnrolledNum NumberofEnrolledfeaturestobeverified piMatchedID ReturnedMatchedID piStatus ReturnedVerificationStatus (Referto4.5VerificationStatus) ReturnValue: FALSE(0) FingerprintVerificationbyFeatureNG. TRUE(1) FingerprintVerificationbyFeatureOK.

11

5.13 Read/WriteEEPROM(OR200EOnly)
Synopsis:bAPI4_ReadPID(BYTE*pBuf) Description:CallthisfunctiontoreadtheProductIDfromEEPROM. Parameter: pBuf Pointertodatabuffer (Referto4.9EEPROMFieldLength) ReturnValue: FALSE(0) ReadEEPROMNG. TRUE(1) ReadEEPROMOK. Synopsis:bAPI4_ReadSN(BYTE*pBuf) Description:CallthisfunctiontoreadtheSerialNumberfromEEPROM. Parameter: pBuf Pointertodatabuffer (Referto4.9EEPROMFieldLength) ReturnValue: FALSE(0) ReadEEPROMNG. TRUE(1) ReadEEPROMOK. Synopsis:bAPI4_ReadMFS(BYTE*pBuf) Description:CallthisfunctiontoreadtheManufacturerInformationfromEEPROM. Parameter: pBuf Pointertodatabuffer (Referto4.9EEPROMFieldLength) ReturnValue: FALSE(0) ReadEEPROMNG. TRUE(1) ReadEEPROMOK.

12

 Synopsis:bAPI4_ReadPDS(BYTE*pBuf) Description:CallthisfunctiontoreadtheProductInformationfromEEPROM. Parameter: pBuf Pointertodatabuffer (Referto4.9EEPROMFieldLength) ReturnValue: FALSE(0) ReadEEPROMNG. TRUE(1) ReadEEPROMOK. Synopsis:bAPI4_ReadInfo(BYTE*pBuf) Description:CallthisfunctiontoreadtheCustomerdefinedInformationfromEEPROM. Parameter: pBuf Pointertodatabuffer Themaximumallowedsizetoreadis32bytes (Referto4.9EEPROMFieldLength) ReturnValue: FALSE(0) ReadEEPROMNG. TRUE(1) ReadEEPROMOK. Synopsis:bAPI4_WriteInfo(BYTE*pBuf) Description:CallthisfunctiontowritetheCustomerdefinedInformationtoEEPROM. Parameter: pBuf Pointertodatabuffer Themaximumallowedsizetowriteis32bytes (Referto4.9EEPROMFieldLength) ReturnValue: FALSE(0) WriteEEPROMNG. TRUE(1) WriteEEPROMOK.

13

6. ControlFlows 6.1 SDKEnable/DisableFlow

Start

bAPI4_OpenDevice bAPI4_GetDeviceNum

bAPI4_OpenSensor bAPI4_SelectDevice

bAPI4_HMFVOpenLib

...

bAPI4_HMFVCLoseLib

bAPI4_CloseSensor

End

14

6.2 FingerprinEnrollmentFlow

15

 6.3 FingerprintVerificationbyImageFlow

16

6.4 FingerprintVerificationbyFeatureFlow(Reserved)
Start

bAPI4_GetImage

NG bAPI4_HMFVExtract

OK

bAPI4_HMFVVerifyTemplate

piStatus== HMFV_STS_VF_POORIMG CheckpiStatus piStatus== HMFV_STS_VF_SUCCESS piStatus== HMFV_STS_VF_FAIL

...

...

End
17

6.5 GetPureImagewithoutQualityCheck
Start

bAPI4_StartRealtimeImage

bAPI4_GrabRealtimeImage

bAPI4_StopImage

End

18