Stay organized with collections Save and categorize content based on your preferences.

Logging - Thread Stack

This module includes OpenThread logging related definitions.

Summary

Functions

otDumpCritPlat(const char *aText, const void *aData, uint16_t aDataLength)
void void void void void void
This function generates a memory dump at critical log level.
otDumpDebgPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
This function generates a memory dump at debug log level.
otDumpInfoPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
This function generates a memory dump at info log level.
otDumpNotePlat(const char *aText, const void *aData, uint16_t aDataLength)
void
This function generates a memory dump at note log level.
otDumpWarnPlat(const char *aText, const void *aData, uint16_t aDataLength)
void
This function generates a memory dump at warning log level.
otLogCli(otLogLevel aLogLevel, const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2
void
This function emits a log message at a given log level.
otLogCritPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void
This function emits a log message at critical log level.
otLogDebgPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void void
This function emits a log message at debug log level.
otLogInfoPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void void
This function emits a log message at info log level.
otLogNotePlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void void
This function emits a log message at note log level.
otLogWarnPlat(const char *aFormat, ...) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1
void void
This function emits a log message at warning log level.
otLoggingGetLevel(void)
This function returns the current log level.
otLoggingSetLevel(otLogLevel aLogLevel)
This function sets the log level.

Functions

otDumpCritPlat

void void void void void void otDumpCritPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

This function generates a memory dump at critical log level.

If OPENTHREAD_CONFIG_LOG_PLATFORM or OPENTHREAD_CONFIG_LOG_PKT_DUMP is not set or the current log level is below critical this function does not emit any log message.

Details
Parameters
[in] aText
A string that is printed before the bytes.
[in] aData
A pointer to the data buffer.
[in] aDataLength
Number of bytes in aData.

otDumpDebgPlat

void otDumpDebgPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

This function generates a memory dump at debug log level.

If OPENTHREAD_CONFIG_LOG_PLATFORM or OPENTHREAD_CONFIG_LOG_PKT_DUMP is not set or the current log level is below debug this function does not emit any log message.

Details
Parameters
[in] aText
A string that is printed before the bytes.
[in] aData
A pointer to the data buffer.
[in] aDataLength
Number of bytes in aData.

otDumpInfoPlat

void otDumpInfoPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

This function generates a memory dump at info log level.

If OPENTHREAD_CONFIG_LOG_PLATFORM or OPENTHREAD_CONFIG_LOG_PKT_DUMP is not set or the current log level is below info this function does not emit any log message.

Details
Parameters
[in] aText
A string that is printed before the bytes.
[in] aData
A pointer to the data buffer.
[in] aDataLength
Number of bytes in aData.

otDumpNotePlat

void otDumpNotePlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

This function generates a memory dump at note log level.

If OPENTHREAD_CONFIG_LOG_PLATFORM or OPENTHREAD_CONFIG_LOG_PKT_DUMP is not set or the current log level is below note this function does not emit any log message.

Details
Parameters
[in] aText
A string that is printed before the bytes.
[in] aData
A pointer to the data buffer.
[in] aDataLength
Number of bytes in aData.

otDumpWarnPlat

void otDumpWarnPlat(
  const char *aText,
  const void *aData,
  uint16_t aDataLength
)

This function generates a memory dump at warning log level.

If OPENTHREAD_CONFIG_LOG_PLATFORM or OPENTHREAD_CONFIG_LOG_PKT_DUMP is not set or the current log level is below warning this function does not emit any log message.

Details
Parameters
[in] aText
A string that is printed before the bytes.
[in] aData
A pointer to the data buffer.
[in] aDataLength
Number of bytes in aData.

otLogCli

void otLogCli(
  otLogLevel aLogLevel,
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(2

This function emits a log message at a given log level.

This function is intended for use by CLI only. If OPENTHREAD_CONFIG_LOG_CLI is not set or the current log level is below the given log level, this function does not emit any log message.

Details
Parameters
[in] aLogLevel
The log level.
[in] aFormat
The format string.
[in] ...
Arguments for the format specification.

otLogCritPlat

void otLogCritPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

This function emits a log message at critical log level.

This function is intended for use by platform. If OPENTHREAD_CONFIG_LOG_PLATFORM is not set or the current log level is below critical, this function does not emit any log message.

Details
Parameters
[in] aFormat
The format string.
[in] ...
Arguments for the format specification.

otLogDebgPlat

void void void void void otLogDebgPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

This function emits a log message at debug log level.

This function is intended for use by platform. If OPENTHREAD_CONFIG_LOG_PLATFORM is not set or the current log level is below debug, this function does not emit any log message.

Details
Parameters
[in] aFormat
The format string.
[in] ...
Arguments for the format specification.

otLogInfoPlat

void void void void otLogInfoPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

This function emits a log message at info log level.

This function is intended for use by platform. If OPENTHREAD_CONFIG_LOG_PLATFORM is not set or the current log level is below info, this function does not emit any log message.

Details
Parameters
[in] aFormat
The format string.
[in] ...
Arguments for the format specification.

otLogNotePlat

void void void otLogNotePlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

This function emits a log message at note log level.

This function is intended for use by platform. If OPENTHREAD_CONFIG_LOG_PLATFORM is not set or the current log level is below note, this function does not emit any log message.

Details
Parameters
[in] aFormat
The format string.
[in] ...
Arguments for the format specification.

otLogWarnPlat

void void otLogWarnPlat(
  const char *aFormat,
  ...
) OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK(1

This function emits a log message at warning log level.

This function is intended for use by platform. If OPENTHREAD_CONFIG_LOG_PLATFORM is not set or the current log level is below warning, this function does not emit any log message.

Details
Parameters
[in] aFormat
The format string.
[in] ...
Arguments for the format specification.

otLoggingGetLevel

otLogLevel otLoggingGetLevel(
  void
)

This function returns the current log level.

If dynamic log level feature OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE is enabled, this function returns the currently set dynamic log level. Otherwise, this function returns the build-time configured log level.

Details
Returns
The log level.

otLoggingSetLevel

otError otLoggingSetLevel(
  otLogLevel aLogLevel
)

This function sets the log level.

Details
Parameters
[in] aLogLevel
The log level.
Return Values
OT_ERROR_NONE
Successfully updated log level.
OT_ERROR_INVALID_ARGS
Log level value is invalid.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.