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

GATT Client API
===============

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

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

* This is a GATT client demo and its tutorial. This demo can scan for devices, connect to the GATT server and discover its services.

    - :example:`bluetooth/bluedroid/ble/gatt_client`
    - :example_file:`GATT Client Example Walkthrough <bluetooth/bluedroid/ble/gatt_client/tutorial/Gatt_Client_Example_Walkthrough.md>`

* This is a multiple connection demo and its tutorial. This demo can connect to multiple GATT server devices and discover their services.

    - :example:`bluetooth/bluedroid/ble/gattc_multi_connect`
    - :example_file:`GATT Client Multi-connection Example Walkthrough <bluetooth/bluedroid/ble/gattc_multi_connect/tutorial/Gatt_Client_Multi_Connection_Example_Walkthrough.md>`

* This is a demo similar to Bluetooth® Low Energy (Bluetooth LE) SPP. This demo, which acts as a GATT client, can receive data from UART and then send the data to the peer device automatically.

    - :example:`bluetooth/bluedroid/ble/ble_spp_client`

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

.. include-build-file:: inc/esp_gattc_api.inc
docs: update format issues for EN and CN files under api-reference/bluetooth folder 2023-07-12 08:48:16 +00:00			`GATT Client API`
component/bt : doxygen can generate html correctly 2016-12-01 12:20:22 +00:00			`===============`

			`Application Example`
			`-------------------`

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 11:21:57 +00:00			Check :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 12:20:22 +00:00
docs: remove filler template content from BT docs 2022-04-27 06:44:36 +00:00			`* This is a GATT client demo and its tutorial. This demo can scan for devices, connect to the GATT server and discover its services.`
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 12:24:18 +00: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 11:21:57 +00:00			- :example:`bluetooth/bluedroid/ble/gatt_client`
			- :example_file:`GATT Client Example Walkthrough <bluetooth/bluedroid/ble/gatt_client/tutorial/Gatt_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 12:24:18 +00:00
docs: remove filler template content from BT docs 2022-04-27 06:44:36 +00:00			`* This is a multiple connection demo and its tutorial. This demo can connect to multiple GATT server devices and discover their services.`
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 12:24:18 +00: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 11:21:57 +00:00			- :example:`bluetooth/bluedroid/ble/gattc_multi_connect`
			- :example_file:`GATT Client Multi-connection Example Walkthrough <bluetooth/bluedroid/ble/gattc_multi_connect/tutorial/Gatt_Client_Multi_Connection_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 12:24:18 +00:00
docs: update format issues for EN and CN files under api-reference/bluetooth folder 2023-07-12 08:48:16 +00:00			`* This is a demo similar to Bluetooth® Low Energy (Bluetooth LE) SPP. This demo, which acts as a GATT client, can receive data from UART and then send the data to the peer device automatically.`
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 12:24:18 +00: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 11:21:57 +00:00			- :example:`bluetooth/bluedroid/ble/ble_spp_client`
component/bt : doxygen can generate html correctly 2016-12-01 12:20:22 +00:00
			`API Reference`
			`-------------`

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