Factory Diagnostics - Thread Stack#

This module includes functions that control the Thread stack's execution.

Functions#

void
otDiagSetOutputCallback(otInstance *aInstance, otDiagOutputCallback aCallback, void *aContext)

Sets the diag output callback.

otDiagProcessCmd(otInstance *aInstance, uint8_t aArgsLength, char *aArgs[])

Processes a factory diagnostics command line.

otDiagProcessCmdLine(otInstance *aInstance, const char *aString)

Processes a factory diagnostics command line.

bool
otDiagIsEnabled(otInstance *aInstance)

Indicates whether or not the factory diagnostics mode is enabled.

Typedef Documentation#

otDiagOutputCallback#

typedef otPlatDiagOutputCallback otDiagOutputCallback

Function Documentation#

otDiagSetOutputCallback#

void otDiagSetOutputCallback (otInstance * aInstance, otDiagOutputCallback aCallback, void * aContext)

Sets the diag output callback.

Parameters
TypeDirectionArgument NameDescription
otInstance *[in]aInstance

The OpenThread instance structure.

otDiagOutputCallback[in]aCallback

A pointer to a function that is called on outputting diag messages.

void *[in]aContext

A pointer to the user context.


otDiagProcessCmd#

otError otDiagProcessCmd (otInstance * aInstance, uint8_t aArgsLength, char * aArgs)

Processes a factory diagnostics command line.

Parameters
TypeDirectionArgument NameDescription
otInstance *[in]aInstance

A pointer to an OpenThread instance.

uint8_t[in]aArgsLength

The number of elements in aArgs.

char *[in]aArgs

An array of arguments.


otDiagProcessCmdLine#

otError otDiagProcessCmdLine (otInstance * aInstance, const char * aString)

Processes a factory diagnostics command line.

Parameters
TypeDirectionArgument NameDescription
otInstance *[in]aInstance

A pointer to an OpenThread instance.

const char *[in]aString

A NULL-terminated input string.


otDiagIsEnabled#

bool otDiagIsEnabled (otInstance * aInstance)

Indicates whether or not the factory diagnostics mode is enabled.

Parameters
TypeDirectionArgument NameDescription
otInstance *[in]aInstance

A pointer to an OpenThread instance.