Differences

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

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
Next revision Both sides next revision
en:configuration_api [2020/02/19 14:03]
yjjung [BS2FingerprintConfig] 		en:configuration_api [2020/07/29 11:48]
yjjung [BS2DisplayConfig]
Line 123: Line 123:
  
 ==== BS2SystemConfig ==== ==== BS2SystemConfig ====
-[[BS2_SetSystemConfig]] must be called after calling [[BS2_GetSystemConfig]] and completing necessary settings except for tamperOn. ​ \\ 
 <code cpp> <code cpp>
 typedef struct { typedef struct {
Line 153: Line 152:
 Reserved variable. \\ \\ Reserved variable. \\ \\
 **5. //​deviceLocked//​** \\  **5. //​deviceLocked//​** \\ 
-Decides whether to show lock screen in stand-by mode. \\ \\ +Indicates the current locked state of the device. (Read only filed) ​\\ \\ 
 **6. //​useInterphone//​** \\  **6. //​useInterphone//​** \\ 
 Decides whether to use intercom. \\ \\  Decides whether to use intercom. \\ \\ 
Line 365: Line 364:
     uint8_t timeFormat;     uint8_t timeFormat;
     uint8_t homeFormation;​     uint8_t homeFormation;​
-    ​uint8_t ​useUserPhrase;​ +    ​BS2_BOOL ​useUserPhrase;​ 
-    ​uint8_t reserved[1];+    ​BS2_BOOL queryUserPhrase;
     uint8_t shortcutHome[BS2_MAX_SHORTCUT_HOME];​     uint8_t shortcutHome[BS2_MAX_SHORTCUT_HOME];​
     uint8_t tnaIcon[16];​     uint8_t tnaIcon[16];​
Line 438: Line 437:
 **13. //​useUserPhrase//​** \\  **13. //​useUserPhrase//​** \\ 
 Flag that determines whether to use the user phrase feature. \\ \\  Flag that determines whether to use the user phrase feature. \\ \\ 
-**14. //​shortcutHome//​** \\  +**13. //​queryUserPhrase//​** \\  
-Home screen layout(Currently, not used). \\ \\  +If set true, asks for the user phrase to the server. \\ \\  
-**15. //​tnaIcon//​** \\ +**15. //​shortcutHome//​** \\  
 +Home screen layout(Going to apply later, not used currently). \\ \\  
 +**16. //​tnaIcon//​** \\ 
 Icon displayed on the device corresponding to the job code. \\ \\ Icon displayed on the device corresponding to the job code. \\ \\
-**16. //​reserved1//​** \\ +**17. //​reserved1//​** \\ 
 Reserved space. \\  Reserved space. \\ 
  
Line 761: Line 762:
 Decides whether to display scanned fingerprint image on the screen. \\ \\  Decides whether to display scanned fingerprint image on the screen. \\ \\ 
 **10. //​lfdLevel//​** \\  **10. //​lfdLevel//​** \\ 
-[+ V2.6.3] ​Configuration for the LFD sensitivity. \\+Configuration for the LFD(Live Fingerprint Detection - fake fingerprint detection) ​sensitivity. \\
 <WRAP group 50%> <WRAP group 50%>
 ^Value ​ ^Description ​ ^ ^Value ​ ^Description ​ ^
Line 1342: Line 1343:
 |11|Led action| |11|Led action|
 |12|Fire alarm input| |12|Fire alarm input|
 +|13|Auth Success(Access granted)|
 +|14|Auth Fail(Access denied)|
 +|15|Lift action|
 </​WRAP>​ </​WRAP>​
 27. //​stopFlag//​ \\  27. //​stopFlag//​ \\ 
Line 1577: Line 1581:
 } BS2FaceConfig;​ } BS2FaceConfig;​
 </​code>​ </​code>​
-1. //​securityLevel//​ \\ +**1. //​securityLevel//​** \\ 
 Face authentication security level. This is used across the system. . \\  Face authentication security level. This is used across the system. . \\ 
 <WRAP group 50%> <WRAP group 50%>
Line 1585: Line 1589:
 |2  |Most highly secure ​ | |2  |Most highly secure ​ |
 </​WRAP>​ </​WRAP>​
-2. //​lightCondition//​ \\ +**2. //​lightCondition//​** \\ 
 Configuration of the light condition.\\ ​ Configuration of the light condition.\\ ​
 <WRAP group 50%> <WRAP group 50%>
Line 1593: Line 1597:
 |2  |Automatic ​ | |2  |Automatic ​ |
 </​WRAP>​ </​WRAP>​
-3. //​enrollThreshold//​ \\  +**3. //​enrollThreshold//​** \\  
-Threshold of face enrollment.\\ ​+Threshold of face enrollment. ​It determines how much movement of pose is allowed when enrolling the face.  ​\\ 
 <WRAP group 50%> <WRAP group 50%>
 ^Value ​ ^Description ​ ^ ^Value ​ ^Description ​ ^
-|0  |THRESHOLD_0 ​ |+|0  |THRESHOLD_0 ​(Most strict) ​|
 |1  |THRESHOLD_1 | |1  |THRESHOLD_1 |
 |2  |THRESHOLD_2 ​ | |2  |THRESHOLD_2 ​ |
Line 1606: Line 1610:
 |7  |THRESHOLD_7 ​ | |7  |THRESHOLD_7 ​ |
 |8  |THRESHOLD_8 ​ | |8  |THRESHOLD_8 ​ |
-|9  |THRESHOLD_9 ​ |+|9  |THRESHOLD_9 ​(Least strict) ​|
 </​WRAP> ​ </​WRAP> ​
-4. //​detectSensitivity//​ \\ +**4. //​detectSensitivity//​** \\ 
 Configuration of sensitivity on detecting the face. \\  Configuration of sensitivity on detecting the face. \\ 
 <WRAP group 50%> <WRAP group 50%>
Line 1617: Line 1621:
 |3  |High  | |3  |High  |
 </​WRAP>​ </​WRAP>​
-5. //​enrollTimeout//​ \\ +**5. //​enrollTimeout//​** \\ 
 Timeout period of face scanning which is 60 seconds by default.\\ \\ Timeout period of face scanning which is 60 seconds by default.\\ \\
-6. //reserved3// \\  +**6. //lfdLevel//** \\ 
-Reserved space.\\ \\ +[+ V2.6.3] Configuration for the LFD(Live Face Detection - fake face detection) sensitivity. \\ 
 +<WRAP group 50%> 
 +^Value ​ ^Description ​ ^ 
 +|0  |Not Use  | 
 +|1  |Strict ​ | 
 +|2  |More Strict ​ | 
 +|3  |Most Strict ​ | 
 +</​WRAP>​ 
 +**7. //​quickEnrollment//​** \\ 
 +[+ V2.6.3] Quick face enrollment process. \\ 
 +True - Face enrollment process with a single step.\\ 
 +False - Face enrollment rpcoess with 3 steps.\\ 
 +Please use false if you want to enroll with a high quality of face templates. \\ \\ 
 +**8. //​previewOption//​** \\ 
 +[+ V2.6.3] IR camera preview option when you authenticate with face. \\ 
 +Only used to ''​FaceLite''​. \\ 
 +<WRAP group 50%> 
 +^Value ​ ^Description ​ ^ 
 +|0  |Preview not used  | 
 +|1  |Preview not used at frist of authentication,​ preview at 1/2 stage  | 
 +|2  |Preview of all stages on authentication ​ | 
 +</​WRAP>​ 
 +**9. //​checkDuplicate//​** \\ 
 +[+ V2.6.4] Check whether the scanned face is duplicated in the device. \\ \\ 
 +**10. //​reserved//​** ​\\  
 +Reserved space. \\ \\ 
 +**11. //​reserved2//​** \\  
 +Reserved space. \\ \\
 ==== BS2Rs485ConfigEX ==== ==== BS2Rs485ConfigEX ====
 <code cpp> <code cpp>