차이
문서의 선택한 두 판 사이의 차이를 보여줍니다.
| 양쪽 이전 판 이전 판 다음 판 | 이전 판 | ||
|
ko:configuration_api [2024/05/28 19:34] kkshin [BS2FaceConfigExt] |
ko:configuration_api [2024/10/24 14:24] (현재) |
||
|---|---|---|---|
| 줄 389: | 줄 389: | ||
| uint8_t showOsdpResult; | uint8_t showOsdpResult; | ||
| uint8_t reserved1[30]; | uint8_t reserved1[30]; | ||
| + | BS2_SHOW_OSDP_RESULT showOsdpResult; ///< 1 byte | ||
| + | | ||
| + | BS2_AUTHMSG_USERINFO authMsgUserName; ///< 1 byte | ||
| + | BS2_AUTHMSG_USERINFO authMsgUserId; ///< 1 byte | ||
| + | | ||
| + | BS2_SCRAMBLE_KEYBOARD_MODE scrambleKeyboardMode ; ///< 1 byte | ||
| + | | ||
| + | uint8_t reserved3[27]; ///< 27 bytes (padding) | ||
| } BS2DisplayConfig; | } BS2DisplayConfig; | ||
| </code> | </code> | ||
| 줄 503: | 줄 511: | ||
| </WRAP> | </WRAP> | ||
| 19. //reserved1// \\ | 19. //reserved1// \\ | ||
| - | 예약된 공간입니다. \\ | + | 예약된 공간입니다. \\ \\ |
| + | 20. //authMsgUserName// \\ | ||
| + | [+2.9.8] 장치 화면에 표시되는 인증 결과 메시지에 포함된 사용자 이름의 표시 방법을 설정합니다. \\ | ||
| + | <WRAP group 50%> | ||
| + | ^값 ^설명 ^ | ||
| + | |0 |전체 표시 | | ||
| + | |1 |첫 문자만 표시 | | ||
| + | |2 |표시 안함 | | ||
| + | </WRAP> | ||
| + | 21. //authMsgUserID// \\ | ||
| + | [+2.9.8] 장치 화면에 표시되는 인증 결과 메시지에 포함된 사용자 ID의 표시 방법을 설정합니다. \\ | ||
| + | <WRAP group 50%> | ||
| + | ^값 ^설명 ^ | ||
| + | |0 |전체 표시 | | ||
| + | |1 |첫 문자만 표시 | | ||
| + | |2 |표시 안함 | | ||
| + | </WRAP> | ||
| + | 22. //scrambleKeyboardMode// \\ | ||
| + | [+2.9.8] 스크램블 키패드의 사용 여부를 설정합니다. \\ | ||
| + | <WRAP group 50%> | ||
| + | ^값 ^설명 ^ | ||
| + | |0 |사용 | | ||
| + | |1 |사용 안함 | | ||
| + | </WRAP> | ||
| ==== BS2IpConfig ==== | ==== BS2IpConfig ==== | ||
| <code cpp> | <code cpp> | ||
| 줄 911: | 줄 941: | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| ^값 ^설명 ^ | ^값 ^설명 ^ | ||
| - | |0 |사용안함 | | ||
| |1 |Master | | |1 |Master | | ||
| |2 |Slave | | |2 |Slave | | ||
| 줄 1117: | 줄 1146: | ||
| uint8_t numInputs; | uint8_t numInputs; | ||
| uint8_t numSupervised; | uint8_t numSupervised; | ||
| - | uint16_t reseved; | + | union { |
| + | uint16_t value; | ||
| + | struct { | ||
| + | uint16_t tamperAuxIndex : 4; | ||
| + | uint16_t acFailAuxIndex : 4; | ||
| + | uint16_t aux0Type : 1; | ||
| + | uint16_t aux1Type : 1; | ||
| + | uint16_t reserved : 6; | ||
| + | } field; | ||
| + | } aux; | ||
| struct { | struct { | ||
| uint8_t portIndex; | uint8_t portIndex; | ||
| 줄 1157: | 줄 1195: | ||
| |255 |사용자 정의 | | |255 |사용자 정의 | | ||
| </WRAP> | </WRAP> | ||
| - | 12. //reserved// \\ | + | 12. //aux// \\ |
| - | 예약된 공간입니다. \\ \\ | + | [+2.9.8] Aux의 동작을 설정합니다. |
| + | <WRAP group 70%> | ||
| + | ^비트위치 ^비트 수 ^멤버명 ^설명 ^ | ||
| + | |0 |4 |tamperAuxIndex |Tamper로 사용할 Aux 번호 (0:None, 1:Aux0, 2:Aux1) | | ||
| + | |7 |4 |acFailAuxIndex |AC Fail로 사용할 Aux 번호 (0:None, 1:Aux0, 2:Aux1) | | ||
| + | |8 |1 |aux0Type |Aux 0의 타입 (0: NO, 1:NC) | | ||
| + | |9 |1 |aux1Type |Aux 1의 타입 (0: NO, 1:NC) | | ||
| + | |10 |6 |reserved |예약된 공간 | | ||
| + | </WRAP> | ||
| 13. //config// \\ | 13. //config// \\ | ||
| supervised 입력 신호 유형을 판단하는 설정값으로, supervised input의 저항값이 사용자 정의일 경우에만 의미가 있습니다. \\ | supervised 입력 신호 유형을 판단하는 설정값으로, supervised input의 저항값이 사용자 정의일 경우에만 의미가 있습니다. \\ | ||
| 줄 1929: | 줄 1975: | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| ^값 ^설명 ^ | ^값 ^설명 ^ | ||
| - | |0 |사용안함 | | ||
| |1 |Master | | |1 |Master | | ||
| |2 |Slave | | |2 |Slave | | ||
| |3 |Standalone | | |3 |Standalone | | ||
| + | </WRAP> | ||
| + | <WRAP info> | ||
| + | CoreStation은 Master로만 사용 가능합니다. 다른 값은 설정할 수 없습니다. | ||
| </WRAP> | </WRAP> | ||
| 7. //numOfChannels// \\ | 7. //numOfChannels// \\ | ||
| 줄 2376: | 줄 2424: | ||
| 2. //maskCheckMode// \\ | 2. //maskCheckMode// \\ | ||
| ''Visual Face 기반'' 마스크 착용 감지 모드를 설정합니다. \\ | ''Visual Face 기반'' 마스크 착용 감지 모드를 설정합니다. \\ | ||
| - | HARD로 설정 시, maskDetectionLevel에 근거하여 착용 위반이 감지되면, 출입에 영향을 주게됩니다. \\ | + | HARD로 설정 시 maskDetectionLevel에 따라 마스크 착용 위반이 감지될 경우 출입에 영향을 주게됩니다. \\ |
| - | SOFT로 설정 시, maskDetectionLevel에 근거하여 착용 위반이 감지되면, 근거를 로그를 남기고 출입에 영향을 주지 않습니다. \\ | + | SOFT로 설정 시 maskDetectionLevel에 따라 마스크 착용 위반이 감지될 경우 로그가 기록되고 출입에는 영향을 주지 않습니다. \\ |
| - | maskCheckMode가 사용안함(0)으로 설정되면, \\ | + | maskCheckMode가 사용안함(0)으로 설정되면, maskDetectionLevel의 설정은 무시됩니다. \\ |
| - | maskDetectionLevel 의 설정은 무시됩니다. \\ | + | 또한 useRejectSound의 마스크 착용으로 인한 소리 발생과 faceCheckOrder의 마스크 착용 감지가 무시됩니다. \\ |
| - | 그리고 useRejectSound의 마스크 착용으로 인한 sound발생이, faceCheckOrder의 마스크 착용 감지가 무시됩니다. \\ | + | [+2.9.8] 마스크 착용 금지(3)는 Mask Check Mode가 Check Before Authentication 인 경우만 설정 가능하며, maskDetectionLevel에 따라 마스크를 착용한 사용자는 인증이 실패됩니다. 이 옵션은 [[device_api#bs2devicecapabilities|BS2DeviceCapabilities - authDenyMaskSupported]]를 지원하는 장치만 사용할 수 있습니다. \\ |
| <WRAP group 50%> | <WRAP group 50%> | ||
| ^값 ^설명 ^기본값 ^ | ^값 ^설명 ^기본값 ^ | ||
| 줄 2386: | 줄 2434: | ||
| |1 |마스크 착용 감지 사용 (HARD) | | | |1 |마스크 착용 감지 사용 (HARD) | | | ||
| |2 |마스크 착용 감지 사용 (SOFT) | | | |2 |마스크 착용 감지 사용 (SOFT) | | | ||
| + | |3 |마스크 착용 금지 | | | ||
| </WRAP> | </WRAP> | ||
| 3. //reserved// \\ | 3. //reserved// \\ | ||
| 줄 2700: | 줄 2749: | ||
| BS2ExtensionNumber phonebook[128]; | BS2ExtensionNumber phonebook[128]; | ||
| - | uint8_t reserved2[32]; ///< 32 bytes (reserved) | + | uint8_t resolution; |
| + | uint8_t transport; | ||
| + | uint8_t reserved2[30]; ///< 30 bytes (reserved) | ||
| } BS2VoipConfigExt; | } BS2VoipConfigExt; | ||
| </code> | </code> | ||
| 줄 2754: | 줄 2805: | ||
| 22. //phonebook// \\ | 22. //phonebook// \\ | ||
| 128개까지 내선 번호들을 전화번호부로 지정할 수 있습니다. \\ \\ | 128개까지 내선 번호들을 전화번호부로 지정할 수 있습니다. \\ \\ | ||
| - | 23. //reserved2// \\ | + | 23. //resolution// \\ |
| + | [+2.9.8] 송신 비디오 해상도를 설정합니다. | ||
| + | <WRAP group 50%> | ||
| + | ^값 ^설명 ^ | ||
| + | |0 |360 x 640 | | ||
| + | |1 |720 x 480 | | ||
| + | </WRAP> | ||
| + | 24. //transport// \\ | ||
| + | [+2.9.8] 데이터 전송 방식을 설정합니다. | ||
| + | <WRAP group 50%> | ||
| + | ^값 ^설명 ^ | ||
| + | |0 |UDP | | ||
| + | |1 |TCP | | ||
| + | |2 |SSL | | ||
| + | </WRAP> | ||
| + | 25. //reserved2// \\ | ||
| 예약된 공간입니다. \\ \\ | 예약된 공간입니다. \\ \\ | ||
| 줄 2768: | 줄 2834: | ||
| BS2_PORT port; | BS2_PORT port; | ||
| BS2_BOOL enabled; | BS2_BOOL enabled; | ||
| - | uint8_t reserved; | + | uint8_t reserved; ///< 1 byte (packing) |
| - | + | ||
| - | uint8_t reserved2[32]; | + | uint8_t resolution; |
| + | uint8_t reserved2[31]; ///< 31 bytes (reserved) | ||
| } BS2RtspConfig; | } BS2RtspConfig; | ||
| </code> | </code> | ||
| 줄 2785: | 줄 2852: | ||
| 6. //reserved// \\ | 6. //reserved// \\ | ||
| 예약된 공간입니다. \\ \\ | 예약된 공간입니다. \\ \\ | ||
| - | 7. //reserved2// \\ | + | 7. //resolution// \\ |
| + | [+2.9.8] 송신 비디오 해상도를 설정합니다. | ||
| + | <WRAP group 30%> | ||
| + | ^값 ^설명 ^ | ||
| + | |0 |180 x 320 | | ||
| + | |1 |720 x 480 | | ||
| + | </WRAP> | ||
| + | 8. //reserved2// \\ | ||
| 예약된 공간입니다. \\ \\ | 예약된 공간입니다. \\ \\ | ||
| 줄 2857: | 줄 2931: | ||
| 5. //reserved1// \\ | 5. //reserved1// \\ | ||
| 예약된 공간입니다. \\ \\ | 예약된 공간입니다. \\ \\ | ||
| - | |||
| - | |||
| - | ==== BS2BarcodeConfig ==== | ||
| - | <code cpp> | ||
| - | typedef struct { | ||
| - | uint8_t useBarcode; | ||
| - | uint8_t scanTimeout; | ||
| - | uint8_t bypassData; | ||
| - | uint8_t treatAsCSN; | ||
| - | |||
| - | uint8_t useVisualBarcode; | ||
| - | uint8_t motionSensitivity; | ||
| - | uint8_t visualCameraScanTimeout; | ||
| - | uint8_t reserved[9]; | ||
| - | } BS2BarcodeConfig; | ||
| - | </code> | ||
| - | 1. //useBarcode// \\ | ||
| - | ''XS2-QR 만 지원'' | ||
| - | Barcode 사용여부 flag입니다. \\ \\ | ||
| - | 2. //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> | ||
| - | 3. //bypassData// \\ | ||
| - | [+2.8.2] 읽혀진 barcode 정보를 장치에서 처리하지 않고, 서버로 전송하기 위해 사용합니다. \\ | ||
| - | 사용자 인증을 위해 사용자 정보 구조체에 barcode 값을 저장하게되는 경우, \\ | ||
| - | 32 byte의 크기 제약([[smartcard_api#BS2CSNCard|BS2CSNCard data 참조]])이 있으나, \\ | ||
| - | [[BS2_SetBarcodeScanListener]]를 호출하고, 이 옵션을 사용하면 최대 512 byte크기의 barcode를 서버로 전송할 수 있습니다. \\ \\ | ||
| - | 4. //treatAsCSN// \\ | ||
| - | [+2.8.2] Barcode를 일반 CSN 카드와 동일하게 처리할지의 여부를 나타냅니다. \\ | ||
| - | XS2-QR 1.1.3부터 적용되며, false의 경우, 이전과 동일하게 처리됩니다. \\ | ||
| - | 이방식은 barcode로 처리될 수 있는 문자셋을 ASCII code 32에서 126까지 자유롭게 지정할 수 있습니다. ([[qr_code_api#BS2_WriteQRCode|BS2_WriteQRCode의 설명 참조]]) \\ | ||
| - | true로 설정하면, barcode를 기존 CSN과 동일하게 숫자로만 취급하게 됩니다. \\ | ||
| - | 따라서, 특수문자, 영문자가 들어있는 barcode 카드 데이터를 설정하고자 하면 오류를 반환할 수 있습니다. \\ | ||
| - | 이 경우, card type만 다르게, CSN 카드와 barcode 데이터를 동일한 값으로 사용하고자하는 사용자의 목적에 부합할 수 있습니다. \\ \\ | ||
| - | 5. //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]]를 통해 지원합니다. \\ \\ | ||
| - | 6. //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> | ||
| - | 7. //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> | ||
| - | 8. //reserved// \\ | ||
| - | 예약된 공간입니다. \\ | ||