无线蓝牙指纹采集网络身份认证软件开发SDK 技术手册.docx
《无线蓝牙指纹采集网络身份认证软件开发SDK 技术手册.docx》由会员分享，可在线阅读，更多相关《无线蓝牙指纹采集网络身份认证软件开发SDK 技术手册.docx（24页珍藏版）》请在冰豆网上搜索。
无线蓝牙指纹采集网络身份认证软件开发SDK技术手册
WWW.ONFINGERKEY.COM
RevisionHistory
Version/Date
Description
Author
V0.1/20111017
Firstdraft
V0.2/20111213
1.新增message
2.原来Enroll（）及Identify（）,以AdvancedEnroll.java及Identify.java取代,主原因是原来的UI是dialogclass,新的UI是activityclass,而activityclass的UI控制上较好,而且如果客制化时,可以参考原有的code,而另新增一个客制化activityclass,不需要修改原来的code
3.新API的Enroll（）及Identify（）是无UI
4.修改initial（）成bind（）
5.修改final（）成unbind（）
6.connect（）改成connectDevice（）
7.disconnect改成disconnectDevice（）
8.新增setDeviceAddress（）
9.依修改后的API,调整samplecode
TableofContents
RevisionHistory2
TableofContents3
1特性说明7
1.17
2架构说明8
2.1架构图8
2.2Yu-KeyBTdevice8
2.3Yu-KeyUSBdevice8
2.4Yu-KeyService8
2.5Enroll/IdentifyAPI9
2.6LocalAP9
2.7CloudComputingAP9
2.8ServerAP9
2.9Yu-KeyCloud9
3简易流程说明10
3.1本机指纹注册简易流程（使用Yu-KeyUSBdevice）10
3.2本机指纹识别简易流程（使用Yu-KeyUSBdevice）11
3.3本机指纹注册简易流程（使用Yu-KeyBTdevice）12
3.4本机指纹识别简易流程（使用Yu-KeyBTdevice）13
4YuKeyLib功能说明14
4.1YuKeyLib（Contextcontext,Handlerhandler）14
4.1.1功能说明:
14
4.1.2参数说明:
14
4.1.3回复值:
15
4.2voidbind（）15
4.2.1功能说明:
15
4.2.2参数说明:
15
4.2.3回复值:
15
4.2.4注意事项:
15
4.3voidunbind（）15
4.3.1功能说明:
15
4.3.2参数说明:
15
4.3.3回复值:
15
4.4booleanconnectDevice（）15
4.4.1功能说明:
15
4.4.2参数说明:
15
4.4.3回复值:
15
4.4.4Message回复:
15
4.5booleandisconnectDevice（）16
4.5.1功能说明:
16
4.5.2参数说明:
16
4.5.3回复值:
16
4.5.4Message回复:
16
4.6Identify.java16
4.6.1功能说明:
16
4.6.2使用说明:
16
4.6.3参数说明:
16
4.6.4回复值:
16
4.6.5Message回复:
16
4.6.6注意事项:
17
4.7Identify（）17
4.7.1功能说明:
17
4.7.2参数说明:
17
4.7.3回复值:
17
4.7.4Message回复:
17
4.7.5注意事项:
17
4.8AdvancedEnroll.java17
4.8.1使用说明:
18
4.8.2参数说明:
18
4.8.3Message回复:
18
4.9enroll（Stringuid）18
4.9.1参数说明:
19
4.9.2回复值:
19
4.9.3Message回复:
19
4.9.4注意事项:
19
4.10deleteFeature（Stringuid）19
4.10.1功能说明:
19
4.10.2参数说明:
19
4.10.3回复值:
19
4.10.4Message回复:
19
4.10.5注意事项:
19
4.11abort（）19
4.11.1功能说明:
19
4.11.2参数说明:
20
4.11.3回复值:
20
4.11.4Message回复:
20
4.12setDeviceAddress（Stringaddress）20
4.12.1功能说明:
20
4.12.2参数说明:
20
4.12.3回复值:
20
4.13StringgetDeviceAddress（）20
4.13.1功能说明:
20
4.13.2参数说明:
20
4.13.3回复值:
20
4.14StringgetMatchedUserID（）20
4.14.2参数说明:
20
4.14.3回复值:
20
4.15booleansetDeviceType（intdeviceType）20
4.15.1功能说明:
20
4.15.2参数说明:
21
4.15.3回复值:
21
5使用YuKeyLib22
5.1以YuKeyBTDevice为例22
5.1.1创建YuKeyLib:
22
5.1.2YuKeyLib初始化:
22
5.1.3设定DeviceType:
22
5.1.4设定DeviceAddress:
22
5.1.5连接YuKeyBTDevice22
5.1.6本机指纹注册23
5.1.7本机指纹识别24
5.1.8结束YuKeyLib24
5.2以YuKeyUSBDevice为例24
1
特性说明
•支持Android作业平台
•SDK跨指纹设备兼容，不论是USB或是Bluetooth，一次开发完全兼容
•提供设备端比对与云端比对两种版本，功能可以随时扩充
•SDK已经提供完整指纹注册、比对功能，无需重新开发指纹功能，集成迅速简单
•指纹用户接口的源代码完全开放，可以自行设计用户接口
•高效能指纹比对核心，云端比对达每秒100,000枚指纹以上
•可依需求客制化其他功能
1.1
2
架构说明
2.1架构图
2.2Yu-KeyBTdevice
该device为一个embeddeddevice,本身提供指纹图像撷取,产生注册用及验证用的指纹特征值,而且可以比对指纹及储存注册的指纹特征
该device透过Bluetooth取得Yu-KeyService的指令,并将结果回传给Yu-KeyService
2.3Yu-KeyUSBdevice
该device只提供指纹图像撷取,透过USB接口传送指纹图像给Yu-KeyService,由Yu-KeyService产生注册用及验证用的指纹特征值,且可以比对指纹及储存注册的指纹特征
2.4Yu-KeyService
该Service是一个remoteprocess,由Enroll/IdentifyAPI透过IPC呼叫,主要功能为连接不同指纹device,如果连接为Yu-KeyUSBdevice则会实作产生注册用及验证用的指纹特征值,比对指纹及储存注册的指纹特征等功能
2.5Enroll/IdentifyAPI
该API为一个javaclass,主要提供enroll/identify的functioncall,另与Service沟通的IPC及用户接口皆已封装在对象内,所以开发者可以使用简易functioncall达到完整的注册及验证的功能
而且此class的code是open,所以开发者可以客制化流程及用户接口
2.6LocalAP
由开发者撰写有关需要LocalHost指纹比对的应用程序,直接呼叫enroll/identify的functioncall
2.7CloudComputingLocalAP
由开发者撰写有关Server端指纹比对的Local应用程序,直接呼叫enroll/identify的functioncall取得注册指纹/验证指纹,经由HTTP将数据传送到ServerAP,由ServerAP要求YuCloud作指纹注册/指纹比对
2.8ServerAP
由开发者撰写有关Server端指纹比对的Server应用程序,取得由CloudComputingLocalAP传送的注册指纹/验证指纹,经由HTTP要求Yu-KeyCloud作指纹注册/指纹比对
2.9YuCloud
提供的云端高效能指纹比对Server
3
简易流程说明
3.1本机指纹注册简易流程（使用Yu-KeyUSBdevice）
3.2本机指纹识别简易流程（使用Yu-KeyUSBdevice）
3.3本机指纹注册简易流程（使用Yu-KeyBTdevice）
3.4本机指纹识别简易流程（使用Yu-KeyBTdevice）
4
YuKeyLib功能说明
4.1YuKeyLib（Contextcontext,Handlerhandler）
4.1.1功能说明:
建构方法,呼叫时间点以Activity为例,是在onCreate（）呼叫
4.1.2参数说明:
context:
通常是一个Activity的context
handler:
希望接收YuKeyLib传送的message,此handler需要处理以下的message
YuKeyLib.DEV_STATE_CHANGE
YuKeyLib.DEV_STATE_DISCONNECTED
YuKeyLib.DEV_STATE_CONNECTING
YuKeyLib.DEV_STATE_CONNECTED
YuKeyLib.FP_RESULT
YuKeyLib.FP_RESULT_ENROLL_OK:
YuKeyLib.FP_RES_ENROLL_FAIL:
YuKeyLib.FP_RES_MATCHED_OK:
YuKeyLib.FP_RES_MATCHED_FAIL:
YuKeyLib.FP_RES_DELETE_OK:
YuKeyLib.FP_RES_DELETE_FAIL:
YuKeyLib.FP_RES_ABORT_OK:
YuKeyLib.FP_RES_GETTING_IMAGE:
YuKeyLib.FP_RES_GETTED_IMAGE:
YuKeyLib.FP_RES_EXTRACTING_FEATURE:
YuKeyLib.FP_RES_GETTED_GOOD_IMAGE:
YuKeyLib.FP_RES_GETTED_BAD_IMAGE:
YuKeyLib.FP_RES_ENROLL_COUNT:
YuKeyLib.FP_RES_ABORT_FAIL:
YuKeyLib.FP_RES_GETTED_IMAGE_TOO_SHORT:
YuKeyLib.FP_RES_LOOP_TIMEOUT:
YuKeyLib.FP_RES_ABORT_FAIL:
YuKeyLib.FP_RES_NOT_CONNECTED:
YuKeyLib.FP_RES_GETTED_IMAGE_FAIL
YuKeyLib.FP_RES_GET_FEATURE:
YuKeyLib.FP_RES_FINGER_LIST:
YuKeyLib.SERVICE_STATE:
YuKeyLib.SERVICE_CONNECTED:
YuKeyLib.SERVICE_DISCONNECTED:
4.1.3回复值:
N/A
4.2voidbind（）
4.2.1功能说明:
作初始化,主要是与YuKeyService作IPC连接,呼叫时间点以Activity为例,是在onStart（）呼叫
4.2.2参数说明:
N/A
4.2.3回复值:
N/A
4.2.4注意事项:
须确定收到YuKeyLib.SERVICE_CONNECTED的message后,才能呼叫其他功能
4.3voidunbind（）
4.3.1功能说明:
结束与YuKeyService连接,呼叫时间点以Activity为例,是在onStop（）呼叫
4.3.2参数说明:
N/A
4.3.3回复值:
N/A
4.4booleanconnectDevice（）
4.4.1功能说明:
指纹机连接,如果为Yu-KeyBTdevice则是Bluetooth连接,需要2秒的连接
4.4.2参数说明:
N/A
4.4.3回复值:
True:
开始连接
False:
启动连接的动作失败
4.4.4Message回复:
YuKeyLib.DEV_STATE_CHANGE:
指纹机状态改变
YuKeyLib.DEV_STATE_CONNECTED:
指纹机连接成功
YuKeyLib.DEV_STATE_DISCONNECTED:
指纹机断线
YuKeyLib.DEV_STATE_CONNECTING:
指纹机连接中
4.5booleandisconnectDevice（）
4.5.1功能说明:
强制指纹机断线,如果为Yu-KeyBTdevice则是Bluetooth断线
4.5.2参数说明:
N/A
4.5.3回复值:
True:
开始断线
False:
启动断线的动作失败
4.5.4Message回复:
N/A
4.6Identify.java
4.6.1功能说明:
本地指纹识别/擷取指紋識別特徵,会展现UI,此对象是Activity对象
4.6.2使用说明:
a.此对象需使用startActivityForResult（）方式呼叫,
a.本地指纹识别
Intentintent=newIntent（）;
intent.setClass（getApplicationContext（）,Identify.class）;
startActivityForResult（intent,REQ_IDENTIFY）;
b.远程指纹识别
Intentintent=newIntent（）;
intent.setClass（getApplicationContext（）,dentify.class）;
Bundlebundle=newBundle（）;
bundle.putInt（Identify.BUND_CMD_KEY,Identify.BUND_CMD_CAP_VERIFY_FEA）;
bundle.putString（Identify.BUND_SERVER_IP,mServerIP）;
bundle.putString（AdvancedEnroll.BUND_SERVER_PORT,mServerPort）;
bundle.putString（"UserID",mUserID）;
intent.putExtras（bundle）;
startActivityForResult（intent,REQ_VERIFY）;
b.细节使用请看YuKeyTool.java/YuKeyCloud.java
4.6.3参数说明:
N/A
4.6.4回复值:
N/A
4.6.5Message回复:
YuKeyLib.FP_RESULT:
指纹相关方法的结果
YuKeyLib.FP_RES_MATCHED_OK:
比对成功
YuKeyLib.FP_RES_MATCHED_FAIL:
比对失败
YuKeyLib.ACT_RES_DO_ABORT:
使用者取消操作
YuKeyLib.ACT_RES_DEV_DISCONNECTED:
指纹机断线
EX:
caseREQ_IDENTIFY:
if（resultCode==YuKeyLib.ACT_RES_MATCHED_OK）{
………….
}elseif（resultCode==YuKeyLib.ACT_RES_MATCHED_FAIL）{
……………
}elseif（resultCode==YuKeyLib.ACT_RES_DO_ABORT）{
……………..
}elseif（resultCode==KeyLib.ACT_RES_DEV_DISCONNECTED）
{
……………..
}
4.6.6注意事项:
1.如果识别成功,可从getMatchedUserID（）取得比对成功的UserID及FingerID
4.7Identify（）
4.7.1功能说明:
本地指纹识别,不产生UI
4.7.2参数说明:
N/A
4.7.3回复值:
True:
开始识别
False:
启动识别的动作失败
4.7.4Message回复:
YuKeyLib.FP_RESULT:
指纹相关方法的结果
YuKeyLib.FP_RES_MATCHED_OK:
比对成功
YuKeyLib.FP_RES_MATCHED_FAIL:
比对失败
4.7.5注意事项:
1.此功能可以使用Identify.java的物件达成
2.如果识别成功,可从getMatchedUserID（）取得比对成功的UserID及FingerID
4.8captureVerifyFeature（）
4.8.1功能说明:
截取指纹识别特征,作为远程辨识之用,不产生UI
4.8.2参数说明:
N/A
4.8.3回复值:
True:
开始撷取
False:
撷取的动作失败
4.8.4Message回复:
YuKeyLib.FP_RES_BLOB:
撷取指纹特征成功
4.8.5注意事项:
3.此功能可以使用Identify.java的物件达成
4.9AdvancedEnroll.java
本地指纹注册及删除,会展现UI,此对象是Activity对象
4.9.1使用说明:
a.此对象需使用startActivityForResult（）方式呼叫
a.本地指纹注册
Intentintent=newIntent（）;
intent.setClass（getApplicationContext（）,AdvancedEnroll.class）;
Bundlebundle=newBundle（）;
bundle.putString（"UserID",mUserID）;
bundle.putInt（AdvancedEnroll.BUND_CMD_KEY,AdvancedEnroll.BUND_CMD_LOCAL_ENROLL）;
intent.putExtras（bundle）;
startActivityForResult（intent,REQ_ADVANCED_ENROLL）;
b.撷取注册指纹特征
Intentintent=newIntent（）;
intent.setClass（getApplicationContext（）,AdvancedEnroll.class）;
Bundlebundle=newBundle（）;
bundle.putString（"UserID",mUserID）;
bundle.putInt（AdvancedEnroll.BUND_CMD_KEY,AdvancedEnroll.BUND_CMD_CAP_ENROLL_FEA）;
bundle.putString（AdvancedEnroll.BUND_SERVER_IP,mServerIP）;
bundle.putString（AdvancedEnroll.BUND_SERVER_PORT,mServerPort）;
intent.putExtras（bundle）;
startActivityForResult（intent,REQ_ADVANCED_ENROLL）;
b.细节使用请看YuKeyTool.java/YuKeyCloud.java
4.9.2参数说明:
a.使用putExtras（）方式传送参数
b.UserID:
注册的UserID
Ex:
Bundlebundle=newBundle（）;
bundle.putString（"UserID",mUserID）;
intent.putExtras（bundle）;
c.BUND_CMD_KEY:
BUND_CMD_CAP_ENROLL_FEA:
要求截取注册指纹特征
BUND_CMD_LOCAL_ENROLL:
要求本机注册
d.BUND_SERVER_IP:
YuServerIPaddress
e.BUND_SERVER_PORT:
YuServerPort
4.9.3Message回复:
YuKeyLib.ACT_RES_DO_ABORT:
使用者取消操作
YuKeyLib.ACT_RES_DEV_DISCONNECTED:
指纹机断线
EX:
caseREQ_ADVANCED_ENROLL:
if（（resultCode==YuKeyLib.ACT_RES_DO_ABORT）&&
（mFpDevType==YuKeyLib.YUKEY_DEVICE））
{
mProgressDialog=ProgressDialog.show（YuKeyTool.this,"",
"Pleasewaitforabortprocess...",true）;
}
elseif（resultCode==YuKeyLib.ACT_RES_DEV_DISCONNECTED）{
setConnectStatus（YuKeyLib.DEV_STATE_DISCONNECTED）;
}
……..
4.10enroll（Stringuid）
本地指纹注册,不产生UI
4.10.1参数说明:
uid:
UserID+”_”+FingerID,Ex:
TEST_L1
L1:
左手拇指,L2:
左手食指,L3:
左手中指,L4:
左手无名指,L
升级会员 