Radio Statistics

This module includes functions for radio statistics.

Summary

Typedefs
otRadioTimeStats typedef
Contains the statistics of radio.

Functions
otRadioTimeStatsGet(otInstance *aInstance)
Gets the radio statistics.
otRadioTimeStatsReset(otInstance *aInstance)
void
Resets the radio statistics.

Structs
otRadioTimeStats

Contains the statistics of radio.

Typedefs

otRadioTimeStats

struct otRadioTimeStats otRadioTimeStats

Contains the statistics of radio.

Functions

otRadioTimeStatsGet

const otRadioTimeStats * otRadioTimeStatsGet(
  otInstance *aInstance
)

Gets the radio statistics.

The radio statistics include the time when the radio is in TX/RX/Sleep state. These times are in units of microseconds. All times are calculated from the last reset of radio statistics.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.
Returns
A const pointer to the otRadioTimeStats struct that contains the data.

otRadioTimeStatsReset

void otRadioTimeStatsReset(
  otInstance *aInstance
)

Resets the radio statistics.

All times are reset to 0.

Details
Parameters
[in] aInstance
A pointer to an OpenThread instance.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.