alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-16 06:54:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'docs/update_esp_hid_host_v5.1' into 'release/v5.1'

Browse Source 
[docs] fix documents for Bluetooth HID Host API reference (backport v5.1)

See merge request espressif/esp-idf!24389
This commit is contained in:
Jiang Jiang Jian
2023-07-04 12:14:22 +08:00
parent 56bb50b85e 5fa5f7b2fe
commit 09f2ab841f
6 changed files with 97 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/en/api-reference/bluetooth/classic_bt.rst
View File

@@ -12,5 +12,6 @@ CLASSIC BT
BT HFP Client <esp_hf_client>
BT HFP AG <esp_hf_ag>
BT HID DEVICE <esp_hidd>
BT HID HOST <esp_hidh>
BT L2CAP <esp_l2cap_bt>
BT SDP <esp_sdp>

20
docs/en/api-reference/bluetooth/esp_hidh.rst Normal file
View File

@@ -0,0 +1,20 @@
Bluetooth HID Host API
========================
Overview
--------
A Bluetooth HID host is a device or software that is capable of connecting and communicating with Bluetooth HID devices, such as keyboards, mice. Users can use the Bluetooth HID Host APIs to send output data or control commands to the HID devices, enabling them to control the behavior or settings of the devices.
Application Example
-------------------
Check :example:`bluetooth` folder in ESP-IDF examples, which contains the following application:
* Example :example:`bluetooth/esp_hid_host` is implemented using the generic esp_hid APIs. esp_hid APIs are build upon the Bluetooth HID APIs and can be a reference.
API Reference
-------------
.. include-build-file:: inc/esp_hidh_api.inc