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

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

Краткое содержание

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

Определения типов

otJamDetectionCallback )(bool aJamState, void *aContext) определение типа
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)
Прекратите обнаружение помех.

Определения типов

обратный вызов otJamDetection

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 для обнаружения помех.

отджамдетектионжетстате

bool otJamDetectionGetState(
  otInstance *aInstance
)

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

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

otJamDetectionGetWindow

uint8_t otJamDetectionGetWindow(
  otInstance *aInstance
)

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

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

отджамдетектионисенаблед

bool otJamDetectionIsEnabled(
  otInstance *aInstance
)

Получить статус обнаружения замятия (включено/выключено)

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

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
Порог установлен успешно.

отджамдетектионсетвиндов

otError otJamDetectionSetWindow(
  otInstance *aInstance,
  uint8_t aWindow
)

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

Подробности
Параметры
[in] aInstance
Указатель на экземпляр OpenThread.
[in] aWindow
Окно «Обнаружение замятия» (допустимый диапазон от 1 до 63)
Возвращаемые значения
OT_ERROR_NONE
Окно установлено успешно.
OT_ERROR_INVALID_ARGS
Данный входной параметр находится за пределами допустимого диапазона (1–63).

отджемдетектионстарт

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

Ресурсы

Справочные разделы API OpenThread взяты из исходного кода, доступного на GitHub . Для получения дополнительной информации или внесения вклада в нашу документацию обратитесь к Ресурсам .