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:20] yjjung |
en:configuration_api [2021/06/01 10:22] kateyu [Configuration API] |
||
|---|---|---|---|
| Line 35: | Line 35: | ||
| * [[BS2_GetWiegandDeviceConfig]]: Retrieves Wiegand device settings from the device. | * [[BS2_GetWiegandDeviceConfig]]: Retrieves Wiegand device settings from the device. | ||
| * [[BS2_SetWiegandDeviceConfig]]: Stores Wiegand device settings on the device. | * [[BS2_SetWiegandDeviceConfig]]: Stores Wiegand device settings on the device. | ||
| - | * [[BS2_GetInputConfig]]: Retrieves input port settings from the device. | + | * [[BS2_GetInputConfig]]: Retrieves supervised input port settings from the device. |
| - | * [[BS2_SetInputConfig]]: Stores input port settings on the device. | + | * [[BS2_SetInputConfig]]: Stores supervised input port settings on the device. |
| * [[BS2_GetWlanConfig]]: Retrieves wireless LAN settings from the device. | * [[BS2_GetWlanConfig]]: Retrieves wireless LAN settings from the device. | ||
| * [[BS2_SetWlanConfig]]: Stores wireless LAN settings on the device. | * [[BS2_SetWlanConfig]]: Stores wireless LAN settings on the device. | ||
| Line 68: | Line 68: | ||
| * [[BS2_GetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Retrieves IPv6 configuration through UDP broadcast with host IP. | * [[BS2_GetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Retrieves IPv6 configuration through UDP broadcast with host IP. | ||
| * [[BS2_SetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Stores IPv6 configuration through UDP broadcast with host IP. | * [[BS2_SetIPV6ConfigViaUDPEx]]: [+ 2.6.3] Stores IPv6 configuration through UDP broadcast with host IP. | ||
| - | * [[BS2_GetDesFireCardConfigEx]]: [+ V2.6.4] Retrieves DesFire advanced configuration from the device. | + | * [[BS2_GetDesFireCardConfigEx]]: [+ 2.6.4] Retrieves DesFire advanced configuration from the device. |
| - | * [[BS2_SetDesFireCardConfigEx]]: [+ V2.6.4] Sets DesFire advanced configuration in the device. | + | * [[BS2_SetDesFireCardConfigEx]]: [+ 2.6.4] Sets DesFire advanced configuration in the device. |
| - | * [[BS2_GetAuthConfigExt]]: ''FaceStation F2'' Retrieves authentication settings from the device. [+ V2.7.1] | + | * [[BS2_GetAuthConfigExt]]: [+ 2.7.1] ''FaceStation F2'' Retrieves authentication settings from the device. |
| - | * [[BS2_SetAuthConfigExt]]: ''FaceStation F2'' Stores authentication settings from the device. [+ V2.7.1] | + | * [[BS2_SetAuthConfigExt]]: [+ 2.7.1] ''FaceStation F2'' Stores authentication settings from the device. |
| - | * [[BS2_GetFaceConfigExt]]: ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera and mask detection. [+ V2.7.1] | + | * [[BS2_GetFaceConfigExt]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera and mask detection. |
| - | * [[BS2_SetFaceConfigExt]]: ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera and mask detection. [+ V2.7.1] | + | * [[BS2_SetFaceConfigExt]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera and mask detection. |
| - | * [[BS2_GetThermalCameraConfig]]: ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera. [+ V2.7.1] | + | * [[BS2_GetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Retrieves configuration of thermal camera. |
| - | * [[BS2_SetThermalCameraConfig]]: ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera. [+ V2.7.1] | + | * [[BS2_SetThermalCameraConfig]]: [+ 2.7.1] ''FaceStation F2, FaceStation2'' Stores configuration of thermal camera. |
| + | * [[BS2_GetBarcodeConfig]]: [+ 2.8] ''X-Station 2'' Barcode 관련 설정을 가져옵니다. | ||
| + | * [[BS2_SetBarcodeConfig]]: [+ 2.8] ''X-Station 2'' Barcode 관련 설정을 저장합니다. | ||
| \\ | \\ | ||
| ===== Structure ===== | ===== Structure ===== | ||
| Line 375: | Line 376: | ||
| uint8_t shortcutHome[BS2_MAX_SHORTCUT_HOME]; | uint8_t shortcutHome[BS2_MAX_SHORTCUT_HOME]; | ||
| uint8_t tnaIcon[16]; | uint8_t tnaIcon[16]; | ||
| - | uint8_t reserved1[32]; | + | uint8_t useScreenSaver; |
| + | uint8_t reserved1[31]; | ||
| } BS2DisplayConfig; | } BS2DisplayConfig; | ||
| </code> | </code> | ||
| Line 415: | Line 417: | ||
| </WRAP> | </WRAP> | ||
| **6. //menuTimeout//** \\ | **6. //menuTimeout//** \\ | ||
| - | Timeout in seconds for lock screen when the user is inactive. The timeout can be set from 0 to 255 seconds. 0 means no lock screen.\\ \\ | + | Timeout in seconds for lock screen when the user is inactive. The timeout can be set from 0 to 255 seconds. 0 means no lock screen.\\ |
| + | <WRAP group 50%> | ||
| + | ^Value ^Description ^ | ||
| + | |0 |No timeout. | | ||
| + | |10 |Menu timeout 10 sec. | | ||
| + | |20 |Menu timeout 20 sec. (Default) | | ||
| + | |30 |Menu timeout 30 sec. | | ||
| + | |40 |Menu timeout 40 sec. | | ||
| + | |50 |Menu timeout 50 sec. | | ||
| + | |60 |Menu timeout 60 sec. | | ||
| + | </WRAP> | ||
| **7. //msgTimeout//** \\ | **7. //msgTimeout//** \\ | ||
| - | Message timeout in milliseconds. The timeout can be set from 500 to 5000 milliseconds.\\ \\ | + | Message timeout in milliseconds. The timeout can be set from 500 to 5000 milliseconds.\\ |
| + | <WRAP group 50%> | ||
| + | ^Value ^Description ^ | ||
| + | |500 |Message timeout 500 msec. | | ||
| + | |1000 |Message timeout 1 sec. | | ||
| + | |2000 |Message timeout 2 sec. (Default) | | ||
| + | |3000 |Message timeout 3 sec. | | ||
| + | |4000 |Message timeout 4 sec. | | ||
| + | |5000 |Message timeout 5 sec. | | ||
| + | </WRAP> | ||
| **8. //backlightTimeout//** \\ | **8. //backlightTimeout//** \\ | ||
| - | Backlight timeout in seconds. \\ \\ | + | Backlight timeout in seconds. \\ |
| + | <WRAP group 50%> | ||
| + | ^Value ^Description ^ | ||
| + | |0 |Backlight timeout 0 sec. | | ||
| + | |10 |Backlight timeout 10 sec. | | ||
| + | |20 |Backlight timeout 20 sec. (Default) | | ||
| + | |30 |Backlight timeout 30 sec. | | ||
| + | |40 |Backlight timeout 40 sec. | | ||
| + | |50 |Backlight timeout 50 sec. | | ||
| + | |60 |Backlight timeout 60 sec. | | ||
| + | </WRAP> | ||
| **9. //displayDateTime//** \\ | **9. //displayDateTime//** \\ | ||
| Decides whether to display clock on screen. \\ \\ | Decides whether to display clock on screen. \\ \\ | ||
| Line 449: | Line 480: | ||
| Home screen layout(Going to apply later, not used currently). \\ \\ | Home screen layout(Going to apply later, not used currently). \\ \\ | ||
| **16. //tnaIcon//** \\ | **16. //tnaIcon//** \\ | ||
| - | Icon displayed on the device corresponding to the job code. \\ \\ | + | Icon displayed on the device corresponding TNA key. \\ \\ |
| - | **17. //reserved1//** \\ | + | **17. //useScreenSaver//** \\ |
| + | ''FaceStation 2'', ''FaceStation F2'' If set true, you can activate the screensaver. \\ \\ | ||
| + | **18. //reserved1//** \\ | ||
| Reserved space. \\ | Reserved space. \\ | ||
| Line 812: | Line 845: | ||
| </WRAP> | </WRAP> | ||
| **2. //channelIndex//** \\ | **2. //channelIndex//** \\ | ||
| - | Communication channel index of the RS-485 network. \\ \\ | + | (non configurable index) Communication channel index of the RS-485 network. \\ \\ |
| **3. //useRegistance//** \\ | **3. //useRegistance//** \\ | ||
| - | Decides whether to use a resistance. \\ \\ | + | Registance flag - no effect on operation. \\ \\ |
| **4. //numOfDevices//** \\ | **4. //numOfDevices//** \\ | ||
| Number of slave devices.\\ \\ | Number of slave devices.\\ \\ | ||
| Line 860: | Line 893: | ||
| uint16_t wiegandCardMask; | uint16_t wiegandCardMask; | ||
| uint8_t wiegandCSNIndex; | uint8_t wiegandCSNIndex; | ||
| - | uint8_t reserved[27]; | + | uint8_t useWiegandUserID; |
| + | uint8_t reserved[26]; | ||
| } BS2WiegandConfig; | } BS2WiegandConfig; | ||
| </code> | </code> | ||
| Line 930: | Line 964: | ||
| **16. //wiegandCSNIndex//** \\ | **16. //wiegandCSNIndex//** \\ | ||
| Index that determines in which format the device will send out a wiegand ouput after the card has been read. This field is used only for Mifare and EM devices. Please check the //useWiegandFormat// field of the [[configuration api#BS2CardConfig]] structure before configuring. \\ \\ | Index that determines in which format the device will send out a wiegand ouput after the card has been read. This field is used only for Mifare and EM devices. Please check the //useWiegandFormat// field of the [[configuration api#BS2CardConfig]] structure before configuring. \\ \\ | ||
| - | **17. //reserved//** \\ | + | **17. //useWiegandUserID//** \\ |
| - | Reserved space\\ \\ | + | The flag you can select whether card ID or user ID to be sent via Wiegand output. \\ |
| + | <WRAP group 50%> | ||
| + | ^Value ^Description ^ | ||
| + | |0 |Not use | | ||
| + | |1 |Card ID | | ||
| + | |2 |User ID | | ||
| + | </WRAP> | ||
| + | **18. //reserved//** \\ | ||
| + | Reserved space.\\ | ||
| Line 1335: | Line 1377: | ||
| 26. //type// \\ | 26. //type// \\ | ||
| Action types. \\ | Action types. \\ | ||
| + | <WRAP round important 60%> | ||
| + | <wrap em>[DoorModule-20, CoreStation-40]</wrap> \\ | ||
| + | If the action type is relay or TTL (Output) and the action device is DM20, CS40, | ||
| + | Action type should be set only as relay action (6). (TTL setting not possible) \\ \\ | ||
| + | <wrap em>[DM20]</wrap> \\ | ||
| + | * Action type : Relay | ||
| + | * relay.relayIndex : 0 ~ 3 (RELAY 0 ~ 3) | ||
| + | * relay.relayIndex : 4 ~ 9 (OUTPUT 0 ~ 5) | ||
| + | <wrap em>[CS40]</wrap> \\ | ||
| + | * Action type : Relay | ||
| + | * relay.relayIndex : 0 ~ 3 (RELAY 0 ~ 3) | ||
| + | * relay.relayIndex : 4 ~ 11 (OUTPUT 0 ~ 7) | ||
| + | </WRAP> | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| ^Value ^Description ^ | ^Value ^Description ^ | ||
| Line 1614: | Line 1669: | ||
| |1 |Outdoor | | |1 |Outdoor | | ||
| |2 |Automatic | | |2 |Automatic | | ||
| + | |3 |[+V2.8] Not used ''(FaceStation F2)'' | | ||
| </WRAP> | </WRAP> | ||
| **3. //enrollThreshold//** \\ | **3. //enrollThreshold//** \\ | ||
| Line 1636: | Line 1692: | ||
| |0 |Off | | |0 |Off | | ||
| |1 |Low | | |1 |Low | | ||
| - | |2 |Basic | | + | |2 |Medium | |
| |3 |High | | |3 |High | | ||
| </WRAP> | </WRAP> | ||
| Line 2049: | Line 2105: | ||
| </code> | </code> | ||
| **1. //extAuthSchedule//** \\ | **1. //extAuthSchedule//** \\ | ||
| - | 각 인증 모드가 활성화될 때 실행할 일정 식별자입니다. \\ | + | Schedule values to operate when each authentication mode is activated. \\ |
| - | 배열의 순서대로 아래의 의미를 가지며, \\ | + | It has the following meanings for each value. \\ |
| - | 배열 내의 값이 0보다 큰경우 해당 인증모드는 활성화 되어 있습니다. \\ | + | 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%> | <WRAP group 70%> | ||
| - | ^순서 ^의미 ^설명 ^ | + | ^Value ^Code ^Description ^ |
| - | |11 |BS2_EXT_AUTH_MODE_FACE_ONLY |얼굴 | | + | |11 |BS2_EXT_AUTH_MODE_FACE_ONLY |Face | |
| - | |12 |BS2_EXT_AUTH_MODE_FACE_FINGERPRINT |얼굴 + 지문 | | + | |12 |BS2_EXT_AUTH_MODE_FACE_FINGERPRINT |Face + Fingerprint | |
| - | |13 |BS2_EXT_AUTH_MODE_FACE_PIN |얼굴 + PIN | | + | |13 |BS2_EXT_AUTH_MODE_FACE_PIN |Face + PIN | |
| - | |14 |BS2_EXT_AUTH_MODE_FACE_FINGERPRINT_OR_PIN |얼굴 + 지문/PIN | | + | |14 |BS2_EXT_AUTH_MODE_FACE_FINGERPRINT_OR_PIN |Face + Fingerprint/PIN | |
| - | |15 |BS2_EXT_AUTH_MODE_FACE_FINGERPRINT_PIN |얼굴 + 지문 + PIN | | + | |15 |BS2_EXT_AUTH_MODE_FACE_FINGERPRINT_PIN |Face + Fingerprint + PIN | |
| - | |16 |BS2_EXT_AUTH_MODE_FINGERPRINT_ONLY |지문 | | + | |16 |BS2_EXT_AUTH_MODE_FINGERPRINT_ONLY |Fingerprint | |
| - | |17 |BS2_EXT_AUTH_MODE_FINGERPRINT_FACE |지문 + 얼굴 | | + | |17 |BS2_EXT_AUTH_MODE_FINGERPRINT_FACE |Fingerprint + Face | |
| - | |18 |BS2_EXT_AUTH_MODE_FINGERPRINT_PIN |지문 + PIN | | + | |18 |BS2_EXT_AUTH_MODE_FINGERPRINT_PIN |Fingerprint + PIN | |
| - | |19 |BS2_EXT_AUTH_MODE_FINGERPRINT_FACE_OR_PIN |지문 + 얼굴/PIN | | + | |19 |BS2_EXT_AUTH_MODE_FINGERPRINT_FACE_OR_PIN |Fingerprint + Face/PIN | |
| - | |20 |BS2_EXT_AUTH_MODE_FINGERPRINT_FACE_PIN |지문 + 얼굴 + PIN | | + | |20 |BS2_EXT_AUTH_MODE_FINGERPRINT_FACE_PIN |Fingerprint + Face + PIN | |
| - | |21 |BS2_EXT_AUTH_MODE_CARD_ONLY |카드 | | + | |21 |BS2_EXT_AUTH_MODE_CARD_ONLY |Card | |
| - | |22 |BS2_EXT_AUTH_MODE_CARD_FACE |카드 + 얼굴 | | + | |22 |BS2_EXT_AUTH_MODE_CARD_FACE |Cardn + Face | |
| - | |23 |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT |카드 + 지문 | | + | |23 |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT |Card + Fingerprint | |
| - | |24 |BS2_EXT_AUTH_MODE_CARD_PIN |카드 + PIN | | + | |24 |BS2_EXT_AUTH_MODE_CARD_PIN |Card + PIN | |
| - | |25 |BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT |카드 + 얼굴/지문 | | + | |25 |BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT |Card + Face/Fingerprint | |
| - | |26 |BS2_EXT_AUTH_MODE_CARD_FACE_OR_PIN |카드 + 얼굴/PIN | | + | |26 |BS2_EXT_AUTH_MODE_CARD_FACE_OR_PIN |Card + Face/PIN | |
| - | |27 |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_OR_PIN |카드 + 지문/PIN | | + | |27 |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_OR_PIN |Card + Fingerprint/PIN | |
| - | |28 |BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT_OR_PIN |카드 + 얼굴/지문/PIN | | + | |28 |BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT_OR_PIN |Card + Face/Fingerprint/PIN | |
| - | |29 |BS2_EXT_AUTH_MODE_CARD_FACE_FINGERPRINT |카드 + 얼굴 + 지문 | | + | |29 |BS2_EXT_AUTH_MODE_CARD_FACE_FINGERPRINT |Card + Face + Fingerprint | |
| - | |30 |BS2_EXT_AUTH_MODE_CARD_FACE_PIN |카드 + 얼굴 + PIN | | + | |30 |BS2_EXT_AUTH_MODE_CARD_FACE_PIN |Card + Face + PIN | |
| - | |31 |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_FACE |카드 + 지문 + 얼굴 | | + | |31 |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_FACE |Card + Fingerprint + Face | |
| - | |32 |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_PIN |카드 + 지문 + PIN | | + | |32 |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_PIN |Card + Fingerprint + PIN | |
| - | |33 |BS2_EXT_AUTH_MODE_CARD_FACE_OR_FINGERPRINT_PIN |카드 + 얼굴/지문 + 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 |카드 + 얼굴 + 지문/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 |카드 + 지문 + 얼굴/PIN | | + | |35 |BS2_EXT_AUTH_MODE_CARD_FINGERPRINT_FACE_OR_PIN |Card + Fingerprint + Face/PIN | |
| - | |36 |BS2_EXT_AUTH_MODE_ID_FACE |ID + 얼굴 | | + | |36 |BS2_EXT_AUTH_MODE_ID_FACE |ID + Face | |
| - | |37 |BS2_EXT_AUTH_MODE_ID_FINGERPRINT |ID + 지문 | | + | |37 |BS2_EXT_AUTH_MODE_ID_FINGERPRINT |ID + Fingerprint | |
| |38 |BS2_EXT_AUTH_MODE_ID_PIN |ID + PIN | | |38 |BS2_EXT_AUTH_MODE_ID_PIN |ID + PIN | | ||
| - | |39 |BS2_EXT_AUTH_MODE_ID_FACE_OR_FINGERPRINT |ID + 얼굴/지문 | | + | |39 |BS2_EXT_AUTH_MODE_ID_FACE_OR_FINGERPRINT |ID + Face/Fingerprint | |
| - | |40 |BS2_EXT_AUTH_MODE_ID_FACE_OR_PIN |ID + 얼굴/PIN | | + | |40 |BS2_EXT_AUTH_MODE_ID_FACE_OR_PIN |ID + Face/PIN | |
| - | |41 |BS2_EXT_AUTH_MODE_ID_FINGERPRINT_OR_PIN |ID + 지문/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 + 얼굴/지문/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 + 얼굴 + 지문 | | + | |43 |BS2_EXT_AUTH_MODE_ID_FACE_FINGERPRINT |ID + Face + Fingerprint | |
| - | |44 |BS2_EXT_AUTH_MODE_ID_FACE_PIN |ID + 얼굴 + PIN | | + | |44 |BS2_EXT_AUTH_MODE_ID_FACE_PIN |ID + Face + PIN | |
| - | |45 |BS2_EXT_AUTH_MODE_ID_FINGERPRINT_FACE |ID + 지문 + 얼굴 | | + | |45 |BS2_EXT_AUTH_MODE_ID_FINGERPRINT_FACE |ID + Fingerprint + Face | |
| - | |46 |BS2_EXT_AUTH_MODE_ID_FINGERPRINT_PIN |ID + 지문 + PIN | | + | |46 |BS2_EXT_AUTH_MODE_ID_FINGERPRINT_PIN |ID + Fingerprint + PIN | |
| - | |47 |BS2_EXT_AUTH_MODE_ID_FACE_OR_FINGERPRINT_PIN |ID + 얼굴/지문 + 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 + 얼굴 + 지문/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 + 지문 + 얼굴/PIN | | + | |49 |BS2_EXT_AUTH_MODE_ID_FINGERPRINT_FACE_OR_PIN |ID + Fingerprint + Face/PIN | |
| </WRAP> | </WRAP> | ||
| 2. //useGlobalAPB// \\ | 2. //useGlobalAPB// \\ | ||
| - | 광역 이중 인증 방지 구역을 활성화할지 결정하는 flag입니다. \\ \\ | + | This flag determines whether to enable Global APB zone. \\ \\ |
| 3. //globalAPBFailAction// \\ | 3. //globalAPBFailAction// \\ | ||
| - | 광역 이중 인증 위반인지 BioStar 애플리케이션에 질의를 할 수 없거나 응답이 없을때 기본적으로 수행해야 할 동작입니다. \\ | + | This is a basic action to be performed when the device cannot query the server for Global APB violation. \\ |
| <WRAP group 50%> | <WRAP group 50%> | ||
| - | ^값 ^설명 ^ | + | ^Value ^Description ^ |
| - | |0 |APB 검사 안함 | | + | |0 |Do not check APB | |
| - | |1 |Soft APB로 동작 | | + | |1 |Soft APB | |
| - | |2 |Hard APB로 동작 | | + | |2 |Hard APB | |
| </WRAP> | </WRAP> | ||
| 4. //useGroupMatching// \\ | 4. //useGroupMatching// \\ | ||
| - | 얼굴 그룹 매칭을 사용할지 결정하는 flag입니다. \\ \\ | + | Enables facial group matching. \\ \\ |
| 5. //reserved// \\ | 5. //reserved// \\ | ||
| - | 예약된 공간입니다. \\ \\ | + | Reserved space. \\ \\ |
| 6. //reserved2// \\ | 6. //reserved2// \\ | ||
| - | 예약된 공간입니다. \\ \\ | + | Reserved space. \\ \\ |
| 7. //usePrivateAuth// \\ | 7. //usePrivateAuth// \\ | ||
| - | 개별 인증 모드를 사용할지 결정하는 flag입니다. \\ \\ | + | Enable private authentication mode. \\ \\ |
| 8. //faceDetectionLevel// \\ | 8. //faceDetectionLevel// \\ | ||
| - | A2에서 사용자를 인증할 때 얼굴 검출 레벨값이며, 지정한 레벨보다 낮은 레벨로 얼굴이 검출되면 인증 실패로 처리됩니다.\\ | + | 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.\\ |
| - | 설정하면 Normal/Strict에 따른 카메라 뷰가 표시되며, 인증 성공 시의 이미지 로그가 얼굴로 인식되지 않으면 접근이 거부됩니다. 기본값은 0입니다. \\ | + | 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%> | <WRAP group 50%> | ||
| - | ^값 ^설명 ^ | + | ^Value ^Description ^ |
| - | |0 |얼굴 검출을 하지 않음 | | + | |0 |Do not detect face | |
| |1 |Normal mode | | |1 |Normal mode | | ||
| |2 |Strict mode | | |2 |Strict mode | | ||
| </WRAP> | </WRAP> | ||
| <WRAP info> | <WRAP info> | ||
| - | A2에서만 설정 가능하며, FaceStation2나 FaceLite에서는 사용되지 않습니다. | + | It is available only in BioStation A2, not available in FaceStation2 or FaceLite. |
| </WRAP> | </WRAP> | ||
| 9. //useServerMatching// \\ | 9. //useServerMatching// \\ | ||
| - | 지문 인증이나 얼굴 인식을 Matching server에서 수행할지 결정하는 flag입니다. \\ \\ | + | Enable server matching for fingerprint matching or facial matching. \\ \\ |
| 10. //useFullAccess// \\ | 10. //useFullAccess// \\ | ||
| - | 사용하지 않는 변수입니다. \\ \\ | + | This parameter is not in use. \\ \\ |
| 11. //matchTimeout// \\ | 11. //matchTimeout// \\ | ||
| - | 지문 인증이나 얼굴 인식에서 최대 응답 시간이며 단위는 초(sec)를 사용합니다. \\ \\ | + | The maximum response time in fingerprint or facial matching and the unit is seconds(sec). \\ \\ |
| 12. //authTimeout// \\ | 12. //authTimeout// \\ | ||
| - | 사용자 인증의 최대 응답 시간이며 단위는 초(sec)를 사용합니다. \\ \\ | + | The maximum response time in user authentication and the unit is seconds(sec). \\ \\ |
| 13. //numOperators// \\ | 13. //numOperators// \\ | ||
| - | 사용자 권한을 정의하는 operator의 개수입니다. \\ \\ | + | The number of operators. \\ \\ |
| 14. //reserved3// \\ | 14. //reserved3// \\ | ||
| - | 예약된 공간입니다. \\ \\ | + | Reserved \\ \\ |
| 15. //userID// \\ | 15. //userID// \\ | ||
| - | 사용자 식별자입니다. \\ \\ | + | User ID \\ \\ |
| 16. //level// \\ | 16. //level// \\ | ||
| - | 사용자가 인증되었을 때 식별자에 해당하는 권한을 지정합니다. \\ | + | It specifies the corresponding level of the user when the user is authenticated.\\ |
| <WRAP group 50%> | <WRAP group 50%> | ||
| - | ^값 ^설명 ^ | + | ^Value ^Description ^ |
| - | |0 |권한 없음 | | + | |0 |No level | |
| - | |1 |관리자 권한 | | + | |1 |Operator level | |
| - | |2 |시스템 구성을 변경할 수 있는 권한 | | + | |2 |System configuration level | |
| - | |3 |사용자 정보를 변경할 수 있는 권한 | | + | |3 |User information level | |
| </WRAP> | </WRAP> | ||
| <WRAP alert> | <WRAP alert> | ||
| - | **주의**\\ | + | **CAUTION**\\ |
| - | Operator 추가 시, 추가하고자 하는 operator의 수를 **//numOperators//** 필드의 값으로 지정해야 합니다. | + | You must specify the number of operators to be added in the field **//numOperators//** when adding operators. |
| </WRAP> | </WRAP> | ||
| 17. //reserved// \\ | 17. //reserved// \\ | ||
| - | 예약된 공간입니다. \\ | + | Reserved \\ |
| 18. //reserved4// \\ | 18. //reserved4// \\ | ||
| - | 예약된 공간입니다. \\ \\ | + | Reserved \\ \\ |
| Line 2166: | Line 2222: | ||
| uint8_t thermalFormat; | uint8_t thermalFormat; | ||
| - | uint8_t reserved2[3]; | + | uint8_t reserved2; |
| - | uint16_t thermalThreshold; | + | uint16_t thermalThresholdLow; |
| + | uint16_t thermalThresholdHigh; | ||
| uint8_t maskDetectionLevel; | uint8_t maskDetectionLevel; | ||
| uint8_t auditTemperature; | uint8_t auditTemperature; | ||
| Line 2174: | Line 2231: | ||
| uint8_t useRejectSound; | uint8_t useRejectSound; | ||
| uint8_t useOverlapThermal; | uint8_t useOverlapThermal; | ||
| - | uint8_t reserved4; | + | uint8_t useDynamicROI; |
| uint8_t faceCheckOrder; | uint8_t faceCheckOrder; | ||
| } BS2FaceConfigExt; | } BS2FaceConfigExt; | ||
| </code> | </code> | ||
| 1. //thermalCheckMode// \\ | 1. //thermalCheckMode// \\ | ||
| - | 열화상 감지 모드를 설정합니다. \\ | + | Sets the thermal check mode. \\ |
| - | HARD로 설정 시, 고열의 기준인 thermalThreshold를 초과하면, 출입에 영향을 주게됩니다. \\ | + | When set to HARD, access is denied if exceeding the thermalThreshold. \\ |
| - | SOFT로 설정 시, 고열의 기준인 thermalThreshold를 초과하면, 근거를 로그를 남기고 출입에 영향을 주지 않습니다. \\ | + | When set to SOFT, access is not affected even if exceeding the thermalThreshold but leaves a related log. \\ |
| + | If thermalCheckMode is set to No use(0), \\ | ||
| + | The settings of thermalFormat, thermalThreshold, auditTemperature, and useOverlapThermal are ignored. \\ | ||
| + | And the reject sound due to thermal check by useRejectSound, the temperature check by faceCheckOrder is ignored. \\ | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| - | ^값 ^설명 ^기본값 ^ | + | ^Value ^Description ^Default ^ |
| - | |0 |열화상 감지 사용 안함 |기본값 | | + | |0 |No use |Default | |
| - | |1 |열화상 감지 사용 (HARD) | | | + | |1 |Thermal Check Mode (HARD) | | |
| - | |2 |열화상 감지 사용 (SOFT) | | | + | |2 |Thermal Check Mode (SOFT) | | |
| </WRAP> | </WRAP> | ||
| 2. //maskCheckMode// \\ | 2. //maskCheckMode// \\ | ||
| - | ''FaceStation F2'' 마스크 착용 감지 모드를 설정합니다. \\ | + | ''FaceStation F2'' Sets the Mask Check Mode. \\ |
| - | ''FaceStation 2'' 이 설정은 무시됩니다. \\ | + | ''FaceStation 2'' This setting is ignored. \\ |
| - | HARD로 설정 시, maskDetectionLevel에 근거하여 착용 위반이 감지되면, 출입에 영향을 주게됩니다. \\ | + | When set to HARD, access is denied if not detecting any mask on the face based on maskDetectionLevel. \\ |
| - | SOFT로 설정 시, maskDetectionLevel에 근거하여 착용 위반이 감지되면, 근거를 로그를 남기고 출입에 영향을 주지 않습니다. \\ | + | When set to SOFT, access is not affected even if not detecting any mask on the face based on maskDetectionLevel but leaves a related log. \\ |
| + | If maskCheckMode is set to No use(0), \\ | ||
| + | The setting of maskDetectionLevel is ignored. \\ | ||
| + | And the reject sound due to mask detection check by useRejectSound, the mask detection check by faceCheckOrder is ignored. \\ | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| - | ^값 ^설명 ^기본값 ^ | + | ^Value ^Description ^Default ^ |
| - | |0 |마스크 착용 감지 사용 안함 |기본값 | | + | |0 |No use |Default | |
| - | |1 |마스크 착용 감지 사용 (HARD) | | | + | |1 |Mask Check Mode (HARD) | | |
| - | |2 |마스크 착용 감지 사용 (SOFT) | | | + | |2 |Mask Check Mode (SOFT) | | |
| </WRAP> | </WRAP> | ||
| 3. //reserved// \\ | 3. //reserved// \\ | ||
| - | 예약된 공간입니다. \\ \\ | + | Reserved \\ \\ |
| 4. //thermalFormat// \\ | 4. //thermalFormat// \\ | ||
| - | 온도 단위를 나타내며, 화면상의 온도 표시를 화씨 또는 섭씨로 나타내도록 선택할 수 있습니다. \\ | + | Represents the temperature unit. You may choose the unit in Fahrenheit or Celsius \\ |
| <WRAP group 50%> | <WRAP group 50%> | ||
| - | ^값 ^설명 ^기본값 ^ | + | ^Value ^Description ^Default ^ |
| - | |0 |화씨 | | | + | |0 |Fahrenheit | | |
| - | |1 |섭씨 |기본값 | | + | |1 |Celsius |Default | |
| </WRAP> | </WRAP> | ||
| 5. //reserved2// \\ | 5. //reserved2// \\ | ||
| - | 예약된 공간입니다. \\ \\ | + | Reserved \\ \\ |
| - | 6. //thermalThreshold// \\ | + | 6. //thermalThresholdLow// \\ |
| - | 고열 판단 기준 값이며, 설정 할 온도의 100을 곱한 값으로 입력하여야 합니다. \\ | + | ''Supported version'' : ''FaceStation F2 V1.0.2'', ''FaceStation 2 V1.5.0'' \\ |
| - | 또한 섭씨 기준으로만 입력할 수 있습니다. \\ | + | This is the range value for determining high temperature and must be entered as a value multiplied by 100 of the temperature to be set. \\ |
| - | 이 값은 인증 거부의 근거가 되며, 설정 범위는 섭씨로 3000에서 4500 사이 입니다. \\ \\ | + | Also, you can only enter in degrees Celsius. \\ |
| - | 7. //maskDetectionLevel// \\ | + | This value is the basis for the denial of authentication, and the setting range is between 100 (1º) and 4500 (45º). \\ |
| - | ''FaceStation F2'' 마스크 착용 감지 수준을 입력합니다. 여기서 감지 수준은 내부적으로 설정된 값에 근거합니다. \\ | + | The default value is 3200 (32º), and if a value larger or smaller than the setting range is entered, the default value a set to 3200 (32º). \\ |
| - | ''FaceStation 2'' 이 설정은 무시됩니다. \\ | + | And you must set a value less than thermalThresholdHigh. \\ \\ |
| + | 7. //thermalThresholdHigh// \\ | ||
| + | This is the range value for determining high temperature and must be entered as a value multiplied by 100 of the temperature to be set. \\ | ||
| + | Also, you can only enter in degrees Celsius. \\ | ||
| + | This value is the basis for the denial of authentication, and the setting range is between 100 (1º) and 4500 (45º). \\ | ||
| + | The default value is 3800 (38º), and if a value larger or smaller than the setting range is entered, the default value a set to 3800 (38º). \\ | ||
| + | And you must set a value greater than thermalThresholdLow. \\ \\ | ||
| + | 8. //maskDetectionLevel// \\ | ||
| + | ''FaceStation F2'' Sets the mask detection level. The detecting level is based on internal setting value. \\ | ||
| + | ''FaceStation 2'' This setting is ignored. \\ | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| - | ^값 ^설명 ^기본값 ^ | + | ^Value ^Description ^Default ^ |
| - | |0 |착용 감지 안함 |기본값 | | + | |0 |No detection |Default | |
| - | |1 |감지수준 보통 | | | + | |1 |Detection level (Normal) | | |
| - | |2 |감지수준 높음 | | | + | |2 |Detection level (High) | | |
| - | |3 |감지수준 매우높음 | | | + | |3 |Detection level (Very high) | | |
| </WRAP> | </WRAP> | ||
| - | 8. //auditTemperature// \\ | + | 9. //auditTemperature// \\ |
| - | 측정 온도를 이벤트 로그에 기록할지 여부를 설정합니다. \\ \\ | + | Decides whether the measured temperature is recorded in the log or not. \\ \\ |
| - | 9. //useRejectSound// \\ | + | 10. //useRejectSound// \\ |
| - | thermalThreshold 또는 maskDetectionLevel에 의해서 사용자 인증이 거부되는 경우, 효과음을 발생시킬지 여부를 설정합니다. \\ \\ | + | Decides whether it sounds when rejecting a user due to thermalThreshold or maskDetectionLevel. \\ \\ |
| - | 10. //useOverlapThermal// \\ | + | 11. //useOverlapThermal// \\ |
| - | 화면상에 열화상 이미지를 중첩해서 표시합니다. \\ \\ | + | Displays a thermal image overlaid on the screen. \\ \\ |
| - | 11. //reserved4// \\ | + | 12. //useDynamicROI// \\ |
| - | 예약된 공간입니다. \\ \\ | + | When set to true, when measuring temperature, the user's forehead is found and measured, not a fixed area. \\ \\ |
| - | 12. //faceCheckOrder// \\ | + | 13. //faceCheckOrder// \\ |
| - | 발열 측정 및 마스크 착용 감지와 인증절차에 대한 순서를 정의합니다. \\ | + | It defines the sequence of thermal check and mask detection and authentication. \\ |
| - | ID를 조합한 인증이나, PIN을 조합한 인증의 경우, 장치에 접촉하게되는 절차를 거치게 되므로, \\ | + | Because the user should touch the device in the case of ID combination authentication or PIN combination authentication,\\ |
| - | 고위험군을 고려하는 환경이라면, 발열 측정 후 인증을 선택할지, 그 전에 인증을 수행할지에 대한 선택은 매우 중요한 요소입니다. \\ | + | it is important to decide whether the device authenticates before all check modes or afterward especially in a high-risk environment.\\ |
| <WRAP group 50%> | <WRAP group 50%> | ||
| - | ^값 ^설명 ^기본값 ^ | + | ^Value ^Description ^Default ^ |
| - | |0 |발열 측정 및 마스크 착용 감지 후 인증 | 기본값 | | + | Authentication before Temperature check or Mask detection check |
| - | |1 |인증 후 발열 측정 및 마스크 착용 감지 | | | + | |0 |Check after authentication | Default | |
| - | |2 |인증 절차 생략. 발열 검사 및 마스크 착용 감지만 수행 | | | + | |1 |Check before authentication | | |
| + | |2 |No authentication, check only | | | ||
| </WRAP> | </WRAP> | ||
| Line 2264: | Line 2337: | ||
| </code> | </code> | ||
| 1. //distance// \\ | 1. //distance// \\ | ||
| - | 열화상 카메라의 체온 측정 거리를 나타냅니다. 단위는 cm이며 기본값은 70 입니다. \\ \\ | + | The distance measured by the thermal imaging camera. The unit is cm, and the default is 100. \\ \\ |
| 2. //emissionRate// \\ | 2. //emissionRate// \\ | ||
| - | 피사체가 열을 방사하는 비율을 입력합니다. \\ | + | The emissivity of the subject reflecting heat. \\ |
| - | [95/97/98] 범위내의 입력을 권장합니다. 피사체가 사람인 경우 적정 권장은 98 입니다. \\ \\ | + | It is recommended to enter within the [95/97/98] range. If the subject is a human, 98 is recommended. \\ \\ |
| 3. //roi// \\ | 3. //roi// \\ | ||
| - | ROI(Region of interest)는 관심영역을 의미하며, 얼굴에서 발열 측정 시, 관심 대상이되는 영역을 \\ | + | ROI (Region of interest) refers to the region of interest. \\ |
| - | 좌표(x, y)와, 범위(width, height) 값을 통해서 지정할 수 있습니다. \\ \\ | + | It can be specified through coordinates (x, y) and range (width, height) values when measuring temperature on the face. \\ \\ |
| 4. //useBodyCompensation// \\ | 4. //useBodyCompensation// \\ | ||
| - | 발열 측정된 체온의 보정을 사용할지 여부를 나타냅니다. \\ \\ | + | It decides whether to use the compensate the body temperature. \\ \\ |
| 5. //compensationTemperature// \\ | 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. \\ |
| - | 설정할 온도의 10을 곱한 값으로 입력하여야하며, 최소 -50에서 최대 50 사이의 값을 지정할 수 있습니다. \\ \\ | + | It must be as the value multiplied by 10 of the temperature to be set. The value is available -50 ~ +50 \\ \\ |