Google 致力于为黑人社区推动种族平等。查看具体行动

Link

此模块包含控制链路层配置的函数。

摘要

枚举

otMacFilterAddressMode{
  OT_MAC_FILTER_ADDRESS_MODE_DISABLED,
  OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST,
  OT_MAC_FILTER_ADDRESS_MODE_DENYLIST
}
枚举
定义 Mac 过滤器的地址模式。

类型定义符

otActiveScanResult typedef
此结构表示收到的 IEEE 802.15.4 信标。
otEnergyScanResult typedef
此结构表示能量扫描结果。
otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext) typedef
void(*
收到 IEEE 802.15.4 Beacon 或完成扫描时,系统会在 IEEE 802.15.4 Active Scan 期间调用此函数指针。
otHandleEnergyScanResult)(otEnergyScanResult *aResult, void *aContext) typedef
void(*
当通道的结果就绪或扫描完成时,在 IEEE 802.15.4 能源扫描期间调用此函数指针。
otLinkPcapCallback)(const otRadioFrame *aFrame, bool aIsTx, void *aContext) typedef
void(*
收到 IEEE 802.15.4 帧时,系统会调用此函数指针。
otMacCounters typedef
struct otMacCounters
此结构表示 MAC 层计数器。
otMacFilterAddressMode typedef
定义 Mac 过滤器的地址模式。
otMacFilterEntry typedef
此结构表示 Mac Filter 条目。
otMacFilterIterator typedef
uint8_t
用于遍历 Mac 过滤器条目。
otThreadLinkInfo typedef
此结构表示从 Thread 无线装置接收的消息的链路特定信息。

函数

otLinkActiveScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleActiveScanResult aCallback, void *aCallbackContext)
该函数会启动 IEEE 802.15.4 Active Scan。
otLinkConvertLinkQualityToRss(otInstance *aInstance, uint8_t aLinkQuality)
int8_t
此方法会将链路质量转换为一般接收信号强度。
otLinkConvertRssToLinkQuality(otInstance *aInstance, int8_t aRss)
uint8_t
此方法会将接收的信号强度转换为链路质量。
otLinkCslGetChannel(otInstance *aInstance)
uint8_t
此函数获取 CSL 通道。
otLinkCslGetPeriod(otInstance *aInstance)
uint16_t
此函数获取 CSL 周期。
otLinkCslGetTimeout(otInstance *aInstance)
uint32_t
此函数会获取 CSL 超时。
otLinkCslSetChannel(otInstance *aInstance, uint8_t aChannel)
此函数设置 CSL 通道。
otLinkCslSetPeriod(otInstance *aInstance, uint16_t aPeriod)
此函数设置 CSL 周期。
otLinkCslSetTimeout(otInstance *aInstance, uint32_t aTimeout)
此函数设置 CSL 超时。
otLinkEnergyScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleEnergyScanResult aCallback, void *aCallbackContext)
该函数会启动 IEEE 802.15.4 能源扫描。
otLinkFilterAddAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
此方法会在 MAC 过滤器中添加扩展地址。
otLinkFilterAddRssIn(otInstance *aInstance, const otExtAddress *aExtAddress, int8_t aRss)
此方法会为来自 MAC 过滤器中给定扩展地址的邮件添加固定的接收信号强度(以 dBm 为单位)。
otLinkFilterClearAddresses(otInstance *aInstance)
void
此方法会从 MAC 过滤器中清除所有“扩展地址”。
otLinkFilterClearAllRssIn(otInstance *aInstance)
void
此方法会清除 MAC 过滤器上收到的所有信号强度条目(包括默认 RSS-in)。
otLinkFilterClearDefaultRssIn(otInstance *aInstance)
void
此方法会清除之前在 MAC 过滤器上设置的所有默认接收信号强度(以 dBm 为单位)。
otLinkFilterGetAddressMode(otInstance *aInstance)
此函数获取 MAC 过滤器的地址模式。
otLinkFilterGetNextAddress(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
此方法会获取使用中的地址过滤器条目。
otLinkFilterGetNextRssIn(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)
此方法会获取使用中的 RssIn 过滤器条目。
otLinkFilterRemoveAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
void
此方法会从 MAC 过滤器中移除扩展地址。
otLinkFilterRemoveRssIn(otInstance *aInstance, const otExtAddress *aExtAddress)
void
此方法会针对某个给定的扩展地址移除固定接收信号强度设置的 MAC 过滤器条目。
otLinkFilterSetAddressMode(otInstance *aInstance, otMacFilterAddressMode aMode)
void
此函数用于设置 MAC 过滤器的地址模式。
otLinkFilterSetDefaultRssIn(otInstance *aInstance, int8_t aRss)
void
此方法设置 MAC 过滤器上默认的接收信号强度(以 dBm 为单位)。
otLinkGetCcaFailureRate(otInstance *aInstance)
uint16_t
此函数返回当前 CCA(清除频道评估)失败率。
otLinkGetChannel(otInstance *aInstance)
uint8_t
获取 IEEE 802.15.4 版本。
otLinkGetCounters(otInstance *aInstance)
const otMacCounters *
获取 MAC 层计数器。
otLinkGetExtendedAddress(otInstance *aInstance)
const otExtAddress *
获取 IEEE 802.15.4 扩展地址。
otLinkGetFactoryAssignedIeeeEui64(otInstance *aInstance, otExtAddress *aEui64)
void
获取出厂分配的 IEEE EUI-64。
otLinkGetMaxFrameRetriesDirect(otInstance *aInstance)
uint8_t
此方法返回直接传输期间的最大帧重试次数。
otLinkGetMaxFrameRetriesIndirect(otInstance *aInstance)
uint8_t
此方法会返回间接传输期间的最大帧重试次数。
otLinkGetPanId(otInstance *aInstance)
获取 IEEE 802.15.4 PAN ID。
otLinkGetPollPeriod(otInstance *aInstance)
uint32_t
获取休眠终端的数据轮询期。
otLinkGetShortAddress(otInstance *aInstance)
获取 IEEE 802.15.4 短地址。
otLinkGetSupportedChannelMask(otInstance *aInstance)
uint32_t
获取支持的 MAC 层通道掩码。
otLinkGetTxDirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)
const uint32_t *
此方法会获取单个直接数据包在成功后重试的直方图。
otLinkGetTxIndirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)
const uint32_t *
此方法会获取单个间接数据包重试成功前的直方图。
otLinkIsActiveScanInProgress(otInstance *aInstance)
bool
此函数用于指示当前是否正在进行 IEEE 802.15.4 Active Scan。
otLinkIsEnabled(otInstance *aInstance)
bool
此函数用于指明是否启用了链路层。
otLinkIsEnergyScanInProgress(otInstance *aInstance)
bool
此函数用于指示当前是否正在进行 IEEE 802.15.4 Energy Scan。
otLinkIsInTransmitState(otInstance *aInstance)
bool
此函数指示 IEEE 802.15.4 MAC 是否处于传输状态。
otLinkIsPromiscuous(otInstance *aInstance)
bool
此函数用于指明链路层是否启用了混杂模式。
otLinkIsRadioFilterEnabled(otInstance *aInstance)
bool
此函数用于指示是否启用了 IEEE 802.15.4 无线过滤器。
otLinkResetCounters(otInstance *aInstance)
void
重置 MAC 层计数器。
otLinkResetTxRetrySuccessHistogram(otInstance *aInstance)
void
此方法会清除直接传输和间接传输的直方图统计信息。
otLinkSendDataRequest(otInstance *aInstance)
此函数将 IEEE 802.15.4 Data Request 消息加入队列以进行传输。
otLinkSendEmptyData(otInstance *aInstance)
此函数指示设备发送空的 IEEE 802.15.4 数据帧。
otLinkSetChannel(otInstance *aInstance, uint8_t aChannel)
设置 IEEE 802.15.4 通道。
otLinkSetEnabled(otInstance *aInstance, bool aEnable)
此函数可启用或停用链接层。
otLinkSetExtendedAddress(otInstance *aInstance, const otExtAddress *aExtAddress)
此函数设置 IEEE 802.15.4 扩展地址。
otLinkSetMaxFrameRetriesDirect(otInstance *aInstance, uint8_t aMaxFrameRetriesDirect)
void
此方法设置直接传输期间的最大帧重试次数。
otLinkSetMaxFrameRetriesIndirect(otInstance *aInstance, uint8_t aMaxFrameRetriesIndirect)
void
此方法设置间接传输期间的最大帧重试次数。
otLinkSetPanId(otInstance *aInstance, otPanId aPanId)
设置 IEEE 802.15.4 PAN ID。
otLinkSetPcapCallback(otInstance *aInstance, otLinkPcapCallback aPcapCallback, void *aCallbackContext)
void
此函数注册回调以提供收到的原始 IEEE 802.15.4 帧。
otLinkSetPollPeriod(otInstance *aInstance, uint32_t aPollPeriod)
为睡眠不足的设备设置设置/清除用户指定的/外部数据轮询周期。
otLinkSetPromiscuous(otInstance *aInstance, bool aPromiscuous)
此函数可启用或停用链路层混杂模式。
otLinkSetRadioFilterEnabled(otInstance *aInstance, bool aFilterEnabled)
void
此函数可启用/停用 IEEE 802.15.4 无线装置过滤模式。
otLinkSetSupportedChannelMask(otInstance *aInstance, uint32_t aChannelMask)
设置支持的 MAC 层通道掩码。

结构体

otActiveScanResult

此结构表示收到的 IEEE 802.15.4 信标。

otEnergyScanResult

此结构表示能量扫描结果。

otMacCounters

此结构表示 MAC 层计数器。

otMacFilterEntry

此结构表示 Mac Filter 条目。

otThreadLinkInfo

此结构表示从 Thread 无线装置接收的消息的链路特定信息。

枚举

类型定义符

函数

资源

OpenThread API 参考主题源自源代码,可在 GitHub 上找到。 如需了解详情或为我们的文档做贡献,请参阅资源