Link

This module includes functions that control link-layer configuration.

Summary

Enumerations

otMacFilterAddressMode{
  OT_MAC_FILTER_ADDRESS_MODE_DISABLED,
  OT_MAC_FILTER_ADDRESS_MODE_WHITELIST,
  OT_MAC_FILTER_ADDRESS_MODE_BLACKLIST
}
enum
Defines address mode of the mac filter.

Typedefs

otActiveScanResult typedef
This structure represents a received IEEE 802.15.4 Beacon.
otEnergyScanResult typedef
This structure represents an energy scan result.
otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext) typedef
void(OTCALL *
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(OTCALL *
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, 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
Defines address mode of the mac filter.
otMacFilterEntry typedef
This structure represents a Mac Filter entry.
otMacFilterIterator typedef
uint8_t
Used to iterate through mac filter entries.
otThreadLinkInfo typedef
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)
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.
otLinkEnergyScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleEnergyScanResult aCallback, void *aCallbackContext)
This function starts an IEEE 802.15.4 Energy Scan.
otLinkFilterAddAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
This method adds an Extended Address to MAC filter.
otLinkFilterAddRssIn(otInstance *aInstance, const otExtAddress *aExtAddress, int8_t aRss)
This method sets the received signal strength (in dBm) for the messages from the Extended Address.
otLinkFilterClearAddresses(otInstance *aInstance)
OTAPI void OTCALL
This method clears all the Extended Addresses from MAC filter.
otLinkFilterClearRssIn(otInstance *aInstance)
OTAPI void OTCALL
This method clears all the received signal strength settings.
otLinkFilterGetAddressMode(otInstance *aInstance)
This function gets the address mode of MAC filter.
otLinkFilterGetNextAddress(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
This method gets an in-use address filter entry.
otLinkFilterGetNextRssIn(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
This method gets an in-use RssIn filter entry.
otLinkFilterRemoveAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
This method removes an Extended Address from MAC filter.
otLinkFilterRemoveRssIn(otInstance *aInstance, const otExtAddress *aExtAddress)
This method removes the received signal strength setting for the received messages from the Extended Address or removes the default received signal strength setting if no Extended Address is specified.
otLinkFilterSetAddressMode(otInstance *aInstance, otMacFilterAddressMode aMode)
This function sets the address mode of MAC filter.
otLinkGetCcaFailureRate(otInstance *aInstance)
uint16_t
This function returns the current CCA (Clear Channel Assessment) failure rate.
otLinkGetChannel(otInstance *aInstance)
OTAPI uint8_t OTCALL
Get the IEEE 802.15.4 channel.
otLinkGetCounters(otInstance *aInstance)
Get the MAC layer counters.
otLinkGetExtendedAddress(otInstance *aInstance)
Get the IEEE 802.15.4 Extended Address.
otLinkGetFactoryAssignedIeeeEui64(otInstance *aInstance, otExtAddress *aEui64)
OTAPI void OTCALL
Get the factory-assigned IEEE EUI-64.
otLinkGetPanId(otInstance *aInstance)
Get the IEEE 802.15.4 PAN ID.
otLinkGetPollPeriod(otInstance *aInstance)
OTAPI uint32_t OTCALL
Get the data poll period of sleepy end device.
otLinkGetShortAddress(otInstance *aInstance)
Get the IEEE 802.15.4 Short Address.
otLinkGetSupportedChannelMask(otInstance *aInstance)
uint32_t
Get the supported channel mask.
otLinkIsActiveScanInProgress(otInstance *aInstance)
OTAPI bool OTCALL
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)
OTAPI bool OTCALL
This function indicates whether or not an IEEE 802.15.4 Energy Scan is currently in progress.
otLinkIsInTransmitState(otInstance *aInstance)
OTAPI bool OTCALL
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.
otLinkOutOfBandTransmitRequest(otInstance *aInstance, otRadioFrame *aOobFrame)
This function enqueues an IEEE 802.15.4 out of band Frame for transmission.
otLinkSendDataRequest(otInstance *aInstance)
This function enqueues an IEEE 802.15.4 Data Request message for transmission.
otLinkSetChannel(otInstance *aInstance, uint8_t aChannel)
Set the IEEE 802.15.4 channel.
otLinkSetEnabled(otInstance *aInstance, bool aEnable)
This function enables or disables the link layer.
otLinkSetExtendedAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
This function sets the IEEE 802.15.4 Extended Address.
otLinkSetPanId(otInstance *aInstance, otPanId aPanId)
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)
OTAPI void OTCALL
Set the data poll period for sleepy end device.
otLinkSetPromiscuous(otInstance *aInstance, bool aPromiscuous)
This function enables or disables the link layer promiscuous mode.
otLinkSetSupportedChannelMask(otInstance *aInstance, uint32_t aChannelMask)
Set the supported channel mask.

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

Typedefs

Functions

Macros