pioduino/esp-idf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge branch 'docs/update_esp_hid_device' into 'master'

Browse Source 
[docs] fix documents for Bluetooth HID Device API reference and example

See merge request espressif/esp-idf!17558
This commit is contained in:
Jiang Jiang Jian
2022-05-05 23:58:07 +08:00
parent 76be0c2624 bed86d8a27
commit 34211f898c
9 changed files with 493 additions and 172 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-reference/bluetooth/classic_bt.rst
+1
View File
@@ -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>
docs/en/api-reference/bluetooth/esp_hidd.rst
+19
View 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