component/bt: clean up the API header and generate documentation files
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
BT COMMON
|
||||
BT LE
|
||||
=========
|
||||
|
||||
.. toctree::
|
||||
|
||||
@@ -0,0 +1,9 @@
|
||||
CLASSIC BT
|
||||
==========
|
||||
|
||||
.. toctree::
|
||||
:caption: Classic BT
|
||||
|
||||
BT GAP <esp_gap_bt>
|
||||
BT A2DP <esp_a2dp>
|
||||
BT AVRC <esp_avrc>
|
||||
@@ -0,0 +1,82 @@
|
||||
Bluetooth A2DP API
|
||||
==================
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
Check :example:`bluetooth` folder in ESP-IDF examples, which contains the following examples:
|
||||
|
||||
:example:`bluetooth/a2dp_sink`
|
||||
|
||||
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.
|
||||
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
Header Files
|
||||
^^^^^^^^^^^^
|
||||
|
||||
* :component_file:`bt/bluedroid/api/include/esp_a2dp_api.h`
|
||||
|
||||
Macros
|
||||
^^^^^^
|
||||
|
||||
.. doxygendefine:: ESP_A2D_MCT_SBC
|
||||
.. doxygendefine:: ESP_A2D_MCT_M12
|
||||
.. doxygendefine:: ESP_A2D_MCT_M24
|
||||
.. doxygendefine:: ESP_A2D_MCT_ATRAC
|
||||
.. doxygendefine:: ESP_A2D_MCT_NON_A2DP
|
||||
.. doxygendefine:: ESP_A2D_CIE_LEN_SBC
|
||||
.. doxygendefine:: ESP_A2D_CIE_LEN_M12
|
||||
.. doxygendefine:: ESP_A2D_CIE_LEN_M24
|
||||
.. doxygendefine:: ESP_A2D_CIE_LEN_ATRAC
|
||||
|
||||
Type Definitions
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. doxygentypedef:: esp_a2d_mct_t
|
||||
.. doxygentypedef:: esp_a2d_cb_t
|
||||
.. doxygentypedef:: esp_a2d_data_cb_t
|
||||
|
||||
Enumerations
|
||||
^^^^^^^^^^^^
|
||||
|
||||
.. doxygenenum:: esp_a2d_connection_state_t
|
||||
.. doxygenenum:: esp_a2d_disc_rsn_t
|
||||
.. doxygenenum:: esp_a2d_audio_state_t
|
||||
.. doxygenenum:: esp_a2d_cb_event_t
|
||||
|
||||
Structures
|
||||
^^^^^^^^^^
|
||||
|
||||
.. doxygenstruct:: esp_a2d_cb_param_t
|
||||
:members:
|
||||
|
||||
.. doxygenstruct:: esp_a2d_cb_param_t::a2d_conn_stat_param
|
||||
:members:
|
||||
|
||||
.. doxygenstruct:: esp_a2d_cb_param_t::a2d_audio_stat_param
|
||||
:members:
|
||||
|
||||
.. doxygenstruct:: esp_a2d_cb_param_t::a2d_audio_cfg_param
|
||||
:members:
|
||||
|
||||
|
||||
Functions
|
||||
^^^^^^^^^
|
||||
|
||||
.. doxygenfunction:: esp_a2d_register_callback
|
||||
.. doxygenfunction:: esp_a2d_register_data_callback
|
||||
.. doxygenfunction:: esp_a2d_sink_init
|
||||
.. doxygenfunction:: esp_a2d_sink_deinit
|
||||
.. doxygenfunction:: esp_a2d_sink_connect
|
||||
.. doxygenfunction:: esp_a2d_sink_disconnect
|
||||
|
||||
@@ -0,0 +1,65 @@
|
||||
BT AVRCP APIs
|
||||
=============
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
Bluetooth AVRCP reference APIs.
|
||||
|
||||
`Instructions`_
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
Header Files
|
||||
^^^^^^^^^^^^
|
||||
|
||||
* :component_file:`bt/bluedroid/api/include/esp_avrc_api.h`
|
||||
|
||||
|
||||
Macros
|
||||
^^^^^^
|
||||
|
||||
|
||||
Type Definitions
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. doxygentypedef:: esp_avrc_ct_cb_t
|
||||
|
||||
Enumerations
|
||||
^^^^^^^^^^^^
|
||||
|
||||
.. doxygenenum:: esp_avrc_features_t
|
||||
.. doxygenenum:: esp_avrc_pt_cmd_t
|
||||
.. doxygenenum:: esp_avrc_pt_cmd_state_t
|
||||
.. doxygenenum:: esp_avrc_ct_cb_event_t
|
||||
|
||||
Structures
|
||||
^^^^^^^^^^
|
||||
|
||||
.. doxygenstruct:: esp_avrc_ct_cb_param_t
|
||||
:members:
|
||||
|
||||
.. doxygenstruct:: esp_avrc_ct_cb_param_t::avrc_ct_conn_stat_param
|
||||
:members:
|
||||
|
||||
.. doxygenstruct:: esp_avrc_ct_cb_param_t::avrc_ct_psth_rsp_param
|
||||
:members:
|
||||
|
||||
|
||||
Functions
|
||||
^^^^^^^^^
|
||||
|
||||
.. doxygenfunction:: esp_avrc_ct_register_callback
|
||||
.. doxygenfunction:: esp_avrc_ct_init
|
||||
.. doxygenfunction:: esp_avrc_ct_deinit
|
||||
.. doxygenfunction:: esp_avrc_ct_send_passthrough_cmd
|
||||
|
||||
@@ -45,4 +45,5 @@ Functions
|
||||
^^^^^^^^^
|
||||
|
||||
.. doxygenfunction:: esp_bt_dev_get_address
|
||||
.. doxygenfunction:: esp_bt_dev_set_device_name
|
||||
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
CLASSIC BLUETOOTH GAP API
|
||||
=========================
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
Application Example
|
||||
-------------------
|
||||
|
||||
`Instructions`_
|
||||
|
||||
.. _Instructions: ../template.html
|
||||
|
||||
|
||||
API Reference
|
||||
-------------
|
||||
|
||||
Header Files
|
||||
^^^^^^^^^^^^
|
||||
|
||||
* :component_file:`bt/bluedroid/api/include/esp_gap_bt_api.h`
|
||||
|
||||
|
||||
Macros
|
||||
^^^^^^
|
||||
|
||||
|
||||
Type Definitions
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
Enumerations
|
||||
^^^^^^^^^^^^
|
||||
|
||||
.. doxygenenum:: esp_bt_scan_mode_t
|
||||
|
||||
Structures
|
||||
^^^^^^^^^^
|
||||
|
||||
|
||||
Functions
|
||||
^^^^^^^^^
|
||||
|
||||
.. doxygenfunction:: esp_bt_gap_set_scan_mode
|
||||
|
||||
@@ -7,6 +7,7 @@ Bluetooth API
|
||||
Bluetooth Controller && VHCI <controller_vhci>
|
||||
Bluetooth Common <bt_common>
|
||||
Bluetooth LE <bt_le>
|
||||
Bluetooth Classic BT <classic_bt>
|
||||
|
||||
|
||||
Example code for this API section is provided in :example:`bluetooth` directory of ESP-IDF examples.
|
||||
|
||||
Reference in New Issue
Block a user