Stauerkennung

Dieses Modul enthält Funktionen zur Erkennung von Signalstörungen.

Zusammenfassung

Die Funktionen in diesem Modul sind verfügbar, wenn die Stauerkennung (OPENTHREAD_CONFIG_JAM_DETECTION_ENABLE) aktiviert ist.

Typedefs
otJamDetectionCallback)(bool aJamState, void *aContext) typedef
void(*
Pointer wird aufgerufen, wenn die Signalstauerkennung aktiviert ist und ein Stau erkannt wird.

Funktionen
otJamDetectionGetBusyPeriod(otInstance *aInstance)
uint8_t
Jam-Erkennung als „Beschäftigt“ nutzen (in Sekunden)
otJamDetectionGetHistoryBitmap(otInstance *aInstance)
uint64_t
Aktuelle Bitmap des Verlaufs abrufen
otJamDetectionGetRssiThreshold(otInstance *aInstance)
int8_t
RSSI-Grenzwert für die Jam-Erkennung (in dBm) abrufen
otJamDetectionGetState(otInstance *aInstance)
bool
Jam-Erkennungsstatus abrufen.
otJamDetectionGetWindow(otInstance *aInstance)
uint8_t
Rufen Sie das Fenster mit der Jam-Erkennung in Sekunden auf.
otJamDetectionIsEnabled(otInstance *aInstance)
bool
Jam-Erkennungsstatus abrufen (aktiviert/deaktiviert)
otJamDetectionSetBusyPeriod(otInstance *aInstance, uint8_t aBusyPeriod)
Legen Sie den Zeitraum für die Jam-Erkennung in Sekunden fest.
otJamDetectionSetRssiThreshold(otInstance *aInstance, int8_t aRssiThreshold)
Legen Sie den RSSI-Schwellenwert für die Jam-Erkennung (in dBm) fest.
otJamDetectionSetWindow(otInstance *aInstance, uint8_t aWindow)
Legen Sie das Fenster zur Erkennung von Störungen in Sekunden fest.
otJamDetectionStart(otInstance *aInstance, otJamDetectionCallback aCallback, void *aContext)
Starten Sie die Stauerkennung.
otJamDetectionStop(otInstance *aInstance)
Störungserkennung beenden.

Typedefs

otJamDetectionCallback

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

Pointer wird aufgerufen, wenn die Signalstauerkennung aktiviert ist und ein Stau erkannt wird.

Details
Parameter
[in] aJamState
Aktueller Jam-Status (true, wenn ein Stau erkannt wird, andernfalls false).
[in] aContext
Ein Zeiger auf einen anwendungsspezifischen Kontext.

Funktionen

otJamDetectionGetBusyPeriod

uint8_t otJamDetectionGetBusyPeriod(
  otInstance *aInstance
)

Jam-Erkennung als „Beschäftigt“ nutzen (in Sekunden)

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Die Jam-Erkennung im „Beschäftigt-Modus“.

otJamDetectionGetHistoryBitmap

uint64_t otJamDetectionGetHistoryBitmap(
  otInstance *aInstance
)

Aktuelle Bitmap des Verlaufs abrufen

Dieser Wert enthält Informationen zum aktuellen Status des Blockiererkennungsmoduls zu Monitoring-/Fehlerbehebungszwecken. Es gibt einen 64-Bit-Wert zurück, bei dem jedes Bit einem Sekundenintervall entspricht, beginnend mit Bit 0 für das jüngste Intervall und Bit 63 für die ältesten Intervalle (63 Sekunden früher). Das Bit ist auf 1 gesetzt, wenn das Störerkennungsmodul während des entsprechenden Intervalls von einer Sekunde ein hohes Signal festgestellt hat.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Die aktuelle Bitmap des Verlaufs

otJamDetectionGetRssiThreshold

int8_t otJamDetectionGetRssiThreshold(
  otInstance *aInstance
)

RSSI-Grenzwert für die Jam-Erkennung (in dBm) abrufen

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
RSSI-Grenzwert für die Jam-Erkennung.

otJamDetectionGetState

bool otJamDetectionGetState(
  otInstance *aInstance
)

Jam-Erkennungsstatus abrufen.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Status der Jam-Erkennung (true Jam wurde erkannt, andernfalls „false“).

otJamDetectionGetWindow

uint8_t otJamDetectionGetWindow(
  otInstance *aInstance
)

Rufen Sie das Fenster mit der Jam-Erkennung in Sekunden auf.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Das Fenster zur Jam-Erkennung.

otJamDetectionIsEnabled

bool otJamDetectionIsEnabled(
  otInstance *aInstance
)

Jam-Erkennungsstatus abrufen (aktiviert/deaktiviert)

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabe
Der Status der Jam-Erkennung (wahr, wenn aktiviert, andernfalls falsch).

otJamDetectionSetBusyPeriod

otError otJamDetectionSetBusyPeriod(
  otInstance *aInstance,
  uint8_t aBusyPeriod
)

Legen Sie den Zeitraum für die Jam-Erkennung in Sekunden fest.

Die Gesamtzahl der Sekunden innerhalb des Erkennungsfensters, in denen der RSSI über dem Grenzwert liegen muss, um die Erkennung auszulösen.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aBusyPeriod
Der Zugriffszeitraum für die Jam-Erkennung (muss ungleich null und kleiner oder gleich dem Jam-Erkennungsfenster sein)
Rückgabewerte
OT_ERROR_NONE
Das Fenster wurde festgelegt.
OT_ERROR_INVALID_ARGS
Die angegebene Eingabe liegt nicht im gültigen Bereich.

otJamDetectionSetRssiThreshold

otError otJamDetectionSetRssiThreshold(
  otInstance *aInstance,
  int8_t aRssiThreshold
)

Legen Sie den RSSI-Schwellenwert für die Jam-Erkennung (in dBm) fest.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aRssiThreshold
Der RSSI-Grenzwert.
Rückgabewerte
OT_ERROR_NONE
Grenzwert wurde festgelegt.

otJamDetectionSetWindow

otError otJamDetectionSetWindow(
  otInstance *aInstance,
  uint8_t aWindow
)

Legen Sie das Fenster zur Erkennung von Störungen in Sekunden fest.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aWindow
Fenster zur Jam-Erkennung (gültiger Bereich: 1 bis 63)
Rückgabewerte
OT_ERROR_NONE
Das Fenster wurde festgelegt.
OT_ERROR_INVALID_ARGS
Der angegebene Eingabeparameter liegt nicht im gültigen Bereich (1–63)

otJamDetectionStart

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

Starten Sie die Stauerkennung.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
[in] aCallback
Ein Zeiger auf eine Funktion, die aufgerufen wird, um über eine Störungszustandsänderung zu informieren.
[in] aContext
Ein Zeiger auf einen anwendungsspezifischen Kontext.
Rückgabewerte
OT_ERROR_NONE
Die Stauerkennung wurde gestartet.
OT_ERROR_ALREADY
Die Jam-Erkennung wurde bereits gestartet.

otJamDetectionStop

otError otJamDetectionStop(
  otInstance *aInstance
)

Störungserkennung beenden.

Details
Parameter
[in] aInstance
Ein Zeiger auf eine OpenThread-Instanz.
Rückgabewerte
OT_ERROR_NONE
Die Störungserkennung wurde beendet.
OT_ERROR_ALREADY
Die Jam-Erkennung wurde bereits beendet.

Ressourcen

OpenThread API-Referenzthemen stammen aus dem Quellcode, der auf GitHub verfügbar ist. Weitere Informationen finden Sie unter Ressourcen. Dort können Sie auch einen Beitrag zu unserer Dokumentation leisten.