Detecção de jam

Este módulo inclui funções para o recurso de detecção de Jam.

Resumo

As funções deste módulo estão disponíveis quando o recurso de detecção de congestionamento (OPENTHREAD_CONFIG_JAM_DETECTION_ENABLE) está ativado.

Typedefs

otJamDetectionCallback)(bool aJamState, void *aContext) typedef
void(*
O ponteiro será chamado se a detecção de Jam estiver ativada e um Jam for detectado.

Funções

otJamDetectionGetBusyPeriod(otInstance *aInstance)
uint8_t
Obter o período de detecção de congestionamento (em segundos)
otJamDetectionGetHistoryBitmap(otInstance *aInstance)
uint64_t
Obtém o bitmap do histórico atual.
otJamDetectionGetRssiThreshold(otInstance *aInstance)
int8_t
Obtenha o limite de detecção de Jam do RSSI (em dBm).
otJamDetectionGetState(otInstance *aInstance)
bool
Acessar o estado de detecção de Jam.
otJamDetectionGetWindow(otInstance *aInstance)
uint8_t
Obtém a janela de detecção de Jam (em segundos).
otJamDetectionIsEnabled(otInstance *aInstance)
bool
Obter o status de detecção de Jam (ativado/desativado)
otJamDetectionSetBusyPeriod(otInstance *aInstance, uint8_t aBusyPeriod)
Defina o Período de detecção de congestionamento (em segundos).
otJamDetectionSetRssiThreshold(otInstance *aInstance, int8_t aRssiThreshold)
Defina o limite de RSSI de detecção de Jam (em dBm).
otJamDetectionSetWindow(otInstance *aInstance, uint8_t aWindow)
Define a janela de detecção de Jam (em segundos).
otJamDetectionStart(otInstance *aInstance, otJamDetectionCallback aCallback, void *aContext)
Inicie a detecção de Jam.
otJamDetectionStop(otInstance *aInstance)
Parar a detecção de Jam

Typedefs

OtJamDetectionCallback

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

O ponteiro será chamado se a detecção de Jam estiver ativada e um Jam for detectado.

Detalhes
Parâmetros
[in] aJamState
Estado atual do Jam (true se o Jam for detectado, false se não).
[in] aContext
Um ponteiro para contexto específico do aplicativo.

Funções

Período do JaneDetection GetBusyPeriod

uint8_t otJamDetectionGetBusyPeriod(
  otInstance *aInstance
)

Obter o período de detecção de congestionamento (em segundos)

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O período de detecção de congestionamentos.

OtJamDetectionGetHistoryBitmap

uint64_t otJamDetectionGetHistoryBitmap(
  otInstance *aInstance
)

Obtém o bitmap do histórico atual.

Este valor fornece informações sobre o estado atual do módulo de detecção de Jam para fins de monitoramento/depuração. Ele retorna um valor de 64 bits no qual cada bit corresponde a um intervalo de um segundo começando com o bit 0 para o intervalo mais recente e o bit 63 para os intervalos mais antigos (63 segundos antes). O bit é definido como 1 se o módulo de detecção de Jam observa/detecta um alto nível de sinal durante o intervalo de um segundo correspondente.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O bitmap do histórico atual.

otJamDetectionGetRssiThreshold

int8_t otJamDetectionGetRssiThreshold(
  otInstance *aInstance
)

Obtenha o limite de detecção de Jam do RSSI (em dBm).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O limite de RSSI de detecção de Jam.

OtJamDetectionGetState

bool otJamDetectionGetState(
  otInstance *aInstance
)

Acessar o estado de detecção de Jam.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O estado de detecção de Jam (true é detectado, caso contrário, "false").

Detecção de janelas de detecção

uint8_t otJamDetectionGetWindow(
  otInstance *aInstance
)

Obtém a janela de detecção de Jam (em segundos).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
A janela de detecção do Jam.

OJJDetectionAtivado

bool otJamDetectionIsEnabled(
  otInstance *aInstance
)

Obter o status de detecção de Jam (ativado/desativado)

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Retorna
O status da detecção de Jam (verdadeiro se ativado, caso contrário será falso).

OJJDetectionSetBusyPeriod

otError otJamDetectionSetBusyPeriod(
  otInstance *aInstance,
  uint8_t aBusyPeriod
)

Defina o Período de detecção de congestionamento (em segundos).

O número de segundos agregados na janela de detecção em que a RSSI precisa estar acima do limite para acionar a detecção.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aBusyPeriod
O período de detecção de congestionamento (deve ser diferente de zero e menor ou igual à janela de detecção de jam)
Valores de retorno
OT_ERROR_NONE
A janela foi definida.
OT_ERROR_INVALID_ARGS
A entrada fornecida não está dentro do intervalo válido.

oJJDetectionSetRssiThreshold

otError otJamDetectionSetRssiThreshold(
  otInstance *aInstance,
  int8_t aRssiThreshold
)

Defina o limite de RSSI de detecção de Jam (em dBm).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aRssiThreshold
O limite de RSSI.
Valores de retorno
OT_ERROR_NONE
O limite foi definido.

Janela de detecção de janelas

otError otJamDetectionSetWindow(
  otInstance *aInstance,
  uint8_t aWindow
)

Define a janela de detecção de Jam (em segundos).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aWindow
A janela de detecção de Jam (o intervalo válido é de 1 a 63)
Valores de retorno
OT_ERROR_NONE
A janela foi definida.
OT_ERROR_INVALID_ARGS
O parâmetro de entrada fornecido não está dentro do intervalo válido (1-63)

Comece a detectar

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

Inicie a detecção de Jam.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aCallback
Um ponteiro para uma função chamada para notificar a alteração do estado de Jam.
[in] aContext
Um ponteiro para contexto específico do aplicativo.
Valores de retorno
OT_ERROR_NONE
A detecção de Jam foi iniciada.
OT_ERROR_ALREADY
A detecção do Jam já foi iniciada.

Interrupção de detecção de otjam

otError otJamDetectionStop(
  otInstance *aInstance
)

Parar a detecção de Jam

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_ERROR_NONE
A detecção de Jam foi interrompida.
OT_ERROR_ALREADY
A detecção do Jam já foi interrompida.

Recursos

Os tópicos de referência da API OpenThread são originados do código-fonte, disponível no GitHub. Para mais informações ou para contribuir com nossa documentação, consulte Recursos.