kopia lustrzana https://github.com/espressif/esp-idf
component/docs: enable generation of API-reference documents for Bluetooth HID device
rodzic
199d72c19c
commit
0760a969a8
|
@ -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',
|
||||
|
|
|
@ -153,6 +153,7 @@ api-reference/bluetooth/esp_a2dp
|
|||
api-reference/bluetooth/esp_blufi
|
||||
api-reference/bluetooth/bt_le
|
||||
api-reference/bluetooth/esp_hf_defs
|
||||
api-reference/bluetooth/esp_hidd
|
||||
api-reference/bluetooth/esp_gap_bt
|
||||
api-reference/bluetooth/esp_gatt_defs
|
||||
api-reference/bluetooth/esp-ble-mesh
|
||||
|
|
|
@ -55,6 +55,7 @@ INPUT = \
|
|||
$(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_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/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 \
|
||||
|
|
|
@ -11,3 +11,4 @@ CLASSIC BT
|
|||
BT HFP Define <esp_hf_defs>
|
||||
BT HFP Client <esp_hf_client>
|
||||
BT HFP AG <esp_hf_ag>
|
||||
BT HID DEVICE <esp_hidd>
|
||||
|
|
|
@ -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
|
|
@ -0,0 +1 @@
|
|||
.. include:: ../../../en/api-reference/bluetooth/esp_hidd.rst
|
Ładowanie…
Reference in New Issue