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(*
Pointer is called when Enh-ACK Probing IE is received.
otLinkMetricsMgmtResponseCallback)(const otIp6Address *aSource, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
Pointer is called when a Link Metrics Management Response is received.
otLinkMetricsReportCallback)(const otIp6Address *aSource, const otLinkMetricsValues *aMetricsValues, otLinkMetricsStatus aStatus, void *aContext) typedef
void(*
Pointer is called when a Link Metrics report is received.
otLinkMetricsSeriesFlags typedef
Represents which frames are accounted in a Forward Tracking Series.
otLinkMetricsStatus typedef
Link Metrics Status values.
otLinkMetricsValues typedef
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)
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.
otLinkMetricsManagerGetMetricsValueByExtAddr(otInstance *aInstance, const otExtAddress *aExtAddress, otLinkMetricsValues *aLinkMetricsValues)
Get Link Metrics data of a neighbor by its extended address.
otLinkMetricsManagerIsEnabled(otInstance *aInstance)
bool
If Link Metrics Manager is enabled.
otLinkMetricsManagerSetEnabled(otInstance *aInstance, bool aEnable)
void
Enable or disable Link Metrics Manager.
otLinkMetricsQuery(otInstance *aInstance, const otIp6Address *aDestination, uint8_t aSeriesId, const otLinkMetrics *aLinkMetricsFlags, otLinkMetricsReportCallback aCallback, void *aCallbackContext)
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

Represents which frames are accounted in a Forward Tracking Series.

otLinkMetricsValues

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.