Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
en:log_management_api [2020/09/10 13:14]
yjjung
en:log_management_api [2021/08/07 14:44]
kkshin [BS2Event]
Line 8: Line 8:
   * [[BS2_ClearLog]]:​ Deletes all logs.   * [[BS2_ClearLog]]:​ Deletes all logs.
   * [[BS2_StartMonitoringLog]]:​ Starts Real-time log streaming. ​   * [[BS2_StartMonitoringLog]]:​ Starts Real-time log streaming. ​
-  * [[BS2_StartMonitoringLogEx]]: ​측정 체온이 포함된, 실시간 로그 스트리밍을 시작합니다. ​[+ V2.7.1]+  * [[BS2_StartMonitoringLogEx]]:​ [+ V2.7.1] ​Starts Real-time log streaming including the temperature information.
   * [[BS2_StopMonitoringLog]]:​ Stops Real-time log streaming. ​   * [[BS2_StopMonitoringLog]]:​ Stops Real-time log streaming. ​
   * [[BS2_GetLogBlob]]:​ Gets certain amount of logs based on the event mask.   * [[BS2_GetLogBlob]]:​ Gets certain amount of logs based on the event mask.
Line 14: Line 14:
   * [[BS2_GetImageLog]] : Gets image logs using event ID.   * [[BS2_GetImageLog]] : Gets image logs using event ID.
   * [[BS2_GetLogSmallBlob]]:​ [+ 2.6.4] Gets certain amount of logs based on the event mask in an efficient way.    * [[BS2_GetLogSmallBlob]]:​ [+ 2.6.4] Gets certain amount of logs based on the event mask in an efficient way. 
-  * [[BS2_GetLogSmallBlobEx]]:​ [+ 2.7.1] ​효율적으로 메모리를 사용하면서EventMask를 사용해서 체온정보를 포함한 로그를 가져옵니다.+  * [[BS2_GetLogSmallBlobEx]]:​ [+ 2.7.1] ​Gets certain amount of logs based on the event mask in an efficient wayincluding the temperature information
 ===== Callback Function ===== ===== Callback Function =====
 ==== OnLogReceived ==== ==== OnLogReceived ====
-장치로부터 새로운 로그를 수신했을 때 호출되는 콜백 함수입니다 \\ \\ +Callback function that is called when receiving a new log from the device. \\ \\ 
 <code cpp> <code cpp>
 typedef void (*OnLogReceived)(uint32_t deviceId, BS2Event* log); typedef void (*OnLogReceived)(uint32_t deviceId, BS2Event* log);
Line 23: Line 23:
 \\ \\
 1. //​deviceId//​ \\  1. //​deviceId//​ \\ 
-새로운 로그를 보내준 장치 ​ID입니다. ​ \\ \\ +Device ​ID  \\ \\ 
 2. //log// \\  2. //log// \\ 
-새로운 로그 정보 구조체입니다. ​ \\ \\ +New log information structure ​ \\ \\ 
  
 ==== 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 parameterand 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 160:
 |::: |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 181:
 |::: |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 194:
 |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 276:
 |:::  |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 324:
 \\ \\  \\ \\ 
  
-**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). \\ \\