mirror of
https://github.com/espressif/esp-idf.git
synced 2025-09-30 19:19:21 +00:00
aea18f6e74
Feature/btdm raw adv Add APIs to set raw advertising data and scan response data by user self. See merge request !451
116 lines
3.3 KiB
ReStructuredText
116 lines
3.3 KiB
ReStructuredText
GAP API
|
|
=======
|
|
|
|
Overview
|
|
--------
|
|
|
|
`Instructions`_
|
|
|
|
.. _Instructions: ../template.html
|
|
|
|
Application Example
|
|
-------------------
|
|
|
|
Check `/examples/bluetooth <https://github.com/espressif/esp-idf/tree/master/examples/bluetooth>`_ folder of `espressif/esp-idf <https://github.com/espressif/esp-idf>`_ repository, that contains the following examples:
|
|
|
|
`gatt_server <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/gatt_server>`_, `gatt_client <https://github.com/espressif/esp-idf/blob/master/examples/bluetooth/gatt_client>`_
|
|
|
|
The two demos use different gap api, such like advertising, scan, set device name and others.
|
|
|
|
API Reference
|
|
-------------
|
|
|
|
Header Files
|
|
^^^^^^^^^^^^
|
|
|
|
* `bt/bluedroid/api/include/esp_gap_ble_api.h <https://github.com/espressif/esp-idf/blob/master/components/bt/bluedroid/api/include/esp_gap_ble_api.h>`_
|
|
|
|
|
|
Macros
|
|
^^^^^^
|
|
|
|
.. doxygendefine:: ESP_BLE_ADV_FLAG_LIMIT_DISC
|
|
.. doxygendefine:: ESP_BLE_ADV_FLAG_GEN_DISC
|
|
.. doxygendefine:: ESP_BLE_ADV_FLAG_BREDR_NOT_SPT
|
|
.. doxygendefine:: ESP_BLE_ADV_FLAG_DMT_CONTROLLER_SPT
|
|
.. doxygendefine:: ESP_BLE_ADV_FLAG_DMT_HOST_SPT
|
|
.. doxygendefine:: ESP_BLE_ADV_FLAG_NON_LIMIT_DISC
|
|
.. doxygendefine:: ESP_BLE_ADV_DATA_LEN_MAX
|
|
.. doxygendefine:: ESP_BLE_SCAN_RSP_DATA_LEN_MAX
|
|
|
|
Type Definitions
|
|
^^^^^^^^^^^^^^^^
|
|
|
|
.. doxygentypedef:: esp_gap_ble_cb_t
|
|
|
|
Enumerations
|
|
^^^^^^^^^^^^
|
|
|
|
.. doxygenenum:: esp_gap_ble_cb_event_t
|
|
.. doxygenenum:: esp_ble_adv_data_type
|
|
.. doxygenenum:: esp_ble_adv_type_t
|
|
.. doxygenenum:: esp_ble_adv_channel_t
|
|
.. doxygenenum:: esp_ble_adv_filter_t
|
|
.. doxygenenum:: esp_ble_own_addr_src_t
|
|
.. doxygenenum:: esp_ble_scan_type_t
|
|
.. doxygenenum:: esp_ble_scan_filter_t
|
|
.. doxygenenum:: esp_gap_search_evt_t
|
|
.. doxygenenum:: esp_ble_evt_type_t
|
|
|
|
Structures
|
|
^^^^^^^^^^
|
|
|
|
.. doxygenstruct:: esp_ble_adv_params_t
|
|
:members:
|
|
|
|
.. doxygenstruct:: esp_ble_adv_data_t
|
|
:members:
|
|
|
|
.. doxygenstruct:: esp_ble_scan_params_t
|
|
:members:
|
|
|
|
.. doxygenstruct:: esp_ble_conn_update_params_t
|
|
:members:
|
|
|
|
.. doxygenstruct:: esp_ble_gap_cb_param_t
|
|
:members:
|
|
|
|
.. doxygenstruct:: esp_ble_gap_cb_param_t::ble_adv_data_cmpl_evt_param
|
|
:members:
|
|
|
|
.. doxygenstruct:: esp_ble_gap_cb_param_t::ble_scan_rsp_data_cmpl_evt_param
|
|
:members:
|
|
|
|
.. doxygenstruct:: esp_ble_gap_cb_param_t::ble_scan_param_cmpl_evt_param
|
|
:members:
|
|
|
|
.. doxygenstruct:: esp_ble_gap_cb_param_t::ble_scan_result_evt_param
|
|
:members:
|
|
|
|
.. doxygenstruct:: esp_ble_gap_cb_param_t::ble_adv_data_raw_cmpl_evt_param
|
|
:members:
|
|
|
|
.. doxygenstruct:: esp_ble_gap_cb_param_t::ble_scan_rsp_data_raw_cmpl_evt_param
|
|
:members:
|
|
|
|
|
|
Functions
|
|
^^^^^^^^^
|
|
|
|
.. doxygenfunction:: esp_ble_gap_register_callback
|
|
.. doxygenfunction:: esp_ble_gap_config_adv_data
|
|
.. doxygenfunction:: esp_ble_gap_set_scan_params
|
|
.. doxygenfunction:: esp_ble_gap_start_scanning
|
|
.. doxygenfunction:: esp_ble_gap_stop_scanning
|
|
.. doxygenfunction:: esp_ble_gap_start_advertising
|
|
.. doxygenfunction:: esp_ble_gap_stop_advertising
|
|
.. doxygenfunction:: esp_ble_gap_update_conn_params
|
|
.. doxygenfunction:: esp_ble_gap_set_pkt_data_len
|
|
.. doxygenfunction:: esp_ble_gap_set_rand_addr
|
|
.. doxygenfunction:: esp_ble_gap_config_local_privacy
|
|
.. doxygenfunction:: esp_ble_gap_set_device_name
|
|
.. doxygenfunction:: esp_ble_resolve_adv_data
|
|
.. doxygenfunction:: esp_ble_gap_config_adv_data_raw
|
|
.. doxygenfunction:: esp_ble_gap_config_scan_rsp_data_raw
|
|
|