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

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

.. toctree::
   :maxdepth: 2

   Bluetooth Controller && VHCI <controller_vhci>
   Bluetooth Common <bt_common>
   Bluetooth LE <bt_le>
   Bluetooth Classic <classic_bt>


To see the overview of the ESP32 Bluetooth stack architecture, follow 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>`_

Example code for this API section is provided in :example:`bluetooth` directory of ESP-IDF examples.

Several examples contain detailed description. To see them please follow links below:

* :example_file:`GATT Client Example Walkthrough <bluetooth/gatt_client/tutorial/Gatt_Client_Example_Walkthrough.md>`
* :example_file:`GATT Server Service Table Example Walkthrough <bluetooth/gatt_server_service_table/tutorial/Gatt_Server_Service_Table_Example_Walkthrough.md>`
* :example_file:`GATT Server Example Walkthrough <bluetooth/gatt_server/tutorial/Gatt_Server_Example_Walkthrough.md>`
* :example_file:`GATT Security Client Example Walkthrough <bluetooth/gatt_security_client/tutorial/Gatt_Security_Client_Example_Walkthrough.md>`
* :example_file:`GATT Security Server Example Walkthrough <bluetooth/gatt_security_server/tutorial/Gatt_Security_Server_Example_Walkthrough.md>`
* :example_file:`GATT Client Multi-connection Example Walkthrough <bluetooth/gattc_multi_connect/tutorial/Gatt_Client_Multi_Connection_Example_Walkthrough.md>`
Moved api documentation to new folders / categories 2017-01-16 23:08:35 +01:00			`Bluetooth API`
			`*************`
API template 2016-10-26 21:08:36 +02:00
component/bt : doxygen can generate html correctly 2016-12-01 20:20:22 +08:00			`.. toctree::`
Moved api documentation to new folders / categories 2017-01-16 23:08:35 +01:00			`:maxdepth: 2`
API template 2016-10-26 21:08:36 +02:00
component/bt: modify bluetooth API 2017-01-03 15:53:06 +08:00			`Bluetooth Controller && VHCI <controller_vhci>`
component/bt : doxygen can generate html correctly 2016-12-01 20:20:22 +08:00			`Bluetooth Common <bt_common>`
			`Bluetooth LE <bt_le>`
docs: Generate Doxygen directives for API documentation 2017-05-02 10:36:01 +02:00			`Bluetooth Classic <classic_bt>`
Moved api documentation to new folders / categories 2017-01-16 23:08:35 +01:00
Added links from api category TOC to example category folders 2017-01-18 21:04:11 +01:00
component/bt: Update BLE examples tutorials and ReadMe files 2018-01-11 20:24:18 +08:00			`To see the overview of the ESP32 Bluetooth stack architecture, follow 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>`_

docs: use custom roles to generate GitHub links 2017-01-19 16:16:06 +08:00			Example code for this API section is provided in :example:`bluetooth` directory of ESP-IDF examples.
component/bt: Update BLE examples tutorials and ReadMe files 2018-01-11 20:24:18 +08:00
			`Several examples contain detailed description. To see them please follow links below:`

			* :example_file:`GATT Client Example Walkthrough <bluetooth/gatt_client/tutorial/Gatt_Client_Example_Walkthrough.md>`
			* :example_file:`GATT Server Service Table Example Walkthrough <bluetooth/gatt_server_service_table/tutorial/Gatt_Server_Service_Table_Example_Walkthrough.md>`
			* :example_file:`GATT Server Example Walkthrough <bluetooth/gatt_server/tutorial/Gatt_Server_Example_Walkthrough.md>`
			* :example_file:`GATT Security Client Example Walkthrough <bluetooth/gatt_security_client/tutorial/Gatt_Security_Client_Example_Walkthrough.md>`
			* :example_file:`GATT Security Server Example Walkthrough <bluetooth/gatt_security_server/tutorial/Gatt_Security_Server_Example_Walkthrough.md>`
			* :example_file:`GATT Client Multi-connection Example Walkthrough <bluetooth/gattc_multi_connect/tutorial/Gatt_Client_Multi_Connection_Example_Walkthrough.md>`