Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision 		Previous revision
en:quick_guide [2017/06/29 14:40]
127.0.0.1 external edit 		en:quick_guide [2021/01/18 14:39] (current)
yjjung
Line 1: Line 1:
 ====== Quick Guide ====== ====== Quick Guide ======
 +
 <WRAP indent> <WRAP indent>
 This page explains how to develop an application using the BioStar SDK. \\ This page explains how to develop an application using the BioStar SDK. \\
Line 90: Line 91:
 ===== Step 3. Verifying the device function ===== ===== Step 3. Verifying the device function =====
 <WRAP indent> <WRAP indent>
-Once the connection with the device has been completed, it's required to get the information of the device. The design of the BioStar application'​s UI needs to be oriented with the certain type of the device, because some functions are not supported based on the device'​s type.((For example, Xpass does not have to have fingerprint identification and face recognition functions as a result of not having a fingerprint sensor and a face recognition sensor.)) Use ''​[[BS2_GetDeviceInfo]]''​ to get the device'​s information.+Once the connection with the device has been completed, it's required to get the information of the device. The design of the BioStar application'​s UI needs to be oriented with a certain type of device because some functions are not supported based on the device'​s type.((For example, Xpass does not have to have fingerprint identification and face recognition functions as a result of not having a fingerprint sensor and a face recognition sensor.)) Use ''​[[BS2_GetDeviceInfo]]''​ to get the device'​s information.
 <code cpp> <code cpp>
 uint32_t deviceId = 1; uint32_t deviceId = 1;
Line 131: Line 132:
 <WRAP indent> <WRAP indent>
 To enroll a new user to the device, it is required to set the header information properly. To enroll a new user to the device, it is required to set the header information properly.
-The type of the credentials that a user can use are PIN, smart card, finger, face and use the information from [[quick_guide#​Step 4. Getting the device configuration]] ''​BS2SimpleDeviceInfo''​ to be informed on which credential the device supports.+The type of credentials that a user can use are PIN, smart card, finger, face, and use the information from [[quick_guide#​Step 4. Getting the device configuration]] ''​BS2SimpleDeviceInfo''​ to be informed on which credential the device supports.
  
 The user and credential information can be enrolled by the ''​[[BS2_EnrolUser]]''​ function. For more details, refer to [[User Management API]]. The user and credential information can be enrolled by the ''​[[BS2_EnrolUser]]''​ function. For more details, refer to [[User Management API]].
Line 148: Line 149:
 ==== User header ==== ==== User header ====
 <WRAP indent> <WRAP indent>
-The user header information ​are different depending on the type of the device. For instance, BioStation 2 can use the user identifier, user name, and PIN, but BioEntry Plus can only use the user identifier field. Because ​of the rest of the fields that are not used from the device will be ignored, a BioStar application developer must create a UI based on the function that the device supports to avoid users from experiencing inconvenience and confusion.+The user header information ​is different depending on the type of device. For instance, BioStation 2 can use the user identifier, user name, and PIN, but BioEntry Plus can only use the user identifier field. Because the rest of the fields that are not used from the device will be ignored, a BioStar application developer must create a UI based on the function that the device supports to avoid users from experiencing inconvenience and confusion.
  
 <WRAP info> <WRAP info>
Line 309: Line 310:
 ==== Add the face template ==== ==== Add the face template ====
 <WRAP indent> <WRAP indent>
-Will be supported later.+Extracting the face template is done by 2 steps; \\ 
 +1. scanning the fingerprint image \\ 
 +2. extracting the template data \\ 
 + 
 +Face template doesn'​t have verify step.  
 +Once the extraction of the face template is completed, map the face template information to the structure. 
 + 
 +<code cpp> 
 +uint32_t deviceId = 1; 
 +BS2SimpleDeviceInfo deviceInfo;​ 
 +BS2UserBlob userBlob; 
 +BS2Face Face[BS2_MAX_NUM_OF_FACE_PER_USER];​ 
 + 
 +if (deviceInfo.faceSupported) 
 +{ 
 +    int idx = 0; 
 +    uint32_t templateIndex = 0; 
 +    byte enrollThreshold;​ 
 +    int result = BS_SDK_SUCCESS;​ 
 +     
 +     
 +     
 +    for(; idx < BS2_MAX_NUM_OF_FACE_PER_USER;​ idx++) 
 +    { 
 +            result = BS2_ScanFace(context,​ deviceId, Face, enrollThreshold,​ NULL); 
 +            if(result != BS_SDK_SUCCESS) 
 +            { 
 +                    //TODO handle error 
 +                    break; ​                    
 +            } 
 +            if(result == BS_SDK_SUCCESS) 
 +            { 
 +                     ​Face[0].faceindext = idx; 
 +                     ​userBlob.faceObjs= face[0] 
 +            } 
 +             
 +    } 
 +} 
 +</​code>​
 </​WRAP>​ </​WRAP>​
 </​WRAP>​ </​WRAP>​
Line 315: Line 354:
 ===== Step 6. Managing the log ===== ===== Step 6. Managing the log =====
 <WRAP indent> <WRAP indent>
-BioEntry Plus, BioEntry W, BioLite Net, Xpass, Xpass S2 can store up to 50,000 logs, and BioStation 2 can store up to 3,000,000 logs. The log information is managed by circular queue, so if there is not enough space to store the old logs will be automatically deleted to secure space. For more details, refer to [[Log Management API]]. ​+BioEntry Plus, BioEntry W, BioLite Net, Xpass, Xpass S2 can store up to 50,000 logs, and BioStation 2 can store up to 3,000,000 logs. The log information is managed by a circular queue, so if there is not enough space to store the old logs will be automatically deleted to secure space. For more details, refer to [[Log Management API]]. ​
 ---- ----
 ==== Getting the log ==== ==== Getting the log ====