Mirrors/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-08-18 06:35:35 +03:00
Code Issues Packages Projects Releases Wiki Activity

component/docs: enable generation of API-reference documents for Bluetooth HID host

Browse Source
This commit is contained in:
wangmengyang
2022-03-25 18:20:37 +08:00
committed by gongyantao
parent e5899f6a70
commit 5fa5f7b2fe
6 changed files with 51 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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