Détection de bouchons

Ce module inclut des fonctions de détection du brouillage du signal.

Résumé

Les fonctions de ce module sont disponibles lorsque la fonctionnalité de détection des bourdonnements (OPENTHREAD_CONFIG_JAM_DETECTION_ENABLE) est activée.

Typedefs
otJamDetectionCallback)(bool aJamState, void *aContext) typedef
void(*
Le pointeur est appelé si la détection d'un bourrage de signal est activée et qu'un bourrage est détecté.

distantes
otJamDetectionGetBusyPeriod(otInstance *aInstance)
uint8_t
Obtenir la période d'indisponibilité de la détection des Jams (en secondes)
otJamDetectionGetHistoryBitmap(otInstance *aInstance)
uint64_t
Obtenir le bitmap d'historique actuel.
otJamDetectionGetRssiThreshold(otInstance *aInstance)
int8_t
Obtenez le seuil RSSI de la détection des Jams (en dBm).
otJamDetectionGetState(otInstance *aInstance)
bool
Permet d'obtenir l'état de détection des Jams.
otJamDetectionGetWindow(otInstance *aInstance)
uint8_t
Obtenir la fenêtre de détection des bouchons (en secondes).
otJamDetectionIsEnabled(otInstance *aInstance)
bool
Obtenir l'état de détection des Jams (activé/désactivé)
otJamDetectionSetBusyPeriod(otInstance *aInstance, uint8_t aBusyPeriod)
Définissez la période d'indisponibilité de la détection des Jams (en secondes).
otJamDetectionSetRssiThreshold(otInstance *aInstance, int8_t aRssiThreshold)
Définissez le seuil RSSI de la détection des Jams (en dBm).
otJamDetectionSetWindow(otInstance *aInstance, uint8_t aWindow)
Définissez la fenêtre de détection des bouchons (en secondes).
otJamDetectionStart(otInstance *aInstance, otJamDetectionCallback aCallback, void *aContext)
Lancez la détection du brouillage.
otJamDetectionStop(otInstance *aInstance)
Arrêtez la détection du brouillage.

Typedefs

otJamDetectionCallback

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

Le pointeur est appelé si la détection d'un bourrage de signal est activée et qu'un bourrage est détecté.

Détails
Paramètres
[in] aJamState
État actuel du Jam (true si un Jam est détecté, false dans le cas contraire)
[in] aContext
Pointeur vers un contexte spécifique à l'application.

distantes

otJamDetectionGetBusyPeriod

uint8_t otJamDetectionGetBusyPeriod(
  otInstance *aInstance
)

Obtenir la période d'indisponibilité de la détection des Jams (en secondes)

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Période chargée de détection des bouchons.

otJamDetectionGetHistoryBitmap

uint64_t otJamDetectionGetHistoryBitmap(
  otInstance *aInstance
)

Obtenir le bitmap d'historique actuel.

Cette valeur fournit des informations sur l'état actuel du module de détection du brouillage, à des fins de surveillance/débogage. Elle renvoie une valeur de 64 bits où chaque bit correspond à un intervalle d'une seconde, en commençant par le bit 0 pour l'intervalle le plus récent et le bit 63 pour les intervalles les plus anciens (63 secondes plus tôt). Le bit est défini sur 1 si le module de détection du brouillage a observé/détecté un niveau de signal élevé pendant l'intervalle d'une seconde correspondant.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Bitmap d'historique actuel.

otJamDetectionGetRssiThreshold

int8_t otJamDetectionGetRssiThreshold(
  otInstance *aInstance
)

Obtenez le seuil RSSI de la détection des Jams (en dBm).

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Seuil RSSI de la détection des Jams.

otJamDetectionGetState

bool otJamDetectionGetState(
  otInstance *aInstance
)

Permet d'obtenir l'état de détection des Jams.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
État de détection du Jam (true conflit détecté ou "false" dans le cas contraire).

otJamDetectionGetWindow

uint8_t otJamDetectionGetWindow(
  otInstance *aInstance
)

Obtenir la fenêtre de détection des bouchons (en secondes).

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
Fenêtre de détection des bourdonnements

otJamDetectionIsEnabled

bool otJamDetectionIsEnabled(
  otInstance *aInstance
)

Obtenir l'état de détection des Jams (activé/désactivé)

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Renvoie
État de détection du Jam ("true" si la détection est activée, "false" dans le cas contraire).

otJamDetectionSetBusyPeriod

otError otJamDetectionSetBusyPeriod(
  otInstance *aInstance,
  uint8_t aBusyPeriod
)

Définissez la période d'indisponibilité de la détection des Jams (en secondes).

Nombre de secondes agrégées dans la fenêtre de détection où le RSSI doit être supérieur au seuil pour déclencher la détection.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aBusyPeriod
Période occupée de détection des Jams (la valeur doit être différente de zéro et inférieure ou égale à la période de détection des Jams)
Valeurs de retour
OT_ERROR_NONE
La fenêtre a bien été définie.
OT_ERROR_INVALID_ARGS
L'entrée donnée n'est pas comprise dans la plage valide.

otJamDetectionSetRssiThreshold

otError otJamDetectionSetRssiThreshold(
  otInstance *aInstance,
  int8_t aRssiThreshold
)

Définissez le seuil RSSI de la détection des Jams (en dBm).

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aRssiThreshold
Seuil RSSI.
Valeurs de retour
OT_ERROR_NONE
Le seuil a bien été défini.

otJamDetectionSetWindow

otError otJamDetectionSetWindow(
  otInstance *aInstance,
  uint8_t aWindow
)

Définissez la fenêtre de détection des bouchons (en secondes).

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aWindow
Fenêtre de détection des Jams (plage valide comprise entre 1 et 63)
Valeurs de retour
OT_ERROR_NONE
La fenêtre a bien été définie.
OT_ERROR_INVALID_ARGS
Le paramètre d'entrée donné n'est pas compris dans une plage valide (1-63).

otJamDetectionStart

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

Lancez la détection du brouillage.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
[in] aCallback
Pointeur vers une fonction appelée pour signaler un changement d'état de brouillage.
[in] aContext
Pointeur vers un contexte spécifique à l'application.
Valeurs de retour
OT_ERROR_NONE
La détection du brouillage a bien été lancée.
OT_ERROR_ALREADY
La détection des brouillages a déjà été lancée.

otJamDetectionStop

otError otJamDetectionStop(
  otInstance *aInstance
)

Arrêtez la détection du brouillage.

Détails
Paramètres
[in] aInstance
Un pointeur vers une instance OpenThread.
Valeurs de retour
OT_ERROR_NONE
La détection du brouillage a bien été arrêtée.
OT_ERROR_ALREADY
La détection du jam est déjà arrêtée.

Ressources

Les sujets de référence de l'API OpenThread proviennent du code source, disponible sur GitHub. Pour en savoir plus ou pour contribuer à notre documentation, consultez la section Ressources.