nRF5 SDK v17.1.0
Data Structures | Typedefs | Enumerations | Functions
MAC MLME Scan API

Module to declare MAC MLME Scan API. More...

Data Structures

struct  mlme_scan_conf_t
 MLME-SCAN.confirm. More...
 
struct  mlme_scan_req_t
 MLME-SCAN.request. More...
 

Typedefs

typedef void(* mlme_scan_conf_cb_t )(mlme_scan_conf_t *)
 User callback to scan request. More...
 

Enumerations

enum  mac_scan_type_t {
  ED_SCAN = 0,
  ACTIVE_SCAN,
  PASSIVE_SCAN,
  ORPHAN_SCAN
}
 Type of scan. More...
 

Functions

void mlme_scan_req (mlme_scan_req_t *req, mlme_scan_conf_cb_t conf_cb)
 MLME-SCAN request. More...
 

Detailed Description

Module to declare MAC MLME Scan API.

The MAC Scan module declares MLME Scan primitives and necessary types according to the MAC specification. More specifically, MLME Scan request aka mlme_scan_req(), and MLME Scan confirm callback typedef aka mlme_scan_conf_cb_t primitives are declared.

Typedef Documentation

typedef void(* mlme_scan_conf_cb_t)(mlme_scan_conf_t *)

User callback to scan request.

The MLME-SCAN.confirm primitive is generated by the MLME and issued to its next higher layer when the channel scan initiated with the MLME-SCAN.request primitive has completed.

In accordance with IEEE Std 802.15.4-2006, section 7.1.11.2

Enumeration Type Documentation

Type of scan.

Enumerator
ED_SCAN 

Energy detection scan.

ACTIVE_SCAN 

Active scan.

PASSIVE_SCAN 

Passive scan.

ORPHAN_SCAN 

Orphan scan.

Function Documentation

void mlme_scan_req ( mlme_scan_req_t req,
mlme_scan_conf_cb_t  conf_cb 
)

MLME-SCAN request.

The MLME-SCAN.request primitive is generated by the next higher layer and issued to its MLME to initiate a channel scan to search for activity within the POS of the device. This primitive can be used to perform an ED scan to determine channel usage, an active or passive scan to locate beacon frames containing any PAN identifier, or an orphan scan to locate a PAN to which the device is currently associated.

Parameters
[in]reqMLME-SCAN request structure.
[in]conf_cbpointer to user callback.

In accordance with IEEE Std 802.15.4-2006, section 7.1.11.1


Documentation feedback | Developer Zone | Subscribe | Updated