/ BLE_API

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:   Peripheral_1_serial_copy Peripheral_1_serial 151006_1st_Scenario_normal

Fork of BLE_API by Bluetooth Low Energy

Embed: (wiki syntax)

« Back to documentation index

GapAdvertisingParams Class Reference
Public Types | Public Member Functions | Static Public Attributes

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 }

Public Member Functions

uint16_t getInterval (void) const
uint16_t getIntervalInADVUnits (void) const

Static Public Attributes

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.

Definition at line 26 of file GapAdvertisingParams.h.

Member Enumeration Documentation

enum AdvertisingType_t

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 37 of file GapAdvertisingParams.h.

Member Function Documentation

uint16_t getInterval ( void   ) const
Returns:
the advertisement interval (in milliseconds)

Definition at line 95 of file GapAdvertisingParams.h.

uint16_t getIntervalInADVUnits ( void   ) const
Returns:
the advertisement interval in units advertisement duration units--i.e. 0.625ms units.

Definition at line 102 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 80 of file GapAdvertisingParams.h.

Generated on Mon Jul 18 2022 21:56:46 by  doxygen 1.7.2