Skip navigation links
com.rscja.deviceapi

Class Fingerprint

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class and Description
      static class  Fingerprint.BufferEnum
      模块缓冲区枚举
      Buffer number
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int autoEnroll(int count, int userID)
      刷指定次数指纹,模块自动完成注册功能
      Auto enroll register once place designated count of fingerprint.
      int[] autoMatch(int count, int startPage, int pageNum)
      刷指定次数指纹,自动完成比对功能
      Auto match once place designated count of fingerprint
      boolean deletChar(int pageID, int num)
      删除库中特征值
      Delete character value
      boolean downChar(Fingerprint.BufferEnum buffer, java.lang.String hexStr)
      下载特征数据到指定缓存区
      Download character data to designated buffer.
      boolean empty()
      清空模块中保存的指纹数据
      Clean fingerprint data stored in module.
      boolean free()
      释放指纹模块
      Relase fignerprint module
      boolean genChar(Fingerprint.BufferEnum buffer)
      生成特征值(存于指定缓存区)
      Generate character,store in designated buffer.
      boolean getImage()
      获取指纹图像(存于模块图像缓存区)
      Get fingerprint image,stored in image buffer of module
      static Fingerprint getInstance()
      获取指纹模块操作实例
      Get fingerprint module entity
      java.lang.String getRandomData()
      获取随机数,检测模块是否正常
      Get random,to detect module is normal or not
      java.lang.String getVersion()
      获取模块版本
      Get module version
      boolean init()
      初始化指纹模块,默认波特率为57600
      Initialize fingerprint moudule, default baudrate 57600
      boolean init(int baudrate)
      初始化指纹模块
      Initialize fingerprint module
      boolean initMorpho()
      初始化指纹模块,仅用于Morpho模块
      Initialize the fingerprint module,valid only for Morpho module.
      boolean isPowerOn()
      判断设备是否上电
      Detect whether device is powered on or not.
      boolean loadChar(Fingerprint.BufferEnum buffer, int pageID)
      加载指定ID页到特征值缓存区
      Load designated ID page to charcater buffer.
      int match()
      对比模板缓冲区1与模板缓冲区2的指纹模板文件
      Match the fingerprint template between buffer 1 and buffer 2.
      boolean morphoEnroll(int id, java.lang.String firstName, java.lang.String lastName)
      采集指纹,仅用于Morpho模块
      Fingerprint enrollment, valid for morpho module.
      java.lang.String[] morphoIdentify()
      验证指纹,仅用于Morpho模块
      Identify fingerprint , valid only for Morpho module
      java.lang.String readChipSN()
      获取芯片序列号
      Get chip SN.
      java.lang.String readSysPara()
      获取系统参数,仅返回版本号
      Get device parameter.
      java.lang.String[] readSysParaMore()
      获取系统参数
      Get system parameter.
      boolean regModel()
      合并特征文件。将模板缓冲区1与模板缓冲区2中的模板文件合并生成模板,结果存于模板缓冲区1。
      Merge character file, use the template file from buffer 1 and buffer 2, store result in buffer 1.
      int[] search(Fingerprint.BufferEnum buffer, int startPage, int pageNum)
      检索指纹库
      search fingerprint database
      boolean setDeviceName(java.lang.String name)
      设置设备名称
      Set device name
      boolean setManuFacture(java.lang.String name)
      设置厂商名称
      Set manufacture name
      boolean setPWD(java.lang.String passWord)
      设置密码
      Set password
      boolean setReg(int regID, int value)
      设置寄存器值,修改模块参数
      Set register value, modify module parameter.
      boolean storChar(Fingerprint.BufferEnum buffer, int pageID)
      存储模板文件。将模板缓冲区buffer中的模板文件存到 PageID号所对应的指纹库位置
      Store the template file, store the template file in buffer to the fingerprint database whichPageID pointing to.
      java.lang.String upChar(Fingerprint.BufferEnum buffer)
      上传指定缓冲区中的指纹特征数据
      Upload fignerprint character data from designated buffer.
      int upImage(int mode, java.lang.String fileName)
      上传指纹图像文件
      Upload fingerprint image file
      boolean validPWD(java.lang.String passWord)
      验证密码
      Verify password
      int validTempleteNum()
      获取模块中已保存的指纹特征数据个数
      Get the number of fingerprint character data stored in the module
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getInstance

        public static Fingerprint getInstance()
                                       throws ConfigurationException
        获取指纹模块操作实例
        Get fingerprint module entity
        Returns:
        指纹模块操作实例
        Return fingerprint module entity
        Throws:
        ConfigurationException - 配置错误异常
        Configuration failure exception
      • init

        public boolean init()
        初始化指纹模块,默认波特率为57600
        Initialize fingerprint moudule, default baudrate 57600
        Returns:
        true成功,false失败
        If sucess, return true, if failure, return false.
      • init

        public boolean init(int baudrate)
        初始化指纹模块
        Initialize fingerprint module
        Parameters:
        baudrate - 波特率(57600或115200)
        Baudrate(57600 or 115200)
        Returns:
        true成功,false失败
        If sucess, return true, if failure, return false.
      • free

        public boolean free()
        释放指纹模块
        Relase fignerprint module
        Returns:
        true成功,false失败
        If success, return true, if failure, return false.
      • getRandomData

        public java.lang.String getRandomData()
        获取随机数,检测模块是否正常
        Get random,to detect module is normal or not
        Returns:
        十六进制格式随机数内容,null为失败
        Return hex format random data, if failure, return null
      • getImage

        public boolean getImage()
        获取指纹图像(存于模块图像缓存区)
        Get fingerprint image,stored in image buffer of module
        Returns:
        true成功,false失败
        If sucess, return true, if failure, return false.
      • genChar

        public boolean genChar(Fingerprint.BufferEnum buffer)
        生成特征值(存于指定缓存区)
        Generate character,store in designated buffer.
        Parameters:
        buffer - 缓冲区编号枚举
        buffer number
        Returns:
        true成功,false失败
        If sucess, return true, if failure, return false.
      • search

        public int[] search(Fingerprint.BufferEnum buffer,
                            int startPage,
                            int pageNum)
        检索指纹库
        search fingerprint database
        Parameters:
        buffer - 缓存区
        Buffer
        startPage - 页开始ID
        Start page ID.
        pageNum - 从startPage开始的num个
        Start page number
        Returns:
        第0个元素为页ID,第1个元素为对比得分,失败返回null
        Return page ID for 0, return match value for 1, return null if failure.
      • match

        public int match()
        对比模板缓冲区1与模板缓冲区2的指纹模板文件
        Match the fingerprint template between buffer 1 and buffer 2.
        Returns:
        对比得分,对比失败则返回-1
        Match result, if failure, return -1
      • regModel

        public boolean regModel()
        合并特征文件。将模板缓冲区1与模板缓冲区2中的模板文件合并生成模板,结果存于模板缓冲区1。
        Merge character file, use the template file from buffer 1 and buffer 2, store result in buffer 1.
        Returns:
        true成功,false失败
        If sucess,return true, if failure,return false.
      • storChar

        public boolean storChar(Fingerprint.BufferEnum buffer,
                                int pageID)
        存储模板文件。将模板缓冲区buffer中的模板文件存到 PageID号所对应的指纹库位置
        Store the template file, store the template file in buffer to the fingerprint database whichPageID pointing to.
        Parameters:
        buffer - 缓冲区
        Buffer
        pageID - 页ID,值为0~254
        Page ID, value 0-254
        Returns:
        true成功,false失败
        If sucess, return true, if failure, return false
      • loadChar

        public boolean loadChar(Fingerprint.BufferEnum buffer,
                                int pageID)
        加载指定ID页到特征值缓存区
        Load designated ID page to charcater buffer.
        Parameters:
        buffer - 缓存区
        Buffer
        pageID - 页ID
        Page ID
        Returns:
        true成功,false失败
        If sucess, return true, if failure, return false.
      • upChar

        public java.lang.String upChar(Fingerprint.BufferEnum buffer)
        上传指定缓冲区中的指纹特征数据
        Upload fignerprint character data from designated buffer.
        Parameters:
        buffer - 缓存区
        Buffer
        Returns:
        十六进制格式特征值数据,null为失败
        Return character data, hex data format, if failure, return null.
      • downChar

        public boolean downChar(Fingerprint.BufferEnum buffer,
                                java.lang.String hexStr)
        下载特征数据到指定缓存区
        Download character data to designated buffer.
        Parameters:
        buffer - 缓存区
        Buffer
        hexStr - 十六进制特征数据
        Character data in hex format
        Returns:
        true成功,false失败
        If sucess,return true, if failure, return false.
      • deletChar

        public boolean deletChar(int pageID,
                                 int num)
        删除库中特征值
        Delete character value
        Parameters:
        pageID - 页ID
        Page ID
        num - 从PageID开始的num个
        number start from page ID
        Returns:
        true成功,false失败
        If sucess, return true, if failure, return false.
      • empty

        public boolean empty()
        清空模块中保存的指纹数据
        Clean fingerprint data stored in module.
        Returns:
        true成功,false失败
        If sucess, return true, if failure, return false.
      • setReg

        public boolean setReg(int regID,
                              int value)
        设置寄存器值,修改模块参数
        Set register value, modify module parameter.
        Parameters:
        regID - 寄存器ID
        Register ID
        value - 需要修改的值
        Value need to be modified
        Returns:
        true成功,false失败
        If sucess, return true, if failure, return false.
      • autoEnroll

        public int autoEnroll(int count,
                              int userID)
        刷指定次数指纹,模块自动完成注册功能
        Auto enroll register once place designated count of fingerprint.
        Parameters:
        count - 次数
        Count
        userID - 注册ID
        Register user ID.
        Returns:
        注册成功返回的ID,失败返回-1
        Return ID , if failure, return -1.
      • autoMatch

        public int[] autoMatch(int count,
                               int startPage,
                               int pageNum)
        刷指定次数指纹,自动完成比对功能
        Auto match once place designated count of fingerprint
        Parameters:
        count - 次数
        Count
        startPage - 起始页
        Start page
        pageNum - 页数
        Page number
        Returns:
        第1个元素为匹配成功的ID,第2个元素为比对得分,null为失败
        Return ,first array is the ID which matched sucessfully, second array is the match result, return null if failure.
      • validTempleteNum

        public int validTempleteNum()
        获取模块中已保存的指纹特征数据个数
        Get the number of fingerprint character data stored in the module
        Returns:
        成功返回指纹特征数据个数,失败返回-1
        Return the number,return -1 if failure.
      • readChipSN

        public java.lang.String readChipSN()
        获取芯片序列号
        Get chip SN.
        Returns:
        十六进制格式芯片序列号,null为失败
        Return chip sn, hex data format, return null if failure.
      • setManuFacture

        public boolean setManuFacture(java.lang.String name)
        设置厂商名称
        Set manufacture name
        Parameters:
        name - 名称,缓存 8字节
        name, buffer 8 bytes
        Returns:
        true成功,false失败
        If sucess, return true, if failure, return false.
      • setDeviceName

        public boolean setDeviceName(java.lang.String name)
        设置设备名称
        Set device name
        Parameters:
        name - 设备名称,缓存 8字节
        Device name, buffer 8 bytes.
        Returns:
        true成功,false失败
        If sucess, return true, if failure, return false.
      • readSysPara

        public java.lang.String readSysPara()
        获取系统参数,仅返回版本号
        Get device parameter. only return version name.
        Returns:
        十六进制格式参数数据,null为失败
        Return device parameter in hex data, return null if failure.
      • getVersion

        public java.lang.String getVersion()
        获取模块版本
        Get module version
        Returns:
        null为失败
        Return null if failure
      • upImage

        public int upImage(int mode,
                           java.lang.String fileName)
        上传指纹图像文件
        Upload fingerprint image file
        Parameters:
        mode - 是否带bmp格式头文件 0表示不带 大于0表示带。默认为1
        Mode,with our without bmp title file,0 for without, >0 for with, 1 by default.
        fileName - 文件路径,包括文件名,函数根据该参数生成图像文件
        File path, including file name, based on this parameter to generate image file
        Returns:
        成功返回图片文件大小,失败返回-1
      • initMorpho

        public boolean initMorpho()
        初始化指纹模块,仅用于Morpho模块
        Initialize the fingerprint module,valid only for Morpho module.
        Returns:
        true成功,false失败
        If sucess,return true,if failure, return false.
      • morphoEnroll

        public boolean morphoEnroll(int id,
                                    java.lang.String firstName,
                                    java.lang.String lastName)
                             throws FingerprintAlreadyEnrolledException,
                                    FingerprintInvalidIDException
        采集指纹,仅用于Morpho模块
        Fingerprint enrollment, valid for morpho module.
        Parameters:
        id - 存储id
        firstName - 名
        lastName - 姓
        Returns:
        true为成功,false为失败 If sucess, return true, if failure, return false.
        Throws:
        FingerprintAlreadyEnrolledException - 抛出此异常说明指纹已经存在
        Fingerprint already enrolled exception
        FingerprintInvalidIDException - 抛出此异常说明ID已被占用
        Fingerprint invalid ID exception.
      • morphoIdentify

        public java.lang.String[] morphoIdentify()
        验证指纹,仅用于Morpho模块
        Identify fingerprint , valid only for Morpho module
        Returns:
        null表示验证失败,成功则返回数据:[0]=id,[1]=firstName,[2]=lastName
        If failure, return null, if sucess, return data : [0]=id,[1]=firstName,[2]=lastName
      • setPWD

        public boolean setPWD(java.lang.String passWord)
        设置密码
        Set password
        Parameters:
        passWord - 密码
        Returns:
        true成功,false失败
        If sucess, return true, if failure, return false.
      • validPWD

        public boolean validPWD(java.lang.String passWord)
        验证密码
        Verify password
        Parameters:
        passWord - 密码
        Password
        Returns:
        true成功,false失败
        If sucess, return true, if false, return failure.
      • readSysParaMore

        public java.lang.String[] readSysParaMore()
        获取系统参数
        Get system parameter.
        Returns:
        [0]安全级别 [1]分包大小 [2]波特率 [3]产品序列号 [4]版本号 [5]厂商代码 [6]传感器名称 ,null为失败
        return data,[0] Security Level [1] Packet Size [2]Baudrate [3]Serial number [4]version [5]Manuafature name [6]sensor name, return null if failure.
      • isPowerOn

        public boolean isPowerOn()
        判断设备是否上电
        Detect whether device is powered on or not.
        Returns:
        已经上电返回true,反之返回false
        If powered on,return true, if not, return false.