From b2987c1e946703cb48d4fff5a123902113d3b51d Mon Sep 17 00:00:00 2001 From: xiongweichao Date: Wed, 18 May 2022 15:48:21 +0800 Subject: [PATCH] Added BT_L2CAP API reference document --- docs/conf_common.py | 1 + docs/doxygen/Doxyfile | 1 + docs/en/api-reference/bluetooth/classic_bt.rst | 1 + docs/en/api-reference/bluetooth/esp_l2cap_bt.rst | 15 +++++++++++++++ .../api-reference/bluetooth/esp_l2cap_bt.rst | 1 + 5 files changed, 19 insertions(+) create mode 100644 docs/en/api-reference/bluetooth/esp_l2cap_bt.rst create mode 100644 docs/zh_CN/api-reference/bluetooth/esp_l2cap_bt.rst diff --git a/docs/conf_common.py b/docs/conf_common.py index a098a9db68..b33ae14699 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -40,6 +40,7 @@ CLASSIC_BT_DOCS = ['api-reference/bluetooth/classic_bt.rst', 'api-reference/bluetooth/esp_a2dp.rst', 'api-reference/bluetooth/esp_avrc.rst', 'api-reference/bluetooth/esp_hidd.rst', + 'api-reference/bluetooth/esp_l2cap_bt.rst', 'api-reference/bluetooth/esp_hf_defs.rst', 'api-reference/bluetooth/esp_hf_client.rst', 'api-reference/bluetooth/esp_hf_ag.rst', diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index 11a187fedc..4e70c392ab 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -56,6 +56,7 @@ INPUT = \ $(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_hf_defs.h \ $(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_spp_api.h \ $(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_hidd_api.h \ + $(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_l2cap_bt_api.h \ $(PROJECT_PATH)/components/bt/host/nimble/esp-hci/include/esp_nimble_hci.h \ $(PROJECT_PATH)/components/bt/include/esp32/include/esp_bt.h \ $(PROJECT_PATH)/components/console/esp_console.h \ diff --git a/docs/en/api-reference/bluetooth/classic_bt.rst b/docs/en/api-reference/bluetooth/classic_bt.rst index d1d78fbf9c..cc0df3b93b 100644 --- a/docs/en/api-reference/bluetooth/classic_bt.rst +++ b/docs/en/api-reference/bluetooth/classic_bt.rst @@ -12,3 +12,4 @@ CLASSIC BT BT HFP Client BT HFP AG BT HID DEVICE + BT L2CAP diff --git a/docs/en/api-reference/bluetooth/esp_l2cap_bt.rst b/docs/en/api-reference/bluetooth/esp_l2cap_bt.rst new file mode 100644 index 0000000000..38d6d13318 --- /dev/null +++ b/docs/en/api-reference/bluetooth/esp_l2cap_bt.rst @@ -0,0 +1,15 @@ +Clissic Bluetooth L2CAP API +============================ + +Application Example +------------------- + +Check :example:`bluetooth/bluedroid/classic_bt` folder in ESP-IDF examples, which contains the following application: + +* This is a BT_L2CAP demo. This demo can connect, send and recive L2CAP data :example:`bluetooth/bluedroid/classic_bt/bt_l2cap_client`, :example:`bluetooth/bluedroid/classic_bt/bt_l2cap_server` + +API Reference +------------- + +.. include-build-file:: inc/esp_l2cap_bt_api.inc + diff --git a/docs/zh_CN/api-reference/bluetooth/esp_l2cap_bt.rst b/docs/zh_CN/api-reference/bluetooth/esp_l2cap_bt.rst new file mode 100644 index 0000000000..24031e6367 --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/esp_l2cap_bt.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/esp_l2cap_bt.rst \ No newline at end of file