Mbed OS Reference
Loading...
Searching...
No Matches
phy_t Struct Reference

Type that describes a bluetooth PHY(sical) transport. More...

#include <BLETypes.h>

Inheritance diagram for phy_t:
SafeEnum< phy_t, uint8_t >

Public Types

enum  type { NONE = 0 , LE_1M = 1 , LE_2M = 2 , LE_CODED }
 struct scoped enum wrapped by the class More...
 
typedef uint8_t representation_t
 Type of the representation. More...
 

Public Member Functions

 phy_t (type value)
 Construct a new instance of phy_t. More...
 
uint8_t value () const
 Explicit access to the inner value of the SafeEnum instance. More...
 
const uint8_t * storage () const
 Return a pointer to the inner storage. More...
 

Detailed Description

Type that describes a bluetooth PHY(sical) transport.

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

Member Typedef Documentation

◆ representation_t

typedef uint8_t representation_t
inherited

Type of the representation.

Definition at line 115 of file common/SafeEnum.h.

Member Enumeration Documentation

◆ type

enum type

struct scoped enum wrapped by the class

Enumerator
NONE 

No phy selected.

Note
This value can be used to indicate the absence of phy
LE_1M 

1Mbit/s LE.

Note
This physical transport was available since Bluetooth 4.0
LE_2M 

2Mbit/s LE.

Modulation is similar to LE_1M but differs in rate. Therefore range performances are in the same ballpark as LE_1M while the increased rate minimize time spent to transfer or receive a packet which leads to a better power consumption and/or faster transfer.

Note
This transport has been introduced with the Bluetooth 5.
When operating at 2Mbit/s range is not exactly identical to the range at 1Mbit/s due to a loss in sensitivity.
LE_CODED 

LE Coded PHY.

This transport reuse the 1Mbit/s channel with different coding schemes. Either two (S=2) or eight (S=8) symbols can be used to represent a bit while the 1Mbit/s transport use 1 symbol to code 1 bit of data.

Here is the data rate of the two coding schemes:

  • S=2: 500kbit/s
  • S=8: 125kbit/s

The goal of the coded PHY is to increase the range of BLE devices. Of course given it takes more time to transfer data, transmission and reception last longer which leads to an increase in power consumption.

Note
This transport has been introduced with the Bluetooth 5.

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

Constructor & Destructor Documentation

◆ phy_t()

phy_t ( type  value)

Construct a new instance of phy_t.

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

Member Function Documentation

◆ value()

uint8_t value ( ) const
inherited

Explicit access to the inner value of the SafeEnum instance.

Definition at line 204 of file common/SafeEnum.h.

◆ storage()

const uint8_t * storage ( ) const
inherited

Return a pointer to the inner storage.

Definition at line 211 of file common/SafeEnum.h.