Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:log_management_api [2021/08/06 15:40] kateyu [BS2Event] |
en:log_management_api [2024/02/22 10:34] kkshin |
||
|---|---|---|---|
| Line 5: | Line 5: | ||
| * [[BS2_GetLog]]: Gets certain amount of logs. | * [[BS2_GetLog]]: Gets certain amount of logs. | ||
| - | * [[BS2_GetFilteredLog]]: Gets filtered logs. | + | * [[BS2_GetFilteredLog]]: ''[Deprecated]'' Gets filtered logs. |
| * [[BS2_ClearLog]]: Deletes all logs. | * [[BS2_ClearLog]]: Deletes all logs. | ||
| * [[BS2_StartMonitoringLog]]: Starts Real-time log streaming. | * [[BS2_StartMonitoringLog]]: Starts Real-time log streaming. | ||
| Line 11: | Line 11: | ||
| * [[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. | ||
| - | * [[BS2_GetFilteredLogSinceEventId]]: Gets filtered logs. | + | * [[BS2_GetFilteredLogSinceEventId]]: ''[Deprecated]'' Gets filtered logs. |
| * [[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] Gets certain amount of logs based on the event mask in an efficient way, including the temperature information. | + | * [[BS2_GetLogSmallBlobEx]]: [+ 2.7.1] Gets certain amount of logs based on the event mask in an efficient way, including the temperature information. |
| ===== Callback Function ===== | ===== Callback Function ===== | ||
| ==== OnLogReceived ==== | ==== OnLogReceived ==== | ||
| Line 74: | Line 74: | ||
| uint8_t reserved[12]; | uint8_t reserved[12]; | ||
| } interlock; | } interlock; | ||
| - | struct { | + | struct { |
| - | uint16_t relayPort; | + | uint16_t relayPort; |
| - | uint16_t inputPort; | + | uint16_t inputPort; |
| - | uint8_t reserved[28]; | + | uint8_t reserved[28]; |
| - | } relayAction; | + | } relayAction; |
| + | struct { | ||
| + | BS2_DEVICE_ID deviceId; | ||
| + | uint8_t data[28]; | ||
| + | } osdpStandard; | ||
| }; | }; | ||
| union { | union { | ||
| Line 91: | Line 95: | ||
| BS2_BOOL image; // Deprecated in V2.6.0 | BS2_BOOL image; // Deprecated in V2.6.0 | ||
| #else | #else | ||
| - | uint8_t image: 1; // Support image and DST by bit division | + | uint8_t image: 1; // Supports image and DST by splitting bit unit |
| uint8_t isDST: 1; | uint8_t isDST: 1; | ||
| uint8_t half: 1; | uint8_t half: 1; | ||
| Line 142: | Line 146: | ||
| **17. //relayAction.inputPort//** \\ | **17. //relayAction.inputPort//** \\ | ||
| Relay port identifier when IM-120 RelayAction takes place. \\ \\ | Relay port identifier when IM-120 RelayAction takes place. \\ \\ | ||
| - | **18. //subCode//** \\ | + | **18. //osdpStandard.deviceId//** \\ |
| + | Identifier of the OSDP standard device. \\ \\ | ||
| + | **19. //osdpStandard.data//** \\ | ||
| + | This is notification structure information with a total size of 28 bytes generated from OSDP standard devices. \\ | ||
| + | For detailed information about the structure, please refer to [[slave_control_api#BS2OsdpStandardDeviceNotify|BS2OsdpStandardDeviceNotify]]. \\ \\ | ||
| + | **20. //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 ^ | ||
| Line 194: | Line 203: | ||
| |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//** \\ | + | **21. //mainCode//** \\ |
| Main code value of log types. \\ | Main code value of log types. \\ | ||
| ^Category ^Event code ^Value ^Description ^ | ^Category ^Event code ^Value ^Description ^ | ||
| Line 282: | Line 291: | ||
| - | **20.//param//** \\ | + | **22.//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 324: | Line 333: | ||
| \\ \\ | \\ \\ | ||
| - | **21. //image//** \\ | + | **23. //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). \\ \\ | ||