• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.bluetooth.hid (蓝牙hid模块)
2
3<!--Kit: Connectivity Kit-->
4<!--Subsystem: Communication-->
5<!--Owner: @enjoy_sunshine-->
6<!--Designer: @chengguohong; @tangjia15-->
7<!--Tester: @wangfeng517-->
8<!--Adviser: @zhang_yixin13-->
9
10本模块提供基于人机接口协议（Human Interface Device Profile，[HID](../../connectivity/terminology.md#hid)）技术的蓝牙人机交互能力，支持获取连接状态等方法。传统蓝牙HID和低功耗蓝牙[HOGP](../../connectivity/terminology.md#hogp)设备均可使用此模块API，相关功能都集成在此HID模块中。
11> **说明：**
12>
13> 本模块首批接口从API version 10开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
14
15## 导入模块
16
17```js
18import { hid } from '@kit.ConnectivityKit';
19```
20
21## BaseProfile
22
23type BaseProfile = baseProfile.BaseProfile
24
25基础Profile接口定义，提供订阅和获取连接状态等公共能力。
26
27**系统能力**：SystemCapability.Communication.Bluetooth.Core
28
29| 类型                            | 说明         |
30| ----------------------------- | ---------- |
31| [baseProfile.BaseProfile](js-apis-bluetooth-baseProfile.md#baseprofile) | 基础Profile接口定义。 |
32
33## hid.createHidHostProfile
34
35createHidHostProfile(): HidHostProfile
36
37创建蓝牙[HID Host](../../connectivity/terminology.md#hid-host)实例。通过该实例可使用本端作为HID Host的接口，如：获取和其他设备间的蓝牙HID连接状态。
38
39**系统能力**：SystemCapability.Communication.Bluetooth.Core
40
41**返回值：**
42
43| 类型                            | 说明         |
44| ----------------------------- | ---------- |
45| HidHostProfile | 返回HID Host实例。<br>- 该类继承于[BaseProfile](#baseprofile)，因此可以使用其父类中的方法。<br>- 和该实例角色相对应的是[HID Device](../../connectivity/terminology.md#hid-device)角色。 |
46
47**错误码**：
48
49以下错误码的详细介绍请参见[通用错误码说明文档](../errorcode-universal.md)。
50
51| 错误码ID | 错误信息 |
52| -------- | ---------------------------- |
53|401 | Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.                 |
54|801 | Capability not supported.          |
55
56**示例：**
57
58```js
59import { BusinessError } from '@kit.BasicServicesKit';
60
61try {
62    let hidHostProfile = hid.createHidHostProfile();
63    console.info('hidHost success');
64} catch (err) {
65    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
66}
67```
68