Factory Diagnostics - Thread Stack

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

Functions

otError otDiagProcessCmd (otInstance *aInstance, uint8_t aArgsLength, char *aArgs[], char *aOutput, size_t aOutputMaxLen)
 This function processes a factory diagnostics command line.
 
otError 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.

Detailed Description

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

Function Documentation

◆ otDiagIsEnabled()

bool otDiagIsEnabled ( otInstance aInstance)

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

Parameters
[in]aInstanceA pointer to an OpenThread instance.
Return values
TRUEif factory diagnostics mode is enabled
FALSEif factory diagnostics mode is disabled.

◆ otDiagProcessCmd()

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

This function processes a factory diagnostics command line.

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

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aArgsLengthThe number of elements in aArgs.
[in]aArgsAn array of arguments.
[out]aOutputThe diagnostics execution result.
[in]aOutputMaxLenThe output buffer size.
Return values
OT_ERROR_INVALID_ARGSThe command is supported but invalid arguments provided.
OT_ERROR_NONEThe command is successfully process.
OT_ERROR_NOT_IMPLEMENTEDThe command is not supported.

◆ otDiagProcessCmdLine()

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

This function processes a factory diagnostics command line.

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

Parameters
[in]aInstanceA pointer to an OpenThread instance.
[in]aStringA NULL-terminated input string.
[out]aOutputThe diagnostics execution result.
[in]aOutputMaxLenThe output buffer size.
Return values
OT_ERROR_NONEThe command is successfully process.
OT_ERROR_INVALID_ARGSThe command is supported but invalid arguments provided.
OT_ERROR_NOT_IMPLEMENTEDThe command is not supported.
OT_ERROR_NO_BUFSThe command string is too long.