@ohos.bluetoothManager (蓝牙)

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

说明：

本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。

导入模块

import bluetoothManager from '@ohos.bluetoothManager';

bluetoothManager.enableBluetooth

enableBluetooth(): void

开启蓝牙。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    bluetoothManager.enableBluetooth();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.disableBluetooth

disableBluetooth(): void

关闭蓝牙。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    bluetoothManager.disableBluetooth();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.getLocalName

getLocalName(): string

获取蓝牙本地设备名称。

需要权限：ohos.permission.USE_BLUETOOTH

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

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let localName = bluetoothManager.getLocalName();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.getState

getState(): BluetoothState

获取蓝牙开关状态。

需要权限：ohos.permission.USE_BLUETOOTH

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

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let state = bluetoothManager.getState();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.getBtConnectionState

getBtConnectionState(): ProfileConnectionState

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

需要权限：ohos.permission.USE_BLUETOOTH

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

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let connectionState = bluetoothManager.getBtConnectionState();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.setLocalName

setLocalName(name: string): void

设置蓝牙本地设备名称。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    bluetoothManager.setLocalName('device_name');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.pairDevice

pairDevice(deviceId: string): void

发起蓝牙配对。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    // 实际的地址可由扫描流程获取
    bluetoothManager.pairDevice("XX:XX:XX:XX:XX:XX");
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.getProfileConnectionState

getProfileConnectionState(profileId: ProfileId): ProfileConnectionState

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let result = bluetoothManager.getProfileConnectionState(bluetoothManager.ProfileId.PROFILE_A2DP_SOURCE);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.cancelPairedDevice

cancelPairedDevice(deviceId: string): void

删除配对的远程设备。

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

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    bluetoothManager.cancelPairedDevice("XX:XX:XX:XX:XX:XX");
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.getRemoteDeviceName

getRemoteDeviceName(deviceId: string): string

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let remoteDeviceName = bluetoothManager.getRemoteDeviceName("XX:XX:XX:XX:XX:XX");
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.getRemoteDeviceClass

getRemoteDeviceClass(deviceId: string): DeviceClass

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let remoteDeviceClass = bluetoothManager.getRemoteDeviceClass("XX:XX:XX:XX:XX:XX");
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.getPairedDevices

getPairedDevices(): Array<string>

获取蓝牙配对列表。

需要权限：ohos.permission.USE_BLUETOOTH

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

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let devices = bluetoothManager.getPairedDevices();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.setBluetoothScanMode

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    // 设置为可连接可发现才可被远端设备扫描到，可以连接。
    bluetoothManager.setBluetoothScanMode(bluetoothManager.ScanMode.SCAN_MODE_CONNECTABLE_GENERAL_DISCOVERABLE, 100);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.getBluetoothScanMode

getBluetoothScanMode(): ScanMode

获取蓝牙扫描模式。

需要权限：ohos.permission.USE_BLUETOOTH

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

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let scanMode = bluetoothManager.getBluetoothScanMode();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.startBluetoothDiscovery

startBluetoothDiscovery(): void

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

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

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

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

let deviceId;
function onReceiveEvent(data) {
    deviceId = data;
}
try {
    bluetoothManager.on('bluetoothDeviceFind', onReceiveEvent);
    bluetoothManager.startBluetoothDiscovery();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.stopBluetoothDiscovery

stopBluetoothDiscovery(): void

关闭蓝牙扫描。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    bluetoothManager.stopBluetoothDiscovery();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.setDevicePairingConfirmation

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

设置设备配对请求确认。

需要权限：ohos.permission.MANAGE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    // 订阅“pinRequired”配对请求事件，收到远端配对请求后设置配对确认
    function onReceivePinRequiredEvent(data) { // data为配对请求的入参，配对请求参数
        console.info('pin required  = '+ JSON.stringify(data));
        bluetoothManager.setDevicePairingConfirmation(data.deviceId, true);
    }
    bluetoothManager.on("pinRequired", onReceivePinRequiredEvent);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.on('bluetoothDeviceFind')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

function onReceiveEvent(data) { // data为蓝牙设备地址集合
    console.info('bluetooth device find = '+ JSON.stringify(data));
}
try {
    bluetoothManager.on('bluetoothDeviceFind', onReceiveEvent);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.off('bluetoothDeviceFind')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

function onReceiveEvent(data) {
    console.info('bluetooth device find = '+ JSON.stringify(data));
}
try {
    bluetoothManager.on('bluetoothDeviceFind', onReceiveEvent);
    bluetoothManager.off('bluetoothDeviceFind', onReceiveEvent);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.on('pinRequired')

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

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

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

function onReceiveEvent(data) { // data为配对请求参数
    console.info('pin required = '+ JSON.stringify(data));
}
try {
    bluetoothManager.on('pinRequired', onReceiveEvent);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.off('pinRequired')

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

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

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

function onReceiveEvent(data) {
    console.info('pin required = '+ JSON.stringify(data));
}
try {
    bluetoothManager.on('pinRequired', onReceiveEvent);
    bluetoothManager.off('pinRequired', onReceiveEvent);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.on('bondStateChange')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

function onReceiveEvent(data) { // data为回调函数入参，表示配对的状态
    console.info('pair state = '+ JSON.stringify(data));
}
try {
    bluetoothManager.on('bondStateChange', onReceiveEvent);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.off('bondStateChange')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

function onReceiveEvent(data) {
    console.info('bond state = '+ JSON.stringify(data));
}
try {
    bluetoothManager.on('bondStateChange', onReceiveEvent);
    bluetoothManager.off('bondStateChange', onReceiveEvent);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.on('stateChange')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

function onReceiveEvent(data) {
    console.info('bluetooth state = '+ JSON.stringify(data));
}
try {
    bluetoothManager.on('stateChange', onReceiveEvent);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.off('stateChange')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

function onReceiveEvent(data) {
    console.info('bluetooth state = '+ JSON.stringify(data));
}
try {
    bluetoothManager.on('stateChange', onReceiveEvent);
    bluetoothManager.off('stateChange', onReceiveEvent);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.sppListen

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

创建一个服务端监听Socket。

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

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

let sppOption = {uuid: '00001810-0000-1000-8000-00805F9B34FB', secure: false, type: 0};
try {
    bluetoothManager.sppListen('server1', sppOption, serverSocket);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.sppAccept

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

let serverNumber = -1;
function serverSocket(code, 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, number) {
  console.log('bluetooth error code: ' + code.code);
  if (code.code == 0) {
    console.log('bluetooth clientSocket Number: ' + number);
    // 获取的clientNumber用作服务端后续读/写操作socket的id。
    clientNumber = number;
  }
}
try {
    bluetoothManager.sppAccept(serverNumber, acceptClientSocket);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.sppConnect

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

let clientNumber = -1;
function clientSocket(code, number) {
  if (code.code != 0) {
    return;
  }
  console.log('bluetooth serverSocket Number: ' + number);
  // 获取的clientNumber用作客户端后续读/写操作socket的id。
  clientNumber = number;
}
let sppOption = {uuid: '00001810-0000-1000-8000-00805F9B34FB', secure: false, type: 0};
try {
    bluetoothManager.sppConnect('XX:XX:XX:XX:XX:XX', sppOption, clientSocket);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.sppCloseServerSocket

sppCloseServerSocket(socket: number): void

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

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

let serverNumber = -1;
function serverSocket(code, number) {
  console.log('bluetooth error code: ' + code.code);
  if (code.code == 0) {
    console.log('bluetooth serverSocket Number: ' + number);
    serverNumber = number;
  }
}
try {
    bluetoothManager.sppCloseServerSocket(serverNumber);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.sppCloseClientSocket

sppCloseClientSocket(socket: number): void

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

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

let clientNumber = -1;
function clientSocket(code, number) {
  if (code.code != 0) {
    return;
  }
  console.log('bluetooth serverSocket Number: ' + number);
  // 获取的clientNumber用作客户端后续读/写操作socket的id。
  clientNumber = number;
}
try {
    bluetoothManager.sppCloseClientSocket(clientNumber);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.sppWrite

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

let clientNumber = -1;
function clientSocket(code, number) {
  if (code.code != 0) {
    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;
try {
    bluetoothManager.sppWrite(clientNumber, arrayBuffer);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.on('sppRead')

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

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

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

let clientNumber = -1;
function clientSocket(code, number) {
  if (code.code != 0) {
    return;
  }
  console.log('bluetooth serverSocket Number: ' + number);
  // 获取的clientNumber用作客户端后续读/写操作socket的id。
  clientNumber = number;
}
function dataRead(dataBuffer) {
  let data = new Uint8Array(dataBuffer);
  console.log('bluetooth data is: ' + data[0]);
}
try {
    bluetoothManager.on('sppRead', clientNumber, dataRead);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.off('sppRead')

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

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

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

参数：

示例：

let clientNumber = -1;
function clientSocket(code, number) {
  if (code.code != 0) {
    return;
  }
  console.log('bluetooth serverSocket Number: ' + number);
  // 获取的clientNumber用作客户端后续读/写操作socket的id。
  clientNumber = number;
}
try {
    bluetoothManager.off('sppRead', clientNumber);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.getProfileInstance

getProfileInstance(profileId: ProfileId): A2dpSourceProfile | HandsFreeAudioGatewayProfile | HidHostProfile | PanProfile

通过ProfileId，获取profile的对象实例，API9新增了HidHostProfile，PanProfile。

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

参数：

返回值：

示例：

try {
    let hidHost = bluetoothManager.getProfileInstance(bluetoothManager.ProfileId.PROFILE_HID_HOST);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.BLE

bluetoothManager.BLE.createGattServer

createGattServer(): GattServer

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

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

返回值：

示例：

let gattServer = bluetoothManager.BLE.createGattServer();

bluetoothManager.BLE.createGattClientDevice

createGattClientDevice(deviceId: string): GattClientDevice

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

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

参数：

返回值：

示例：

try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.BLE.getConnectedBLEDevices

getConnectedBLEDevices(): Array<string>

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

需要权限：ohos.permission.USE_BLUETOOTH

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

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let result = bluetoothManager.BLE.getConnectedBLEDevices();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.BLE.startBLEScan

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

发起BLE扫描流程。

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

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

function onReceiveEvent(data) {
    console.info('BLE scan device find result = '+ JSON.stringify(data));
}
try {
    bluetoothManager.BLE.on("BLEDeviceFind", onReceiveEvent);
    bluetoothManager.BLE.startBLEScan(
        [{
            deviceId:"XX:XX:XX:XX:XX:XX",
            name:"test",
            serviceUuid:"00001888-0000-1000-8000-00805f9b34fb"
        }],
        {
            interval: 500,
            dutyMode: bluetoothManager.ScanDuty.SCAN_MODE_LOW_POWER,
            matchMode: bluetoothManager.MatchMode.MATCH_MODE_AGGRESSIVE,
        }
    );
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.BLE.stopBLEScan

stopBLEScan(): void

停止BLE扫描流程。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    bluetoothManager.BLE.stopBLEScan();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.BLE.on('BLEDeviceFind')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

function onReceiveEvent(data) {
    console.info('bluetooth device find = '+ JSON.stringify(data));
}
try {
    bluetoothManager.BLE.on('BLEDeviceFind', onReceiveEvent);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

bluetoothManager.BLE.off('BLEDeviceFind')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

function onReceiveEvent(data) {
    console.info('bluetooth device find = '+ JSON.stringify(data));
}
try {
    bluetoothManager.BLE.on('BLEDeviceFind', onReceiveEvent);
    bluetoothManager.BLE.off('BLEDeviceFind', onReceiveEvent);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

BaseProfile

profile基类。

getConnectionDevices

getConnectionDevices(): Array<string>

获取已连接设备列表。

需要权限：ohos.permission.USE_BLUETOOTH

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

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let a2dpSrc = bluetoothManager.getProfileInstance(bluetoothManager.ProfileId.PROFILE_A2DP_SOURCE) as bluetoothManager.A2dpSourceProfile;
    let retArray = a2dpSrc.getConnectionDevices();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

getDeviceState

getDeviceState(device: string): ProfileConnectionState

获取设备profile的连接状态。

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let a2dpSrc = bluetoothManager.getProfileInstance(bluetoothManager.ProfileId.PROFILE_A2DP_SOURCE) as bluetoothManager.A2dpSourceProfile;
    let ret = a2dpSrc.getDeviceState('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

A2dpSourceProfile

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

connect

connect(device: string): void

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

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let a2dpSrc = bluetoothManager.getProfileInstance(bluetoothManager.ProfileId.PROFILE_A2DP_SOURCE) as bluetoothManager.A2dpSourceProfile;
    a2dpSrc.connect('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

disconnect

disconnect(device: string): void

断开设备的a2dp服务连接。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let a2dpSrc = bluetoothManager.getProfileInstance(bluetoothManager.ProfileId.PROFILE_A2DP_SOURCE) as bluetoothManager.A2dpSourceProfile;
    a2dpSrc.disconnect('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

on('connectionStateChange')

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

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

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

参数：

返回值：

无

示例：

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

off('connectionStateChange')

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

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

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

参数：

返回值：

无

示例：

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

getPlayingState

getPlayingState(device: string): PlayingState

获取设备的播放状态。

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let a2dpSrc = bluetoothManager.getProfileInstance(bluetoothManager.ProfileId.PROFILE_A2DP_SOURCE) as bluetoothManager.A2dpSourceProfile;
    let state = a2dpSrc.getPlayingState('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

HandsFreeAudioGatewayProfile

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

connect

connect(device: string): void

连接设备的HFP服务。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let hfpAg = bluetoothManager.getProfileInstance(bluetoothManager.ProfileId.PROFILE_HANDS_FREE_AUDIO_GATEWAY) as bluetoothManager.HandsFreeAudioGatewayProfile;
    hfpAg.connect('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

disconnect

disconnect(device: string): void

断开连接设备的HFP服务。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let hfpAg = bluetoothManager.getProfileInstance(bluetoothManager.ProfileId.PROFILE_HANDS_FREE_AUDIO_GATEWAY) as bluetoothManager.HandsFreeAudioGatewayProfile;
    hfpAg.disconnect('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

on('connectionStateChange')

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

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

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

参数：

示例：

function onReceiveEvent(data) {
    console.info('hfp state = '+ JSON.stringify(data));
}
let hfpAg = bluetoothManager.getProfileInstance(bluetoothManager.ProfileId.PROFILE_HANDS_FREE_AUDIO_GATEWAY) as
  bluetoothManager.HandsFreeAudioGatewayProfile;
hfpAg.on('connectionStateChange', onReceiveEvent);

off('connectionStateChange')

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

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

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

参数：

示例：

function onReceiveEvent(data) {
    console.info('hfp state = '+ JSON.stringify(data));
}
let hfpAg = bluetoothManager.getProfileInstance(bluetoothManager.ProfileId.PROFILE_HANDS_FREE_AUDIO_GATEWAY) as
  bluetoothManager.HandsFreeAudioGatewayProfile;
hfpAg.on('connectionStateChange', onReceiveEvent);
hfpAg.off('connectionStateChange', onReceiveEvent);

HidHostProfile

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

connect

connect(device: string): void

连接设备的HidHost服务。

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

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let hidHostProfile = bluetoothManager.getProfileInst(bluetoothManager.ProfileId.PROFILE_HID_HOST) as bluetoothManager.HidHostProfile;
    hidHostProfile.connect('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

disconnect

disconnect(device: string): void

断开连接设备的HidHost服务。

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

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let hidHostProfile = bluetoothManager.getProfileInst(bluetoothManager.ProfileId.PROFILE_HID_HOST) as bluetoothManager.HidHostProfile;
    hidHostProfile.disconnect('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

on('connectionStateChange')

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

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

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

参数：

示例：

function onReceiveEvent(data) {
    console.info('hidHost state = '+ JSON.stringify(data));
}
let hidHost = bluetoothManager.getProfileInst(bluetoothManager.ProfileId.PROFILE_HID_HOST) as bluetoothManager.HidHostProfile;
hidHost.on('connectionStateChange', onReceiveEvent);

off('connectionStateChange')

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

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

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

参数：

示例：

function onReceiveEvent(data) {
    console.info('hidHost state = '+ JSON.stringify(data));
}
let hidHost = bluetoothManager.getProfileInst(bluetoothManager.ProfileId.PROFILE_HID_HOST) as bluetoothManager.HidHostProfile;
hidHost.on('connectionStateChange', onReceiveEvent);
hidHost.off('connectionStateChange', onReceiveEvent);

PanProfile

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

disconnect

disconnect(device: string): void

断开连接设备的Pan服务。

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let panProfile = bluetoothManager.getProfileInst(bluetoothManager.ProfileId.PROFILE_PAN_NETWORK) as bluetoothManager.PanProfile;
    panProfile.disconnect('XX:XX:XX:XX:XX:XX');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

on('connectionStateChange')

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

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

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

参数：

示例：

function onReceiveEvent(data) {
    console.info('pan state = '+ JSON.stringify(data));
}
let panProfile = bluetoothManager.getProfileInst(bluetoothManager.ProfileId.PROFILE_PAN_NETWORK) as bluetoothManager.PanProfile;
panProfile.on('connectionStateChange', onReceiveEvent);

off('connectionStateChange')

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

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

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

参数：

示例：

function onReceiveEvent(data) {
    console.info('pan state = '+ JSON.stringify(data));
}
let panProfile = bluetoothManager.getProfileInst(bluetoothManager.ProfileId.PROFILE_PAN_NETWORK) as bluetoothManager.PanProfile;
panProfile.on('connectionStateChange', onReceiveEvent);
panProfile.off('connectionStateChange', onReceiveEvent);

setTethering

setTethering(enable: boolean): void

设置网络共享状态。

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

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let panProfile = bluetoothManager.getProfileInst(bluetoothManager.ProfileId.PROFILE_PAN_NETWORK) as bluetoothManager.PanProfile;
    panProfile.setTethering(true);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

isTetheringOn

isTetheringOn(): boolean

获取网络共享状态。

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

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

返回值：

示例：

try {
    let panProfile = bluetoothManager.getProfileInst(bluetoothManager.ProfileId.PROFILE_PAN_NETWORK) as bluetoothManager.PanProfile;
    let ret = panProfile.isTetheringOn();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

GattServer

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

startAdvertising

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

开始发送BLE广播。

需要权限：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 = bluetoothManager.BLE.createGattServer();
try {
    gattServer.startAdvertising({
            interval:150,
            txPower:60,
            connectable:true,
        },{
            serviceUuids:["00001888-0000-1000-8000-00805f9b34fb"],
            manufactureData:[{
                 manufactureId:4567,
                 manufactureValue:manufactureValueBuffer.buffer
            }],
            serviceData:[{
                serviceUuid:"00001888-0000-1000-8000-00805f9b34fb",
                serviceValue:serviceValueBuffer.buffer
            }],
        },{
            serviceUuids:["00001889-0000-1000-8000-00805f9b34fb"],
            manufactureData:[{
                manufactureId:1789,
                manufactureValue:manufactureValueBuffer.buffer
            }],
            serviceData:[{
                serviceUuid:"00001889-0000-1000-8000-00805f9b34fb",
                serviceValue:serviceValueBuffer.buffer
            }],
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

stopAdvertising

stopAdvertising(): void

停止发送BLE广播。

需要权限：ohos.permission.DISCOVER_BLUETOOTH

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

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

let server = bluetoothManager.BLE.createGattServer();
try {
    server.stopAdvertising();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

addService

addService(service: GattService): void

server端添加服务。

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

// 创建descriptors
let descriptors = [];
let arrayBuffer = new ArrayBuffer(8);
let descV = new Uint8Array(arrayBuffer);
descV[0] = 11;
let descriptor = {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 = [];
let arrayBufferC = new ArrayBuffer(8);
let cccV = new Uint8Array(arrayBufferC);
cccV[0] = 1;
let characteristic = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB', characteristicValue: arrayBufferC, descriptors:descriptors};
let characteristicN = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001821-0000-1000-8000-00805F9B34FB', characteristicValue: arrayBufferC, descriptors:descriptors};
characteristics[0] = characteristic;

// 创建gattService
let gattService = {serviceUuid:'00001810-0000-1000-8000-00805F9B34FB', isPrimary: true, characteristics:characteristics, includeServices:[]};

let gattServer = bluetoothManager.BLE.createGattServer();
try {
    gattServer.addService(gattService);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

removeService

removeService(serviceUuid: string): void

删除已添加的服务。

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

let server = bluetoothManager.BLE.createGattServer();
try {
    server.removeService('00001810-0000-1000-8000-00805F9B34FB');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

close

close(): void

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

需要权限：ohos.permission.USE_BLUETOOTH

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

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

let server = bluetoothManager.BLE.createGattServer();
try {
    server.close();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

notifyCharacteristicChanged

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

// 创建descriptors
let descriptors = [];
let arrayBuffer = new ArrayBuffer(8);
let descV = new Uint8Array(arrayBuffer);
descV[0] = 11;
let descriptor = {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 = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB', characteristicValue: arrayBufferC, descriptors:descriptors};
let notifyCharacteristic = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001821-0000-1000-8000-00805F9B34FB', characteristicValue: characteristic.characteristicValue, confirm: false};
let server = bluetoothManager.BLE.createGattServer();
try {
    server.notifyCharacteristicChanged('XX:XX:XX:XX:XX:XX', notifyCharacteristic);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

sendResponse

sendResponse(serverResponse: ServerResponse): void

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

需要权限：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 = {
    "deviceId": "XX:XX:XX:XX:XX:XX",
    "transId": 0,
    "status": 0,
    "offset": 0,
    "value": arrayBufferCCC,
};

let gattServer = bluetoothManager.BLE.createGattServer();
try {
    gattServer.sendResponse(serverResponse);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

on('characteristicRead')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

示例：

let arrayBufferCCC = new ArrayBuffer(8);
let cccValue = new Uint8Array(arrayBufferCCC);
cccValue[0] = 1123;
function ReadCharacteristicReq(CharacteristicReadRequest) {
    let deviceId = CharacteristicReadRequest.deviceId;
    let transId = CharacteristicReadRequest.transId;
    let offset = CharacteristicReadRequest.offset;
    let characteristicUuid = CharacteristicReadRequest.characteristicUuid;

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

    try {
        gattServer.sendResponse(serverResponse);
    } catch (err) {
        console.error("errCode:" + err.code + ",errMessage:" + err.message);
    }
}

let gattServer = bluetoothManager.BLE.createGattServer();
gattServer.on("characteristicRead", ReadCharacteristicReq);

off('characteristicRead')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

示例：

let gattServer = bluetoothManager.BLE.createGattServer();
gattServer.off("characteristicRead");

on('characteristicWrite')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

示例：

let arrayBufferCCC = new ArrayBuffer(8);
let cccValue = new Uint8Array(arrayBufferCCC);
function WriteCharacteristicReq(CharacteristicWriteRequest) {
    let deviceId = CharacteristicWriteRequest.deviceId;
    let transId = CharacteristicWriteRequest.transId;
    let offset = CharacteristicWriteRequest.offset;
    let isPrep = CharacteristicWriteRequest.isPrep;
    let needRsp = CharacteristicWriteRequest.needRsp;
    let value =  new Uint8Array(CharacteristicWriteRequest.value);
    let characteristicUuid = CharacteristicWriteRequest.characteristicUuid;

    cccValue[0] = value[0];
    let serverResponse = {deviceId: deviceId, transId: transId, status: 0, offset: offset, value:arrayBufferCCC};

    try {
        gattServer.sendResponse(serverResponse);
    } catch (err) {
        console.error("errCode:" + err.code + ",errMessage:" + err.message);
    }
}

let gattServer = bluetoothManager.BLE.createGattServer();
gattServer.on("characteristicWrite", WriteCharacteristicReq);

off('characteristicWrite')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

示例：

let gattServer = bluetoothManager.BLE.createGattServer();
gattServer.off("characteristicWrite");

on('descriptorRead')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

示例：

let arrayBufferDesc = new ArrayBuffer(8);
let descValue = new Uint8Array(arrayBufferDesc);
descValue[0] = 1101;
function ReadDescriptorReq(DescriptorReadRequest) {
    let deviceId = DescriptorReadRequest.deviceId;
    let transId = DescriptorReadRequest.transId;
    let offset = DescriptorReadRequest.offset;
    let descriptorUuid = DescriptorReadRequest.descriptorUuid;

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

    try {
        gattServer.sendResponse(serverResponse);
    } catch (err) {
        console.error("errCode:" + err.code + ",errMessage:" + err.message);
    }
}

let gattServer = bluetoothManager.BLE.createGattServer();
gattServer.on("descriptorRead", ReadDescriptorReq);

off('descriptorRead')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

示例：

let gattServer = bluetoothManager.BLE.createGattServer();
gattServer.off("descriptorRead");

on('descriptorWrite')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

示例：

let arrayBufferDesc = new ArrayBuffer(8);
let descValue = new Uint8Array(arrayBufferDesc);
function WriteDescriptorReq(DescriptorWriteRequest) {
    let deviceId = DescriptorWriteRequest.deviceId;
    let transId = DescriptorWriteRequest.transId;
    let offset = DescriptorWriteRequest.offset;
    let isPrep = DescriptorWriteRequest.isPrep;
    let needRsp = DescriptorWriteRequest.needRsp;
    let value = new Uint8Array(DescriptorWriteRequest.value);
    let descriptorUuid = DescriptorWriteRequest.descriptorUuid;

    descValue[0] = value[0];
    let serverResponse = {deviceId: deviceId, transId: transId, status: 0, offset: offset, value:arrayBufferDesc};

    try {
        gattServer.sendResponse(serverResponse);
    } catch (err) {
        console.error("errCode:" + err.code + ",errMessage:" + err.message);
    }
}

let gattServer = bluetoothManager.BLE.createGattServer();
gattServer.on("descriptorRead", WriteDescriptorReq);

off('descriptorWrite')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

示例：

let gattServer = bluetoothManager.BLE.createGattServer();
gattServer.off("descriptorWrite");

on('connectStateChange')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

示例：

function Connected(BLEConnectChangedState) {
  let deviceId = BLEConnectChangedState.deviceId;
  let status = BLEConnectChangedState.state;
}

let gattServer = bluetoothManager.BLE.createGattServer();
gattServer.on("connectStateChange", Connected);

off('connectStateChange')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

示例：

let gattServer = bluetoothManager.BLE.createGattServer();
gattServer.off("connectStateChange");

GattClientDevice

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

connect

connect(): void

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

需要权限：ohos.permission.USE_BLUETOOTH

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

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.connect();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

disconnect

disconnect(): void

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

需要权限：ohos.permission.USE_BLUETOOTH

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

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.disconnect();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

close

close(): void

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

需要权限：ohos.permission.USE_BLUETOOTH

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

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.close();
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

getServices

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

// callkback 模式
function getServices(code, gattServices) {
  if (code.code == 0) {
      let services = 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);
      }
  }
}

try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.connect();
    device.getServices(getServices);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

getServices

getServices(): Promise<Array<GattService>>

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

需要权限：ohos.permission.USE_BLUETOOTH

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

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

// Promise 模式
try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.connect();
    device.getServices().then(result => {
        console.info("getServices successfully:" + JSON.stringify(result));
    });
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

readCharacteristicValue

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

function readCcc(code, 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 descriptors = [];
let bufferDesc = new ArrayBuffer(8);
let descV = new Uint8Array(bufferDesc);
descV[0] = 11;
let descriptor = {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 = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
characteristicValue: bufferCCC, descriptors:descriptors};

try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.readCharacteristicValue(characteristic, readCcc);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

readCharacteristicValue

readCharacteristicValue(characteristic: BLECharacteristic): Promise<BLECharacteristic>

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

let descriptors = [];
let bufferDesc = new ArrayBuffer(8);
let descV = new Uint8Array(bufferDesc);
descV[0] = 11;
let descriptor = {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 = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
characteristicValue: bufferCCC, descriptors:descriptors};

try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.readCharacteristicValue(characteristic);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

readDescriptorValue

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

function readDesc(code, 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 bufferDesc = new ArrayBuffer(8);
let descV = new Uint8Array(bufferDesc);
descV[0] = 11;
let descriptor = {
    serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
    characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
    descriptorUuid: '00002903-0000-1000-8000-00805F9B34FB',
    descriptorValue: bufferDesc
};
try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.readDescriptorValue(descriptor, readDesc);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

readDescriptorValue

readDescriptorValue(descriptor: BLEDescriptor): Promise<BLEDescriptor>

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

let bufferDesc = new ArrayBuffer(8);
let descV = new Uint8Array(bufferDesc);
descV[0] = 11;
let descriptor = {
    serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
    characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
    descriptorUuid: '00002903-0000-1000-8000-00805F9B34FB',
    descriptorValue: bufferDesc
};
try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.readDescriptorValue(descriptor);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

writeCharacteristicValue

writeCharacteristicValue(characteristic: BLECharacteristic): void

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

let descriptors = [];
let bufferDesc = new ArrayBuffer(8);
let descV = new Uint8Array(bufferDesc);
descV[0] = 11;
let descriptor = {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 = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
  characteristicValue: bufferCCC, descriptors:descriptors};
try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.writeCharacteristicValue(characteristic);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

writeDescriptorValue

writeDescriptorValue(descriptor: BLEDescriptor): void

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

let bufferDesc = new ArrayBuffer(8);
let descV = new Uint8Array(bufferDesc);
descV[0] = 22;
let descriptor = {
    serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
    characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB',
    descriptorUuid: '00002903-0000-1000-8000-00805F9B34FB',
    descriptorValue: bufferDesc
};
try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.writeDescriptorValue(descriptor);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

setBLEMtuSize

setBLEMtuSize(mtu: number): void

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.setBLEMtuSize(128);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

setNotifyCharacteristicChanged

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

// 创建descriptors
let descriptors = [];
let arrayBuffer = new ArrayBuffer(8);
let descV = new Uint8Array(arrayBuffer);
descV[0] = 11;
let descriptor = {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 = {serviceUuid: '00001810-0000-1000-8000-00805F9B34FB',
  characteristicUuid: '00001820-0000-1000-8000-00805F9B34FB', characteristicValue: arrayBufferC, descriptors:descriptors};
try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.setNotifyCharacteristicChanged(characteristic, false);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

on('BLECharacteristicChange')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

示例：

function CharacteristicChange(CharacteristicChangeReq) {
    let serviceUuid = CharacteristicChangeReq.serviceUuid;
    let characteristicUuid = CharacteristicChangeReq.characteristicUuid;
    let value = new Uint8Array(CharacteristicChangeReq.characteristicValue);
}
try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.on('BLECharacteristicChange', CharacteristicChange);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

off('BLECharacteristicChange')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

示例：

try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.off('BLECharacteristicChange');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

on('BLEConnectionStateChange')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

示例：

function ConnectStateChanged(state) {
  console.log('bluetooth connect state changed');
  let connectState = state.state;
}
try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.on('BLEConnectionStateChange', ConnectStateChanged);
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

off('BLEConnectionStateChange')

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

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

示例：

try {
    let device = bluetoothManager.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
    device.off('BLEConnectionStateChange');
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

getDeviceName

getDeviceName(callback: AsyncCallback<string>): void

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

// callback
try {
    let gattClient = bluetoothManager.BLE.createGattClientDevice("XX:XX:XX:XX:XX:XX");
    gattClient.connect();
    let deviceName = gattClient.getDeviceName((err, data)=> {
        console.info('device name err ' + JSON.stringify(err));
        console.info('device name' + JSON.stringify(data));
    })
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

getDeviceName

getDeviceName(): Promise<string>

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

需要权限：ohos.permission.USE_BLUETOOTH

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

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

// promise
try {
    let gattClient = bluetoothManager.BLE.createGattClientDevice("XX:XX:XX:XX:XX:XX");
    gattClient.connect();
    let deviceName = gattClient.getDeviceName().then((data) => {
        console.info('device name' + JSON.stringify(data));
    })
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

getRssiValue

getRssiValue(callback: AsyncCallback<number>): void

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

需要权限：ohos.permission.USE_BLUETOOTH

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

参数：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

// callback
try {
    let gattClient = bluetoothManager.BLE.createGattClientDevice("XX:XX:XX:XX:XX:XX");
    gattClient.connect();
    let rssi = gattClient.getRssiValue((err, data)=> {
        console.info('rssi err ' + JSON.stringify(err));
        console.info('rssi value' + JSON.stringify(data));
    })
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

getRssiValue

getRssiValue(): Promise<number>

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

需要权限：ohos.permission.USE_BLUETOOTH

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

返回值：

错误码：

以下错误码的详细介绍请参见蓝牙服务子系统错误码。

示例：

// promise
try {
    let gattClient = bluetoothManager.BLE.createGattClientDevice("XX:XX:XX:XX:XX:XX");
    let rssi = gattClient.getRssiValue().then((data) => {
        console.info('rssi' + JSON.stringify(data));
    })
} catch (err) {
    console.error("errCode:" + err.code + ",errMessage:" + err.message);
}

ScanMode

枚举，扫描模式。

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

BondState

枚举，配对状态。

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

SppOption

描述spp的配置参数。

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

SppType

枚举，Spp链路类型。

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

GattService

描述service的接口参数定义。

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

BLECharacteristic

描述characteristic的接口参数定义 。

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

BLEDescriptor

描述descriptor的接口参数定义 。

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

NotifyCharacteristic

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

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

CharacteristicReadRequest

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

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

CharacteristicWriteRequest

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

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

DescriptorReadRequest

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

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

DescriptorWriteRequest

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

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

ServerResponse

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

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

BLEConnectChangedState

描述Gatt profile连接状态 。

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

ProfileConnectionState

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

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

ScanFilter

扫描过滤参数。

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

ScanOptions

扫描的配置参数。

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

ScanDuty

枚举，扫描模式。

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

MatchMode

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

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

ScanResult

扫描结果上报数据。

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

BluetoothState

枚举，蓝牙开关状态。

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

AdvertiseSetting

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

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

AdvertiseData

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

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

ManufactureData

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

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

ServiceData

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

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

PinRequiredParam

描述配对请求参数。

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

BondStateParam

描述配对状态参数。

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

StateChangeParam

描述profile状态改变参数。

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

DeviceClass

描述蓝牙设备的类别。

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

MajorClass

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

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

MajorMinorClass

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

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

PlayingState

枚举，蓝牙A2DP 播放状态。

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

ProfileId

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

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