Detección de atascos

Este módulo incluye funciones para la función de detección de interferencia de señal.

Resumen

Las funciones de este módulo están disponibles cuando la función de detección de OPENTHREAD_CONFIG_JAM_DETECTION_ENABLE ( OPENTHREAD_CONFIG_JAM_DETECTION_ENABLE ) está habilitada.

Typedefs
`otJamDetectionCallback )(bool aJamState, void *aContext)`	typedef `void(*` Este puntero de función se llama si la detección de atasco de señal está habilitada y se detecta un atasco.

Funciones
`otJamDetectionGetBusyPeriod ( otInstance *aInstance)`	`uint8_t` Obtenga el período ocupado de detección de atascos (en segundos)
`otJamDetectionGetHistoryBitmap ( otInstance *aInstance)`	`uint64_t` Obtenga el mapa de bits del historial actual.
`otJamDetectionGetRssiThreshold ( otInstance *aInstance)`	`int8_t` Obtenga el umbral RSSI de detección de atascos (en dBm).
`otJamDetectionGetState ( otInstance *aInstance)`	`bool` Obtenga el estado de detección de atascos.
`otJamDetectionGetWindow ( otInstance *aInstance)`	`uint8_t` Obtenga la ventana de detección de atascos (en segundos).
`otJamDetectionIsEnabled ( otInstance *aInstance)`	`bool` Obtener el estado de detección de atascos (habilitado / deshabilitado)
`otJamDetectionSetBusyPeriod ( otInstance *aInstance, uint8_t aBusyPeriod)`	`otError` Configure el Período ocupado de detección de atascos (en segundos).
`otJamDetectionSetRssiThreshold ( otInstance *aInstance, int8_t aRssiThreshold)`	`otError` Establezca el umbral RSSI de detección de atascos (en dBm).
`otJamDetectionSetWindow ( otInstance *aInstance, uint8_t aWindow)`	`otError` Configure la ventana de detección de atascos (en segundos).
`otJamDetectionStart ( otInstance aInstance, otJamDetectionCallback aCallback, void aContext)`	`otError` Inicie la detección de interferencias.
`otJamDetectionStop ( otInstance *aInstance)`	`otError` Detenga la detección de interferencias.

Typedefs

otJamDetectionCallback

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

Este puntero de función se llama si la detección de atasco de señal está habilitada y se detecta un atasco.

Detalles

Parámetros

`[in] aJamState`	Estado de atasco actual ( `true` si se detecta atasco, `false` caso contrario).
`[in] aContext`	Un puntero al contexto específico de la aplicación.

Funciones

otJamDetectionGetBusyPeriod

uint8_t otJamDetectionGetBusyPeriod(
  otInstance *aInstance
)

Obtenga el período ocupado de detección de atascos (en segundos)

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El período ocupado de detección de atascos.

otJamDetectionGetHistoryBitmap

uint64_t otJamDetectionGetHistoryBitmap(
  otInstance *aInstance
)

Obtenga el mapa de bits del historial actual.

Este valor proporciona información sobre el estado actual del módulo de detección de interferencias con fines de supervisión / depuración. Devuelve un valor de 64 bits donde cada bit corresponde a un intervalo de un segundo comenzando con el bit 0 para el intervalo más reciente y el bit 63 para los intervalos más antiguos (63 segundos antes). El bit se establece en 1 si el módulo de detección de interferencias observó / detectó un nivel de señal alto durante el intervalo de un segundo correspondiente.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El mapa de bits del historial actual.

otJamDetectionGetRssiThreshold

int8_t otJamDetectionGetRssiThreshold(
  otInstance *aInstance
)

Obtenga el umbral RSSI de detección de atascos (en dBm).

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El umbral RSSI de detección de atascos.

otJamDetectionGetState

bool otJamDetectionGetState(
  otInstance *aInstance
)

Obtenga el estado de detección de atascos.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El estado de detección de atasco (se detecta atasco true , "falso" en caso contrario).

otJamDetectionGetWindow

uint8_t otJamDetectionGetWindow(
  otInstance *aInstance
)

Obtenga la ventana de detección de atascos (en segundos).

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

La ventana de detección de atascos.

otJamDetectionIsEnabled

bool otJamDetectionIsEnabled(
  otInstance *aInstance
)

Obtener el estado de detección de atascos (habilitado / deshabilitado)

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Devoluciones

El estado de detección de atascos (verdadero si está habilitado, falso en caso contrario).

otJamDetectionSetBusyPeriod

otError otJamDetectionSetBusyPeriod(
  otInstance *aInstance,
  uint8_t aBusyPeriod
)

Configure el Período ocupado de detección de atascos (en segundos).

El número de segundos agregados dentro de la ventana de detección donde el RSSI debe estar por encima del umbral para activar la detección.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aBusyPeriod`	El período ocupado de la detección de atascos (debe ser distinto de cero y menor o igual que la ventana de detección de atascos)

Valores devueltos

`OT_ERROR_NONE`	Configurar correctamente la ventana.
`OT_ERROR_INVALID_ARGS`	La entrada dada no está dentro del rango válido.

otJamDetectionSetRssiThreshold

otError otJamDetectionSetRssiThreshold(
  otInstance *aInstance,
  int8_t aRssiThreshold
)

Establezca el umbral RSSI de detección de atascos (en dBm).

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aRssiThreshold`	El umbral RSSI.

Valores devueltos

OT_ERROR_NONE

Estableció correctamente el umbral.

otJamDetectionSetWindow

otError otJamDetectionSetWindow(
  otInstance *aInstance,
  uint8_t aWindow
)

Configure la ventana de detección de atascos (en segundos).

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aWindow`	La ventana de detección de atascos (el rango válido es de 1 a 63)

Valores devueltos

`OT_ERROR_NONE`	Configurar correctamente la ventana.
`OT_ERROR_INVALID_ARGS`	El parámetro de entrada dado no está dentro del rango válido (1-63)

otJamDetectionStart

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

Inicie la detección de interferencias.

Detalles

Parámetros

`[in] aInstance`	Un puntero a una instancia de OpenThread.
`[in] aCallback`	Un puntero a una función llamada para notificar el cambio de estado de interferencia.
`[in] aContext`	Un puntero al contexto específico de la aplicación.

Valores devueltos

`OT_ERROR_NONE`	Comenzó con éxito la detección de interferencias.
`OT_ERROR_ALREADY`	La detección de atascos se ha iniciado antes.

otJamDetectionStop

otError otJamDetectionStop(
  otInstance *aInstance
)

Detenga la detección de interferencias.

Detalles

Parámetros

[in] aInstance

Un puntero a una instancia de OpenThread.

Valores devueltos

`OT_ERROR_NONE`	Detuvo con éxito la detección de interferencias.
`OT_ERROR_ALREADY`	La detección de atascos ya está detenida.