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#

EmberAfPluginCompactLoggerMessageInfo

Compact Logger

API#

void
emberAfPluginCompactLoggerInit(void)

Initialize compact logger.

EmberStatus
emberAfPluginCompactLoggerAdd(uint16_t logMessageId, uint16_t logDataLength, uint8_t *logData)

Add compact log.

uint16_t
emberAfPluginCompactLoggerGetLogCount(void)

Get log count.

EmberStatus
emberAfPluginCompactLoggerInitIterator(void)

Initialize compact logger iterator.

EmberStatus
emberAfPluginCompactLoggerGetLogMessageInfoByIterator(EmberAfPluginCompactLoggerMessageInfo *info)

Get log message info by using the iterator.

EmberStatus
emberAfPluginCompactLoggerGetLogMessageDataByIterator(uint16_t indexIntoEntry, uint16_t maxMessageSize, uint16_t *returnDataSize, uint8_t *returnData)

Get log message data by using the iterator.

EmberStatus
emberAfPluginCompactLoggerIteratorNextEntry(void)

Compact logger iterator next entry.

EmberStatus
emberAfPluginCompactLoggerUpdateAllLogsWithUtcTime(uint32_t currentUtcTimeSeconds)

Update all logs with UTC time.

void
emberAfPluginCompactLoggerPrintAllMessages(void)

Print all messages.

EmberStatus
emberAfPluginCompactLoggerGetEntryByNumber(uint32_t entryNumber, EmberAfPluginCompactLoggerMessageInfo *info)

Get entry by number.

bool
emberAfPluginCompactLoggerCheckFacilityAndSeverity(EmberCompactLoggerSeverity severity, uint16_t facility)

Check facility and severity.

void
emberAfPluginCompactLoggerSetFacility(uint16_t facility)

Set facility.

EmberStatus
emberAfPluginCompactLoggerSetSeverity(EmberCompactLoggerSeverity severity)

Set severity.

Enumerations#

enum
EmberCompactLoggerSeverity {
EMBER_AF_PLUGIN_COMPACT_LOGGER_SEVERITY_CRITICAL
EMBER_AF_PLUGIN_COMPACT_LOGGER_SEVERITY_NOTICE
EMBER_AF_PLUGIN_COMPACT_LOGGER_SEVERITY_DEBUG
}

Typedefs#

Macros#

#define
EMBER_AF_PLUGIN_COMPACT_LOGGER_FACILITY_ALL 0xFFFF
#define
EMBER_AF_PLUGIN_COMPACT_LOGGER_BITMASK_UTC_TIME_SYNC 0x01
#define
EMBER_AF_PLUGIN_COMPACT_LOGGER_BITMASK_MS_PRECISION 0x02

API Documentation#

emberAfPluginCompactLoggerInit#

void emberAfPluginCompactLoggerInit (void )

Initialize compact logger.

Parameters
TypeDirectionArgument NameDescription
voidN/A

Definition at line 73 of file app/framework/plugin/compact-logger/compact-logger.h

emberAfPluginCompactLoggerAdd#

EmberStatus emberAfPluginCompactLoggerAdd (uint16_t logMessageId, uint16_t logDataLength, uint8_t * logData)

Add compact log.

Parameters
TypeDirectionArgument NameDescription
uint16_tN/AlogMessageId

message id Ver.: always

uint16_tN/AlogDataLength

data length Ver.: always

uint8_t *N/AlogData

data Ver.: always

Returns

  • EmberStatus status


Definition at line 83 of file app/framework/plugin/compact-logger/compact-logger.h

emberAfPluginCompactLoggerGetLogCount#

uint16_t emberAfPluginCompactLoggerGetLogCount (void )

Get log count.

Parameters
TypeDirectionArgument NameDescription
voidN/A

Returns

  • uint16_t Log count


Definition at line 91 of file app/framework/plugin/compact-logger/compact-logger.h

emberAfPluginCompactLoggerInitIterator#

EmberStatus emberAfPluginCompactLoggerInitIterator (void )

Initialize compact logger iterator.

Parameters
TypeDirectionArgument NameDescription
voidN/A

Returns

  • EmberStatus status


Definition at line 98 of file app/framework/plugin/compact-logger/compact-logger.h

emberAfPluginCompactLoggerGetLogMessageInfoByIterator#

EmberStatus emberAfPluginCompactLoggerGetLogMessageInfoByIterator (EmberAfPluginCompactLoggerMessageInfo * info)

Get log message info by using the iterator.

Parameters
TypeDirectionArgument NameDescription
EmberAfPluginCompactLoggerMessageInfo *N/Ainfo

pointer to struct to store log info

Returns

  • EmberStatus status code


Definition at line 107 of file app/framework/plugin/compact-logger/compact-logger.h

emberAfPluginCompactLoggerGetLogMessageDataByIterator#

EmberStatus emberAfPluginCompactLoggerGetLogMessageDataByIterator (uint16_t indexIntoEntry, uint16_t maxMessageSize, uint16_t * returnDataSize, uint8_t * returnData)

Get log message data by using the iterator.

Parameters
TypeDirectionArgument NameDescription
uint16_tN/AindexIntoEntry

Ver.: always

uint16_tN/AmaxMessageSize

Ver.: always

uint16_t *N/AreturnDataSize

Ver.: always

uint8_t *N/AreturnData

Ver.: always

Returns

  • EmberStatus status code


Definition at line 118 of file app/framework/plugin/compact-logger/compact-logger.h

emberAfPluginCompactLoggerIteratorNextEntry#

EmberStatus emberAfPluginCompactLoggerIteratorNextEntry (void )

Compact logger iterator next entry.

Parameters
TypeDirectionArgument NameDescription
voidN/A

Returns

  • EmberStatus status code


Definition at line 128 of file app/framework/plugin/compact-logger/compact-logger.h

emberAfPluginCompactLoggerUpdateAllLogsWithUtcTime#

EmberStatus emberAfPluginCompactLoggerUpdateAllLogsWithUtcTime (uint32_t currentUtcTimeSeconds)

Update all logs with UTC time.

Parameters
TypeDirectionArgument NameDescription
uint32_tN/AcurrentUtcTimeSeconds

UTC time in seconds Ver.: always

Returns

  • EmberStatus status code


Definition at line 137 of file app/framework/plugin/compact-logger/compact-logger.h

emberAfPluginCompactLoggerPrintAllMessages#

void emberAfPluginCompactLoggerPrintAllMessages (void )

Print all messages.

Parameters
TypeDirectionArgument NameDescription
voidN/A

Definition at line 142 of file app/framework/plugin/compact-logger/compact-logger.h

emberAfPluginCompactLoggerGetEntryByNumber#

EmberStatus emberAfPluginCompactLoggerGetEntryByNumber (uint32_t entryNumber, EmberAfPluginCompactLoggerMessageInfo * info)

Get entry by number.

Parameters
TypeDirectionArgument NameDescription
uint32_tN/AentryNumber
EmberAfPluginCompactLoggerMessageInfo *N/Ainfo

pointer to struct where info will be stored Ver.: always

Returns

  • EmberStatus status code


Definition at line 151 of file app/framework/plugin/compact-logger/compact-logger.h

emberAfPluginCompactLoggerCheckFacilityAndSeverity#

bool emberAfPluginCompactLoggerCheckFacilityAndSeverity (EmberCompactLoggerSeverity severity, uint16_t facility)

Check facility and severity.

Parameters
TypeDirectionArgument NameDescription
EmberCompactLoggerSeverityN/Aseverity

Ver.: always

uint16_tN/Afacility

Ver.: always

Returns

  • bool


Definition at line 162 of file app/framework/plugin/compact-logger/compact-logger.h

emberAfPluginCompactLoggerSetFacility#

void emberAfPluginCompactLoggerSetFacility (uint16_t facility)

Set facility.

Parameters
TypeDirectionArgument NameDescription
uint16_tN/Afacility

Ver.: always


Definition at line 170 of file app/framework/plugin/compact-logger/compact-logger.h

emberAfPluginCompactLoggerSetSeverity#

EmberStatus emberAfPluginCompactLoggerSetSeverity (EmberCompactLoggerSeverity severity)

Set severity.

Parameters
TypeDirectionArgument NameDescription
EmberCompactLoggerSeverityN/Aseverity

Ver.: always

Returns

  • EmberStatus status code


Definition at line 178 of file app/framework/plugin/compact-logger/compact-logger.h

Enumeration Documentation#

EmberCompactLoggerSeverity#

EmberCompactLoggerSeverity
Enumerator
EMBER_AF_PLUGIN_COMPACT_LOGGER_SEVERITY_CRITICAL
EMBER_AF_PLUGIN_COMPACT_LOGGER_SEVERITY_NOTICE
EMBER_AF_PLUGIN_COMPACT_LOGGER_SEVERITY_DEBUG

Definition at line 55 of file app/framework/plugin/compact-logger/compact-logger.h

Typedef Documentation#

EmberAfPluginCompactLoggerMessageBitmask#

typedef uint8_t EmberAfPluginCompactLoggerMessageBitmask

Definition at line 42 of file app/framework/plugin/compact-logger/compact-logger.h