차이

문서의 선택한 두 판 사이의 차이를 보여줍니다.

--- ko:configuration_api [2023/02/09 16:13]
mashin
+++ ko:configuration_api [2024/04/04 13:53] (현재)
ghshin [BS2FaceConfig]
@@ 줄 86: / 줄 86: @@
   * [[BS2_GetRtspConfig]]: [+ 2.8.3] ''BS3'' RTSP 설정을 가져옵니다.
   * [[BS2_SetRtspConfig]]: [+ 2.8.3] ''BS3'' RTSP 설정을 저장합니다.
-  * [[BS2_GetLicenseConfig]]: [+ 2.8.4] 장치 라이선스 활성화 정보를 가져옵니다.
+  * [[BS2_GetLicenseConfig]]: [+ 2.9.1] 장치 라이선스 활성화 정보를 가져옵니다.
+  * [[BS2_GetOsdpStandardConfig]]: [+ 2.9.1] 장치의 OSDP 설정 정보를 가져옵니다.
+  * [[BS2_GetOsdpStandardActionConfig]]: [+ 2.9.1] OSDP 장치의 action별 LED/buzzer 설정을 가져옵니다.
+  * [[BS2_SetOsdpStandardActionConfig]]: [+ 2.9.1] OSDP 장치의 action별 LED/buzzer 설정을 저장합니다.
+  * [[BS2_GetCustomCardConfig]]: [+ 2.9.4] Custom smart card 설정을 가져옵니다.
+  * [[BS2_SetCustomCardConfig]]: [+ 2.9.4] Custom smart card 설정을 저장합니다.
 ===== 구조체 =====
 ==== BS2FactoryConfig ====
@@ 줄 204: / 줄 208: @@
 |0x80000000  |CARD_OPERATION_USE  |
 |0x00000000  |CARD_OPERATION_MASK_NONE  |
-|0x00000001  |CARD_OPERATION_MASK_LF_EM  |
+|0x00000800  |CARD_OPERATION_MASK_CUSTOM_DESFIRE_EV1  |
-|0x00000002  |CARD_OPERATION_MASK_LF_PROX  |
+|0x00000400  |CARD_OPERATION_MASK_CUSTOM_CLASSIC_PLUS  |
-|0x00000004  |CARD_OPERATION_MASK_HF_CSN_MIFARE  |
+|0x00000200  |CARD_OPERATION_MASK_BLE  |
-|0x00000008  |CARD_OPERATION_MASK_HF_CSN_ICLASS  |
+|0x00000100  |CARD_OPERATION_MASK_NFC  |
-|0x00000010  |CARD_OPERATION_MASK_HF_SMART_MIFARE  |
+|0x00000080  |CARD_OPERATION_MASK_SEOS  |
-|0x00000020  |CARD_OPERATION_MASK_HF_SMART_MIFARE_DESFIRE  |
+|0x00000040  |CARD_OPERATION_MASK_SR_SE  |
-|0x00000040  |CARD_OPERATION_MASK_HF_SMART_ICLASS  |
+|0x00000020  |CARD_OPERATION_MASK_DESFIRE_EV1  |
-|0x00000080  |CARD_OPERATION_MASK_HF_SMART_ICLASS_SEOS  |
+|0x00000010  |CARD_OPERATION_MASK_CLASSIC_PLUS  |
-|0x00000100  |CARD_OPERATION_MASK_MOBILE_NFC  |
+|0x00000008  |CARD_OPERATION_MASK_ICLASS  |
-|0x00000200  |CARD_OPERATION_MASK_MOBILE_BLE  |
+|0x00000004  |CARD_OPERATION_MASK_MIFARE_FELICA  |
-|0x00000400  |CARD_OPERATION_MASK_HF_CSN_OTHERS  |
+|0x00000002  |CARD_OPERATION_MASK_HIDPROX  |
+|0x00000001  |CARD_OPERATION_MASK_EM  |
 </WRAP>
 . //reserved2// \\
@@ 줄 382: / 줄 387: @@
     uint8_t tnaIcon[16];
     uint8_t useScreenSaver;
-    uint8_t reserved1[31];
+    uint8_t showOsdpResult;
+    uint8_t reserved1[30];
 } BS2DisplayConfig;
 </code>
@@ 줄 488: / 줄 494: @@
 . //useScreenSaver// \\
 ''FaceStation 2'', ''FaceStation F2'' true로 설정 시, 화면보호기가 활성화됩니다. \\ \\
-. //reserved1// \\
+. //showOsdpResult// \\
+[+ 2.9.6] Intelligent slave나 타사 컨트롤러에 슈프리마 장치를 주변장치로 연결하여 사용하는 환경에서 \\
+인증 결과를 장치 화면에 표시하도록 하는 옵션입니다. \\
+<WRAP group 50%>
+^값  ^설명  ^
+|0  |OSDP 인증결과 표시 (기본값)  |
+|1  |OSDP 인증결과 표시안함  |
+</WRAP>
+. //reserved1// \\
 예약된 공간입니다. \\
@@ 줄 1217: / 줄 1231: @@
     uint32_t deviceID;
     uint8_t type;
-    uint8_t reserved[3];
+    uint8_t reserved;
+    uint16_t ignoreSignalTime;
     union {
@@ 줄 1263: / 줄 1278: @@
 |3|Schedule trigger|
 </WRAP>
+. //reserved// \\
+예약된 공간입니다. \\ \\
+. //ignoreSignalTime// \\
+[+2.9.6] 밀리초 단위로 지정하며 일정 시간 내 동일한 입력 신호가 반복적으로 입력되는 것을 무시하기 위한 설정입니다. \\
+슈프리마 장치가 타사 컨트롤러와 wiegand로 연결된 환경에서 \\
+특정 모델의 컨트롤러로부터 슈프리마 장치로 인증에 대한 피드백이 반복적으로 입력되는 경우 \\
+이 설정을 통해 해당 시간만큼 강제로 입력 신호가 무시되도록 지정할 수 있습니다. \\ \\
 ==== BS2Action ====
@@ 줄 1702: / 줄 1724: @@
     uint8_t unused;
-    uint8_t reserved[14];	///< 14 bytes (reserved)
+    uint8_t unableToSaveImageOfVisualFace;
+    uint8_t reserved[13];
 } BS2FaceConfig;
 </code>
 . //securityLevel// \\
 시스템 전반적으로 사용할 얼굴 인증 보안 레벨입니다. \\
@@ 줄 1788: / 줄 1812: @@
 [+ 2.6.4] true로 설정하면 중복된 얼굴 정보인지 판단합니다. \\ \\
 . //operationMode// \\
-[+ 2.7.1] ''FaceStation F2'' 아래의 동작 모드를 설정하며, 기본값은 Fusion 모드입니다. \\
+[+ 2.7.1] ''FaceStation F2 V1.0.1''미만은 아래의 동작 모드로 설정가능하며, 기본값은 Fusion 모드입니다. \\
 <WRAP group 50%>
 ^값  ^모드  ^설명  ^기본값  ^
@@ 줄 1794: / 줄 1818: @@
 |1  |Visual 모드 |Visual matching | |
 |2  |Visual + IR검출 |Visual matching, IR은 얼굴 검출만| |
+</WRAP>
+''FaceStation F2 V1.0.1''이상, ''BioStatoin 3'', ''BioEntry W3''는 아래와 같은 의미로 사용됩니다.
+<WRAP group 50%>
+^값  ^모드  ^설명  ^기본값  ^
+|0  |Fusion 모드 |Visual matching + IR matching |기본 |
+|1  |Fast 모드 |Visual matching | |
 </WRAP>
 . //maxRotation// \\
-[+ 2.7.1] ''FaceStation F2'' 얼굴 검출 시 보통은 정면 일 것입니다. \\
+[+ 2.7.1] ''FaceStation F2'' 일반적인 상황에서 얼굴을 검출할 때 얼굴의 방향은 정면일 것입니다. \\
-하지만 FSF2는 얼굴 검출 시 정면에서 몇도 정도 회전된(외곡된) 이미지인지 판단이 가능합니다. \\
+FaceStation F2는 얼굴 검출 시 정면에서 어느 정도 회전된(왜곡된) 이미지인지 판단할 수 있습니다. \\
-이를 통해 일정 각도 이상 회전된 이미지의 경우 검출 실패 처리를 시킬 수 있습니다. \\
+이를 통해 일정 각도 이상 회전된 이미지의 경우 검출 실패 처리를 할 수 있습니다. \\
-maxRotation은 이경우의 최대 허용치를 나타내며, 기본값은 15도 입니다. \\ \\
+maxRotation은 이런 경우의 최대 허용치를 나타내며 기본값은 15도입니다. \\ \\
+[+ 2.9.6] Angle 추가 정의 \\
+<WRAP group 40%>
+^정의  ^값  ^
+|BS2_MAX_ROTATION_DEFAULT  | 15  |
+|BS2_MAX_ROTATION_ANGLE_15  | 15  |
+|BS2_MAX_ROTATION_ANGLE_30  | 30  |
+|BS2_MAX_ROTATION_ANGLE_45  | 45  |
+|BS2_MAX_ROTATION_ANGLE_60  | 60  |
+|BS2_MAX_ROTATION_ANGLE_75  | 75  |
+|BS2_MAX_ROTATION_ANGLE_90  | 90  |
+|BS2_MAX_ROTATION_ANGLE_MAX  | 90  |
+</WRAP>
 . //faceWidth// \\
-[+ 2.7.1] ''FaceStation F2'' 얼굴 이미지의 폭을 나타내며, 폭의 최소값, 최대값을 지정할 수 있습니다. \\
+[+ 2.7.1] ''FaceStation F2'' 얼굴 이미지의 폭을 나타내며 폭의 최소값, 최대값을 지정할 수 있습니다. \\
-최소값, 최대값은 아래의 값을 기본값으로 갖습니다. \\
+최소값, 최대값의 기본값은 아래와 같습니다. \\
-[+ 2.8.3] ''BioStation 3'' 해당 설정은 무시됩니다. \\
+<WRAP group 30%>
-<WRAP group 20%>
 ^  ^기본값(min)  ^기본값(max)  ^
 |FSF2  |66  |250  |
-|BS3  |-  |-  |
+|BS3  |130  |350  |
+|BEW3  |130  |350  |
 </WRAP>
 . //searchRange// \\
-[+ 2.7.1] ''FaceStation F2'' 얼굴 검색 범위를 나타내며, 범위의 x값(가로 좌표)과 x값 지점으로부터의 폭을 지정할 수 있습니다. \\
+[+ 2.7.1] ''FaceStation F2'' 얼굴 감지 범위를 나타내며 범위의 x값(가로 좌표)과 x값으로부터의 폭을 지정할 수 있습니다. \\
-x값과 폭은 아래의 값을 기본값으로 갖습니다. \\
+x값과 폭의 기본값은 아래와 같습니다. \\
-[+ 2.8.3] ''BioStation 3'' 해당 설정은 무시됩니다. \\
+<WRAP group 30%>
-<WRAP group 20%>
 ^  ^기본값(x)  ^기본값(width)  ^
 |FSF2  |144  |432  |
-|BS3  |-  |-  |
+|BS3  |90  |540  |
+|BEW3  |90  |540  |
 </WRAP>
 . //detectDistance// \\
 [+ 2.8.3] ''BioStation 3'' 얼굴 감지 거리의 최소값과 최대값을 설정합니다. \\
+[+ 2.9.6] ''FaceStation F2'' ''BioEntry W3'' 기능추가. \\
 픽셀 단위로 얼굴 위치를 지정하는 faceWidth는 사용하기 난해하므로 더 이상 사용하지 않습니다. \\
 대신 피사체(얼굴)의 감지 거리를 얼마로 할지 만 정합니다. 거리는 cm로 설정하며, 10의 배수로 입력하여야 합니다. \\
 <WRAP group 80%>
 ^  ^최소 감지거리의 최소값  ^최소 감지거리의 최대값  ^최소 감지거리(기본값)  ^최대 감지거리의 최소값  ^최대 감지거리의 최대값  ^최대 감지거리(무제한)  ^최대 감지거리(기본값)  ^
-|BS3  |30  |100  |60  |40  |100  |255  |100  |
+|FSF2 |30  |130  |30  |40  |130  |255  |130  |
+|BS3  |30  |100  |30  |40  |100  |255  |100  |
+|BEW3  |30  |100  |30  |40  |100  |255  |100  |
 </WRAP>
 . //wideSearch// \\
@@ 줄 1835: / 줄 1881: @@
 . //unused// \\
 예약된 공간입니다.\\ \\
-. //reserved// \\
+. //unableToSaveImageOfVisualFace// \\
+[+ 2.9.6] Visual face를 크리덴셜로 사용하는 장치에서 얼굴 이미지를 장치에 저장할 것인지를 나타냅니다. \\
+이 설정을 키면 장치 내 모든 사용자의 얼굴 정보 중 이미지 정보가 즉시 삭제되며 템플릿만 남게됩니다. \\
+또한, [[BS2_EnrollUserFaceEx]] API를 통해 사용자 이미지가 포함된 얼굴 정보를 가져오더라도 장치는 이를 무시하게됩니다. \\
+기본값은 false 이며, 얼굴과 이미지 모두 저장입니다. \\ \\
+. //reserved// \\
 예약된 공간입니다.\\ \\
@@ 줄 2430: / 줄 2481: @@
     uint8_t treatAsCSN;
-    uint8_t reserved[12];
+    uint8_t useVisualBarcode;
+    uint8_t motionSensitivity;
+    uint8_t visualCameraScanTimeout;
+    uint8_t reserved[9];
 } BS2BarcodeConfig;
 </code>
 . //useBarcode// \\
+''XS2-QR 만 지원''
 Barcode 사용여부 flag입니다. \\ \\
 . //scanTimeout// \\
 Barcode scan 시간을 설정합니다. 단위는 초입니다. \\
 기본값은 4초이며, 4~10초 범위 내로 입력 가능합니다. \\ \\
+<WRAP group 50%>
+^값  ^매크로  ^설명  ^
+|4  |BS2_BARCODE_TIMEOUT_DEFAULT  |기본값  |
+|4  |BS2_BARCODE_TIMEOUT_MIN  |최소값  |
+|10  |BS2_BARCODE_TIMEOUT_MAX  |최대값  |
+</WRAP>
 . //bypassData// \\
 [+2.8.2] 읽혀진 barcode 정보를 장치에서 처리하지 않고, 서버로 전송하기 위해 사용합니다. \\
@@ 줄 2450: / 줄 2511: @@
 따라서, 특수문자, 영문자가 들어있는 barcode 카드 데이터를 설정하고자 하면 오류를 반환할 수 있습니다. \\
 이 경우, card type만 다르게, CSN 카드와 barcode 데이터를 동일한 값으로 사용하고자하는 사용자의 목적에 부합할 수 있습니다. \\ \\
-. //reserved// \\
+. //useVisualBarcode// \\
+[+ 2.9.1] Visual barcode 사용여부 flag입니다. \\
+<WRAP group 50%>
+^지원장치  ^펌웨어  ^
+|XS2-Finger  |V1.2.0  |
+|XS2-Card  |V1.2.0  |
+|BS3  |V1.1.0  |
+</WRAP>
+Visual barcode는 QR code sensor가 아닌, 일반 visual camera를 통해 QR code 읽기를 지원하며, \\
+이 기능을 사용하기 위해서는, 별도의 라이선스 활성화가 필요합니다. \\
+라이선스 활성화는 [[BS2_EnableDeviceLicense]]를 통해 지원합니다. \\ \\
+. //motionSensitivity// \\
+[+ 2.9.1] Visual barcode에 대한, 모션 센서의 감도를 설정합니다. \\
+<WRAP group 50%>
+^값  ^매크로  ^설명  ^
+|0  |BS2_MOTION_SENSITIVITY_LOW  |낮음  |
+|1  |BS2_MOTION_SENSITIVITY_NORMAL  |중간  |
+|2  |BS2_MOTION_SENSITIVITY_HIGH  |높음  |
+</WRAP>
+. //visualCameraScanTimeout// \\
+[+ 2.9.1] Visual camera에대한 scan 시간을 설정합니다. 단위는 초입니다. \\
+기본값은 10초이며, 3~20초 범위 내로 입력 가능합니다. \\
+<WRAP group 50%>
+^값  ^매크로  ^설명  ^
+|10  |BS2_VISUAL_BARCODE_TIMEOUT_DEFAULT  |기본값  |
+|3  |BS2_VISUAL_BARCODE_TIMEOUT_MIN  |최소값  |
+|20  |BS2_VISUAL_BARCODE_TIMEOUT_MAX  |최대값  |
+</WRAP>
+. //reserved// \\
 예약된 공간입니다. \\
 ==== BS2InputConfigEx ====
 <code cpp>
@@ 줄 2814: / 줄 2902: @@
 이 경우, card type만 다르게, CSN 카드와 barcode 데이터를 동일한 값으로 사용하고자하는 사용자의 목적에 부합할 수 있습니다. \\ \\
 . //useVisualBarcode// \\
-[+2.8.4] Visual barcode 사용여부 flag입니다. \\
+[+ 2.9.1] Visual barcode 사용여부 flag입니다. \\
 <WRAP group 50%>
 ^지원장치  ^펌웨어  ^
@@ 줄 2823: / 줄 2911: @@
 Visual barcode는 QR code sensor가 아닌, 일반 visual camera를 통해 QR code 읽기를 지원하며, \\
 이 기능을 사용하기 위해서는, 별도의 라이선스 활성화가 필요합니다. \\
-라이선스 활성화는 [[qr_code_api#BS2_EnableBarcodeLicense]]를 통해 지원합니다. \\ \\
+라이선스 활성화는 [[BS2_EnableDeviceLicense]]를 통해 지원합니다. \\ \\
 . //motionSensitivity// \\
-[+2.8.4] Visual barcode에 대한, 모션 센서의 감도를 설정합니다. \\
+[+ 2.9.1] Visual barcode에 대한, 모션 센서의 감도를 설정합니다. \\
 <WRAP group 50%>
 ^값  ^매크로  ^설명  ^
@@ 줄 2833: / 줄 2921: @@
 </WRAP>
 . //visualCameraScanTimeout// \\
-[+2.8.4] Visual camera에대한 scan 시간을 설정합니다. 단위는 초입니다. \\
+[+ 2.9.1] Visual camera에대한 scan 시간을 설정합니다. 단위는 초입니다. \\
 기본값은 10초이며, 3~20초 범위 내로 입력 가능합니다. \\
 <WRAP group 50%>
@@ 줄 3069: / 줄 3157: @@
 . //actions// \\
 OSDP 장치에 대한 LED/buzzer 정보이며, 최대 32개 까지 지정할 수 있습니다. \\ \\
+==== BS2CustomMifareCard ====
+<code cpp>
+typedef struct {
+	uint8_t primaryKey[6];
+	uint8_t reserved1[2];
+	uint8_t secondaryKey[6];
+	uint8_t reserved2[2];
+	uint16_t startBlockIndex;
+	uint8_t dataSize;
+	uint8_t skipBytes;
+	uint8_t reserved[4];
+} BS2CustomMifareCard;
+</code>
+. //primaryKey// \\
+Mifare card 정보에 접근하기 위한 첫번째 암호화 키입니다. \\ \\
+. //reserved1// \\
+예약된 공간입니다.\\ \\
+. //secondaryKey// \\
+Mifare card 정보에 접근하기 위한 두번째 암호화 키입니다. \\ \\
+. //reserved2// \\
+예약된 공간입니다.\\ \\
+. //startBlockIndex// \\
+Mifare data storage에서의 start block index입니다.\\ \\
+. //dataSize// \\
+카드 데이터가 몇 byte의 크기를 갖는지를 나타냅니다. \\ \\
+. //skipBytes// \\
+카드 데이터가 나타나는 위치를 의미합니다. \\
+카드 데이터를 읽어들일 시작점 입니다. 처음부터 읽을경우 0이고, 첫번째 이후일 경우 건너뛴 byte 수를 나타냅니다. \\ \\
+. //reserved// \\
+예약된 공간입니다.\\ \\
+==== BS2CustomDesFireCard ====
+<code cpp>
+typedef struct {
+	uint8_t primaryKey[16];
+	uint8_t secondaryKey[16];
+	uint8_t appID[3];
+	uint8_t fileID;
+	uint8_t encryptionType;                 // 0: DES/3DES, 1: AES
+	uint8_t operationMode;                  // 0: legacy(use picc master key), 1: new mode(use app master, file read, file write key)
+	uint8_t dataSize;
+	uint8_t skipBytes;
+	uint8_t reserved[4];
+	BS2DesFireAppLevelKey desfireAppKey;		///<52 bytes
+} BS2CustomDesFireCard;                           ///<96 Bytes
+</code>
+. //primaryKey// \\
+DesFire card 정보에 접근하기 위한 첫번째 암호화 키입니다. (일반설정) \\ \\
+. //secondaryKey// \\
+DesFire card 정보에 접근하기 위한 두번째 암호화 키입니다. (일반설정) \\ \\
+. //appID// \\
+사용자 인증을 위해 DESFire 카드내에 내장된 사용할 애플리케이션 식별자입니다.\\ \\
+. //fileID// \\
+DESFire 카드내에 내장된 사용할 애플리케이션이 데이터를 읽고 쓰기 위한 파일 식별자입니다.\\ \\
+. //encryptionType// \\
+데이터 암호화 방식을 나타냅니다.\\
+<WRAP group 50%>
+^값  ^설명  ^
+|0  |DES/3DES  |
+|1  |AES  |
+</WRAP>
+. //operationMode// \\
+운영 방식을 지정합니다. \\
+<WRAP group 50%>
+^값  ^설명  ^
+|0  |일반설정 사용 (PICC master key를 사용)  |
+|1  |고급설정 사용 (App master key를 사용)  |
+</WRAP>
+. //dataSize// \\
+카드 데이터가 몇 byte의 크기를 갖는지를 나타냅니다. \\ \\
+. //skipBytes// \\
+카드 데이터가 나타나는 위치를 의미합니다. \\
+카드 데이터를 읽어들일 시작점 입니다. 처음부터 읽을경우 0이고, 첫번째 이후일 경우 건너뛴 byte 수를 나타냅니다. \\ \\
+. //reserved// \\
+예약된 공간입니다.\\ \\
+. //desfireAppKey// \\
+DesFire card 정보에 접근하기 위한 키 정보를 나타냅니다. (고급설정) \\ \\
+==== BS2CustomCardConfig ====
+<code cpp>
+typedef struct {
+	BS2_CARD_DATA_TYPE dataType;
+	BS2_BOOL useSecondaryKey;
+	uint8_t reserved1[2];
+	BS2CustomMifareCard mifare;
+	BS2CustomDesFireCard desfire;
+	uint8_t reserved2[24];
+	uint8_t reserved3[96];
+	BS2_CARD_BYTE_ORDER smartCardByteOrder;
+	uint8_t reserved4[3];
+	BS2_UID formatID;
+	uint8_t reserved5[8];
+} BS2CustomCardConfig;
+</code>
+. //dataType// \\
+Card의 데이터 유형입니다. \\
+<WRAP group 50%>
+^값  ^설명  ^
+|0  |바이너리  |
+|1  |아스키  |
+|2  |UTF16  |
+|3  |BCD  |
+</WRAP>
+. //useSecondaryKey// \\
+두번째 암호화 키 사용 유무를 결정하는 flag입니다. \\ \\
+. //reserved1// \\
+예약된 공간입니다. \\ \\
+. //mifare// \\
+Mifare custom card 정보를 설정합니다. \\ \\
+. //desfire// \\
+DESFire custom card 정보를 설정합니다. \\ \\
+. //reserved2// \\
+예약된 공간입니다. \\ \\
+. //reserved3// \\
+예약된 공간입니다. \\ \\
+. //smartCardByteOrder// \\
+MSB 또는 LSB로 출력을 지정할 수 있습니다. \\
+<WRAP group 50%>
+^값  ^설명  ^
+|0  |MSB  |
+|1  |LSB  |
+</WRAP>
+. //reserved4// \\
+예약된 공간입니다. \\ \\
+. //formatID// \\
+BioStar 2 애플리케이션에서 card configuration을 데이터베이스 관리할 필요가 있을 경우 사용할 수 있는 식별자입니다. \\ \\
+. //reserved5// \\
+예약된 공간입니다. \\ \\