Log Management API

장치의 로그를 제어하는 API입니다.

• BS2_GetLog: 일정량의 로그를 가져옵니다.
• BS2_GetFilteredLog: [지원중단] 조건에 맞는 로그를 가져옵니다.
• 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를 사용해서 체온정보를 포함한 로그를 가져옵니다.

장치로부터 새로운 로그를 수신했을 때 호출되는 콜백 함수입니다.

typedef void (*OnLogReceived)(uint32_t deviceId, BS2Event* log);

1. deviceId
새로운 로그를 보내준 장치 ID입니다.

2. log
새로운 로그 정보 구조체입니다.

[+ V2.7.1] 장치로부터 새로운 로그를 수신했을 때 호출되는 콜백 함수입니다.
열화상 카메라를 통해 측정된 체온이 세번째 인자로 수신되며, BS2FaceConfigExt의 auditTemperature가 true로 설정되어져야 합니다.

typedef void (*OnLogReceivedEx)(uint32_t deviceId, BS2Event* log, uint32_t temperature);

1. deviceId
새로운 로그를 보내준 장치 ID입니다.

2. log
새로운 로그 정보 구조체입니다.

3. temperature
새로운 로그 발생 시, 측정된 체온 정보입니다.

typedef struct {
    uint32_t id;
    uint32_t dateTime;
    uint32_t deviceID;
    union {
        char userID[BS2_USER_ID_SIZE];
        uint32_t uid;
        uint32_t doorID;
        uint32_t liftID;
        uint32_t zoneID;
        struct {
            uint32_t ioDeviceID;
            uint16_t port;
            int8_t value;
            uint8_t reserved[25];
        };
        struct {
            uint32_t zoneID;
            uint32_t doorID;
            uint32_t ioDeviceID;
            uint16_t port;
            uint8_t reserved[18];
        } alarm;
        struct {
            uint32_t zoneID;
            uint32_t doorID[4];
            uint8_t reserved[12];
        } interlock;
        struct {
            uint16_t relayPort;
            uint16_t inputPort;
            uint8_t reserved[28];
        } relayAction;
        struct {
            BS2_DEVICE_ID deviceId;
            uint8_t data[28];
        } osdpStandard;
    };
    union {
        uint16_t code;
        struct {
            uint8_t subCode;
            uint8_t mainCode;
        };
    };
    uint8_t param;
#ifdef LESS_THAN_SDK_2_6_0
    BS2_BOOL image;         // Deprecated in V2.6.0
#else
    uint8_t image: 1;       // bit 단위 분할하여 image 및 DST 지원
    uint8_t isDST: 1;
    uint8_t half: 1;
    uint8_t hour: 4;
    uint8_t negative: 1;
#endif
} BS2Event;

1. id
로그 레코드의 식별자이며 로그가 발생될 때마다 1부터 자동으로 증가합니다.

2. dateTime
로그가 발생된 시간 정보이며, UTC로부터 현재까지 흐른 초(sec) 수를 의미합니다.

3. deviceID
로그가 발생된 장치 식별자입니다.

4. userID
로그와 관련된 사용자 식별자로써 사용자와 관련 없는 로그일 경우 0으로 설정됩니다.

5. uid
출입문에 대한 로그라면 doorID를, 구역에 대한 로그라면 zoneID를 참조하면 되지만,
이를 정확히 알 수 없는 경우 uid를 참조하면 됩니다.
uid, doorID, liftID, zoneID는 union으로 선언되어 있기때문에 기본적으로 같은 정보를 의미합니다.

6. doorID
로그가 발생된 출입문 식별자입니다.

7. liftID
로그가 발생된 리프트 식별자입니다.

8. zoneID
로그가 발생된 구역 식별자입니다.

9. ioDeviceID
Door나 Input 장치의 식별자로 Door나 Input 장치와 관련 없는 로그일 경우 0으로 설정됩니다.

10. port
ioDeviceID에 대한 port를 의미합니다.

11. value
ioDeviceID에 대한 port value를 나타하며 다음을 의미합니다.
BS2_PORT_VALUE_UNKNOWN : -1
BS2_PORT_VALUE_OPEN : 0
BS2_PORT_VALUE_CLOSED : 1
BS2_PORT_VALUE_SUPERVISED_SHORT : 2
BS2_PORT_VALUE_SUPERVISED_OPEN : 3

12. alarm.zoneID
침입탐지 구역 경보 발생 시 구역에대한 식별자를 의미합니다.

13. alarm.doorID
침입탐지 구역 경보를 발생시킨 출입문 식별자를 의미합니다.

14. interlock.zoneID
인터락 위반을 발생시킨 구역 식별자를 의미합니다.

15. interlock.doorID
인터락 위반을 발생시킨 출입문 식별자를 의미합니다.

16. relayAction.relayPort
IM-120에서 RelayAction 동작 시 relay의 port 식별자입니다.

17. relayAction.inputPort
IM-120에서 RelayAction 동작 시 input의 port 식별자입니다.

18. osdpStandard.deviceId
OSDP standard 장치의 식별자입니다.

19. osdpStandard.data
OSDP standard 장치에서 발생된 총 28byte 크기의 알림 구조체 정보입니다.
구조체에 대한 상세한 정보는 BS2OsdpStandardDeviceNotify를 참조하세요.

20. subCode
로그 유형의 하위 코드 값입니다. 추가 정보가 필요할 경우 사용하십시오.

21. mainCode
로그 유형의 주코드 값입니다.

22. param
이벤트 발생 장치의 추가 정보가 필요할 경우에만 사용되고, 주로 근태 코드나 출입문이나 입력 장치의 포트 번호가 저장됩니다. 근태 코드가 저장될 때는 아래의 코드표를 참고하십시오.

[+ 2.6.3] param의 추가기능
event code가 사용자와 관련된 경우에 한합니다.
장치에서 직접 사용자를 추가 또는 편집, 삭제하였다면 param은 1, BioStar를 통해 이루어졌다면 0입니다.
예를들어 BS2_EVENT_USER_ENROLL_SUCCESS와 함께 param이 1이었다면, 장치에서 직접 추가된 사용자를 나타냅니다.
이 기능은 아래의 펌웨어 버전 이후부터 지원합니다.

23. image
SDK V2.6.0 이전까지는 1byte 전체를 사용하여 다음을 의미했습니다.
- 이벤트 발생되었을 때 이미지 정보가 포함되었는지 여부 (true/false).
SDK V2.6.0 부터는 1byte를 bit 단위로 나누어 다음의 정보를 제공할 수 있도록 변경되었습니다.
- 이미지 정보가 포함되었는지 여부
- DST 적용 여부

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 image[BS2_EVENT_MAX_IMAGE_SIZE];
    uint8_t reserved;
} BS2EventBlob;

1. eventMask
Event mask값입니다. mask값에 따라서 해당 ID(User, card, door, zone)값을 인식할 수 있습니다.

2. id
로그 레코드의 식별자이며 로그가 발생될 때마다 1부터 자동으로 증가합니다.

3. info
BS2EventExtInfo 구조체 정보입니다.

4. userID
로그와 관련된 사용자 식별자로써 사용자와 관련 없는 로그일 경우 0으로 설정됩니다.

5. cardID
로그와 관련된 card 식별자로써 card와 관련 없는 로그일 경우 0으로 설정됩니다.
인증 실패의 경우에만 기록하며, 인증 성공의 경우에는 eventMask와 상관없이 user ID를 리턴합니다.

6. doorID
로그와 관련된 door 식별자로써 door와 관련 없는 로그일 경우 0으로 설정됩니다.

7. zoneID
로그와 관련된 zone 식별자로써 zone와 관련 없는 로그일 경우 0으로 설정됩니다.

8. ioDevice
Door나 Input 장치의 식별자로 Door나 Input 장치와 관련 없는 로그일 경우 0으로 설정됩니다. (BS2EventExtIoDevice 구조체 참고)

9. tnaKey
이벤트 발생 장치의 추가 정보가 필요할 경우에만 사용되고, 주로 근태 코드나 출입문이나 입력 장치의 포트 번호가 저장됩니다

10. jobCode
사용자 정보에 JobCode가 존재했을 경우에, JobCode 사용하여 인증 할 때 사용자의 JobCode 값을 말합니다.

11. imageSize
이벤트 발생되었을 때 이미지 size를 말합니다.

12. image
이벤트 발생되었을 때 이미지 정보가 포함될 경우에 사용됩니다

13. reserved
예약된 공간입니다.

typedef struct {
    uint32_t dateTime;
    uint32_t deviceID;    
    union {                                       ///< 2 bytes
		BS2_EVENT_CODE code;
		struct {
			uint8_t subCode;
			uint8_t mainCode;
		};
	};
	uint8_t reserved[2];
} BS2EventExtInfo;

1. dateTime
로그가 발생된 시간 정보이며, UTC로부터 현재까지 흐른 초(sec) 수를 의미합니다.

2. deviceID
로그가 발생된 장치 식별자입니다.

3. subCode
로그 유형의 하위 코드 값입니다. 추가 정보가 필요할 경우 사용하십시오

4. mainCode
로그 유형의 주코드 값입니다.

5. reserved
예약된 공간입니다.

typedef struct {
    uint32_t ioDeviceID;
    uint16_t port;    
    uint8_t value;
    uint8_t reserved[1];
} BS2EventExtInfo;

1. ioDeviceID
Door나 Input 장치의 식별자로 Door나 Input 장치와 관련 없는 로그일 경우 0으로 설정됩니다.

2. port
입력 port number입니다.

3. value
입력 port 상태를 말합니다.

4. reserved
예약된 공간입니다.

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;

1. eventMask
Event mask값입니다. mask값에 따라서 해당 ID(User, card, door, zone)값을 인식할 수 있습니다.

2. id
로그 레코드의 식별자이며 로그가 발생될 때마다 1부터 자동으로 증가합니다.

3. info
BS2EventExtInfo 구조체 정보입니다.

4. userID
로그와 관련된 사용자 식별자로써 사용자와 관련 없는 로그일 경우 0으로 설정됩니다.

5. cardID
로그와 관련된 card 식별자로써 card와 관련 없는 로그일 경우 0으로 설정됩니다.
인증 실패의 경우에만 기록하며, 인증 성공의 경우에는 eventMask와 상관없이 user ID를 리턴합니다.

6. doorID
로그와 관련된 door 식별자로써 door와 관련 없는 로그일 경우 0으로 설정됩니다.

7. zoneID
로그와 관련된 zone 식별자로써 zone와 관련 없는 로그일 경우 0으로 설정됩니다.

8. ioDevice
Door나 Input 장치의 식별자로 Door나 Input 장치와 관련 없는 로그일 경우 0으로 설정됩니다. (BS2EventExtIoDevice 구조체 참고)

9. tnaKey
이벤트 발생 장치의 추가 정보가 필요할 경우에만 사용되고, 주로 근태 코드나 출입문이나 입력 장치의 포트 번호가 저장됩니다

10. jobCode
사용자 정보에 JobCode가 존재했을 경우에, JobCode 사용하여 인증 할 때 사용자의 JobCode 값을 말합니다.

11. imageSize
이벤트 발생되었을 때 이미지 size를 말합니다.

12. imageObj
이벤트 발생되었을 때 이미지 정보가 포함될 경우에 사용됩니다

13. reserved
예약된 공간입니다.

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;

1. eventMask
Event mask값입니다. mask값에 따라서 해당 ID(User, card, door, zone)값을 인식할 수 있습니다.

2. id
로그 레코드의 식별자이며 로그가 발생될 때마다 1부터 자동으로 증가합니다.

3. info
BS2EventExtInfo 구조체 정보입니다.

4. userID
로그와 관련된 사용자 식별자로써 사용자와 관련 없는 로그일 경우 0으로 설정됩니다.

5. cardID
로그와 관련된 card 식별자로써 card와 관련 없는 로그일 경우 0으로 설정됩니다.
인증 실패의 경우에만 기록하며, 인증 성공의 경우에는 eventMask와 상관없이 user ID를 리턴합니다.

6. doorID
로그와 관련된 door 식별자로써 door와 관련 없는 로그일 경우 0으로 설정됩니다.

7. zoneID
로그와 관련된 zone 식별자로써 zone와 관련 없는 로그일 경우 0으로 설정됩니다.

8. ioDevice
Door나 Input 장치의 식별자로 Door나 Input 장치와 관련 없는 로그일 경우 0으로 설정됩니다. (BS2EventExtIoDevice 구조체 참고)

9. tnaKey
이벤트 발생 장치의 추가 정보가 필요할 경우에만 사용되고, 주로 근태 코드나 출입문이나 입력 장치의 포트 번호가 저장됩니다

10. jobCode
사용자 정보에 JobCode가 존재했을 경우에, JobCode 사용하여 인증 할 때 사용자의 JobCode 값을 말합니다.

11. imageSize
이벤트 발생되었을 때 이미지 size를 말합니다.

12. imageObj
이벤트 발생되었을 때 이미지 정보가 포함될 경우에 사용됩니다

13. temperature
열화상 카메라가 설치되어 있으며, 로그를 남기도록 설정이 되어 있는경우 체온정보가 설정됩니다. auditTemperature 참조

14. reserved
예약된 공간입니다.