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

GAP API
=======

Overview
--------

`Instructions`_

.. _Instructions: ../template.html

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

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

* This is a SMP security client demo and 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>`

* This is a SMP security server demo and 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/inc/esp_gap_ble_api.inc
component/bt : doxygen can generate html correctly 2016-12-01 12:20:22 +00:00			`GAP API`
Updated links to point directly to example folder, fixed names 2017-01-17 19:03:26 +00:00			`=======`
component/bt : doxygen can generate html correctly 2016-12-01 12:20:22 +00:00
			`Overview`
			`--------`

			`Instructions`_

Updated links to point directly to example folder, fixed names 2017-01-17 19:03:26 +00:00			`.. _Instructions: ../template.html`

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
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			`* This is a SMP security client demo and 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.`

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_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 12:24:18 +00:00
			`* This is a SMP security server demo and 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.`

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_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 12:20:22 +00:00
			`API Reference`
			`-------------`

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 08:36:01 +00:00			`.. include:: /_build/inc/esp_gap_ble_api.inc`
component/bt : doxygen can generate html correctly 2016-12-01 12:20:22 +00:00