otPlatDiagRadioGetPowerSettings(otInstance *aInstance, uint8_t aChannel, int16_t *aTargetPower, int16_t *aActualPower, uint8_t *aRawPowerSetting, uint16_t *aRawPowerSettingLength)

Get the power settings for the given channel.

Enumeration Documentation#

otGpioMode#

otGpioMode

Defines the gpio modes.

Enumerator
OT_GPIO_MODE_INPUT	Input mode without pull resistor.
OT_GPIO_MODE_OUTPUT	Output mode.

Definition at line 60 of file include/openthread/platform/diag.h

Typedef Documentation#

otPlatDiagOutputCallback#

typedef void(* otPlatDiagOutputCallback) (const char *aFormat, va_list aArguments, void *aContext) )(const char *aFormat, va_list aArguments, void *aContext)

Pointer to callback to output platform diag messages.

Parameters

[in]	aFormat	The format string.
[in]	aArguments	The format string arguments.
[out]	aContext	A pointer to the user context.

Definition at line 73 of file include/openthread/platform/diag.h

Function Documentation#

otPlatDiagSetOutputCallback#

void otPlatDiagSetOutputCallback (otInstance * aInstance, otPlatDiagOutputCallback aCallback, void * aContext)

Sets the platform diag output callback.

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.

Definition at line 82 of file include/openthread/platform/diag.h

otPlatDiagProcess#

otError otPlatDiagProcess (otInstance * aInstance, uint8_t aArgsLength, char * aArgs)

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.

Definition at line 95 of file include/openthread/platform/diag.h

otPlatDiagModeSet#

void otPlatDiagModeSet (bool aMode)

Enables/disables the factory diagnostics mode.

Parameters

[in]

aMode

TRUE to enable diagnostics mode, FALSE otherwise.

Definition at line 102 of file include/openthread/platform/diag.h

otPlatDiagModeGet#

bool otPlatDiagModeGet (void )

Indicates whether or not factory diagnostics mode is enabled.

Parameters

N/A

Returns

TRUE if factory diagnostics mode is enabled, FALSE otherwise.

Definition at line 109 of file include/openthread/platform/diag.h

otPlatDiagChannelSet#

void otPlatDiagChannelSet (uint8_t aChannel)

Sets the channel to use for factory diagnostics.

Parameters

[in]

aChannel

The channel value.

Definition at line 116 of file include/openthread/platform/diag.h

otPlatDiagTxPowerSet#

void otPlatDiagTxPowerSet (int8_t aTxPower)

Sets the transmit power to use for factory diagnostics.

Parameters

[in]

aTxPower

The transmit power value.

Definition at line 123 of file include/openthread/platform/diag.h

otPlatDiagRadioReceived#

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

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.

Definition at line 132 of file include/openthread/platform/diag.h

otPlatDiagAlarmCallback#

void otPlatDiagAlarmCallback (otInstance * aInstance)

Processes the alarm event.

Parameters

[in]

aInstance

The OpenThread instance for current request.

Definition at line 139 of file include/openthread/platform/diag.h

otPlatDiagGpioSet#

otError otPlatDiagGpioSet (uint32_t aGpio, bool aValue)

Sets the gpio value.

Parameters

[in]	aGpio	The gpio number.
[in]	aValue	true to set the gpio to high level, or false otherwise.

Definition at line 153 of file include/openthread/platform/diag.h

otPlatDiagGpioGet#

otError otPlatDiagGpioGet (uint32_t aGpio, bool * aValue)

Gets the gpio value.

Parameters

[in]	aGpio	The gpio number.
[out]	aValue	A pointer where to put gpio value.

Definition at line 167 of file include/openthread/platform/diag.h

otPlatDiagGpioSetMode#

otError otPlatDiagGpioSetMode (uint32_t aGpio, otGpioMode aMode)

Sets the gpio mode.

Parameters

[in]	aGpio	The gpio number.
[out]	aMode	The gpio mode.

Definition at line 181 of file include/openthread/platform/diag.h

otPlatDiagGpioGetMode#

otError otPlatDiagGpioGetMode (uint32_t aGpio, otGpioMode * aMode)

Gets the gpio mode.

Parameters

[in]	aGpio	The gpio number.
[out]	aMode	A pointer where to put gpio mode.

Definition at line 196 of file include/openthread/platform/diag.h

otPlatDiagRadioSetRawPowerSetting#

otError otPlatDiagRadioSetRawPowerSetting (otInstance * aInstance, const uint8_t * aRawPowerSetting, uint16_t aRawPowerSettingLength)

Set the radio raw power setting for diagnostics module.

Parameters

[in]	aInstance	The OpenThread instance structure.
[in]	aRawPowerSetting	A pointer to the raw power setting byte array.
[in]	aRawPowerSettingLength	The length of the `aRawPowerSetting`.

Definition at line 209 of file include/openthread/platform/diag.h

otPlatDiagRadioGetRawPowerSetting#

otError otPlatDiagRadioGetRawPowerSetting (otInstance * aInstance, uint8_t * aRawPowerSetting, uint16_t * aRawPowerSettingLength)

Get the radio raw power setting for diagnostics module.

Parameters

[in]	aInstance	The OpenThread instance structure.
[out]	aRawPowerSetting	A pointer to the raw power setting byte array.
[inout]	aRawPowerSettingLength	On input, a pointer to the size of `aRawPowerSetting`. On output, a pointer to the length of the raw power setting data.

Definition at line 227 of file include/openthread/platform/diag.h

otPlatDiagRadioRawPowerSettingEnable#

otError otPlatDiagRadioRawPowerSettingEnable (otInstance * aInstance, bool aEnable)

Enable/disable the platform layer to use the raw power setting set by otPlatDiagRadioSetRawPowerSetting().

Parameters

[in]	aInstance	The OpenThread instance structure.
[in]	aEnable	TRUE to enable or FALSE to disable the raw power setting.

Definition at line 240 of file include/openthread/platform/diag.h

otPlatDiagRadioTransmitCarrier#

otError otPlatDiagRadioTransmitCarrier (otInstance * aInstance, bool aEnable)

Start/stop the platform layer to transmit continuous carrier wave.

Parameters

[in]	aInstance	The OpenThread instance structure.
[in]	aEnable	TRUE to enable or FALSE to disable the platform layer to transmit continuous carrier wave.

Definition at line 252 of file include/openthread/platform/diag.h

otPlatDiagRadioTransmitStream#

otError otPlatDiagRadioTransmitStream (otInstance * aInstance, bool aEnable)

Start/stop the platform layer to transmit stream of characters.

Parameters

[in]	aInstance	The OpenThread instance structure.
[in]	aEnable	TRUE to enable or FALSE to disable the platform layer to transmit stream.

Definition at line 264 of file include/openthread/platform/diag.h

otPlatDiagRadioGetPowerSettings#

otError otPlatDiagRadioGetPowerSettings (otInstance * aInstance, uint8_t aChannel, int16_t * aTargetPower, int16_t * aActualPower, uint8_t * aRawPowerSetting, uint16_t * aRawPowerSettingLength)

Get the power settings for the given channel.

Parameters

[in]	aInstance	The OpenThread instance structure.
[in]	aChannel	The radio channel.
[out]	aTargetPower	The target power in 0.01 dBm.
[out]	aActualPower	The actual power in 0.01 dBm.
[out]	aRawPowerSetting	A pointer to the raw power setting byte array.
[inout]	aRawPowerSettingLength	On input, a pointer to the size of `aRawPowerSetting`. On output, a pointer to the length of the raw power setting data.

Definition at line 283 of file include/openthread/platform/diag.h