esp-idf/docs/en/api-reference/bluetooth/esp_gap_ble.rst

GAP API
=======

:link_to_translation:`zh_CN:[中文]`

Application Example
-------------------

Check the :example:`bluetooth/bluedroid/ble` folder in ESP-IDF examples, which contains the following demos and their tutorials:

* The following shows an SMP security client demo with its tutorial. This demo initiates its security parameters and acts as a GATT client, which can send a security request to the peer device and then complete the encryption procedure.

    - :example:`bluetooth/bluedroid/ble/gatt_security_client`
    - :example_file:`GATT Security Client Example Walkthrough <bluetooth/bluedroid/ble/gatt_security_client/tutorial/Gatt_Security_Client_Example_Walkthrough.md>`

* The following shows an SMP security server demo with its tutorial. This demo initiates its security parameters and acts as a GATT server, which can send a pair request to the peer device and then complete the encryption procedure.

    - :example:`bluetooth/bluedroid/ble/gatt_security_server`
    - :example_file:`GATT Security Server Example Walkthrough <bluetooth/bluedroid/ble/gatt_security_server/tutorial/Gatt_Security_Server_Example_Walkthrough.md>`

API Reference
-------------

.. include-build-file:: inc/esp_gap_ble_api.inc
component/bt : doxygen can generate html correctly 2016-12-01 07:20:22 -05:00			`GAP API`
Updated links to point directly to example folder, fixed names 2017-01-17 14:03:26 -05:00			`=======`
docs: update format issues for EN and CN files under api-reference/bluetooth folder 2023-07-12 04:48:16 -04:00
Docs/add Chinese translation for api-reference/bluetooth/esp_gap_ble.rst, api-reference/protocols/modbus.rst, and libraries-and-frameworks/libs-frameworks.rst from scratch 2023-05-04 05:25:41 -04:00			:link_to_translation:`zh_CN:[中文]`
component/bt : doxygen can generate html correctly 2016-12-01 07:20:22 -05:00
			`Application Example`
			`-------------------`

Docs/add Chinese translation for api-reference/bluetooth/esp_gap_ble.rst, api-reference/protocols/modbus.rst, and libraries-and-frameworks/libs-frameworks.rst from scratch 2023-05-04 05:25:41 -04:00			Check the :example:`bluetooth/bluedroid/ble` folder in ESP-IDF examples, which contains the following demos and their tutorials:
component/bt : doxygen can generate html correctly 2016-12-01 07:20:22 -05:00
Docs/add Chinese translation for api-reference/bluetooth/esp_gap_ble.rst, api-reference/protocols/modbus.rst, and libraries-and-frameworks/libs-frameworks.rst from scratch 2023-05-04 05:25:41 -04:00			`* The following shows an SMP security client demo with its tutorial. This demo initiates its security parameters and acts as a GATT client, which can send a security request to the peer device and then complete the encryption procedure.`
component/bt: Update BLE examples tutorials and ReadMe files - Make docs compatible with GitHub Markdown - Add tutorials links in programming doc - Modify ReadMe files 2018-01-11 07:24:18 -05:00
Bluetooth examples restructuring The existing Bluetooth examples are split as: 1. examples/bluetooth/bluedroid - Bluedroid Host (BT + BLE) examples a. examples/bluetooth/bluedroid/classic_bt - Classic BT examples b. examples/bluetooth/bluedroid/ble - BLE examples c. examples/bluetooth/bluedroid/coex - Classic BT and BLE coex examples d. examples/bluetooth/bluedroid/hci - VHCI and HCI UART examples i. Rename ble_adv to controller_vhci_ble_adv and move it in hci folder 2. examples/bluetooth/nimble - NimBLE BLE Host + NimBLE Mesh examples 3. examples/bluetooth/esp_ble_mesh - ESP BLE Mesh examples 4. Update documentation references 2019-07-01 07:21:57 -04:00			- :example:`bluetooth/bluedroid/ble/gatt_security_client`
			- :example_file:`GATT Security Client Example Walkthrough <bluetooth/bluedroid/ble/gatt_security_client/tutorial/Gatt_Security_Client_Example_Walkthrough.md>`
component/bt: Update BLE examples tutorials and ReadMe files - Make docs compatible with GitHub Markdown - Add tutorials links in programming doc - Modify ReadMe files 2018-01-11 07:24:18 -05:00
Docs/add Chinese translation for api-reference/bluetooth/esp_gap_ble.rst, api-reference/protocols/modbus.rst, and libraries-and-frameworks/libs-frameworks.rst from scratch 2023-05-04 05:25:41 -04:00			`* The following shows an SMP security server demo with its tutorial. This demo initiates its security parameters and acts as a GATT server, which can send a pair request to the peer device and then complete the encryption procedure.`
component/bt: Update BLE examples tutorials and ReadMe files - Make docs compatible with GitHub Markdown - Add tutorials links in programming doc - Modify ReadMe files 2018-01-11 07:24:18 -05:00
Bluetooth examples restructuring The existing Bluetooth examples are split as: 1. examples/bluetooth/bluedroid - Bluedroid Host (BT + BLE) examples a. examples/bluetooth/bluedroid/classic_bt - Classic BT examples b. examples/bluetooth/bluedroid/ble - BLE examples c. examples/bluetooth/bluedroid/coex - Classic BT and BLE coex examples d. examples/bluetooth/bluedroid/hci - VHCI and HCI UART examples i. Rename ble_adv to controller_vhci_ble_adv and move it in hci folder 2. examples/bluetooth/nimble - NimBLE BLE Host + NimBLE Mesh examples 3. examples/bluetooth/esp_ble_mesh - ESP BLE Mesh examples 4. Update documentation references 2019-07-01 07:21:57 -04:00			- :example:`bluetooth/bluedroid/ble/gatt_security_server`
			- :example_file:`GATT Security Server Example Walkthrough <bluetooth/bluedroid/ble/gatt_security_server/tutorial/Gatt_Security_Server_Example_Walkthrough.md>`
component/bt : doxygen can generate html correctly 2016-12-01 07:20:22 -05:00
			`API Reference`
			`-------------`

docs: add new top-level docs builder that builds docs for a single chip 2019-11-12 22:46:16 -05:00			`.. include-build-file:: inc/esp_gap_ble_api.inc`
component/bt : doxygen can generate html correctly 2016-12-01 07:20:22 -05:00