Logging

This module includes the platform abstraction for the debug log service.

Summary

Enumerations

otLogRegion{
  OT_LOG_REGION_API = 1,
  OT_LOG_REGION_MLE = 2,
  OT_LOG_REGION_ARP = 3,
  OT_LOG_REGION_NET_DATA = 4,
  OT_LOG_REGION_ICMP = 5,
  OT_LOG_REGION_IP6 = 6,
  OT_LOG_REGION_MAC = 7,
  OT_LOG_REGION_MEM = 8,
  OT_LOG_REGION_NCP = 9,
  OT_LOG_REGION_MESH_COP = 10,
  OT_LOG_REGION_NET_DIAG = 11,
  OT_LOG_REGION_PLATFORM = 12,
  OT_LOG_REGION_COAP = 13,
  OT_LOG_REGION_CLI = 14,
  OT_LOG_REGION_CORE = 15,
  OT_LOG_REGION_UTIL = 16
}
enum
This enumeration represents log regions.

Typedefs

otLogLevel typedef
uint8_t
This type represents the log level.
otLogRegion typedef
This enumeration represents log regions.

Functions

otPlatLog(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, ...)
void
This function outputs logs.
otPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list ap)
void
This function outputs logs.

Enumerations

otLogRegion

 otLogRegion

This enumeration represents log regions.

Properties
OT_LOG_REGION_API

OpenThread API.

OT_LOG_REGION_ARP

EID-to-RLOC mapping.

OT_LOG_REGION_CLI

CLI.

OT_LOG_REGION_COAP

CoAP.

OT_LOG_REGION_CORE

OpenThread Core.

OT_LOG_REGION_ICMP

ICMPv6.

OT_LOG_REGION_IP6

IPv6.

OT_LOG_REGION_MAC

IEEE 802.15.4 MAC.

OT_LOG_REGION_MEM

Memory.

OT_LOG_REGION_MESH_COP

Mesh Commissioning Protocol.

OT_LOG_REGION_MLE

MLE.

OT_LOG_REGION_NCP

NCP.

OT_LOG_REGION_NET_DATA

Network Data.

OT_LOG_REGION_NET_DIAG

Network Diagnostic.

OT_LOG_REGION_PLATFORM

Platform.

OT_LOG_REGION_UTIL

Utility module.

Typedefs

otLogLevel

uint8_t otLogLevel

This type represents the log level.

otLogRegion

enum otLogRegion otLogRegion

This enumeration represents log regions.

Functions

otPlatLog

void otPlatLog(
  otLogLevel aLogLevel,
  otLogRegion aLogRegion,
  const char *aFormat,
  ...
)

This function outputs logs.

Details
Parameters
[in] aLogLevel
The log level.
[in] aLogRegion
The log region.
[in] aFormat
A pointer to the format string.
[in] ...
Arguments for the format specification.

otPlatLogv

void otPlatLogv(
  otLogLevel aLogLevel,
  otLogRegion aLogRegion,
  const char *aFormat,
  va_list ap
)

This function outputs logs.

Details
Parameters
[in] aLogLevel
The log level.
[in] aLogRegion
The log region.
[in] aFormat
A pointer to the format string.
[in] ap
va_list matching information for aFormat

Macros

OT_LOG_LEVEL_CRIT

 OT_LOG_LEVEL_CRIT 1

Log level Critical.

OT_LOG_LEVEL_DEBG

 OT_LOG_LEVEL_DEBG 5

Log level Debug.

OT_LOG_LEVEL_INFO

 OT_LOG_LEVEL_INFO 4

Log level Informational.

OT_LOG_LEVEL_NONE

 OT_LOG_LEVEL_NONE 0

Log level None.

OT_LOG_LEVEL_NOTE

 OT_LOG_LEVEL_NOTE 3

Log level Notice.

OT_LOG_LEVEL_WARN

 OT_LOG_LEVEL_WARN 2

Log level Warning.