Moved files into separate folders per 'en' and 'zh_CN' language version and linked 'zh_CN' files back to 'en' files if translation is not yet available
This commit is contained in:
krzychb
@@ -0,0 +1,9 @@
|
||||
BT COMMON
|
||||
=========
|
||||
|
||||
.. toctree::
|
||||
:caption: Bluetooth Common Defines and APIs
|
||||
|
||||
Bluetooth DEFINE <esp_bt_defs>
|
||||
Bluetooth MAIN <esp_bt_main>
|
||||
Bluetooth DEVICE <esp_bt_device>
|
||||
@@ -0,0 +1,11 @@
|
||||
BT LE
|
||||
=========
|
||||
|
||||
.. toctree::
|
||||
:caption: Bluetooth LE
|
||||
|
||||
BLE GAP <esp_gap_ble>
|
||||
BLE GATT DEFINE <esp_gatt_defs>
|
||||
BLE GATT SERVER <esp_gatts>
|
||||
BLE GATT CLIENT <esp_gattc>
|
||||
BLE BLUFI <esp_blufi>
|
||||
@@ -0,0 +1,10 @@
|
||||
CLASSIC BT
|
||||
==========
|
||||
|
||||
.. toctree::
|
||||
:caption: Classic BT
|
||||
|
||||
BT GAP <esp_gap_bt>
|
||||
BT A2DP <esp_a2dp>
|
||||
BT AVRC <esp_avrc>
|
||||
BT SPP <esp_spp>
|
||||
@@ -0,0 +1,21 @@
|
||||
Controller && VHCI
|
||||
==================
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
Check :example:`bluetooth` folder in ESP-IDF examples, which contains the following application:
|
||||
|
||||
* This is a BLE advertising demo with virtual HCI interface. Send Reset/ADV_PARAM/ADV_DATA/ADV_ENABLE HCI command for BLE advertising - :example:`bluetooth/ble_adv`.
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. include:: /_build/inc/bt.inc
|
||||
@@ -0,0 +1,22 @@
|
||||
Bluetooth A2DP API
|
||||
==================
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
Check :example:`bluetooth` folder in ESP-IDF examples, which contains the following application:
|
||||
|
||||
* This is a A2DP sink client demo. This demo can be discovered and connected by A2DP source device and receive the audio stream from remote device - :example:`bluetooth/a2dp_sink`
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. include:: /_build/inc/esp_a2dp_api.inc
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
BT AVRCP APIs
|
||||
=============
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
Bluetooth AVRCP reference APIs.
|
||||
|
||||
`Instructions`_
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. include:: /_build/inc/esp_avrc_api.inc
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
BLUFI API
|
||||
=========
|
||||
|
||||
Overview
|
||||
--------
|
||||
BLUFI is a profile based GATT to config ESP32 WIFI to connect/disconnect AP or setup a softap and etc.
|
||||
Use should concern these things:
|
||||
|
||||
1. The event sent from profile. Then you need to do something as the event indicate.
|
||||
2. Security reference. You can write your own Security functions such as symmetrical encryption/decryption and checksum functions. Even you can define the "Key Exchange/Negotiation" procedure.
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
Check :example:`bluetooth` folder in ESP-IDF examples, which contains the following application:
|
||||
|
||||
* This is a BLUFI demo. This demo can set ESP32's wifi to softap/station/softap&station mode and config wifi connections - :example:`bluetooth/blufi`
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. include:: /_build/inc/esp_blufi_api.inc
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
BT GENERIC DEFINES
|
||||
==================
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. include:: /_build/inc/esp_bt_defs.inc
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
BT DEVICE APIs
|
||||
===============
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
Bluetooth device reference APIs.
|
||||
|
||||
`Instructions`_
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. include:: /_build/inc/esp_bt_device.inc
|
||||
@@ -0,0 +1,22 @@
|
||||
BT MAIN API
|
||||
===========
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. include:: /_build/inc/esp_bt_main.inc
|
||||
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
GAP API
|
||||
=======
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
Check :example:`bluetooth` 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/gatt_security_client`
|
||||
- :example_file:`GATT Security Client Example Walkthrough <bluetooth/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/gatt_security_server`
|
||||
- :example_file:`GATT Security Server Example Walkthrough <bluetooth/gatt_security_server/tutorial/Gatt_Security_Server_Example_Walkthrough.md>`
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. include:: /_build/inc/esp_gap_ble_api.inc
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
CLASSIC BLUETOOTH GAP API
|
||||
=========================
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. include:: /_build/inc/esp_gap_bt_api.inc
|
||||
|
||||
@@ -0,0 +1,21 @@
|
||||
GATT DEFINES
|
||||
============
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. include:: /_build/inc/esp_gatt_defs.inc
|
||||
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
GATT CLIENT API
|
||||
===============
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
Check :example:`bluetooth` 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/gatt_client`
|
||||
- :example_file:`GATT Client Example Walkthrough <bluetooth/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/gattc_multi_connect`
|
||||
- :example_file:`GATT Client Multi-connection Example Walkthrough <bluetooth/gattc_multi_connect/tutorial/Gatt_Client_Multi_Connection_Example_Walkthrough.md>`
|
||||
|
||||
* This is a BLE SPP-Like demo. 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/ble_spp_client`
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. include:: /_build/inc/esp_gattc_api.inc
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
GATT SERVER API
|
||||
===============
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
Check :example:`bluetooth` folder in ESP-IDF examples, which contains the following demos and their tutorials:
|
||||
|
||||
* This is a GATT sever demo and its tutorial. This demo creates a GATT service with an attribute table, which releases the user from adding attributes one by one. This is the recommended method of adding attributes.
|
||||
|
||||
- :example:`bluetooth/gatt_server_service_table`
|
||||
- :example_file:`GATT Server Service Table Example Walkthrough <bluetooth/gatt_server_service_table/tutorial/Gatt_Server_Service_Table_Example_Walkthrough.md>`
|
||||
|
||||
* This is a GATT server demo and its tutorial. This demo creates a GATT service by adding attributes one by one as defined by Bluedroid. The recommended method of adding attributes is presented in example above.
|
||||
|
||||
- :example:`bluetooth/gatt_server`
|
||||
- :example_file:`GATT Server Example Walkthrough <bluetooth/gatt_server/tutorial/Gatt_Server_Example_Walkthrough.md>`
|
||||
|
||||
* This is a BLE SPP-Like demo. This demo, which acts as a GATT server, can receive data from UART and then send the data to the peer device automatically.
|
||||
|
||||
- :example:`bluetooth/ble_spp_server`
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. include:: /_build/inc/esp_gatts_api.inc
|
||||
|
||||
@@ -0,0 +1,22 @@
|
||||
SPP API
|
||||
===============
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
Check :example:`bluetooth` folder in ESP-IDF examples, which contains the following application:
|
||||
|
||||
* This is a SPP demo. This demo can discover the service, connect, send and recive SPP data :example:`bluetooth/bt_spp_acceptor`, :example:`bluetooth/bt_spp_initiator`
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
.. include:: /_build/inc/esp_spp_api.inc
|
||||
|
||||
@@ -0,0 +1,27 @@
|
||||
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>`
|
||||
Reference in New Issue
Block a user