Factory Diagnostics

This module includes the platform abstraction for diagnostics features.

Functions

otError otPlatDiagProcess (otInstance *aInstance, uint8_t aArgsLength, char *aArgs[], char *aOutput, size_t aOutputMaxLen)
 This function processes a factory diagnostics command line.
 
void otPlatDiagModeSet (bool aMode)
 This function enables/disables the factory diagnostics mode.
 
bool otPlatDiagModeGet (void)
 This function indicates whether or not factory diagnostics mode is enabled.
 
void otPlatDiagChannelSet (uint8_t aChannel)
 This function sets the channel to use for factory diagnostics.
 
void otPlatDiagTxPowerSet (int8_t aTxPower)
 This function sets the transmit power to use for factory diagnostics.
 
void otPlatDiagRadioReceived (otInstance *aInstance, otRadioFrame *aFrame, otError aError)
 This function processes the received radio frame.
 
void otPlatDiagAlarmCallback (otInstance *aInstance)
 This function processes the alarm event.

Detailed Description

This module includes the platform abstraction for diagnostics features.

Function Documentation

◆ otPlatDiagAlarmCallback()

void otPlatDiagAlarmCallback ( otInstance aInstance)

This function processes the alarm event.

Parameters
[in]aInstanceThe OpenThread instance for current request.

◆ otPlatDiagChannelSet()

void otPlatDiagChannelSet ( uint8_t  aChannel)

This function sets the channel to use for factory diagnostics.

Parameters
[in]aChannelThe channel value.

◆ otPlatDiagModeGet()

bool otPlatDiagModeGet ( void  )

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

Returns
TRUE if factory diagnostics mode is enabled, FALSE otherwise.

◆ otPlatDiagModeSet()

void otPlatDiagModeSet ( bool  aMode)

This function enables/disables the factory diagnostics mode.

Parameters
[in]aModeTRUE to enable diagnostics mode, FALSE otherwise.

◆ otPlatDiagProcess()

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

This function processes a factory diagnostics command line.

Parameters
[in]aInstanceThe OpenThread instance for current request.
[in]aArgsLengthThe number of arguments in aArgs.
[in]aArgsThe arguments of diagnostics command line.
[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_INVALID_COMMANDThe command is not valid or not supported.

◆ otPlatDiagRadioReceived()

void otPlatDiagRadioReceived ( otInstance aInstance,
otRadioFrame aFrame,
otError  aError 
)

This function processes the received radio frame.

Parameters
[in]aInstanceThe OpenThread instance for current request.
[in]aFrameThe received radio frame.
[in]aErrorThe received radio frame status.

◆ otPlatDiagTxPowerSet()

void otPlatDiagTxPowerSet ( int8_t  aTxPower)

This function sets the transmit power to use for factory diagnostics.

Parameters
[in]aTxPowerThe transmit power value.