openthread.h File Reference

This file defines the top-level functions for the OpenThread library. More...

#include <openthread/crypto.h>
#include <openthread/dataset.h>
#include <openthread/instance.h>
#include <openthread/ip6.h>
#include <openthread/link.h>
#include <openthread/message.h>
#include <openthread/netdata.h>
#include <openthread/tasklet.h>
#include <openthread/thread.h>
#include <openthread/types.h>

Go to the source code of this file.

Functions
OTAPI const char *OTCALL	otGetVersionString (void)
	Get the OpenThread version string. More...
OTAPI const char *OTCALL	otThreadErrorToString (otError aError)
	This function converts an otError enum into a string. More...

Detailed Description

This file defines the top-level functions for the OpenThread library.

Function Documentation

otGetVersionString()

OTAPI const char* OTCALL otGetVersionString

(

void

)

Get the OpenThread version string.

Returns

A pointer to the OpenThread version.

PLATFORM_VERSION_ATTR_PREFIX and PLATFORM_VERSION_ATTR_SUFFIX are intended to be used to specify compiler directives to indicate what linker section the platform version string should be stored.

This is useful for specifying an exact locaiton of where the version string will be located so that it can be easily retrieved from the raw firmware image.

If PLATFORM_VERSION_ATTR_PREFIX is unspecified, the keyword static is used instead.

If both are unspecified, the location of the string in the firmware image will be undefined and may change.

otThreadErrorToString()

OTAPI const char* OTCALL otThreadErrorToString

(

otError

aError

)

This function converts an otError enum into a string.

Parameters

[in]

aError

An otError enum.

Returns

A string representation of an otError.