@ohos.bluetooth (蓝牙)

蓝牙模块提供了基础的传统蓝牙能力以及BLE的扫描、广播等功能。

说明： 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 从API Version 9 开始，该接口不再维护，推荐使用@ohos.bluetooth.ble等相关profile接口。

导入模块

import bluetooth from '@ohos.bluetooth';

bluetooth.enableBluetooth^{8+(deprecated)}

enableBluetooth(): boolean

开启蓝牙。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.enableBluetooth替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

let enable : boolean = bluetooth.enableBluetooth();

bluetooth.disableBluetooth^{8+(deprecated)}

disableBluetooth(): boolean

关闭蓝牙。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.disableBluetooth替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

let disable : boolean = bluetooth.disableBluetooth();

bluetooth.getLocalName^{8+(deprecated)}

getLocalName(): string

获取蓝牙本地设备名称。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.getLocalName替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

let localName : string = bluetooth.getLocalName();

bluetooth.getState^(deprecated)

getState(): BluetoothState

获取蓝牙开关状态。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.getState替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

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

bluetooth.getBtConnectionState^(deprecated)

getBtConnectionState(): ProfileConnectionState

获取蓝牙本端的Profile连接状态，例如：任意一个支持的Profile连接状态为已连接，则此接口返回状态为已连接。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.getBtConnectionState替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

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

bluetooth.setLocalName^{8+(deprecated)}

setLocalName(name: string): boolean

设置蓝牙本地设备名称。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.setLocalName替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

bluetooth.pairDevice^(deprecated)

pairDevice(deviceId: string): boolean

发起蓝牙配对。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.pairDevice替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

// 实际的地址可由扫描流程获取
let result : boolean = bluetooth.pairDevice("XX:XX:XX:XX:XX:XX");

bluetooth.getProfileConnState^{8+(deprecated)}

getProfileConnState(profileId: ProfileId): ProfileConnectionState

依据ProfileId获取指定profile的连接状态。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.getProfileConnectionState替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

bluetooth.cancelPairedDevice^{8+(deprecated)}

cancelPairedDevice(deviceId: string): boolean

删除配对的远程设备。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.cancelPairedDevice替代。

系统接口：此接口为系统接口。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

bluetooth.getRemoteDeviceName^{8+(deprecated)}

getRemoteDeviceName(deviceId: string): string

获取对端蓝牙设备的名称。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.getRemoteDeviceName替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

bluetooth.getRemoteDeviceClass^{8+(deprecated)}

getRemoteDeviceClass(deviceId: string): DeviceClass

获取对端蓝牙设备的类别。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.getRemoteDeviceClass替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

bluetooth.getPairedDevices^{8+(deprecated)}

getPairedDevices(): Array<string>

获取蓝牙配对列表。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.getPairedDevices替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

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

bluetooth.setBluetoothScanMode^{8+(deprecated)}

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

设置蓝牙扫描模式，可以被远端设备发现。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.setBluetoothScanMode替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

// 设置为可连接可发现才可被远端设备扫描到，可以连接。
let result : boolean = bluetooth.setBluetoothScanMode(bluetooth.ScanMode
    .SCAN_MODE_CONNECTABLE_GENERAL_DISCOVERABLE, 100);

bluetooth.getBluetoothScanMode^{8+(deprecated)}

getBluetoothScanMode(): ScanMode

获取蓝牙扫描模式。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.getBluetoothScanMode替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

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

bluetooth.startBluetoothDiscovery^{8+(deprecated)}

startBluetoothDiscovery(): boolean

开启蓝牙扫描，可以发现远端设备。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.startBluetoothDiscovery替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH 和 ohos.permission.LOCATION

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

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

关闭蓝牙扫描。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.stopBluetoothDiscovery替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

let result : boolean = bluetooth.stopBluetoothDiscovery();

bluetooth.setDevicePairingConfirmation^{8+(deprecated)}

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

设置设备配对请求确认。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.setDevicePairingConfirmation替代。

需要权限：ohos.permission.MANAGE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

// 订阅“pinRequired”配对请求事件，收到远端配对请求后设置配对确认
function onReceivePinRequiredEvent(data : bluetooth.PinRequiredParam) { // data为配对请求的入参，配对请求参数
    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

订阅蓝牙设备发现上报事件。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.on('bluetoothDeviceFind')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

function onReceiveEvent(data : Array<string>) { // data为蓝牙设备地址集合
    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

取消订阅蓝牙设备发现上报事件。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.off('bluetoothDeviceFind')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

订阅远端蓝牙设备的配对请求事件。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.on('pinRequired')替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

function onReceiveEvent(data : bluetooth.PinRequiredParam) { // data为配对请求参数
    console.info('pin required = '+ JSON.stringify(data));
}
bluetooth.on('pinRequired', onReceiveEvent);

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

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

取消订阅远端蓝牙设备的配对请求事件。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.off('pinRequired')替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

订阅蓝牙配对状态改变事件。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.on('bondStateChange')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

function onReceiveEvent(data : bluetooth.BondStateParam) { // data为回调函数入参，表示配对的状态
    console.info('pair state = '+ JSON.stringify(data));
}
bluetooth.on('bondStateChange', onReceiveEvent);

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

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

取消订阅蓝牙配对状态改变事件。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.off('bondStateChange')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

订阅蓝牙连接状态改变事件。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.on('stateChange')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

取消订阅蓝牙连接状态改变事件。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.off('stateChange')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

创建一个服务端监听Socket。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.sppListen替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

示例：

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

服务端监听socket等待客户端连接。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.sppAccept替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

示例：

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);
    // 获取的clientNumber用作服务端后续读/写操作socket的id。
    clientNumber = number;
  }
}
bluetooth.sppAccept(serverNumber, acceptClientSocket);

bluetooth.sppConnect^{8+(deprecated)}

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

客户端向远端设备发起spp连接。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.sppConnect替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

示例：

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);
  // 获取的clientNumber用作客户端后续读/写操作socket的id。
  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

关闭服务端监听Socket，入参socket由sppListen接口返回。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.sppCloseServerSocket替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

示例：

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

关闭客户端socket，入参socket由sppAccept或sppConnect接口获取。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.sppCloseClientSocket替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

示例：

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);
  // 获取的clientNumber用作客户端后续读/写操作socket的id。
  clientNumber = number;
}
bluetooth.sppCloseClientSocket(clientNumber);

bluetooth.sppWrite^{8+(deprecated)}

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

通过socket向远端发送数据，入参clientSocket由sppAccept或sppConnect接口获取 。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.sppWrite替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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);
  // 获取的clientNumber用作客户端后续读/写操作socket的id。
  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

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.on('sppRead')替代。

订阅spp读请求事件，入参clientSocket由sppAccept或sppConnect接口获取。

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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);
  // 获取的clientNumber用作客户端后续读/写操作socket的id。
  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

取消订阅spp读请求事件，入参clientSocket由sppAccept或sppConnect接口获取。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.off('sppRead')替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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);
  // 获取的clientNumber用作客户端后续读/写操作socket的id。
  clientNumber = number;
}
bluetooth.off('sppRead', clientNumber);

bluetooth.getProfile^{8+(deprecated)}

getProfile(profileId: ProfileId): A2dpSourceProfile | HandsFreeAudioGatewayProfile

通过ProfileId，获取profile的对象实例。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.getProfileInstance替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

bluetooth.BLE

createGattServer^(deprecated)

createGattServer(): GattServer

创建一个可使用的GattServer实例。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.BLE.createGattServer替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

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

createGattClientDevice^(deprecated)

createGattClientDevice(deviceId: string): GattClientDevice

创建一个可使用的GattClientDevice实例。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.BLE.createGattClientDevice替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

getConnectedBLEDevices^(deprecated)

getConnectedBLEDevices(): Array<string>

获取和当前设备连接的BLE设备。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.BLE.getConnectedBLEDevices替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

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

startBLEScan^(deprecated)

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

发起BLE扫描流程。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.BLE.startBLEScan替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH 和 ohos.permission.MANAGE_BLUETOOTH 和 ohos.permission.LOCATION

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

停止BLE扫描流程。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.BLE.stopBLEScan替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

无

示例：

bluetooth.BLE.stopBLEScan();

on('BLEDeviceFind')^(deprecated)

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

订阅BLE设备发现上报事件。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.BLE.on('BLEDeviceFind')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

取消订阅BLE设备发现上报事件。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.BLE.off('BLEDeviceFind')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

profile基类。

getConnectionDevices^{8+(deprecated)}

getConnectionDevices(): Array<string>

获取已连接设备列表。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.BaseProfile.getConnectionDevices替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

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

获取设备profile的连接状态。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.BaseProfile.getDeviceState替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

使用A2dpSourceProfile方法之前需要创建该类的实例进行操作，通过getProfile()方法构造此实例。

connect^{8+(deprecated)}

connect(device: string): boolean

发起设备的A2dp服务连接请求。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.A2dpSourceProfile.connect替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

断开设备的a2dp服务连接。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.A2dpSourceProfile.disconnect替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

订阅a2dp连接状态变化事件。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.A2dpSourceProfile.on('connectionStateChange')替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

取消订阅a2dp连接状态变化事件。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.A2dpSourceProfile.off('connectionStateChange')替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

获取设备的播放状态。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.A2dpSourceProfile.getPlayingState替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

使用HandsFreeAudioGatewayProfile方法之前需要创建该类的实例进行操作，通过getProfile()方法构造此实例。

connect^{8+(deprecated)}

connect(device: string): boolean

连接设备的HFP服务。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.HandsFreeAudioGatewayProfile.connect替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

断开连接设备的HFP服务。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.HandsFreeAudioGatewayProfile.disconnect替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

订阅HFP连接状态变化事件。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.HandsFreeAudioGatewayProfile.on('connectionStateChange')替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

取消订阅HFP连接状态变化事件。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.HandsFreeAudioGatewayProfile.off('connectionStateChange')替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

server端类，使用server端方法之前需要创建该类的实例进行操作，通过createGattServer()方法构造此实例。

startAdvertising^(deprecated)

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

开始发送BLE广播。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.startAdvertising替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

停止发送BLE广播。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.stopAdvertising替代。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

无

示例：

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

addService^(deprecated)

addService(service: GattService): boolean

server端添加服务。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.addService替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

// 创建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;

// 创建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;

// 创建gattService
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

删除已添加的服务。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.removeService替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

close^(deprecated)

close(): void

关闭服务端功能，去注册server在协议栈的注册，调用该接口后GattServer实例将不能再使用。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.close替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

示例：

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

notifyCharacteristicChanged^(deprecated)

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

server端特征值发生变化时，主动通知已连接的client设备。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.notifyCharacteristicChanged替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

// 创建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

server端回复client端的读写请求。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.sendResponse替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

/* 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

server端订阅特征值读请求事件。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.on('characteristicRead')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

server端取消订阅特征值读请求事件。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.off('characteristicRead')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

on('characteristicWrite')^(deprecated)

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

server端订阅特征值写请求事件。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.on('characteristicWrite')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

server端取消订阅特征值写请求事件。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.off('characteristicWrite')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

on('descriptorRead')^(deprecated)

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

server端订阅描述符读请求事件。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.on('descriptorRead')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

server端取消订阅描述符读请求事件。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.off('descriptorRead')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

on('descriptorWrite')^(deprecated)

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

server端订阅描述符写请求事件。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.on('descriptorWrite')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

server端取消订阅描述符写请求事件。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.off('descriptorWrite')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

on('connectStateChange')^(deprecated)

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

server端订阅BLE连接状态变化事件。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.on('connectStateChange')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

server端取消订阅BLE连接状态变化事件。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattServer.off('connectStateChange')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

GattClientDevice

client端类，使用client端方法之前需要创建该类的实例进行操作，通过createGattClientDevice(deviceId: string)方法构造此实例。

connect^(deprecated)

connect(): boolean

client端发起连接远端蓝牙低功耗设备。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.connect替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

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

disconnect^(deprecated)

disconnect(): boolean

client端断开与远端蓝牙低功耗设备的连接。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.disconnect替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

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

close^(deprecated)

close(): boolean

关闭客户端功能，注销client在协议栈的注册，调用该接口后GattClientDevice实例将不能再使用。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.close替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

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

client端获取蓝牙低功耗设备的所有服务，即服务发现 。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.getServices替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

import { BusinessError } from '@ohos.base';
// callkback 模式
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>>

client端获取蓝牙低功耗设备的所有服务，即服务发现。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.getServices替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

// 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

client端读取蓝牙低功耗设备特定服务的特征值。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.readCharacteristicValue替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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>

client端读取蓝牙低功耗设备特定服务的特征值。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.readCharacteristicValue替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

client端读取蓝牙低功耗设备特定的特征包含的描述符。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.readDescriptorValue替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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>

client端读取蓝牙低功耗设备特定的特征包含的描述符。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.readDescriptorValue替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

client端向低功耗蓝牙设备写入特定的特征值。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.writeCharacteristicValue替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

client端向低功耗蓝牙设备特定的描述符写入二进制数据。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.writeDescriptorValue替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

client协商远端蓝牙低功耗设备的最大传输单元（Maximum Transmission Unit, MTU），调用connect接口连接成功后才能使用。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.setBLEMtuSize替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

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

setNotifyCharacteristicChanged^(deprecated)

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

向服务端发送设置通知此特征值请求。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.setNotifyCharacteristicChanged替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

示例：

// 创建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

订阅蓝牙低功耗设备的特征值变化事件。需要先调用setNotifyCharacteristicChanged接口才能接收server端的通知。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.on('BLECharacteristicChange')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

取消订阅蓝牙低功耗设备的特征值变化事件。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.off('BLECharacteristicChange')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

client端订阅蓝牙低功耗设备的连接状态变化事件。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.on('BLEConnectionStateChange')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

取消订阅蓝牙低功耗设备的连接状态变化事件。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.off('BLEConnectionStateChange')替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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

getDeviceName^(deprecated)

getDeviceName(callback: AsyncCallback<string>): void

client获取远端蓝牙低功耗设备名。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.getDeviceName替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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>

client获取远端蓝牙低功耗设备名。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.getDeviceName替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

// 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

client获取远端蓝牙低功耗设备的信号强度 (Received Signal Strength Indication, RSSI)，调用connect接口连接成功后才能使用。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.getRssiValue替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

参数：

返回值：

无

示例：

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>

client获取远端蓝牙低功耗设备的信号强度 (Received Signal Strength Indication, RSSI)，调用connect接口连接成功后才能使用。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattClientDevice.getRssiValue替代。

需要权限：ohos.permission.USE_BLUETOOTH

系统能力：SystemCapability.Communication.Bluetooth.Core。

返回值：

示例：

// 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)}

枚举，扫描模式。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.ScanMode替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

BondState^{8+(deprecated)}

枚举，配对状态。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.BondState替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

SppOption^{8+(deprecated)}

描述spp的配置参数。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.SppOption替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

SppType^{8+(deprecated)}

枚举，Spp链路类型。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.SppType替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

GattService^(deprecated)

描述service的接口参数定义。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.GattService替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

BLECharacteristic^(deprecated)

描述characteristic的接口参数定义 。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.BLECharacteristic替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

BLEDescriptor^(deprecated)

描述descriptor的接口参数定义 。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.BLEDescriptor替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

NotifyCharacteristic^(deprecated)

描述server端特征值变化时发送的特征通知参数定义。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.NotifyCharacteristic替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

CharacteristicReadReq^(deprecated)

描述server端订阅后收到的特征值读请求事件参数结构。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.CharacteristicReadRequest替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

CharacteristicWriteReq^(deprecated)

描述server端订阅后收到的特征值写请求事件参数结构。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.CharacteristicWriteRequest替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

DescriptorReadReq^(deprecated)

描述server端订阅后收到的描述符读请求事件参数结构。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.DescriptorReadRequest替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

DescriptorWriteReq^(deprecated)

描述server端订阅后收到的描述符写请求事件参数结构。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.DescriptorWriteRequest替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

ServerResponse^(deprecated)

描述server端回复client端读/写请求的响应参数结构。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.ServerResponse替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

BLEConnectChangedState^(deprecated)

描述Gatt profile连接状态 。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.BLEConnectChangedState替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

ProfileConnectionState^(deprecated)

枚举，蓝牙设备的profile连接状态。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.ProfileConnectionState替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

ScanFilter^(deprecated)

扫描过滤参数。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.ScanFilter替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

ScanOptions^(deprecated)

扫描的配置参数。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.ScanOptions替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

ScanDuty^(deprecated)

枚举，扫描模式。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.ScanDuty替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

MatchMode^(deprecated)

枚举，硬件过滤匹配模式。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.MatchMode替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

ScanResult^(deprecated)

扫描结果上报数据。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.ScanResult替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

BluetoothState^(deprecated)

枚举，蓝牙开关状态。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.BluetoothState替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

AdvertiseSetting^(deprecated)

描述蓝牙低功耗设备发送广播的参数。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.AdvertiseSetting替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

AdvertiseData^(deprecated)

描述BLE广播数据包的内容。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.AdvertiseData替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

ManufactureData^(deprecated)

描述BLE广播数据包的内容。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.ManufactureData替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

ServiceData^(deprecated)

描述广播包中服务数据内容。

说明：
从API version 7开始支持，从API version 9开始废弃。建议使用bluetoothManager.ServiceData替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

PinRequiredParam^{8+(deprecated)}

描述配对请求参数。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.PinRequiredParam替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

BondStateParam^{8+(deprecated)}

描述配对状态参数。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.BondStateParam替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

StateChangeParam^{8+(deprecated)}

描述profile状态改变参数。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.StateChangeParam替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

DeviceClass^{8+(deprecated)}

描述蓝牙设备的类别。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.DeviceClass替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

MajorClass^{8+(deprecated)}

枚举，蓝牙设备主要类别。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.MajorClass替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

MajorMinorClass^{8+(deprecated)}

枚举，主要次要蓝牙设备类别。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.MajorMinorClass替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

PlayingState^{8+(deprecated)}

枚举，蓝牙A2DP 播放状态。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.PlayingState替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。

ProfileId^{8+(deprecated)}

蓝牙profile枚举，API9新增PROFILE_HID_HOST，PROFILE_PAN_NETWORK。

说明：
从API version 8开始支持，从API version 9开始废弃。建议使用bluetoothManager.ProfileId替代。

系统能力：SystemCapability.Communication.Bluetooth.Core。