public class Fingerprint
extends java.lang.Object
注意:
Note:
1、使用前请确认您的机器已安装此模块。
1. Please make sure this module is installed in your device before using.
2、要正常使用模块需要在\libs\armeabi\目录放置libDeviceAPI.so文件
2. Put libDeviceAPI.so file in directory \libs\armeabi\ then module can be used normally.
3、在操作设备前需要调用 init()
打开设备,使用完后调用 free()
关闭设备
3. Before operating the device, call init()
to switch on the device, then call free()
to switch off the device.
Modifier and Type | Class and Description |
---|---|
static class |
Fingerprint.BufferEnum
模块缓冲区枚举
Module buffer zone example. |
Modifier and Type | Method and Description |
---|---|
int |
autoEnroll(int count,
int userID)
刷指定次数指纹,模块自动完成注册功能
Scan fingerprint in specified number, module complete registered function automatically |
int[] |
autoMatch(int count,
int startPage,
int pageNum)
刷指定次数指纹,自动完成比对功能
Scan fingerprint in specified number, complete comparison function automatically |
boolean |
deletChar(int pageID,
int num)
删除库中特征值
delete feature value in database. |
boolean |
downChar(Fingerprint.BufferEnum buffer,
java.lang.String hexStr)
下载特征数据到指定缓存区
download feature data to specified buffer zone |
boolean |
empty()
清空模块中保存的指纹数据
empty out saved fingerprint data in module. |
boolean |
free()
释放指纹模块
Release fingerprint module. |
boolean |
genChar(Fingerprint.BufferEnum buffer)
生成特征值(存于指定缓存区)
Generate feature value( save in specified buffer zone) |
boolean |
getImage()
获取指纹图像(存于模块图像缓存区)
Acquire fingerprint image( save in buffer zone of module image) |
static Fingerprint |
getInstance()
获取指纹模块操作实例
Acquire fingerprint module operation Instance. |
java.lang.String |
getRandomData()
获取随机数,检测模块是否正常
Acquire random number, detect module is normal or not. |
java.lang.String |
getVersion()
获取模块版本
Acquire module version |
boolean |
init()
初始化指纹模块,默认波特率为57600
Initialize fingerprint module, default baud rate is 57600. |
boolean |
init(int baudrate)
初始化指纹模块
Initialize fingerprint module. |
boolean |
isPowerOn()
判断设备是否上电
Judge the device is powered on or not. |
boolean |
loadChar(Fingerprint.BufferEnum buffer,
int pageID)
加载指定ID页到特征值缓存区
Load specified ID page to feature value buffer zone |
int |
match()
对比模板缓冲区1与模板缓冲区2的指纹模板文件
fingerprint template file of comparison template buffer zone 1 and template buffer zone 2. |
java.lang.String |
readChipSN()
获取芯片序列号
acquire chip serial number |
java.lang.String |
readSysPara()
获取系统参数,仅返回版本号
Acquire system parameter, return version number only |
java.lang.String[] |
readSysParaMore()
获取系统参数
Acquire system parameter |
boolean |
regModel()
合并特征文件。将模板缓冲区1与模板缓冲区2中的模板文件合并生成模板,结果存于模板缓冲区1。
Combine feature file. |
int[] |
search(Fingerprint.BufferEnum buffer,
int startPage,
int pageNum)
检索指纹库
Searching fingerprint database |
boolean |
setDeviceName(java.lang.String name)
设置设备名称
Setup device name |
boolean |
setManuFacture(java.lang.String name)
设置厂商名称
Setup manufacture name |
boolean |
setPWD(java.lang.String passWord)
设置密码
Setup password |
boolean |
setReg(int regID,
int value)
设置寄存器值,修改模块参数
Setup the value in RAM, modify the parameter in module. |
boolean |
storChar(Fingerprint.BufferEnum buffer,
int pageID)
存储模板文件。将模板缓冲区buffer中的模板文件存到 PageID号所对应的指纹库位置
save templatefile. |
java.lang.String |
upChar(Fingerprint.BufferEnum buffer)
上传指定缓冲区中的指纹特征数据
Upload fingerprint feature data of specified buffer zone |
int |
upImage(int mode,
java.lang.String fileName)
上传指纹图像文件
Upload finerprint image file |
boolean |
validPWD(java.lang.String passWord)
验证密码
Verify password |
int |
validTempleteNum()
获取模块中已保存的指纹特征数据个数
Acquire number of saved fingerprint feature data in module |
public static Fingerprint getInstance() throws ConfigurationException
ConfigurationException
- 配置错误异常public boolean init()
public boolean init(int baudrate)
baudrate
- 波特率(57600或115200)public boolean free()
public java.lang.String getRandomData()
public boolean getImage()
public boolean genChar(Fingerprint.BufferEnum buffer)
buffer
- 缓冲区编号枚举
Buffer zone code examplepublic int[] search(Fingerprint.BufferEnum buffer, int startPage, int pageNum)
buffer
- 缓存区startPage
- 页开始IDpageNum
- 从startPage开始的num个public int match()
public boolean regModel()
public boolean storChar(Fingerprint.BufferEnum buffer, int pageID)
buffer
- 缓冲区pageID
- 页ID,值为0~254public boolean loadChar(Fingerprint.BufferEnum buffer, int pageID)
buffer
- 缓存区pageID
- 页IDpublic java.lang.String upChar(Fingerprint.BufferEnum buffer)
buffer
- 缓存区public boolean downChar(Fingerprint.BufferEnum buffer, java.lang.String hexStr)
buffer
- 缓存区hexStr
- 十六进制特征数据public boolean deletChar(int pageID, int num)
pageID
- 页IDnum
- 从PageID开始的num个public boolean empty()
public boolean setReg(int regID, int value)
regID
- 寄存器IDvalue
- 需要修改的值public int autoEnroll(int count, int userID)
count
- 次数userID
- 注册IDpublic int[] autoMatch(int count, int startPage, int pageNum)
count
- 次数startPage
- 起始页pageNum
- 页数public int validTempleteNum()
public java.lang.String readChipSN()
public boolean setManuFacture(java.lang.String name)
name
- 名称,缓存 8字节public boolean setDeviceName(java.lang.String name)
name
- 设备名称,缓存 8字节public java.lang.String readSysPara()
public java.lang.String getVersion()
public int upImage(int mode, java.lang.String fileName)
mode
- 是否带bmp格式头文件 0表示不带 大于0表示带。默认为1fileName
- 文件路径,包括文件名,函数根据该参数生成图像文件public boolean setPWD(java.lang.String passWord)
passWord
- 密码public boolean validPWD(java.lang.String passWord)
passWord
- 密码public java.lang.String[] readSysParaMore()
public boolean isPowerOn()