Armatura SDK Guide-PalmLite-Windows-202206 PDF
Armatura SDK Guide-PalmLite-Windows-202206 PDF
Armatura SDK Guide-PalmLite-Windows-202206 PDF
June 2022
Thank you for choosing our product. Please read the instructions
carefully before operation. Follow these instructions to ensure that the
product is functioning properly. The images shown in this manual are for
illustrative purposes only.
Trademark
Disclaimer
This manual contains information on the operation and maintenance of the ARMATURA product.
The copyright in all the documents, drawings, etc. in relation to the ARMATURA supplied product
vests in and is the property of ARMATURA. The contents hereof should not be used or shared by
the receiver with any third party without express written permission of ARMATURA.
The contents of this manual must be read as a whole before starting the operation and maintenance
of the supplied product. If any of the content(s) of the manual seems unclear or incomplete, please
contact ARMATURA before starting the operation and maintenance of the said product.
It is an essential pre-requisite for the satisfactory operation and maintenance that the operating and
maintenance personnel are fully familiar with the design and that the said personnel have received
thorough training in operating and maintaining the machine/unit/product. It is further essential for the
safe operation of the machine/unit/product that personnel have read, understood, and followed the
safety instructions contained in the manual.
In case of any conflict between terms and conditions of this manual and the contract specifications,
drawings, instruction sheets or any other contract-related documents, the contract
conditions/documents shall prevail. The contract specific conditions/documents shall apply in priority.
ARMATURA does not assume responsibility for any errors or omissions in the information or
documents which are referenced by or linked to this manual. The entire risk as to the results and
performance obtained from using the information is assumed by the user.
ARMATURA in no event shall be liable to the user or any third party for any incidental,
consequential, indirect, special, or exemplary damages, including, without limitation, loss of
business, loss of profits, business interruption, loss of business information or any pecuniary loss,
arising out of, in connection with, or relating to the use of the information contained in or referenced
by this manual, even if ARMATURA has been advised of the possibility of such damages.
This manual and the information contained therein may include technical, other inaccuracies, or
typographical errors. ARMATURA periodically changes the information herein which will be
incorporated into new additions/amendments to the manual. ARMATURA reserves the right to add,
delete, amend, or modify the information contained in the manual from time to time in the form of
circulars, letters, notes, etc. for better operation and safety of the machine/unit/product. The said
additions or amendments are meant for improvement /better operations of the machine/unit/product
and such amendments shall not give any right to claim any compensation or damages under any
circumstances.
ARMATURA shall in no way be responsible (i) in case the machine/unit/product malfunctions due to
any non-compliance of the instructions contained in this manual (ii) in case of operation of the
machine/unit/product beyond the rate limits (iii) in case of operation of the machine and product in
conditions different from the prescribed conditions of the manual.
The product will be updated from time to time without prior notice. The latest operation procedures
and relevant documents are available on http://www.armatura.com.
ARMATURA Headquarters
Address 190 Bluegrass Valley Pkwy,
Alpharetta, GA 30005, USA.
ARMATURA biometric hardware and software are incorporated into the product designs of some of
the world’s leading suppliers of workforce management (WFM) terminals, Point-of-Sale (PoS)
terminals, intercoms, electronic safes, metal key lockers, dangerous machinery, and many other
products which heavily rely on correctly verifying & authenticating user’s identity.
All figures displayed are for illustration purposes only. Figures in this manual may not be exactly
consistent with the actual products.
Document Conventions
Conventions used in this manual are listed below:
GUI Conventions
For Software
Convention Description
Bold font Used to identify software interface names e.g. OK, Confirm, Cancel.
Multi-level menus are separated by these brackets. For example, File >
>
Create > Folder.
For Device
Convention Description
<> Button or key names for devices. For example, press <OK>.
Window names, menu items, data table, and field names are inside square
[]
brackets. For example, pop up the [New User] window.
Symbols
Convention Description
Table of Contents
1 OVERVIEW ........................................................................... ERROR! BOOKMARK NOT DEFINED.
APPENDIX ...........................................................................................................................................56
1 Introduction
This document will provide with basic SDK development guide and technical background to
help with better use of AMTPalmLite SDK document. From the perspective of a developer, the
key design objective of this SDK is its compatibility and ease of execution.
This development manual contains the product development documentation for developers that
describes the functions provided by the SDK and its related usage, which eases the
development environment.
The following sections explain all the required information on how to perform and integrate
AMTPalmLite SDK.
The palm has a complex vascular pattern that is unique to every person. Since the vein
patterns lie under the skin, they are almost impossible to replicate/spoof and allow for highly
secure authentication with false Near-infrared (NIR) light palm recognition employs a particular
image capture technology in which the mounted NIR LED light illuminates the palm, the camera
captures the infrared light instead of visible light reflected from the illuminated palm and forms
grayscale level images.
NIR light can penetrate the palm skin, the palm surface and the subcutaneous tissue have
different levels of infrared light absorption, thus the IR camera captures the pattern
characteristics from both palm surface print and subcutaneous vessels (or palm veins). Such
biometric patterns are unique and stable to the individuals, not changing with age.
NIR light has different wavelengths from visible light, it allows the camera less impacted by the
visible light, therefore the technology can be applied to a vast variety of lighting conditions,
especially in very poor-lighted environments.
Recently, significant progress has been made on palm recognition algorithms and imaging
sensors, and the palm recognition technology provides advanced features such as touchless
authentication, recognition from wide range distance, high pose tolerance and less privacy
concern comparing to face recognition technology, the palm recognition-based applications
have been widely explored and deployed, especially in access control and security industries.
AMT Palm SDK is a wrapper of Armatura near-Infrared light palm recognition algorithm. It is an
excellent 3-in-1 combination of Palm, Palm print and Palm Vein near infrared palm recognition
algorithm developed for resist complex ambient light, high tolerance of gesture and large
capacity recognition. The algorithm focuses on improving the wide adaptation to the user
environment and user habits, thereby greatly improving the robustness and pass rate of palm
recognition.
The SDK provides the rich interfaces to access the algorithm’s functionalities for palm
recognition process, including palm detection, feature extraction, liveness detection, template
creation and palm identification.
The PalmLite SDK utilizes the widely supported libusb API for palm module communication,
supports common-used Windows, Android and Linux operation systems, frees the developers
from intimidating hardware operations. It is a developer-friendly toolkit to empower the biometric
features on the software application with easy pickup.
The simple library components aid in supporting and enhancing the security requirements
through biometric palm recognition which avoids spoofing and has been widely used in various
systems, including attendance, security, video monitoring and so on.
Compared to visible light imaging approach, the infrared light imaging approach is more
robust under various lighting condition, it makes the PalmLite algorithm well adapted to
perform palm recognition on the images captured from a broader range of deployment
environments.
or in wide yaw, pitch or roll angles. The algorithm is highly adaptable to the way the palm
device is installed and allows user to scan the palm in a natural and comfort posture in
enrollment or identification scenarios.
During the process to register the palm template, the PalmLite algorithm takes the averaging
approach on multiple templates (5 templates consecutively) to build a stable and robust
representation of the candidate palm.
The combination of above processes ensures the algorithm to achieve highly accurate and
robust recognition performance.
▪ Liveness Detection:
The pattern from live subcutaneous tissues is invisible to human eyes and non-duplicatable,
naturally it provides anti-spoofing security, the combination of NIR camera and PalmLite
algorithm makes the palm recognition super secure.
▪ Algorithm Integrity:
Combined with Armatura near-infrared light palm module, the PalmLite algorithm ensures
the quality of images along with data integrity for genuine and accurate image recognition
process.
2 Technical Specifications
Development Language
This SDK provides a standard Win32 API interface and supports C, C++, and C# language
development.
Platform Requirements
The SDK must be used on 32-bit/64-bit operating system with Windows XP SP3 or higher.
Technical Parameters
Parameter Description
Image resolution 480 x 640
Template size 8848 bytes
Gesture adaptability Yaw ≤20, Pitch ≤20, Roll ≤90,Bend ≤ 15
Palm detection < 50 ms
Palm feature extraction < 80 ms
Palm Verification/Identification (1:6000) < 150 ms
Palm Storage Capacity 6000
Accuracy TAR = 98.2% when FAR = 0.05%
The preceding algorithm capability indicators are all measured based on the actual image data
set (resolution of 480 x 640), 8GB memory and quad-core Inter(R) Core(TM) i5-3210M CPU
@2.5GHz processor.
Before installing AMTPalmLite SDK, please make sure that your operating system, computer
configuration or Windows mobile terminal device meets the requirements for software operation.
The AMTPalmLite SDK provides two sets of APIs to meet different requirements of developers.
• When you use the device library (AMTPalmCap.dll) and algorithm library
(AMTIRPalmService.dll), you need to control the registration process and palm detection
process manually.
• If you use AMTPalmApi, the SDK integration will be simpler and faster, because
AMTPalmApi encapsulates the AMTPalmCap and AMTIRPalmService interfaces to
implement the registration process and palm detection process automatically.
This section describes the key processes of palm recognition to help developers understand the
palm registration and detection processes implemented by AMTPalmApi library.
The palm device supports infrared imaging, and the application calls the image capturing
function to acquire palm images. When a palm approaches the device, the device turns on the
near-infrared LED light, captures palm images, and returns the images. If palm images cannot
be captured, the device returns a failure message. After capturing the palm images, the
application calls the algorithm library to extract a template. If the template is extracted
successfully, the application notifies the device. If the device does not receive the notification
within the timeout period (5s by default), it turns off the near-infrared LED light.
Note: Skip this process if you are using AMTPalmApi library for SDK integration.
Process Description
• After the palm device is successfully opened, the device API SDK (AMTPalmCap.dll)
starts to capture palm images continuously.
• The device API SDK (AMTPalmCap.dll) notifies the application to acquire the image
status through the AMT_Palmsensor_Capture function.
• After the AMT_Palmsensor_Capture returns the acquisition, the algorithm API SDK
(AMTIRPalmService.dll) is called to extract the template data.
In the palm registration process, the palm device must collect five pre-registered templates and
merge them into a registered template. For details about different types of templates, see the
interface description.
Process Description
• After the palm device is successfully opened, the device API SDK (AMTPalmCap.dll)
starts to capture palm images continuously.
• The application layer obtains the acquired image status by calling the device API SDK
(AMTPalmCap.dll) AMT_Palmsensor_Capture.
• If less than five templates have been captured, the application continues to capture the
next template.
• After collecting five palm templates, the application merges the templates. If the
registration fails, the application returns a message and ends the registration process.
• After the registration is successful, call AMTPalmServiceDBAdd of the algorithm API SDK
(AMTIRPalmService.dll) to add the registration template to the library and save the
registration template to the database.
To implement 1:N palm identification, it is required to add all the registered templates to the
database. It is recommended to call the AMTPalmServiceDBAdd function to add all registered
templates to the database after successful algorithm initialization.
Process Description
• After the palm device is successfully opened, the device API SDK (AMTPalmCap.dll)
starts to capture palm images continuously.
• The application layer obtains the acquired image status by calling the device API SDK
(AMTPalmCap.dll) AMT_Palmsensor_Capture.
• And once the registered template is identified, the application ends the registration
process.
Verification/Identification
27120 bytes Only used for palm verification/identification
template
3.2.1 AMTPalmApi.dll
The AMTPalmApi.dll dynamic library simplifies the calling process of the palm collection library
AMTPalmCap.dll and the palm algorithm library AMTIRPalmService.dll interface, helping
customers integrate SDK more easily and quickly
Function List
Interface Description
AMTPalm_GetVersion
Function Syntax
Description
Parameters
Parameter Description
Out: Returns the version number (recommended to pre-allocate
version
64 bytes, sufficient to use)
size In: Memory size allocated by version (number of bytes).
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalm_Init
Function Syntax
Description
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalm_Terminate
Function Syntax
Description
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalm_OpenDevice
Function Syntax
Description
Parameter
Parameter Description
index In: Device index 0~(n-1), n=AMTPalm_GetDeviceCount
handle Out: Device operation instance handle
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalm_GetDeviceCount
Function Syntax
Description
Parameter
Parameter Description
devcnt Out: Returns the number of devices
Returns
0 Success
Other Failure Error Code
AMTPalm_CloseDevice
Function Syntax
Description
Parameter
Parameter Description
handle In: Device operation instance handle
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalm_SetParameter
Function Syntax
Description
Parameter
Parameter Description
handle In: Device operation instance handle
paramCode In: Parameter code (see Parameter Code Description)
paramValue In: Parameter value
size In: Parameter value length
Returns
0 Success
Other Failure Error Code
Remarks
When setting the status of the external light, please refer to Parameter Code Description.
AMTPalm_GetParameter
Function Syntax
Description
Parameter
Parameter Description
handle In: Device operation instance handle
paramCode In: Parameter code (see Parameter Code Description)
paramValue In: Parameter value
In: Parameter value pre-allocated buffer size
size
Out: Actual parameter value occupied size
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalm_CapturePalmImageAndTemplate
Function Syntax
Description
Collects the palm images and extracts the pre-registered template data and
verification/identification template data.
Parameter
Parameter Description
In: Return palm image data (the original image data with a
imgBuffer
grayscale image bit depth of 8 bits)
In: imgBuffer allocated memory size (recommended pre-allocation
cbImgBuffer
480*640)
In:
1 Represents the extraction of pre-registered features,
verification/identification features, mainly used in the
extractType
registration process
2 Represents the extraction of verification/identification
features, used in the verification/identification process
Returns
0 Success
Remarks
AMTPalm_Verify
Function Syntax
Description
Parameter
Parameter Description
handle In: Device operation instance handle
regTemplate In:Registration template data (see AMTPalm_MergeTemplates)
cbRegTemplate In: Registration template data length
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalm_VerifyByID
Function Syntax
Description
Parameter
Parameter Description
handle In: Device operation instance handle
In: Verification templates (see
verTemplate
AMTPalm_CapturePalmImageAndTemplate)
cbVerTemplate In: Verification template data length
id In: Specified ID
In: Returns the corresponding verification score (more than 576
score
can be considered successful)
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalm_MergeTemplates
Function Syntax
Description
Combines five pieces of palm pre-registered template data into one registered palm template.
Parameter
Parameter Description
handle In: Device operation instance handle
In: Palm pre-registration template data (multiple templates, it is
rawTemplates recommended to pass 5 pre-registration templates, only support
up to 5)
In: Number of pre-registered template data (It is recommended to
mergedCount
pass 5 preregistered templates, and only support up to 5)
pMergeTemplate Out: Palm registration template data after successful merge
In: pMergeTemplate memory allocation size (It is recommended to
cbMergeTemplate pre-allocate 8848 bytes, which cannot be less than 8848 bytes)
Out: Returns the actual pMergeTemplate data length
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalm_DBAdd
Function Syntax
Description
Parameter
Parameter Description
handle In: Device operation instance handle
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalm_DBDel
Function Syntax
Description
Deletes the registration template with the specified id from the database.
Parameter
Parameter Description
handle In: Device operation instance handle
id In: Palm id
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalm_DBCount
Function Syntax
Description
Parameter
Parameter Description
handle In: Device operation instance handle
count Out: The total number of templates returned to the library
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalm_DBClear
Function Syntax
Description
Parameter
Parameter Description
handle In: Device operation instance handle
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalm_DBIdentify
Function Syntax
Description
Parameter
Parameter Description
handle In: Device operation instance handle
In: Identification templates (see
verTemplate
AMTPalm_CapturePalmImageAndTemplate)
cbVerTemplate In: Template data length
Out: Returns the palm ID of the successful recognition (at least 24
id bytes are
allocated)
score Out: Return score
In: Minimum matching score (identification passing threshold,
minScore
recommended to set to 576)
maxScore In: The highest number of matches (just pass 1000 directly)
Returns
0 Success
Other Failure Error Code
Remarks
If you choose to use the device or algorithm more flexibly, you can use the following device or
algorithm interfaces or just call ARMATURA's device SDK or algorithm SDK. For details about
the palm detection process and registration process, see sections 4.6.1 and 4.6.2.
4.1.1 AMTPalmCap.dll
AMTPalmCap.dll dynamic library is the base library for palm collection. Mainly used for palm
image data collection and some device parameter setting and acquisition.
Function List
Interface Description
AMT_Palmsensor_GetVersion
Function Syntax
Description
Parameters
Parameter Description
version In: Buffer pointer (recommended to pre-allocate 64 bytes, enough to use)
len In: buffer length allocated by version.
Returns
0 Success
Other Failure Error Code
Remarks
AMT_Palmsensor_Init
Function Syntax
Description
Returns
0 Success
Other Failure Error Code
Remarks
Before calling all functions (except AMT_Palmsensor_GetVersion), please initialize the device list
AMT_Palmsensor_Free
Function Syntax
Description
Returns
0 Success
Other Failure Error Code
Remarks
AMT_Palmsensor_GetCount
Function Syntax
Description
Returns
Remarks
AMT_Palmsensor_Open
Function Syntax
Description
Parameters
Parameter Description
In: Device index 0~(n-1), n=AMT_Palmsensor_GetCount
index
(generally pass 0)
Returns
Remarks
AMT_Palmsensor_Close
Function Syntax
Description
Parameters
Parameter Description
context In: Device operation instance handle
Returns
0 Success
Other Failure Error Code
Remarks
AMT_Palmsensor_Capture
Function Syntax
Description
Parameters
Parameter Description
context In: Device operation instance handle
imageBuffer Out: Image data collected(>=(width*height) Bytes)
In: imageBuffer pre-allocated buffer size (generally allocated >=
imageBufferSize
(width*height) bytes is sufficient)
Returns
Remarks
AMT_Palmsensor_SetParameter
Function Syntax
Description
Parameters
Parameter Description
context In: Device operation instance handle
paramCode In: Parameter code (see Parameter Code Description)
paramValue In: Parameter value (see Parameter Code Description)
Returns
0 Success
Other Failure Error Code
Remarks
AMT_Palmsensor_GetParameter
Function Syntax
Parameters
Parameter Description
context In: Device operation instance handle
paramCode In: Parameter code (see Parameter Code Description)
Returns
Remarks
AMT_Palmsensor_SetParameterEx
Function Syntax
Description
Parameters
Parameter Description
context In: Device operation instance handle
paramCode In: Parameter code (see Parameter Code Description)
paramValue In: Parameter value (see Parameter Code Description)
paramLen In: Parameter value length
Returns
Remarks
AMT_Palmsensor_GetParameterEx
Function Syntax
Description
Parameters
Parameter Description
context In: Device operation instance handle
paramCode In: Parameter code (see Parameter Code Description)
paramValue In: Parameter value (see Parameter Code Description)
In: Parameter value length
paramLen
Out: actual parameter value occupied size
Returns
4.2.1 AMTIRPalmService.dll
AMTIRPalmService.dll dynamic library is a palm algorithm interface library. Mainly used for
palm template extraction, registration, verification/identification, etc.
Function List
Interface Description
AMTPalmServiceVersion
Function Syntax
Description
Parameters
Parameter Description
versionData Out: Returns the date of the version number
major Out: Major version number.
minor Out: Minor version number
Out: Return the version number (recommended to pre-allocate 64
version
bytes, enough to use)
size In: Memory size allocated by the version (number of bytes)
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalmServiceInit
Function Syntax
Description
Parameters
Parameter Description
handle Out: Algorithm handle
width In: Palm image width (480 can be passed)
height In: Palm image height (only 640 can be passed)
IsMallocDb In: Pass true
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalmServiceFinal
Function Syntax
Description
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalmServiceSetParam
Function Syntax
Description
Parameters
Parameter Description
handle In: Just pass 0
paramIndex In: Parameter code (see Parameter Code Description)
paramValue In: Parameter value
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalmServiceExtractTemplate
Function Syntax
Description
Extracts the verification/identification templates and registration templates from palm images.
Parameters
Parameter Description
handle In: Just pass 0
In: Palm image data (original image data with 8-bit grayscale image bit
imgBuffer
depth)
In:
Represents the extraction of pre-registered features,
extractType
verification/identification features mainly used in the registration
process.
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalmServiceVerify
Function Syntax
Description
Parameters
Parameter Description
handle In: Just pass 0
regTemplate In: Register template data
verTemplate In: Compare template data
Returns
Remarks
AMTPalmServiceVerifyByID
Function Syntax
Description
Parameters
Parameter Description
handle In: Just pass 0
verTemplate In: Verifies the template data
id In: Palm id
Returns
Remarks
AMTPalmServiceMergeTemplates
Function Syntax
Description
Combines five pieces of palm pre-registered template data into one registered palm template.
Parameters
Parameter Description
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalmServiceDBAdd
Function Syntax
Description
Parameters
Parameter Description
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalmServiceDBDel
Function Syntax
Description
Delete the specified registration template from the 1:N bottombase library.
Parameters
Parameter Description
handle In: Just pass 0
id In: Palm id to delete
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalmServiceDBCount
Function Syntax
Description
Parameters
Parameter Description
handle In: Just pass 0
Returns
Remarks
AMTPalmServiceDBClear
Function Syntax
Description
Parameter Description
handle In: Just pass 0
Returns
0 Success
Other Failure Error Code
Remarks
AMTPalmServiceDBIdentify
Function Syntax
Description
Parameters
Parameter Description
handle In: Just pass 0
verTemplate In: identifies the template data
id Out: Returns the matched palm id (at least 24 bytes are allocated)
In: Minimum matching score (identification passing threshold,
minScore
recommended to set to 576)
maxScore In: Highest match score (just pass 1000 directly)
Returns
Remarks
Appendix
Appendix 1: Glossary
The following definitions will help you understand basic functions of a palm recognition
application and complete integrated development of such an application.
Re-registered template
Pre-registered templates are only used to merge captured palm features into a registered
template.
Verification/Identification template
Verification/Identification templates are palm templates used for 1:1 or 1:N palm recognition.
1:1 palm verification, also called palm verification, is a process of verifying whether a user has a
valid identity based on the user ID and palm template or determining whether a registered
template and several verification templates are extracted from the same palm.
That is, 1:1 biometric verification process authenticates a person’s identity by comparing the
captured biometric template with a biometric template of that person pre-stored in the database.
1:N palm identification, also called palm recognition, is a process of determining whether a user
exists in the system based on the palm of the user, without the user ID. Specifically, the
application looks up the palm template database based on the input palm template and returns
the name of the user meeting the threshold, palm similarity degree, and other related
information.
So thus, A one-to-many (1:N) biometric identification process instantly compares the person’s
captured biometric template against ALL stored biometric templates in the system.
Registered template
Registered palm
The palm collectordevice captures five palm images of the same user to extract pre-registered
templates, merges the pre-registered templates into a registered template, and then loads it to
the backend database as a registered palm for subsequent palm recognition.
Remarks
When using parameter code 2004 to control the LED light. The paramValue parameter value
needs to be passed in two bytes. The high byte indicates the flash time. The flash time is
required to be set with specific value (*100ms). After the set time is exceeded, the device
automatically turns off the flash light. The low byte indicates the type of LED light color.
Examples
Function Syntax
int nParamValue = 0;
char*)&nParamValue,paramSize);
Function Syntax
int nWidth = 0;
int nHeight = 0;
paramSize = sizeof(int);
¶mSize);
Error Code
Error
Description
code
0 Successful operation
-1 Operation failed
-2 Device is not connected
-3 Null pointer
-4 Invalid parameter
-5 Interface is not supported
-6 Failed to initialize algorithm library
-7 Invalid handle
-8 No palm detected
-9 Insufficient software memory allocation
-13 Failed to extract template
-14 Failed to load dynamic library of palm algorithm
-15 Incorrect template format
Failed to add registration template to the library (algorithm allocates memory
-16
error)
-17 Template conversion failed
-18 The verification/identification template data to be synthesized is incorrect
-19 Failed to open device
-103 No such id in the database (1:N bottombase library does not have this id)
-105 The characteristics of the id of the database are invalid (1: N bottombase library)
-106 Duplicate id added
-200 The database is full (1:N bottombase library)
-1000 Dongle error
Remarks
• The parameter code 2010 is used to notify the device whether the palm is away from the
recognition area, and the paramValue parameter value: 0x03 means there is a palm
placed in the recognition area, 0x04 means that the palm is away from the recognition
area.
• The parameter code 2012 is used to set the near-infrared LED light off timeout. The
timeout unit is: 1000ms (that is, the set value * 1000ms)
• The parameter code 2004 is used to control the LED light. The paramValue parameter
value needs to be passed in two bytes. The high byte indicates the flash time. The flash
time is the specific value to be set (*100ms). After the set values of the flash time is
exceeded, the device automatically turns off the light. The low byte indicates the type of
LED light color
Examples
Function Syntax
int nParamValue = 0;
int nRedLed = 1;//Red light
nParamValue = nRedLed;
int ret = AMT_Palmsensor_SetParameter(m_hDevice,2004,nParamValue);
Function Syntax
Notify the device if the palm is away from the recognition area)
Function Syntax
//Notifies the device that the palm is away from the recognition area
int nParamValue = 0x04;
int ret = AMT_Palmsensor_SetParameter(m_hDevice,2010, nParamValue);
//Notifies the device that there is a palm placed in the recognition area
nParamValue = 0x03
ret = AMT_Palmsensor_SetParameter(m_hDevice, 2010, nParamValue);
Function Syntax
Error Code
Parameter
Data type/length Attribute Description
code
Sets the template extraction detection
100 Int/4Bytes W
threshold
Error Code
E-mail: info@armatura.us
www.armatura.us