Compact Logger#
API and Callbacks for the Compact Logger Component.
This component manages a compact logger that stores log entries encoded with a 2-byte enumeration. Another component must provide the encoding/decoding of the enumerations. This component stores log messages with the following: UTC Time, Time Synchronization, Log Message ID, and variable log message data. It stores the data in a ring-buffer stored in RAM. When space is needed, the oldest log message entries are deleted.
Modules#
sl_zigbee_af_plugin_compact_logger_message_info_t
API#
Initialize compact logger.
Add compact log.
Get log count.
Initialize compact logger iterator.
Get log message info by using the iterator.
Get log message data by using the iterator.
Compact logger iterator next entry.
Update all logs with UTC time.
Print all messages.
Get entry by number.
Check facility and severity.
Set facility.
Set severity.
Enumerations#
Typedefs#
Macros#
API Documentation#
sl_zigbee_af_compact_logger_init#
void sl_zigbee_af_compact_logger_init (void )
Initialize compact logger.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
sl_zigbee_af_compact_logger_add#
sl_status_t sl_zigbee_af_compact_logger_add (uint16_t logMessageId, uint16_t logDataLength, uint8_t * logData)
Add compact log.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | logMessageId | message id Ver.: always |
| uint16_t | N/A | logDataLength | data length Ver.: always |
| uint8_t * | N/A | logData | data Ver.: always |
Returns
sl_status_t status
sl_zigbee_af_compact_logger_get_log_count#
uint16_t sl_zigbee_af_compact_logger_get_log_count (void )
Get log count.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
uint16_t Log count
sl_zigbee_af_compact_logger_init_iterator#
sl_status_t sl_zigbee_af_compact_logger_init_iterator (void )
Initialize compact logger iterator.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
sl_status_t status
sl_zigbee_af_compact_logger_get_log_message_info_by_iterator#
sl_status_t sl_zigbee_af_compact_logger_get_log_message_info_by_iterator (sl_zigbee_af_plugin_compact_logger_message_info_t * info)
Get log message info by using the iterator.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_af_plugin_compact_logger_message_info_t * | N/A | info | pointer to struct to store log info |
Returns
sl_status_t status code
sl_zigbee_af_compact_logger_get_log_message_data_by_iterator#
sl_status_t sl_zigbee_af_compact_logger_get_log_message_data_by_iterator (uint16_t indexIntoEntry, uint16_t maxMessageSize, uint16_t * returnDataSize, uint8_t * returnData)
Get log message data by using the iterator.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | indexIntoEntry | Ver.: always |
| uint16_t | N/A | maxMessageSize | Ver.: always |
| uint16_t * | N/A | returnDataSize | Ver.: always |
| uint8_t * | N/A | returnData | Ver.: always |
Returns
sl_status_t status code
sl_zigbee_af_compact_logger_iterator_next_entry#
sl_status_t sl_zigbee_af_compact_logger_iterator_next_entry (void )
Compact logger iterator next entry.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Returns
sl_status_t status code
sl_zigbee_af_compact_logger_update_all_logs_with_utc_time#
sl_status_t sl_zigbee_af_compact_logger_update_all_logs_with_utc_time (uint32_t currentUtcTimeSeconds)
Update all logs with UTC time.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | N/A | currentUtcTimeSeconds | UTC time in seconds Ver.: always |
Returns
sl_status_t status code
sl_zigbee_af_compact_logger_print_all_messages#
void sl_zigbee_af_compact_logger_print_all_messages (void )
Print all messages.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
sl_zigbee_af_compact_logger_get_entry_by_number#
sl_status_t sl_zigbee_af_compact_logger_get_entry_by_number (uint32_t entryNumber, sl_zigbee_af_plugin_compact_logger_message_info_t * info)
Get entry by number.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint32_t | N/A | entryNumber | |
| sl_zigbee_af_plugin_compact_logger_message_info_t * | N/A | info | pointer to struct where info will be stored Ver.: always |
Returns
sl_status_t status code
sl_zigbee_af_compact_logger_check_facility_and_severity#
bool sl_zigbee_af_compact_logger_check_facility_and_severity (sl_zigbee_compact_logger_severity_t severity, uint16_t facility)
Check facility and severity.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_compact_logger_severity_t | N/A | severity | Ver.: always |
| uint16_t | N/A | facility | Ver.: always |
Returns
bool
sl_zigbee_af_compact_logger_set_facility#
void sl_zigbee_af_compact_logger_set_facility (uint16_t facility)
Set facility.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | N/A | facility | Ver.: always |
sl_zigbee_af_compact_logger_set_severity#
sl_status_t sl_zigbee_af_compact_logger_set_severity (sl_zigbee_compact_logger_severity_t severity)
Set severity.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_zigbee_compact_logger_severity_t | N/A | severity | Ver.: always |
Returns
sl_status_t status code
Enumeration Documentation#
sl_zigbee_compact_logger_severity_t#
sl_zigbee_compact_logger_severity_t
| Enumerator | |
|---|---|
| SL_ZIGBEE_AF_PLUGIN_COMPACT_LOGGER_SEVERITY_CRITICAL | |
| SL_ZIGBEE_AF_PLUGIN_COMPACT_LOGGER_SEVERITY_NOTICE | |
| SL_ZIGBEE_AF_PLUGIN_COMPACT_LOGGER_SEVERITY_DEBUG | |
Typedef Documentation#
sl_zigbee_af_plugin_compact_logger_message_bitmask_t#
typedef uint8_t sl_zigbee_af_plugin_compact_logger_message_bitmask_t