@ohos.bluetooth.hid (Bluetooth HID Module) (System API)

The hid module provides APIs for using the Bluetooth Human Interface Device Profile (HID).

NOTE

• The initial APIs of this module are supported since API version 10. Newly added APIs will be marked with a superscript to indicate their earliest API version.
• This topic describes only the system APIs provided by the module. For details about its public APIs, see @ohos.bluetooth.hid (Bluetooth HID Module).

Modules to Import

import hid from '@ohos.bluetooth.hid';

HidHostProfile

Before using any API of HidHostProfile, you need to create an instance of this class by using createHidHostProfile().

connect

connect(deviceId: string): void

Connects to the HidHost service of a device.

System API: This is a system API.

Required permissions: ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Error codes

For details about the error codes, see Bluetooth Error Codes.

Example

import { BusinessError } from '@ohos.base';
try {
    let hidHostProfile = hid.createHidHostProfile();
    hidHostProfile.connect('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
}

disconnect

disconnect(deviceId: string): void

Disconnects from the HidHost service of a device.

System API: This is a system API.

Required permissions: ohos.permission.ACCESS_BLUETOOTH and ohos.permission.MANAGE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Error codes

For details about the error codes, see Bluetooth Error Codes.

Example

import { BusinessError } from '@ohos.base';
try {
    let hidHostProfile = hid.createHidHostProfile();
    hidHostProfile.disconnect('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error('errCode: ' + (err as BusinessError).code + ', errMessage: ' + (err as BusinessError).message);
}