Factory Diagnostics

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

Summary

Functions

otDiagIsEnabled(otInstance *aInstance)
bool
This function indicates whether or not the factory diagnostics mode is enabled.
otDiagProcessCmd(otInstance *aInstance, int aArgCount, char *aArgVector[], char *aOutput, size_t aOutputMaxLen)
void
This function processes a factory diagnostics command line.
otDiagProcessCmdLine(otInstance *aInstance, const char *aString, char *aOutput, size_t aOutputMaxLen)
void
This function processes a factory diagnostics command line.

Functions

otDiagIsEnabled

bool otDiagIsEnabled(
  otInstance *aInstance
)

This function 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

void otDiagProcessCmd(
  otInstance *aInstance,
  int aArgCount,
  char *aArgVector[],
  char *aOutput,
  size_t aOutputMaxLen
)

This function processes a factory diagnostics command line.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
[in] aArgCount
The argument counter of diagnostics command line.
[in] aArgVector
The argument vector of diagnostics command line.
[out] aOutput
The diagnostics execution result.
[in] aOutputMaxLen
The output buffer size.

otDiagProcessCmdLine

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

This function processes a factory diagnostics command line.

Details
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.