• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.bluetooth.hid (蓝牙hid模块)
2
3hid模块提供了访问蓝牙hid相关功能的方法。
4
5> **说明：**
6>
7> 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
8
9
10
11## 导入模块
12
13```js
14import hid from '@ohos.bluetooth.hid';
15```
16
17
18## hid.createHidHostProfile<a name="createHidHostProfile"></a>
19
20createHidHostProfile(): HidHostProfile
21
22创建hid profile实例。
23
24**系统能力**：SystemCapability.Communication.Bluetooth.Core。
25
26**返回值：**
27
28| 类型                            | 说明         |
29| ----------------------------- | ---------- |
30| HidHostProfile | 返回该profile的实例。 |
31
32**示例：**
33
34```js
35import { BusinessError } from '@ohos.base';
36try {
37    let hidHostProfile = hid.createHidHostProfile();
38    console.info('hidHost success');
39} catch (err) {
40    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
41}
42```
43
44
45## HidHostProfile
46
47使用HidHostProfile方法之前需要创建该类的实例进行操作，通过createHidHostProfile()方法构造此实例。
48
49
50### connect<a name="HidHost-connect"></a>
51
52connect(deviceId: string): void
53
54连接设备的HidHost服务。
55
56**系统接口**：此接口为系统接口。
57
58**需要权限**：ohos.permission.ACCESS_BLUETOOTH 和 ohos.permission.MANAGE_BLUETOOTH
59
60**系统能力**：SystemCapability.Communication.Bluetooth.Core。
61
62**参数：**
63
64| 参数名    | 类型     | 必填   | 说明      |
65| ------ | ------ | ---- | ------- |
66| deviceId | string | 是    | 远端设备地址。 |
67
68**错误码**：
69
70以下错误码的详细介绍请参见[蓝牙服务子系统错误码](../errorcodes/errorcode-bluetoothManager.md)。
71
72| 错误码ID | 错误信息 |
73| -------- | ---------------------------- |
74|2900001 | Service stopped.                         |
75|2900003 | Bluetooth switch is off.                 |
76|2900004 | Profile is not supported.                |
77|2900099 | Operation failed.                        |
78
79**示例：**
80
81```js
82import { BusinessError } from '@ohos.base';
83try {
84    let hidHostProfile = hid.createHidHostProfile();
85    hidHostProfile.connect('XX:XX:XX:XX:XX:XX');
86} catch (err) {
87    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
88}
89```
90
91
92### disconnect<a name="HidHost-disconnect"></a>
93
94disconnect(deviceId: string): void
95
96断开连接设备的HidHost服务。
97
98**系统接口**：此接口为系统接口。
99
100**需要权限**：ohos.permission.ACCESS_BLUETOOTH 和 ohos.permission.MANAGE_BLUETOOTH
101
102**系统能力**：SystemCapability.Communication.Bluetooth.Core。
103
104**参数：**
105
106| 参数名    | 类型     | 必填   | 说明      |
107| ------ | ------ | ---- | ------- |
108| deviceId | string | 是    | 远端设备地址。 |
109
110**错误码**：
111
112以下错误码的详细介绍请参见[蓝牙服务子系统错误码](../errorcodes/errorcode-bluetoothManager.md)。
113
114| 错误码ID | 错误信息 |
115| -------- | ---------------------------- |
116|2900001 | Service stopped.                         |
117|2900003 | Bluetooth switch is off.                 |
118|2900004 | Profile is not supported.                |
119|2900099 | Operation failed.                        |
120
121**示例：**
122
123```js
124import { BusinessError } from '@ohos.base';
125try {
126    let hidHostProfile = hid.createHidHostProfile();
127    hidHostProfile.disconnect('XX:XX:XX:XX:XX:XX');
128} catch (err) {
129    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
130}
131```