Differences

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

--- en:configuration_api [2020/02/19 11:29]
kkshin
+++ en:configuration_api [2020/08/28 12:38]
yjjung [Configuration API]
@@ Line 68: / Line 68: @@
   * [[BS2_GetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Retrieves IPv6 configuration through UDP broadcast with host IP.
   * [[BS2_SetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Stores IPv6 configuration through UDP broadcast with host IP.
+  * [[BS2_GetDesFireCardConfigEx]]: [+ V2.6.4] Retrieves DesFire advanced configuration from the device.
+  * [[BS2_SetDesFireCardConfigEx]]: [+ V2.6.4] Sets DesFire advanced configuration in the device.
+  * [[BS2_GetAuthConfigExt]]: ''FaceStation F2'' Retrieves authentication settings from the device. [+ V2.7.1]
+  * [[BS2_SetAuthConfigExt]]: ''FaceStation F2'' Stores authentication settings from the device. [+ V2.7.1]
+  * [[BS2_GetFaceConfigExt]]: ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera and mask detection. [+ V2.7.1]
+  * [[BS2_SetFaceConfigExt]]: ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera and mask detection. [+ V2.7.1]
+  * [[BS2_GetThermalCameraConfig]]: ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera. [+ V2.7.1]
+  * [[BS2_SetThermalCameraConfig]]: ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera. [+ V2.7.1]
 \\
 ===== Structure =====
@@ Line 121: / Line 130: @@
 ==== BS2SystemConfig ====
-[[BS2_SetSystemConfig]] must be called after calling [[BS2_GetSystemConfig]] and completing necessary settings except for tamperOn.  \\
 <code cpp>
 typedef struct {
@@ Line 151: / Line 159: @@
 Reserved variable. \\ \\
 **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//** \\
 Decides whether to use intercom. \\ \\
@@ Line 177: / Line 185: @@
 **14. //reserved//** \\
 Reserved space. \\ \\
-. //useCardOperationMask// \\
+**15. //useCardOperationMask//** \\
 [+ V2.6.4] Provides a card selective option not to read all kinds of cards from the device. \\
 You can select multiple cards using MASK. The user can select or deselect of a specific card reading option using this option. \\
@@ Line 363: / Line 371: @@
     uint8_t timeFormat;
     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 tnaIcon[16];
@@ Line 436: / Line 444: @@
 **13. //useUserPhrase//** \\
 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. \\ \\
-**16. //reserved1//** \\
+**17. //reserved1//** \\
 Reserved space. \\
@@ Line 691: / Line 701: @@
 Reserved space. \\
 </WRAP>
 ==== BS2FingerprintConfig ====
 <code cpp>
@@ Line 758: / Line 769: @@
 Decides whether to display scanned fingerprint image on the screen. \\ \\
 **10. //lfdLevel//** \\
-Configuration for the LFD sensitivity. \\
+Configuration for the LFD(Live Fingerprint Detection - fake fingerprint detection) sensitivity. \\
 <WRAP group 50%>
 ^Value  ^Description  ^
@@ Line 766: / Line 777: @@
 |3  |Most Strict  |
 </WRAP>
-**11. checkDuplicate \\
+**11. //checkDuplicate//** \\
 [+ V2.6.4] If set to true, it will determine if the fingerprint is a duplicate. \\ \\
 **12. //reserved3//** \\
@@ Line 1339: / Line 1350: @@
 |11|Led action|
 |12|Fire alarm input|
+|13|Auth Success(Access granted)|
+|14|Auth Fail(Access denied)|
+|15|Lift action|
 </WRAP>
 . //stopFlag// \\
@@ Line 1558: / Line 1572: @@
 <code cpp>
 typedef struct {
-	BS2_FACE_SECURITY_LEVEL       securityLevel;
+    uint8_t       securityLevel;
-	BS2_FACE_LIGHT_CONDITON       lightCondition;
+    uint8_t       lightCondition;
-	BS2_FACE_ENROLL_THRESHOLD     enrollThreshold;
+    uint8_t       enrollThreshold;
-	BS2_FACE_DETECT_SENSITIVITY   detectSensitivity;
+    uint8_t       detectSensitivity;
-	uint16_t                      enrollTimeout;
+    uint16_t      enrollTimeout;
-	uint8_t                       reserved3[32];
+    uint8_t       lfdLevel;
+    bool          quickEnrollment;
+    uint8_t       previewOption;
+    bool          checkDuplicate;
+    uint8_t       reserved[2];
+    uint8_t       reserved2[26];
 } BS2FaceConfig;
 </code>
-. //securityLevel// \\
+**1. //securityLevel//** \\
 Face authentication security level. This is used across the system. . \\
 <WRAP group 50%>
@@ Line 1575: / Line 1596: @@
 |2  |Most highly secure  |
 </WRAP>
-. //lightCondition// \\
+**2. //lightCondition//** \\
 Configuration of the light condition.\\
 <WRAP group 50%>
@@ Line 1583: / Line 1604: @@
 |2  |Automatic  |
 </WRAP>
-. //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%>
 ^Value  ^Description  ^
-|0  |THRESHOLD_0  |
+|0  |THRESHOLD_0 (Most strict) |
 |1  |THRESHOLD_1 |
 |2  |THRESHOLD_2  |
@@ Line 1596: / Line 1617: @@
 |7  |THRESHOLD_7  |
 |8  |THRESHOLD_8  |
-|9  |THRESHOLD_9  |
+|9  |THRESHOLD_9 (Least strict) |
 </WRAP>
-. //detectSensitivity// \\
+**4. //detectSensitivity//** \\
 Configuration of sensitivity on detecting the face. \\
 <WRAP group 50%>
@@ Line 1607: / Line 1628: @@
 |3  |High  |
 </WRAP>
-. //enrollTimeout// \\
+**5. //enrollTimeout//** \\
 Timeout period of face scanning which is 60 seconds by default.\\ \\
-. //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 ====
 <code cpp>