Stay organized with collections Save and categorize content based on your preferences.

Link Metrics

This module includes functions that control the Link Metrics protocol.

Summary

Enumerations

otLinkMetricsEnhAckFlags{
  OT_LINK_METRICS_ENH_ACK_CLEAR = 0,
  OT_LINK_METRICS_ENH_ACK_REGISTER = 1
}
enum
Enhanced-ACK Flags.
otLinkMetricsStatus enum
Link Metrics Status values.

Typedefs

otLinkMetricsEnhAckFlags typedef
Enhanced-ACK Flags.
otLinkMetricsEnhAckProbingIeReportCallback)(otShortAddress aShortAddress, const otExtAddress *aExtAddress, const otLinkMetricsValues *aMetricsValues, void *aContext) typedef
void(*
This function pointer is called when Enh-ACK Probing IE is received.
otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, uint8_t aStatus, void *aContext) typedef
void(*
This function pointer is called when a Link Metrics Management Response is received.
otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, uint8_t aStatus, void *aContext) typedef
void(*
This function pointer is called when a Link Metrics report is received.
otLinkMetricsSeriesFlags typedef
This structure represents which frames are accounted in a Forward Tracking Series.
otLinkMetricsStatus typedef
Link Metrics Status values.
otLinkMetricsValues typedef
This structure represents the result (value) for a Link Metrics query.

Functions

otLinkMetricsConfigEnhAckProbing(otInstance *aInstance, const otIp6Address *aDestination, otLinkMetricsEnhAckFlags aEnhAckFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext, otLinkMetricsEnhAckProbingIeReportCallback aEnhAckCallback, void *aEnhAckCallbackContext)
This function sends an MLE Link Metrics Management Request to configure/clear an Enhanced-ACK Based Probing.
otLinkMetricsConfigForwardTrackingSeries(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, otLinkMetricsSeriesFlags aSeriesFlags, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsMgmtResponseCallback aCallback, void *aCallbackContext)
Sends an MLE Link Metrics Management Request to configure or clear a Forward Tracking Series.
otLinkMetricsQuery(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsReportCallback aCallback, void *aCallbackContext)
This function sends an MLE Data Request to query Link Metrics.
otLinkMetricsSendLinkProbe(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, uint8_t aLength)
Sends an MLE Link Probe message.

Structs

otLinkMetricsSeriesFlags

This structure represents which frames are accounted in a Forward Tracking Series.

otLinkMetricsValues

This structure represents the result (value) for a Link Metrics query.

Enumerations

Typedefs

Functions

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.