차이

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

차이 보기로 링크

양쪽 이전 판 이전 판
다음 판
이전 판
다음 판 양쪽 다음 판
ko:configuration_api [2022/04/12 16:12]
kkshin [BS2BarcodeConfig]
ko:configuration_api [2022/08/24 19:52]
kkshin [BS2FaceConfig]
줄 70: 줄 70:
   * [[BS2_GetDesFireCardConfigEx]]:​ [+ 2.6.4] DesFire 카드 고급설정 정보를 가져옵니다.   * [[BS2_GetDesFireCardConfigEx]]:​ [+ 2.6.4] DesFire 카드 고급설정 정보를 가져옵니다.
   * [[BS2_SetDesFireCardConfigEx]]:​ [+ 2.6.4] DesFire 카드 고급설정 정보를 저장합니다.   * [[BS2_SetDesFireCardConfigEx]]:​ [+ 2.6.4] DesFire 카드 고급설정 정보를 저장합니다.
-  * [[BS2_GetAuthConfigExt]]:​ [+ 2.7.1] ''​FaceStation F2''​ 인증 설정 정보를 가져옵니다. +  * [[BS2_GetAuthConfigExt]]:​ [+ 2.7.1] ''​FSF2''​ 인증 설정 정보를 가져옵니다. 
-  * [[BS2_SetAuthConfigExt]]:​ [+ 2.7.1] ''​FaceStation F2''​ 인증 설정 정보를 저장합니다. +  * [[BS2_SetAuthConfigExt]]:​ [+ 2.7.1] ''​FSF2''​ 인증 설정 정보를 저장합니다. 
-  * [[BS2_GetFaceConfigExt]]:​ [+ 2.7.1] ''​FaceStation F2FaceStation2''​ 열화상 감지와 마스크 착용 체크를 위한 설정 정보를 가져옵니다. +  * [[BS2_GetFaceConfigExt]]:​ [+ 2.7.1] ''​FSF2FS2''​ 열화상 감지와 마스크 착용 체크를 위한 설정 정보를 가져옵니다. 
-  * [[BS2_SetFaceConfigExt]]:​ [+ 2.7.1] ''​FaceStation F2FaceStation2''​ 열화상 감지와 마스크 착용 체크를 위한 설정 정보를 저장합니다. +  * [[BS2_SetFaceConfigExt]]:​ [+ 2.7.1] ''​FSF2FS2''​ 열화상 감지와 마스크 착용 체크를 위한 설정 정보를 저장합니다. 
-  * [[BS2_GetThermalCameraConfig]]:​ [+ 2.7.1] ''​FaceStation F2FaceStation2''​ 열화상 카메라 설정을 가져옵니다. +  * [[BS2_GetThermalCameraConfig]]:​ [+ 2.7.1] ''​FSF2FS2''​ 열화상 카메라 설정을 가져옵니다. 
-  * [[BS2_SetThermalCameraConfig]]:​ [+ 2.7.1] ''​FaceStation F2FaceStation2''​ 열화상 카메라 설정을 저장합니다. +  * [[BS2_SetThermalCameraConfig]]:​ [+ 2.7.1] ''​FSF2FS2''​ 열화상 카메라 설정을 저장합니다. 
-  * [[BS2_GetBarcodeConfig]]:​ [+ 2.8] ''​X-Station 2''​ Barcode 관련 설정을 가져옵니다. +  * [[BS2_GetBarcodeConfig]]:​ [+ 2.8] ''​XS2''​ Barcode 관련 설정을 가져옵니다. 
-  * [[BS2_SetBarcodeConfig]]:​ [+ 2.8] ''​X-Station 2''​ Barcode 관련 설정을 저장합니다.+  * [[BS2_SetBarcodeConfig]]:​ [+ 2.8] ''​XS2''​ Barcode 관련 설정을 저장합니다.
   * [[BS2_GetInputConfigEx]]:​ [+ 2.8.1] ''​IM-120''​ Input 관련 확장형 설정을 가져옵니다.   * [[BS2_GetInputConfigEx]]:​ [+ 2.8.1] ''​IM-120''​ Input 관련 확장형 설정을 가져옵니다.
   * [[BS2_SetInputConfigEx]]:​ [+ 2.8.1] ''​IM-120''​ Input 관련 확장형 설정을 저장합니다.   * [[BS2_SetInputConfigEx]]:​ [+ 2.8.1] ''​IM-120''​ Input 관련 확장형 설정을 저장합니다.
   * [[BS2_GetRelayActionConfig]]:​ [+ 2.8.1] ''​IM-120''​ RelayAction 관련 설정을 가져옵니다.   * [[BS2_GetRelayActionConfig]]:​ [+ 2.8.1] ''​IM-120''​ RelayAction 관련 설정을 가져옵니다.
   * [[BS2_SetRelayActionConfig]]:​ [+ 2.8.1] ''​IM-120''​ RelayAction 관련 설정을 저장합니다.   * [[BS2_SetRelayActionConfig]]:​ [+ 2.8.1] ''​IM-120''​ RelayAction 관련 설정을 저장합니다.
 +  * [[BS2_GetVoipConfigExt]]:​ [+ 2.8.3] ''​BS3''​ 확장형 VoIP 설정을 가져옵니다.
 +  * [[BS2_SetVoipConfigExt]]:​ [+ 2.8.3] ''​BS3''​ 확장형 VoIP 설정을 저장합니다.
 +  * [[BS2_GetRtspConfig]]:​ [+ 2.8.3] ''​BS3''​ RTSP 설정을 가져옵니다.
 +  * [[BS2_SetRtspConfig]]:​ [+ 2.8.3] ''​BS3''​ RTSP 설정을 저장합니다.
  
 ===== 구조체 ===== ===== 구조체 =====
줄 656: 줄 660:
     uint8_t formatID;     uint8_t formatID;
     uint8_t cipher;     uint8_t cipher;
-    uint8_t reserved[24];+    ​uint8_t smartCardByteOrder;​ 
 +    ​uint8_t reserved[22];
 } BS2CardConfig;​ } BS2CardConfig;​
 </​code>​ </​code>​
줄 728: 줄 733:
 |1  |활성화 ​ | |1  |활성화 ​ |
 </​WRAP>​ </​WRAP>​
-24. //reserved5// \\ +24. //smartCardByteOrder//​ \\ 
 +[+2.8.2] 이전까지 smart card의 data 영역에 쓰여진 카드정보는 MSB 방식으로 고정이었습니다. \\ 
 +이로인해 LSB 방식을 사용하는 일부 controller로의 연동시, byte 정보가 반전되어 전혀 다른값으로 출력되었습니다. \\ 
 +smartCardByteOrder 값으로, MSB/LSB 출력을 유연하게 변경할 수 있습니다. \\ 
 +<WRAP group 50%> 
 +^값  ^설명 ​ ^ 
 +|0  |MSB  | 
 +|1  |LSB  | 
 +</​WRAP>​ 
 +25. //reserved// \\ 
 예약된 공간입니다. \\  예약된 공간입니다. \\ 
 ==== BS2FingerprintConfig ==== ==== BS2FingerprintConfig ====
줄 1665: 줄 1679:
     uint8_t ​      ​maxRotation;​     uint8_t ​      ​maxRotation;​
  
 +    // Deprecated
     struct {     struct {
         uint16_t ​ min;         uint16_t ​ min;
줄 1670: 줄 1685:
     } faceWidth;     } faceWidth;
  
 +    // Deprecated
     struct {     struct {
         uint16_t ​ x;         uint16_t ​ x;
줄 1675: 줄 1691:
     } searchRange;​     } searchRange;​
  
-    uint8_t ​      reserved2[18];+    ​struct { 
 +        ​uint8_t ​min; // 30 ~ 100 
 +        uint8_t max; // 40 ~ 100, 255 
 +    } detectDistance;​ ////<​ 2 bytes 
 +     
 +    BS2_BOOL wideSearch;​ ///<​ 1 byte 
 +    uint8_t unused; 
 +     
 +    uint8_t reserved[14]; ///< 14 bytes (reserved)
 } BS2FaceConfig;​ } BS2FaceConfig;​
 </​code>​ </​code>​
줄 1693: 줄 1717:
 |1  |옥외 ​ | |1  |옥외 ​ |
 |2  |자동 ​ | |2  |자동 ​ |
-|3  |[+V2.8] 사용 안함 ''​(FaceStation F2)'' ​ |+|3  |[+ 2.8] 사용 안함 ''​(FaceStation F2)'' ​ |
 </​WRAP>​ </​WRAP>​
 3. //​enrollThreshold//​ \\  3. //​enrollThreshold//​ \\ 
줄 1735: 줄 1759:
 </​WRAP>​ </​WRAP>​
 6. //​lfdLevel//​ \\ 6. //​lfdLevel//​ \\
-[+ V2.6.3] 위조된 얼굴을 여과할 수 있는 민감도를 설정할 수 있습니다. \\+[+ 2.6.3] 위조된 얼굴을 여과할 수 있는 민감도를 설정할 수 있습니다. \\
 ''​FaceStation2,​ FaceLite''​ : 기본값은 0입니다. \\ ''​FaceStation2,​ FaceLite''​ : 기본값은 0입니다. \\
-''​FaceStation F2''​ : [+ V2.7.1] 기본값이 1입니다. \\+''​FaceStation F2''​ : [+ 2.7.1] 기본값이 1입니다. \\
 <WRAP group 50%> <WRAP group 50%>
 ^값  ^설명 ​ ^ ^값  ^설명 ​ ^
줄 1746: 줄 1770:
 </​WRAP>​ </​WRAP>​
 7. //​quickEnrollment//​ \\ 7. //​quickEnrollment//​ \\
-[+ V2.6.3] 빠른 얼굴 등록 사용 여부를 설정할 수 있습니다. \\+[+ 2.6.3] 빠른 얼굴 등록 사용 여부를 설정할 수 있습니다. \\
 이 값을 true로 설정하면 얼굴 등록 절차가 1단계로 설정되며,​ false로 설정할 경우 3단계로 설정됩니다. \\ 이 값을 true로 설정하면 얼굴 등록 절차가 1단계로 설정되며,​ false로 설정할 경우 3단계로 설정됩니다. \\
 고품질의 얼굴 템플릿을 등록하려면 false를 설정하십시오. \\ \\ 고품질의 얼굴 템플릿을 등록하려면 false를 설정하십시오. \\ \\
 8. //​previewOption//​ \\ 8. //​previewOption//​ \\
-[+ V2.6.3] IR 인증 가이드를 의미하며,​ 얼굴 인증 시 preview 화면 출력 설정을 변경할 수 있습니다. \\+[+ 2.6.3] IR 인증 가이드를 의미하며,​ 얼굴 인증 시 preview 화면 출력 설정을 변경할 수 있습니다. \\
 ''​FaceLite''​에서만 사용됩니다. \\ ''​FaceLite''​에서만 사용됩니다. \\
 <WRAP group 50%> <WRAP group 50%>
줄 1759: 줄 1783:
 </​WRAP>​ </​WRAP>​
 9. //​checkDuplicate//​ \\ 9. //​checkDuplicate//​ \\
-[+ V2.6.4] true로 설정하면 중복된 얼굴 정보인지 판단합니다. \\ \\+[+ 2.6.4] true로 설정하면 중복된 얼굴 정보인지 판단합니다. \\ \\
 10. //​operationMode//​ \\  10. //​operationMode//​ \\ 
-[+ V2.7.1] ''​FaceStation F2''​ 아래의 동작 모드를 설정하며,​ 기본값은 Fusion 모드입니다. \\ +[+ 2.7.1] ''​FaceStation F2''​ 아래의 동작 모드를 설정하며,​ 기본값은 Fusion 모드입니다. \\ 
 <WRAP group 50%> <WRAP group 50%>
 ^값  ^모드 ​ ^설명 ​ ^기본값 ​ ^ ^값  ^모드 ​ ^설명 ​ ^기본값 ​ ^
줄 1769: 줄 1793:
 </​WRAP> ​ </​WRAP> ​
 11. //​maxRotation//​ \\  11. //​maxRotation//​ \\ 
-[+ V2.7.1] ''​FaceStation F2''​ 얼굴 검출 시 보통은 정면 일 것입니다. \\+[+ 2.7.1] ''​FaceStation F2''​ 얼굴 검출 시 보통은 정면 일 것입니다. \\
 하지만 FSF2는 얼굴 검출 시 정면에서 몇도 정도 회전된(외곡된) 이미지인지 판단이 가능합니다. \\ 하지만 FSF2는 얼굴 검출 시 정면에서 몇도 정도 회전된(외곡된) 이미지인지 판단이 가능합니다. \\
 이를 통해 일정 각도 이상 회전된 이미지의 경우 검출 실패 처리를 시킬 수 있습니다. \\ 이를 통해 일정 각도 이상 회전된 이미지의 경우 검출 실패 처리를 시킬 수 있습니다. \\
 maxRotation은 이경우의 최대 허용치를 나타내며,​ 기본값은 15도 입니다. \\ \\ maxRotation은 이경우의 최대 허용치를 나타내며,​ 기본값은 15도 입니다. \\ \\
 12. //​faceWidth//​ \\  12. //​faceWidth//​ \\ 
-[+ V2.7.1] ''​FaceStation F2''​ 얼굴 이미지의 폭을 나타내며,​ 폭의 최소값, 최대값을 지정할 수 있습니다. \\ +[+ 2.7.1] ''​FaceStation F2''​ 얼굴 이미지의 폭을 나타내며,​ 폭의 최소값, 최대값을 지정할 수 있습니다. \\ 
 최소값, 최대값은 아래의 값을 기본값으로 갖습니다. \\ 최소값, 최대값은 아래의 값을 기본값으로 갖습니다. \\
 +[+ 2.8.3] ''​BioStation 3''​ 해당 설정은 무시됩니다. \\
 <WRAP group 20%> <WRAP group 20%>
-^  ^기본값 ​ ^ +^  ^기본값(min)  ^기본값(max) ​ ^ 
-|min  ​|66 ​ | +|FSF2  ​|66 ​ ​|250 ​ | 
-|max  |250  |+|BS3  |-  |-  |
 </​WRAP> ​ </​WRAP> ​
 13. //​searchRange//​ \\ 13. //​searchRange//​ \\
-[+ V2.7.1] ''​FaceStation F2''​ 얼굴 검색 범위를 나타내며,​ 범위의 x값(가로 좌표)과 x값 지점으로부터의 폭을 지정할 수 있습니다. \\ +[+ 2.7.1] ''​FaceStation F2''​ 얼굴 검색 범위를 나타내며,​ 범위의 x값(가로 좌표)과 x값 지점으로부터의 폭을 지정할 수 있습니다. \\ 
 x값과 폭은 아래의 값을 기본값으로 갖습니다. \\ x값과 폭은 아래의 값을 기본값으로 갖습니다. \\
 +[+ 2.8.3] ''​BioStation 3''​ 해당 설정은 무시됩니다. \\
 <WRAP group 20%> <WRAP group 20%>
-^  ^기본값 ​ ^ +^  ^기본값(x)  ^기본값(width) ​ ^ 
-| ​|144 ​ | +|FSF2  ​|144 ​ ​|432 ​ | 
-|width  |432  |+|BS3  |-  |-  |
 </​WRAP> ​ </​WRAP> ​
-14. //reserved2// \\ +14. //detectDistance//​ \\ 
 +[+ 2.8.3] ''​BioStation 3''​ 얼굴 감지 거리의 최소값과 최대값을 설정합니다. \\ 
 +픽셀 단위로 얼굴 위치를 지정하는 faceWidth는 사용하기 난해하므로 더 이상 사용하지 않습니다. \\ 
 +대신 피사체(얼굴)의 감지 거리를 얼마로 할지 만 정합니다. 거리는 cm로 설정하며,​ 10의 배수로 입력하여야 합니다. \\ 
 +<WRAP group 80%> 
 +^  ^최소 감지거리의 최소값 ​ ^최소 감지거리의 최대값 ​ ^최소 감지거리(기본값) ​ ^최대 감지거리의 최소값 ​ ^최대 감지거리의 최대값 ​ ^최대 감지거리(무제한) ​ ^최대 감지거리(기본값) ​ ^ 
 +|BS3  |30  |100  |60  |40  |100  |255  |100  | 
 +</​WRAP>​  
 +15. //​wideSearch//​ \\ 
 +[+ 2.8.3] ''​BioStation 3''​ 얼굴 감지 범위를 넓힙니다. \\ 
 +x좌표와 width를 지정해야하는 난해한 설정인 searchRange는 더 이상 사용하지 않습니다. \\ 
 +대신 얼굴 감지를 표준(false) 설정으로 할지, 광역(true)으로 할지 여부만 지정합니다. \\ 
 +광역으로 감지하는 범위에 대한 세부 설정은 장치 내부 설정 값을 따릅니다. 사용자는 이 값을 변경할 수 없습니다. \\ \\ 
 +이 설정 값이 켜지면(true) 카메라를 통해 넓은 범위의 피사체를 찾아내므로,​ 피사체가 여럿이 되는 경우 의도치 않은 인증으로 연결될 수 있습니다. \\ 
 +기본 설정 값은 false입니다. \\ \\ 
 +16. //unused// \\ 
 +예약된 공간입니다.\\ \\ 
 +17. //reserved// \\
 예약된 공간입니다.\\ \\ 예약된 공간입니다.\\ \\
  
줄 2396: 줄 2439:
 사용자 인증을 위해 사용자 정보 구조체에 barcode 값을 저장하게되는 경우, \\ 사용자 인증을 위해 사용자 정보 구조체에 barcode 값을 저장하게되는 경우, \\
 32 byte의 크기 제약([[smartcard_api#​BS2CSNCard|BS2CSNCard data 참조]])이 있으나, \\ 32 byte의 크기 제약([[smartcard_api#​BS2CSNCard|BS2CSNCard data 참조]])이 있으나, \\
-이 옵션을 사용하면 최대 512 byte크기의 barcode를 서버로 전송할 수 있습니다. \\ \\+[[BS2_SetBarcodeScanListener]]를 호출하고, ​이 옵션을 사용하면 최대 512 byte크기의 barcode를 서버로 전송할 수 있습니다. \\ \\
 4. //​treatAsCSN//​ \\ 4. //​treatAsCSN//​ \\
 [+2.8.2] Barcode를 일반 CSN 카드와 동일하게 처리할지의 여부를 나타냅니다. \\ [+2.8.2] Barcode를 일반 CSN 카드와 동일하게 처리할지의 여부를 나타냅니다. \\
줄 2528: 줄 2571:
 예약된 공간입니다. \\ \\ 예약된 공간입니다. \\ \\
 13. //​reserved2//​ \\ 13. //​reserved2//​ \\
 +예약된 공간입니다. \\ \\
 +
 +
 +==== BS2VoipConfigExt ====
 +<code cpp>
 +typedef struct {
 +    BS2_USER_ID phoneNumber;​
 +    char description[48 * 3];
 +
 +    uint8_t reserved[32];​
 +} BS2ExtensionNumber;​
 +
 +typedef struct {
 +    BS2_BOOL enabled;
 +    BS2_BOOL useOutboundProxy;​
 +    uint16_t registrationDuration;​
 +
 +    BS2_URL address;
 +    BS2_PORT port;
 +
 +    struct {
 +        uint8_t speaker;​ //​ 0 ~ 100
 +        uint8_t mic; // 0 ~ 100
 +    } volume;​ ///<​ 2 bytes
 +
 +    BS2_USER_ID id;
 +    BS2_USER_ID password;
 +    BS2_USER_ID authorizationCode;​
 +
 +    struct {
 +        BS2_URL address;
 +        BS2_PORT port;
 +        uint8_t reserved[2];​
 +    } outboundProxy;​
 +
 +    uint8_t exitButton; ​           /// *, #, 0~9
 +    uint8_t reserved1;
 +    uint8_t numPhoneBook;​
 +    BS2_BOOL showExtensionNumber;​
 +
 +    BS2ExtensionNumber phonebook[128];​
 +
 +    uint8_t reserved2[32]; ​       ///< 32 bytes (reserved)
 +} BS2VoipConfigExt;​
 +</​code>​
 +1. //​phoneNumber//​ \\ 
 +내선 번호입니다. \\ \\
 +2. //​description//​ \\
 +표시 정보입니다. \\ \\
 +3. //​reserved//​ \\
 +예약된 공간입니다. \\ \\
 +4. //enabled// \\
 +VoIP extension 기능을 사용할 것인지 여부를 설정합니다. \\ \\
 +5. //​useOutboundProxy//​ \\ 
 +Outbound 프록시 서버를 구성할 것인지 여부를 설정합니다. \\ \\
 +6. //​registrationDuration//​ \\
 +SIP 서버에 관련 정보를 업데이트 시키는 주기입니다. \\
 +초단위로 설정하며,​ 60~600 범위의 값으로 지정하여야 합니다. \\ \\
 +7. //address// \\ 
 +SIP 서버(일반적으로 BioStar)의 IP 주소를 입력합니다. \\ \\
 +8. //port// \\
 +SIP 서버 포트를 입력합니다. 기본 포트는 5060번입니다. \\ \\
 +9. //speaker// \\
 +인터폰의 스피커 음량 정보를 0에서 100까지 범위로 입력합니다. 기본 값은 50입니다. \\ \\
 +10. //mic// \\
 +인터폰의 마이크 음량 정보를 0에서 100까지 범위로 입력합니다. 기본 값은 50입니다. \\ \\
 +11. //id// \\
 +SIP 서버에 연결하는 ID를 입력합니다. \\
 +12. //​password//​ \\
 +SIP 서버에 연결하는 비밀번호를 지정합니다. \\ \\
 +13. //​authorizationCode//​ \\
 +SIP 서버에 연결에 필요한 인증코드 값입니다. \\ \\
 +14. //​outboundProxy//​ \\
 +Outbound 프록시 서버 정보를 입력합니다. \\ \\
 +15. //address// \\ 
 +Outbound 프록시 서버의 IP 주소를 입력합니다. \\ \\
 +16. //port// \\
 +Outbound 프록시 서버 포트를 입력합니다. \\ \\
 +17. //​reserved//​ \\
 +예약된 공간입니다. \\ \\
 +18. //​exitButton//​ \\
 +퇴실버튼으로 사용할 버튼 기호입니다. \\
 +<WRAP group 50%>
 +^값  ^설명 ​ ^
 +|*  |'​*'​ ASCII code 42  |
 +|#  |'#'​ ASCII code 35  |
 +|0~9  |'​0'​~'​9'​ ASCII code (48~57) ​ |
 +</​WRAP> ​
 +19. //​reserved1//​ \\
 +예약된 공간입니다. \\ \\
 +20. //​numPhoneBook//​ \\
 +전화번호부 갯수입니다. \\ \\
 +21. //​showExtensionNumber//​ \\
 +전화번호부를 보여줄지 여부를 결정합니다. \\ \\
 +22. //​phonebook//​ \\
 +128개까지 내선 번호들을 전화번호부로 지정할 수 있습니다. \\ \\
 +23. //​reserved2//​ \\
 +예약된 공간입니다. \\ \\
 +
 +
 +==== BS2RtspConfig ====
 +<code cpp>
 +typedef struct {
 +    BS2_USER_ID id;
 +    BS2_USER_ID password;
 +
 +    BS2_URL address;
 +
 +    BS2_PORT port;
 +    BS2_BOOL enabled;
 +    uint8_t reserved;
 +
 +    uint8_t reserved2[32];​
 +} BS2RtspConfig;​
 +</​code>​
 +1. //id// \\
 +RTSP 서버 연결시, 계정 정보입니다. \\ \\
 +2. //​password//​ \\
 +RTSP 서버 연결시, 비밀번호입니다. \\ \\
 +3. //address// \\ 
 +RTSP 서버의 주소를 입력합니다. \\ \\
 +4. //port// \\
 +RTSP 서버 연결 포트를 입력합니다. 기본 포트는 554입니다. \\ \\
 +5. //enabled// \\
 +RTSP 연결을 사용할 것인지 여부를 설정합니다. \\ \\
 +6. //​reserved//​ \\
 +예약된 공간입니다. \\ \\
 +7. //​reserved2//​ \\
 예약된 공간입니다. \\ \\ 예약된 공간입니다. \\ \\