my version with changed conversion between duration units

Fork of BLE_API by Bluetooth Low Energy

Embed: (wiki syntax)

« Back to documentation index

GapAdvertisingParams Class Reference

GapAdvertisingParams Class Reference

This class provides a wrapper for the core advertising parameters, including the advertising type (Connectable Undirected, Non Connectable Undirected, etc.), as well as the advertising and timeout intervals. More...

#include <GapAdvertisingParams.h>

Public Types

enum  AdvertisingType_t { ADV_CONNECTABLE_UNDIRECTED, ADV_CONNECTABLE_DIRECTED, ADV_SCANNABLE_UNDIRECTED, ADV_NON_CONNECTABLE_UNDIRECTED }

Static Public Attributes

static const uint16_t UNIT_1_25_MS = 1250
 Number of microseconds in 1.25 milliseconds.
static const uint16_t UNIT_0_625_MS = 625
 Number of microseconds in 0.625 milliseconds.

Detailed Description

This class provides a wrapper for the core advertising parameters, including the advertising type (Connectable Undirected, Non Connectable Undirected, etc.), as well as the advertising and timeout intervals.

See the following for more information on advertising types:
  • Bluetooth Core Specification 4.0 (Vol. 6), Part B, Section 2.3.1
  • Bluetooth Core Specification 4.0 (Vol. 3), Part C, Section 9.3

Definition at line 36 of file GapAdvertisingParams.h.


Member Enumeration Documentation

Encapsulates the peripheral advertising modes, which determine how the device appears to other central devices in hearing range

Enumerator:
ADV_CONNECTABLE_UNDIRECTED 

Vol 3, Part C, Section 9.3.4 and Vol 6, Part B, Section 2.3.1.1.

ADV_CONNECTABLE_DIRECTED 

Vol 3, Part C, Section 9.3.3 and Vol 6, Part B, Section 2.3.1.2.

ADV_SCANNABLE_UNDIRECTED 

Include support for Scan Response payloads, see Vol 6, Part B, Section 2.3.1.4.

ADV_NON_CONNECTABLE_UNDIRECTED 

Vol 3, Part C, Section 9.3.2 and Vol 6, Part B, Section 2.3.1.3.

Definition at line 47 of file GapAdvertisingParams.h.


Field Documentation

const uint16_t UNIT_0_625_MS = 625 [static]

Number of microseconds in 0.625 milliseconds.

Definition at line 91 of file GapAdvertisingParams.h.

const uint16_t UNIT_1_25_MS = 1250 [static]

Number of microseconds in 1.25 milliseconds.

Definition at line 90 of file GapAdvertisingParams.h.