From df419fd8626152ae24ef98b5fafbfb9b011c5734 Mon Sep 17 00:00:00 2001 From: Tian Hao Date: Thu, 1 Dec 2016 20:20:22 +0800 Subject: [PATCH] component/bt : doxygen can generate html correctly --- docs/Doxyfile | 1 + docs/api/bt.rst | 43 ++----------- docs/api/bt_common.rst | 8 +++ docs/api/bt_le.rst | 10 +++ docs/api/esp_bt_defs.rst | 60 ++++++++++++++++++ docs/api/esp_bt_main.rst | 49 +++++++++++++++ docs/api/esp_gap_ble.rst | 103 ++++++++++++++++++++++++++++++ docs/api/esp_gatt_defs.rst | 60 ++++++++++++++++++ docs/api/esp_gattc.rst | 125 +++++++++++++++++++++++++++++++++++++ docs/api/esp_gatts.rst | 121 +++++++++++++++++++++++++++++++++++ docs/api/vhci.rst | 41 ++++++++++++ 11 files changed, 584 insertions(+), 37 deletions(-) create mode 100644 docs/api/bt_common.rst create mode 100644 docs/api/bt_le.rst create mode 100644 docs/api/esp_bt_defs.rst create mode 100644 docs/api/esp_bt_main.rst create mode 100644 docs/api/esp_gap_ble.rst create mode 100644 docs/api/esp_gatt_defs.rst create mode 100644 docs/api/esp_gattc.rst create mode 100644 docs/api/esp_gatts.rst create mode 100644 docs/api/vhci.rst diff --git a/docs/Doxyfile b/docs/Doxyfile index 2a4089819..c3ca02103 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -18,6 +18,7 @@ PROJECT_NAME = "ESP32 Programming Guide" INPUT = ../components/esp32/include/esp_wifi.h \ ../components/driver/include/driver \ ../components/bt/include \ + ../components/bt/bluedroid/api/include \ ../components/nvs_flash/include \ ../components/log/include \ ../components/vfs/include \ diff --git a/docs/api/bt.rst b/docs/api/bt.rst index 1824bc454..924e855c2 100644 --- a/docs/api/bt.rst +++ b/docs/api/bt.rst @@ -1,41 +1,10 @@ Bluetooth ========= -Overview --------- +.. toctree:: + :caption: Bluetooth APIs -`Instructions`_ - -Application Example -------------------- - -Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: - -`05_ble_adv `_ - - This is a BLE advertising demo with virtual HCI interface. Send Reset/ADV_PARAM/ADV_DATA/ADV_ENABLE HCI command for BLE advertising. - -`Instructions`_ - -.. _Instructions: template.html - -API Reference -------------- - -Header Files -^^^^^^^^^^^^ - - * `bt/include/bt.h `_ - -Type Definitions -^^^^^^^^^^^^^^^^ - -.. doxygenstruct:: vhci_host_callback - -Functions -^^^^^^^^^ - -.. doxygenfunction:: API_vhci_host_check_send_available -.. doxygenfunction:: API_vhci_host_register_callback -.. doxygenfunction:: API_vhci_host_send_packet -.. doxygenfunction:: bt_controller_init + Bluetooth VHCI + Bluetooth Common + Bluetooth Classic + Bluetooth LE diff --git a/docs/api/bt_common.rst b/docs/api/bt_common.rst new file mode 100644 index 000000000..eaa6b8d31 --- /dev/null +++ b/docs/api/bt_common.rst @@ -0,0 +1,8 @@ +BT COMMON +========= + +.. toctree:: + :caption: Bluetooth Common Defines and APIs + + Bluetooth DEFINE + Bluetooth MAIN diff --git a/docs/api/bt_le.rst b/docs/api/bt_le.rst new file mode 100644 index 000000000..6ae486937 --- /dev/null +++ b/docs/api/bt_le.rst @@ -0,0 +1,10 @@ +BT COMMON +========= + +.. toctree:: + :caption: Bluetooth LE + + BLE GAP + BLE GATT DEFINE + BLE GATT SERVER + BLE GATT CLIENT diff --git a/docs/api/esp_bt_defs.rst b/docs/api/esp_bt_defs.rst new file mode 100644 index 000000000..9a2131f74 --- /dev/null +++ b/docs/api/esp_bt_defs.rst @@ -0,0 +1,60 @@ +BT GENERIC DEFINES +================== + +Overview +-------- + +`Instructions`_ + +Application Example +------------------- + +`Instructions`_ + +.. _Instructions: template.html + + +API Reference +------------- + +Header Files +^^^^^^^^^^^^ + + * `bt/bluedroid/api/include/esp_bt_defs.h `_ + + +Macros +^^^^^^ + +.. doxygendefine:: ESP_DEFAULT_GATT_IF +.. doxygendefine:: ESP_BLE_CONN_PARAM_UNDEF +.. doxygendefine:: ESP_BLE_IS_VALID_PARAM +.. doxygendefine:: ESP_UUID_LEN_16 +.. doxygendefine:: ESP_UUID_LEN_32 +.. doxygendefine:: ESP_UUID_LEN_128 +.. doxygendefine:: ESP_BD_ADDR_LEN +.. doxygendefine:: ESP_APP_ID_MIN +.. doxygendefine:: ESP_APP_ID_MAX + +Type Definitions +^^^^^^^^^^^^^^^^ + +.. doxygentypedef:: esp_bd_addr_t +.. doxygentypedef:: esp_profile_cb_t + +Enumerations +^^^^^^^^^^^^ + +.. doxygenenum:: esp_bt_status_t +.. doxygenenum:: esp_bt_dev_type_t +.. doxygenenum:: esp_bd_addr_type_t +.. doxygenenum:: esp_ble_addr_type_t + +Structures +^^^^^^^^^^ + + +Functions +^^^^^^^^^ + + diff --git a/docs/api/esp_bt_main.rst b/docs/api/esp_bt_main.rst new file mode 100644 index 000000000..dc317c584 --- /dev/null +++ b/docs/api/esp_bt_main.rst @@ -0,0 +1,49 @@ +BT MAIN API +=========== + +Overview +-------- + +`Instructions`_ + +Application Example +------------------- + +`Instructions`_ + +.. _Instructions: template.html + + +API Reference +------------- + +Header Files +^^^^^^^^^^^^ + + * `bt/bluedroid/api/include/esp_bt_main.h `_ + + +Macros +^^^^^^ + + +Type Definitions +^^^^^^^^^^^^^^^^ + + +Enumerations +^^^^^^^^^^^^ + + +Structures +^^^^^^^^^^ + + +Functions +^^^^^^^^^ + +.. doxygenfunction:: esp_enable_bluetooth +.. doxygenfunction:: esp_disable_bluetooth +.. doxygenfunction:: esp_init_bluetooth +.. doxygenfunction:: esp_deinit_bluetooth + diff --git a/docs/api/esp_gap_ble.rst b/docs/api/esp_gap_ble.rst new file mode 100644 index 000000000..f1837d402 --- /dev/null +++ b/docs/api/esp_gap_ble.rst @@ -0,0 +1,103 @@ +GAP API +======== + +Overview +-------- + +`Instructions`_ + +Application Example +------------------- + +Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: + +`14_gatts_demo `_ +`15_gattc_demo `_ + +The two demos use different gap api, such like advertising, scan, set device name and others. + +`Instructions`_ + +.. _Instructions: template.html + + +API Reference +------------- + +Header Files +^^^^^^^^^^^^ + + * `bt/bluedroid/api/include/esp_gap_ble_api.h `_ + + +Macros +^^^^^^ + +.. doxygendefine:: ESP_BLE_ADV_DATA_LEN_MAX + +Type Definitions +^^^^^^^^^^^^^^^^ + + +Enumerations +^^^^^^^^^^^^ + +.. doxygenenum:: esp_gap_ble_cb_event_t +.. doxygenenum:: esp_ble_adv_data_type +.. doxygenenum:: esp_ble_adv_type_t +.. doxygenenum:: esp_ble_adv_channel_t +.. doxygenenum:: esp_ble_adv_filter_t +.. doxygenenum:: esp_ble_own_addr_src_t +.. doxygenenum:: esp_ble_scan_type_t +.. doxygenenum:: esp_ble_scan_filter_t +.. doxygenenum:: esp_gap_search_evt_t +.. doxygenenum:: esp_ble_evt_type_t + +Structures +^^^^^^^^^^ + +.. doxygenstruct:: esp_ble_adv_params_t + :members: + +.. doxygenstruct:: esp_ble_adv_data_t + :members: + +.. doxygenstruct:: esp_ble_scan_params_t + :members: + +.. doxygenstruct:: esp_ble_conn_update_params_t + :members: + +.. doxygenstruct:: esp_ble_gap_cb_param_t + :members: + +.. doxygenstruct:: esp_ble_gap_cb_param_t::ble_adv_data_cmpl_evt_param + :members: + +.. doxygenstruct:: esp_ble_gap_cb_param_t::ble_scan_rsp_data_cmpl_evt_param + :members: + +.. doxygenstruct:: esp_ble_gap_cb_param_t::ble_scan_param_cmpl_evt_param + :members: + +.. doxygenstruct:: esp_ble_gap_cb_param_t::ble_scan_result_evt_param + :members: + + +Functions +^^^^^^^^^ + +.. doxygenfunction:: esp_ble_gap_register_callback +.. doxygenfunction:: esp_ble_gap_config_adv_data +.. doxygenfunction:: esp_ble_gap_set_scan_params +.. doxygenfunction:: esp_ble_gap_start_scanning +.. doxygenfunction:: esp_ble_gap_stop_scanning +.. doxygenfunction:: esp_ble_gap_start_advertising +.. doxygenfunction:: esp_ble_gap_stop_advertising +.. doxygenfunction:: esp_ble_gap_update_conn_params +.. doxygenfunction:: esp_ble_gap_set_pkt_data_len +.. doxygenfunction:: esp_ble_gap_set_rand_addr +.. doxygenfunction:: esp_ble_gap_config_local_privacy +.. doxygenfunction:: esp_ble_gap_set_device_name +.. doxygenfunction:: esp_ble_resolve_adv_data + diff --git a/docs/api/esp_gatt_defs.rst b/docs/api/esp_gatt_defs.rst new file mode 100644 index 000000000..a4cfe918c --- /dev/null +++ b/docs/api/esp_gatt_defs.rst @@ -0,0 +1,60 @@ +GATT DEFINES +============ + +Overview +-------- + +`Instructions`_ + +Application Example +------------------- + +`Instructions`_ + +.. _Instructions: template.html + + +API Reference +------------- + +Header Files +^^^^^^^^^^^^ + + * `bt/bluedroid/api/include/esp_gatt_defs.h `_ + + +Macros +^^^^^^ + +.. doxygendefine:: ESP_GATT_MAX_ATTR_LEN + +Type Definitions +^^^^^^^^^^^^^^^^ + +.. doxygentypedef:: esp_gatt_if_t + +Enumerations +^^^^^^^^^^^^ + +.. doxygenenum:: esp_gatt_prep_write_type +.. doxygenenum:: esp_gatt_status_t +.. doxygenenum:: esp_gatt_conn_reason_t +.. doxygenenum:: esp_gatt_auth_req_t +.. doxygenenum:: esp_gatt_perm_t +.. doxygenenum:: esp_gatt_char_prop_t +.. doxygenenum:: esp_gatt_write_type_t + +Structures +^^^^^^^^^^ + +.. doxygenstruct:: esp_gatt_value_t + :members: + +.. doxygenstruct:: esp_gatt_rsp_t + :members: + + +Functions +^^^^^^^^^ + + diff --git a/docs/api/esp_gattc.rst b/docs/api/esp_gattc.rst new file mode 100644 index 000000000..efd2623ad --- /dev/null +++ b/docs/api/esp_gattc.rst @@ -0,0 +1,125 @@ +GATT CLIENT API +=============== + +Overview +-------- + +`Instructions`_ + +Application Example +------------------- + +Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: + +`15_gattc_demo `_ + +This is a gatt client demo. This demo can scan devices, connect to the gatt server and discover the service. + +`Instructions`_ + +.. _Instructions: template.html + + +API Reference +------------- + +Header Files +^^^^^^^^^^^^ + + * `bt/bluedroid/api/include/esp_gattc_api.h `_ + +Macros +^^^^^^ + +.. doxygendefine:: ESP_GATT_DEF_BLE_MTU_SIZE +.. doxygendefine:: ESP_GATT_MAX_MTU_SIZE + +Type Definitions +^^^^^^^^^^^^^^^^ + + +Enumerations +^^^^^^^^^^^^ + +.. doxygenenum:: esp_gattc_cb_event_t + +Structures +^^^^^^^^^^ + +.. doxygenstruct:: esp_ble_gattc_cb_param_t + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_reg_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_open_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_close_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_cfg_mtu_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_search_cmpl_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_search_res_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_read_char_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_write_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_exec_cmpl_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_notify_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_srvc_chg_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_congest_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_get_char_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_get_descr_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_get_incl_srvc_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_reg_for_notify_evt_param + :members: + +.. doxygenstruct:: esp_ble_gattc_cb_param_t::gattc_unreg_for_notify_evt_param + :members: + + +Functions +^^^^^^^^^ + +.. doxygenfunction:: esp_ble_gattc_register_callback +.. doxygenfunction:: esp_ble_gattc_app_register +.. doxygenfunction:: esp_ble_gattc_app_unregister +.. doxygenfunction:: esp_ble_gattc_open +.. doxygenfunction:: esp_ble_gattc_close +.. doxygenfunction:: esp_ble_gattc_config_mtu +.. doxygenfunction:: esp_ble_gattc_search_service +.. doxygenfunction:: esp_ble_gattc_get_characteristic +.. doxygenfunction:: esp_ble_gattc_get_descriptor +.. doxygenfunction:: esp_ble_gattc_get_included_service +.. doxygenfunction:: esp_ble_gattc_read_char +.. doxygenfunction:: esp_ble_gattc_read_char_descr +.. doxygenfunction:: esp_ble_gattc_write_char +.. doxygenfunction:: esp_ble_gattc_write_char_descr +.. doxygenfunction:: esp_ble_gattc_prepare_write +.. doxygenfunction:: esp_ble_gattc_execute_write +.. doxygenfunction:: esp_ble_gattc_register_for_notify +.. doxygenfunction:: esp_ble_gattc_unregister_for_notify + diff --git a/docs/api/esp_gatts.rst b/docs/api/esp_gatts.rst new file mode 100644 index 000000000..fdb0e055a --- /dev/null +++ b/docs/api/esp_gatts.rst @@ -0,0 +1,121 @@ +GATT SERVER API +=============== + +Overview +-------- + +`Instructions`_ + +Application Example +------------------- + +Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: + +`14_gatts_demo `_ + +This is a gatt server demo. Use gatt api to create a gatt server with send advertising. This gatt server can be connected and the service can be discovery. + +`Instructions`_ + +.. _Instructions: template.html + + +API Reference +------------- + +Header Files +^^^^^^^^^^^^ + + * `bt/bluedroid/api/include/esp_gatts_api.h `_ + +Macros +^^^^^^ + +.. doxygendefine:: ESP_GATT_PREP_WRITE_CANCEL +.. doxygendefine:: ESP_GATT_PREP_WRITE_EXEC + +Type Definitions +^^^^^^^^^^^^^^^^ + + +Enumerations +^^^^^^^^^^^^ + +.. doxygenenum:: esp_gatts_cb_event_t + +Structures +^^^^^^^^^^ + +.. doxygenstruct:: esp_ble_gatts_cb_param_t + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_reg_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_read_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_write_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_exec_write_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_mtu_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_conf_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_create_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_add_incl_srvc_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_add_char_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_add_char_descr_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_delete_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_start_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_stop_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_connect_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_disconnect_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_congest_evt_param + :members: + +.. doxygenstruct:: esp_ble_gatts_cb_param_t::gatts_rsp_evt_param + :members: + + +Functions +^^^^^^^^^ + +.. doxygenfunction:: esp_ble_gatts_register_callback +.. doxygenfunction:: esp_ble_gatts_app_register +.. doxygenfunction:: esp_ble_gatts_app_unregister +.. doxygenfunction:: esp_ble_gatts_create_service +.. doxygenfunction:: esp_ble_gatts_add_included_service +.. doxygenfunction:: esp_ble_gatts_add_char +.. doxygenfunction:: esp_ble_gatts_add_char_descr +.. doxygenfunction:: esp_ble_gatts_delete_service +.. doxygenfunction:: esp_ble_gatts_start_service +.. doxygenfunction:: esp_ble_gatts_stop_service +.. doxygenfunction:: esp_ble_gatts_send_indicate +.. doxygenfunction:: esp_ble_gatts_send_response +.. doxygenfunction:: esp_ble_gatts_open +.. doxygenfunction:: esp_ble_gatts_close + diff --git a/docs/api/vhci.rst b/docs/api/vhci.rst new file mode 100644 index 000000000..0d5d8b5ff --- /dev/null +++ b/docs/api/vhci.rst @@ -0,0 +1,41 @@ +VHCI +==== + +Overview +-------- + +`Instructions`_ + +Application Example +------------------- + +Check `/examples `_ folder of `espressif/esp-idf `_ repository, that contains the following example: + +`05_ble_adv `_ + + This is a BLE advertising demo with virtual HCI interface. Send Reset/ADV_PARAM/ADV_DATA/ADV_ENABLE HCI command for BLE advertising. + +`Instructions`_ + +.. _Instructions: template.html + +API Reference +------------- + +Header Files +^^^^^^^^^^^^ + + * `bt/include/bt.h `_ + +Type Definitions +^^^^^^^^^^^^^^^^ + +.. doxygenstruct:: vhci_host_callback + +Functions +^^^^^^^^^ + +.. doxygenfunction:: API_vhci_host_check_send_available +.. doxygenfunction:: API_vhci_host_register_callback +.. doxygenfunction:: API_vhci_host_send_packet +.. doxygenfunction:: bt_controller_init