PHY ED API

nRF5 SDK v15.0.0

Module to declare PHY Energy Detection API. More...

Data Structures

struct phy_plme_ed_mem_t
This structure holds static data of this module. More...
struct plme_ed_conf_t
PLME-ED.confirm parameters. More...

Enumerations

enum phy_plme_ed_state_t {
PHY_PLME_ED_STATE_IDLE ,
PHY_PLME_ED_STATE_BUSY
}
Describes the current state of the ED algorithm. More...

Functions

void plme_ed_req (void)
PLME-ED.request. More...
void plme_ed_conf ( plme_ed_conf_t *conf)
The PLME-ED.confirm callback function, implemented by the next higher layer. More...

Detailed Description

Module to declare PHY Energy Detection API.

The PHY ED module declares Energy Detection PHY routines and necessary types according to the PHY specification. More specifically, PHY ED request plme_ed_req() , PHY ED confirm plme_ed_conf() primitives are declared.

Enumeration Type Documentation

Describes the current state of the ED algorithm.

Enumerator
PHY_PLME_ED_STATE_IDLE

Algorithm is idle.

PHY_PLME_ED_STATE_BUSY

Currently performing ED.

Function Documentation

void plme_ed_conf ( plme_ed_conf_t * conf )

The PLME-ED.confirm callback function, implemented by the next higher layer.

The PLME-ED.confirm primitive is generated by the PLME and issued to its next higher layer in response to an PLME-ED.request primitive. In accordance with IEEE Std 802.15.4-2006, section 6.2.2.4.

Parameters
[out] conf Pointer to PLME-ED.confirm parameters
void plme_ed_req ( void )

PLME-ED.request.

Request ED measurement for the current channel. In accordance with IEEE Std 802.15.4-2006, section 6.2.2.3.