ジャム検出

このモジュールには、信号の詰まり検出機能の関数が含まれています。

概要

このモジュールの関数は、ジャム検出機能（OPENTHREAD_CONFIG_JAM_DETECTION_ENABLE）が有効になっている場合に使用できます。

Typedef
otJamDetectionCallback)(bool aJamState, void *aContext) typedef
void(*
信号のジャム検出が有効になっていて、ジャムが検出された場合、ポインタが呼び出されます。

関数
otJamDetectionGetBusyPeriod(otInstance *aInstance)
uint8_t
ジャム検出のビジー期間（秒）を取得
otJamDetectionGetHistoryBitmap(otInstance *aInstance)
uint64_t
現在の履歴のビットマップを取得します。
otJamDetectionGetRssiThreshold(otInstance *aInstance)
int8_t
ジャム検出 RSSI しきい値（dBm 単位）を取得します。
otJamDetectionGetState(otInstance *aInstance)
bool
ジャム検出の状態を取得する。
otJamDetectionGetWindow(otInstance *aInstance)
uint8_t
ジャム検出検出ウィンドウの取得（秒）
otJamDetectionIsEnabled(otInstance *aInstance)
bool
ジャム検出のステータスを取得する（有効/無効）
otJamDetectionSetBusyPeriod(otInstance *aInstance, uint8_t aBusyPeriod)
ジャム検出のビジー期間を秒単位で設定します。
otJamDetectionSetRssiThreshold(otInstance *aInstance, int8_t aRssiThreshold)
ジャム検出 RSSI しきい値を dBm 単位で設定します。
otJamDetectionSetWindow(otInstance *aInstance, uint8_t aWindow)
ジャム検出検出ウィンドウを秒単位で設定します。
otJamDetectionStart(otInstance *aInstance, otJamDetectionCallback aCallback, void *aContext)
詰まり検出を開始する。
otJamDetectionStop(otInstance *aInstance)
障害検出を停止します。

Typedef

otJamDetectionCallback

void(* otJamDetectionCallback)(bool aJamState, void *aContext)

信号のジャム検出が有効になっていて、ジャムが検出された場合、ポインタが呼び出されます。

詳細
パラメータ
[in] aJamState
現在の Jam の状態（ジャムが検出された場合は true、それ以外の場合は false）。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。

関数

otJamDetectionGetBusyPeriod

uint8_t otJamDetectionGetBusyPeriod(
  otInstance *aInstance
)

ジャム検出のビジー期間（秒）を取得

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
ジャム検出がビジー状態の期間です。

otJamDetectionGetHistoryBitmap

uint64_t otJamDetectionGetHistoryBitmap(
  otInstance *aInstance
)

現在の履歴のビットマップを取得します。

この値は、モニタリングやデバッグを目的とした、詰まり検出モジュールの現在の状態に関する情報を提供します。64 ビットの値を返し、各ビットは 1 秒間隔に対応します。各ビットは、最新の間隔のビット 0、最も古い間隔（63 秒前）のビット 63 から始まります。対応する 1 秒間にジャミング検出モジュールが高信号レベルを観測または検出した場合、ビットは 1 に設定されます。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
現在の履歴のビットマップ。

otJamDetectionGetRssiThreshold

int8_t otJamDetectionGetRssiThreshold(
  otInstance *aInstance
)

ジャム検出 RSSI しきい値（dBm 単位）を取得します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
ジャム検出 RSSI のしきい値。

otJamDetectionGetState

bool otJamDetectionGetState(
  otInstance *aInstance
)

ジャム検出の状態を取得する。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
紙詰まり検出の状態（true の紙詰まりが検出されました。それ以外の場合は「false」です。

otJamDetectionGetWindow

uint8_t otJamDetectionGetWindow(
  otInstance *aInstance
)

ジャム検出検出ウィンドウの取得（秒）

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
紙詰まり検出ウィンドウ。

otJamDetectionIsEnabled

bool otJamDetectionIsEnabled(
  otInstance *aInstance
)

ジャム検出のステータスを取得する（有効/無効）

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
ジャム検出のステータス（有効な場合は true、そうでない場合は false）。

otJamDetectionSetBusyPeriod

otError otJamDetectionSetBusyPeriod(
  otInstance *aInstance,
  uint8_t aBusyPeriod
)

ジャム検出のビジー期間を秒単位で設定します。

検出時間枠内の集計された秒数。ここで、RSSI が検出をトリガーするには、しきい値を超えている必要があります。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aBusyPeriod
ジャム検出のビジー期間（ゼロ以外ではジャム検出ウィンドウ以下の値を指定してください）
戻り値
OT_ERROR_NONE
ウィンドウを設定しました。
OT_ERROR_INVALID_ARGS
入力した値が有効な範囲内にありません。

otJamDetectionSetRssiThreshold

otError otJamDetectionSetRssiThreshold(
  otInstance *aInstance,
  int8_t aRssiThreshold
)

ジャム検出 RSSI しきい値を dBm 単位で設定します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aRssiThreshold
RSSI のしきい値。
戻り値
OT_ERROR_NONE
しきい値を設定しました。

otJamDetectionSetWindow

otError otJamDetectionSetWindow(
  otInstance *aInstance,
  uint8_t aWindow
)

ジャム検出検出ウィンドウを秒単位で設定します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aWindow
[Jam Detection] ウィンドウ（有効範囲は 1 ～ 63）
戻り値
OT_ERROR_NONE
ウィンドウを設定しました。
OT_ERROR_INVALID_ARGS
指定された入力パラメータが有効な範囲（1 ～ 63）内にありません

otJamDetectionStart

otError otJamDetectionStart(
  otInstance *aInstance,
  otJamDetectionCallback aCallback,
  void *aContext
)

詰まり検出を開始する。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
[in] aCallback
ジャミング状態の変化を通知するために呼び出される関数へのポインタ。
[in] aContext
アプリケーション固有のコンテキストへのポインタ。
戻り値
OT_ERROR_NONE
詰まりの検出を開始しました。
OT_ERROR_ALREADY
以前にジャムの検出を開始しています。

otJamDetectionStop

otError otJamDetectionStop(
  otInstance *aInstance
)

障害検出を停止します。

詳細
パラメータ
[in] aInstance
OpenThread インスタンスへのポインタ。
戻り値
OT_ERROR_NONE
詰まりの検出を停止しました。
OT_ERROR_ALREADY
紙詰まりの検出はすでに停止しています。

関連情報

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