Differences

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

--- en:configuration_api [2020/02/19 14:35]
yjjung [BS2FaceConfig]
+++ en:configuration_api [2020/09/10 09:00]
yjjung [BS2AuthConfigExt]
@@ 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 123: / Line 130: @@
 ==== BS2SystemConfig ====
-[[BS2_SetSystemConfig]] must be called after calling [[BS2_GetSystemConfig]] and completing necessary settings except for tamperOn.  \\
 <code cpp>
 typedef struct {
@@ Line 153: / 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 365: / 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 438: / 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 1342: / 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 1572: / 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>
-. **//securityLevel//** \\
+**1. //securityLevel//** \\
 Face authentication security level. This is used across the system. . \\
 <WRAP group 50%>
@@ Line 1585: / Line 1607: @@
 |2  |Most highly secure  |
 </WRAP>
-. **//lightCondition//** \\
+**2. //lightCondition//** \\
 Configuration of the light condition.\\
 <WRAP group 50%>
@@ Line 1593: / Line 1615: @@
 |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 1606: / Line 1628: @@
 |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 1617: / Line 1639: @@
 |3  |High  |
 </WRAP>
-. **//enrollTimeout//** \\
+**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.\\ \\
-. **//lfdLevel//** \\
+<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 1628: / Line 1667: @@
 |3  |Most Strict  |
 </WRAP>
-. **//quickEnrollment//** \\
+**7. //quickEnrollment//** \\
 [+ 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. \\ \\
-. //previewOption// \\
+**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>
-. //checkDuplicate// \\
+**9. //checkDuplicate//** \\
 [+ V2.6.4] Check whether the scanned face is duplicated in the device. \\ \\
-. //reserved// \\
-Reserved space. \\ \\
+**10. //operationMode//** \\
-. //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>
@@ Line 1955: / Line 2016: @@
 . //reserved// \\
 Reserved space. \\
+==== BS2AuthConfigExt ====
+<code cpp>
+typedef struct {
+    uint32_t extAuthSchedule[BS2_MAX_NUM_OF_EXT_AUTH_MODE];
+    uint8_t useGlobalAPB;
+    uint8_t globalAPBFailAction;
+    uint8_t useGroupMatching;
+    uint8_t reserved;
+    uint8_t reserved2[4];
+    uint8_t usePrivateAuth;
+    uint8_t faceDetectionLevel;
+    uint8_t useServerMatching;
+    uint8_t useFullAccess;
+    uint8_t matchTimeout;
+    uint8_t authTimeout;
+    uint8_t numOperators;
+    uint8_t reserved3[1];
+    struct {
+        char userID[BS2_USER_ID_SIZE];
+        uint8_t level;
+        uint8_t reserved[3];
+    } operators[BS2_MAX_OPERATORS];
+    uint8_t reserved4[256];
+} BS2AuthConfigExt;
+</code>
+**1. //extAuthSchedule//** \\
+Schedule values to operate when each authentication mode is activated. \\
+It has the following meanings for each value. \\
+If the value in the array is greater than 0, the authentication mode is activated. \\
+In the explanations below, biometric information means fingerprints or faces depending on the device. \\
+<WRAP group 70%>
+^Value ^Code  ^Description  ^
+|11  |BS2_EXT_AUTH_MODE_FACE_ONLY  |Face |
+|12  |BS2_EXT_AUTH_MODE_FACE_FINGERPRINT  |Face + Fingerprint  |
+|13  |BS2_EXT_AUTH_MODE_FACE_PIN  |Face + PIN  |
+|14  |BS2_EXT_AUTH_MODE_FACE_FINGERPRINT_OR_PIN  |Face + Fingerprint/PIN  |
+|15  |BS2_EXT_AUTH_MODE_FACE_FINGERPRINT_PIN  |Face + Fingerprint + PIN  |
+|16  |BS2_EXT_AUTH_MODE_FINGERPRINT_ONLY  |Fingerprint |
+|17  |BS2_EXT_AUTH_MODE_FINGERPRINT_FACE  |Fingerprint + Face |
+|18  |BS2_EXT_AUTH_MODE_FINGERPRINT_PIN  |Fingerprint + PIN  |
+|19  |BS2_EXT_AUTH_MODE_FINGERPRINT_FACE_OR_PIN  |Fingerprint + Face/PIN  |
+|20  |BS2_EXT_AUTH_MODE_FINGERPRINT_FACE_PIN  |Fingerprint + Face + PIN  |
+|21  |BS2_EXT_AUTH_MODE_CARD_ONLY  |Card |
+|22  |BS2_EXT_AUTH_MODE_CARD_FACE  |Cardn + Face  |
+|23  |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT  |Card + Fingerprint  |
+|24  |BS2_EXT_AUTH_MODE_CARD_PIN  |Card + PIN  |
+|25  |BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT  |Card + Face/Fingerprint  |
+|26  |BS2_EXT_AUTH_MODE_CARD_FACE_OR_PIN  |Card + Face/PIN  |
+|27  |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_OR_PIN  |Card + Fingerprint/PIN  |
+|28  |BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT_OR_PIN  |Card + Face/Fingerprint/PIN  |
+|29  |BS2_EXT_AUTH_MODE_CARD_FACE_FINGERPRINT  |Card + Face + Fingerprint  |
+|30  |BS2_EXT_AUTH_MODE_CARD_FACE_PIN  |Card + Face + PIN  |
+|31  |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_FACE  |Card + Fingerprint + Face  |
+|32  |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_PIN  |Card + Fingerprint + PIN  |
+|33  |BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT_PIN  |Card + Face/Fingerprint + PIN  |
+|34  |BS2_EXT_AUTH_MODE_CARD_FACE_FINGERPRINT_OR_PIN  |Card + Face + Fingerprint/PIN  |
+|35  |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_FACE_OR_PIN  |Card + Fingerprint + Face/PIN  |
+|36  |BS2_EXT_AUTH_MODE_ID_FACE  |ID + Face  |
+|37  |BS2_EXT_AUTH_MODE_ID_FINGERPRINT  |ID + Fingerprint  |
+|38  |BS2_EXT_AUTH_MODE_ID_PIN  |ID + PIN  |
+|39  |BS2_EXT_AUTH_MODE_ID_FACE_OR_FINGERPRINT  |ID + Face/Fingerprint  |
+|40  |BS2_EXT_AUTH_MODE_ID_FACE_OR_PIN  |ID + Face/PIN  |
+|41  |BS2_EXT_AUTH_MODE_ID_FINGERPRINT_OR_PIN  |ID + Fingerprint/PIN  |
+|42  |BS2_EXT_AUTH_MODE_ID_FACE_OR_FINGERPRINT_OR_PIN  |ID + Face/Fingerprint/PIN  |
+|43  |BS2_EXT_AUTH_MODE_ID_FACE_FINGERPRINT  |ID + Face + Fingerprint  |
+|44  |BS2_EXT_AUTH_MODE_ID_FACE_PIN  |ID + Face + PIN  |
+|45  |BS2_EXT_AUTH_MODE_ID_FINGERPRINT_FACE  |ID + Fingerprint + Face  |
+|46  |BS2_EXT_AUTH_MODE_ID_FINGERPRINT_PIN  |ID + Fingerprint + PIN  |
+|47  |BS2_EXT_AUTH_MODE_ID_FACE_OR_FINGERPRINT_PIN  |ID + Face/Fingerprint + PIN  |
+|48  |BS2_EXT_AUTH_MODE_ID_FACE_FINGERPRINT_OR_PIN  |ID + Face + Fingerprint/PIN  |
+|49  |BS2_EXT_AUTH_MODE_ID_FINGERPRINT_FACE_OR_PIN  |ID + Fingerprint + Face/PIN  |
+</WRAP>
+. //useGlobalAPB// \\
+This flag determines whether to enable Global APB zone. \\ \\
+. //globalAPBFailAction// \\
+This is a basic action to be performed when the device cannot query the server for Global APB violation.  \\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |Do not check APB  |
+|1  |Soft APB  |
+|2  |Hard APB  |
+</WRAP>
+. //useGroupMatching// \\
+Enables facial group matching. \\ \\
+. //reserved// \\
+Reserved space. \\ \\
+. //reserved2// \\
+Reserved space. \\ \\
+. //usePrivateAuth// \\
+Enable private authentication mode. \\ \\
+. //faceDetectionLevel// \\
+This is the face detection level value when authenticating the user in BioStation A2, and if a face is detected at a level lower than the specified level, it is treated as an authentication failure.\\
+When enabled, the camera view according to Normal/Strict is displayed, and access is denied if the image log is not recognized as a face when successful authentication. The default is 0. \\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |Do not detect face  |
+|1  |Normal mode  |
+|2  |Strict mode  |
+</WRAP>
+<WRAP info>
+It is available only in BioStation A2, not available in FaceStation2 or FaceLite.
+</WRAP>
+. //useServerMatching// \\
+Enable server matching for fingerprint matching or facial matching. \\ \\
+. //useFullAccess// \\
+This parameter is not in use. \\ \\
+. //matchTimeout// \\
+The maximum response time in fingerprint or facial matching and the unit is seconds(sec). \\ \\
+. //authTimeout// \\
+The maximum response time in user authentication and the unit is seconds(sec).  \\ \\
+. //numOperators// \\
+The number of operators. \\ \\
+. //reserved3// \\
+Reserved \\ \\
+. //userID// \\
+User ID \\ \\
+. //level// \\
+It specifies the corresponding level of the user when the user is authenticated.\\
+<WRAP group 50%>
+^Value  ^Description  ^
+|0  |No level  |
+|1  |Operator level  |
+|2  |System configuration level  |
+|3  |User information level  |
+</WRAP>
+<WRAP alert>
+**CAUTION**\\
+You must specify the number of operators to be added in the field **//numOperators//** when adding operators.
+</WRAP>
+. //reserved// \\
+Reserved \\
+. //reserved4// \\
+Reserved \\ \\
+==== BS2FaceConfigExt ====
+<code cpp>
+typedef struct {
+    uint8_t thermalCheckMode;
+    uint8_t maskCheckMode;
+    uint8_t reserved[2];
+    uint8_t thermalFormat;
+    uint8_t reserved2[3];
+    uint16_t thermalThreshold;
+    uint8_t maskDetectionLevel;
+    uint8_t auditTemperature;
+    uint8_t useRejectSound;
+    uint8_t useOverlapThermal;
+    uint8_t reserved4;
+    uint8_t faceCheckOrder;
+} BS2FaceConfigExt;
+</code>
+. //thermalCheckMode// \\
+열화상 감지 모드를 설정합니다. \\
+HARD로 설정 시, 고열의 기준인 thermalThreshold를 초과하면, 출입에 영향을 주게됩니다. \\
+SOFT로 설정 시, 고열의 기준인 thermalThreshold를 초과하면, 근거를 로그를 남기고 출입에 영향을 주지 않습니다. \\
+<WRAP group 50%>
+^값  ^설명  ^기본값  ^
+|0  |열화상 감지 사용 안함  |기본값  |
+|1  |열화상 감지 사용 (HARD)  |  |
+|2  |열화상 감지 사용 (SOFT)  |  |
+</WRAP>
+. //maskCheckMode// \\
+''FaceStation F2'' 마스크 착용 감지 모드를 설정합니다. \\
+''FaceStation 2'' 이 설정은 무시됩니다. \\
+HARD로 설정 시, maskDetectionLevel에 근거하여 착용 위반이 감지되면, 출입에 영향을 주게됩니다. \\
+SOFT로 설정 시, maskDetectionLevel에 근거하여 착용 위반이 감지되면, 근거를 로그를 남기고 출입에 영향을 주지 않습니다. \\
+<WRAP group 50%>
+^값  ^설명  ^기본값  ^
+|0  |마스크 착용 감지 사용 안함  |기본값  |
+|1  |마스크 착용 감지 사용 (HARD)  |  |
+|2  |마스크 착용 감지 사용 (SOFT)  |  |
+</WRAP>
+. //reserved// \\
+예약된 공간입니다. \\ \\
+. //thermalFormat// \\
+온도 단위를 나타내며, 화면상의 온도 표시를 화씨 또는 섭씨로 나타내도록 선택할 수 있습니다. \\
+<WRAP group 50%>
+^값  ^설명  ^기본값  ^
+|0  |화씨  |  |
+|1  |섭씨  |기본값  |
+</WRAP>
+. //reserved2// \\
+예약된 공간입니다. \\ \\
+. //thermalThreshold// \\
+고열 판단 기준 값이며, 설정 할 온도의 100을 곱한 값으로 입력하여야 합니다. \\
+또한 섭씨 기준으로만 입력할 수 있습니다. \\
+이 값은 인증 거부의 근거가 되며, 설정 범위는 섭씨로 3000에서 4500 사이 입니다. \\ \\
+. //maskDetectionLevel// \\
+''FaceStation F2'' 마스크 착용 감지 수준을 입력합니다. 여기서 감지 수준은 내부적으로 설정된 값에 근거합니다. \\
+''FaceStation 2'' 이 설정은 무시됩니다. \\
+<WRAP group 50%>
+^값  ^설명  ^기본값  ^
+|0  |착용 감지 안함  |기본값  |
+|1  |감지수준 보통  |  |
+|2  |감지수준 높음  |  |
+|3  |감지수준 매우높음  |  |
+</WRAP>
+. //auditTemperature// \\
+측정 온도를 이벤트 로그에 기록할지 여부를 설정합니다. \\ \\
+. //useRejectSound// \\
+thermalThreshold 또는 maskDetectionLevel에 의해서 사용자 인증이 거부되는 경우, 효과음을 발생시킬지 여부를 설정합니다. \\ \\
+. //useOverlapThermal// \\
+화면상에 열화상 이미지를 중첩해서 표시합니다. \\ \\
+. //reserved4// \\
+예약된 공간입니다. \\ \\
+. //faceCheckOrder// \\
+발열 측정 및 마스크 착용 감지와 인증절차에 대한 순서를 정의합니다. \\
+ID를 조합한 인증이나, PIN을 조합한 인증의 경우, 장치에 접촉하게되는 절차를 거치게 되므로, \\
+고위험군을 고려하는 환경이라면, 발열 측정 후 인증을 선택할지, 그 전에 인증을 수행할지에 대한 선택은 매우 중요한 요소입니다. \\
+<WRAP group 50%>
+^값  ^설명  ^기본값  ^
+|0  |발열 측정 및 마스크 착용 감지 후 인증  | 기본값  |
+|1  |인증 후 발열 측정 및 마스크 착용 감지  |  |
+|2  |인증 절차 생략. 발열 검사 및 마스크 착용 감지만 수행  |  |
+</WRAP>
+==== BS2ThermalCameraConfig ====
+<code cpp>
+typedef struct {
+    uint8_t distance;
+    uint8_t emissionRate;
+    struct {
+        uint16_t x;
+        uint16_t y;
+        uint16_t width;
+        uint16_t height;
+    } roi;
+    uint8_t useBodyCompensation;
+    int8_t compensationTemperature;
+} BS2ThermalCameraConfig;
+</code>
+. //distance// \\
+The distance measured by the thermal imaging camera. The unit is cm, and the default is 70. \\ \\
+. //emissionRate// \\
+The rate of the subject reflecting heat. \\
+It is recommended to enter within the [95/97/98] range. If the subject is a human, 98 is recommended. \\ \\
+. //roi// \\
+ROI (Region of interest) refers to the region of interest. \\
+It can be specified through coordinates (x, y) and range (width, height) values when measuring temperature on the face. \\ \\
+. //useBodyCompensation// \\
+It decides whether to use the compensate the body temperature. \\ \\
+. //compensationTemperature// \\
+There may be a slight difference between the actual body temperature and the body temperature measurement using the camera, and you can correct the difference by setting a value here. \\
+It must be as the value multiplied by 10 of the temperature to be set. The value is available -50 ~ +50 \\ \\