Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
en:configuration_api [2020/08/28 13:18] yjjung [BS2FaceConfig] |
en:configuration_api [2020/09/04 14:14] yjjung [BS2ThermalCameraConfig] |
||
---|---|---|---|
Line 2016: | Line 2016: | ||
8. //reserved// \\ | 8. //reserved// \\ | ||
Reserved space. \\ | 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> | ||
+ | 2. //useGlobalAPB// \\ | ||
+ | This flag determines whether to enable Global APB zone. \\ \\ | ||
+ | 3. //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> | ||
+ | 4. //useGroupMatching// \\ | ||
+ | Enables facial group matching. \\ \\ | ||
+ | 5. //reserved// \\ | ||
+ | Reserved space. \\ \\ | ||
+ | 6. //reserved2// \\ | ||
+ | Reserved space. \\ \\ | ||
+ | 7. //usePrivateAuth// \\ | ||
+ | Enable private authentication mode. \\ \\ | ||
+ | 8. //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> | ||
+ | 9. //useServerMatching// \\ | ||
+ | Enable server matching for fingerprint matching or facial matching. \\ \\ | ||
+ | 10. //useFullAccess// \\ | ||
+ | This parameter is not in use. \\ \\ | ||
+ | 11. //matchTimeout// \\ | ||
+ | 지문 인증이나 얼굴 인식에서 최대 응답 시간이며 단위는 초(sec)를 사용합니다. \\ \\ | ||
+ | 12. //authTimeout// \\ | ||
+ | 사용자 인증의 최대 응답 시간이며 단위는 초(sec)를 사용합니다. \\ \\ | ||
+ | 13. //numOperators// \\ | ||
+ | 사용자 권한을 정의하는 operator의 개수입니다. \\ \\ | ||
+ | 14. //reserved3// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 15. //userID// \\ | ||
+ | 사용자 식별자입니다. \\ \\ | ||
+ | 16. //level// \\ | ||
+ | 사용자가 인증되었을 때 식별자에 해당하는 권한을 지정합니다. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^값 ^설명 ^ | ||
+ | |0 |권한 없음 | | ||
+ | |1 |관리자 권한 | | ||
+ | |2 |시스템 구성을 변경할 수 있는 권한 | | ||
+ | |3 |사용자 정보를 변경할 수 있는 권한 | | ||
+ | </WRAP> | ||
+ | <WRAP alert> | ||
+ | **주의**\\ | ||
+ | Operator 추가 시, 추가하고자 하는 operator의 수를 **//numOperators//** 필드의 값으로 지정해야 합니다. | ||
+ | </WRAP> | ||
+ | 17. //reserved// \\ | ||
+ | 예약된 공간입니다. \\ | ||
+ | 18. //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> | ||
+ | 1. //thermalCheckMode// \\ | ||
+ | 열화상 감지 모드를 설정합니다. \\ | ||
+ | HARD로 설정 시, 고열의 기준인 thermalThreshold를 초과하면, 출입에 영향을 주게됩니다. \\ | ||
+ | SOFT로 설정 시, 고열의 기준인 thermalThreshold를 초과하면, 근거를 로그를 남기고 출입에 영향을 주지 않습니다. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^값 ^설명 ^기본값 ^ | ||
+ | |0 |열화상 감지 사용 안함 |기본값 | | ||
+ | |1 |열화상 감지 사용 (HARD) | | | ||
+ | |2 |열화상 감지 사용 (SOFT) | | | ||
+ | </WRAP> | ||
+ | 2. //maskCheckMode// \\ | ||
+ | ''FaceStation F2'' 마스크 착용 감지 모드를 설정합니다. \\ | ||
+ | ''FaceStation 2'' 이 설정은 무시됩니다. \\ | ||
+ | HARD로 설정 시, maskDetectionLevel에 근거하여 착용 위반이 감지되면, 출입에 영향을 주게됩니다. \\ | ||
+ | SOFT로 설정 시, maskDetectionLevel에 근거하여 착용 위반이 감지되면, 근거를 로그를 남기고 출입에 영향을 주지 않습니다. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^값 ^설명 ^기본값 ^ | ||
+ | |0 |마스크 착용 감지 사용 안함 |기본값 | | ||
+ | |1 |마스크 착용 감지 사용 (HARD) | | | ||
+ | |2 |마스크 착용 감지 사용 (SOFT) | | | ||
+ | </WRAP> | ||
+ | 3. //reserved// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 4. //thermalFormat// \\ | ||
+ | 온도 단위를 나타내며, 화면상의 온도 표시를 화씨 또는 섭씨로 나타내도록 선택할 수 있습니다. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^값 ^설명 ^기본값 ^ | ||
+ | |0 |화씨 | | | ||
+ | |1 |섭씨 |기본값 | | ||
+ | </WRAP> | ||
+ | 5. //reserved2// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 6. //thermalThreshold// \\ | ||
+ | 고열 판단 기준 값이며, 설정 할 온도의 100을 곱한 값으로 입력하여야 합니다. \\ | ||
+ | 또한 섭씨 기준으로만 입력할 수 있습니다. \\ | ||
+ | 이 값은 인증 거부의 근거가 되며, 설정 범위는 섭씨로 3000에서 4500 사이 입니다. \\ \\ | ||
+ | 7. //maskDetectionLevel// \\ | ||
+ | ''FaceStation F2'' 마스크 착용 감지 수준을 입력합니다. 여기서 감지 수준은 내부적으로 설정된 값에 근거합니다. \\ | ||
+ | ''FaceStation 2'' 이 설정은 무시됩니다. \\ | ||
+ | <WRAP group 50%> | ||
+ | ^값 ^설명 ^기본값 ^ | ||
+ | |0 |착용 감지 안함 |기본값 | | ||
+ | |1 |감지수준 보통 | | | ||
+ | |2 |감지수준 높음 | | | ||
+ | |3 |감지수준 매우높음 | | | ||
+ | </WRAP> | ||
+ | 8. //auditTemperature// \\ | ||
+ | 측정 온도를 이벤트 로그에 기록할지 여부를 설정합니다. \\ \\ | ||
+ | 9. //useRejectSound// \\ | ||
+ | thermalThreshold 또는 maskDetectionLevel에 의해서 사용자 인증이 거부되는 경우, 효과음을 발생시킬지 여부를 설정합니다. \\ \\ | ||
+ | 10. //useOverlapThermal// \\ | ||
+ | 화면상에 열화상 이미지를 중첩해서 표시합니다. \\ \\ | ||
+ | 11. //reserved4// \\ | ||
+ | 예약된 공간입니다. \\ \\ | ||
+ | 12. //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> | ||
+ | 1. //distance// \\ | ||
+ | The distance measured by the thermal imaging camera. The unit is cm, and the default is 70. \\ \\ | ||
+ | 2. //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. \\ \\ | ||
+ | 3. //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. \\ \\ | ||
+ | 4. //useBodyCompensation// \\ | ||
+ | It decides whether to use the compensate the body temperature. \\ \\ | ||
+ | 5. //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 \\ \\ | ||
+ |