Обнаружение замятия

Этот модуль включает функции для обнаружения помех сигнала.

Резюме

Функции в этом модуле доступны, когда включена функция обнаружения OPENTHREAD_CONFIG_JAM_DETECTION_ENABLE ( OPENTHREAD_CONFIG_JAM_DETECTION_ENABLE ).

Typedefs

otJamDetectionCallback )(bool aJamState, void *aContext) typedef
void(*
Этот указатель функции вызывается, если включено обнаружение замятия сигнала и обнаружено замятие.

Функции

otJamDetectionGetBusyPeriod ( otInstance *aInstance)
uint8_t
Получите период занятости для обнаружения замятия (в секундах)
otJamDetectionGetHistoryBitmap ( otInstance *aInstance)
uint64_t
Получить текущее растровое изображение истории.
otJamDetectionGetRssiThreshold ( otInstance *aInstance)
int8_t
Получите пороговое значение RSSI для обнаружения замятия (в дБм).
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 для обнаружения замятия (в дБм).
otJamDetectionSetWindow ( otInstance *aInstance, uint8_t aWindow)
Установите окно обнаружения замятия (в секундах).
otJamDetectionStart ( otInstance *aInstance, otJamDetectionCallback aCallback, void *aContext)
Запустите обнаружение заклинивания.
otJamDetectionStop ( otInstance *aInstance)
Остановите обнаружение заклинивания.

Typedefs

otJamDetectionCallback

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

Этот указатель функции вызывается, если включено обнаружение замятия сигнала и обнаружено замятие.

Подробности
Параметры
[in] aJamState
Текущее состояние замятия ( true если застревание обнаружено, иначе false ).
[in] aContext
Указатель на контекст приложения.

Функции

otJamDetectionGetBusyPeriod

uint8_t otJamDetectionGetBusyPeriod(
  otInstance *aInstance
)

Получите период занятости для обнаружения замятия (в секундах)

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Период занятости для обнаружения замятия.

otJamDetectionGetHistoryBitmap

uint64_t otJamDetectionGetHistoryBitmap(
  otInstance *aInstance
)

Получить текущее растровое изображение истории.

Это значение предоставляет информацию о текущем состоянии модуля обнаружения помех для целей мониторинга / отладки. Он возвращает 64-битное значение, где каждый бит соответствует интервалу в одну секунду, начиная с бита 0 для самого последнего интервала и бита 63 для самых старых интервалов (на 63 секунды раньше). Бит устанавливается в 1, если модуль обнаружения помех обнаружил / обнаружил высокий уровень сигнала в течение соответствующего интервала в одну секунду.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Растровое изображение текущей истории.

otJamDetectionGetRssiThreshold

int8_t otJamDetectionGetRssiThreshold(
  otInstance *aInstance
)

Получите пороговое значение RSSI для обнаружения замятия (в дБм).

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Пороговое значение RSSI для обнаружения замятия.

otJamDetectionGetState

bool otJamDetectionGetState(
  otInstance *aInstance
)

Получите состояние обнаружения замятия.

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
Возврат
Состояние «Обнаружение застревания» (обнаружено true застревание, в противном случае - «ложь»).

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 для обнаружения замятия (в дБм).

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aRssiThreshold
Порог RSSI.
Возвращаемые значения
OT_ERROR_NONE
Успешно установил порог.

otJamDetectionSetWindow

otError otJamDetectionSetWindow(
  otInstance *aInstance,
  uint8_t aWindow
)

Установите окно обнаружения замятия (в секундах).

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aWindow
Окно обнаружения замятия (допустимый диапазон от 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
Обнаружение замятия уже остановлено.