0.01.00
jam_detection.h File Reference

This file includes the OpenThread API for jam detection feature. More...

#include <openthread/types.h>

Go to the source code of this file.

Typedefs

typedef void(* otJamDetectionCallback) (bool aJamState, void *aContext)
 This function pointer is called if signal jam detection is enabled and a jam is detected. More...
 

Functions

otError otJamDetectionSetRssiThreshold (otInstance *aInstance, int8_t aRssiThreshold)
 Set the Jam Detection RSSI Threshold (in dBm). More...
 
int8_t otJamDetectionGetRssiThreshold (otInstance *aInstance)
 Get the Jam Detection RSSI Threshold (in dBm). More...
 
otError otJamDetectionSetWindow (otInstance *aInstance, uint8_t aWindow)
 Set the Jam Detection Detection Window (in seconds). More...
 
uint8_t otJamDetectionGetWindow (otInstance *aInstance)
 Get the Jam Detection Detection Window (in seconds). More...
 
otError otJamDetectionSetBusyPeriod (otInstance *aInstance, uint8_t aBusyPeriod)
 Set the Jam Detection Busy Period (in seconds). More...
 
uint8_t otJamDetectionGetBusyPeriod (otInstance *aInstance)
 Get the Jam Detection Busy Period (in seconds) More...
 
otError otJamDetectionStart (otInstance *aInstance, otJamDetectionCallback aCallback, void *aContext)
 Start the jamming detection. More...
 
otError otJamDetectionStop (otInstance *aInstance)
 Stop the jamming detection. More...
 
bool otJamDetectionIsEnabled (otInstance *aInstance)
 Get the Jam Detection Status (enabled/disabled) More...
 
bool otJamDetectionGetState (otInstance *aInstance)
 Get the Jam Detection State. More...
 
uint64_t otJamDetectionGetHistoryBitmap (otInstance *aInstance)
 Get the current history bitmap. More...
 

Detailed Description

This file includes the OpenThread API for jam detection feature.