Détection de Jams

Ce module propose des fonctions de détection du brouillement du signal.

Résumé

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

Définitions

otJamDetectionCallback)(bool aJamState, void *aContext) CANNOT TRANSLATE
void(*
Ce pointeur de fonction est appelé si la détection d'embouteillage est activée et qu'un Jam est détecté.

Functions

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

Définitions

otJamDetectionRappel

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

Ce pointeur de fonction est appelé si la détection d'embouteillage est activée et qu'un Jam est détecté.

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

Functions

otJamDetectionGetBusyPeriod

uint8_t otJamDetectionGetBusyPeriod(
  otInstance *aInstance
)

Obtenez la période d'occupation détectée (en secondes)

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
La période de détection de l'affluence dans un Jam.

otJamDetectionGetHistoryBitmap

uint64_t otJamDetectionGetHistoryBitmap(
  otInstance *aInstance
)

Obtenez le bitmap actuel de l'historique.

Cette valeur fournit des informations sur l'état actuel du module de détection du brouillage à des fins de surveillance/débogage. Il renvoie une valeur de 64 bits, où chaque bit correspond à un intervalle d'une seconde 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é un niveau élevé de signal pendant la première seconde correspondante.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
bitmap de l'historique actuel.

otJamDetectionGetRssiThreshold

int8_t otJamDetectionGetRssiThreshold(
  otInstance *aInstance
)

Obtenez le seuil RSSI de détection du Jam (en DHCP).

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Seuil RSSI de détection de Jam.

otJamDetectionGetState

bool otJamDetectionGetState(
  otInstance *aInstance
)

Obtenez l'état de détection du Jam.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
État de la détection de Jam (true Jam détecté, "false" ou "non", autrement).

otJamDetectionGetWindow

uint8_t otJamDetectionGetWindow(
  otInstance *aInstance
)

Obtenez la fenêtre de détection de la détection de Jams (en secondes).

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
Fenêtre de détection de Jams.

otJamDetectionIsEnabled

bool otJamDetectionIsEnabled(
  otInstance *aInstance
)

Obtenir l'état de détection du Jam (activé/désactivé)

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
Renvoie
État de la détection de Jam (True, si activé), "False" dans le cas contraire).

otJamDetectionSetBusyPeriod

otError otJamDetectionSetBusyPeriod(
  otInstance *aInstance,
  uint8_t aBusyPeriod
)

Permet de définir la période d'occupation de la détection du Jam (en secondes).

Nombre de secondes cumulées dans la fenêtre de détection où la valeur RSSI doit être supérieure au seuil pour déclencher la détection.

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aBusyPeriod
Période de détection du Jam indisponible (elle doit être différente de zéro et inférieure ou égale à la période de détection du Jam)
Valeurs renvoyées
OT_ERROR_NONE
La fenêtre a bien été définie.
OT_ERROR_INVALID_ARGS
L'entrée donnée ne se situe pas dans la plage valide.

otJamDetectionSetRssiThreshold

otError otJamDetectionSetRssiThreshold(
  otInstance *aInstance,
  int8_t aRssiThreshold
)

Définissez le seuil RSSI de détection du Jam (en DHCP).

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aRssiThreshold
Seuil RSSI.
Valeurs renvoyées
OT_ERROR_NONE
Le seuil a bien été défini.

otJamDétecterionSetWindow

otError otJamDetectionSetWindow(
  otInstance *aInstance,
  uint8_t aWindow
)

Définissez la fenêtre de détection du Jam (en secondes).

Détails
Paramètres
[in] aInstance
Pointeur vers une instance OpenThread.
[in] aWindow
Fenêtre de détection du Jam (la plage valide est comprise entre 1 et 63)
Valeurs renvoyées
OT_ERROR_NONE
La fenêtre a bien été définie.
OT_ERROR_INVALID_ARGS
Le paramètre d'entrée indiqué n'est pas compris dans la plage valide (1 à 63)

otJamDetectionDémarrer

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

Lancez la détection du brouillard.

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

otJamDetectionStop

otError otJamDetectionStop(
  otInstance *aInstance
)

Arrêtez la détection de brouillard.

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

Resources

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