NimBLE Host GAP Reference

Introduction

The Generic Access Profile (GAP) is responsible for all connecting, advertising, scanning, and connection updating operations.

Header

#include "host/ble_hs.h"

Definitions

BLE host GAP definitions

Functions

FunctionDescription
ble_gap_adv_activeIndicates whether an advertisement procedure is currently in progress.
ble_gap_adv_rsp_set_dataConfigures the data to include in subsequent scan responses.
ble_gap_adv_rsp_set_fieldsConfigures the fields to include in subsequent scan responses.
ble_gap_adv_set_dataConfigures the data to include in subsequent advertisements.
ble_gap_adv_set_fieldsConfigures the fields to include in subsequent advertisements.
ble_gap_adv_set_phys [experimental] Configures primary and secondary PHYs to use in subsequent extended advertisements from Bluetooth 5.
ble_gap_adv_set_tx_power [experimental] Configures Tx Power level to use in subsequent extended advertisements from Bluetooth 5.
ble_gap_adv_startInitiates advertising.
ble_gap_adv_stopStops the currently-active advertising procedure.
ble_gap_conn_activeIndicates whether a connect procedure is currently in progress.
ble_gap_conn_cancelAborts a connect procedure in progress.
ble_gap_conn_findSearches for a connection with the specified handle.
ble_gap_conn_rssiRetrieves the most-recently measured RSSI for the specified connection.
ble_gap_connectInitiates a connect procedure.
ble_gap_ext_connect [experimental] Same as above but using extended connect from Bluetooth 5.
ble_gap_discPerforms the Limited or General Discovery Procedures.
ble_gap_ext_disc [experimental] Same as above but using extended advertising from Bluetooth 5.
ble_gap_disc_activeIndicates whether a discovery procedure is currently in progress.
ble_gap_disc_cancelCancels the discovery procedure currently in progress.
ble_gap_security_initiateInitiates the GAP encryption procedure.
ble_gap_set_event_cbConfigures a connection to use the specified GAP event callback.
ble_gap_terminateTerminates an established connection.
ble_gap_update_paramsInitiates a connection parameter update procedure.
ble_gap_wl_setOverwrites the controller's white list with the specified contents.
ble_gap_set_priv_modeSet privacy mode for peer device.
ble_gap_read_le_phyRead PHY on the connections.
ble_gap_set_prefered_default_le_phySet default prefered PHY mode for new connections.
ble_gap_set_prefered_le_phySet prefered PHY mode for the connections.