Detecção de congestionamento

Este módulo inclui funções para o recurso de detecção de interferência de sinal.

Resumo

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

Typedefs

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

remotas

otJamDetectionGetBusyPeriod(otInstance *aInstance)
uint8_t
Descubra o período de atividade da detecção de jams (em segundos)
otJamDetectionGetHistoryBitmap(otInstance *aInstance)
uint64_t
Acessa o bitmap atual do histórico.
otJamDetectionGetRssiThreshold(otInstance *aInstance)
int8_t
Receba o limite de RSSI da detecção de jam (em dBm).
otJamDetectionGetState(otInstance *aInstance)
bool
Recebe o estado de detecção de Jam.
otJamDetectionGetWindow(otInstance *aInstance)
uint8_t
Acesse a janela de detecção de jam (em segundos).
otJamDetectionIsEnabled(otInstance *aInstance)
bool
Acessar o status da detecção de Jam (ativado/desativado)
otJamDetectionSetBusyPeriod(otInstance *aInstance, uint8_t aBusyPeriod)
Defina o período de ocupação da detecção de jams (em segundos).
otJamDetectionSetRssiThreshold(otInstance *aInstance, int8_t aRssiThreshold)
Defina o limite de RSSI da detecção de Jam (em dBm).
otJamDetectionSetWindow(otInstance *aInstance, uint8_t aWindow)
Defina a janela de detecção de jam (em segundos).
otJamDetectionStart(otInstance *aInstance, otJamDetectionCallback aCallback, void *aContext)
Inicie a detecção de obstruções.
otJamDetectionStop(otInstance *aInstance)
Interrompa a detecção de interferências.

Typedefs

otJamDetectionCallback

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

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

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

remotas

otJamDetectionGetBusyPeriod

uint8_t otJamDetectionGetBusyPeriod(
  otInstance *aInstance
)

Descubra o período de atividade da detecção de jams (em segundos)

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

otJamDetectionGetHistoryBitmap

uint64_t otJamDetectionGetHistoryBitmap(
  otInstance *aInstance
)

Acessa o bitmap atual do histórico.

Esse valor fornece informações sobre o estado atual do módulo de detecção de interferências para fins de monitoramento/depuração. Ele retorna um valor de 64 bits em que 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 anteriores). O bit é definido como 1 se o módulo de detecção de interferências observou/detectou um nível de sinal alto 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
)

Receba o limite de RSSI da detecção de jam (em dBm).

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

otJamDetectionGetState

bool otJamDetectionGetState(
  otInstance *aInstance
)

Recebe 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 foi detectado, caso contrário, como "false").

otJamDetectionGetWindow

uint8_t otJamDetectionGetWindow(
  otInstance *aInstance
)

Acesse a janela de detecção de jam (em segundos).

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

otJamDetectionIsEnabled

bool otJamDetectionIsEnabled(
  otInstance *aInstance
)

Acessar o status da 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, falso).

otJamDetectionSetBusyPeriod

otError otJamDetectionSetBusyPeriod(
  otInstance *aInstance,
  uint8_t aBusyPeriod
)

Defina o período de ocupação da detecção de jams (em segundos).

O número de segundos agregados dentro da janela de detecção em que o 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 ocupado da detecção de jams (deve ser diferente de zero e menor ou igual à janela de detecção de jams)
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.

otJamDetectionSetRssiThreshold

otError otJamDetectionSetRssiThreshold(
  otInstance *aInstance,
  int8_t aRssiThreshold
)

Defina o limite de RSSI da 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.

otJamDetectionSetWindow

otError otJamDetectionSetWindow(
  otInstance *aInstance,
  uint8_t aWindow
)

Defina a janela de detecção de jam (em segundos).

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
[in] aWindow
Janela de detecção de Jams (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 a 63)

otJamDetectionStart

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

Inicie a detecção de obstruções.

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

otJamDetectionStop

otError otJamDetectionStop(
  otInstance *aInstance
)

Interrompa a detecção de interferências.

Detalhes
Parâmetros
[in] aInstance
Um ponteiro para uma instância do OpenThread.
Valores de retorno
OT_ERROR_NONE
A detecção de interferência foi interrompida.
OT_ERROR_ALREADY
A detecção de Jams 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.