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

Bluetooth API
*************

:link_to_translation:`zh_CN:[中文]`

.. toctree::
   :maxdepth: 2

   Bluetooth Controller && VHCI <controller_vhci>
   Bluetooth Common <bt_common>
   Bluetooth LE <bt_le>
   Bluetooth Classic <classic_bt>
   NimBLE <nimble/index>

ESP-IDF currently supports two host stacks. The Bluedroid based stack (default) supports classic Bluetooth as well as BLE. On the other hand, Apache NimBLE based stack is BLE only. For users to make a choice:
* For usecases involving classic Bluetooth as well as BLE, Bluedroid should be used.
* For BLE-only usecases, using NimBLE is recommended. It is less demanding in terms of code footprint and runtime memory, making it suitable for such scenarios.


For the overview of the ESP32 Bluetooth stack architecture, follow the links below:

* `ESP32 Bluetooth Architecture (PDF) [English] <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_en.pdf>`_
* `ESP32 Bluetooth Architecture (PDF) [中文] <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_cn.pdf>`_

Code examples for this API section are provided in the :example:`bluetooth/bluedroid` directory of ESP-IDF examples.

The following examples contain detailed walkthroughs:

* :example_file:`GATT Client Example Walkthrough <bluetooth/bluedroid/ble/gatt_client/tutorial/Gatt_Client_Example_Walkthrough.md>`
* :example_file:`GATT Server Service Table Example Walkthrough <bluetooth/bluedroid/ble/gatt_server_service_table/tutorial/Gatt_Server_Service_Table_Example_Walkthrough.md>`
* :example_file:`GATT Server Example Walkthrough <bluetooth/bluedroid/ble/gatt_server/tutorial/Gatt_Server_Example_Walkthrough.md>`
* :example_file:`GATT Security Client Example Walkthrough <bluetooth/bluedroid/ble/gatt_security_client/tutorial/Gatt_Security_Client_Example_Walkthrough.md>`
* :example_file:`GATT Security Server Example Walkthrough <bluetooth/bluedroid/ble/gatt_security_server/tutorial/Gatt_Security_Server_Example_Walkthrough.md>`
* :example_file:`GATT Client Multi-connection Example Walkthrough <bluetooth/bluedroid/ble/gattc_multi_connect/tutorial/Gatt_Client_Multi_Connection_Example_Walkthrough.md>`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`Bluetooth API`
			`*************`
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 15:08:36 -04:00
Add Chinese translation for index.rst files and esp_wifi.rst file in api-reference following Kirill's English review, including: -network/index.rst -network/esp_wifi.rst -peripherals/index.rst -provisioning/index.rst 2019-05-15 09:05:44 -04:00			:link_to_translation:`zh_CN:[中文]`

component/bt : doxygen can generate html correctly 2016-12-01 07:20:22 -05:00			`.. toctree::`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00			`:maxdepth: 2`
API template - reflected template in other DRAFT API dcouments - DRAFT of Bluetooth API - link fixes in CONTRIBUTING.rst 2016-10-26 15:08:36 -04:00
component/bt: modify bluetooth API 1. VHCI api and doxygen 2. Controller api and doxygen 3. bluedroid init/enable api and doxygen 4. cleanup demo codes 2017-01-03 02:53:06 -05:00			`Bluetooth Controller && VHCI <controller_vhci>`
component/bt : doxygen can generate html correctly 2016-12-01 07:20:22 -05:00			`Bluetooth Common <bt_common>`
			`Bluetooth LE <bt_le>`
docs: Generate Doxygen directives for API documentation This is to resolve issue reported in https://github.com/espressif/esp-idf/issues/130. 2017-05-02 04:36:01 -04:00			`Bluetooth Classic <classic_bt>`
Port NimBLE Host Stack on ESP-IDF 2019-06-24 21:03:58 -04:00			`NimBLE <nimble/index>`

			`ESP-IDF currently supports two host stacks. The Bluedroid based stack (default) supports classic Bluetooth as well as BLE. On the other hand, Apache NimBLE based stack is BLE only. For users to make a choice:`
			`* For usecases involving classic Bluetooth as well as BLE, Bluedroid should be used.`
			`* For BLE-only usecases, using NimBLE is recommended. It is less demanding in terms of code footprint and runtime memory, making it suitable for such scenarios.`
Moved api documentation to new folders / categories 2017-01-16 17:08:35 -05:00
Added links from api category TOC to example category folders Typo fix in bluetooth README.md 2017-01-18 15:04:11 -05:00
Doc/review api reference indexes 2019-04-28 22:53:42 -04:00			`For the overview of the ESP32 Bluetooth stack architecture, follow the links below:`
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
			* `ESP32 Bluetooth Architecture (PDF) [English] <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_en.pdf>`_
			* `ESP32 Bluetooth Architecture (PDF) [中文] <http://espressif.com/sites/default/files/documentation/esp32_bluetooth_architecture_cn.pdf>`_

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			Code examples for this API section are provided in the :example:`bluetooth/bluedroid` directory of ESP-IDF examples.
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
Doc/review api reference indexes 2019-04-28 22:53:42 -04:00			`The following examples contain detailed walkthroughs:`
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_file:`GATT Client Example Walkthrough <bluetooth/bluedroid/ble/gatt_client/tutorial/Gatt_Client_Example_Walkthrough.md>`
			* :example_file:`GATT Server Service Table Example Walkthrough <bluetooth/bluedroid/ble/gatt_server_service_table/tutorial/Gatt_Server_Service_Table_Example_Walkthrough.md>`
			* :example_file:`GATT Server Example Walkthrough <bluetooth/bluedroid/ble/gatt_server/tutorial/Gatt_Server_Example_Walkthrough.md>`
			* :example_file:`GATT Security Client Example Walkthrough <bluetooth/bluedroid/ble/gatt_security_client/tutorial/Gatt_Security_Client_Example_Walkthrough.md>`
			* :example_file:`GATT Security Server Example Walkthrough <bluetooth/bluedroid/ble/gatt_security_server/tutorial/Gatt_Security_Server_Example_Walkthrough.md>`
			* :example_file:`GATT Client Multi-connection Example Walkthrough <bluetooth/bluedroid/ble/gattc_multi_connect/tutorial/Gatt_Client_Multi_Connection_Example_Walkthrough.md>`