このページは Cloud Translation API によって翻訳されました。

Jam 検出

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

概要

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

Typedef
`otJamDetectionCallback)(bool aJamState, void *aContext)`	typedef `void(*` この関数ポインタは、シグナル Jam 検出が有効で、Jam が検出されると呼び出されます。

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

Typedef

otJamDetectionCallback

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

この関数ポインタは、シグナル Jam 検出が有効で、Jam が検出されると呼び出されます。

詳細

パラメータ

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

関数

otJamDetectionGetBusyPeriod

uint8_t otJamDetectionGetBusyPeriod(
  otInstance *aInstance
)

Jam 検出ビジー期間（秒）を取得する

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

Jam 検出ビジー期間。

otJamDetectionGetHistoryBitmap

uint64_t otJamDetectionGetHistoryBitmap(
  otInstance *aInstance
)

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

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

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

現在の履歴ビットマップ。

otJamDetectionGetRssiThreshold

int8_t otJamDetectionGetRssiThreshold(
  otInstance *aInstance
)

Jam 検出の RSSI しきい値（dBm）を取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

Jam 検出の RSSI しきい値。

otJamDetectionGetState

bool otJamDetectionGetState(
  otInstance *aInstance
)

Jam 検出ステータスを取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

Jam の検出状態（true の Jam が検出されます。それ以外の場合は false）。

otJamDetectionGetWindow

uint8_t otJamDetectionGetWindow(
  otInstance *aInstance
)

Jam 検出検出ウィンドウ（秒単位）を取得します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

Jam 検出ウィンドウ。

otJamDetectionIsEnabled（有効、無効）

bool otJamDetectionIsEnabled(
  otInstance *aInstance
)

Jam 検出ステータスを取得する（有効/無効）

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

Jam 検出ステータス（有効な場合は true、それ以外の場合は false）。

otJamDetectionSetBusyPeriod

otError otJamDetectionSetBusyPeriod(
  otInstance *aInstance,
  uint8_t aBusyPeriod
)

Jam 検出ビジー期間（秒単位）を設定します。

検出期間内で RSSI がしきい値を上回る必要がある集計期間の秒数。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aBusyPeriod`	Jam 検出ビジー期間（ゼロ以外の、Jam 検出ウィンドウ以下にしてください）

戻り値

`OT_ERROR_NONE`	ウィンドウを設定しました。
`OT_ERROR_INVALID_ARGS`	指定した入力は有効な範囲内にありません。

otJamDetectionSetRssiThreshold

otError otJamDetectionSetRssiThreshold(
  otInstance *aInstance,
  int8_t aRssiThreshold
)

Jam 検出の RSSI しきい値（dBm）を設定します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aRssiThreshold`	RSSI のしきい値。

戻り値

OT_ERROR_NONE

しきい値を正常に設定しました。

otJamDetectionSetWindow

otError otJamDetectionSetWindow(
  otInstance *aInstance,
  uint8_t aWindow
)

Jam 検出検出ウィンドウを秒単位で設定できます。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aWindow`	Jam 検出ウィンドウ（有効な範囲は 1 ～ 63）

戻り値

`OT_ERROR_NONE`	ウィンドウを設定しました。
`OT_ERROR_INVALID_ARGS`	指定された入力パラメータが有効な範囲（1 ～ 63）内にありません

otJamDetectionStart

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

Jam 検出を開始します。

詳細

パラメータ

`[in] aInstance`	OpenThread インスタンスへのポインタ。
`[in] aCallback`	Jam の状態の変化を通知する関数へのポインタ。
`[in] aContext`	アプリケーション固有のコンテキストへのポインタ。

戻り値

`OT_ERROR_NONE`	正常に検出されました。
`OT_ERROR_ALREADY`	すでに Jam の検出が開始されています。

otJamDetectionStop

otError otJamDetectionStop(
  otInstance *aInstance
)

故障の検出を停止します。

詳細

パラメータ

[in] aInstance

OpenThread インスタンスへのポインタ。

戻り値

`OT_ERROR_NONE`	正常に検出できませんでした。
`OT_ERROR_ALREADY`	Jam の検出はすでに停止しています。

リソース

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