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:log_management_api [2020/09/10 16:01] yjjung [OnLogReceived] |
en:log_management_api [2021/08/06 15:35] kateyu [BS2Event] |
||
---|---|---|---|
Line 28: | Line 28: | ||
==== OnLogReceivedEx ==== | ==== OnLogReceivedEx ==== | ||
- | [+ V2.7.1] 장치로부터 새로운 로그를 수신했을 때 호출되는 콜백 함수입니다. \\ | + | [+ V2.7.1] Callback function that is called when receiving a new log from the device. \\ |
- | 열화상 카메라를 통해 측정된 체온이 세번째 인자로 수신되며, [[configuration api#BS2FaceConfigExt]]의 auditTemperature가 true로 설정되어져야 합니다. \\ \\ | + | The temperature information is transferred as the 3rd parameter, and auditTemperature should be true in [[configuration api#BS2FaceConfigExt]]. \\ \\ |
<code cpp> | <code cpp> | ||
typedef void (*OnLogReceivedEx)(uint32_t deviceId, BS2Event* log, uint32_t temperature); | typedef void (*OnLogReceivedEx)(uint32_t deviceId, BS2Event* log, uint32_t temperature); | ||
Line 35: | Line 35: | ||
\\ | \\ | ||
1. //deviceId// \\ | 1. //deviceId// \\ | ||
- | 새로운 로그를 보내준 장치 ID입니다. \\ \\ | + | Device ID \\ \\ |
2. //log// \\ | 2. //log// \\ | ||
- | 새로운 로그 정보 구조체입니다. \\ \\ | + | New log information structure \\ \\ |
3. //temperature// \\ | 3. //temperature// \\ | ||
- | 새로운 로그 발생 시, 측정된 체온 정보입니다. \\ \\ | + | Temperature information \\ \\ |
Line 74: | Line 74: | ||
uint8_t reserved[12]; | uint8_t reserved[12]; | ||
} interlock; | } interlock; | ||
+ | struct { | ||
+ | uint16_t relayPort; | ||
+ | uint16_t inputPort; | ||
+ | uint8_t reserved[28]; | ||
+ | } relayAction; | ||
}; | }; | ||
union { | union { | ||
Line 133: | Line 138: | ||
**15. //interlock.doorID//** \\ | **15. //interlock.doorID//** \\ | ||
Door ID that makes interlock zone alarms. \\ \\ | Door ID that makes interlock zone alarms. \\ \\ | ||
- | **16. //subCode//** \\ | + | **16. //relayAction.relayPort//** \\ |
+ | Relay port identifier when IM-120 RelayAction takes place. \\ \\ | ||
+ | **17. //relayAction.inputPort// \\ | ||
+ | Relay port identifier when IM-120 RelayAction takes place. \\ \\ | ||
+ | 18. //subCode// \\ | ||
Sub code value of log types. Use if the additional information is necessary. \\ | Sub code value of log types. Use if the additional information is necessary. \\ | ||
- | ^Category ^Event code ^Value ^Description ^ | + | |
+ | ^Category ^Event code ^Value ^Description ^ | ||
|Verify |BS2_SUB_EVENT_VERIFY_ID_PIN |0x01 |ID and PIN verification success | | |Verify |BS2_SUB_EVENT_VERIFY_ID_PIN |0x01 |ID and PIN verification success | | ||
|::: |BS2_SUB_EVENT_VERIFY_ID_FINGER |0x02 |ID and fingerprint verification success | | |::: |BS2_SUB_EVENT_VERIFY_ID_FINGER |0x02 |ID and fingerprint verification success | | ||
Line 151: | Line 161: | ||
|::: |BS2_SUB_EVENT_VERIFY_AOC_FINGER |0x0E |AOC card and fingerprint verification success | | |::: |BS2_SUB_EVENT_VERIFY_AOC_FINGER |0x0E |AOC card and fingerprint verification success | | ||
|::: |BS2_SUB_EVENT_VERIFY_AOC_FINGER_PIN |0x0F |AOC card, fingerprint, PIN verification success | | |::: |BS2_SUB_EVENT_VERIFY_AOC_FINGER_PIN |0x0F |AOC card, fingerprint, PIN verification success | | ||
+ | |::: |BS2_SUB_EVENT_VERIFY_MOBLIE_CARD |0x16 |Mobile card verification success (+V2.8) | | ||
+ | |::: |BS2_SUB_EVENT_VERIFY_MOBILE_CARD_PIN |0x17 |Mobile card and PIN verification success (+V2.8) | | ||
+ | |::: |BS2_SUB_EVENT_VERIFY_MOBILE_CARD_FINGER |0x18 |Mobile card and fingerprint verification success (+V2.8) | | ||
+ | |::: |BS2_SUB_EVENT_VERIFY_MOBILE_CARD_FINGER_PIN |0x19 |Mobile card, fingerprint, PIN verification success (+V2.8) | | ||
+ | |::: |BS2_SUB_EVENT_VERIFY_MOBILE_CARD_FACE |0x1A |Mobile card and face verification success (+V2.8) | | ||
+ | |::: |BS2_SUB_EVENT_VERIFY_MOBILE_CARD_FACE_PIN |0x1B |Mobile card, face, PIN verification success (+V2.8) | | ||
+ | |::: |BS2_SUB_EVENT_VERIFY_MOBILE_CARD_FACE_FINGER |0x20 |Mobile card, face, fingerprint verification success (+V2.8) | | ||
+ | |::: |BS2_SUB_EVENT_VERIFY_MOBILE_CARD_FINGER_FACE |0x21 |Mobile card, fingerprint, face verification success (+V2.8) | | ||
|Identify |BS2_SUB_EVENT_IDENTIFY_FINGER |0x01 |Fingerprint identification success | | |Identify |BS2_SUB_EVENT_IDENTIFY_FINGER |0x01 |Fingerprint identification success | | ||
|::: |BS2_SUB_EVENT_IDENTIFY_FINGER_PIN |0x02 |Fingerprint and PIN identification success | | |::: |BS2_SUB_EVENT_IDENTIFY_FINGER_PIN |0x02 |Fingerprint and PIN identification success | | ||
Line 164: | Line 182: | ||
|::: |BS2_SUB_EVENT_CREDENTIAL_AOC_PIN |0x06 |Invalid AOC PIN | | |::: |BS2_SUB_EVENT_CREDENTIAL_AOC_PIN |0x06 |Invalid AOC PIN | | ||
|::: |BS2_SUB_EVENT_CREDENTIAL_AOC_FINGER |0x07 |Invalid AOC fingerprint | | |::: |BS2_SUB_EVENT_CREDENTIAL_AOC_FINGER |0x07 |Invalid AOC fingerprint | | ||
+ | |::: |BS2_SUB_EVENT_CREDENTIAL_MOBILE_CARD |0x08 |Invalid mobile card (+V2.8) | | ||
|Auth |BS2_SUB_EVENT_AUTH_FAIL_INVALID_AUTH_MODE |0x01 |Invalid authentication mode | | |Auth |BS2_SUB_EVENT_AUTH_FAIL_INVALID_AUTH_MODE |0x01 |Invalid authentication mode | | ||
|::: |BS2_SUB_EVENT_AUTH_FAIL_INVALID_CREDENTIAL |0x02 |Non-registered authentication method| | |::: |BS2_SUB_EVENT_AUTH_FAIL_INVALID_CREDENTIAL |0x02 |Non-registered authentication method| | ||
Line 176: | Line 195: | ||
|APB |BS2_SUB_EVENT_ZONE_HARD_APB |0x01 |Hard APB zone | | |APB |BS2_SUB_EVENT_ZONE_HARD_APB |0x01 |Hard APB zone | | ||
|::: |BS2_SUB_EVENT_ZONE_SOFT_APB |0x02 |Soft APB zone | | |::: |BS2_SUB_EVENT_ZONE_SOFT_APB |0x02 |Soft APB zone | | ||
- | + | **19. //mainCode//** \\ | |
- | **17. //mainCode//** \\ | + | |
Main code value of log types. \\ | Main code value of log types. \\ | ||
^Category ^Event code ^Value ^Description ^ | ^Category ^Event code ^Value ^Description ^ | ||
Line 259: | Line 277: | ||
|::: |BS2_EVENT_ZONE_SCHEDULED_LOCK_ALARM |0x6E00 |Scheduled lock alarm zone start | | |::: |BS2_EVENT_ZONE_SCHEDULED_LOCK_ALARM |0x6E00 |Scheduled lock alarm zone start | | ||
|::: |BS2_EVENT_ZONE_SCHEDULED_LOCK_ALARM_CLEAR |0x6F00 |Scheduled lock alarm zone clear | | |::: |BS2_EVENT_ZONE_SCHEDULED_LOCK_ALARM_CLEAR |0x6F00 |Scheduled lock alarm zone clear | | ||
+ | | | ||
+ | |RelayAction |BS2_EVENT_RELAY_ACTION_ON |0xC300 |RelayAction Switch-ON | | ||
+ | |::: |BS2_EVENT_RELAY_ACTION_OFF |0xC400 |RelayAction Switch-OFF | | ||
+ | |::: |BS2_EVENT_RELAY_ACTION_KEEP |0xC500 |RelayAction KEEP SIGNAL | | ||
+ | |||
- | **18. //param//** \\ | + | **20.//param//** \\ |
It is used only when extra information on the device is needed. Usually, a time and attendance code, a port number of the door or input device is stored in the //param// argument. | It is used only when extra information on the device is needed. Usually, a time and attendance code, a port number of the door or input device is stored in the //param// argument. | ||
When a time and attendance code is stored, refer to the following values: | When a time and attendance code is stored, refer to the following values: | ||
Line 302: | Line 325: | ||
\\ \\ | \\ \\ | ||
- | **19. //image//** \\ | + | **21. //image//** \\ |
Prior to SDK V2.6.0, it used the whole 1 byte and means below: \\ | Prior to SDK V2.6.0, it used the whole 1 byte and means below: \\ | ||
- Whether the image was included when the event occurred (true / false). \\ \\ | - Whether the image was included when the event occurred (true / false). \\ \\ |