Differences

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

--- en:configuration_api [2020/02/25 08:29]
kkshin [BS2SystemConfig]
+++ en:configuration_api [2020/08/28 13:20]
yjjung
@@ 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 152: / 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 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>
@@ 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//** \\
+각 인증 모드가 활성화될 때 실행할 일정 식별자입니다. \\
+배열의 순서대로 아래의 의미를 가지며, \\
+배열 내의 값이 0보다 큰경우 해당 인증모드는 활성화 되어 있습니다. \\
+아래 설명 중 생체정보는 장치에 따라 지문 또는 얼굴을 의미합니다. \\
+<WRAP group 70%>
+^순서 ^의미  ^설명  ^
+|11  |BS2_EXT_AUTH_MODE_FACE_ONLY  |얼굴  |
+|12  |BS2_EXT_AUTH_MODE_FACE_FINGERPRINT  |얼굴 + 지문  |
+|13  |BS2_EXT_AUTH_MODE_FACE_PIN  |얼굴 + PIN  |
+|14  |BS2_EXT_AUTH_MODE_FACE_FINGERPRINT_OR_PIN  |얼굴 + 지문/PIN  |
+|15  |BS2_EXT_AUTH_MODE_FACE_FINGERPRINT_PIN  |얼굴 + 지문 + PIN  |
+|16  |BS2_EXT_AUTH_MODE_FINGERPRINT_ONLY  |지문  |
+|17  |BS2_EXT_AUTH_MODE_FINGERPRINT_FACE  |지문 + 얼굴  |
+|18  |BS2_EXT_AUTH_MODE_FINGERPRINT_PIN  |지문 + PIN  |
+|19  |BS2_EXT_AUTH_MODE_FINGERPRINT_FACE_OR_PIN  |지문 + 얼굴/PIN  |
+|20  |BS2_EXT_AUTH_MODE_FINGERPRINT_FACE_PIN  |지문 + 얼굴 + PIN  |
+|21  |BS2_EXT_AUTH_MODE_CARD_ONLY  |카드  |
+|22  |BS2_EXT_AUTH_MODE_CARD_FACE  |카드 + 얼굴  |
+|23  |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT  |카드 + 지문  |
+|24  |BS2_EXT_AUTH_MODE_CARD_PIN  |카드 + PIN  |
+|25  |BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT  |카드 + 얼굴/지문  |
+|26  |BS2_EXT_AUTH_MODE_CARD_FACE_OR_PIN  |카드 + 얼굴/PIN  |
+|27  |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_OR_PIN  |카드 + 지문/PIN  |
+|28  |BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT_OR_PIN  |카드 + 얼굴/지문/PIN  |
+|29  |BS2_EXT_AUTH_MODE_CARD_FACE_FINGERPRINT  |카드 + 얼굴 + 지문  |
+|30  |BS2_EXT_AUTH_MODE_CARD_FACE_PIN  |카드 + 얼굴 + PIN  |
+|31  |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_FACE  |카드 + 지문 + 얼굴  |
+|32  |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_PIN  |카드 + 지문 + PIN  |
+|33  |BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT_PIN  |카드 + 얼굴/지문 + PIN  |
+|34  |BS2_EXT_AUTH_MODE_CARD_FACE_FINGERPRINT_OR_PIN  |카드 + 얼굴 + 지문/PIN  |
+|35  |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_FACE_OR_PIN  |카드 + 지문 + 얼굴/PIN  |
+|36  |BS2_EXT_AUTH_MODE_ID_FACE  |ID + 얼굴  |
+|37  |BS2_EXT_AUTH_MODE_ID_FINGERPRINT  |ID + 지문  |
+|38  |BS2_EXT_AUTH_MODE_ID_PIN  |ID + PIN  |
+|39  |BS2_EXT_AUTH_MODE_ID_FACE_OR_FINGERPRINT  |ID + 얼굴/지문  |
+|40  |BS2_EXT_AUTH_MODE_ID_FACE_OR_PIN  |ID + 얼굴/PIN  |
+|41  |BS2_EXT_AUTH_MODE_ID_FINGERPRINT_OR_PIN  |ID + 지문/PIN  |
+|42  |BS2_EXT_AUTH_MODE_ID_FACE_OR_FINGERPRINT_OR_PIN  |ID + 얼굴/지문/PIN  |
+|43  |BS2_EXT_AUTH_MODE_ID_FACE_FINGERPRINT  |ID + 얼굴 + 지문  |
+|44  |BS2_EXT_AUTH_MODE_ID_FACE_PIN  |ID + 얼굴 + PIN  |
+|45  |BS2_EXT_AUTH_MODE_ID_FINGERPRINT_FACE  |ID + 지문 + 얼굴  |
+|46  |BS2_EXT_AUTH_MODE_ID_FINGERPRINT_PIN  |ID + 지문 + PIN  |
+|47  |BS2_EXT_AUTH_MODE_ID_FACE_OR_FINGERPRINT_PIN  |ID + 얼굴/지문 + PIN  |
+|48  |BS2_EXT_AUTH_MODE_ID_FACE_FINGERPRINT_OR_PIN  |ID + 얼굴 + 지문/PIN  |
+|49  |BS2_EXT_AUTH_MODE_ID_FINGERPRINT_FACE_OR_PIN  |ID + 지문 + 얼굴/PIN  |
+</WRAP>
+. //useGlobalAPB// \\
+광역 이중 인증 방지 구역을 활성화할지 결정하는 flag입니다. \\ \\
+. //globalAPBFailAction// \\
+광역 이중 인증 위반인지 BioStar 애플리케이션에 질의를 할 수 없거나 응답이 없을때 기본적으로 수행해야 할 동작입니다. \\
+<WRAP group 50%>
+^값  ^설명  ^
+|0  |APB 검사 안함  |
+|1  |Soft APB로 동작  |
+|2  |Hard APB로 동작  |
+</WRAP>
+. //useGroupMatching// \\
+얼굴 그룹 매칭을 사용할지 결정하는 flag입니다. \\ \\
+. //reserved// \\
+예약된 공간입니다. \\ \\
+. //reserved2// \\
+예약된 공간입니다. \\ \\
+. //usePrivateAuth// \\
+개별 인증 모드를 사용할지 결정하는 flag입니다. \\ \\
+. //faceDetectionLevel// \\
+A2에서 사용자를 인증할 때 얼굴 검출 레벨값이며, 지정한 레벨보다 낮은 레벨로 얼굴이 검출되면 인증 실패로 처리됩니다.\\
+설정하면 Normal/Strict에 따른 카메라 뷰가 표시되며, 인증 성공 시의 이미지 로그가 얼굴로 인식되지 않으면 접근이 거부됩니다. 기본값은 0입니다. \\
+<WRAP group 50%>
+^값  ^설명  ^
+|0  |얼굴 검출을 하지 않음  |
+|1  |Normal mode  |
+|2  |Strict mode  |
+</WRAP>
+<WRAP info>
+A2에서만 설정 가능하며, FaceStation2나 FaceLite에서는 사용되지 않습니다.
+</WRAP>
+. //useServerMatching// \\
+지문 인증이나 얼굴 인식을 Matching server에서 수행할지 결정하는 flag입니다. \\ \\
+. //useFullAccess// \\
+사용하지 않는 변수입니다. \\ \\
+. //matchTimeout// \\
+지문 인증이나 얼굴 인식에서 최대 응답 시간이며 단위는 초(sec)를 사용합니다. \\ \\
+. //authTimeout// \\
+사용자 인증의 최대 응답 시간이며 단위는 초(sec)를 사용합니다. \\ \\
+. //numOperators// \\
+사용자 권한을 정의하는 operator의 개수입니다. \\ \\
+. //reserved3// \\
+예약된 공간입니다. \\ \\
+. //userID// \\
+사용자 식별자입니다. \\ \\
+. //level// \\
+사용자가 인증되었을 때 식별자에 해당하는 권한을 지정합니다. \\
+<WRAP group 50%>
+^값  ^설명  ^
+|0  |권한 없음  |
+|1  |관리자 권한  |
+|2  |시스템 구성을 변경할 수 있는 권한  |
+|3  |사용자 정보를 변경할 수 있는 권한  |
+</WRAP>
+<WRAP alert>
+**주의**\\
+Operator 추가 시, 추가하고자 하는 operator의 수를 **//numOperators//** 필드의 값으로 지정해야 합니다.
+</WRAP>
+. //reserved// \\
+예약된 공간입니다. \\
+. //reserved4// \\
+예약된 공간입니다. \\ \\
+==== 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// \\
+열화상 카메라의 체온 측정 거리를 나타냅니다. 단위는 cm이며 기본값은 70 입니다. \\ \\
+. //emissionRate// \\
+피사체가 열을 방사하는 비율을 입력합니다. \\
+[95/97/98] 범위내의 입력을 권장합니다. 피사체가 사람인 경우 적정 권장은 98 입니다. \\ \\
+. //roi// \\
+ROI(Region of interest)는 관심영역을 의미하며, 얼굴에서 발열 측정 시, 관심 대상이되는 영역을 \\
+좌표(x, y)와, 범위(width, height) 값을 통해서 지정할 수 있습니다. \\ \\
+. //useBodyCompensation// \\
+발열 측정된 체온의 보정을 사용할지 여부를 나타냅니다. \\ \\
+. //compensationTemperature// \\
+실제 체온측정값과, 카메라를 통한 체온측정은 약간의 차이가 존재할 수 있으며, 이곳에 값을 설정하여, 그 차이를 보정할 수 있습니다. \\
+설정할 온도의 10을 곱한 값으로 입력하여야하며, 최소 -50에서 최대 50 사이의 값을 지정할 수 있습니다. \\ \\