• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# HID DDK开发指导
2
3## 场景介绍
4
5HID DDK（HID Driver Develop Kit）是为开发者提供的HID设备驱动程序开发套件，支持开发者基于用户态，在应用层开发HID设备驱动。提供了一系列主机侧访问设备的接口，包括创建设备、向设备发送事件、销毁设备。
6
7## 接口说明
8
9| 名称 | 描述 |
10| -------- | -------- |
11| OH_Hid_CreateDevice(Hid_Device *hidDevice, Hid_EventProperties *hidEventProperties) | 创建HID设备。请在设备使用完后使用OH_Hid_DestroyDevice销毁设备 |
12| OH_Hid_EmitEvent(int32_t deviceId, const Hid_EmitItem items[], uint16_t length) | 向指定deviceId的HID设备发送事件。 |
13| OH_Hid_DestroyDevice(int32_t deviceId) | 销毁指定deviceId的HID设备。 |
14
15详细的接口说明请参考[HID DDK](../reference/apis-driverdevelopment-kit/_hid_ddk.md)。
16
17## HID DDK开发步骤
18
19以下步骤描述了如何使用 **HID DDK**开发HID设备驱动：
20
21**添加动态链接库**
22
23CMakeLists.txt中添加以下lib。
24```txt
25libhid.z.so
26```
27
28**头文件**
29```c++
30#include <hid/hid_ddk_api.h>
31#include <hid/hid_ddk_types.h>
32```
33
341. **创建设备**。使用 **hid_ddk_api.h** 的 **OH_Hid_CreateDevice** 接口创建HID设备，成功返回设备deviceId（**非负数**），失败返回错误码（**负数**）。
35
36    ```c++
37   // 构建HID设备属性
38   std::vector<Hid_DeviceProp> deviceProp = {HID_PROP_DIRECT};
39   std::string deviceName = "keyboard"
40   Hid_Device hidDevice = {
41       .deviceName = deviceName.c_str(),
42       .vendorId = 0x6006,
43       .productId = 0x6006,
44       .version = 1,
45       .bustype = 3,
46       .properties = deviceProp.data(),
47       .propLength = (uint16_t)deviceProp.size()
48   };
49   // 构建HID设备关注的事件属性
50   std::vector<Hid_EventType> eventType = {HID_EV_ABS, HID_EV_KEY, HID_EV_SYN, HID_EV_MSC};
51   Hid_EventTypeArray eventTypeArray = {.hidEventType = eventType.data(), .length = (uint16_t)eventType.size()};
52   std::vector<Hid_KeyCode> keyCode = {HID_BTN_TOOL_PEN, HID_BTN_TOOL_RUBBER, HID_BTN_TOUCH, HID_BTN_STYLUS, HID_BTN_RIGHT};
53   Hid_KeyCodeArray keyCodeArray = {.hidKeyCode = keyCode.data(), .length = (uint16_t)keyCode.size()};
54   std::vector<Hid_MscEvent> mscEvent = {HID_MSC_SCAN};
55   Hid_MscEventArray mscEventArray = {.hidMscEvent = mscEvent.data(), .length = (uint16_t)mscEvent.size()};
56   std::vector<Hid_AbsAxes> absAxes = {HID_ABS_X, HID_ABS_Y, HID_ABS_PRESSURE};
57   Hid_AbsAxesArray absAxesArray = {.hidAbsAxes = absAxes.data(), .length = (uint16_t)absAxes.size()};
58   Hid_EventProperties hidEventProp = {
59       .hidEventTypes = eventTypeArray,
60       .hidKeys = keyCodeArray,
61       .hidAbs = absAxesArray,
62       .hidMiscellaneous = mscEventArray
63    };
64    // 创建设备并获取到deviceId
65    int32_t deviceId = OH_Hid_CreateDevice(&hidDevice, &hidEventProp);
66    ```
67
682. **向指定deviceId的HID设备发送事件**。使用 **hid_ddk_api.h** 的 **OH_Hid_EmitEvent** 向指定的deviceId的设备发送事件。
69
70    ```c++
71    // 构建需要发送事件
72    Hid_EmitItem event = {.type = HID_EV_MSC, .code = HID_MSC_SCAN, .value = 0x000d0042};
73    std::vector<Hid_EmitItem> itemVec;
74    itemVec.push_back(event);
75    // 向指定deviceId的HID设备发送事件
76    int32_t ret = OH_Hid_EmitEvent(deviceId, itemVec.data(), (uint16_t)itemVec.size());
77    ```
78
793. **释放资源**。在所有请求处理完毕，程序退出前，使用 **hid_ddk_api.h** 的 **OH_Hid_DestroyDevice** 接口销毁HID设备。
80
81    ```c++
82    // 销毁HID设备
83    int32_t ret = OH_Hid_DestroyDevice(deviceId);
84    ```