mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00

History

Angus Gratton 2d22fbd4ff cmake: Add missing example CMakeLists.txt files, CI check all examples have both		2018-08-28 11:11:57 +08:00
..
main	nvs_flash: Version compatibility check for nvs storage	2018-08-08 12:43:50 +05:30
CMakeLists.txt	cmake: Add missing example CMakeLists.txt files, CI check all examples have both	2018-08-28 11:11:57 +08:00
Makefile	example/hid: Added the BLE hid device profile.	2018-04-19 11:44:51 +08:00
README.md	example/hid: Added the readme file.	2018-04-20 09:20:44 -04:00
sdkconfig.defaults	example/hid: Added the BLE hid device profile.	2018-04-19 11:44:51 +08:00

README.md

ESP-IDF BLE HID device demo

This example Implemented BLE HID device profile related functions, in which the HID device has 4 Reports (1 is mouse, 2 is keyboard and LED, 3 is Consumer Devices, 4 is Vendor devices). Users can choose different reports according to their own application scenarios. BLE HID profile inheritance and USB HID class.

ble_hidd_demo_main.c

This file is the demo to show how to used the HID(you can used it to connected to the smart phone act as the consumer device then can used the button to volume++ or volume-- etc., or connected to the Windows 10 PC act as a keyboard or mouse)

hidd_le_prf_int.h

This header file includes some HID profile related definitions.

esp_hidd_prf_api.h & esp_hidd_prf_api.c

These files contains the the api of the HID profile

When you used the HID profile, you just need to added the esp_hidd_prf_api.h includes file and send the HID data used the function defined in the esp_hidd_prf_api.c file.

hid_dev.h & hid_dev.c

These file define the HID spec related definitions

hid_device_le_prf.c

This file is the HID profile definition file, it include the main function of the HID profile. It mainly includes how to create HID service. If you send and receive HID data and convert the data to keyboard keys, the mouse and consumer values are forwarded to the application.