PC0004 How to replace BioMini SDK V.2.6 with V.3.

BioMini SDK V.3.1

PC SDK is upgraded to support a new scanner, BioMini. Functions are newly added and optimized in
the SDK V.3.1. But if you know the usage of SDK V. 2.6, you can change your project to SDK 3.1 without
difficulty, because the main functions are same as old version. The notable change is that the SFR300
module is divided into two modules which are UFScanner and UFMacher.
The wrapper.dll of SDK V.2.6 can be supplied if you need, but we recommend you to use optimized SDK
V.3.1.
This script helps you to upgrade your project from SDK V. 2.6 to V. 3.1 or higher. All SDK 2.6 functions
can be easily replaced with V. 3.1 functions by changing name and adding some parameters.

Functions of initialization and uninitialization

Functions

SDK V.2.6

SDK V.3.1

SF_Initialize()

SF_Initialize()

UFS_Init();

SF_SelectReader(int SensorType)

SF_SelectReader(int SensorType)

Not use

SF_Uninitialize()

SF_Uninitialize()

UFS_Uninit();

SF_GetDeviceNumber()

SF_GetDeviceNumber()

Removed

SF_GetDevice()

SF_GetDevice()

Removed

SF_SetDevice(int Device)

SF_SetDevice(int Device)

Removed

New function of BioMini SDK V.3.1 (Scanner handle)

In SDK version 3.1, the functions about UFScanner module need a specific scanner handle. The
UFS_Init() initializes all connected scanners. And then one scanner handle must be selected for using
the scanner functions. You can get the scanner handle by using UFS_GetScannerHandle.
UFS_GetScannerHandle(int nScannerIndex, HUFScanner* phScanner)
nScannerIndex

The index number of one of the initialized scanners.

If you use just one scanner, set this value to 0.

phScanner

Handle of scanner
PC0004 How to replace BioMini SDK V.2.6 with V.3.1

SF_GetSerial(unsigned char* Serial)

SDK V.2.6

SDK V.3.1

SF_GetSerial(Serial)

UFS_GetParameter(g_hScanner, UFS_PARAM_SERIAL, Serial)

UFS_GetParameter(g_hScanner, UFS_PARAM_SERIAL, Serial)

hScanner

Scanner handle

UFS_PARAM_SERIAL

Parameter for requiring a serial number

Serial

Serial number

SF_GetTimeout()
SDK V.2.6

SDK V.3.1

SF_GetTimeout()

UFS_GetParameter(g_hScanner, UFS_PARAM_TIMEOUT, &value)

UFS_GetParameter(g_hScanner, UFS_PARAM_TIMEOUT, &value)

hScanner

Scanner handle

UFS_PARAM_TIMEOUT

Parameter for requiring a timeout value

value

Timeout value

SF_SetTimeout(int Timeout)
SDK V.2.6

SDK V.3.1

SF_SetTimeout(Timeout)

UFS_SetParameter(g_hScanner, UFS_PARAM_TIMEOUT, &Timeout)

UFS_SetParameter(g_hScanner, UFS_PARAM_TIMEOUT, &Timeout)

hScanner

Scanner handle

UFS_PARAM_TIMEOUT

Parameter for requiring a timeout value

value

The timeout value for setting

PC0004 How to replace BioMini SDK V.2.6 with V.3.1

SF_GetBrightness()
SDK V.2.6

SDK V.3.1

SF_GetBrightness()

UFS_GetParameter(g_hScanner, UFS_PARAM_BRIGHTNESS, &value)

UFS_GetParameter(g_hScanner, UFS_PARAM_BRIGHTNESS, &value)

hScanner

Scanner handle

UFS_PARAM_BRIGHTNESS

Parameter for requiring a brightness value

value

brightness value

SF_SetBrightness(int Brightness)
SDK V.2.6

SDK V.3.1

SF_SetBrightness(Brightn
ess)

UFS_SetParameter(g_hScanner, UFS_PARAM_BRIGHTNESS,
&Brightness)

UFS_SetParameter(g_hScanner, UFS_PARAM_BRIGHTNESS, &Brightness)

hScanner

Scanner handle

UFS_PARAM_BRIGHTNESS

Parameter for setting the brightness value

value

the brightness value for setting

SF_GetSensitivity()
SDK V.2.6

SDK V.3.1

SF_GetSensitivity()

UFS_GetParameter(g_hScanner, UFS_PARAM_SENSITIVITY, &value)

UFS_GetParameter(g_hScanner, UFS_PARAM_SENSITIVITY, &value)

hScanner

Scanner handle

UFS_PARAM_SENSITIVITY

Parameter for setting the sensitivity level

value

sensitivity level value

PC0004 How to replace BioMini SDK V.2.6 with V.3.1

SF_IsSensorOn()
SDK V.2.6

SDK V.3.1

SF_IsSensorOn()

UFS_IsFingerOn(g_hScanner, &bFingerOn)

UFS_IsFingerOn(g_hScanner, &bFingerOn)
hScanner

Scanner handle

bFingerOn

Return value
1: Finger On | 0: Finger Off

SF_Capture()
SDK V.2.6

SDK V.3.1

SF_Capture()

UFS_CaptureSingleImage(g_hScanner)

UFS_CaptureSingleImage(g_hScanner)
hScanner

Scanner handle

SF_AbortCapturing()
SDK V.2.6

SDK V.3.1

SF_AbortCapturing()

UFS_AbortCapturing(g_hScanner)

UFS_AbortCapturing(g_hScanner)
hScanner

Scanner handle

SF_GetImageWidth(), SF_GetImageHeight(), SF_GetImageBuffer()

SDK V.2.6

SDK V.3.1

SF_GetImageWidth(),
SF_GetImageHeight(),
SF_GetImageBuffer()

UFS_GetCaptureImageBufferInfo(g_hScanner, &nWidth, &nHeight,

&nResolution)

- UFS_GetCaptureImageBufferInfo(g_hScanner, &nWidth, &nHeight, &nResolution)

hScanner

Scanner handle

nWidth

Captured Images width

nHeight

Captured Images height

nResolution

Captured Images resolution

PC0004 How to replace BioMini SDK V.2.6 with V.3.1

SF_Clear()
SDK V.2.6

SDK V.3.1

SF_Clear()

UFS_ClearCaptureImageBuffer(g_hScanner)

UFS_ClearCaptureImageBuffer(g_hScanner)
hScanner

Scanner handle

SF_Draw(HWND hWnd, int l, int t, int r, int b, int bCore

SDK V.2.6

SDK V.3.1

SF_Draw(HWND hWnd, int l, int t, int r, int b, int

bCore)

UFS_DrawCaptureImageBuffer(g_hScanner,
hDC, l, t, r, b, bCore)

UFS_DrawCaptureImageBuffer(g_hScanner, hDC, l, t, r, b, bCore)

hScanner

Scanner handle

hDC

Handle to the DC where the fingerprint image is drawn

Specifies the logical x-coordinate of the upper-left corner of the rectangle

Specifies the logical y-coordinate of the upper-left corner of the rectangle

Specifies the logical x-coordinate of the lower-right corner of the rectangle

Specifies the logical y-coordinate of the lower-right corner of the rectangle

bCore

Specifies whether the core of fingerprint is drawn of not

SF_Enroll(unsigned char* Template, int* TemplateSize, int bCoreDetect) + SF_GetEnrollQuality()

SDK V.2.6

SDK V.3.1

SF_Enroll(unsigned char* Template, int*

TemplateSize, int bCoreDetect)
+ SF_GetEnrollQuality()

UFS_SetParameter(g_hScanner,
UFS_PARAM_DETECT_CORE, &value)
+ UFS_Extract(g_hScanner, Template,
TemplateSize, &g_nEnrollQuality)

If the detect core option is not set, default setting is applied. The default setting of the core detec
tion is false.
UFS_SetParameter(g_hScanner, UFS_PARAM_DETECT_CORE, &value)

g_hScanner

Scanner handle

UFS_PARAM_DETECT_CORE

Parameter for using the core detection

value

1: set detect core 2: off

PC0004 How to replace BioMini SDK V.2.6 with V.3.1

UFS_Extract(g_hScanner, Template, TemplateSize, &g_nEnrollQuality

g_hScanner

Scanner handle

Template

Array to extract a template

TemplateSize

Size of extracted template

g_nEnrollQuality

Quality of extracted template

Return values of SF_Enroll & UFS_Extract

SDK V.2.6

SDK V.3.1

SF_SUCCESS

UFS_OK

SF_NOTGOODIMAGE

UFS_ERR_NOT_GOOD_IMAGE

SF_CORETOCENTER

UFS_ERR_CORE_NOT_DETECTED

SF_CORETOLEFT

UFS_ERR_CORE_TO_LEFT

SF_CORETOLEFT|SF_CORETOTOP

UFS_ERR_CORE_TO_LEFT_TOP

SF_CORETOTOP

UFS_ERR_CORE_TO_TOP

SF_CORETORIGHT|SF_CORETOTOP

UFS_ERR_CORE_TO_RIGHT_TOP

SF_CORETORIGHT

UFS_ERR_CORE_TO_RIGHT

SF_CORETORIGHT|SF_CORETOBOTTOM

UFS_ERR_CORE_TO_RIGHT_BOTTOM

SF_CORETOBOTTOM

UFS_ERR_CORE_TO_BOTTOM

SF_CORETOLEFT|SF_CORETOBOTTOM

UFS_ERR_CORE_TO_LEFT_BOTTOM

SF_EnrollWithVerify
SDK V.2.6

SDK V.3.1

SF_EnrollWithVerify(Template, TemplateSize,
bCoreDetect)

UFS_CaptureSingleImage(g_hScanner)
+ UFS_Extract(g_hScanner, Template, TemplateSize,
&g_nEnrollQuality)
+ UFM_Verify(g_hMatcher, Template,
*TemplateSize, g_Template, g_TemplateSize,
&bVerifySucceed)

If the detect core option is not set, default setting is applied. The default setting of the core
detection is false.

PC0004 How to replace BioMini SDK V.2.6 with V.3.1

UFM_Verify(g_hMatcher, Template, *TemplateSize, g_Template, g_TemplateSize, &bVerifySucceed)

g_ hMatcher

Handle of matcher

Template

Extracted Template

TemplateSize

Size of extracted Template

g_Template

Saved(Enrolled) Template

g_TemplateSize

Size of Saved(Enrolled) Template

bVerifySucceed

Matching condition
1: matching 0: not matching

If the detect core option is not set, default setting is applied. The default setting of the core
detection is false.
SF_Verify
SDK V.2.6

SDK V.3.1

SF_Verify(Template, SecurityLevel,
bCoreDetect)

UFS_Extract(g_hScanner, Template, TemplateSize,

&g_nEnrollQuality)
+ UFM_SetParameter(g_hMatcher,
UFM_PARAM_SECURITY_LEVEL, & SecurityLevel)
+ UFM_Verify(g_hMatcher, Template,
TEMPLATESIZE, Template2, TemplateSize2,
&bVerifySucceed)

UFM_SetParameter(g_hMatcher, UFM_PARAM_SECURITY_LEVEL, &value)

g_hScanner

Handle of scanner

UFM_PARAM_SECURITY_LEVEL

Parameter for setting the Security level

value

Value of security level (1~7)

UFM_Verify(g_hMatcher, Template, TemplateSize, Template2, TemplateSize2, &bVerifySucceed)

g_ hMatcher

Handle of matcher

Template

Extracted Template

TemplateSize

Size of extracted Template

g_Template

Saved(Enrolled) Template

g_TemplateSize

Size of Saved(Enrolled) Template

bVerifySucceed

Matching condition
1: matching 0: not matching

PC0004 How to replace BioMini SDK V.2.6 with V.3.1

SF_Identify
SDK V.2.6

SDK V.3.1

SF_Identify(Template, Count, Match,

SecurityLevel, bCoreDetect, Timeout)

UFS_Extract(g_hScanner, Template, TemplateSize,

&EnrollQuality)
+ UFM_SetParameter(g_hMatcher,
UFM_PARAM_SECURITY_LEVEL, & SecurityLevel)
+ UFM_Identify(g_hMatcher, Template,
TemplateSize, Template2, pnTemplate2Size, Count,
Timeout, & Match)

If the detect core option is not set, default setting is applied. The default setting of the core
detection is false.

UFM_Identify(g_hMatcher, Template, TemplateSize, Template2, pnTemplate2Size, Count, Timeout,

&nMatchTemplate2Index)
g_ hMatcher

Handle of matcher

Template

Extracted Template

TemplateSize

Size of extracted Template

Template

Array of saved(Enrolled) templates

pnTemplate2Size

Array of size of saved(Enrolled) templates

Count

Number of saved(Enrolled) templates

Timeout

Time out value

nMatchTemplate2Index

Index of matched template

Return values of SF_Identify & UFM_Identify

SDK V.2.6

SDK V.3.1

SF_MATCHTIMEOUT

UFM_ERR_MATCH_TIMEOUT

SF_MATCHABORT

UFM_ERR_MATCH_ABORTED

SF_MATCHFAIL, SF_SUCCESS

Removed

PC0004 How to replace BioMini SDK V.2.6 with V.3.1

SF_IdentifyMT
SDK V.2.6

SDK V.3.1

SF_IdentifyMT(Template, Count, Match,

SecurityLevel, bCoreDetect Timeout)

UFS_Extract(g_hScanner, Template, TemplateSize,

&g_nEnrollQuality)
if success
+ UFM_IdentifyMT(g_hMatcher, Template,
TemplateSize, Template2, pnTemplate2Size, Count,
Timeout, & Match)

If the detect core option is not set, default setting is applied. The default setting of the core detec
tion is false.
UFM_IdentifyMT(g_hMatcher, Template, TemplateSize, Template2, pnTemplate2Size, Count,
Timeout, &nMatchTemplate2Index)
g_ hMatcher

Handle of matcher

Template2

Extracted template

TemplateSize2

Size of Extracted template

Template

Array of saved(Enrolled) templates

pnTemplate2Size

Array of size of saved(Enrolled) templates

Count

Number of saved(Enrolled) templates

Timeout

Time out value

nMatchTemplate2Index

Index of matched template

SF_AbortMatching()
SDK V.2.6

SDK V.3.1

SF_AbortMatching()

UFM_AbortIdentify(g_hMatcher)

UFM_AbortIdentify(g_hMatcher)
g_ hMatcher

Handle of matcher

SF_RotateTemplate(unsigned char* Template)

SDK V.2.6

SDK V.3.1

SF_RotateTemplate(Template)

UFM_RotateTemplate(g_hMatcher, Template, SF_TEMPLATESIZE)

PC0004 How to replace BioMini SDK V.2.6 with V.3.1

UFM_RotateTemplate(g_hMatcher, Template, SF_TEMPLATESIZE)

g_ hMatcher

Handle of matcher

Template

Template to rotation

SF_TEMPLATESIZE

Size of template

SF_SetFastMode(int Mode)

SDK V.3.1
if SF_NORMAL_MODE than set value to 0

UFM_SetParameter(g_hMatcher,
UFM_PARAM_FAST_MODE, &value)

if SF_FAST_MODE than set value to 1

UFM_SetParameter(g_hMatcher,
UFM_PARAM_FAST_MODE, &value)

PC0004 How to replace BioMini SDK V.2.6 with V.3.1

10