Link

This module includes functions that control link-layer configuration.

Summary

Enumerations
otMacFilterAddressMode{   OT_MAC_FILTER_ADDRESS_MODE_DISABLED,   OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST,   OT_MAC_FILTER_ADDRESS_MODE_DENYLIST }	enum Defines address mode of the mac filter.

Typedefs
otActiveScanResult	typedef struct otActiveScanResult This structure represents a received IEEE 802.15.4 Beacon.
otEnergyScanResult	typedef struct otEnergyScanResult This structure represents an energy scan result.
otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext)	typedef void(* This function pointer is called during an IEEE 802.15.4 Active Scan when an IEEE 802.15.4 Beacon is received or the scan completes.
otHandleEnergyScanResult)(otEnergyScanResult *aResult, void *aContext)	typedef void(* This function pointer is called during an IEEE 802.15.4 Energy Scan when the result for a channel is ready or the scan completes.
otLinkPcapCallback)(const otRadioFrame *aFrame, bool aIsTx, void *aContext)	typedef void(* This function pointer is called when an IEEE 802.15.4 frame is received.
otMacCounters	typedef struct otMacCounters This structure represents the MAC layer counters.
otMacFilterAddressMode	typedef enum otMacFilterAddressMode Defines address mode of the mac filter.
otMacFilterEntry	typedef struct otMacFilterEntry This structure represents a Mac Filter entry.
otMacFilterIterator	typedef uint8_t Used to iterate through mac filter entries.
otThreadLinkInfo	typedef struct otThreadLinkInfo This structure represents link-specific information for messages received from the Thread radio.

Functions
otLinkActiveScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleActiveScanResult aCallback, void *aCallbackContext)	otError This function starts an IEEE 802.15.4 Active Scan.
otLinkConvertLinkQualityToRss(otInstance *aInstance, uint8_t aLinkQuality)	int8_t This method converts link quality to typical received signal strength.
otLinkConvertRssToLinkQuality(otInstance *aInstance, int8_t aRss)	uint8_t This method converts received signal strength to link quality.
otLinkCslGetChannel(otInstance *aInstance)	uint8_t This function gets the CSL channel.
otLinkCslGetPeriod(otInstance *aInstance)	uint16_t This function gets the CSL period.
otLinkCslGetTimeout(otInstance *aInstance)	uint32_t This function gets the CSL timeout.
otLinkCslSetChannel(otInstance *aInstance, uint8_t aChannel)	otError Sets the CSL channel.
otLinkCslSetPeriod(otInstance *aInstance, uint16_t aPeriod)	otError Sets the CSL period in units of 10 symbols.
otLinkCslSetTimeout(otInstance *aInstance, uint32_t aTimeout)	otError Sets the CSL timeout in seconds.
otLinkEnergyScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleEnergyScanResult aCallback, void *aCallbackContext)	otError This function starts an IEEE 802.15.4 Energy Scan.
otLinkFilterAddAddress(otInstance *aInstance, const otExtAddress *aExtAddress)	otError This method adds an Extended Address to MAC filter.
otLinkFilterAddRssIn(otInstance *aInstance, const otExtAddress *aExtAddress, int8_t aRss)	otError This method adds a fixed received signal strength (in dBm) entry for the messages from a given Extended Address in MAC Filter.
otLinkFilterClearAddresses(otInstance *aInstance)	void This method clears all the Extended Addresses from MAC filter.
otLinkFilterClearAllRssIn(otInstance *aInstance)	void This method clears all the received signal strength entries (including default RSS-in) on MAC Filter.
otLinkFilterClearDefaultRssIn(otInstance *aInstance)	void This method clears any previously set default received signal strength (in dBm) on MAC Filter.
otLinkFilterGetAddressMode(otInstance *aInstance)	otMacFilterAddressMode This function gets the address mode of MAC filter.
otLinkFilterGetNextAddress(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)	otError This method gets an in-use address filter entry.
otLinkFilterGetNextRssIn(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)	otError This method gets an in-use RssIn filter entry.
otLinkFilterRemoveAddress(otInstance *aInstance, const otExtAddress *aExtAddress)	void This method removes an Extended Address from MAC filter.
otLinkFilterRemoveRssIn(otInstance *aInstance, const otExtAddress *aExtAddress)	void This method removes a MAC Filter entry for fixed received signal strength setting for a given Extended Address.
otLinkFilterSetAddressMode(otInstance *aInstance, otMacFilterAddressMode aMode)	void This function sets the address mode of MAC filter.
otLinkFilterSetDefaultRssIn(otInstance *aInstance, int8_t aRss)	void This method sets the default received signal strength (in dBm) on MAC Filter.
otLinkGetCcaFailureRate(otInstance *aInstance)	uint16_t This function returns the current CCA (Clear Channel Assessment) failure rate.
otLinkGetChannel(otInstance *aInstance)	uint8_t Get the IEEE 802.15.4 channel.
otLinkGetCounters(otInstance *aInstance)	const otMacCounters * Get the MAC layer counters.
otLinkGetExtendedAddress(otInstance *aInstance)	const otExtAddress * Gets the IEEE 802.15.4 Extended Address.
otLinkGetFactoryAssignedIeeeEui64(otInstance *aInstance, otExtAddress *aEui64)	void Get the factory-assigned IEEE EUI-64.
otLinkGetMaxFrameRetriesDirect(otInstance *aInstance)	uint8_t This method returns the maximum number of frame retries during direct transmission.
otLinkGetMaxFrameRetriesIndirect(otInstance *aInstance)	uint8_t This method returns the maximum number of frame retries during indirect transmission.
otLinkGetPanId(otInstance *aInstance)	otPanId Get the IEEE 802.15.4 PAN ID.
otLinkGetPollPeriod(otInstance *aInstance)	uint32_t Get the data poll period of sleepy end device.
otLinkGetShortAddress(otInstance *aInstance)	otShortAddress Get the IEEE 802.15.4 Short Address.
otLinkGetSupportedChannelMask(otInstance *aInstance)	uint32_t Get the supported channel mask of MAC layer.
otLinkGetTxDirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)	const uint32_t * This method gets histogram of retries for a single direct packet until success.
otLinkGetTxIndirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)	const uint32_t * This method gets histogram of retries for a single indirect packet until success.
otLinkIsActiveScanInProgress(otInstance *aInstance)	bool This function indicates whether or not an IEEE 802.15.4 Active Scan is currently in progress.
otLinkIsEnabled(otInstance *aInstance)	bool This function indicates whether or not the link layer is enabled.
otLinkIsEnergyScanInProgress(otInstance *aInstance)	bool This function indicates whether or not an IEEE 802.15.4 Energy Scan is currently in progress.
otLinkIsInTransmitState(otInstance *aInstance)	bool This function indicates whether or not an IEEE 802.15.4 MAC is in the transmit state.
otLinkIsPromiscuous(otInstance *aInstance)	bool This function indicates whether or not promiscuous mode is enabled at the link layer.
otLinkIsRadioFilterEnabled(otInstance *aInstance)	bool This function indicates whether the IEEE 802.15.4 radio filter is enabled or not.
otLinkResetCounters(otInstance *aInstance)	void Resets the MAC layer counters.
otLinkResetTxRetrySuccessHistogram(otInstance *aInstance)	void This method clears histogram statistics for direct and indirect transmissions.
otLinkSendDataRequest(otInstance *aInstance)	otError This function enqueues an IEEE 802.15.4 Data Request message for transmission.
otLinkSendEmptyData(otInstance *aInstance)	otError This function instructs the device to send an empty IEEE 802.15.4 data frame.
otLinkSetChannel(otInstance *aInstance, uint8_t aChannel)	otError Set the IEEE 802.15.4 channel.
otLinkSetEnabled(otInstance *aInstance, bool aEnable)	otError This function enables or disables the link layer.
otLinkSetExtendedAddress(otInstance *aInstance, const otExtAddress *aExtAddress)	otError Sets the IEEE 802.15.4 Extended Address.
otLinkSetMaxFrameRetriesDirect(otInstance *aInstance, uint8_t aMaxFrameRetriesDirect)	void This method sets the maximum number of frame retries during direct transmission.
otLinkSetMaxFrameRetriesIndirect(otInstance *aInstance, uint8_t aMaxFrameRetriesIndirect)	void This method sets the maximum number of frame retries during indirect transmission.
otLinkSetPanId(otInstance *aInstance, otPanId aPanId)	otError Set the IEEE 802.15.4 PAN ID.
otLinkSetPcapCallback(otInstance *aInstance, otLinkPcapCallback aPcapCallback, void *aCallbackContext)	void This function registers a callback to provide received raw IEEE 802.15.4 frames.
otLinkSetPollPeriod(otInstance *aInstance, uint32_t aPollPeriod)	otError Set/clear user-specified/external data poll period for sleepy end device.
otLinkSetPromiscuous(otInstance *aInstance, bool aPromiscuous)	otError This function enables or disables the link layer promiscuous mode.
otLinkSetRadioFilterEnabled(otInstance *aInstance, bool aFilterEnabled)	void This function enables/disables IEEE 802.15.4 radio filter mode.
otLinkSetSupportedChannelMask(otInstance *aInstance, uint32_t aChannelMask)	otError Set the supported channel mask of MAC layer.

Structs
otActiveScanResult	This structure represents a received IEEE 802.15.4 Beacon.
otEnergyScanResult	This structure represents an energy scan result.
otMacCounters	This structure represents the MAC layer counters.
otMacFilterEntry	This structure represents a Mac Filter entry.
otThreadLinkInfo	This structure represents link-specific information for messages received from the Thread radio.

Enumerations

otMacFilterAddressMode

 otMacFilterAddressMode

Defines address mode of the mac filter.

Properties
OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST	Allowlist address filter mode is enabled.
OT_MAC_FILTER_ADDRESS_MODE_DENYLIST	Denylist address filter mode is enabled.
OT_MAC_FILTER_ADDRESS_MODE_DISABLED	Address filter is disabled.

Typedefs

otActiveScanResult

struct otActiveScanResult otActiveScanResult

This structure represents a received IEEE 802.15.4 Beacon.

otEnergyScanResult

struct otEnergyScanResult otEnergyScanResult

This structure represents an energy scan result.

otHandleActiveScanResult

void(* otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext)

This function pointer is called during an IEEE 802.15.4 Active Scan when an IEEE 802.15.4 Beacon is received or the scan completes.

Details
Parameters	[in] aResult A valid pointer to the beacon information or NULL when the active scan completes. [in] aContext A pointer to application-specific context.

otHandleEnergyScanResult

void(* otHandleEnergyScanResult)(otEnergyScanResult *aResult, void *aContext)

This function pointer is called during an IEEE 802.15.4 Energy Scan when the result for a channel is ready or the scan completes.

Details
Parameters	[in] aResult A valid pointer to the energy scan result information or NULL when the energy scan completes. [in] aContext A pointer to application-specific context.

otLinkPcapCallback

void(* otLinkPcapCallback)(const otRadioFrame *aFrame, bool aIsTx, void *aContext)

This function pointer is called when an IEEE 802.15.4 frame is received.

Note: This callback is called after FCS processing and aFrame may not contain the actual FCS that was received.

Note: This callback is called before IEEE 802.15.4 security processing.

Details
Parameters	[in] aFrame A pointer to the received IEEE 802.15.4 frame. [in] aIsTx Whether this frame is transmitted, not received. [in] aContext A pointer to application-specific context.

otMacCounters

struct otMacCounters otMacCounters

This structure represents the MAC layer counters.

otMacFilterAddressMode

enum otMacFilterAddressMode otMacFilterAddressMode

Defines address mode of the mac filter.

otMacFilterEntry

struct otMacFilterEntry otMacFilterEntry

This structure represents a Mac Filter entry.

otMacFilterIterator

uint8_t otMacFilterIterator

Used to iterate through mac filter entries.

otThreadLinkInfo

struct otThreadLinkInfo otThreadLinkInfo

This structure represents link-specific information for messages received from the Thread radio.

Functions

otLinkActiveScan

otError otLinkActiveScan(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aScanDuration,
  otHandleActiveScanResult aCallback,
  void *aCallbackContext
)

This function starts an IEEE 802.15.4 Active Scan.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aScanChannels A bit vector indicating which channels to scan (e.g. OT_CHANNEL_11_MASK). [in] aScanDuration The time in milliseconds to spend scanning each channel. [in] aCallback A pointer to a function called on receiving a beacon or scan completes. [in] aCallbackContext A pointer to application-specific context.
Return Values	OT_ERROR_NONE Accepted the Active Scan request. OT_ERROR_BUSY Already performing an Active Scan.

otLinkConvertLinkQualityToRss

int8_t otLinkConvertLinkQualityToRss(
  otInstance *aInstance,
  uint8_t aLinkQuality
)

This method converts link quality to typical received signal strength.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aLinkQuality LinkQuality value, should be in range [0,3].
Returns	Typical platform received signal strength mapping to aLinkQuality.

otLinkConvertRssToLinkQuality

uint8_t otLinkConvertRssToLinkQuality(
  otInstance *aInstance,
  int8_t aRss
)

This method converts received signal strength to link quality.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aRss The received signal strength value to be converted.
Returns	Link quality value mapping to aRss.

otLinkCslGetChannel

uint8_t otLinkCslGetChannel(
  otInstance *aInstance
)

This function gets the CSL channel.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The CSL channel.

otLinkCslGetPeriod

uint16_t otLinkCslGetPeriod(
  otInstance *aInstance
)

This function gets the CSL period.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The CSL period in units of 10 symbols.

otLinkCslGetTimeout

uint32_t otLinkCslGetTimeout(
  otInstance *aInstance
)

This function gets the CSL timeout.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The CSL timeout in seconds.

otLinkCslSetChannel

otError otLinkCslSetChannel(
  otInstance *aInstance,
  uint8_t aChannel
)

Sets the CSL channel.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aChannel The CSL sample channel. Channel value should be 0 (Set CSL Channel unspecified) or within the range [1, 10] (if 915-MHz supported) and 11, 26.
Return Values	OT_ERROR_NONE Successfully set the CSL parameters. OT_ERROR_INVALID_ARGS Invalid aChannel.

otLinkCslSetPeriod

otError otLinkCslSetPeriod(
  otInstance *aInstance,
  uint16_t aPeriod
)

Sets the CSL period in units of 10 symbols.

Disable CSL by setting this parameter to 0.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aPeriod The CSL period in units of 10 symbols.
Return Values	OT_ERROR_NONE Successfully set the CSL period. OT_ERROR_INVALID_ARGS Invalid CSL period.

otLinkCslSetTimeout

otError otLinkCslSetTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

Sets the CSL timeout in seconds.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aTimeout The CSL timeout in seconds.
Return Values	OT_ERROR_NONE Successfully set the CSL timeout. OT_ERROR_INVALID_ARGS Invalid CSL timeout.

otLinkEnergyScan

otError otLinkEnergyScan(
  otInstance *aInstance,
  uint32_t aScanChannels,
  uint16_t aScanDuration,
  otHandleEnergyScanResult aCallback,
  void *aCallbackContext
)

This function starts an IEEE 802.15.4 Energy Scan.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aScanChannels A bit vector indicating on which channels to perform energy scan. [in] aScanDuration The time in milliseconds to spend scanning each channel. [in] aCallback A pointer to a function called to pass on scan result on indicate scan completion. [in] aCallbackContext A pointer to application-specific context.
Return Values	OT_ERROR_NONE Accepted the Energy Scan request. OT_ERROR_BUSY Could not start the energy scan.

otLinkFilterAddAddress

otError otLinkFilterAddAddress(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

This method adds an Extended Address to MAC filter.

This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aExtAddress A pointer to the Extended Address (MUST NOT be NULL).
Return Values	OT_ERROR_NONE Successfully added aExtAddress to MAC filter. OT_ERROR_NO_BUFS No available entry exists.

otLinkFilterAddRssIn

otError otLinkFilterAddRssIn(
  otInstance *aInstance,
  const otExtAddress *aExtAddress,
  int8_t aRss
)

This method adds a fixed received signal strength (in dBm) entry for the messages from a given Extended Address in MAC Filter.

This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aExtAddress A pointer to the IEEE 802.15.4 Extended Address. MUST NOT be NULL. [in] aRss A received signal strength (in dBm).
Return Values	OT_ERROR_NONE Successfully added an entry for aExtAddress and aRss. OT_ERROR_NO_BUFS No available entry exists.

otLinkFilterClearAddresses

void otLinkFilterClearAddresses(
  otInstance *aInstance
)

This method clears all the Extended Addresses from MAC filter.

This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

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

otLinkFilterClearAllRssIn

void otLinkFilterClearAllRssIn(
  otInstance *aInstance
)

This method clears all the received signal strength entries (including default RSS-in) on MAC Filter.

This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

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

otLinkFilterClearDefaultRssIn

void otLinkFilterClearDefaultRssIn(
  otInstance *aInstance
)

This method clears any previously set default received signal strength (in dBm) on MAC Filter.

This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

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

otLinkFilterGetAddressMode

otMacFilterAddressMode otLinkFilterGetAddressMode(
  otInstance *aInstance
)

This function gets the address mode of MAC filter.

This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	the address mode.

otLinkFilterGetNextAddress

otError otLinkFilterGetNextAddress(
  otInstance *aInstance,
  otMacFilterIterator *aIterator,
  otMacFilterEntry *aEntry
)

This method gets an in-use address filter entry.

This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in,out] aIterator A pointer to the MAC filter iterator context. To get the first in-use address filter entry, it should be set to OT_MAC_FILTER_ITERATOR_INIT. MUST NOT be NULL. [out] aEntry A pointer to where the information is placed. MUST NOT be NULL.
Return Values	OT_ERROR_NONE Successfully retrieved an in-use address filter entry. OT_ERROR_NOT_FOUND No subsequent entry exists.

otLinkFilterGetNextRssIn

otError otLinkFilterGetNextRssIn(
  otInstance *aInstance,
  otMacFilterIterator *aIterator,
  otMacFilterEntry *aEntry
)

This method gets an in-use RssIn filter entry.

This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in,out] aIterator A pointer to the MAC filter iterator context. MUST NOT be NULL. To get the first entry, it should be set to OT_MAC_FILTER_ITERATOR_INIT. [out] aEntry A pointer to where the information is placed. The last entry would have the extended address as all 0xff to indicate the default received signal strength if it was set. aEntry MUST NOT be NULL.
Return Values	OT_ERROR_NONE Successfully retrieved the next entry. OT_ERROR_NOT_FOUND No subsequent entry exists.

otLinkFilterRemoveAddress

void otLinkFilterRemoveAddress(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

This method removes an Extended Address from MAC filter.

This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

No action is performed if there is no existing entry in Filter matching the given Extended Address.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aExtAddress A pointer to the Extended Address (MUST NOT be NULL).

otLinkFilterRemoveRssIn

void otLinkFilterRemoveRssIn(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

This method removes a MAC Filter entry for fixed received signal strength setting for a given Extended Address.

This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

No action is performed if there is no existing entry in Filter matching the given Extended Address.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aExtAddress A pointer to the IEEE 802.15.4 Extended Address. MUST NOT be NULL.

otLinkFilterSetAddressMode

void otLinkFilterSetAddressMode(
  otInstance *aInstance,
  otMacFilterAddressMode aMode
)

This function sets the address mode of MAC filter.

This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aMode The address mode to set.

otLinkFilterSetDefaultRssIn

void otLinkFilterSetDefaultRssIn(
  otInstance *aInstance,
  int8_t aRss
)

This method sets the default received signal strength (in dBm) on MAC Filter.

This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

The default RSS value is used for all received frames from addresses for which there is no explicit RSS-IN entry in the Filter list (added using otLinkFilterAddRssIn()).

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aRss The default received signal strength (in dBm) to set.

otLinkGetCcaFailureRate

uint16_t otLinkGetCcaFailureRate(
  otInstance *aInstance
)

This function returns the current CCA (Clear Channel Assessment) failure rate.

The rate is maintained over a window of (roughly) last OPENTHREAD_CONFIG_CCA_FAILURE_RATE_AVERAGING_WINDOW frame transmissions.

Details
Returns	The CCA failure rate with maximum value 0xffff corresponding to 100% failure rate.

otLinkGetChannel

uint8_t otLinkGetChannel(
  otInstance *aInstance
)

Get the IEEE 802.15.4 channel.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The IEEE 802.15.4 channel.

See also:
otLinkSetChannel

otLinkGetCounters

const otMacCounters * otLinkGetCounters(
  otInstance *aInstance
)

Get the MAC layer counters.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	A pointer to the MAC layer counters.

otLinkGetExtendedAddress

const otExtAddress * otLinkGetExtendedAddress(
  otInstance *aInstance
)

Gets the IEEE 802.15.4 Extended Address.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	A pointer to the IEEE 802.15.4 Extended Address.

otLinkGetFactoryAssignedIeeeEui64

void otLinkGetFactoryAssignedIeeeEui64(
  otInstance *aInstance,
  otExtAddress *aEui64
)

Get the factory-assigned IEEE EUI-64.

Details
Parameters	[in] aInstance A pointer to the OpenThread instance. [out] aEui64 A pointer to where the factory-assigned IEEE EUI-64 is placed.

otLinkGetMaxFrameRetriesDirect

uint8_t otLinkGetMaxFrameRetriesDirect(
  otInstance *aInstance
)

This method returns the maximum number of frame retries during direct transmission.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The maximum number of retries during direct transmission.

otLinkGetMaxFrameRetriesIndirect

uint8_t otLinkGetMaxFrameRetriesIndirect(
  otInstance *aInstance
)

This method returns the maximum number of frame retries during indirect transmission.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The maximum number of retries during indirect transmission.

otLinkGetPanId

otPanId otLinkGetPanId(
  otInstance *aInstance
)

Get the IEEE 802.15.4 PAN ID.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The IEEE 802.15.4 PAN ID.

See also:
otLinkSetPanId

otLinkGetPollPeriod

uint32_t otLinkGetPollPeriod(
  otInstance *aInstance
)

Get the data poll period of sleepy end device.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The data poll period of sleepy end device in milliseconds.

See also:
otLinkSetPollPeriod

otLinkGetShortAddress

otShortAddress otLinkGetShortAddress(
  otInstance *aInstance
)

Get the IEEE 802.15.4 Short Address.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	A pointer to the IEEE 802.15.4 Short Address.

otLinkGetSupportedChannelMask

uint32_t otLinkGetSupportedChannelMask(
  otInstance *aInstance
)

Get the supported channel mask of MAC layer.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	The supported channel mask as uint32_t with bit 0 (lsb) mapping to channel 0, bit 1 to channel 1, so on.

otLinkGetTxDirectRetrySuccessHistogram

const uint32_t * otLinkGetTxDirectRetrySuccessHistogram(
  otInstance *aInstance,
  uint8_t *aNumberOfEntries
)

This method gets histogram of retries for a single direct packet until success.

This function is valid when OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE configuration is enabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [out] aNumberOfEntries A pointer to where the size of returned histogram array is placed.
Returns	A pointer to the histogram of retries (in a form of an array). The n-th element indicates that the packet has been sent with n-th retry.

otLinkGetTxIndirectRetrySuccessHistogram

const uint32_t * otLinkGetTxIndirectRetrySuccessHistogram(
  otInstance *aInstance,
  uint8_t *aNumberOfEntries
)

This method gets histogram of retries for a single indirect packet until success.

This function is valid when OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE configuration is enabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [out] aNumberOfEntries A pointer to where the size of returned histogram array is placed.
Returns	A pointer to the histogram of retries (in a form of an array). The n-th element indicates that the packet has been sent with n-th retry.

otLinkIsActiveScanInProgress

bool otLinkIsActiveScanInProgress(
  otInstance *aInstance
)

This function indicates whether or not an IEEE 802.15.4 Active Scan is currently in progress.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	true if an IEEE 802.15.4 Active Scan is in progress, false otherwise.

otLinkIsEnabled

bool otLinkIsEnabled(
  otInstance *aInstance
)

This function indicates whether or not the link layer is enabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Return Values	true Link layer is enabled. false Link layer is not enabled.

otLinkIsEnergyScanInProgress

bool otLinkIsEnergyScanInProgress(
  otInstance *aInstance
)

This function indicates whether or not an IEEE 802.15.4 Energy Scan is currently in progress.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	true if an IEEE 802.15.4 Energy Scan is in progress, false otherwise.

otLinkIsInTransmitState

bool otLinkIsInTransmitState(
  otInstance *aInstance
)

This function indicates whether or not an IEEE 802.15.4 MAC is in the transmit state.

MAC module is in the transmit state during CSMA/CA procedure, CCA, Data, Beacon or Data Request frame transmission and receiving an ACK of a transmitted frame. MAC module is not in the transmit state during transmission of an ACK frame or a Beacon Request frame.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Returns	true if an IEEE 802.15.4 MAC is in the transmit state, false otherwise.

otLinkIsPromiscuous

bool otLinkIsPromiscuous(
  otInstance *aInstance
)

This function indicates whether or not promiscuous mode is enabled at the link layer.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Return Values	true Promiscuous mode is enabled. false Promiscuous mode is not enabled.

otLinkIsRadioFilterEnabled

bool otLinkIsRadioFilterEnabled(
  otInstance *aInstance
)

This function indicates whether the IEEE 802.15.4 radio filter is enabled or not.

This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

Details
Return Values	TRUE If the radio filter is enabled. FALSE If the radio filter is disabled.

otLinkResetCounters

void otLinkResetCounters(
  otInstance *aInstance
)

Resets the MAC layer counters.

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

otLinkResetTxRetrySuccessHistogram

void otLinkResetTxRetrySuccessHistogram(
  otInstance *aInstance
)

This method clears histogram statistics for direct and indirect transmissions.

This function is valid when OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE configuration is enabled.

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

otLinkSendDataRequest

otError otLinkSendDataRequest(
  otInstance *aInstance
)

This function enqueues an IEEE 802.15.4 Data Request message for transmission.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Return Values	OT_ERROR_NONE Successfully enqueued an IEEE 802.15.4 Data Request message. OT_ERROR_INVALID_STATE Device is not in rx-off-when-idle mode. OT_ERROR_NO_BUFS Insufficient message buffers available.

otLinkSendEmptyData

otError otLinkSendEmptyData(
  otInstance *aInstance
)

This function instructs the device to send an empty IEEE 802.15.4 data frame.

This function is only supported on an Rx-Off-When-Idle device to send an empty data frame to its parent. Note: available only when OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE is enabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance.
Return Values	OT_ERROR_NONE Successfully enqueued an empty message. OT_ERROR_INVALID_STATE Device is not in Rx-Off-When-Idle mode. OT_ERROR_NO_BUFS Insufficient message buffers available.

otLinkSetChannel

otError otLinkSetChannel(
  otInstance *aInstance,
  uint8_t aChannel
)

Set the IEEE 802.15.4 channel.

This function succeeds only when Thread protocols are disabled. A successful call to this function invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aChannel The IEEE 802.15.4 channel.
Return Values	OT_ERROR_NONE Successfully set the channel. OT_ERROR_INVALID_ARGS If aChannel is not in the range [11, 26] or is not in the supported channel mask. OT_ERROR_INVALID_STATE Thread protocols are enabled.

See also:
otLinkGetChannel

otLinkSetEnabled

otError otLinkSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

This function enables or disables the link layer.

Note: The link layer may only be enabled / disabled when the Thread Interface is disabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aEnable true to enable the link layer, or false otherwise.
Return Values	OT_ERROR_NONE Successfully enabled / disabled the link layer. OT_ERROR_INVALID_STATE Could not disable the link layer because the Thread interface is enabled.

otLinkSetExtendedAddress

otError otLinkSetExtendedAddress(
  otInstance *aInstance,
  const otExtAddress *aExtAddress
)

Sets the IEEE 802.15.4 Extended Address.

Note: Only succeeds when Thread protocols are disabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aExtAddress A pointer to the IEEE 802.15.4 Extended Address.
Return Values	OT_ERROR_NONE Successfully set the IEEE 802.15.4 Extended Address. OT_ERROR_INVALID_ARGS aExtAddress was NULL. OT_ERROR_INVALID_STATE Thread protocols are enabled.

otLinkSetMaxFrameRetriesDirect

void otLinkSetMaxFrameRetriesDirect(
  otInstance *aInstance,
  uint8_t aMaxFrameRetriesDirect
)

This method sets the maximum number of frame retries during direct transmission.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aMaxFrameRetriesDirect The maximum number of retries during direct transmission.

otLinkSetMaxFrameRetriesIndirect

void otLinkSetMaxFrameRetriesIndirect(
  otInstance *aInstance,
  uint8_t aMaxFrameRetriesIndirect
)

This method sets the maximum number of frame retries during indirect transmission.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aMaxFrameRetriesIndirect The maximum number of retries during indirect transmission.

otLinkSetPanId

otError otLinkSetPanId(
  otInstance *aInstance,
  otPanId aPanId
)

Set the IEEE 802.15.4 PAN ID.

This function succeeds only when Thread protocols are disabled. A successful call to this function also invalidates the Active and Pending Operational Datasets in non-volatile memory.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aPanId The IEEE 802.15.4 PAN ID.
Return Values	OT_ERROR_NONE Successfully set the PAN ID. OT_ERROR_INVALID_ARGS If aPanId is not in the range [0, 65534]. OT_ERROR_INVALID_STATE Thread protocols are enabled.

See also:
otLinkGetPanId

otLinkSetPcapCallback

void otLinkSetPcapCallback(
  otInstance *aInstance,
  otLinkPcapCallback aPcapCallback,
  void *aCallbackContext
)

This function registers a callback to provide received raw IEEE 802.15.4 frames.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aPcapCallback A pointer to a function that is called when receiving an IEEE 802.15.4 link frame or NULL to disable the callback. [in] aCallbackContext A pointer to application-specific context.

otLinkSetPollPeriod

otError otLinkSetPollPeriod(
  otInstance *aInstance,
  uint32_t aPollPeriod
)

Set/clear user-specified/external data poll period for sleepy end device.

Note: This function updates only poll period of sleepy end device. To update child timeout the function otThreadSetChildTimeout() shall be called.

Note: Minimal non-zero value should be OPENTHREAD_CONFIG_MAC_MINIMUM_POLL_PERIOD (10ms). Or zero to clear user-specified poll period.

Note:User-specified value should be no more than the maximal value 0x3FFFFFF ((1 << 26) - 1) allowed, otherwise it would be clipped by the maximal value.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aPollPeriod data poll period in milliseconds.
Return Values	OT_ERROR_NONE Successfully set/cleared user-specified poll period. OT_ERROR_INVALID_ARGS If aPollPeriod is invalid.

See also:
otLinkGetPollPeriod

otLinkSetPromiscuous

otError otLinkSetPromiscuous(
  otInstance *aInstance,
  bool aPromiscuous
)

This function enables or disables the link layer promiscuous mode.

Note: Promiscuous mode may only be enabled when the Thread interface is disabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aPromiscuous true to enable promiscuous mode, or false otherwise.
Return Values	OT_ERROR_NONE Successfully enabled promiscuous mode. OT_ERROR_INVALID_STATE Could not enable promiscuous mode because the Thread interface is enabled.

otLinkSetRadioFilterEnabled

void otLinkSetRadioFilterEnabled(
  otInstance *aInstance,
  bool aFilterEnabled
)

This function enables/disables IEEE 802.15.4 radio filter mode.

This function is available when OPENTHREAD_CONFIG_MAC_FILTER_ENABLE configuration is enabled.

The radio filter is mainly intended for testing. It can be used to temporarily block all tx/rx on the 802.15.4 radio. When radio filter is enabled, radio is put to sleep instead of receive (to ensure device does not receive any frame and/or potentially send ack). Also the frame transmission requests return immediately without sending the frame over the air (return "no ack" error if ack is requested, otherwise return success).

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aFilterEnabled TRUE to enable radio filter, FALSE to disable

otLinkSetSupportedChannelMask

otError otLinkSetSupportedChannelMask(
  otInstance *aInstance,
  uint32_t aChannelMask
)

Set the supported channel mask of MAC layer.

This function succeeds only when Thread protocols are disabled.

Details
Parameters	[in] aInstance A pointer to an OpenThread instance. [in] aChannelMask The supported channel mask (bit 0 or lsb mapping to channel 0, and so on).
Return Values	OT_ERROR_NONE Successfully set the supported channel mask. OT_ERROR_INVALID_STATE Thread protocols are enabled.

Macros

OT_MAC_FILTER_FIXED_RSS_DISABLED

 OT_MAC_FILTER_FIXED_RSS_DISABLED 127

Used to indicate no fixed received signal strength was set.

OT_MAC_FILTER_ITERATOR_INIT

 OT_MAC_FILTER_ITERATOR_INIT 0

Initializer for otMacFilterIterator.

OT_US_PER_TEN_SYMBOLS

 OT_US_PER_TEN_SYMBOLS 160

The microseconds per 10 symbols.

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.