Factory Diagnostics - Thread Stack#

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

Functions#

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

This function processes a factory diagnostics command line.

otDiagProcessCmdLine(otInstance *aInstance, const char *aString, char *aOutput, size_t aOutputMaxLen)

This function processes a factory diagnostics command line.

bool
otDiagIsEnabled(otInstance *aInstance)

This function indicates whether or not the factory diagnostics mode is enabled.

Function Documentation#

otDiagProcessCmd#

otError otDiagProcessCmd (otInstance *aInstance, uint8_t aArgsLength, char *aArgs[], char *aOutput, size_t aOutputMaxLen)

This function processes a factory diagnostics command line.

Parameters
[in]aInstance

A pointer to an OpenThread instance.

[in]aArgsLength

The number of elements in aArgs.

[in]aArgs

An array of arguments.

[out]aOutput

The diagnostics execution result.

[in]aOutputMaxLen

The output buffer size.

The output of this function (the content written to aOutput) MUST terminate with \0 and the \0 is within the output buffer.


Definition at line 71 of file include/openthread/diag.h

otDiagProcessCmdLine#

otError otDiagProcessCmdLine (otInstance *aInstance, const char *aString, char *aOutput, size_t aOutputMaxLen)

This function processes a factory diagnostics command line.

Parameters
[in]aInstance

A pointer to an OpenThread instance.

[in]aString

A NULL-terminated input string.

[out]aOutput

The diagnostics execution result.

[in]aOutputMaxLen

The output buffer size.

The output of this function (the content written to aOutput) MUST terminate with \0 and the \0 is within the output buffer.


Definition at line 94 of file include/openthread/diag.h

otDiagIsEnabled#

bool otDiagIsEnabled (otInstance *aInstance)

This function indicates whether or not the factory diagnostics mode is enabled.

Parameters
[in]aInstance

A pointer to an OpenThread instance.


Definition at line 105 of file include/openthread/diag.h