Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

phy_t Struct Reference
Public Types | Public Member Functions | Friends

phy_t Struct Reference

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

#include <BLETypes.h>

Inherits 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.

Public Member Functions

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

Friends

bool operator== (phy_tlhs, phy_trhs)
 Equal to operator for Target instances.
bool operator!= (phy_tlhs, phy_trhs)
 Not equal to operator for Target instances.
bool operator< (phy_tlhs, phy_trhs)
 Less than operator for Target instances.
bool operator<= (phy_tlhs, phy_trhs)
 Less than or equal to operator for Target instances.
bool operator> (phy_tlhs, phy_trhs)
 Greater than operator for Target instances.
bool operator>= (phy_tlhs, phy_trhs)
 Greater than or equal to operator for Target instances.

Detailed Description

Type that describes a bluetooth PHY(sical) transport.

Definition at line 628 of file BLETypes.h.

Member Typedef Documentation

typedef uint8_t representation_t [inherited]

Type of the representation.

Definition at line 113 of file SafeEnum.h.

Member Enumeration Documentation

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 630 of file BLETypes.h.

Constructor & Destructor Documentation

phy_t ( type  value )

Construct a new instance of phy_t.

Definition at line 683 of file BLETypes.h.

Member Function Documentation

const uint8_t * storage (  ) const [inherited]

Return a pointer to the inner storage.

Definition at line 209 of file SafeEnum.h.

uint8_t value (  ) const [inherited]

Explicit access to the inner value of the SafeEnum instance.

Definition at line 202 of file SafeEnum.h.

Friends And Related Function Documentation

bool operator!= ( phy_t  lhs,
phy_t  rhs 
) [friend, inherited]

Not equal to operator for Target instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs and rhs are not equal and false otherwise.

Definition at line 144 of file SafeEnum.h.

bool operator< ( phy_t  lhs,
phy_t  rhs 
) [friend, inherited]

Less than operator for Target instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is less than rhs and false otherwise.

Definition at line 156 of file SafeEnum.h.

bool operator<= ( phy_t  lhs,
phy_t  rhs 
) [friend, inherited]

Less than or equal to operator for Target instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is less than or equal to rhs and false otherwise.

Definition at line 169 of file SafeEnum.h.

bool operator== ( phy_t  lhs,
phy_t  rhs 
) [friend, inherited]

Equal to operator for Target instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs and rhs are equal and false otherwise.

Definition at line 131 of file SafeEnum.h.

bool operator> ( phy_t  lhs,
phy_t  rhs 
) [friend, inherited]

Greater than operator for Target instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is greater than rhs; false otherwise.

Definition at line 182 of file SafeEnum.h.

bool operator>= ( phy_t  lhs,
phy_t  rhs 
) [friend, inherited]

Greater than or equal to operator for Target instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is greater than or equal to rhs; false otherwise.

Definition at line 195 of file SafeEnum.h.

Generated on Tue Jul 12 2022 13:55:39 by  doxygen 1.7.2