diff --git a/docs/conf_common.py b/docs/conf_common.py index 7c84489f48..5e9753d633 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -39,6 +39,7 @@ BT_DOCS = ['api-guides/blufi.rst', 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_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 b277dadd32..d51406481f 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -51,6 +51,7 @@ INPUT = \ $(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_a2dp_api.h \ $(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_avrc_api.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_hf_defs.h \ $(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_hf_client_api.h \ $(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_hf_ag_api.h \ diff --git a/docs/en/api-reference/bluetooth/classic_bt.rst b/docs/en/api-reference/bluetooth/classic_bt.rst index 5ddd4f7ffa..d1d78fbf9c 100644 --- a/docs/en/api-reference/bluetooth/classic_bt.rst +++ b/docs/en/api-reference/bluetooth/classic_bt.rst @@ -11,3 +11,4 @@ CLASSIC BT BT HFP Define BT HFP Client BT HFP AG + BT HID DEVICE diff --git a/docs/en/api-reference/bluetooth/esp_hidd.rst b/docs/en/api-reference/bluetooth/esp_hidd.rst new file mode 100644 index 0000000000..55e529df7d --- /dev/null +++ b/docs/en/api-reference/bluetooth/esp_hidd.rst @@ -0,0 +1,19 @@ +Bluetooth HID Device API +======================== + +Overview +-------- + +A Bluetooth HID device is a device providing the service of human or other data input and output to and from a Bluetooth HID Host. Users can use the Bluetooth HID Device APIs to make devices like keyboards, mice, joysticks and so on. + +Application Example +------------------- + +Check :example:`bluetooth/bluedroid/classic_bt` folder in ESP-IDF examples, which contains the following application: + +* This is an example of Bluetooth HID mouse device. The device running this example can be discovered and connected by a Bluetooth HID Host device such as a PC, and the pointer will move left and right after HID connection is established - :example:`bluetooth/bluedroid/classic_bt/bt_hid_mouse_device` + +API Reference +------------- + +.. include-build-file:: inc/esp_hidd_api.inc diff --git a/docs/zh_CN/api-reference/bluetooth/esp_hidd.rst b/docs/zh_CN/api-reference/bluetooth/esp_hidd.rst new file mode 100644 index 0000000000..8140f3552e --- /dev/null +++ b/docs/zh_CN/api-reference/bluetooth/esp_hidd.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/bluetooth/esp_hidd.rst