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.
| N/A |
73 of file app/framework/plugin/compact-logger/compact-logger.hsl_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.
| N/A | logMessageId | message id Ver.: always |
| N/A | logDataLength | data length Ver.: always |
| N/A | logData | data Ver.: always |
Returns
sl_status_t status
83 of file app/framework/plugin/compact-logger/compact-logger.hsl_zigbee_af_compact_logger_get_log_count#
uint16_t sl_zigbee_af_compact_logger_get_log_count (void )
Get log count.
| N/A |
Returns
uint16_t Log count
91 of file app/framework/plugin/compact-logger/compact-logger.hsl_zigbee_af_compact_logger_init_iterator#
sl_status_t sl_zigbee_af_compact_logger_init_iterator (void )
Initialize compact logger iterator.
| N/A |
Returns
sl_status_t status
98 of file app/framework/plugin/compact-logger/compact-logger.hsl_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.
| N/A | info | pointer to struct to store log info |
Returns
sl_status_t status code
107 of file app/framework/plugin/compact-logger/compact-logger.hsl_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.
| N/A | indexIntoEntry | Ver.: always |
| N/A | maxMessageSize | Ver.: always |
| N/A | returnDataSize | Ver.: always |
| N/A | returnData | Ver.: always |
Returns
sl_status_t status code
118 of file app/framework/plugin/compact-logger/compact-logger.hsl_zigbee_af_compact_logger_iterator_next_entry#
sl_status_t sl_zigbee_af_compact_logger_iterator_next_entry (void )
Compact logger iterator next entry.
| N/A |
Returns
sl_status_t status code
128 of file app/framework/plugin/compact-logger/compact-logger.hsl_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.
| N/A | currentUtcTimeSeconds | UTC time in seconds Ver.: always |
Returns
sl_status_t status code
137 of file app/framework/plugin/compact-logger/compact-logger.hsl_zigbee_af_compact_logger_print_all_messages#
void sl_zigbee_af_compact_logger_print_all_messages (void )
Print all messages.
| N/A |
142 of file app/framework/plugin/compact-logger/compact-logger.hsl_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.
| N/A | entryNumber | |
| N/A | info | pointer to struct where info will be stored Ver.: always |
Returns
sl_status_t status code
151 of file app/framework/plugin/compact-logger/compact-logger.hsl_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.
| N/A | severity | Ver.: always |
| N/A | facility | Ver.: always |
Returns
bool
162 of file app/framework/plugin/compact-logger/compact-logger.hsl_zigbee_af_compact_logger_set_facility#
void sl_zigbee_af_compact_logger_set_facility (uint16_t facility)
Set facility.
| N/A | facility | Ver.: always |
170 of file app/framework/plugin/compact-logger/compact-logger.hsl_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.
| N/A | severity | Ver.: always |
Returns
sl_status_t status code
178 of file app/framework/plugin/compact-logger/compact-logger.hEnumeration 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 | |
55 of file app/framework/plugin/compact-logger/compact-logger.hTypedef Documentation#
sl_zigbee_af_plugin_compact_logger_message_bitmask_t#
typedef uint8_t sl_zigbee_af_plugin_compact_logger_message_bitmask_t
42 of file app/framework/plugin/compact-logger/compact-logger.hMacro Definition Documentation#
SL_ZIGBEE_AF_PLUGIN_COMPACT_LOGGER_FACILITY_ALL#
#define SL_ZIGBEE_AF_PLUGIN_COMPACT_LOGGER_FACILITY_ALLValue:
0xFFFF
61 of file app/framework/plugin/compact-logger/compact-logger.hSL_ZIGBEE_AF_PLUGIN_COMPACT_LOGGER_BITMASK_UTC_TIME_SYNC#
#define SL_ZIGBEE_AF_PLUGIN_COMPACT_LOGGER_BITMASK_UTC_TIME_SYNCValue:
0x01
62 of file app/framework/plugin/compact-logger/compact-logger.hSL_ZIGBEE_AF_PLUGIN_COMPACT_LOGGER_BITMASK_MS_PRECISION#
#define SL_ZIGBEE_AF_PLUGIN_COMPACT_LOGGER_BITMASK_MS_PRECISIONValue:
0x02
63 of file app/framework/plugin/compact-logger/compact-logger.h