otLinkMetricsEnhAckGenData() function

Generates the Link Metrics data (assessed for the acknowledged frame) bytes that would be included in Vendor-Specific IE. First checks what Link Metrics are specified by the Initiator indicated by @p aMacAddress. And then write the values to @p aData.

Syntax

Show:

Summary

Declaration

from link_metrics.h:94

uint8_t otLinkMetricsEnhAckGenData(const otMacAddress *aMacAddress, uint8_t aLqi, int8_t aRssi, uint8_t *aData);

Arguments

Argument

Description

aMacAddress

The Mac address of the Initiator.

aLqi

LQI value of the acknowledged frame.

aRssi

RSSI value of the acknowledged frame.

aData

A pointer to the buffer where the data would be written to. The caller should make sure that the size of the buffer is not less than the size of Link Metrics data configured before.

Return value

The size of data read. Would be `0` if the Initiator is not found or @p aData is invalid.

Examples

References

from examples

otLinkMetricsEnhAckGenData() function

Syntax

Arguments

Return value

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle

otLinkMetricsEnhAckGenData() function

Syntax

Arguments

Return value

Related Functions

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle