Factory Diagnostics - Thread Stack

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

Summary

Typedefs
otDiagOutputCallback typedef

Functions
otDiagIsEnabled(otInstance *aInstance)
bool
Indicates whether or not the factory diagnostics mode is enabled.
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.
otDiagSetOutputCallback(otInstance *aInstance, otDiagOutputCallback aCallback, void *aContext)
void
Sets the diag output callback.

Typedefs

otDiagOutputCallback

otPlatDiagOutputCallback otDiagOutputCallback

Functions

otDiagIsEnabled

bool otDiagIsEnabled(
  otInstance *aInstance
)

Indicates whether or not the factory diagnostics mode is enabled.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Return Values
TRUE
if factory diagnostics mode is enabled
FALSE
if factory diagnostics mode is disabled.

otDiagProcessCmd

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

Processes a factory diagnostics command line.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aArgsLength
The number of elements in aArgs.
[in] aArgs
An array of arguments.
Return Values
OT_ERROR_INVALID_ARGS
The command is supported but invalid arguments provided.
OT_ERROR_NONE
The command is successfully process.
OT_ERROR_NOT_IMPLEMENTED
The command is not supported.

otDiagProcessCmdLine

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

Processes a factory diagnostics command line.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aString
A NULL-terminated input string.
Return Values
OT_ERROR_NONE
The command is successfully process.
OT_ERROR_INVALID_ARGS
The command is supported but invalid arguments provided.
OT_ERROR_NOT_IMPLEMENTED
The command is not supported.
OT_ERROR_NO_BUFS
The command string is too long.

otDiagSetOutputCallback

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

Sets the diag output callback.

Details
Parameters
[in] aInstance
The OpenThread instance structure.
[in] aCallback
A pointer to a function that is called on outputting diag messages.
[in] aContext
A pointer to the user context.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.