mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
docs: fixed missing API-reference documents for Bluetooth HID device
# Conflicts: # docs/docs_not_updated/esp32c2.txt # docs/doxygen/Doxyfile
This commit is contained in:
parent
63f78a82f0
commit
a91d53f04f
@ -39,6 +39,7 @@ BT_DOCS = ['api-guides/blufi.rst',
|
|||||||
CLASSIC_BT_DOCS = ['api-reference/bluetooth/classic_bt.rst',
|
CLASSIC_BT_DOCS = ['api-reference/bluetooth/classic_bt.rst',
|
||||||
'api-reference/bluetooth/esp_a2dp.rst',
|
'api-reference/bluetooth/esp_a2dp.rst',
|
||||||
'api-reference/bluetooth/esp_avrc.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_defs.rst',
|
||||||
'api-reference/bluetooth/esp_hf_client.rst',
|
'api-reference/bluetooth/esp_hf_client.rst',
|
||||||
'api-reference/bluetooth/esp_hf_ag.rst',
|
'api-reference/bluetooth/esp_hf_ag.rst',
|
||||||
|
@ -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_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_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_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_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_client_api.h \
|
||||||
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_hf_ag_api.h \
|
$(PROJECT_PATH)/components/bt/host/bluedroid/api/include/api/esp_hf_ag_api.h \
|
||||||
|
@ -11,3 +11,4 @@ CLASSIC BT
|
|||||||
BT HFP Define <esp_hf_defs>
|
BT HFP Define <esp_hf_defs>
|
||||||
BT HFP Client <esp_hf_client>
|
BT HFP Client <esp_hf_client>
|
||||||
BT HFP AG <esp_hf_ag>
|
BT HFP AG <esp_hf_ag>
|
||||||
|
BT HID DEVICE <esp_hidd>
|
||||||
|
19
docs/en/api-reference/bluetooth/esp_hidd.rst
Normal file
19
docs/en/api-reference/bluetooth/esp_hidd.rst
Normal file
@ -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
|
1
docs/zh_CN/api-reference/bluetooth/esp_hidd.rst
Normal file
1
docs/zh_CN/api-reference/bluetooth/esp_hidd.rst
Normal file
@ -0,0 +1 @@
|
|||||||
|
.. include:: ../../../en/api-reference/bluetooth/esp_hidd.rst
|
Loading…
Reference in New Issue
Block a user