Factory Diagnostics

This module includes the platform abstraction for diagnostics features.

Summary

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

void otPlatDiagAlarmCallback(
  otInstance *aInstance
)

This function processes the alarm event.

Details

Parameters

[in] aInstance

The OpenThread instance for current request.

void otPlatDiagChannelSet(
  uint8_t aChannel
)

This function sets the channel to use for factory diagnostics.

Details

Parameters

[in] aChannel

The channel value.

bool otPlatDiagModeGet(
  void
)

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

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

void otPlatDiagModeSet(
  bool aMode
)

This function enables/disables the factory diagnostics mode.

Details

Parameters

[in] aMode

TRUE to enable diagnostics mode, FALSE otherwise.

void otPlatDiagProcess(
  otInstance *aInstance,
  int argc,
  char *argv[],
  char *aOutput,
  size_t aOutputMaxLen
)

This function processes a factory diagnostics command line.

Details

Parameters

`[in] aInstance`	The OpenThread instance for current request.
`[in] argc`	The argument counter of diagnostics command line.
`[in] argv`	The argument vector of diagnostics command line.
`[out] aOutput`	The diagnostics execution result.
`[in] aOutputMaxLen`	The output buffer size.

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

This function processes the received radio frame.

Details

Parameters

`[in] aInstance`	The OpenThread instance for current request.
`[in] aFrame`	The received radio frame.
`[in] aError`	The received radio frame status.

void otPlatDiagTxPowerSet(
  int8_t aTxPower
)

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

Details

Parameters

[in] aTxPower

The transmit power value.