Differences

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

--- en:configuration_api [2020/02/25 08:31]
kkshin [BS2SystemConfig]
+++ en:configuration_api [2020/08/28 13:18]
yjjung [BS2FaceConfig]
@@ Line 70: / Line 70: @@
   * [[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 364: / 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 437: / 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 1341: / 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 1571: / Line 1583: @@
     uint8_t       previewOption;
     bool          checkDuplicate;
-    uint8_t       reserved[2];
+    uint8_t       operationMode;
+    uint8_t       maxRotation;
-    uint8_t       reserved2[26];
+    struct {
+        uint16_t  min;
+        uint16_t  max;
+    } faceWidth;
+    struct {
+        uint16_t  x;
+        uint16_t  width;
+    } searchRange;
+    uint8_t       reserved2[18];
 } BS2FaceConfig;
 </code>
@@ Line 1593: / Line 1616: @@
 </WRAP>
 **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 1605: / Line 1628: @@
 |7  |THRESHOLD_7  |
 |8  |THRESHOLD_8  |
-|9  |THRESHOLD_9  |
+|9  |THRESHOLD_9 (Least strict) |
 </WRAP>
 **4. //detectSensitivity//** \\
@@ Line 1617: / Line 1640: @@
 </WRAP>
 **5. //enrollTimeout//** \\
-Timeout period of face scanning which is 60 seconds by default.\\ \\
+''FaceStation2, FaceLite'' : Timeout period of face scanning which is 60 seconds by default.\\ \\
+<WRAP group 60%>
+^Value  ^Description  ^
+|BS2_FACE_ENROLL_TIMEOUT_MIN  |30  |
+|BS2_FACE_ENROLL_TIMEOUT_MAX  |60  |
+|BS2_FACE_ENROLL_TIMEOUT_DEFAULT  |BS2_FACE_ENROLL_TIMEOUT_MAX  |
+</WRAP>
+''FaceStation F2'' : [+ V2.7.1] Face scan wait time, default is 20 seconds. \\
+<WRAP group 70%>
+^Value  ^Description  ^
+|BS2_FACE_EX_ENROLL_TIMEOUT_MIN  |10  |
+|BS2_FACE_EX_ENROLL_TIMEOUT_MAX  |20  |
+|BS2_FACE_EX_ENROLL_TIMEOUT_DEFAULT  |BS2_FACE_EX_ENROLL_TIMEOUT_MAX  |
+</WRAP>
 **6. //lfdLevel//** \\
 [+ V2.6.3] Configuration for the LFD(Live Face Detection - fake face detection) sensitivity. \\
+''FaceStation2, FaceLite'' : Default is 0. \\
+''FaceStation F2'' : [+ V2.7.1] Default is 1. \\
 <WRAP group 50%>
 ^Value  ^Description  ^
@@ Line 1630: / Line 1670: @@
 [+ V2.6.3] Quick face enrollment process. \\
 True - Face enrollment process with a single step.\\
-False - Face enrollment rpcoess with 3 steps.\\
+False - Face enrollment process 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. \\
+[+ V2.6.3] IR camera preview option when you authenticate with the 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  |
+|1  |Preview not used at first 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. \\ \\
+**10. //operationMode//** \\
-**11. //reserved2//** \\
+[+ V2.7.1] ''FaceStation F2'' Configures operation mode with below values, default is Fusion mode. \\
-Reserved space. \\ \\
+<WRAP group 50%>
+^Value  ^Mode  ^Description  ^Default  ^
+|0  |Fusion Mode |Visual matching + IR matching |Default |
+|1  |Visual Mode |Visual matching | |
+|2  |Visual + IR |Visual matching, IR detects only face| |
+</WRAP>
+**11. //maxRotation//** \\
+[+ V2.7.1] ''FaceStation F2'' When face is recognized normally it's front side. \\
+Still, it is possible to determine how many degrees the image has been rotated from the front when FSF2 detects a face. \\
+This enables detection failure in the case of images rotated over a certain angle. \\
+maxRotation represents the maximum allowable value in this case, and the default value is 15 degrees. \\ \\
+**12. //faceWidth//** \\
+[+ V2.7.1] ''FaceStation F2'' This indicates the width of the face image, and you can specify the minimum and maximum values. \\
+The minimum and maximum values default to 66 and 250. \\ \\
+**13. //searchRange//** \\
+[+ V2.7.1] ''FaceStation F2'' Represents the face search range, and you can specify the x value (horizontal coordinate) of the range and the width from the x value point. \\
+The default values for x value and width are 144 and 432. \\ \\
+. //reserved2// \\
+Reserved space.\\ \\
 ==== BS2Rs485ConfigEX ====
 <code cpp>