@ohos.bluetooth (Bluetooth)

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 7. 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 9. You are advised to use profile APIs of @ohos.bluetooth.ble.

Modules to Import

import bluetooth from '@ohos.bluetooth';

bluetooth.enableBluetooth^{8+(deprecated)}

enableBluetooth(): boolean

Enables Bluetooth.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.enableBluetooth.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

let enable : boolean = bluetooth.enableBluetooth();

bluetooth.disableBluetooth^{8+(deprecated)}

disableBluetooth(): boolean

Disables Bluetooth.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.disableBluetooth.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

let disable : boolean = bluetooth.disableBluetooth();

bluetooth.getLocalName^{8+(deprecated)}

getLocalName(): string

Obtains the name of the local Bluetooth device.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.getLocalName.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

let localName : string = bluetooth.getLocalName();

bluetooth.getState^(deprecated)

getState(): BluetoothState

Obtains the Bluetooth state.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.getState.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

let state : bluetooth.BluetoothState = bluetooth.getState();

bluetooth.getBtConnectionState^(deprecated)

getBtConnectionState(): ProfileConnectionState

Obtains the local profile connection state.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.getBtConnectionState.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

let connectionState : bluetooth.ProfileConnectionState = bluetooth.getBtConnectionState();

bluetooth.setLocalName^{8+(deprecated)}

setLocalName(name: string): boolean

Sets the name of the local Bluetooth device.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.setLocalName.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let ret : boolean = bluetooth.setLocalName('device_name');

bluetooth.pairDevice^(deprecated)

pairDevice(deviceId: string): boolean

Initiates Bluetooth pairing.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.pairDevice.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

// The address can be scanned.
let result : boolean = bluetooth.pairDevice("XX:XX:XX:XX:XX:XX");

bluetooth.getProfileConnState^{8+(deprecated)}

getProfileConnState(profileId: ProfileId): ProfileConnectionState

Obtains the connection status of the specified profile.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.getProfileConnectionState.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let result : bluetooth.ProfileConnectionState = bluetooth.getProfileConnState(bluetooth.ProfileId.PROFILE_A2DP_SOURCE);

bluetooth.cancelPairedDevice^{8+(deprecated)}

cancelPairedDevice(deviceId: string): boolean

Cancels a paired remote device.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.cancelPairedDevice.

System API: This is a system API.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let result : boolean = bluetooth.cancelPairedDevice("XX:XX:XX:XX:XX:XX");

bluetooth.getRemoteDeviceName^{8+(deprecated)}

getRemoteDeviceName(deviceId: string): string

Obtains the name of the remote Bluetooth device.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.getRemoteDeviceName.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let remoteDeviceName : string = bluetooth.getRemoteDeviceName("XX:XX:XX:XX:XX:XX");

bluetooth.getRemoteDeviceClass^{8+(deprecated)}

getRemoteDeviceClass(deviceId: string): DeviceClass

Obtains the class of the remote Bluetooth device.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.getRemoteDeviceClass.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let remoteDeviceClass : bluetooth.DeviceClass = bluetooth.getRemoteDeviceClass("XX:XX:XX:XX:XX:XX");

bluetooth.getPairedDevices^{8+(deprecated)}

getPairedDevices(): Array<string>

Obtains the paired devices.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.getPairedDevices.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

let devices : Array<string> = bluetooth.getPairedDevices();

bluetooth.setBluetoothScanMode^{8+(deprecated)}

setBluetoothScanMode(mode: ScanMode, duration: number): boolean

Sets the Bluetooth scan mode so that the device can be discovered by a remote device.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.setBluetoothScanMode.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

// The device can be discovered and connected only when the discoverable and connectable mode is used.
let result : boolean = bluetooth.setBluetoothScanMode(bluetooth.ScanMode
    .SCAN_MODE_CONNECTABLE_GENERAL_DISCOVERABLE, 100);

bluetooth.getBluetoothScanMode^{8+(deprecated)}

getBluetoothScanMode(): ScanMode

Obtains the Bluetooth scan mode.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.getBluetoothScanMode.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

let scanMode : bluetooth.ScanMode = bluetooth.getBluetoothScanMode();

bluetooth.startBluetoothDiscovery^{8+(deprecated)}

startBluetoothDiscovery(): boolean

Starts Bluetooth scan to discover remote devices.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.startBluetoothDiscovery.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH and ohos.permission.LOCATION

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

let deviceId : Array<string>;
function onReceiveEvent(data : Array<string>) {
    deviceId = data;
}
bluetooth.on('bluetoothDeviceFind', onReceiveEvent);
let result : boolean = bluetooth.startBluetoothDiscovery();

bluetooth.stopBluetoothDiscovery^{8+(deprecated)}

stopBluetoothDiscovery(): boolean

Stops Bluetooth scan.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.stopBluetoothDiscovery.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

let result : boolean = bluetooth.stopBluetoothDiscovery();

bluetooth.setDevicePairingConfirmation^{8+(deprecated)}

setDevicePairingConfirmation(device: string, accept: boolean): boolean

Sets the device pairing confirmation.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.setDevicePairingConfirmation.

Required permissions: ohos.permission.MANAGE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

// Subscribe to the pinRequired event and configure the pairing confirmation after receiving a pairing request from the remote device.
function onReceivePinRequiredEvent(data : bluetooth.PinRequiredParam) { // data is the input parameter for the pairing request.
    console.info('pin required  = '+ JSON.stringify(data));
    bluetooth.setDevicePairingConfirmation(data.deviceId, true);
}
bluetooth.on("pinRequired", onReceivePinRequiredEvent);

bluetooth.on('bluetoothDeviceFind')^{8+(deprecated)}

on(type: "bluetoothDeviceFind", callback: Callback<Array<string>>): void

Subscribes to the Bluetooth device discovery events.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.on('bluetoothDeviceFind').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function onReceiveEvent(data : Array<string>) { // data is an array of Bluetooth device addresses.
    console.info('bluetooth device find = '+ JSON.stringify(data));
}
bluetooth.on('bluetoothDeviceFind', onReceiveEvent);

bluetooth.off('bluetoothDeviceFind')^{8+(deprecated)}

off(type: "bluetoothDeviceFind", callback?: Callback<Array<string>>): void

Unsubscribes from the Bluetooth device discovery events.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.off('bluetoothDeviceFind').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function onReceiveEvent(data : Array<string>) {
    console.info('bluetooth device find = '+ JSON.stringify(data));
}
bluetooth.on('bluetoothDeviceFind', onReceiveEvent);
bluetooth.off('bluetoothDeviceFind', onReceiveEvent);

bluetooth.on('pinRequired')^{8+(deprecated)}

on(type: "pinRequired", callback: Callback<PinRequiredParam>): void

Subscribes to the pairing request events of the remote Bluetooth device.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.on('pinRequired').

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function onReceiveEvent(data : bluetooth.PinRequiredParam) { // data is the pairing request parameter.
    console.info('pin required = '+ JSON.stringify(data));
}
bluetooth.on('pinRequired', onReceiveEvent);

bluetooth.off('pinRequired')^{8+(deprecated)}

off(type: "pinRequired", callback?: Callback<PinRequiredParam>): void

Unsubscribes from the pairing request events of the remote Bluetooth device.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.off('pinRequired').

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function onReceiveEvent(data : bluetooth.PinRequiredParam) {
    console.info('pin required = '+ JSON.stringify(data));
}
bluetooth.on('pinRequired', onReceiveEvent);
bluetooth.off('pinRequired', onReceiveEvent);

bluetooth.on('bondStateChange')^{8+(deprecated)}

on(type: "bondStateChange", callback: Callback<BondStateParam>): void

Subscribes to the Bluetooth pairing state changes.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.on('bondStateChange').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function onReceiveEvent(data : bluetooth.BondStateParam) { // data, as the input parameter of the callback, indicates the pairing state.
    console.info('pair state = '+ JSON.stringify(data));
}
bluetooth.on('bondStateChange', onReceiveEvent);

bluetooth.off('bondStateChange')^{8+(deprecated)}

off(type: "bondStateChange", callback?: Callback<BondStateParam>): void

Unsubscribes from the Bluetooth pairing state changes.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.off('bondStateChange').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function onReceiveEvent(data : bluetooth.BondStateParam) {
    console.info('bond state = '+ JSON.stringify(data));
}
bluetooth.on('bondStateChange', onReceiveEvent);
bluetooth.off('bondStateChange', onReceiveEvent);

bluetooth.on('stateChange')^{8+(deprecated)}

on(type: "stateChange", callback: Callback<BluetoothState>): void

Subscribes to the Bluetooth connection state changes.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.on('stateChange').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function onReceiveEvent(data : bluetooth.BluetoothState) {
    console.info('bluetooth state = '+ JSON.stringify(data));
}
bluetooth.on('stateChange', onReceiveEvent);

bluetooth.off('stateChange')^{8+(deprecated)}

off(type: "stateChange", callback?: Callback<BluetoothState>): void

Unsubscribes from the Bluetooth connection state changes.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.off('stateChange').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function onReceiveEvent(data : bluetooth.BluetoothState) {
    console.info('bluetooth state = '+ JSON.stringify(data));
}
bluetooth.on('stateChange', onReceiveEvent);
bluetooth.off('stateChange', onReceiveEvent);

bluetooth.sppListen^{8+(deprecated)}

sppListen(name: string, option: SppOption, callback: AsyncCallback<number>): void

Creates a server listening socket.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.sppListen.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Example

import { BusinessError } from '@ohos.base';
let serverNumber = -1;
function serverSocket(code : BusinessError, number : number) {
  console.log('bluetooth error code: ' + code.code);
  if (code.code == 0) {
    console.log('bluetooth serverSocket Number: ' + number);
    serverNumber = number;
  }
}

let sppOption : bluetooth.SppOption = {uuid: '00001810-0000-1000-8000-00805F9B34FB', secure: false, type: 0};
bluetooth.sppListen('server1', sppOption, serverSocket);

bluetooth.sppAccept^{8+(deprecated)}

sppAccept(serverSocket: number, callback: AsyncCallback<number>): void

Listens for a connection to be made to this socket from the client and accepts it.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.sppAccept.

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Example

import { BusinessError } from '@ohos.base';
let serverNumber = -1;
function serverSocket(code : BusinessError, number : number) {
  console.log('bluetooth error code: ' + code.code);
  if (code.code == 0) {
    console.log('bluetooth serverSocket Number: ' + number);
    serverNumber = number;
  }
}
let clientNumber = -1;
function acceptClientSocket(code : BusinessError, number : number) {
  console.log('bluetooth error code: ' + code.code);
  if (code.code == 0) {
    console.log('bluetooth clientSocket Number: ' + number);
    // The obtained clientNumber is used as the socket ID for subsequent read/write operations on the server.
    clientNumber = number;
  }
}
bluetooth.sppAccept(serverNumber, acceptClientSocket);

bluetooth.sppConnect^{8+(deprecated)}

sppConnect(device: string, option: SppOption, callback: AsyncCallback<number>): void

Initiates an SPP connection to a remote device from the client.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.sppConnect.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Example

import { BusinessError } from '@ohos.base';
let clientNumber = -1;
function clientSocket(code : BusinessError, number : number) {
  if (code.code != 0 || code == null) {
    return;
  }
  console.log('bluetooth serverSocket Number: ' + number);
  // The obtained clientNumber is used as the socket ID for subsequent read/write operations on the client.
  clientNumber = number;
}
let sppOption : bluetooth.SppOption = {uuid: '00001810-0000-1000-8000-00805F9B34FB', secure: false, type: 0};
bluetooth.sppConnect('XX:XX:XX:XX:XX:XX', sppOption, clientSocket);

bluetooth.sppCloseServerSocket^{8+(deprecated)}

sppCloseServerSocket(socket: number): void

Closes the listening socket of the server.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.sppCloseServerSocket.

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Example

import { BusinessError } from '@ohos.base';
let serverNumber = -1;
function serverSocket(code : BusinessError, number : number) {
  console.log('bluetooth error code: ' + code.code);
  if (code.code == 0) {
    console.log('bluetooth serverSocket Number: ' + number);
    serverNumber = number;
  }
}
bluetooth.sppCloseServerSocket(serverNumber);

bluetooth.sppCloseClientSocket^{8+(deprecated)}

sppCloseClientSocket(socket: number): void

Closes the client socket.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.sppCloseClientSocket.

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Example

import { BusinessError } from '@ohos.base';
let clientNumber = -1;
function clientSocket(code : BusinessError, number : number) {
  if (code.code != 0 || code == null) {
    return;
  }
  console.log('bluetooth serverSocket Number: ' + number);
  // The obtained clientNumber is used as the socket ID for subsequent read/write operations on the client.
  clientNumber = number;
}
bluetooth.sppCloseClientSocket(clientNumber);

bluetooth.sppWrite^{8+(deprecated)}

sppWrite(clientSocket: number, data: ArrayBuffer): boolean

Writes data to the remote device through the socket.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.sppWrite.

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

import { BusinessError } from '@ohos.base';
let clientNumber = -1;
function clientSocket(code : BusinessError, number : number) {
  if (code.code != 0 || code == null) {
    return;
  }
  console.log('bluetooth serverSocket Number: ' + number);
  // The obtained clientNumber is used as the socket ID for subsequent read/write operations on the client.
  clientNumber = number;
}
let arrayBuffer = new ArrayBuffer(8);
let data = new Uint8Array(arrayBuffer);
data[0] = 123;
let ret : boolean = bluetooth.sppWrite(clientNumber, arrayBuffer);
if (ret) {
  console.log('spp write successfully');
} else {
  console.log('spp write failed');
}

bluetooth.on('sppRead')^{8+(deprecated)}

on(type: "sppRead", clientSocket: number, callback: Callback<ArrayBuffer>): void

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.on('sppRead').

Subscribes to the SPP read request events.

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

import { BusinessError } from '@ohos.base';
let clientNumber = -1;
function clientSocket(code : BusinessError, number : number) {
  if (code.code != 0 || code == null) {
    return;
  }
  console.log('bluetooth serverSocket Number: ' + number);
  // The obtained clientNumber is used as the socket ID for subsequent read/write operations on the client.
  clientNumber = number;
}
function dataRead(dataBuffer : ArrayBuffer) {
  let data = new Uint8Array(dataBuffer);
  console.log('bluetooth data is: ' + data[0]);
}
bluetooth.on('sppRead', clientNumber, dataRead);

bluetooth.off('sppRead')^{8+(deprecated)}

off(type: "sppRead", clientSocket: number, callback?: Callback<ArrayBuffer>): void

Unsubscribes from the SPP read request events.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.off('sppRead').

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

import { BusinessError } from '@ohos.base';
let clientNumber = -1;
function clientSocket(code : BusinessError, number : number) {
  if (code.code != 0 || code == null) {
    return;
  }
  console.log('bluetooth serverSocket Number: ' + number);
  // The obtained clientNumber is used as the socket ID for subsequent read/write operations on the client.
  clientNumber = number;
}
bluetooth.off('sppRead', clientNumber);

bluetooth.getProfile^{8+(deprecated)}

getProfile(profileId: ProfileId): A2dpSourceProfile | HandsFreeAudioGatewayProfile

Obtains a profile object.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.getProfileInstance.

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let a2dpSrc : bluetooth.A2dpSourceProfile = bluetooth.getProfile(bluetooth.ProfileId.PROFILE_A2DP_SOURCE) as bluetooth.A2dpSourceProfile;

bluetooth.BLE

createGattServer^(deprecated)

createGattServer(): GattServer

Creates a GattServer instance.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.BLE.createGattServer.

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

let gattServer : bluetooth.GattServer = bluetooth.BLE.createGattServer();

createGattClientDevice^(deprecated)

createGattClientDevice(deviceId: string): GattClientDevice

Creates a GattClientDevice instance.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.BLE.createGattClientDevice.

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');

getConnectedBLEDevices^(deprecated)

getConnectedBLEDevices(): Array<string>

Obtains the BLE devices connected to this device.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.BLE.getConnectedBLEDevices.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

let result : Array<string> = bluetooth.BLE.getConnectedBLEDevices();

startBLEScan^(deprecated)

startBLEScan(filters: Array<ScanFilter>, options?: ScanOptions): void

Starts a BLE scan.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.BLE.startBLEScan.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH, ohos.permission.MANAGE_BLUETOOTH, and ohos.permission.LOCATION

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function onReceiveEvent(data : Array<bluetooth.ScanResult>) {
    console.info('BLE scan device find result = '+ JSON.stringify(data));
}
bluetooth.BLE.on("BLEDeviceFind", onReceiveEvent);
let scanOptions : bluetooth.ScanOptions = {
    interval: 500,
    dutyMode: bluetooth.ScanDuty.SCAN_MODE_LOW_POWER,
    matchMode: bluetooth.MatchMode.MATCH_MODE_AGGRESSIVE,
}

let scanFilter : bluetooth.ScanFilter = {
    deviceId:"XX:XX:XX:XX:XX:XX",
    name:"test",
    serviceUuid:"00001888-0000-1000-8000-00805f9b34fb"
}
bluetooth.BLE.startBLEScan(
    [scanFilter], scanOptions
);

stopBLEScan^(deprecated)

stopBLEScan(): void

Stops the BLE scan.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.BLE.stopBLEScan.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

No value is returned.

Example

bluetooth.BLE.stopBLEScan();

on('BLEDeviceFind')^(deprecated)

on(type: "BLEDeviceFind", callback: Callback<Array<ScanResult>>): void

Subscribe to the BLE device discovery events.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.BLE.on('BLEDeviceFind').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function onReceiveEvent(data : Array<bluetooth.ScanResult>) {
    console.info('bluetooth device find = '+ JSON.stringify(data));
}
bluetooth.BLE.on('BLEDeviceFind', onReceiveEvent);

off('BLEDeviceFind')^(deprecated)

off(type: "BLEDeviceFind", callback?: Callback<Array<ScanResult>>): void

Unsubscribes from the BLE device discovery events.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.BLE.off('BLEDeviceFind').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function onReceiveEvent(data : Array<bluetooth.ScanResult>) {
    console.info('bluetooth device find = '+ JSON.stringify(data));
}
bluetooth.BLE.on('BLEDeviceFind', onReceiveEvent);
bluetooth.BLE.off('BLEDeviceFind', onReceiveEvent);

BaseProfile

Provides the profile base class.

getConnectionDevices^{8+(deprecated)}

getConnectionDevices(): Array<string>

Obtains the connected devices.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.BaseProfile.getConnectionDevices.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

let a2dpSrc : bluetooth.A2dpSourceProfile = bluetooth.getProfile(bluetooth.ProfileId.PROFILE_A2DP_SOURCE) as bluetooth.A2dpSourceProfile;
let retArray : Array<string> = a2dpSrc.getConnectionDevices();

getDeviceState^{8+(deprecated)}

getDeviceState(device: string): ProfileConnectionState

Obtains the connection state of the profile.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.BaseProfile.getDeviceState.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let a2dpSrc : bluetooth.A2dpSourceProfile = bluetooth.getProfile(bluetooth.ProfileId.PROFILE_A2DP_SOURCE) as bluetooth.A2dpSourceProfile;
let ret : bluetooth.ProfileConnectionState = a2dpSrc.getDeviceState('XX:XX:XX:XX:XX:XX');

A2dpSourceProfile

Before using a method of A2dpSourceProfile, you need to create an instance of this class by using the getProfile() method.

connect^{8+(deprecated)}

connect(device: string): boolean

Sets up an Advanced Audio Distribution Profile (A2DP) connection.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.A2dpSourceProfile.connect.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let a2dpSrc : bluetooth.A2dpSourceProfile = bluetooth.getProfile(bluetooth.ProfileId.PROFILE_A2DP_SOURCE) as bluetooth.A2dpSourceProfile;
let ret : boolean = a2dpSrc.connect('XX:XX:XX:XX:XX:XX');

disconnect^{8+(deprecated)}

disconnect(device: string): boolean

Disconnects an A2DP connection.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.A2dpSourceProfile.disconnect.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let a2dpSrc : bluetooth.A2dpSourceProfile = bluetooth.getProfile(bluetooth.ProfileId.PROFILE_A2DP_SOURCE) as bluetooth.A2dpSourceProfile;
let ret : boolean = a2dpSrc.disconnect('XX:XX:XX:XX:XX:XX');

on('connectionStateChange')^{8+(deprecated)}

on(type: "connectionStateChange", callback: Callback<StateChangeParam>): void

Subscribes to the A2DP connection state changes.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.A2dpSourceProfile.on('connectionStateChange').

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function onReceiveEvent(data : bluetooth.StateChangeParam) {
    console.info('a2dp state = '+ JSON.stringify(data));
}
let a2dpSrc : bluetooth.A2dpSourceProfile = bluetooth.getProfile(bluetooth.ProfileId.PROFILE_A2DP_SOURCE) as bluetooth.A2dpSourceProfile;
a2dpSrc.on('connectionStateChange', onReceiveEvent);

off('connectionStateChange')^{8+(deprecated)}

off(type: "connectionStateChange", callback?: Callback<StateChangeParam>): void

Unsubscribes from the A2DP connection state changes.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.A2dpSourceProfile.off('connectionStateChange').

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function onReceiveEvent(data : bluetooth.StateChangeParam) {
    console.info('a2dp state = '+ JSON.stringify(data));
}
let a2dpSrc : bluetooth.A2dpSourceProfile = bluetooth.getProfile(bluetooth.ProfileId.PROFILE_A2DP_SOURCE) as bluetooth.A2dpSourceProfile;
a2dpSrc.on('connectionStateChange', onReceiveEvent);
a2dpSrc.off('connectionStateChange', onReceiveEvent);

getPlayingState^{8+(deprecated)}

getPlayingState(device: string): PlayingState

Obtains the playing state of a device.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.A2dpSourceProfile.getPlayingState.

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let a2dpSrc : bluetooth.A2dpSourceProfile = bluetooth.getProfile(bluetooth.ProfileId.PROFILE_A2DP_SOURCE) as bluetooth.A2dpSourceProfile;
let state : bluetooth.PlayingState = a2dpSrc.getPlayingState('XX:XX:XX:XX:XX:XX');

HandsFreeAudioGatewayProfile

Before using a method of HandsFreeAudioGatewayProfile, you need to create an instance of this class by using the getProfile() method.

connect^{8+(deprecated)}

connect(device: string): boolean

Sets up a Hands-free Profile (HFP) connection of a device.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.HandsFreeAudioGatewayProfile.connect.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let hfpAg : bluetooth.HandsFreeAudioGatewayProfile= bluetooth.getProfile(bluetooth.ProfileId
    .PROFILE_HANDS_FREE_AUDIO_GATEWAY);
let ret : boolean = hfpAg.connect('XX:XX:XX:XX:XX:XX');

disconnect^{8+(deprecated)}

disconnect(device: string): boolean

Disconnects the HFP connection of a device.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.HandsFreeAudioGatewayProfile.disconnect.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let hfpAg : bluetooth.HandsFreeAudioGatewayProfile = bluetooth.getProfile(bluetooth.ProfileId
    .PROFILE_HANDS_FREE_AUDIO_GATEWAY);
let ret : boolean = hfpAg.disconnect('XX:XX:XX:XX:XX:XX');

on('connectionStateChange')^{8+(deprecated)}

on(type: "connectionStateChange", callback: Callback<StateChangeParam>): void

Subscribes to the HFP connection state changes.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.HandsFreeAudioGatewayProfile.on('connectionStateChange').

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function onReceiveEvent(data : bluetooth.StateChangeParam) {
    console.info('hfp state = '+ JSON.stringify(data));
}
let hfpAg : bluetooth.HandsFreeAudioGatewayProfile= bluetooth.getProfile(bluetooth.ProfileId
    .PROFILE_HANDS_FREE_AUDIO_GATEWAY);
hfpAg.on('connectionStateChange', onReceiveEvent);

off('connectionStateChange')^{8+(deprecated)}

off(type: "connectionStateChange", callback?: Callback<StateChangeParam>): void

Unsubscribes from the HFP connection state changes.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.HandsFreeAudioGatewayProfile.off('connectionStateChange').

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function onReceiveEvent(data : bluetooth.StateChangeParam) {
    console.info('hfp state = '+ JSON.stringify(data));
}
let hfpAg : bluetooth.HandsFreeAudioGatewayProfile= bluetooth.getProfile(bluetooth.ProfileId
    .PROFILE_HANDS_FREE_AUDIO_GATEWAY);
hfpAg.on('connectionStateChange', onReceiveEvent);
hfpAg.off('connectionStateChange', onReceiveEvent);

GattServer

Implements the Generic Attribute Profile (GATT) server. Before using a method of this class, you need to create a GattServer instance using the createGattServer() method.

startAdvertising^(deprecated)

startAdvertising(setting: AdvertiseSetting, advData: AdvertiseData, advResponse?: AdvertiseData): void

Starts BLE advertising.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.startAdvertising.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

let manufactureValueBuffer = new Uint8Array(4);
manufactureValueBuffer[0] = 1;
manufactureValueBuffer[1] = 2;
manufactureValueBuffer[2] = 3;
manufactureValueBuffer[3] = 4;

let serviceValueBuffer = new Uint8Array(4);
serviceValueBuffer[0] = 4;
serviceValueBuffer[1] = 6;
serviceValueBuffer[2] = 7;
serviceValueBuffer[3] = 8;
console.info('manufactureValueBuffer = '+ JSON.stringify(manufactureValueBuffer));
console.info('serviceValueBuffer = '+ JSON.stringify(serviceValueBuffer));
let gattServer : bluetooth.GattServer = bluetooth.BLE.createGattServer();
let setting : bluetooth.AdvertiseSetting = {
    interval:150,
    txPower:60,
    connectable:true,
}

let manufactureData : bluetooth.ManufactureData = {
    manufactureId:4567,
    manufactureValue:manufactureValueBuffer.buffer
}

let serviceData : bluetooth.ServiceData = {
    serviceUuid:"00001888-0000-1000-8000-00805f9b34fb",
    serviceValue:serviceValueBuffer.buffer
}

let advData : bluetooth.AdvertiseData = {
    serviceUuids:["00001889-0000-1000-8000-00805f9b34fb"],
    manufactureData:[manufactureData],
    serviceData:[serviceData],
}

let advResponse : bluetooth.AdvertiseData = {
    serviceUuids:["00001889-0000-1000-8000-00805f9b34fb"],
    manufactureData:[manufactureData],
    serviceData:[serviceData],
}
gattServer.startAdvertising(setting, advData, advResponse);

stopAdvertising^(deprecated)

stopAdvertising(): void

Stops BLE advertising.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.stopAdvertising.

Required permissions: ohos.permission.DISCOVER_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

No value is returned.

Example

let server : bluetooth.GattServer = bluetooth.BLE.createGattServer();
server.stopAdvertising();

addService^(deprecated)

addService(service: GattService): boolean

Adds a service to this GATT server.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.addService.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

// Create descriptors.
let descriptors : Array<bluetooth.BLEDescriptor> = [];
let arrayBuffer = new ArrayBuffer(8);
let descV = new Uint8Array(arrayBuffer);
descV[0] = 11;
let descriptor : bluetooth.BLEDescriptor = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
  descriptorUuid: '00002902-0000-1000-8000-00805F9B34FB', descriptorValue: arrayBuffer};
descriptors[0] = descriptor;

// Create characteristics.
let characteristics : Array<bluetooth.BLECharacteristic> = [];
let arrayBufferC = new ArrayBuffer(8);
let cccV = new Uint8Array(arrayBufferC);
cccV[0] = 1;
let characteristic : bluetooth.BLECharacteristic = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB', characteristicValue: arrayBufferC, descriptors:descriptors};
let characteristicN : bluetooth.BLECharacteristic = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001821-0000-1000-8000-00805F9B34FB', characteristicValue: arrayBufferC, descriptors:descriptors};
characteristics[0] = characteristic;

// Create a gattService instance.
let gattService : bluetooth.GattService = {serviceUuid:'00001810-0000-1000-8000-00805F9B34FB', isPrimary: true, characteristics:characteristics, includeServices:[]};

let gattServer : bluetooth.GattServer = bluetooth.BLE.createGattServer();
let ret : boolean = gattServer.addService(gattService);
if (ret) {
   console.log("add service successfully");
} else {
   console.log("add service failed");
}

removeService^(deprecated)

removeService(serviceUuid: string): boolean

Removes a service from this GATT server.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.removeService.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let server : bluetooth.GattServer = bluetooth.BLE.createGattServer();
server.removeService('00001810-0000-1000-8000-00805F9B34FB');

close^(deprecated)

close(): void

Closes this GATT server to unregister it from the protocol stack. After this method is called, this GattServer cannot be used.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.close.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Example

let server : bluetooth.GattServer = bluetooth.BLE.createGattServer();
server.close();

notifyCharacteristicChanged^(deprecated)

notifyCharacteristicChanged(deviceId: string, notifyCharacteristic: NotifyCharacteristic): boolean

Notifies the connected client device when a characteristic value changes.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.notifyCharacteristicChanged.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

// Create descriptors.
let descriptors : Array<bluetooth.BLEDescriptor> = [];
let arrayBuffer = new ArrayBuffer(8);
let descV = new Uint8Array(arrayBuffer);
descV[0] = 11;
let descriptor : bluetooth.BLEDescriptor = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
  descriptorUuid: '00002902-0000-1000-8000-00805F9B34FB', descriptorValue: arrayBuffer};
descriptors[0] = descriptor;
let arrayBufferC = new ArrayBuffer(8);
let characteristic : bluetooth.BLECharacteristic = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB', characteristicValue: arrayBufferC, descriptors:descriptors};
let notifyCharacteristic : bluetooth.NotifyCharacteristic = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001821-0000-1000-8000-00805F9B34FB', characteristicValue: characteristic.characteristicValue, confirm: false};
let server : bluetooth.GattServer = bluetooth.BLE.createGattServer();
server.notifyCharacteristicChanged('XX:XX:XX:XX:XX:XX', notifyCharacteristic);

sendResponse^(deprecated)

sendResponse(serverResponse: ServerResponse): boolean

Sends a response to a read or write request from the GATT client.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.sendResponse.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

/* send response */
let arrayBufferCCC = new ArrayBuffer(8);
let cccValue = new Uint8Array(arrayBufferCCC);
cccValue[0] = 1123;
let serverResponse : bluetooth.ServerResponse = {
    "deviceId": "XX:XX:XX:XX:XX:XX",
    "transId": 0,
    "status": 0,
    "offset": 0,
    "value": arrayBufferCCC,
};

let gattServer : bluetooth.GattServer = bluetooth.BLE.createGattServer();
let ret : boolean = gattServer.sendResponse(serverResponse);
if (ret) {
  console.log('bluetooth sendResponse successfully');
} else {
  console.log('bluetooth sendResponse failed');
}

on('characteristicRead')^(deprecated)

on(type: "characteristicRead", callback: Callback<CharacteristicReadReq>): void

Subscribes to the characteristic read request events.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.on('characteristicRead').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

let arrayBufferCCC = new ArrayBuffer(8);
let cccValue = new Uint8Array(arrayBufferCCC);
cccValue[0] = 1123;
function ReadCharacteristicReq(CharacteristicReadReq : bluetooth.CharacteristicReadReq) {
  let deviceId : string = CharacteristicReadReq.deviceId;
  let transId : number = CharacteristicReadReq.transId;
  let offset : number = CharacteristicReadReq.offset;
  let characteristicUuid : string = CharacteristicReadReq.characteristicUuid;

  let serverResponse : bluetooth.ServerResponse = {deviceId: deviceId, transId: transId, status: 0, 
  offset: offset, value:arrayBufferCCC};

  let ret : boolean = gattServer.sendResponse(serverResponse);
  if (ret) {
    console.log('bluetooth sendResponse successfully');
  } else {
    console.log('bluetooth sendResponse failed');
  }
}

let gattServer : bluetooth.GattServer = bluetooth.BLE.createGattServer();
gattServer.on("characteristicRead", ReadCharacteristicReq);

off('characteristicRead')^(deprecated)

off(type: "characteristicRead", callback?: Callback<CharacteristicReadReq>): void

Unsubscribes from the characteristic read request events.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.off('characteristicRead').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

let gattServer : bluetooth.GattServer = bluetooth.BLE.createGattServer();
gattServer.off("characteristicRead");

on('characteristicWrite')^(deprecated)

on(type: "characteristicWrite", callback: Callback<CharacteristicWriteReq>): void

Subscribes to the characteristic write request events.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.on('characteristicWrite').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

let arrayBufferCCC = new ArrayBuffer(8);
let cccValue = new Uint8Array(arrayBufferCCC);
function WriteCharacteristicReq(CharacteristicWriteReq : bluetooth.CharacteristicWriteReq) {
  let deviceId : string = CharacteristicWriteReq.deviceId;
  let transId : number = CharacteristicWriteReq.transId;
  let offset : number = CharacteristicWriteReq.offset;
  let isPrep : boolean = CharacteristicWriteReq.isPrep;
  let needRsp : boolean = CharacteristicWriteReq.needRsp;
  let value =  new Uint8Array(arrayBufferCCC);
  let characteristicUuid : string = CharacteristicWriteReq.characteristicUuid;

  cccValue.set(new Uint8Array(value));
  let serverResponse : bluetooth.ServerResponse = {deviceId: deviceId, transId: transId, status: 0, 
  offset: offset, value:arrayBufferCCC};

  let ret : boolean = gattServer.sendResponse(serverResponse);
  if (ret) {
    console.log('bluetooth sendResponse successfully');
  } else {
    console.log('bluetooth sendResponse failed');
  }
}

let gattServer : bluetooth.GattServer = bluetooth.BLE.createGattServer();
gattServer.on("characteristicWrite", WriteCharacteristicReq);

off('characteristicWrite')^(deprecated)

off(type: "characteristicWrite", callback?: Callback<CharacteristicWriteReq>): void

Unsubscribes from the characteristic write request events.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.off('characteristicWrite').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

let gattServer : bluetooth.GattServer = bluetooth.BLE.createGattServer();
gattServer.off("characteristicWrite");

on('descriptorRead')^(deprecated)

on(type: "descriptorRead", callback: Callback<DescriptorReadReq>): void

Subscribes to the descriptor read request events.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.on('descriptorRead').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

let arrayBufferDesc = new ArrayBuffer(8);
let descValue = new Uint8Array(arrayBufferDesc);
descValue[0] = 1101;
function ReadDescriptorReq(DescriptorReadReq : bluetooth.DescriptorReadReq) {
  let deviceId : string = DescriptorReadReq.deviceId;
  let transId : number = DescriptorReadReq.transId;
  let offset : number = DescriptorReadReq.offset;
  let descriptorUuid : string = DescriptorReadReq.descriptorUuid;

  let serverResponse : bluetooth.ServerResponse = {deviceId: deviceId, transId: transId, status: 0, 
  offset: offset, value:arrayBufferDesc};

  let ret : boolean = gattServer.sendResponse(serverResponse);
  if (ret) {
    console.log('bluetooth sendResponse successfully');
  } else {
    console.log('bluetooth sendResponse failed');
  }
}

let gattServer : bluetooth.GattServer = bluetooth.BLE.createGattServer();
gattServer.on("descriptorRead", ReadDescriptorReq);

off('descriptorRead')^(deprecated)

off(type: "descriptorRead", callback?: Callback<DescriptorReadReq>): void

Unsubscribes from the descriptor read request events.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.off('descriptorRead').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

let gattServer : bluetooth.GattServer = bluetooth.BLE.createGattServer();
gattServer.off("descriptorRead");

on('descriptorWrite')^(deprecated)

on(type: "descriptorWrite", callback: Callback<DescriptorWriteReq>): void

Subscribes to the descriptor write request events.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.on('descriptorWrite').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

let arrayBufferDesc = new ArrayBuffer(8);
let descValue = new Uint8Array(arrayBufferDesc);
function WriteDescriptorReq(DescriptorWriteReq : bluetooth.DescriptorWriteReq) {
  let deviceId : string = DescriptorWriteReq.deviceId;
  let transId : number = DescriptorWriteReq.transId;
  let offset : number = DescriptorWriteReq.offset;
  let isPrep : boolean = DescriptorWriteReq.isPrep;
  let needRsp : boolean = DescriptorWriteReq.needRsp;
  let value = new Uint8Array(arrayBufferDesc);
  let descriptorUuid : string = DescriptorWriteReq.descriptorUuid;

  descValue.set(new Uint8Array(value));
  let serverResponse : bluetooth.ServerResponse = {deviceId: deviceId, transId: transId, status: 0, offset: offset, value:arrayBufferDesc};

  let ret : boolean = gattServer.sendResponse(serverResponse);
  if (ret) {
    console.log('bluetooth sendResponse successfully');
  } else {
    console.log('bluetooth sendResponse failed');
  }
}

let gattServer : bluetooth.GattServer = bluetooth.BLE.createGattServer();
gattServer.on("descriptorWrite", WriteDescriptorReq);

off('descriptorWrite')^(deprecated)

off(type: "descriptorWrite", callback?: Callback<DescriptorWriteReq>): void

Unsubscribes from the descriptor write request events.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.off('descriptorWrite').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

let gattServer : bluetooth.GattServer = bluetooth.BLE.createGattServer();
gattServer.off("descriptorWrite");

on('connectStateChange')^(deprecated)

on(type: "connectStateChange", callback: Callback<BLEConnectChangedState>): void

Subscribes to the BLE connection state changes.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.on('connectStateChange').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function Connected(BLEConnectChangedState : bluetooth.BLEConnectChangedState) {
  let deviceId : string = BLEConnectChangedState.deviceId;
  let status : bluetooth.ProfileConnectionState = BLEConnectChangedState.state;
}

let gattServer : bluetooth.GattServer = bluetooth.BLE.createGattServer();
gattServer.on("connectStateChange", Connected);

off('connectStateChange')^(deprecated)

off(type: "connectStateChange", callback?: Callback<BLEConnectChangedState>): void

Unsubscribes from the BLE connection state changes.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattServer.off('connectStateChange').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

let gattServer : bluetooth.GattServer = bluetooth.BLE.createGattServer();
gattServer.off("connectStateChange");

GattClientDevice

Implements the GATT client. Before using a method of this class, you must create a GattClientDevice instance using the createGattClientDevice(deviceId: string) method.

connect^(deprecated)

connect(): boolean

Initiates a connection to the remote BLE device.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.connect.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
let ret : boolean = device.connect();

disconnect^(deprecated)

disconnect(): boolean

Disconnects from the remote BLE device.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.disconnect.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
let ret : boolean = device.disconnect();

close^(deprecated)

close(): boolean

Closes this GATT client to unregister it from the protocol stack. After this method is called, this GattClientDevice instance cannot be used.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.close.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
let ret : boolean = device.close();

getServices^(deprecated)

getServices(callback: AsyncCallback<Array<GattService>>): void

Obtains all services of the remote BLE device. This API uses an asynchronous callback to return the result.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.getServices.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

import { BusinessError } from '@ohos.base';
// Callback
function getServices(code : BusinessError, gattServices : Array<bluetooth.GattService>) {
  if (code.code == 0) {
      let services : Array<bluetooth.GattService> = gattServices;
      console.log('bluetooth code is ' + code.code);
      console.log("bluetooth services size is ", services.length);

      for (let i = 0; i < services.length; i++) {
        console.log('bluetooth serviceUuid is ' + services[i].serviceUuid);
      }
  }
}

let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
device.connect();
device.getServices(getServices);

getServices^(deprecated)

getServices(): Promise<Array<GattService>>

Obtains all services of the remote BLE device. This API uses a promise to return the result.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.getServices.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

// Promise
let device : bluetooth.GattClientDevice= bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
device.connect();
device.getServices().then((result : Array<bluetooth.GattService>) => {
    console.info("getServices successfully:" + JSON.stringify(result));
});

readCharacteristicValue^(deprecated)

readCharacteristicValue(characteristic: BLECharacteristic, callback: AsyncCallback<BLECharacteristic>): void

Reads the characteristic value of the specific service of the remote BLE device. This API uses an asynchronous callback to return the result.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.readCharacteristicValue.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

import { BusinessError } from '@ohos.base';
function readCcc(code : BusinessError, BLECharacteristic : bluetooth.BLECharacteristic) {
  if (code.code != 0) {
      return;
  }
  console.log('bluetooth characteristic uuid: ' + BLECharacteristic.characteristicUuid);
  let value = new Uint8Array(BLECharacteristic.characteristicValue);
  console.log('bluetooth characteristic value: ' + value[0] +','+ value[1]+','+ value[2]+','+ value[3]);
}

let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
let descriptors : Array<bluetooth.BLEDescriptor> = [];
let bufferDesc : ArrayBuffer = new ArrayBuffer(8);
let descV : Uint8Array = new Uint8Array(bufferDesc);
descV[0] = 11;
let descriptor : bluetooth.BLEDescriptor = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
descriptorUuid: '00002903-0000-1000-8000-00805F9B34FB', descriptorValue: bufferDesc};
descriptors[0] = descriptor;

let bufferCCC = new ArrayBuffer(8);
let cccV = new Uint8Array(bufferCCC);
cccV[0] = 1;
let characteristic : bluetooth.BLECharacteristic = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
characteristicValue: bufferCCC, descriptors:descriptors};

device.readCharacteristicValue(characteristic, readCcc);

readCharacteristicValue^(deprecated)

readCharacteristicValue(characteristic: BLECharacteristic): Promise<BLECharacteristic>

Reads the characteristic value of the specific service of the remote BLE device. This API uses a promise to return the result.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.readCharacteristicValue.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
let descriptors : Array<bluetooth.BLEDescriptor> = [];
let bufferDesc = new ArrayBuffer(8);
let descV = new Uint8Array(bufferDesc);
descV[0] = 11;
let descriptor : bluetooth.BLEDescriptor = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
descriptorUuid: '00002903-0000-1000-8000-00805F9B34FB', descriptorValue: bufferDesc};
descriptors[0] = descriptor;

let bufferCCC = new ArrayBuffer(8);
let cccV = new Uint8Array(bufferCCC);
cccV[0] = 1;
let characteristic : bluetooth.BLECharacteristic = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
characteristicValue: bufferCCC, descriptors:descriptors};

device.readCharacteristicValue(characteristic);

readDescriptorValue^(deprecated)

readDescriptorValue(descriptor: BLEDescriptor, callback: AsyncCallback<BLEDescriptor>): void

Reads the descriptor contained in the specific characteristic of the remote BLE device. This API uses an asynchronous callback to return the result.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.readDescriptorValue.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

import { BusinessError } from '@ohos.base';
function readDesc(code : BusinessError, BLEDescriptor : bluetooth.BLEDescriptor) {
  if (code.code != 0) {
      return;
  }
  console.log('bluetooth descriptor uuid: ' + BLEDescriptor.descriptorUuid);
  let value = new Uint8Array(BLEDescriptor.descriptorValue);
  console.log('bluetooth descriptor value: ' + value[0] +','+ value[1]+','+ value[2]+','+ value[3]);
}

let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
let bufferDesc = new ArrayBuffer(8);
let descV = new Uint8Array(bufferDesc);
descV[0] = 11;
let descriptor : bluetooth.BLEDescriptor = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
  descriptorUuid: '00002903-0000-1000-8000-00805F9B34FB', descriptorValue: bufferDesc};
device.readDescriptorValue(descriptor, readDesc);

readDescriptorValue^(deprecated)

readDescriptorValue(descriptor: BLEDescriptor): Promise<BLEDescriptor>

Reads the descriptor contained in the specific characteristic of the remote BLE device. This API uses a promise to return the result.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.readDescriptorValue.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
let bufferDesc = new ArrayBuffer(8);
let descV = new Uint8Array(bufferDesc);
descV[0] = 11;
let descriptor : bluetooth.BLEDescriptor = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
  descriptorUuid: '00002903-0000-1000-8000-00805F9B34FB', descriptorValue: bufferDesc};
device.readDescriptorValue(descriptor);

writeCharacteristicValue^(deprecated)

writeCharacteristicValue(characteristic: BLECharacteristic): boolean

Writes a characteristic value to the remote BLE device.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.writeCharacteristicValue.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
let descriptors : Array<bluetooth.BLEDescriptor> = [];
let bufferDesc = new ArrayBuffer(8);
let descV = new Uint8Array(bufferDesc);
descV[0] = 11;
let descriptor : bluetooth.BLEDescriptor = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
  descriptorUuid: '00002903-0000-1000-8000-00805F9B34FB', descriptorValue: bufferDesc};
descriptors[0] = descriptor;

let bufferCCC = new ArrayBuffer(8);
let cccV = new Uint8Array(bufferCCC);
cccV[0] = 1;
let characteristic : bluetooth.BLECharacteristic = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
  characteristicValue: bufferCCC, descriptors:descriptors};
let retWriteCcc : boolean = device.writeCharacteristicValue(characteristic);
if (retWriteCcc) {
  console.log('write characteristic successfully');
} else {
  console.log('write characteristic failed');
}

writeDescriptorValue^(deprecated)

writeDescriptorValue(descriptor: BLEDescriptor): boolean

Writes binary data to the specific descriptor of the remote BLE device.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.writeDescriptorValue.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
let bufferDesc = new ArrayBuffer(8);
let descV = new Uint8Array(bufferDesc);
descV[0] = 22;
let descriptor : bluetooth.BLEDescriptor = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
  descriptorUuid: '00002903-0000-1000-8000-00805F9B34FB', descriptorValue: bufferDesc};
let retWriteDesc : boolean = device.writeDescriptorValue(descriptor);
if (retWriteDesc) {
  console.log('bluetooth write descriptor successfully');
} else {
  console.log('bluetooth write descriptor failed');
}

setBLEMtuSize^(deprecated)

setBLEMtuSize(mtu: number): boolean

Sets the maximum transmission unit (MTU) that can be transmitted between the GATT client and its remote BLE device. This API can be used only after a connection is set up by calling connect.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.setBLEMtuSize.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
device.setBLEMtuSize(128);

setNotifyCharacteristicChanged^(deprecated)

setNotifyCharacteristicChanged(characteristic: BLECharacteristic, enable: boolean): boolean

Sets the function of notifying the GATT client when the characteristic value of the remote BLE device changes.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.setNotifyCharacteristicChanged.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

Example

// Create descriptors.
let descriptors : Array<bluetooth.BLEDescriptor> = [];
let arrayBuffer = new ArrayBuffer(8);
let descV = new Uint8Array(arrayBuffer);
descV[0] = 11;
let descriptor : bluetooth.BLEDescriptor = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
  descriptorUuid: '00002902-0000-1000-8000-00805F9B34FB', descriptorValue: arrayBuffer};
descriptors[0] = descriptor;
let arrayBufferC = new ArrayBuffer(8);
let characteristic : bluetooth.BLECharacteristic = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB', characteristicValue: arrayBufferC, descriptors:descriptors};
let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
device.setNotifyCharacteristicChanged(characteristic, false);

on('BLECharacteristicChange')^(deprecated)

on(type: "BLECharacteristicChange", callback: Callback<BLECharacteristic>): void

Subscribes to the BLE characteristic changes. The client can receive a notification from the server only after the setNotifyCharacteristicChanged method is called.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.on('BLECharacteristicChange').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function CharacteristicChange(CharacteristicChangeReq : bluetooth.BLECharacteristic) {
  let serviceUuid : string = CharacteristicChangeReq.serviceUuid;
  let characteristicUuid : string = CharacteristicChangeReq.characteristicUuid;
  let value = new Uint8Array(CharacteristicChangeReq.characteristicValue);
}
let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
device.on('BLECharacteristicChange', CharacteristicChange);

off('BLECharacteristicChange')^(deprecated)

off(type: "BLECharacteristicChange", callback?: Callback<BLECharacteristic>): void

Unsubscribes from the BLE characteristic changes.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.off('BLECharacteristicChange').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
device.off('BLECharacteristicChange');

on('BLEConnectionStateChange')^(deprecated)

on(type: "BLEConnectionStateChange", callback: Callback<BLEConnectChangedState>): void

Subscribes to the BLE connection state changes.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.on('BLEConnectionStateChange').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

function ConnectStateChanged(state : bluetooth.BLEConnectChangedState) {
  console.log('bluetooth connect state changed');
  let connectState : bluetooth.ProfileConnectionState = state.state;
}
let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
device.on('BLEConnectionStateChange', ConnectStateChanged);

off('BLEConnectionStateChange')^(deprecated)

off(type: "BLEConnectionStateChange", callback?: Callback<BLEConnectChangedState>): void

Unsubscribes from the BLE connection state changes.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.off('BLEConnectionStateChange').

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

let device : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
device.off('BLEConnectionStateChange');

getDeviceName^(deprecated)

getDeviceName(callback: AsyncCallback<string>): void

Obtains the name of the remote BLE device. This API uses an asynchronous callback to return the result.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.getDeviceName.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

import { BusinessError } from '@ohos.base';
// callback
let gattClient : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice("XX:XX:XX:XX:XX:XX");
let deviceName : void = gattClient.getDeviceName((err : BusinessError, data : string)=> {
    console.info('device name err ' + JSON.stringify(err));
    console.info('device name' + JSON.stringify(data));
})

getDeviceName^(deprecated)

getDeviceName(): Promise<string>

Obtains the name of the remote BLE device. This API uses a promise to return the result.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.getDeviceName.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

// promise
let gattClient : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice("XX:XX:XX:XX:XX:XX");
gattClient.getDeviceName().then((data) => {
    console.info('device name' + JSON.stringify(data));
})

getRssiValue^(deprecated)

getRssiValue(callback: AsyncCallback<number>): void

Obtains the received signal strength indication (RSSI) of the remote BLE device. This API uses an asynchronous callback to return the result. It can be used only after a connection is set up by calling connect.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.getRssiValue.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Parameters

Return value

No value is returned.

Example

import { BusinessError } from '@ohos.base';
// callback
let gattClient : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice("XX:XX:XX:XX:XX:XX");
let ret : boolean = gattClient.connect();
gattClient.getRssiValue((err : BusinessError, data : number)=> {
    console.info('rssi err ' + JSON.stringify(err));
    console.info('rssi value' + JSON.stringify(data));
})

getRssiValue^(deprecated)

getRssiValue(): Promise<number>

Obtains the RSSI of the remote BLE device. This API uses a promise to return the result. It can be used only after a connection is set up by calling connect.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattClientDevice.getRssiValue.

Required permissions: ohos.permission.USE_BLUETOOTH

System capability: SystemCapability.Communication.Bluetooth.Core

Return value

Example

// promise
let gattClient : bluetooth.GattClientDevice = bluetooth.BLE.createGattClientDevice("XX:XX:XX:XX:XX:XX");
gattClient.getRssiValue().then((data : number) => {
    console.info('rssi' + JSON.stringify(data));
})

ScanMode^{8+(deprecated)}

Enumerates the scan modes.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.ScanMode.

System capability: SystemCapability.Communication.Bluetooth.Core

BondState^{8+(deprecated)}

Enumerates the pairing states.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.BondState.

System capability: SystemCapability.Communication.Bluetooth.Core

SppOption^{8+(deprecated)}

Defines the SPP configuration parameters.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.SppOption.

System capability: SystemCapability.Communication.Bluetooth.Core

SppType^{8+(deprecated)}

Enumerates the SPP link types.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.SppType.

System capability: SystemCapability.Communication.Bluetooth.Core

GattService^(deprecated)

Defines the GATT service API parameters.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.GattService.

System capability: SystemCapability.Communication.Bluetooth.Core

BLECharacteristic^(deprecated)

Defines the characteristic API parameters.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.BLECharacteristic.

System capability: SystemCapability.Communication.Bluetooth.Core

BLEDescriptor^(deprecated)

Defines the descriptor API parameters.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.BLEDescriptor.

System capability: SystemCapability.Communication.Bluetooth.Core

NotifyCharacteristic^(deprecated)

Defines the parameters in the notifications sent when the server characteristic value changes.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.NotifyCharacteristic.

System capability: SystemCapability.Communication.Bluetooth.Core

CharacteristicReadReq^(deprecated)

Defines the parameters of the CharacteristicReadReq event received by the server.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.CharacteristicReadRequest.

System capability: SystemCapability.Communication.Bluetooth.Core

CharacteristicWriteReq^(deprecated)

Defines the parameters of the CharacteristicWriteReq event received by the server.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.CharacteristicWriteRequest.

System capability: SystemCapability.Communication.Bluetooth.Core

DescriptorReadReq^(deprecated)

Defines the parameters of the DescriptorReadReq event received by the server.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.DescriptorReadRequest.

System capability: SystemCapability.Communication.Bluetooth.Core

DescriptorWriteReq^(deprecated)

Defines the parameters of the DescriptorWriteReq event received by the server.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.DescriptorWriteRequest.

System capability: SystemCapability.Communication.Bluetooth.Core

ServerResponse^(deprecated)

Defines the parameters of the server's response to the GATT client's read/write request.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.ServerResponse.

System capability: SystemCapability.Communication.Bluetooth.Core

BLEConnectChangedState^(deprecated)

Defines the parameters of BLEConnectChangedState.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.BLEConnectChangedState.

System capability: SystemCapability.Communication.Bluetooth.Core

ProfileConnectionState^(deprecated)

Enumerates the profile connection states.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.ProfileConnectionState.

System capability: SystemCapability.Communication.Bluetooth.Core

ScanFilter^(deprecated)

Defines the scan filter parameters.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.ScanFilter.

System capability: SystemCapability.Communication.Bluetooth.Core

ScanOptions^(deprecated)

Defines the scan configuration parameters.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.ScanOptions.

System capability: SystemCapability.Communication.Bluetooth.Core

ScanDuty^(deprecated)

Enumerates the scan duty options.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.ScanDuty.

System capability: SystemCapability.Communication.Bluetooth.Core

MatchMode^(deprecated)

Enumerates the hardware match modes of BLE scan filters.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.MatchMode.

System capability: SystemCapability.Communication.Bluetooth.Core

ScanResult^(deprecated)

Defines the scan result.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.ScanResult.

System capability: SystemCapability.Communication.Bluetooth.Core

BluetoothState^(deprecated)

Enumerates the Bluetooth states.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.BluetoothState.

System capability: SystemCapability.Communication.Bluetooth.Core

AdvertiseSetting^(deprecated)

Defines the BLE advertising parameters.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.AdvertiseSetting.

System capability: SystemCapability.Communication.Bluetooth.Core

AdvertiseData^(deprecated)

Defines the content of a BLE advertisement packet.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.AdvertiseData.

System capability: SystemCapability.Communication.Bluetooth.Core

ManufactureData^(deprecated)

Defines the content of a BLE advertisement packet.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.ManufactureData.

System capability: SystemCapability.Communication.Bluetooth.Core

ServiceData^(deprecated)

Defines the service data contained in an advertisement packet.

NOTE
This API is supported since API version 7 and deprecated since API version 9. You are advised to use bluetoothManager.ServiceData.

System capability: SystemCapability.Communication.Bluetooth.Core

PinRequiredParam^{8+(deprecated)}

Defines the pairing request parameters.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.PinRequiredParam.

System capability: SystemCapability.Communication.Bluetooth.Core

BondStateParam^{8+(deprecated)}

Defines the pairing state parameters.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.BondStateParam.

System capability: SystemCapability.Communication.Bluetooth.Core

StateChangeParam^{8+(deprecated)}

Defines the profile state change parameters.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.StateChangeParam.

System capability: SystemCapability.Communication.Bluetooth.Core

DeviceClass^{8+(deprecated)}

Defines the class of a Bluetooth device.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.DeviceClass.

System capability: SystemCapability.Communication.Bluetooth.Core

MajorClass^{8+(deprecated)}

Enumerates the major classes of Bluetooth devices.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.MajorClass.

System capability: SystemCapability.Communication.Bluetooth.Core

MajorMinorClass^{8+(deprecated)}

Enumerates the major and minor classes of Bluetooth devices.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.MajorMinorClass.

System capability: SystemCapability.Communication.Bluetooth.Core

PlayingState^{8+(deprecated)}

Enumerates the A2DP playing states.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.PlayingState.

System capability: SystemCapability.Communication.Bluetooth.Core

ProfileId^{8+(deprecated)}

Enumerates the Bluetooth profiles. API version 9 is added with PROFILE_HID_HOST and PROFILE_PAN_NETWORK.

NOTE
This API is supported since API version 8 and deprecated since API version 9. You are advised to use bluetoothManager.ProfileId.

System capability: SystemCapability.Communication.Bluetooth.Core