This module includes the platform abstraction for diagnostics features. More...
Functions | |
| otError | otPlatDiagProcess (otInstance *aInstance, uint8_t aArgsLength, char *aArgs[], char *aOutput, size_t aOutputMaxLen) |
| void | otPlatDiagModeSet (bool aMode) |
| bool | otPlatDiagModeGet (void) |
| void | otPlatDiagChannelSet (uint8_t aChannel) |
| void | otPlatDiagTxPowerSet (int8_t aTxPower) |
| void | otPlatDiagRadioReceived (otInstance *aInstance, otRadioFrame *aFrame, otError aError) |
| void | otPlatDiagAlarmCallback (otInstance *aInstance) |
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] aInstance The OpenThread instance for current request.
◆ otPlatDiagChannelSet()
| void otPlatDiagChannelSet | ( | uint8_t | aChannel | ) |
This function sets the channel to use for factory diagnostics.
- Parameters
-
[in] aChannel The 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] aMode TRUE 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] aInstance The OpenThread instance for current request. [in] aArgsLength The number of arguments in aArgs.[in] aArgs The arguments of diagnostics command line. [out] aOutput The diagnostics execution result. [in] aOutputMaxLen The output buffer size.
- Return values
-
OT_ERROR_INVALID_ARGS The command is supported but invalid arguments provided. OT_ERROR_NONE The command is successfully process. OT_ERROR_INVALID_COMMAND The 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] aInstance The OpenThread instance for current request. [in] aFrame The received radio frame. [in] aError The received radio frame status.
◆ otPlatDiagTxPowerSet()
| void otPlatDiagTxPowerSet | ( | int8_t | aTxPower | ) |
This function sets the transmit power to use for factory diagnostics.
- Parameters
-
[in] aTxPower The transmit power value.