• 日期: 2027-02-21 16:35:33
  • 标签: 常规

这个库是用于将一个 ESP32 设备转换为一个 HID 键盘或多媒体控制器的 BLE 设备的库。它提供了一个 API 来设置设备名称、制造商、电池级别和回调函数，并允许用户发送按键和媒体控制命令到连接的 BLE 设备。它还提供了一个 BLE 连接状态对象，可以用来检查设备是否连接。

代码示例

#include <BLEDevice.h>
#include <BLEUtils.h>
#include <BLEServer.h>
#include 'BLE2902.h'
#include 'BLEHIDDevice.h'
#include 'HIDTypes.h'
#include <driver/adc.h>
#include "sdkconfig.h"

#include "BleConnectionStatus.h"
#include "Hid2Ble.h"
#include "BLECharacteristic.h"

// Report IDs:
#define KEYBOARD_ID 0x01
#define MEDIA_KEYS_ID 0x02

static const uint8_t _hidReportDescriptor[] = {
	USAGE_PAGE(1), 0x01, // USAGE_PAGE (Generic Desktop Ctrls)
	USAGE(1), 0x06,		 // USAGE (Keyboard)
	COLLECTION(1), 0x01, // COLLECTION (Application)
	// ------------------------------------------------- Keyboard
	REPORT_ID(1), KEYBOARD_ID, //   REPORT_ID (1)
	USAGE_PAGE(1), 0x07,	   //   USAGE_PAGE (Kbrd/Keypad)
	USAGE_MINIMUM(1), 0xE0,	   //   USAGE_MINIMUM (0xE0)
	USAGE_MAXIMUM(1), 0xE7,	   //   USAGE_MAXIMUM (0xE7)
	LOGICAL_MINIMUM(1), 0x00,  //   LOGICAL_MINIMUM (0)
	LOGICAL_MAXIMUM(1), 0x01,  //   Logical Maximum (1)
	REPORT_SIZE(1), 0x01,	   //   REPORT_SIZE (1)
	REPORT_COUNT(1), 0x08,	   //   REPORT_COUNT (8)
	HIDINPUT(1), 0x02,		   //   INPUT (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position)
	REPORT_COUNT(1), 0x01,	   //   REPORT_COUNT (1) ; 1 byte (Reserved)
	REPORT_SIZE(1), 0x08,	   //   REPORT_SIZE (8)
	HIDINPUT(1), 0x01,		   //   INPUT (Const,Array,Abs,No Wrap,Linear,Preferred State,No Null Position)
	REPORT_COUNT(1), 0x05,	   //   REPORT_COUNT (5) ; 5 bits (Num lock, Caps lock, Scroll lock, Compose, Kana)
	REPORT_SIZE(1), 0x01,	   //   REPORT_SIZE (1)
	USAGE_PAGE(1), 0x08,	   //   USAGE_PAGE (LEDs)
	USAGE_MINIMUM(1), 0x01,	   //   USAGE_MINIMUM (0x01) ; Num Lock
	USAGE_MAXIMUM(1), 0x05,	   //   USAGE_MAXIMUM (0x05) ; Kana
	HIDOUTPUT(1), 0x02,		   //   OUTPUT (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position,Non-volatile)
	REPORT_COUNT(1), 0x01,	   //   REPORT_COUNT (1) ; 3 bits (Padding)
	REPORT_SIZE(1), 0x03,	   //   REPORT_SIZE (3)
	HIDOUTPUT(1), 0x01,		   //   OUTPUT (Const,Array,Abs,No Wrap,Linear,Preferred State,No Null Position,Non-volatile)
	REPORT_COUNT(1), 0x06,	   //   REPORT_COUNT (6) ; 6 bytes (Keys)
	REPORT_SIZE(1), 0x08,	   //   REPORT_SIZE(8)
	LOGICAL_MINIMUM(1), 0x00,  //   LOGICAL_MINIMUM(0)
	LOGICAL_MAXIMUM(1), 0x65,  //   LOGICAL_MAXIMUM (0x65) ; 101 keys
	USAGE_PAGE(1), 0x07,	   //   USAGE_PAGE (Kbrd/Keypad)
	USAGE_MINIMUM(1), 0x00,	   //   USAGE_MINIMUM (0)
	USAGE_MAXIMUM(1), 0x65,	   //   USAGE_MAXIMUM (0x65)
	HIDINPUT(1), 0x00,		   //   INPUT (Data,Array,Abs,No Wrap,Linear,Preferred State,No Null Position)
	END_COLLECTION(0),		   // END_COLLECTION
	// ------------------------------------------------- Media Keys
	USAGE_PAGE(1), 0x0C,		 // USAGE_PAGE (Consumer)
	USAGE(1), 0x01,				 // USAGE (Consumer Control)
	COLLECTION(1), 0x01,		 // COLLECTION (Application)
	REPORT_ID(1), MEDIA_KEYS_ID, //   REPORT_ID (3)
	USAGE_PAGE(1), 0x0C,		 //   USAGE_PAGE (Consumer)
	LOGICAL_MINIMUM(1), 0x00,	 //   LOGICAL_MINIMUM (0)
	LOGICAL_MAXIMUM(1), 0x01,	 //   LOGICAL_MAXIMUM (1)
	REPORT_SIZE(1), 0x01,		 //   REPORT_SIZE (1)
	REPORT_COUNT(1), 0x10,		 //   REPORT_COUNT (16)
	USAGE(1), 0xB5,				 //   USAGE (Scan Next Track)     ; bit 0: 1
	USAGE(1), 0xB6,				 //   USAGE (Scan Previous Track) ; bit 1: 2
	USAGE(1), 0xB7,				 //   USAGE (Stop)                ; bit 2: 4
	USAGE(1), 0xCD,				 //   USAGE (Play/Pause)          ; bit 3: 8
	USAGE(1), 0xE2,				 //   USAGE (Mute)                ; bit 4: 16
	USAGE(1), 0xE9,				 //   USAGE (Volume Increment)    ; bit 5: 32
	USAGE(1), 0xEA,				 //   USAGE (Volume Decrement)    ; bit 6: 64
	USAGE(2), 0x23, 0x02,		 //   Usage (WWW Home)            ; bit 7: 128
	USAGE(2), 0x94, 0x01,		 //   Usage (My Computer) ; bit 0: 1
	USAGE(2), 0x92, 0x01,		 //   Usage (Calculator)  ; bit 1: 2
	USAGE(2), 0x2A, 0x02,		 //   Usage (WWW fav)     ; bit 2: 4
	USAGE(2), 0x21, 0x02,		 //   Usage (WWW search)  ; bit 3: 8
	USAGE(2), 0x26, 0x02,		 //   Usage (WWW stop)    ; bit 4: 16
	USAGE(2), 0x24, 0x02,		 //   Usage (WWW back)    ; bit 5: 32
	USAGE(2), 0x83, 0x01,		 //   Usage (Media sel)   ; bit 6: 64
	USAGE(2), 0x8A, 0x01,		 //   Usage (Mail)        ; bit 7: 128
	HIDINPUT(1), 0x02,			 //   INPUT (Data,Var,Abs,No Wrap,Linear,Preferred State,No Null Position)
	END_COLLECTION(0)			 // END_COLLECTION
};

Hid2Ble::Hid2Ble(std::string deviceName, std::string deviceManufacturer, uint8_t batteryLevel) : hid(0)
{
	this->deviceName = deviceName;
	this->deviceManufacturer = deviceManufacturer;
	this->batteryLevel = batteryLevel;
	this->connectionStatus = new BleConnectionStatus();
}

void Hid2Ble::begin(void)
{
	xTaskCreate(this->taskServer, "server", 20000, (void *)this, 5, NULL);
}

void Hid2Ble::end(void)
{
}

bool Hid2Ble::isConnected(void)
{
	return this->connectionStatus->connected;
}

void Hid2Ble::setBatteryLevel(uint8_t level)
{
	this->batteryLevel = level;
	this->hid->setBatteryLevel(this->batteryLevel);
}

void Hid2Ble::setCallBack(BLECharacteristicCallbacks *callBack)
{
	this->callBack = callBack;
}

void Hid2Ble::taskServer(void *pvParameter)
{
	Hid2Ble *bleKeyboardInstance = (Hid2Ble *)pvParameter; //static_cast<BleKeyboard *>(pvParameter);
	BLEDevice::init(bleKeyboardInstance->deviceName);
	BLEServer *pServer = BLEDevice::createServer();
	pServer->setCallbacks(bleKeyboardInstance->connectionStatus);

	bleKeyboardInstance->hid = new BLEHIDDevice(pServer);
	bleKeyboardInstance->inputKeyboard = bleKeyboardInstance->hid->inputReport(KEYBOARD_ID); // <-- input REPORTID from report map
	bleKeyboardInstance->outputKeyboard = bleKeyboardInstance->hid->outputReport(KEYBOARD_ID);
	bleKeyboardInstance->inputMediaKeys = bleKeyboardInstance->hid->inputReport(MEDIA_KEYS_ID);
	bleKeyboardInstance->connectionStatus->inputKeyboard = bleKeyboardInstance->inputKeyboard;
	bleKeyboardInstance->connectionStatus->outputKeyboard = bleKeyboardInstance->outputKeyboard;
	bleKeyboardInstance->connectionStatus->inputMediaKeys = bleKeyboardInstance->inputMediaKeys;

	bleKeyboardInstance->outputKeyboard->setCallbacks(bleKeyboardInstance->callBack);

	bleKeyboardInstance->hid->manufacturer()->setValue(bleKeyboardInstance->deviceManufacturer);

	bleKeyboardInstance->hid->pnp(0x02, 0xe502, 0xa111, 0x0210);
	bleKeyboardInstance->hid->hidInfo(0x00, 0x01);

	BLESecurity *pSecurity = new BLESecurity();

	pSecurity->setAuthenticationMode(ESP_LE_AUTH_BOND);

	bleKeyboardInstance->hid->reportMap((uint8_t *)_hidReportDescriptor, sizeof(_hidReportDescriptor));
	bleKeyboardInstance->hid->startServices();
	bleKeyboardInstance->hid->setBatteryLevel(bleKeyboardInstance->batteryLevel);
	bleKeyboardInstance->onStarted(pServer);

	BLEAdvertising *pAdvertising = pServer->getAdvertising();
	pAdvertising->setAppearance(HID_KEYBOARD);
	pAdvertising->addServiceUUID(bleKeyboardInstance->hid->hidService()->getUUID());
	pAdvertising->addServiceUUID(bleKeyboardInstance->hid->deviceInfo()->getUUID());
	pAdvertising->addServiceUUID(bleKeyboardInstance->hid->batteryService()->getUUID());

	pAdvertising->start();

	vTaskDelay(portMAX_DELAY); //delay(portMAX_DELAY);
}

void Hid2Ble::send2Ble(char *keys)
{
	if (this->isConnected())
	{
		this->inputKeyboard->setValue((uint8_t *)keys, 8);
		this->inputKeyboard->notify();
	}
}
void Hid2Ble::sendMedia2Ble(char *keys)
{
	if (this->isConnected())
	{
		this->inputMediaKeys->setValue((uint8_t *)keys, 2);
		this->inputMediaKeys->notify();
	}
}

使用方法

  1. 创建一个 Hid2Ble 对象
  2. 使用 begin() 方法启动 BLE 服务
  3. 使用 send2Ble() 方法发送键盘按键
  4. 使用 sendMedia2Ble() 方法发送媒体控制命令

特性

  • 支持 HID 键盘和多媒体控制
  • 可自定义设备名称、制造商和电池级别
  • 提供连接状态信息
  • 支持回调函数

安装

arduino-cli lib install BLEDevice
arduino-cli lib install BLEUtils
arduino-cli lib install BLEServer
arduino-cli lib install BLE2902
arduino-cli lib install BLEHIDDevice
arduino-cli lib install HIDTypes
arduino-cli lib install BleConnectionStatus
arduino-cli lib install Hid2Ble

注意事项

  • 此库需要 ESP32 芯片
  • 确保已经安装了 Arduino IDE 和 ESP32 开发板的驱动程序

示例代码

#include "Hid2Ble.h"

Hid2Ble bleKeyboard("MyKeyboard", "MyCompany", 100);

void setup() {
  Serial.begin(115200);
  bleKeyboard.begin();
}

void loop() {
  // 发送键盘按键
  bleKeyboard.send2Ble((char *) {0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00});

  // 发送媒体控制命令
  bleKeyboard.sendMedia2Ble((char *) {0x01, 0x00});

  delay(1000);
}

资源

作者

Your Name

ESP32 HID 键盘/媒体控制 BLE 库

原文地址: http://www.cveoy.top/t/topic/nD89 著作权归作者所有。请勿转载和采集!

免费AI点我,无需注册和登录