Logging - Thread Stack#

otGetLogLevel#

otLogLevel otGetLogLevel (otInstance * aInstance)

Returns the current log level for a given OpenThread instance.

If dynamic log level feature OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE is enabled, this function returns the currently set dynamic log level:

• In a single-instance configuration, it returns the instance's log level.

• In a multi-instance configuration, it returns the instance-specific log level if it has been explicitly set (see otSetLogLevel()). Otherwise, it returns the global log level (see otLoggingGetLevel()).

If the dynamic log level feature is not enabled, this function returns the build-time configured log level.

Returns

• The log level.

otSetLogLevel#

otError otSetLogLevel (otInstance * aInstance, otLogLevel aLogLevel)

Sets the log level for a given OpenThread instance.

Note

• This function requires OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE=1.

In a single-instance configuration, this function sets the log level for the instance.

In a multi-instance configuration (OPENTHREAD_CONFIG_MULTIPLE_INSTANCE_ENABLE), if OPENTHREAD_CONFIG_LOG_INSTANCE_AWARE_API_ENABLE is not enabled, this function returns OT_ERROR_NOT_CAPABLE. When the log level is explicitly set on an instance, it overrides the global log level set using otLoggingSetLevel().

otLoggingGetLevel#

otLogLevel otLoggingGetLevel (void )

Returns the current global log level.

In a single-instance configuration, this function behaves the same as otGetLogLevel(). In a multi-instance configuration, it returns the global log level which is used for all instances.

Returns

• The global log level.

otLoggingSetLevel#

otError otLoggingSetLevel (otLogLevel aLogLevel)

Sets the global log level.

Note

• This function requires OPENTHREAD_CONFIG_LOG_LEVEL_DYNAMIC_ENABLE=1.

In a single-instance configuration, this function behaves the same as otSetLogLevel() (which is the recommended function to use).

In a multi-instance configuration, it sets the global log level which is used by all instances. The log level can be explicitly set on a specific instance using otSetLogLevel(), which will then be used instead of the global value.

otLogCritPlat#

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

Emits a log message at critical log level.

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.

otLogWarnPlat#

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

Emits a log message at warning log level.

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.

otLogNotePlat#

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

Emits a log message at note log level.

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.

otLogInfoPlat#

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

Emits a log message at info log level.

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.

otLogDebgPlat#

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

Emits a log message at debug log level.

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.

otDumpCritPlat#

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

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.

otDumpWarnPlat#

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

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.

otDumpNotePlat#

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

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.

otDumpInfoPlat#

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

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.

otDumpDebgPlat#

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

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.

otLogPlat#

void otLogPlat (otLogLevel aLogLevel, const char * aPlatModuleName, const char * aFormat, ... )

Emits a log message at given log level using a platform module name.

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

The aPlatModuleName name is used to determine the log module name in the emitted log message, following the P-{PlatModuleName}--- format. This means that the prefix string "P-" is added to indicate that this is a platform sub-module, followed by the next 12 characters of the PlatModuleName string, with padded hyphens - at the end to ensure that the region name is 14 characters long.

otLogPlatArgs#

void otLogPlatArgs (otLogLevel aLogLevel, const char * aPlatModuleName, const char * aFormat, va_list aArgs)

Emits a log message at given log level using a platform module name.

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

The aPlatModuleName name is used to determine the log module name in the emitted log message, following the P-{PlatModuleName}--- format. This means that the prefix string "P-" is added to indicate that this is a platform sub-module, followed by the next 12 characters of the PlatModuleName string, with padded hyphens - at the end to ensure that the region name is 14 characters long.

otLogCli#

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

Emits a log message at a given log level.

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.

otLogGenerateNextHexDumpLine#

otError otLogGenerateNextHexDumpLine (otLogHexDumpInfo * aInfo)

Generates the next hex dump line.

Can call this method back-to-back to generate the hex dump output line by line. On the first call the mIterator field in aInfo MUST be set to zero.

Here is an example of the generated hex dump output:

"==========================[{mTitle} len=070]============================" "| 41 D8 87 34 12 FF FF 25 | 4C 57 DA F2 FB 2F 62 7F | A..4...%LW.../b. |" "| 3B 01 F0 4D 4C 4D 4C 54 | 4F 00 15 15 00 00 00 00 | ;..MLMLTO....... |" "| 00 00 00 01 80 DB 60 82 | 7E 33 72 3B CC B3 A1 84 | ......`.~3r;.... |" "| 3B E6 AD B2 0B 45 E7 45 | C5 B9 00 1A CB 2D 6D 1C | ;....E.E.....-m. |" "| 10 3E 3C F5 D3 70 | | .><..p |" "------------------------------------------------------------------------"