@ohos.bluetoothManager (Bluetooth) (System API)

The Bluetooth module provides classic Bluetooth capabilities and Bluetooth Low Energy (BLE) scan and advertising.

NOTE

• The initial APIs of this module are supported since API version 9. Newly added APIs will be marked with a superscript to indicate their earliest API version.
• The APIs provided by this module are no longer maintained since API version 10. You are advised to use profile APIs of @ohos.bluetooth.ble.
• This topic describes only system APIs provided by the module. For details about its public APIs, see @ohos.bluetoothManager.

Modules to Import

import bluetoothManager from '@ohos.bluetoothManager';

bluetoothManager.cancelPairedDevice^(deprecated)

cancelPairedDevice(deviceId: string): void

Cancels a paired remote device.

NOTE
This API is supported since API version 9 and deprecated since API version 10. Use connection.cancelPairedDevice instead.

System API: This is a system API.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Name	Type	Mandatory	Description
deviceId	string	Yes	Address of the remote device to cancel, for example, XX:XX:XX:XX:XX:XX.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications are not allowed to use system APIs.
401	Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
801	Capability not supported.
2900001	Service stopped.
2900003	Bluetooth disabled.
2900099	Operation failed.

Example

import { BusinessError } from '@ohos.base';
try {
    bluetoothManager.cancelPairedDevice("XX:XX:XX:XX:XX:XX");
} catch (err) {
    console.error("errCode:" + (err as BusinessError).code + ",errMessage:" + (err as BusinessError).message);
}

connect

connect(device: string): void

Connects to the HidHost service of a device.

NOTE
This API is supported since API version 9 and deprecated since API version 10. Use hid.HidHostProfile#connect instead.

System API: This is a system API.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Name	Type	Mandatory	Description
device	string	Yes	Address of the target device.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications are not allowed to use system APIs.
401	Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
801	Capability not supported.
2900001	Service stopped.
2900003	Bluetooth disabled.
2900004	Profile not supported.
2900099	Operation failed.

Example

import { BusinessError } from '@ohos.base';
try {
    let hidHostProfile: bluetoothManager.HidHostProfile = bluetoothManager.getProfileInstance(bluetoothManager.ProfileId.PROFILE_HID_HOST) as bluetoothManager.HidHostProfile;
    hidHostProfile.connect('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error("errCode:" + (err as BusinessError).code + ",errMessage:" + (err as BusinessError).message);
}

disconnect^(deprecated)

disconnect(device: string): void

Disconnects from the HidHost service of a device.

NOTE
This API is supported since API version 9 and deprecated since API version 10. Use hid.HidHostProfile#disconnect instead.

System API: This is a system API.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Name	Type	Mandatory	Description
device	string	Yes	Address of the target device.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications are not allowed to use system APIs.
401	Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
801	Capability not supported.
2900001	Service stopped.
2900003	Bluetooth disabled.
2900004	Profile not supported.
2900099	Operation failed.

Example

import { BusinessError } from '@ohos.base';
try {
    let hidHostProfile: bluetoothManager.HidHostProfile = bluetoothManager.getProfileInstance(bluetoothManager.ProfileId.PROFILE_HID_HOST) as bluetoothManager.HidHostProfile;
    hidHostProfile.disconnect('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error("errCode:" + (err as BusinessError).code + ",errMessage:" + (err as BusinessError).message);
}

disconnect^(deprecated)

disconnect(device: string): void

Disconnects from the Personal Area Network (PAN) service of a device.

NOTE
This API is supported since API version 9 and deprecated since API version 10. Use pan.PanProfile#disconnect instead.

System API: This is a system API.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Name	Type	Mandatory	Description
device	string	Yes	Address of the target device.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications are not allowed to use system APIs.
401	Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed.
801	Capability not supported.
2900001	Service stopped.
2900003	Bluetooth disabled.
2900004	Profile not supported.
2900099	Operation failed.

Example

import { BusinessError } from '@ohos.base';
try {
    let panProfile: bluetoothManager.PanProfile = bluetoothManager.getProfileInstance(bluetoothManager.ProfileId.PROFILE_PAN_NETWORK) as bluetoothManager.PanProfile;
    panProfile.disconnect('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error("errCode:" + (err as BusinessError).code + ",errMessage:" + (err as BusinessError).message);
}

setTethering^(deprecated)

setTethering(enable: boolean): void

Sets tethering.

NOTE
This API is supported since API version 9 and deprecated since API version 10. The substitute API is available only for system applications.

System API: This is a system API.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Name	Type	Mandatory	Description
value	boolean	Yes	Whether to set tethering over a Bluetooth PAN.

Error codes

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

ID	Error Message
201	Permission denied.
202	Non-system applications are not allowed to use system APIs.
401	Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types.
801	Capability not supported.
2900001	Service stopped.
2900003	Bluetooth disabled.
2900004	Profile not supported.
2900099	Operation failed.

Example

import { BusinessError } from '@ohos.base';
try {
    let panProfile: bluetoothManager.PanProfile = bluetoothManager.getProfileInstance(bluetoothManager.ProfileId.PROFILE_PAN_NETWORK) as bluetoothManager.PanProfile;
    panProfile.setTethering(true);
} catch (err) {
    console.error("errCode:" + (err as BusinessError).code + ",errMessage:" + (err as BusinessError).message);
}

isTetheringOn^(deprecated)

isTetheringOn(): boolean

Obtains the network sharing status.

NOTE
This API is supported since API version 9 and deprecated since API version 10. Use pan.PanProfile#isTetheringOn instead.

System API: This is a system API.

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Type	Description
boolean	Returns true if tethering is available over a Bluetooth PAN; return false otherwise.

Error codes

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

ID	Error Message
202	Non-system applications are not allowed to use system APIs.
801	Capability not supported.

Example

import { BusinessError } from '@ohos.base';
try {
    let panProfile: bluetoothManager.PanProfile = bluetoothManager.getProfileInstance(bluetoothManager.ProfileId.PROFILE_PAN_NETWORK) as bluetoothManager.PanProfile;
    panProfile.isTetheringOn();
} catch (err) {
    console.error("errCode:" + (err as BusinessError).code + ",errMessage:" + (err as BusinessError).message);
}