Mbed OS Reference
Loading...
Searching...
No Matches
phy_set_t Class Reference

Type that describe a set of PHY(sical) transports. More...

#include <BLETypes.h>

Public Member Functions

 phy_set_t ()
 Create set that indicates no preference. More...
 
 phy_set_t (uint8_t value)
 Create a set based on the mask specified in the Bluetooth spec. More...
 
 phy_set_t (bool phy_1m, bool phy_2m, bool phy_coded)
 Create a set based on individual settings. More...
 
 phy_set_t (phy_t phy)
 Create a set from a single phy. More...
 
void set_1m (bool enabled=true)
 Prefer 1M PHY. More...
 
void set_2m (bool enabled=true)
 Prefer 2M PHY. More...
 
void set_coded (bool enabled=true)
 Prefer coded PHY. More...
 

Detailed Description

Type that describe a set of PHY(sical) transports.

This is used to indicate preference for the PHY transports set within it.

Definition at line 704 of file common/BLETypes.h.

Constructor & Destructor Documentation

◆ phy_set_t() [1/4]

phy_set_t ( )

Create set that indicates no preference.

Definition at line 715 of file common/BLETypes.h.

◆ phy_set_t() [2/4]

phy_set_t ( uint8_t  value)

Create a set based on the mask specified in the Bluetooth spec.

Parameters
valueOctet containing the set of preferred PHYs

Definition at line 722 of file common/BLETypes.h.

◆ phy_set_t() [3/4]

phy_set_t ( bool  phy_1m,
bool  phy_2m,
bool  phy_coded 
)

Create a set based on individual settings.

Parameters
phy_1mPrefer LE 1M
phy_2mPrefer LE 2M if avaiable
phy_codedPrefer coded modulation if avaiable

Definition at line 731 of file common/BLETypes.h.

◆ phy_set_t() [4/4]

phy_set_t ( phy_t  phy)

Create a set from a single phy.

Parameters
phyThe phy to add to the set.

Definition at line 744 of file common/BLETypes.h.

Member Function Documentation

◆ set_1m()

void set_1m ( bool  enabled = true)

Prefer 1M PHY.

Definition at line 762 of file common/BLETypes.h.

◆ set_2m()

void set_2m ( bool  enabled = true)

Prefer 2M PHY.

Definition at line 771 of file common/BLETypes.h.

◆ set_coded()

void set_coded ( bool  enabled = true)

Prefer coded PHY.

Definition at line 780 of file common/BLETypes.h.