未加工リンク

このモジュールには、未加工のリンクレイヤの構成を制御する関数が含まれています。

概要

Typedef
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)
ラジオをスリープから Receive へと移行します。
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)
無線通信での送信シーケンスを開始します。

Typedef

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。フレームが送信されたが ACK が受信されなかった場合の OT_ERROR_NO_ACK OT_ERROR_CHANNEL_ACCESS_FAILURE は、チャネルのアクティビティが原因で送信を実行できなかった場合に返されます。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
)

ラジオをスリープから Receive へと移行します。

ラジオをオンにします。

詳細
パラメータ
[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 フレームの受信時に呼び出される関数へのポインタ。未加工リンクレイヤを無効にします。
戻り値
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. 無線通信を Receive から Transmit に移行する。
  2. 指定されたチャネル上で PSDU を所定の送信電力で送信する。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aCallback
送信の完了時に呼び出される関数へのポインタ。
戻り値
OT_ERROR_NONE
送信に移行しました。
OT_ERROR_INVALID_STATE
無線通信が受信状態ではありませんでした。

関連情報

OpenThread API リファレンスのトピックは、GitHub で入手できるソースコードに由来しています。 詳細について、またはドキュメントへの投稿については、リソースをご覧ください。