차이

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

--- ko:log_management_api [2018/09/12 09:54]
kkshin
+++ ko:log_management_api [2021/05/25 15:37]
kkshin [BS2Event]
@@ 줄 8: / 줄 8: @@
   * [[BS2_ClearLog]]: 모든 로그를 삭제합니다.
   * [[BS2_StartMonitoringLog]]: 실시간 로그 스트리밍을 시작합니다.
+  * [[BS2_StartMonitoringLogEx]]: 측정 체온이 포함된, 실시간 로그 스트리밍을 시작합니다. [+ V2.7.1]
   * [[BS2_StopMonitoringLog]]: 실시간 로그 스트리밍을 중단합니다.
   * [[BS2_GetLogBlob]]: EventMask에 맞게 일정량의 로그를 가져옵니다.
   * [[BS2_GetFilteredLogSinceEventId]]: 조건에 맞는 로그를 가져옵니다.
+  * [[BS2_GetImageLog]]: 이미지로그를 가져옵니다.
+  * [[BS2_GetLogSmallBlob]]: [+ 2.6.4] 효율적으로 메모리를 사용하면서, EventMask에 맞게 일정량의 로그를 가져옵니다.
+  * [[BS2_GetLogSmallBlobEx]]: [+ 2.7.1] 효율적으로 메모리를 사용하면서, EventMask를 사용해서 체온정보를 포함한 로그를 가져옵니다.
 ===== 콜백 함수 =====
+==== OnLogReceived ====
+장치로부터 새로운 로그를 수신했을 때 호출되는 콜백 함수입니다.  \\ \\
 <code cpp>
 typedef void (*OnLogReceived)(uint32_t deviceId, BS2Event* log);
 </code>
 \\
+. //deviceId// \\
+새로운 로그를 보내준 장치 ID입니다.  \\ \\
+. //log// \\
+새로운 로그 정보 구조체입니다.  \\ \\
-. //OnLogReceived// \\
+==== OnLogReceivedEx ====
-장치로부터 새로운 로그를 수신했을 때 호출되는 콜백 함수입니다.  \\ \\
+[+ V2.7.1] 장치로부터 새로운 로그를 수신했을 때 호출되는 콜백 함수입니다. \\
+열화상 카메라를 통해 측정된 체온이 세번째 인자로 수신되며, [[configuration api#BS2FaceConfigExt]]의 auditTemperature가 true로 설정되어져야 합니다. \\ \\
+<code cpp>
+typedef void (*OnLogReceivedEx)(uint32_t deviceId, BS2Event* log, uint32_t temperature);
+</code>
+\\
+. //deviceId// \\
+새로운 로그를 보내준 장치 ID입니다.  \\ \\
+. //log// \\
+새로운 로그 정보 구조체입니다.  \\ \\
+. //temperature// \\
+새로운 로그 발생 시, 측정된 체온 정보입니다. \\ \\
 ===== 구조체 =====
 ==== BS2Event ====
@@ 줄 119: / 줄 140: @@
 |::: |BS2_SUB_EVENT_VERIFY_ID_FACE  |0x04  |주어진 사용자 식별자로 얼굴 인식 성공  |
 |::: |BS2_SUB_EVENT_VERIFY_ID_FACE_PIN  |0x05  |주어진 사용자 식별자로 얼굴 인식과 PIN 인증 성공  |
-|::: |BS2_SUB_EVENT_VERIFY_CARD  |0x06  |스마트 카드 인증 성공  |
+|::: |BS2_SUB_EVENT_VERIFY_CARD  |0x06  |카드 인증 성공  |
-|::: |BS2_SUB_EVENT_VERIFY_CARD_PIN  |0x07  |스마트 카드와 PIN 인증 성공  |
+|::: |BS2_SUB_EVENT_VERIFY_CARD_PIN  |0x07  |카드와 PIN 인증 성공  |
-|::: |BS2_SUB_EVENT_VERIFY_CARD_FINGER  |0x08  |스마트 카드와 지문 인증 성공  |
+|::: |BS2_SUB_EVENT_VERIFY_CARD_FINGER  |0x08  |카드와 지문 인증 성공  |
-|::: |BS2_SUB_EVENT_VERIFY_CARD_FINGER_PIN  |0x09  |스마트 카드, 지문, PIN 인증 성공  |
+|::: |BS2_SUB_EVENT_VERIFY_CARD_FINGER_PIN  |0x09  |카드, 지문, PIN 인증 성공  |
-|::: |BS2_SUB_EVENT_VERIFY_CARD_FACE  |0x0A  |스마트 카드 인증과 얼굴 인식 성공  |
+|::: |BS2_SUB_EVENT_VERIFY_CARD_FACE  |0x0A  |카드 인증과 얼굴 인식 성공  |
-|::: |BS2_SUB_EVENT_VERIFY_CARD_FACE_PIN  |0x0B  |스마트 카드, 얼굴 인식, PIN 인증 성공  |
+|::: |BS2_SUB_EVENT_VERIFY_CARD_FACE_PIN  |0x0B  |카드, 얼굴 인식, PIN 인증 성공  |
 |::: |BS2_SUB_EVENT_VERIFY_AOC  |0x0C  |AOC 카드 인증 성공  |
 |::: |BS2_SUB_EVENT_VERIFY_AOC_PIN  |0x0D  |AOC 카드와 PIN 인증 성공  |
 |::: |BS2_SUB_EVENT_VERIFY_AOC_FINGER  |0x0E  |AOC 카드와 지문 인증 성공  |
 |::: |BS2_SUB_EVENT_VERIFY_AOC_FINGER_PIN  |0x0F  |AOC 카드, 지문, PIN 인증 성공  |
+|::: |BS2_SUB_EVENT_VERIFY_MOBLIE_CARD  |0x16  |Mobile카드 인증 성공 (+V2.8)  |
+|::: |BS2_SUB_EVENT_VERIFY_MOBILE_CARD_PIN  |0x17  |Mobile카드, PIN 인증 성공 (+V2.8)  |
+|::: |BS2_SUB_EVENT_VERIFY_MOBILE_CARD_FINGER  |0x18  |Mobile카드, 지문 인증 성공 (+V2.8)  |
+|::: |BS2_SUB_EVENT_VERIFY_MOBILE_CARD_FINGER_PIN   |0x19  |Mobile카드, 지문, PIN 인증 성공 (+V2.8)  |
+|::: |BS2_SUB_EVENT_VERIFY_MOBILE_CARD_FACE  |0x1A  |Mobile카드, 얼굴 인증 성공 (+V2.8)  |
+|::: |BS2_SUB_EVENT_VERIFY_MOBILE_CARD_FACE_PIN  |0x1B  |Mobile카드, 얼굴, PIN 인증 성공 (+V2.8)  |
+|::: |BS2_SUB_EVENT_VERIFY_MOBILE_CARD_FACE_FINGER  |0x20  |Mobile카드, 얼굴, 지문 인증 성공 (+V2.8)  |
+|::: |BS2_SUB_EVENT_VERIFY_MOBILE_CARD_FINGER_FACE  |0x21  |Mobile카드, 지문, 얼굴 인증 성공 (+V2.8)  |
 |Identify  |BS2_SUB_EVENT_IDENTIFY_FINGER  |0x01  |지문 인증으로 사용자 식별  |
 |::: |BS2_SUB_EVENT_IDENTIFY_FINGER_PIN  |0x02  |지문과 PIN 인증으로 사용자 식별  |
@@ 줄 142: / 줄 171: @@
 |::: |BS2_SUB_EVENT_CREDENTIAL_AOC_PIN  |0x06  |유효하지 않은 AOC PIN  |
 |::: |BS2_SUB_EVENT_CREDENTIAL_AOC_FINGER  |0x07  |유효하지 않은 AOC 지문  |
+|::: |BS2_SUB_EVENT_CREDENTIAL_MOBILE_CARD  |0x08  |유효하지 않은 Mobile카드 (+V2.8)  |
 |Auth  |BS2_SUB_EVENT_AUTH_FAIL_INVALID_AUTH_MODE  |0x01  |유효하지 않은 인증 모드  |
 |::: |BS2_SUB_EVENT_AUTH_FAIL_INVALID_CREDENTIAL  |0x02  |인증 모드에 설정되지 않은 인증 수단  |
@@ 줄 176: / 줄 206: @@
 |::: |BS2_EVENT_USER_DELETE_ALL_SUCCESS  |0x2600  |전체 사용자 삭제 성공  |
 |::: |BS2_EVENT_USER_ISSUE_AOC_SUCCESS  |0x2700  |Access card로 인증 성공 |
+|::: |BS2_EVENT_USER_DUPLICATE_CREDENTIAL  |0x2800  |중복 인증(카드/지문/얼굴)정보 검출 |
 |Device  |BS2_EVENT_DEVICE_SYSTEM_RESET  |0x3000  |시스템 다시 시작  |
 |::: |BS2_EVENT_DEVICE_SYSTEM_STARTED  |0x3100  |시스템이 시작됨  |
@@ 줄 262: / 줄 293: @@
 |:::|BS2_TNA_KEY_15|0|15|
 |:::|BS2_TNA_KEY_16|Esc|16|
+</WRAP>
+\\
+**[+ 2.6.3] param의 추가기능** \\
+event code가 사용자와 관련된 경우에 한합니다. \\
+장치에서 직접 사용자를 추가 또는 편집, 삭제하였다면 param은 1, BioStar를 통해 이루어졌다면 0입니다.\\
+예를들어 BS2_EVENT_USER_ENROLL_SUCCESS와 함께 param이 1이었다면, 장치에서 직접 추가된 사용자를 나타냅니다.\\
+이 기능은 아래의 펌웨어 버전 이후부터 지원합니다.
+<WRAP group 60%>
+^장치 종류 ^지원 버전  ^
+|BioStation 2 |V1.7.0 |
+|BioStation A2 |V1.6.0 |
+|CoreStation 40 |V1.2.0 |
+|BioEntry P2 |V1.2.0 |
+|BioStation L2 |V1.4.0 |
+|BioLite N2 |V1.1.0 |
+|BioEntry W2 |V1.3.0 |
+|FaceStation 2 |V1.2.0|
 </WRAP>
 \\ \\
@@ 줄 307: / 줄 355: @@
 <WRAP group 50%>
 ^값  ^설명  ^
-|0     |없음  |
+|0x0000  |없음  |
-|1     |BS2EventExtInfo 구조체 |
+|0x0001  |BS2EventExtInfo 구조체 |
-|2     |User ID |
+|0x0002  |User ID |
-|4     |Card ID |
+|0x0004  |Card ID |
-|8     |Door ID |
+|0x0008  |Door ID |
-|16    |Zone ID |
+|0x0010  |Zone ID |
-|32    |BS2EventExtIoDevice 구조체  |
+|0x0020  |BS2EventExtIoDevice 구조체  |
-|64    |Door ID |
+|0x0040  |TNA Key |
-|128   |Zone ID |
+|0x0080  |Job Code |
-|256   |TNA Key |
+|0x0100  |Image |
-|512   |Job Code |
+|0x0200  |Temperature |
-|1024  |Image |
+|0xFFFF  |ALL |
-|65535 |ALL |
 </WRAP>
 . //id// \\
@@ 줄 328: / 줄 375: @@
 로그와 관련된 사용자 식별자로써 사용자와 관련 없는 로그일 경우 0으로 설정됩니다. \\ \\
 . //cardID// \\
-로그와 관련된 card 식별자로써 card와 관련 없는 로그일 경우 0으로 설정됩니다. \\ \\
+로그와 관련된 card 식별자로써 card와 관련 없는 로그일 경우 0으로 설정됩니다. \\
+인증 실패의 경우에만 기록하며, 인증 성공의 경우에는 eventMask와 상관없이 user ID를 리턴합니다. \\ \\
 . //doorID// \\
 로그와 관련된 door 식별자로써 door와 관련 없는 로그일 경우 0으로 설정됩니다. \\ \\
@@ 줄 402: / 줄 450: @@
 </WRAP>
 . //reserved// \\
+예약된 공간입니다.\\ \\
+==== BS2EventSmallBlob ====
+<code cpp>
+typedef struct {
+    uint16_t eventMask;
+    uint32_t id;
+    BS2EventExtInfo info;
+    union
+    {
+	BS2_USER_ID userID;                       // valid if eventMask has BS2_EVENT_MASK_USER_ID
+	uint8_t cardID[BS2_CARD_DATA_SIZE];       // valid if eventMask has BS2_EVENT_MASK_CARD_ID
+	BS2_DOOR_ID doorID;                       // valid if eventMask has BS2_EVENT_MASK_DOOR_ID
+	BS2_ZONE_ID zoneID;                       // valid if eventMask has BS2_EVENT_MASK_ZONE_ID
+	BS2EventExtIoDevice ioDevice;             // valid if eventMask has BS2_EVENT_MASK_IODEVICE
+    };
+    uint8_t tnaKey;
+    uint32_t jobCode;
+    uint16_t imageSize;
+    uint8_t* imageObj;                        // valid if eventMask has BS2_EVENT_MASK_IMAGE
+    uint8_t reserved;
+} BS2EventSmallBlob;
+</code>
+\\
+. //eventMask// \\
+Event mask값입니다. mask값에 따라서 해당 ID(User, card, door, zone)값을 인식할 수 있습니다.\\ \\
+<WRAP group 50%>
+^값  ^설명  ^
+|0x0000  |없음  |
+|0x0001  |BS2EventExtInfo 구조체 |
+|0x0002  |User ID |
+|0x0004  |Card ID |
+|0x0008  |Door ID |
+|0x0010  |Zone ID |
+|0x0020  |BS2EventExtIoDevice 구조체  |
+|0x0040  |TNA Key |
+|0x0080  |Job Code |
+|0x0100  |Image |
+|0x0200  |Temperature |
+|0xFFFF  |ALL |
+</WRAP>
+. //id// \\
+로그 레코드의 식별자이며 로그가 발생될 때마다 1부터 자동으로 증가합니다. \\ \\
+. //info// \\
+BS2EventExtInfo 구조체 정보입니다. \\ \\
+. //userID// \\
+로그와 관련된 사용자 식별자로써 사용자와 관련 없는 로그일 경우 0으로 설정됩니다. \\ \\
+. //cardID// \\
+로그와 관련된 card 식별자로써 card와 관련 없는 로그일 경우 0으로 설정됩니다. \\
+인증 실패의 경우에만 기록하며, 인증 성공의 경우에는 eventMask와 상관없이 user ID를 리턴합니다. \\ \\
+. //doorID// \\
+로그와 관련된 door 식별자로써 door와 관련 없는 로그일 경우 0으로 설정됩니다. \\ \\
+. //zoneID// \\
+로그와 관련된 zone 식별자로써 zone와 관련 없는 로그일 경우 0으로 설정됩니다. \\ \\
+. //ioDevice// \\
+Door나 Input 장치의 식별자로 Door나 Input 장치와 관련 없는 로그일 경우 0으로 설정됩니다. (BS2EventExtIoDevice 구조체 참고)\\ \\
+. //tnaKey// \\
+이벤트 발생 장치의 추가 정보가 필요할 경우에만 사용되고, 주로 근태 코드나 출입문이나 입력 장치의 포트 번호가 저장됩니다 \\ \\
+. //jobCode// \\
+사용자 정보에 JobCode가 존재했을 경우에, JobCode 사용하여 인증 할 때 사용자의 JobCode 값을 말합니다. \\ \\
+. //imageSize// \\
+이벤트 발생되었을 때 이미지 size를 말합니다. \\ \\
+. //imageObj// \\
+이벤트 발생되었을 때 이미지 정보가 포함될 경우에 사용됩니다 \\ \\
+. //reserved// \\
+예약된 공간입니다.\\ \\
+==== BS2EventSmallBlobEx ====
+<code cpp>
+typedef struct {
+    uint16_t eventMask;
+    uint32_t id;
+    BS2EventExtInfo info;                         // valid if eventMask has BS2_EVENT_MASK_INFO
+    union
+    {
+        BS2_USER_ID userID;                       // valid if eventMask has BS2_EVENT_MASK_USER_ID
+        uint8_t cardID[BS2_CARD_DATA_SIZE];       // valid if eventMask has BS2_EVENT_MASK_CARD_ID
+        BS2_DOOR_ID doorID;                       // valid if eventMask has BS2_EVENT_MASK_DOOR_ID
+        BS2_ZONE_ID zoneID;                       // valid if eventMask has BS2_EVENT_MASK_ZONE_ID
+        BS2EventExtIoDevice ioDevice;             // valid if eventMask has BS2_EVENT_MASK_IODEVICE
+    };
+    uint8_t tnaKey;                               // valid if eventMask has BS2_EVENT_MASK_TNA_KEY
+    uint32_t jobCode;                             // valid if eventMask has BS2_EVENT_MASK_JOB_CODE
+    uint16_t imageSize;                           // valid if eventMask has BS2_EVENT_MASK_IMAGE
+    uint8_t* imageObj;                            // valid if eventMask has BS2_EVENT_MASK_IMAGE
+    uint8_t reserved;
+    uint32_t temperature;                         // valid if eventMask has BS2_EVENT_MASK_TEMPERATURE
+} BS2EventSmallBlobEx;
+</code>
+\\
+. //eventMask// \\
+Event mask값입니다. mask값에 따라서 해당 ID(User, card, door, zone)값을 인식할 수 있습니다.\\ \\
+<WRAP group 50%>
+^값  ^설명  ^
+|0x0000  |없음  |
+|0x0001  |BS2EventExtInfo 구조체 |
+|0x0002  |User ID |
+|0x0004  |Card ID |
+|0x0008  |Door ID |
+|0x0010  |Zone ID |
+|0x0020  |BS2EventExtIoDevice 구조체  |
+|0x0040  |TNA Key |
+|0x0080  |Job Code |
+|0x0100  |Image |
+|0x0200  |Temperature |
+|0xFFFF  |ALL |
+</WRAP>
+. //id// \\
+로그 레코드의 식별자이며 로그가 발생될 때마다 1부터 자동으로 증가합니다. \\ \\
+. //info// \\
+BS2EventExtInfo 구조체 정보입니다. \\ \\
+. //userID// \\
+로그와 관련된 사용자 식별자로써 사용자와 관련 없는 로그일 경우 0으로 설정됩니다. \\ \\
+. //cardID// \\
+로그와 관련된 card 식별자로써 card와 관련 없는 로그일 경우 0으로 설정됩니다. \\
+인증 실패의 경우에만 기록하며, 인증 성공의 경우에는 eventMask와 상관없이 user ID를 리턴합니다. \\ \\
+. //doorID// \\
+로그와 관련된 door 식별자로써 door와 관련 없는 로그일 경우 0으로 설정됩니다. \\ \\
+. //zoneID// \\
+로그와 관련된 zone 식별자로써 zone와 관련 없는 로그일 경우 0으로 설정됩니다. \\ \\
+. //ioDevice// \\
+Door나 Input 장치의 식별자로 Door나 Input 장치와 관련 없는 로그일 경우 0으로 설정됩니다. (BS2EventExtIoDevice 구조체 참고)\\ \\
+. //tnaKey// \\
+이벤트 발생 장치의 추가 정보가 필요할 경우에만 사용되고, 주로 근태 코드나 출입문이나 입력 장치의 포트 번호가 저장됩니다 \\ \\
+. //jobCode// \\
+사용자 정보에 JobCode가 존재했을 경우에, JobCode 사용하여 인증 할 때 사용자의 JobCode 값을 말합니다. \\ \\
+. //imageSize// \\
+이벤트 발생되었을 때 이미지 size를 말합니다. \\ \\
+. //imageObj// \\
+이벤트 발생되었을 때 이미지 정보가 포함될 경우에 사용됩니다 \\ \\
+. //temperature// \\
+열화상 카메라가 설치되어 있으며, 로그를 남기도록 설정이 되어 있는경우 체온정보가 설정됩니다. [[configuration api#BS2FaceConfigExt|auditTemperature 참조]] \\ \\
+. //reserved// \\
 예약된 공간입니다.\\ \\