リンク

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

概要

列挙型
otMacFilterAddressMode{   OT_MAC_FILTER_ADDRESS_MODE_DISABLED,   OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST,   OT_MAC_FILTER_ADDRESS_MODE_DENYLIST }	enum Mac フィルタのアドレスモードを定義します。

Typedef
otActiveScanResult	typedef struct otActiveScanResult 受信した IEEE 802.15.4 ビーコンを表します。
otEnergyScanResult	typedef struct otEnergyScanResult エネルギー スキャンの結果を表します。
otHandleActiveScanResult)(otActiveScanResult *aResult, void *aContext)	typedef void(* IEEE 802.15.4 アクティブ スキャン中に、IEEE 802.15.4 ビーコンが受信されたとき、またはスキャンが完了したときに、ポインタが呼び出されます。
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 enum otMacFilterAddressMode Mac フィルタのアドレスモードを定義します。
otMacFilterEntry	typedef struct otMacFilterEntry Mac フィルタ エントリを表します。
otMacFilterIterator	typedef uint8_t MAC フィルタ エントリを反復処理するために使用します。
otThreadLinkInfo	typedef struct otThreadLinkInfo Thread 無線から受信したメッセージのリンク固有の情報を表します。

関数
otLinkActiveScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleActiveScanResult aCallback, void *aCallbackContext)	otError IEEE 802.15.4 アクティブ スキャンを開始します。
otLinkConvertLinkQualityToRss(otInstance *aInstance, uint8_t aLinkQuality)	int8_t リンク品質を一般的な受信電波強度に変換します。
otLinkConvertRssToLinkQuality(otInstance *aInstance, int8_t aRss)	uint8_t 受信電波強度をリンク品質に変換します。
otLinkEnergyScan(otInstance *aInstance, uint32_t aScanChannels, uint16_t aScanDuration, otHandleEnergyScanResult aCallback, void *aCallbackContext)	otError IEEE 802.15.4 エネルギー スキャンを開始します。
otLinkFilterAddAddress(otInstance *aInstance, const otExtAddress *aExtAddress)	otError MAC フィルタに拡張アドレスを追加します。
otLinkFilterAddRssIn(otInstance *aInstance, const otExtAddress *aExtAddress, int8_t aRss)	otError 指定された拡張アドレスを RssIn リストに追加（または RssIn リストの既存のアドレスを変更）し、そのアドレスからのメッセージの受信電波強度（dBm 単位）エントリを設定します。
otLinkFilterClearAddresses(otInstance *aInstance)	void MAC フィルタからすべての拡張アドレスを消去します。
otLinkFilterClearAllRssIn(otInstance *aInstance)	void RssIn リストから受信電波強度（rss）とリンク品質インジケーター（lqi）のエントリ（デフォルトを含む）をすべて消去します。
otLinkFilterClearDefaultRssIn(otInstance *aInstance)	void MAC フィルタで以前に設定したデフォルトの受信信号強度（dBm 単位）をクリアします。
otLinkFilterGetAddressMode(otInstance *aInstance)	otMacFilterAddressMode MAC フィルタのアドレスモードを取得します。
otLinkFilterGetNextAddress(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)	otError 使用中のアドレス フィルタ エントリを取得します。
otLinkFilterGetNextRssIn(otInstance *aInstance, otMacFilterIterator *aIterator, otMacFilterEntry *aEntry)	otError 使用中の RssIn フィルタ エントリを取得します。
otLinkFilterRemoveAddress(otInstance *aInstance, const otExtAddress *aExtAddress)	void MAC フィルタから拡張アドレスを削除します。
otLinkFilterRemoveRssIn(otInstance *aInstance, const otExtAddress *aExtAddress)	void 指定された拡張アドレスを RssIn リストから削除します。
otLinkFilterSetAddressMode(otInstance *aInstance, otMacFilterAddressMode aMode)	void MAC フィルタのアドレス モードを設定します。
otLinkFilterSetDefaultRssIn(otInstance *aInstance, int8_t aRss)	void MAC フィルタのデフォルトの受信信号強度（dBm）を設定します。
otLinkGetCcaFailureRate(otInstance *aInstance)	uint16_t 現在の CCA（Clear Channel Assessment）の失敗率を返します。
otLinkGetChannel(otInstance *aInstance)	uint8_t IEEE 802.15.4 チャンネルを取得します。
otLinkGetCounters(otInstance *aInstance)	const otMacCounters * MAC レイヤのカウンタを取得します。
otLinkGetCslChannel(otInstance *aInstance)	uint8_t CSL チャネルを取得します。
otLinkGetCslPeriod(otInstance *aInstance)	uint32_t CSL 期間をマイクロ秒単位で取得します。
otLinkGetCslTimeout(otInstance *aInstance)	uint32_t CSL タイムアウトを取得します。
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)	otPanId IEEE 802.15.4 PAN ID を取得します。
otLinkGetPollPeriod(otInstance *aInstance)	uint32_t スリープ状態のエンドデバイスのデータ アンケート期間を取得します。
otLinkGetRegion(otInstance *aInstance, uint16_t *aRegionCode)	otError 地域コードを取得します。
otLinkGetShortAddress(otInstance *aInstance)	otShortAddress IEEE 802.15.4 の短縮アドレスを取得します。
otLinkGetSupportedChannelMask(otInstance *aInstance)	uint32_t MAC レイヤのサポートされているチャネル マスクを取得します。
otLinkGetTxDirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)	const uint32_t * 1 つのダイレクト パケットについて、成功までの再試行のヒストグラムを取得します。
otLinkGetTxIndirectRetrySuccessHistogram(otInstance *aInstance, uint8_t *aNumberOfEntries)	const uint32_t * 単一の間接パケットについて、成功までの再試行のヒストグラムを取得します。
otLinkIsActiveScanInProgress(otInstance *aInstance)	bool IEEE 802.15.4 アクティブ スキャンが現在進行中かどうかを示します。
otLinkIsCslEnabled(otInstance *aInstance)	bool CSL が有効かどうかを示します。
otLinkIsCslSupported(otInstance *aInstance)	bool デバイスが、CSL をサポートする親に接続されているかどうかを示します。
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)	otError 送信のために IEEE 802.15.4 Data Request メッセージをキューに追加します。
otLinkSendEmptyData(otInstance *aInstance)	otError 空の IEEE 802.15.4 データフレームを送信するようデバイスに指示します。
otLinkSetChannel(otInstance *aInstance, uint8_t aChannel)	otError IEEE 802.15.4 チャネルを設定します。
otLinkSetCslChannel(otInstance *aInstance, uint8_t aChannel)	otError CSL チャネルを設定します。
otLinkSetCslPeriod(otInstance *aInstance, uint32_t aPeriod)	otError CSL 期間をマイクロ秒単位で設定します。
otLinkSetCslTimeout(otInstance *aInstance, uint32_t aTimeout)	otError CSL タイムアウトを秒単位で設定します。
otLinkSetEnabled(otInstance *aInstance, bool aEnable)	otError リンクレイヤを有効または無効にします。
otLinkSetExtendedAddress(otInstance *aInstance, const otExtAddress *aExtAddress)	otError IEEE 802.15.4 拡張アドレスを設定します。
otLinkSetMaxFrameRetriesDirect(otInstance *aInstance, uint8_t aMaxFrameRetriesDirect)	void 直接送信中のフレーム再試行の最大数を設定します。
otLinkSetMaxFrameRetriesIndirect(otInstance *aInstance, uint8_t aMaxFrameRetriesIndirect)	void 間接伝送中のフレーム再試行の最大数を設定します。
otLinkSetPanId(otInstance *aInstance, otPanId aPanId)	otError IEEE 802.15.4 PAN ID を設定します。
otLinkSetPcapCallback(otInstance *aInstance, otLinkPcapCallback aPcapCallback, void *aCallbackContext)	void 受信した未加工の IEEE 802.15.4 フレームを提供するコールバックを登録します。
otLinkSetPollPeriod(otInstance *aInstance, uint32_t aPollPeriod)	otError スリープ状態のエンドデバイスのユーザー指定/外部データ ポーリング期間を設定/クリア。
otLinkSetPromiscuous(otInstance *aInstance, bool aPromiscuous)	otError リンクレイヤのプロミスキャス モードを有効または無効にします。
otLinkSetRadioFilterEnabled(otInstance *aInstance, bool aFilterEnabled)	void IEEE 802.15.4 無線フィルタ モードを有効または無効にします。
otLinkSetRegion(otInstance *aInstance, uint16_t aRegionCode)	otError 地域コードを設定します。
otLinkSetSupportedChannelMask(otInstance *aInstance, uint32_t aChannelMask)	otError MAC レイヤのサポート対象チャネル マスクを設定します。

構造体
otActiveScanResult	受信した IEEE 802.15.4 ビーコンを表します。
otEnergyScanResult	エネルギー スキャンの結果を表します。
otMacCounters	MAC レイヤのカウンタを表します。
otMacFilterEntry	Mac フィルタ エントリを表します。
otThreadLinkInfo	Thread 無線から受信したメッセージのリンク固有の情報を表します。

列挙型

otMacFilterAddressMode

 otMacFilterAddressMode

Mac フィルタのアドレスモードを定義します。

プロパティ
OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST	許可リストのアドレス フィルタモードが有効になっています。
OT_MAC_FILTER_ADDRESS_MODE_DENYLIST	拒否リストのアドレスのフィルタモードが有効になっています。
OT_MAC_FILTER_ADDRESS_MODE_DISABLED	アドレス フィルタが無効になっています。

Typedef

otActiveScanResult

struct otActiveScanResult otActiveScanResult

受信した IEEE 802.15.4 ビーコンを表します。

otEnergyScanResult

struct otEnergyScanResult otEnergyScanResult

エネルギー スキャンの結果を表します。

otHandleActiveScanResult

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

IEEE 802.15.4 アクティブ スキャン中に、IEEE 802.15.4 ビーコンが受信されたとき、またはスキャンが完了したときに、ポインタが呼び出されます。

詳細
パラメータ	[in] aResult ビーコン情報への有効なポインタ、またはアクティブなスキャンが完了したら NULL。 [in] aContext アプリケーション固有のコンテキストへのポインタ。

otHandleEnergyScanResult

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

IEEE 802.15.4 エネルギー スキャン中に、チャネルの結果が準備できたとき、またはスキャンが完了したときに、ポインタが呼び出されます。

詳細
パラメータ	[in] aResult エネルギー スキャン結果情報への有効なポインタ、またはエネルギー スキャンが完了した場合は NULL。 [in] aContext アプリケーション固有のコンテキストへのポインタ。

otLinkPcapCallback

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

IEEE 802.15.4 フレームを受信すると、ポインタが呼び出されます。

注: このコールバックは FCS の処理後に呼び出されます。aFrame には、受信した実際の FCS が含まれていない場合があります。

注: このコールバックは IEEE 802.15.4 セキュリティ処理の前に呼び出されます。

詳細
パラメータ	[in] aFrame 受信した IEEE 802.15.4 フレームへのポインタ。 [in] aIsTx このフレームを送信、受信しないか。 [in] aContext アプリケーション固有のコンテキストへのポインタ。

otMacCounters

struct otMacCounters otMacCounters

MAC レイヤのカウンタを表します。

otMacFilterAddressMode

enum otMacFilterAddressMode otMacFilterAddressMode

Mac フィルタのアドレスモードを定義します。

otMacFilterEntry

struct otMacFilterEntry otMacFilterEntry

Mac フィルタ エントリを表します。

otMacFilterIterator

uint8_t otMacFilterIterator

MAC フィルタ エントリを反復処理するために使用します。

otThreadLinkInfo

struct otThreadLinkInfo otThreadLinkInfo

Thread 無線から受信したメッセージのリンク固有の情報を表します。

関数

otLinkActiveScan

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

IEEE 802.15.4 アクティブ スキャンを開始します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aScanChannels スキャンするチャンネルを示すビットベクトル（例: OT_CHANNEL_11_MASK）。 [in] aScanDuration 各チャネルのスキャンに要する時間（ミリ秒単位）。 [in] aCallback ビーコンの受信時またはスキャンの完了時に呼び出される関数へのポインタ。 [in] aCallbackContext アプリケーション固有のコンテキストへのポインタ。
戻り値	OT_ERROR_NONE アクティブ スキャン リクエストを承認しました。 OT_ERROR_BUSY すでにアクティブ スキャンを実行しています。

otLinkConvertLinkQualityToRss

int8_t otLinkConvertLinkQualityToRss(
  otInstance *aInstance,
  uint8_t aLinkQuality
)

リンク品質を一般的な受信電波強度に変換します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aLinkQuality LinkQuality の値は [0,3] の範囲内でなければなりません。
戻り値	一般的なプラットフォームの受信電波強度は aLinkQuality にマッピングされます。

otLinkConvertRssToLinkQuality

uint8_t otLinkConvertRssToLinkQuality(
  otInstance *aInstance,
  int8_t aRss
)

受信電波強度をリンク品質に変換します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aRss 変換される受信電波強度の値。
戻り値	aRss にマッピングされるリンク品質値。

otLinkEnergyScan

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

IEEE 802.15.4 エネルギー スキャンを開始します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aScanChannels エネルギー スキャンを実行するチャネルを示すビットベクトル。 [in] aScanDuration 各チャネルのスキャンに要する時間（ミリ秒単位）。 [in] aCallback スキャン完了時にスキャン結果を渡すために呼び出される関数へのポインタ。 [in] aCallbackContext アプリケーション固有のコンテキストへのポインタ。
戻り値	OT_ERROR_NONE エネルギー スキャン リクエストを承諾しました。 OT_ERROR_BUSY エネルギー スキャンを開始できませんでした。

otLinkFilterAddAddress

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

MAC フィルタに拡張アドレスを追加します。

OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 構成が有効な場合に使用できます。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aExtAddress 拡張アドレスへのポインタ（NULL であってはなりません）。
戻り値	OT_ERROR_NONE aExtAddress を MAC フィルタに追加しました。 OT_ERROR_NO_BUFS 利用可能なエントリがありません。

otLinkFilterAddRssIn

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

指定された拡張アドレスを RssIn リストに追加（または RssIn リストの既存のアドレスを変更）し、そのアドレスからのメッセージの受信電波強度（dBm 単位）エントリを設定します。

rss を設定するために、拡張アドレスは必ずしも address allowlist/denylist フィルタに含める必要はありません。

注: RssIn リストには、rss またはリンク品質インジケーター（lqi）の値がデフォルトと異なる拡張アドレスが含まれます。

OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 構成が有効な場合に使用できます。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aExtAddress IEEE 802.15.4 拡張アドレスへのポインタ。NULL であってはなりません。 [in] aRss 受信電波強度（dBm 単位）。
戻り値	OT_ERROR_NONE aExtAddress と aRss のエントリを追加しました。 OT_ERROR_NO_BUFS 利用可能なエントリがありません。

otLinkFilterClearAddresses

void otLinkFilterClearAddresses(
  otInstance *aInstance
)

MAC フィルタからすべての拡張アドレスを消去します。

OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 構成が有効な場合に使用できます。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。

otLinkFilterClearAllRssIn

void otLinkFilterClearAllRssIn(
  otInstance *aInstance
)

RssIn リストから受信電波強度（rss）とリンク品質インジケーター（lqi）のエントリ（デフォルトを含む）をすべて消去します。

この操作を行うと、すべての拡張アドレスで無線（OTA）信号が使用されます。

OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 構成が有効な場合に使用できます。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。

otLinkFilterClearDefaultRssIn

void otLinkFilterClearDefaultRssIn(
  otInstance *aInstance
)

MAC フィルタで以前に設定したデフォルトの受信信号強度（dBm 単位）をクリアします。

OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 構成が有効な場合に使用できます。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。

otLinkFilterGetAddressMode

otMacFilterAddressMode otLinkFilterGetAddressMode(
  otInstance *aInstance
)

MAC フィルタのアドレスモードを取得します。

OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 構成が有効な場合に使用できます。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	選択します。

otLinkFilterGetNextAddress

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

使用中のアドレス フィルタ エントリを取得します。

OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 構成が有効な場合に使用できます。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in,out] aIterator MAC フィルタ イテレータ コンテキストへのポインタ。最初の使用中のアドレス フィルタ エントリを取得するには、OT_MAC_FILTER_ITERATOR_INIT に設定する必要があります。NULL であってはなりません。 [out] aEntry 情報を配置する場所へのポインタ。NULL であってはなりません。
戻り値	OT_ERROR_NONE 使用中の住所フィルタのエントリを取得しました。 OT_ERROR_NOT_FOUND 後続のエントリがありません。

otLinkFilterGetNextRssIn

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

使用中の RssIn フィルタ エントリを取得します。

OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 構成が有効な場合に使用できます。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in,out] aIterator MAC フィルタ イテレータ コンテキストへのポインタ。NULL であってはなりません。最初のエントリを取得するには、OT_MAC_FILTER_ITERATOR_INIT に設定する必要があります。 [out] aEntry 情報を配置する場所へのポインタ。最後のエントリは拡張アドレスがすべて 0xff となり、設定されていればデフォルトの受信電波強度を示します。aEntry が null であってはなりません。
戻り値	OT_ERROR_NONE 次のエントリを取得しました。 OT_ERROR_NOT_FOUND 後続のエントリがありません。

otLinkFilterRemoveAddress

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

MAC フィルタから拡張アドレスを削除します。

OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 構成が有効な場合に使用できます。

指定した拡張アドレスに一致する既存のエントリがフィルタ内にない場合、アクションは実行されません。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aExtAddress 拡張アドレスへのポインタ（NULL であってはなりません）。

otLinkFilterRemoveRssIn

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

指定された拡張アドレスを RssIn リストから削除します。

RssIn リストから MAC アドレスを削除すると、この MAC アドレスでは代わりにデフォルトの rss と lqi の設定が使用されます（デフォルトが設定されている場合）。（デフォルト値が設定されていない場合は、無線（OTA）信号が使用されます）。

OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 構成が有効な場合に使用できます。

指定された拡張アドレスに一致する既存のエントリが RssIn リストにない場合、アクションは実行されません。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aExtAddress IEEE 802.15.4 拡張アドレスへのポインタ。NULL であってはなりません。

otLinkFilterSetAddressMode

void otLinkFilterSetAddressMode(
  otInstance *aInstance,
  otMacFilterAddressMode aMode
)

MAC フィルタのアドレス モードを設定します。

OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 構成が有効な場合に使用できます。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aMode 設定する住所モード。

otLinkFilterSetDefaultRssIn

void otLinkFilterSetDefaultRssIn(
  otInstance *aInstance,
  int8_t aRss
)

MAC フィルタのデフォルトの受信信号強度（dBm）を設定します。

OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 構成が有効な場合に使用できます。

デフォルトの RSS 値は、フィルタリスト（otLinkFilterAddRssIn() を使用して追加）に明示的な RSS-IN エントリがないアドレスから受信したすべてのフレームに使用されます。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aRss 設定するデフォルトの受信信号強度（dBm）。

otLinkGetCcaFailureRate

uint16_t otLinkGetCcaFailureRate(
  otInstance *aInstance
)

現在の CCA（Clear Channel Assessment）の失敗率を返します。

このレートは、（ほぼ）最後の OPENTHREAD_CONFIG_CCA_FAILURE_RATE_AVERAGING_WINDOW フレーム送信の時間枠で維持されます。

詳細
戻り値	100% の障害率に対応する最大値 0xffff の CCA 障害率。

otLinkGetChannel

uint8_t otLinkGetChannel(
  otInstance *aInstance
)

IEEE 802.15.4 チャンネルを取得します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	IEEE 802.15.4 チャネル。

関連項目:
otLinkSetChannel

otLinkGetCounters

const otMacCounters * otLinkGetCounters(
  otInstance *aInstance
)

MAC レイヤのカウンタを取得します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	MAC レイヤカウンタへのポインタ。

otLinkGetCslChannel

uint8_t otLinkGetCslChannel(
  otInstance *aInstance
)

CSL チャネルを取得します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	CSL チャンネル。

otLinkGetCslPeriod

uint32_t otLinkGetCslPeriod(
  otInstance *aInstance
)

CSL 期間をマイクロ秒単位で取得します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	CSL 期間（マイクロ秒単位）。

otLinkGetCslTimeout

uint32_t otLinkGetCslTimeout(
  otInstance *aInstance
)

CSL タイムアウトを取得します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	CSL タイムアウト（秒単位）。

otLinkGetExtendedAddress

const otExtAddress * otLinkGetExtendedAddress(
  otInstance *aInstance
)

IEEE 802.15.4 拡張アドレスを取得します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	IEEE 802.15.4 拡張アドレスへのポインタ。

otLinkGetFactoryAssignedIeeeEui64

void otLinkGetFactoryAssignedIeeeEui64(
  otInstance *aInstance,
  otExtAddress *aEui64
)

工場出荷時に割り当てられた IEEE EUI-64 を入手します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [out] aEui64 工場出荷時に割り当てられた IEEE EUI-64 が配置されている場所を指すポインタ。

otLinkGetMaxFrameRetriesDirect

uint8_t otLinkGetMaxFrameRetriesDirect(
  otInstance *aInstance
)

直接送信中のフレーム再試行の最大数を返します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	直接送信中の再試行の最大数。

otLinkGetMaxFrameRetriesIndirect

uint8_t otLinkGetMaxFrameRetriesIndirect(
  otInstance *aInstance
)

間接伝送中のフレーム再試行の最大数を返します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	間接送信中の再試行の最大数。

otLinkGetPanId

otPanId otLinkGetPanId(
  otInstance *aInstance
)

IEEE 802.15.4 PAN ID を取得します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	IEEE 802.15.4 PAN ID。

関連項目:
otLinkSetPanId

otLinkGetPollPeriod

uint32_t otLinkGetPollPeriod(
  otInstance *aInstance
)

スリープ状態のエンドデバイスのデータ アンケート期間を取得します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	スリープ状態のエンドデバイスのデータ ポーリング期間（ミリ秒）。

関連項目:
otLinkSetPollPeriod

otLinkGetRegion

otError otLinkGetRegion(
  otInstance *aInstance,
  uint16_t *aRegionCode
)

地域コードを取得します。

無線リージョンの形式は、ISO 3166 alpha-2 コードの 2 バイトの ASCII 表現です。

詳細
パラメータ	[in] aInstance OpenThread インスタンスの構造。 [out] aRegionCode ラジオの地域コード。aRegionCode >> 8 は最初の ASCII 文字で、aRegionCode & 0xff は 2 番目の ASCII 文字です。
戻り値	OT_ERROR_INVALID_ARGS aRegionCode は nullptr です。 OT_ERROR_FAILED その他のプラットフォーム固有のエラー。 OT_ERROR_NONE 地域コードを取得しました。 OT_ERROR_NOT_IMPLEMENTED この機能は実装されていません。

otLinkGetShortAddress

otShortAddress otLinkGetShortAddress(
  otInstance *aInstance
)

IEEE 802.15.4 の短縮アドレスを取得します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	IEEE 802.15.4 Short Address へのポインタ。

otLinkGetSupportedChannelMask

uint32_t otLinkGetSupportedChannelMask(
  otInstance *aInstance
)

MAC レイヤのサポートされているチャネル マスクを取得します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	サポートされるチャネル マスクは uint32_t で、ビット 0（lsb）はチャネル 0 にマッピングされ、ビット 1 はチャネル 1 にマッピングされます（以下同様）。

otLinkGetTxDirectRetrySuccessHistogram

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

1 つのダイレクト パケットについて、成功までの再試行のヒストグラムを取得します。

OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE 構成が有効な場合に有効です。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [out] aNumberOfEntries 返されたヒストグラム配列のサイズが配置される場所へのポインタ。
戻り値	再試行のヒストグラムへのポインタ（配列形式）。n 番目の要素は、パケットが n 回目の再試行で送信されたことを示します。

otLinkGetTxIndirectRetrySuccessHistogram

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

単一の間接パケットについて、成功までの再試行のヒストグラムを取得します。

OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE 構成が有効な場合に有効です。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [out] aNumberOfEntries 返されたヒストグラム配列のサイズが配置される場所へのポインタ。
戻り値	再試行のヒストグラムへのポインタ（配列形式）。n 番目の要素は、パケットが n 回目の再試行で送信されたことを示します。

otLinkIsActiveScanInProgress

bool otLinkIsActiveScanInProgress(
  otInstance *aInstance
)

IEEE 802.15.4 アクティブ スキャンが現在進行中かどうかを示します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	IEEE 802.15.4 アクティブ スキャンが進行中の場合は true、そうでない場合は false です。

otLinkIsCslEnabled

bool otLinkIsCslEnabled(
  otInstance *aInstance
)

CSL が有効かどうかを示します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	TRUE リンクレイヤは CSL が有効になっています。 FALSE リンクレイヤで CSL が有効になっていません。

otLinkIsCslSupported

bool otLinkIsCslSupported(
  otInstance *aInstance
)

デバイスが、CSL をサポートする親に接続されているかどうかを示します。

詳細
戻り値	TRUE 親が CSL をサポートしている場合。 FALSE 親が CSL をサポートしていない場合。

otLinkIsEnabled

bool otLinkIsEnabled(
  otInstance *aInstance
)

リンクレイヤが有効かどうかを示します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	TRUE リンクレイヤが有効になっています。 FALSE リンクレイヤが有効になっていません。

otLinkIsEnergyScanInProgress

bool otLinkIsEnergyScanInProgress(
  otInstance *aInstance
)

IEEE 802.15.4 Energy Scan が現在進行中かどうかを示します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	IEEE 802.15.4 エネルギー スキャンが進行中の場合は true、そうでない場合は false です。

otLinkIsInTransmitState

bool otLinkIsInTransmitState(
  otInstance *aInstance
)

IEEE 802.15.4 MAC アドレスの送信状態を示します。

MAC モジュールは、CSMA/CA 手順中、CCA、データ、ビーコン、またはデータ リクエスト フレームの送信中と送信フレームの ACK 受信中に送信状態にあります。ACK フレームまたはビーコン リクエスト フレームの送信中に、MAC モジュールが送信状態にありません。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	IEEE 802.15.4 MAC が送信状態にある場合は true、そうでない場合は false です。

otLinkIsPromiscuous

bool otLinkIsPromiscuous(
  otInstance *aInstance
)

リンクレイヤでプロミスキャス モードが有効になっているかどうかを示します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	TRUE プロミスキャス モードは有効になっています。 FALSE プロミスキャス モードが有効になっていません。

otLinkIsRadioFilterEnabled

bool otLinkIsRadioFilterEnabled(
  otInstance *aInstance
)

IEEE 802.15.4 無線フィルタが有効かどうかを示します。

OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 構成が有効な場合に使用できます。

詳細
戻り値	TRUE 無線フィルタが有効な場合。 FALSE ラジオフィルタが無効になっている場合。

otLinkResetCounters

void otLinkResetCounters(
  otInstance *aInstance
)

MAC レイヤのカウンタをリセットします。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。

otLinkResetTxRetrySuccessHistogram

void otLinkResetTxRetrySuccessHistogram(
  otInstance *aInstance
)

直接送信と間接送信のヒストグラム統計情報をクリアします。

OPENTHREAD_CONFIG_MAC_RETRY_SUCCESS_HISTOGRAM_ENABLE 構成が有効な場合に有効です。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。

otLinkSendDataRequest

otError otLinkSendDataRequest(
  otInstance *aInstance
)

送信のために IEEE 802.15.4 Data Request メッセージをキューに追加します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	OT_ERROR_NONE IEEE 802.15.4 データ要求メッセージをキューに登録しました。 OT_ERROR_INVALID_STATE デバイスが rx-off-when-idle モードになっていない。 OT_ERROR_NO_BUFS 利用可能なメッセージ バッファが不足しています。

otLinkSendEmptyData

otError otLinkSendEmptyData(
  otInstance *aInstance
)

空の IEEE 802.15.4 データフレームを送信するようデバイスに指示します。

空のデータフレームを親に送信する Rx-Off-When-Idle デバイスでのみサポートされます。注: OPENTHREAD_CONFIG_REFERENCE_DEVICE_ENABLE が有効な場合にのみ使用できます。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。
戻り値	OT_ERROR_NONE 空のメッセージをキューに登録しました。 OT_ERROR_INVALID_STATE デバイスが Rx-Off-When-Idle モードになっていません。 OT_ERROR_NO_BUFS 利用可能なメッセージ バッファが不足しています。

otLinkSetChannel

otError otLinkSetChannel(
  otInstance *aInstance,
  uint8_t aChannel
)

IEEE 802.15.4 チャネルを設定します。

Thread プロトコルが無効になっている場合にのみ成功します。この関数の呼び出しが成功すると、不揮発性メモリ内のアクティブなオペレーション データセットと保留中のオペレーション データセットが無効になります。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aChannel IEEE 802.15.4 チャネル。
戻り値	OT_ERROR_NONE チャネルを設定しました。 OT_ERROR_INVALID_ARGS aChannel が [11, 26] の範囲外であるか、サポートされているチャンネル マスク内にない場合。 OT_ERROR_INVALID_STATE スレッド プロトコルが有効になっている。

関連項目:
otLinkGetChannel

otLinkSetCslChannel

otError otLinkSetCslChannel(
  otInstance *aInstance,
  uint8_t aChannel
)

CSL チャネルを設定します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aChannel CSL サンプル チャンネル。チャネル値は 0（CSL チャネル設定未指定）、または [1, 10]（915 MHz がサポートされている場合）と 11, 26 の範囲内である必要があります。
戻り値	OT_ERROR_NONE CSL パラメータを正常に設定しました。 OT_ERROR_INVALID_ARGS aChannel が無効です。

otLinkSetCslPeriod

otError otLinkSetCslPeriod(
  otInstance *aInstance,
  uint32_t aPeriod
)

CSL 期間をマイクロ秒単位で設定します。

このパラメータを 0 に設定して、CSL を無効にします。

CSL 期間は OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC の倍数でなければなりません。それ以外の場合は、OT_ERROR_INVALID_ARGS が返されます。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aPeriod CSL 期間（マイクロ秒単位）。
戻り値	OT_ERROR_NONE CSL 期間を設定しました。 OT_ERROR_INVALID_ARGS 無効な CSL 期間

otLinkSetCslTimeout

otError otLinkSetCslTimeout(
  otInstance *aInstance,
  uint32_t aTimeout
)

CSL タイムアウトを秒単位で設定します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aTimeout CSL タイムアウト（秒単位）。
戻り値	OT_ERROR_NONE CSL タイムアウトを設定しました。 OT_ERROR_INVALID_ARGS 無効な CSL タイムアウト。

otLinkSetEnabled

otError otLinkSetEnabled(
  otInstance *aInstance,
  bool aEnable
)

リンクレイヤを有効または無効にします。

注: リンクレイヤは、スレッド インターフェースが無効になっている場合にのみ有効または無効にできます。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aEnable リンクレイヤを有効にする場合は true、そうでない場合は false です。
戻り値	OT_ERROR_NONE リンクレイヤを有効または無効にしました。 OT_ERROR_INVALID_STATE Thread インターフェースが有効になっているため、リンクレイヤを無効にできませんでした。

otLinkSetExtendedAddress

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

IEEE 802.15.4 拡張アドレスを設定します。

注: Thread プロトコルが無効になっている場合にのみ成功します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aExtAddress IEEE 802.15.4 拡張アドレスへのポインタ。
戻り値	OT_ERROR_NONE IEEE 802.15.4 拡張アドレスが正常に設定されました。 OT_ERROR_INVALID_ARGS aExtAddress が NULL だった。 OT_ERROR_INVALID_STATE スレッド プロトコルが有効になっている。

otLinkSetMaxFrameRetriesDirect

void otLinkSetMaxFrameRetriesDirect(
  otInstance *aInstance,
  uint8_t aMaxFrameRetriesDirect
)

直接送信中のフレーム再試行の最大数を設定します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aMaxFrameRetriesDirect 直接送信中の再試行の最大数。

otLinkSetMaxFrameRetriesIndirect

void otLinkSetMaxFrameRetriesIndirect(
  otInstance *aInstance,
  uint8_t aMaxFrameRetriesIndirect
)

間接伝送中のフレーム再試行の最大数を設定します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aMaxFrameRetriesIndirect 間接送信中の再試行の最大数。

otLinkSetPanId

otError otLinkSetPanId(
  otInstance *aInstance,
  otPanId aPanId
)

IEEE 802.15.4 PAN ID を設定します。

Thread プロトコルが無効になっている場合にのみ成功します。この関数の呼び出しが成功すると、不揮発性メモリ内のアクティブな運用データセットと保留中の運用データセットも無効になります。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aPanId IEEE 802.15.4 PAN ID。
戻り値	OT_ERROR_NONE PAN ID を設定しました。 OT_ERROR_INVALID_ARGS aPanId が [0, 65534] の範囲外の場合。 OT_ERROR_INVALID_STATE スレッド プロトコルが有効になっている。

関連項目:
otLinkGetPanId

otLinkSetPcapCallback

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

受信した未加工の IEEE 802.15.4 フレームを提供するコールバックを登録します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aPcapCallback IEEE 802.15.4 リンクフレームまたは NULL を受信したときにコールバックを無効にする場合に呼び出される関数へのポインタ。 [in] aCallbackContext アプリケーション固有のコンテキストへのポインタ。

otLinkSetPollPeriod

otError otLinkSetPollPeriod(
  otInstance *aInstance,
  uint32_t aPollPeriod
)

スリープ状態のエンドデバイスのユーザー指定/外部データ ポーリング期間を設定/クリア。

注: この関数は、スリープ状態のエンドデバイスのポーリング期間のみを更新します。子タイムアウトを更新するには、関数 otThreadSetChildTimeout() を呼び出します。

注: ゼロ以外の最小値は OPENTHREAD_CONFIG_MAC_MINIMUM_POLL_PERIOD（10 ミリ秒）にする必要があります。ゼロの場合、ユーザー指定のポーリング期間をクリアします。

注: ユーザー指定の値は、許容される最大値 0x3FFFFFF（(1 << 26) - 1）以下にする必要があります。そうでない場合、最大値によってクリップされます。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aPollPeriod （ミリ秒単位）。
戻り値	OT_ERROR_NONE ユーザー指定のアンケート期間を設定またはクリアしました。 OT_ERROR_INVALID_ARGS aPollPeriod が無効な場合。

関連情報:
otLinkGetPollPeriod

otLinkSetPromiscuous

otError otLinkSetPromiscuous(
  otInstance *aInstance,
  bool aPromiscuous
)

リンクレイヤのプロミスキャス モードを有効または無効にします。

注: プロミスキャス モードは、Thread インターフェースが無効になっている場合にのみ有効にできます。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aPromiscuous プロミスキャス モードを有効にする場合は true を、それ以外の場合は false を指定します。
戻り値	OT_ERROR_NONE プロミスキャス モードを有効にしました。 OT_ERROR_INVALID_STATE Thread インターフェースが有効になっているため、プロミスキャス モードを有効にできませんでした。

otLinkSetRadioFilterEnabled

void otLinkSetRadioFilterEnabled(
  otInstance *aInstance,
  bool aFilterEnabled
)

IEEE 802.15.4 無線フィルタ モードを有効または無効にします。

OPENTHREAD_CONFIG_MAC_FILTER_ENABLE 構成が有効な場合に使用できます。

無線フィルタは主にテストを対象としています。これを使用して、802.15.4 無線のすべての送信/受信を一時的にブロックできます。無線フィルタを有効にすると、無線は受信ではなくスリープ状態になります（デバイスがフレームを受信したり、確認応答を送信したりしないようにするため）。また、フレーム送信リクエストは無線（OTA）でフレームを送信せずにすぐに戻ります（確認応答がリクエストされている場合は「確認応答なし」エラーを返し、それ以外の場合は成功を返します）。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aFilterEnabled ラジオボタンのフィルタを有効にする場合は TRUE、無効にする場合は FALSE を指定します。

otLinkSetRegion

otError otLinkSetRegion(
  otInstance *aInstance,
  uint16_t aRegionCode
)

地域コードを設定します。

無線リージョンの形式は、ISO 3166 alpha-2 コードの 2 バイトの ASCII 表現です。

詳細
パラメータ	[in] aInstance OpenThread インスタンスの構造。 [in] aRegionCode ラジオの地域コード。aRegionCode >> 8 は最初の ASCII 文字で、aRegionCode & 0xff は 2 番目の ASCII 文字です。
戻り値	OT_ERROR_FAILED その他のプラットフォーム固有のエラー。 OT_ERROR_NONE 地域コードを設定しました。 OT_ERROR_NOT_IMPLEMENTED この機能は実装されていません。

otLinkSetSupportedChannelMask

otError otLinkSetSupportedChannelMask(
  otInstance *aInstance,
  uint32_t aChannelMask
)

MAC レイヤのサポート対象チャネル マスクを設定します。

Thread プロトコルが無効になっている場合にのみ成功します。

詳細
パラメータ	[in] aInstance OpenThread インスタンスへのポインタ。 [in] aChannelMask サポートされるチャネル マスク（ビット 0 または lsb をチャネル 0 にマッピングするなど）。
戻り値	OT_ERROR_NONE サポートされているチャンネル マスクを設定しました。 OT_ERROR_INVALID_STATE スレッド プロトコルが有効になっている。

マクロ

OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC

 OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC (160)

CSL 期間の 10 記号の単位をマイクロ秒単位で表します。

CSL 期間（マイクロ秒単位）は、この値の倍数でなければなりません。

OT_MAC_FILTER_FIXED_RSS_DISABLED

 OT_MAC_FILTER_FIXED_RSS_DISABLED 127

受信電波強度が固定されていないことを示す場合に使用します。

OT_MAC_FILTER_ITERATOR_INIT

 OT_MAC_FILTER_ITERATOR_INIT 0

otMacFilterIterator の初期化子。

OT_US_PER_TEN_SYMBOLS

 OT_US_PER_TEN_SYMBOLS OT_RADIO_TEN_SYMBOLS_TIME

10 個の記号の時間（マイクロ秒単位）。

関連情報

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