原始链接

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

摘要

类型定义符
otLinkRawEnergyScanDone)(otInstance *aInstance, int8_t aEnergyScanMaxRssi) typedef
void(*
用于接收 IEEE 802.15.4 帧的指针。
otLinkRawReceiveDone)(otInstance *aInstance, otRadioFrame *aFrame, otError aError) typedef
void(*
用于接收 IEEE 802.15.4 帧的指针。
otLinkRawTransmitDone)(otInstance *aInstance, otRadioFrame *aFrame, otRadioFrame *aAckFrame, otError aError) typedef
void(*
用于接收 IEEE 802.15.4 帧的指针。

函数
otLinkRawEnergyScan(otInstance *aInstance, uint8_t aScanChannel, uint16_t aScanDuration, otLinkRawEnergyScanDone aCallback)
在无线装置上开始能量扫描序列。
otLinkRawGetCaps(otInstance *aInstance)
获取电台功能。
otLinkRawGetPromiscuous(otInstance *aInstance)
bool
获取混杂模式的状态。
otLinkRawGetRadioTime(otInstance *aInstance)
uint64_t
获取无线装置芯片的当前平台时间（64 位宽）。
otLinkRawGetRssi(otInstance *aInstance)
int8_t
获取最新的 RSSI 测量值。
otLinkRawGetTransmitBuffer(otInstance *aInstance)
无线装置从发射转换到接收。
otLinkRawIsEnabled(otInstance *aInstance)
bool
指明原始链接层是否已启用。
otLinkRawReceive(otInstance *aInstance)
将电台从“睡眠”转换为“接收”。
otLinkRawSetMacFrameCounter(otInstance *aInstance, uint32_t aMacFrameCounter)
设置当前的 MAC 帧计数器值。
otLinkRawSetMacFrameCounterIfLarger(otInstance *aInstance, uint32_t aMacFrameCounter)
仅当新值大于当前值时，才设置当前的 MAC 帧计数器值。
otLinkRawSetMacKey(otInstance *aInstance, uint8_t aKeyIdMode, uint8_t aKeyId, const otMacKey *aPrevKey, const otMacKey *aCurrKey, const otMacKey *aNextKey)
更新 MAC 密钥和密钥索引。
otLinkRawSetPromiscuous(otInstance *aInstance, bool aEnable)
启用或停用混杂模式。
otLinkRawSetReceiveDone(otInstance *aInstance, otLinkRawReceiveDone aCallback)
启用/停用原始链接层。
otLinkRawSetShortAddress(otInstance *aInstance, uint16_t aShortAddress)
设置用于过滤地址的短地址。
otLinkRawSleep(otInstance *aInstance)
将无线装置从“接收”模式转换为“睡眠”模式。
otLinkRawSrcMatchAddExtEntry(otInstance *aInstance, const otExtAddress *aExtAddress)
正在向来源匹配表添加扩展地址。
otLinkRawSrcMatchAddShortEntry(otInstance *aInstance, uint16_t aShortAddress)
正在向来源匹配表添加短地址。
otLinkRawSrcMatchClearExtEntries(otInstance *aInstance)
从来源匹配表中移除所有扩展地址。
otLinkRawSrcMatchClearExtEntry(otInstance *aInstance, const otExtAddress *aExtAddress)
正在移除电台来源匹配表的扩展地址。
otLinkRawSrcMatchClearShortEntries(otInstance *aInstance)
从来源匹配表中移除所有短地址。
otLinkRawSrcMatchClearShortEntry(otInstance *aInstance, uint16_t aShortAddress)
正在移除来源匹配表的短地址。
otLinkRawSrcMatchEnable(otInstance *aInstance, bool aEnable)
为待处理的帧启用/停用来源匹配。
otLinkRawTransmit(otInstance *aInstance, otLinkRawTransmitDone aCallback)
在无线装置上开始发送序列。

类型定义符

otLinkRawEnergyScanDone

void(* otLinkRawEnergyScanDone)(otInstance *aInstance, int8_t aEnergyScanMaxRssi)

用于接收 IEEE 802.15.4 帧的指针。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aEnergyScanMaxRssi
已扫描的频道上遇到的最大 RSSI。

otLinkRawReceiveDone

void(* otLinkRawReceiveDone)(otInstance *aInstance, otRadioFrame *aFrame, otError aError)

用于接收 IEEE 802.15.4 帧的指针。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aFrame
指向已接收帧的指针，如果接收操作被取消，则为 NULL。
[in] aError
OT_ERROR_NONE（如果成功收到帧）。OT_ERROR_ABORT 表示接收被中止且未收到帧时抛出的异常。

otLinkRawTransmitDone

void(* otLinkRawTransmitDone)(otInstance *aInstance, otRadioFrame *aFrame, otRadioFrame *aAckFrame, otError aError)

用于接收 IEEE 802.15.4 帧的指针。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aFrame
指向已传输帧的指针。
[in] aAckFrame
指向 ACK 帧的指针。
[in] aError
传输帧时抛出 OT_ERROR_NONE。OT_ERROR_NO_ACK 发送帧但未接收到 ACK 时（如果因信道上的活动而无法进行传输）。OT_ERROR_ABORT 因其他原因而取消传输。

函数

otLinkRawEnergyScan

otError otLinkRawEnergyScan(
  otInstance *aInstance,
  uint8_t aScanChannel,
  uint16_t aScanDuration,
  otLinkRawEnergyScanDone aCallback
)

在无线装置上开始能量扫描序列。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aScanChannel
执行能量扫描的通道。
[in] aScanDuration
要扫描的频道的时长（以毫秒为单位）。
[in] aCallback
指向扫描通道完成时调用的函数的指针。
返回值
OT_ERROR_NONE
已成功开始扫描频道。
OT_ERROR_BUSY
无线装置正在执行能量扫描。
OT_ERROR_NOT_IMPLEMENTED
无线装置不支持能量扫描。
OT_ERROR_INVALID_STATE
如果未启用原始链接层。

otLinkRawGetCaps

otRadioCaps otLinkRawGetCaps(
  otInstance *aInstance
)

获取电台功能。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
返回值
无线电功能位矢量。堆栈会根据此值启用或停用某些函数。

otLinkRawGetPromiscuous

bool otLinkRawGetPromiscuous(
  otInstance *aInstance
)

获取混杂模式的状态。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
返回值
true
已启用混杂模式。
false
混杂模式已停用。

otLinkRawGetRadioTime

uint64_t otLinkRawGetRadioTime(
  otInstance *aInstance
)

获取无线装置芯片的当前平台时间（64 位宽）。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
返回值
当前无线电时间（以微秒为单位）。

otLinkRawGetRssi

int8_t otLinkRawGetRssi(
  otInstance *aInstance
)

获取最新的 RSSI 测量值。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
返回值
RSSI（以 dBm 为单位）（若有效）。如果 RSSI 无效，则为 127。

otLinkRawGetTransmitBuffer

otRadioFrame * otLinkRawGetTransmitBuffer(
  otInstance *aInstance
)

无线装置从发射转换到接收。

返回指向传输缓冲区的指针。

调用方会在此缓冲区中形成 IEEE 802.15.4 帧，然后调用 otLinkRawTransmit() 以请求传输。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
返回值
指向传输缓冲区的指针，如果未启用原始链路层，则为 NULL。

otLinkRawIsEnabled

bool otLinkRawIsEnabled(
  otInstance *aInstance
)

指明原始链接层是否已启用。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
返回值
true
启用原始链接层。
false
原始链接层已停用。

otLinkRawReceive

otError otLinkRawReceive(
  otInstance *aInstance
)

将电台从“睡眠”转换为“接收”。

打开无线装置。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
返回值
OT_ERROR_NONE
已成功转换为接收端。
OT_ERROR_INVALID_STATE
无线装置已停用或正在传输。

otLinkRawSetMacFrameCounter

otError otLinkRawSetMacFrameCounter(
  otInstance *aInstance,
  uint32_t aMacFrameCounter
)

设置当前的 MAC 帧计数器值。

始终将 MAC 计数器设置为新的给定值 aMacFrameCounter，与当前值无关。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aMacFrameCounter
MAC 帧计数器值。
返回值
OT_ERROR_NONE
如果成功，
OT_ERROR_INVALID_STATE
如果未启用原始链接层。

otLinkRawSetMacFrameCounterIfLarger

otError otLinkRawSetMacFrameCounterIfLarger(
  otInstance *aInstance,
  uint32_t aMacFrameCounter
)

仅当新值大于当前值时，才设置当前的 MAC 帧计数器值。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aMacFrameCounter
MAC 帧计数器值。
返回值
OT_ERROR_NONE
如果成功，
OT_ERROR_INVALID_STATE
如果未启用原始链接层。

otLinkRawSetMacKey

otError otLinkRawSetMacKey(
  otInstance *aInstance,
  uint8_t aKeyIdMode,
  uint8_t aKeyId,
  const otMacKey *aPrevKey,
  const otMacKey *aCurrKey,
  const otMacKey *aNextKey
)

更新 MAC 密钥和密钥索引。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aKeyIdMode
密钥 ID 模式。
[in] aKeyId
键索引。
[in] aPrevKey
旧 MAC 密钥。
[in] aCurrKey
当前的 MAC 密钥。
[in] aNextKey
下一个 MAC 密钥。
返回值
OT_ERROR_NONE
如果成功，
OT_ERROR_INVALID_STATE
如果未启用原始链接层。

otLinkRawSetPromiscuous

otError otLinkRawSetPromiscuous(
  otInstance *aInstance,
  bool aEnable
)

启用或停用混杂模式。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aEnable
用于启用或停用混杂模式的值。
返回值
OT_ERROR_NONE
如果成功，
OT_ERROR_INVALID_STATE
如果未启用原始链接层。

otLinkRawSetReceiveDone

otError otLinkRawSetReceiveDone(
  otInstance *aInstance,
  otLinkRawReceiveDone aCallback
)

启用/停用原始链接层。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aCallback
指向在收到 IEEE 802.15.4 帧时调用的函数的指针。NULL，用于停用原始链接层。
返回值
OT_ERROR_FAILED
无法启用/停用无线装置。
OT_ERROR_INVALID_STATE
OpenThread IPv6 接口已启用。
OT_ERROR_NONE
是否成功设置了启用状态。

otLinkRawSetShortAddress

otError otLinkRawSetShortAddress(
  otInstance *aInstance,
  uint16_t aShortAddress
)

设置用于过滤地址的短地址。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aShortAddress
IEEE 802.15.4 短地址。
返回值
OT_ERROR_NONE
如果成功，
OT_ERROR_INVALID_STATE
如果未启用原始链接层。

otLinkRawSleep

otError otLinkRawSleep(
  otInstance *aInstance
)

将无线装置从“接收”模式转换为“睡眠”模式。

关闭无线装置。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
返回值
OT_ERROR_NONE
已成功转换到“睡眠”模式。
OT_ERROR_BUSY
无线电正在传输
OT_ERROR_INVALID_STATE
电台已停用

otLinkRawSrcMatchAddExtEntry

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

正在向来源匹配表添加扩展地址。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aExtAddress
要添加的扩展地址。
返回值
OT_ERROR_NONE
扩展地址已成功添加到来源匹配表中。
OT_ERROR_NO_BUFS
源匹配表中没有可用的条目。
OT_ERROR_INVALID_STATE
如果未启用原始链接层。

otLinkRawSrcMatchAddShortEntry

otError otLinkRawSrcMatchAddShortEntry(
  otInstance *aInstance,
  uint16_t aShortAddress
)

正在向来源匹配表添加短地址。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aShortAddress
要添加的短地址。
返回值
OT_ERROR_NONE
已成功将短地址添加到来源匹配表中。
OT_ERROR_NO_BUFS
源匹配表中没有可用的条目。
OT_ERROR_INVALID_STATE
如果未启用原始链接层。

otLinkRawSrcMatchClearExtEntries

otError otLinkRawSrcMatchClearExtEntries(
  otInstance *aInstance
)

从来源匹配表中移除所有扩展地址。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
返回值
OT_ERROR_NONE
如果成功，
OT_ERROR_INVALID_STATE
如果未启用原始链接层。

otLinkRawSrcMatchClearExtEntry

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

正在移除电台来源匹配表的扩展地址。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aExtAddress
要移除的扩展地址。
返回值
OT_ERROR_NONE
已成功从来源匹配表中移除扩展地址。
OT_ERROR_NO_ADDRESS
扩展地址不在源匹配表中。
OT_ERROR_INVALID_STATE
如果未启用原始链接层。

otLinkRawSrcMatchClearShortEntries

otError otLinkRawSrcMatchClearShortEntries(
  otInstance *aInstance
)

从来源匹配表中移除所有短地址。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
返回值
OT_ERROR_NONE
如果成功，
OT_ERROR_INVALID_STATE
如果未启用原始链接层。

otLinkRawSrcMatchClearShortEntry

otError otLinkRawSrcMatchClearShortEntry(
  otInstance *aInstance,
  uint16_t aShortAddress
)

正在移除来源匹配表的短地址。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aShortAddress
要移除的短地址。
返回值
OT_ERROR_NONE
已成功从来源匹配表中移除短地址。
OT_ERROR_NO_ADDRESS
短地址不在来源匹配表中。
OT_ERROR_INVALID_STATE
如果未启用原始链接层。

otLinkRawSrcMatchEnable

otError otLinkRawSrcMatchEnable(
  otInstance *aInstance,
  bool aEnable
)

为待处理的帧启用/停用来源匹配。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aEnable
为待处理的帧启用/停用源匹配。
返回值
OT_ERROR_NONE
如果成功，
OT_ERROR_INVALID_STATE
如果未启用原始链接层。

otLinkRawTransmit

otError otLinkRawTransmit(
  otInstance *aInstance,
  otLinkRawTransmitDone aCallback
)

在无线装置上开始发送序列。

在请求传输之前，调用方必须在 otLinkRawGetTransmitBuffer() 提供的缓冲区中形成 IEEE 802.15.4 帧。信道和发射功率也包含在 otRadioFrame 结构中。

传输序列包括：

  1. 将无线电从“接收”转换为“发送”。
  2. 在指定信道上以给定的传输功率传输 PSDU。

具体说明
参数
[in] aInstance
指向 OpenThread 实例的指针。
[in] aCallback
指向在传输完成时调用的函数的指针。
返回值
OT_ERROR_NONE
已成功转换为 Transmit。
OT_ERROR_INVALID_STATE
无线装置不处于接收状态。

资源

OpenThread API 参考文档源自 GitHub 上提供的源代码。如需了解详情，或者为我们的文档做贡献，请参阅资源。