蓝牙

说明： 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。
开发前请熟悉鸿蒙开发指导文档 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

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

导入模块

import bluetooth from '@ohos.bluetooth';

bluetooth.enableBluetooth8+[]()

enableBluetooth(): boolean

开启蓝牙。

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

返回值：

类型	说明
boolean	打开蓝牙，成功返回true，否则返回false。

示例：

let enable = bluetooth.enableBluetooth();

bluetooth.disableBluetooth8+[]()

disableBluetooth(): boolean

关闭蓝牙。

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

返回值：

类型	说明
boolean	关闭蓝牙，成功返回true，否则返回false。

示例：

let disable = bluetooth.disableBluetooth();

bluetooth.getLocalName8+[]()

getLocalName(): string

获取蓝牙本地设备名称。

需要权限 ：ohos.permission.USE_BLUETOOTH

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

返回值：

类型	说明
string	蓝牙本地设备名称。

示例：

let localName = bluetooth.getLocalName();

bluetooth.getState

getState(): BluetoothState

获取蓝牙开关状态。

需要权限 ：ohos.permission.USE_BLUETOOTH

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

返回值：

类型	说明
[BluetoothState]	表示蓝牙开关状态。

示例：

let state = bluetooth.getState();

bluetooth.getBtConnectionState

getBtConnectionState(): ProfileConnectionState

获取蓝牙设备的Profile连接状态。

需要权限 ：ohos.permission.USE_BLUETOOTH

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

返回值：

类型	说明
[ProfileConnectionState]	表示蓝牙设备的Profile连接状态。

示例：

let connectionState = bluetooth.getBtConnectionState();

bluetooth.setLocalName8+[]()

setLocalName(name: string): boolean

设置蓝牙本地设备名称。

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

参数名	类型	必填	说明
name	string	是	要设置的蓝牙名称，最大长度为248字节数。

返回值：

类型	说明
boolean	设置蓝牙本地设备名称，成功返回true，否则返回false。

示例：

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

bluetooth.pairDevice

pairDevice(deviceId: string): boolean

发起蓝牙配对。

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

参数名	类型	必填	说明
deviceId	string	是	表示配对的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。

返回值：

类型	说明
boolean	发起蓝牙配对，成功返回true，否则返回false。

示例：

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

bluetooth.getProfileConnState8+[]()

getProfileConnState(profileId: ProfileId): ProfileConnectionState

获取profile的连接状态。

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
ProfileId	profileId	是	表示profile的枚举值，例如：PROFILE_A2DP_SOURCE。

返回值：

类型	说明
[ProfileConnectionState]	profile的连接状态。

示例：

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

bluetooth.cancelPairedDevice8+[]()

cancelPairedDevice(deviceId: string): boolean

删除配对的远程设备。

此接口为系统接口。

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

参数名	类型	必填	说明
deviceId	string	是	表示要删除的远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。

返回值：

类型	说明
boolean	启动取消配对，成功返回true，否则返回false。

示例：

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

bluetooth.getRemoteDeviceName8+[]()

getRemoteDeviceName(deviceId: string): string

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
deviceId	string	是	表示远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。

返回值：

类型	说明
string	以字符串格式返回设备名称。

示例：

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

bluetooth.getRemoteDeviceClass8+[]()

getRemoteDeviceClass(deviceId: string): DeviceClass

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
deviceId	string	是	表示远程设备的地址，例如："XX:XX:XX:XX:XX:XX"。

返回值：

类型	说明
[DeviceClass]	远程设备的类别。

示例：

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

bluetooth.getPairedDevices8+[]()

getPairedDevices(): Array

获取蓝牙配对列表。

需要权限 ：ohos.permission.USE_BLUETOOTH

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

返回值：

类型	说明
Array	已配对蓝牙设备的地址列表。

示例：

let devices = bluetooth.getPairedDevices();

bluetooth.setBluetoothScanMode8+[]()

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
mode	[ScanMode]	是	蓝牙扫描模式。
duration	number	是	设备可被发现的持续时间，单位为毫秒；设置为0则持续可发现。

返回值：

类型	说明
boolean	设置蓝牙扫描，成功返回true，否则返回false。

示例：

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

bluetooth.getBluetoothScanMode8+[]()

getBluetoothScanMode(): ScanMode

获取蓝牙扫描模式。

需要权限 ：ohos.permission.USE_BLUETOOTH

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

返回值：

类型	说明
[ScanMode]	蓝牙扫描模式。

示例：

let scanMode = bluetooth.getBluetoothScanMode();

bluetooth.startBluetoothDiscovery8+[]()

startBluetoothDiscovery(): boolean

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

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

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

返回值：

类型	说明
boolean	开启蓝牙扫描，成功返回true，否则返回false。

示例：

let deviceId;
function onReceiveEvent(data) {
    deviceId = data;
}
bluetooth.on('bluetoothDeviceFind', onReceiveEvent);
let result = bluetooth.startBluetoothDiscovery();

bluetooth.stopBluetoothDiscovery8+[]()

stopBluetoothDiscovery(): boolean

关闭蓝牙扫描。

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

返回值：

类型	说明
boolean	关闭蓝牙扫描，成功返回true，否则返回false。

示例：

let result = bluetooth.stopBluetoothDiscovery();

bluetooth.setDevicePairingConfirmation8+[]()

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

设置设备配对请求确认。

需要权限 ：ohos.permission.MANAGE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
device	string	是	表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。
accept	boolean	是	接受配对请求设置为true，否则设置为false。

返回值：

类型	说明
boolean	设置设备配对确认，成功返回true，否则返回false。

示例：

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

bluetooth.on('bluetoothDeviceFind')8+

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"bluetoothDeviceFind"字符串，表示蓝牙设备发现事件。
callback	Callback>	是	表示回调函数的入参，发现的设备集合。回调函数由用户创建通过该接口注册。

返回值：

无

示例：

function onReceiveEvent(data) { // data为蓝牙设备地址集合
    console.info('bluetooth device find = '+ JSON.stringify(data));
}
bluetooth.on('bluetoothDeviceFind', onReceiveEvent);

bluetooth.off('bluetoothDeviceFind')8+

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"bluetoothDeviceFind"字符串，表示蓝牙设备发现事件。
callback	Callback>	否	表示取消订阅蓝牙设备发现事件上报。不填该参数则取消订阅该type对应的所有回调。

返回值：

无

示例：

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

bluetooth.on('pinRequired')8+

on(type: "pinRequired", callback: Callback): void

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

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"pinRequired"字符串，表示配对请求事件。
callback	Callback<[PinRequiredParam]>	是	表示回调函数的入参，配对请求。回调函数由用户创建通过该接口注册。

返回值：

无

示例：

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

bluetooth.off('pinRequired')8+

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

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

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"pinRequired"字符串，表示配对请求事件。
callback	Callback<[PinRequiredParam]>	否	表示取消订阅蓝牙配对请求事件上报，入参为配对请求参数。不填该参数则取消订阅该type对应的所有回调。

返回值：

无

示例：

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

bluetooth.on('bondStateChange')8+

on(type: "bondStateChange", callback: Callback): void

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"bondStateChange"字符串，表示蓝牙配对状态改变事件。
callback	Callback<[BondStateParam]>	是	表示回调函数的入参，配对的状态。回调函数由用户创建通过该接口注册。

返回值：

无

示例：

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

bluetooth.off('bondStateChange')8+

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"bondStateChange"字符串，表示蓝牙配对状态改变事件。
callback	Callback<[BondStateParam]>	否	表示取消订阅蓝牙配对状态改变事件上报。不填该参数则取消订阅该type对应的所有回调。

返回值：

无

示例：

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

bluetooth.on('stateChange')8+

on(type: "stateChange", callback: Callback): void

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"stateChange"字符串，表示蓝牙状态改变事件。
callback	Callback<[BluetoothState]>	是	表示回调函数的入参，蓝牙状态。回调函数由用户创建通过该接口注册。

返回值：

无

示例：

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

bluetooth.off('stateChange')8+

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"stateChange"字符串，表示蓝牙状态改变事件。
callback	Callback<[BluetoothState]>	否	表示取消订阅蓝牙状态改变事件上报。不填该参数则取消订阅该type对应的所有回调。

返回值：

无

示例：

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

bluetooth.sppListen8+[]()

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

创建一个服务端监听Socket。

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
name	string	是	服务的名称。
option	[SppOption]	是	spp监听配置参数。
callback	AsyncCallback	是	表示回调函数的入参，服务端Socket的id。

示例：

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};
bluetooth.sppListen('server1', sppOption, serverSocket);

bluetooth.sppAccept8+[]()

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

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

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

参数：

参数名	类型	必填	说明
serverSocket	number	是	服务端socket的id。
callback	AsyncCallback	是	表示回调函数的入参，客户端socket的id。

示例：

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;
  }
}
bluetooth.sppAccept(serverNumber, acceptClientSocket);

bluetooth.sppConnect8+[]()

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
device	string	是	对端设备地址，例如："XX:XX:XX:XX:XX:XX"。
option	[SppOption]	是	spp客户端连接配置参数。
callback	AsyncCallback	是	表示回调函数的入参，客户端socket的id。

示例：

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};
bluetooth.sppConnect('XX:XX:XX:XX:XX:XX', sppOption, clientSocket);

bluetooth.sppCloseServerSocket8+[]()

sppCloseServerSocket(socket: number): void

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

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

参数：

参数名	类型	必填	说明
socket	number	是	服务端监听socket的id。

示例：

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;
  }
}
bluetooth.sppCloseServerSocket(serverNumber);

bluetooth.sppCloseClientSocket8+[]()

sppCloseClientSocket(socket: number): void

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

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

参数：

参数名	类型	必填	说明
参数名	类型	必填	说明
socket	number	是	客户端socket的id。

示例：

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

bluetooth.sppWrite8+[]()

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

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

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

参数：

参数名	类型	必填	说明
clientSocket	number	是	客户端socket的id。
data	ArrayBuffer	是	写入的数据。

返回值：

类型	说明
boolean	写数据操作，成功返回true，否则返回false。

示例：

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;
let ret = bluetooth.sppWrite(clientNumber, arrayBuffer);
if (ret) {
  console.log('spp write successfully');
} else {
  console.log('spp write failed');
}

bluetooth.on('sppRead')8+

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

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

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

参数：

参数名	类型	必填	说明
type	string	是	填写"sppRead"字符串，表示spp读请求事件。
clientSocket	number	是	客户端socket的id。
callback	Callback	是	表示回调函数的入参，读取到的数据。

返回值：

无

示例：

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]);
}
bluetooth.on('sppRead', clientNumber, dataRead);

bluetooth.off('sppRead')8+

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

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

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

参数：

参数名	类型	必填	说明
type	string	是	填写"sppRead"字符串，表示spp读请求事件。
clientSocket	number	是	客户端Socket的id。
callback	Callback	否	表示取消订阅spp读请求事件上报。不填该参数则取消订阅该type对应的所有回调。

返回值：

无

示例：

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

bluetooth.getProfile8+[]()

getProfile(profileId: ProfileId): A2dpSourceProfile | HandsFreeAudioGatewayProfile

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

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

参数：

参数名	类型	必填	说明
profileId	[ProfileId]	是	表示profile的枚举值，例如：PROFILE_A2DP_SOURCE。

返回值：

类型	说明
[A2dpSourceProfile]或[HandsFreeAudioGatewayProfile]	对应的profile的对象实例，当前支持A2dpSourceProfile， HandsFreeAudioGatewayProfile。

示例：

let a2dpSrc = bluetooth.getProfile(bluetooth.ProfileId.PROFILE_A2DP_SOURCE);

bluetooth.getProfile9+[]()

getProfile(profileId: ProfileId): A2dpSourceProfile | HandsFreeAudioGatewayProfile | HidHostProfile

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

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

参数：

参数名	类型	必填	说明
profileId	[ProfileId]	是	表示profile的枚举值，例如：PROFILE_A2DP_SOURCE。

返回值：

类型	说明
[A2dpSourceProfile]或 [HandsFreeAudioGatewayProfile]或[HidHostProfile]	对应的profile的对象实例，当前支持A2dpSourceProfile/HandsFreeAudioGatewayProfile/HidHostProfile。

示例：

let hidHost = bluetooth.getProfile(bluetooth.ProfileId.PROFILE_HID_HOST);

bluetooth.BLE

bluetooth.BLE.createGattServer

createGattServer(): GattServer

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

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

返回值：

类型	说明
[GattServer]	server端类，使用server端方法之前需要创建该类的实例进行操作。

示例：

let gattServer = bluetooth.BLE.createGattServer();

bluetooth.BLE.createGattClientDevice

createGattClientDevice(deviceId: string): GattClientDevice

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

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

参数：

参数名	类型	必填	说明
deviceId	string	是	对端设备地址，例如："XX:XX:XX:XX:XX:XX"。

返回值：

类型	说明
[GattClientDevice]	client端类，使用client端方法之前需要创建该类的实例进行操作。

示例：

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

bluetooth.BLE.getConnectedBLEDevices

getConnectedBLEDevices(): Array

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

返回值：

类型	说明
Array	返回当前设备作为Server端时连接BLE设备地址集合。

示例：

let result = bluetooth.BLE.getConnectedBLEDevices();

bluetooth.BLE.startBLEScan

startBLEScan(filters: Array, options?: ScanOptions): void

发起BLE扫描流程。

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

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

参数：

参数名	类型	必填	说明
filters	Array<[ScanFilter]>	是	表示扫描结果过滤策略集合，如果不使用过滤的方式，该参数设置为null。
options	[ScanOptions]	否	表示扫描的参数配置，可选参数。

返回值：

无

示例：

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

bluetooth.BLE.stopBLEScan

stopBLEScan(): void

停止BLE扫描流程。

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

返回值：

无

示例：

bluetooth.BLE.stopBLEScan();

bluetooth.BLE.on('BLEDeviceFind')

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"BLEDeviceFind"字符串，表示BLE设备发现事件。
callback	Callback>	是	表示回调函数的入参，发现的设备集合。回调函数由用户创建通过该接口注册。

返回值：

无

示例：

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

bluetooth.BLE.off('BLEDeviceFind')

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"BLEDeviceFind"字符串，表示BLE设备发现事件。
callback	Callback>	否	表示取消订阅BLE设备发现事件上报。不填该参数则取消订阅该type对应的所有回调。

返回值：

无

示例：

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

BaseProfile

profile基类。

getConnectionDevices8+[]()

getConnectionDevices(): Array

获取已连接设备列表。

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

无

返回值：

类型	说明
Array	返回已连接设备的地址列表。

示例：

let a2dpSrc = bluetooth.getProfile(bluetooth.ProfileId.PROFILE_A2DP_SOURCE)
let retArray = a2dpSrc.getConnectionDevices();

getDeviceState8+[]()

getDeviceState(device: string): ProfileConnectionState

获取设备profile的连接状态。

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
device	string	是	远端设备地址。

返回值：

类型	说明
[ProfileConnectionState]	返回profile的连接状态。

示例：

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

A2dpSourceProfile

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

connect8+[]()

connect(device: string): boolean

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

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

参数名	类型	必填	说明
device	string	是	远端设备地址。

返回值：

类型	说明
boolean	成功返回true，失败返回false。

示例：

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

disconnect8+[]()

disconnect(device: string): boolean

断开设备的a2dp服务连接。

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

参数名	类型	必填	说明
device	string	是	远端设备地址。

返回值：

类型	说明
boolean	成功返回true，失败返回false。

示例：

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

on('connectionStateChange')8+

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

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

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

参数：

参数名	类型	必填	说明
type	string	是	填写"connectionStateChange"字符串，表示连接状态变化事件。
callback	Callback<[StateChangeParam]>	是	表示回调函数的入参。

返回值：

无

示例：

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

off('connectionStateChange')8+

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

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

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

参数：

参数名	类型	必填	说明
type	string	是	填写"connectionStateChange"字符串，表示连接状态变化事件。
callback	Callback<[StateChangeParam]>	否	表示回调函数的入参。

返回值：

无

示例：

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

getPlayingState9+

getPlayingState(device: string): PlayingState

获取设备的播放状态。

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
device	string	是	远端设备地址。

返回值：

类型	说明
[PlayingState]	远端设备的播放状态。

示例：

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

HandsFreeAudioGatewayProfile

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

connect8+[]()

connect(device: string): boolean

连接设备的HFP服务。

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

参数名	类型	必填	说明
device	string	是	远端设备地址。

返回值：

类型	说明
boolean	成功返回true，失败返回false。

示例：

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

disconnect8+[]()

disconnect(device: string): boolean

断开连接设备的HFP服务。

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

参数名	类型	必填	说明
device	string	是	远端设备地址。

返回值：

类型	说明
boolean	成功返回true，失败返回false。

示例：

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

on('connectionStateChange')8+

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

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

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

参数：

参数名	类型	必填	说明
type	string	是	填写"connectionStateChange"字符串，表示连接状态变化事件。
callback	Callback<[StateChangeParam]>	是	表示回调函数的入参。

返回值：

无

示例：

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

off('connectionStateChange')8+

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

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

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

参数：

参数名	类型	必填	说明
type	string	是	填写"connectionStateChange"字符串，表示连接状态变化事件。
callback	Callback<[StateChangeParam]>	否	表示回调函数的入参。

返回值：

无

示例：

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

HidHostProfile

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

connect9+[]()

connect(device: string): boolean

连接设备的HidHost服务。

此接口为系统接口。

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

参数名	类型	必填	说明
device	string	是	远端设备地址。

返回值：

类型	说明
boolean	成功返回true，失败返回false。

示例：

let hidHostProfile = bluetooth.getProfile(bluetooth.ProfileId.PROFILE_HID_HOST);
let ret = hidHostProfile.connect('XX:XX:XX:XX:XX:XX');

disconnect9+[]()

disconnect(device: string): boolean

断开连接设备的HidHost服务。

此接口为系统接口。

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

参数名	类型	必填	说明
device	string	是	远端设备地址。

返回值：

类型	说明
boolean	成功返回true，失败返回false。

示例：

let hidHostProfile = bluetooth.getProfile(bluetooth.ProfileId.PROFILE_HID_HOST);
let ret = hidHostProfile.disconnect('XX:XX:XX:XX:XX:XX');

on('connectionStateChange')9+

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

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

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

参数：

参数名	类型	必填	说明
type	string	是	填写"connectionStateChange"字符串，表示连接状态变化事件。
callback	Callback<[StateChangeParam]>	是	表示回调函数的入参。

返回值：

无

示例：

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

off('connectionStateChange')9+

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

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

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

参数：

参数名	类型	必填	说明
type	string	是	填写"connectionStateChange"字符串，表示连接状态变化事件。
callback	Callback<[StateChangeParam]>	否	表示回调函数的入参。

返回值：

无

示例：

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

GattServer

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

startAdvertising

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

开始发送BLE广播。

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

参数：

参数名	类型	必填	说明
setting	[AdvertiseSetting]	是	BLE广播的相关参数。
advData	[AdvertiseData]	是	BLE广播包内容。
advResponse	[AdvertiseData]	否	BLE回复扫描请求回复响应。

返回值：

无

示例：

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.BLE.createGattServer();
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
            }],
});

stopAdvertising

stopAdvertising(): void

停止发送BLE广播。

需要权限 ：ohos.permission.DISCOVER_BLUETOOTH

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

返回值：

无

示例：

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

addService

addService(service: GattService): boolean

server端添加服务。

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
service	[GattService]	是	服务端的service数据。BLE广播的相关参数

返回值：

类型	说明
boolean	添加服务操作，成功返回true，否则返回false。

示例：

// 创建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 = bluetooth.BLE.createGattServer();
let ret = gattServer.addService(gattService);
if (ret) {
   console.log("add service successfully");
} else {
   console.log("add service failed");
}

removeService

removeService(serviceUuid: string): boolean

删除已添加的服务。

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
serviceUuid	string	是	service的UUID，例如“00001810-0000-1000-8000-00805F9B34FB”。

返回值：


类型	说明
boolean	删除服务操作，成功返回true，否则返回false。

示例：

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

close

close(): void

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

示例：

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

notifyCharacteristicChanged

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
deviceId	string	是	接收通知的client端设备地址，例如“XX:XX:XX:XX:XX:XX”。
notifyCharacteristic	[NotifyCharacteristic]	是	通知的特征值数据。

返回值：


类型	说明
boolean	通知操作，成功返回true，否则返回false。

示例：

// 创建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 = bluetooth.BLE.createGattServer();
server.notifyCharacteristicChanged('XX:XX:XX:XX:XX:XX', notifyCharacteristic);

sendResponse

sendResponse(serverResponse: ServerResponse): boolean

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
serverResponse	[ServerResponse]	是	server端回复的响应数据。

返回值：


类型	说明
boolean	回复响应操作，成功返回true，否则返回false。

示例：

/* 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 = bluetooth.BLE.createGattServer();
let ret = gattServer.sendResponse(serverResponse);
if (ret) {
  console.log('bluetooth sendResponse successfully');
} else {
  console.log('bluetooth sendResponse failed');
}

on('characteristicRead')

on(type: "characteristicRead", callback: Callback): void

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"characteristicRead"字符串，表示特征值读请求事件。
callback	Callback<[CharacteristicReadReq]>	是	表示回调函数的入参，client端发送的读请求数据。

返回值：

无

示例：

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

  let serverResponse = {deviceId: deviceId, transId: transId, status: 0, offset: offset, value:arrayBufferCCC};
  
  let ret = gattServer.sendResponse(serverResponse);
  if (ret) {
    console.log('bluetooth sendResponse successfully');
  } else {
    console.log('bluetooth sendResponse failed');
  }
}

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

off('characteristicRead')

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"characteristicRead"字符串，表示特征值读请求事件。
callback	Callback<[CharacteristicReadReq]>	否	表示取消订阅特征值读请求事件上报。不填该参数则取消订阅该type对应的所有回调。

返回值：

无

示例：

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

on('characteristicWrite')

on(type: "characteristicWrite", callback: Callback): void

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"characteristicWrite"字符串，表示特征值写请求事件。
callback	Callback<[CharacteristicWriteReq]>	是	表示回调函数的入参，client端发送的写请求数据。

返回值：

无

示例：

let arrayBufferCCC = new ArrayBuffer(8);
let cccValue = new Uint8Array(arrayBufferCCC);
function WriteCharacteristicReq(CharacteristicWriteReq) {
  let deviceId = CharacteristicWriteReq.deviceId;
  let transId = CharacteristicWriteReq.transId;
  let offset = CharacteristicWriteReq.offset;
  let isPrep = CharacteristicWriteReq.isPrep;
  let needRsp = CharacteristicWriteReq.needRsp;
  let value =  new Uint8Array(CharacteristicWriteReq.value);
  let characteristicUuid = CharacteristicWriteReq.characteristicUuid;
  
  cccValue[0] = value[0];
  let serverResponse = {deviceId: deviceId, transId: transId, status: 0, offset: offset, value:arrayBufferCCC};
  
  let ret = gattServer.sendResponse(serverResponse);
  if (ret) {
    console.log('bluetooth sendResponse successfully');
  } else {
    console.log('bluetooth sendResponse failed');
  }
}

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

off('characteristicWrite')

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"characteristicWrite"字符串，表示特征值写请求事件。
callback	Callback<[CharacteristicWriteReq]>	否	表示取消订阅特征值写请求事件上报。不填该参数则取消订阅该type对应的所有回调。

返回值：

无

示例：

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

on('descriptorRead')

on(type: "descriptorRead", callback: Callback): void

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"descriptorRead"字符串，表示描述符读请求事件。
callback	Callback<[DescriptorReadReq]>	是	表示回调函数的入参，client端发送的读请求数据。

返回值：

无

示例：

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

  let serverResponse = {deviceId: deviceId, transId: transId, status: 0, offset: offset, value:arrayBufferDesc};
  
  let ret = gattServer.sendResponse(serverResponse);
  if (ret) {
    console.log('bluetooth sendResponse successfully');
  } else {
    console.log('bluetooth sendResponse failed');
  }
}

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

off('descriptorRead')

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"descriptorRead"字符串，表示描述符读请求事件。
callback	Callback<[DescriptorReadReq]>	否	表示取消订阅描述符读请求事件上报。不填该参数则取消订阅该type对应的所有回调。

返回值：

无

示例：

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

on('descriptorWrite')

on(type: "descriptorWrite", callback: Callback): void

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"descriptorWrite"字符串，表示描述符写请求事件。
callback	Callback<[DescriptorWriteReq]>	是	表示回调函数的入参，client端发送的写请求数据。

返回值：

无

示例：

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

  descValue[0] = value[0];
  let serverResponse = {deviceId: deviceId, transId: transId, status: 0, offset: offset, value:arrayBufferDesc};
  
  let ret = gattServer.sendResponse(serverResponse);
  if (ret) {
    console.log('bluetooth sendResponse successfully');
  } else {
    console.log('bluetooth sendResponse failed');
  }
}

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

off('descriptorWrite')

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"descriptorWrite"字符串，表示描述符写请求事件。
callback	Callback<[DescriptorWriteReq]>	否	表示取消订阅描述符写请求事件上报。不填该参数则取消订阅该type对应的所有回调。

返回值：

无

示例：

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

on('connectStateChange')

on(type: "connectStateChange", callback: Callback): void

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"connectStateChange"字符串，表示BLE连接状态变化事件。
callback	Callback<[BLEConnectChangedState]>	是	表示回调函数的入参，连接状态。

返回值：

无

示例：

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

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

off('connectStateChange')

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"connectStateChange"字符串，表示BLE连接状态变化事件。
callback	Callback<[BLEConnectChangedState]>	否	表示取消订阅BLE连接状态变化事件。不填该参数则取消订阅该type对应的所有回调。

返回值：

无

示例：

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

GattClientDevice

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

connect

connect(): boolean

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

返回值：

类型	说明
boolean	连接操作成功返回true，操作失败返回false。

示例：

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

disconnect

disconnect(): boolean

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

返回值：

类型	说明
boolean	断开连接操作，成功返回true，操作失败返回false。

示例：

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

close

close(): boolean

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

返回值：

类型	说明
boolean	关闭操作，成功返回true，操作失败返回false。

示例：

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

getServices

getServices(callback: AsyncCallback>): void

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback>	是	client进行服务发现，通过注册回调函数获取。

返回值：

无

示例：

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

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

getServices

getServices(): Promise>

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

返回值：

类型	说明
Promise>	client进行服务发现，通过promise形式获取。

示例：

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

readCharacteristicValue

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
characteristic	[BLECharacteristic]	是	待读取的特征值。
callback	AsyncCallback<[BLECharacteristic]>	是	client读取特征值，通过注册回调函数获取。

返回值：

无

示例：

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 device = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
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};

device.readCharacteristicValue(characteristic, readCcc);

readCharacteristicValue

readCharacteristicValue(characteristic: BLECharacteristic): Promise

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
characteristic	[BLECharacteristic]	是	待读取的特征值。

返回值：


类型	说明
Promise<[BLECharacteristic]>	client读取特征值，通过promise形式获取。

示例：

let device = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
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};

device.readCharacteristicValue(characteristic);

readDescriptorValue

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
descriptor	[BLEDescriptor]	是	待读取的描述符。
callback	AsyncCallback<[BLECharacteristic]>	是	client读取描述符，通过注册回调函数获取。

返回值：

无

示例：

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 device = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
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};
device.readDescriptorValue(descriptor, readDesc);

readDescriptorValue

readDescriptorValue(descriptor: BLEDescriptor): Promise

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
descriptor	[BLEDescriptor]	是	待读取的描述符。

返回值：


类型	说明
Promise<[BLEDescriptor]>	client读取描述符，通过promise形式获取。

示例：

let device = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
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};
device.readDescriptorValue(descriptor);

writeCharacteristicValue

writeCharacteristicValue(characteristic: BLECharacteristic): boolean

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
characteristic	[BLECharacteristic]	是	蓝牙设备特征对应的二进制值及其它参数。

返回值：

类型	说明
boolean	写特征值操作成功返回true，操作失败返回false。

示例：

let device = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
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};
let retWriteCcc = device.writeCharacteristicValue(characteristic);
if (retWriteCcc) {
  console.log('write characteristic successfully');
} else {
  console.log('write characteristic failed');
}

writeDescriptorValue

writeDescriptorValue(descriptor: BLEDescriptor): boolean

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
descriptor	[BLEDescriptor]	是	蓝牙设备描述符的二进制值及其它参数。

返回值：

类型	说明
boolean	写描述符操作成功返回true，操作失败返回false。

示例：

let device = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
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};
let retWriteDesc = device.writeDescriptorValue(descriptor);
if (retWriteDesc) {
  console.log('bluetooth write descriptor successfully');
} else {
  console.log('bluetooth write descriptor failed');
}

setBLEMtuSize

setBLEMtuSize(mtu: number): boolean

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
mtu	number	是	设置范围为22~512字节。

返回值：

类型	说明
boolean	MTU协商操作成功返回true，操作失败返回false。

示例：

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

setNotifyCharacteristicChanged

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
characteristic	[BLECharacteristic]	是	蓝牙低功耗特征。
enable	boolean	是	启用接收notify设置为true，否则设置为false。

返回值：

类型	说明
boolean	设置操作成功返回true，操作失败返回false。

示例：

// 创建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 device = bluetooth.BLE.createGattClientDevice('XX:XX:XX:XX:XX:XX');
device.setNotifyCharacteristicChanged(characteristic, false);

on('BLECharacteristicChange')

on(type: "BLECharacteristicChange", callback: Callback): void

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"BLECharacteristicChange"字符串，表示特征值变化事件。
callback	Callback<[BLECharacteristic]>	是	表示蓝牙低功耗设备的特征值变化事件的回调函数。

返回值：

无

示例：

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

off('BLECharacteristicChange')

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"BLECharacteristicChange"字符串，表示特征值变化事件。
callback	Callback<[BLECharacteristic]>	否	表示取消订阅蓝牙低功耗设备的特征值变化事件。不填该参数则取消订阅该type对应的所有回调。

返回值：

无

示例：

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

on('BLEConnectionStateChange')

on(type: "BLEConnectionStateChange", callback: Callback): void

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"BLEConnectionStateChange"字符串，表示连接状态变化事件。
callback	Callback<[BLEConnectChangedState]>	是	表示连接状态，已连接或断开。

返回值：

无

示例：

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

off('BLEConnectionStateChange')

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

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
type	string	是	填写"BLEConnectionStateChange"字符串，表示连接状态变化事件。
callback	Callback<[BLEConnectChangedState]>	否	表示取消订阅蓝牙低功耗设备的连接状态变化事件。不填该参数则取消订阅该type对应的所有回调。

返回值：

无

示例：

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

getDeviceName

getDeviceName(callback: AsyncCallback): void

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback	是	client获取对端server设备名，通过注册回调函数获取。

返回值：

无

示例：

// callback
let gattClient = bluetooth.BLE.createGattClientDevice("XX:XX:XX:XX:XX:XX");
let deviceName = gattClient.getDeviceName((err, data)= > {
    console.info('device name err ' + JSON.stringify(err));
    console.info('device name' + JSON.stringify(data));
})

getDeviceName

getDeviceName(): Promise

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

返回值：

类型	说明
Promise	client获取对端server设备名，通过promise形式获取。

示例：

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

getRssiValue

getRssiValue(callback: AsyncCallback): void

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

参数：

参数名	类型	必填	说明
callback	AsyncCallback	是	返回信号强度，单位 dBm，通过注册回调函数获取。

返回值：

无

示例：

// callback
let gattClient = bluetooth.BLE.createGattClientDevice("XX:XX:XX:XX:XX:XX");
let ret = device.connect();
let rssi = gattClient.getRssiValue((err, data)= > {
    console.info('rssi err ' + JSON.stringify(err));
    console.info('rssi value' + JSON.stringify(data));
})

getRssiValue

getRssiValue(): Promise

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

需要权限 ：ohos.permission.USE_BLUETOOTH

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

返回值：

类型	说明
Promise	返回信号强度，单位 dBm，通过promise形式获取。

示例：

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

ScanMode8+[]()

枚举，扫描模式。

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

名称	默认值	说明
SCAN_MODE_NONE	0	没有扫描模式。
SCAN_MODE_CONNECTABLE	1	可连接扫描模式。
SCAN_MODE_GENERAL_DISCOVERABLE	2	general发现模式。
SCAN_MODE_LIMITED_DISCOVERABLE	3	limited发现模式。
SCAN_MODE_CONNECTABLE_GENERAL_DISCOVERABLE	4	可连接general发现模式。
SCAN_MODE_CONNECTABLE_LIMITED_DISCOVERABLE	5	可连接limited发现模式。

BondState8+[]()

枚举，配对状态。

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

名称	默认值	说明
BOND_STATE_INVALID	0	无效的配对。
BOND_STATE_BONDING	1	正在配对。
BOND_STATE_BONDED	2	已配对。

SppOption8+[]()

描述spp的配置参数。

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

名称	参数类型	可读	可写	说明
uuid	string	是	是	spp单据的uuid。
secure	boolean	是	是	是否是安全通道。
type	[SppType]	是	是	Spp链路类型。

SppType8+[]()

枚举，Spp链路类型。

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

名称	默认值	说明
SPP_RFCOMM	0	表示rfcomm链路类型。

GattService

描述service的接口参数定义。

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

名称	参数类型	可读	可写	说明
serviceUuid	string	是	是	特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。
isPrimary	boolean	是	是	如果是主服务设置为true，否则设置为false。
characteristics	Array<[BLECharacteristic]>	是	是	当前服务包含的特征列表。
includeServices	Array<[GattService]>	是	是	当前服务依赖的其它服务。

BLECharacteristic

描述characteristic的接口参数定义。

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

名称	参数类型	可读	可写	说明
serviceUuid	string	是	是	特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。
characteristicUuid	string	是	是	特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。
characteristicValue	ArrayBuffer	是	是	特征对应的二进制值。
descriptors	Array<[BLEDescriptor]>	是	是	特定特征的描述符列表。

BLEDescriptor

描述descriptor的接口参数定义。

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

名称	参数类型	可读	可写	说明
serviceUuid	string	是	是	特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。
characteristicUuid	string	是	是	特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。
descriptorUuid	string	是	是	描述符（descriptor）的UUID，例如：00002902-0000-1000-8000-00805f9b34fb。
descriptorValue	ArrayBuffer	是	是	描述符对应的二进制值。

NotifyCharacteristic

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

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

名称	参数类型	可读	可写	说明
serviceUuid	string	是	是	特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。
characteristicUuid	string	是	是	特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。
characteristicValue	ArrayBuffer	是	是	特征对应的二进制值。
confirm	boolean	是	是	如果是notification则对端回复确认设置为true，如果是indication则对端不需要回复确认设置为false。

CharacteristicReadReq

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

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

名称	参数类型	可读	可写	说明
deviceId	string	是	否	表示发送特征值读请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。
transId	number	是	否	表示读请求的传输ID，server端回复响应时需填写相同的传输ID。
offset	number	是	否	表示读特征值数据的起始位置。例如：k表示从第k个字节开始读，server端回复响应时需填写相同的offset。
characteristicUuid	string	是	否	特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。
serviceUuid	string	是	否	特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。

CharacteristicWriteReq

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

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

名称	参数类型	可读	可写	说明
deviceId	string	是	否	表示发送特征值写请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。
transId	number	是	否	表示写请求的传输ID，server端回复响应时需填写相同的传输ID。
offset	number	是	否	表示写特征值数据的起始位置。例如：k表示从第k个字节开始写，server端回复响应时需填写相同的offset。
descriptorUuid	string	是	否	表示描述符（descriptor）的UUID，例如：00002902-0000-1000-8000-00805f9b34fb。
characteristicUuid	string	是	否	特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。
serviceUuid	string	是	否	特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。

DescriptorReadReq

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

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

名称	参数类型	可读	可写	说明
deviceId	string	是	否	表示发送描述符读请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。
transId	number	是	否	表示读请求的传输ID，server端回复响应时需填写相同的传输ID。
offset	number	是	否	表示读描述符数据的起始位置。例如：k表示从第k个字节开始读，server端回复响应时需填写相同的offset。
descriptorUuid	string	是	否	表示描述符（descriptor）的UUID，例如：00002902-0000-1000-8000-00805f9b34fb。
characteristicUuid	string	是	否	特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。
serviceUuid	string	是	否	特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。

DescriptorWriteReq

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

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

名称	参数类型	可读	可写	说明
deviceId	string	是	否	表示发送描述符写请求的远端设备地址，例如："XX:XX:XX:XX:XX:XX"。
transId	number	是	否	表示写请求的传输ID，server端回复响应时需填写相同的传输ID。
offset	number	是	否	表示写描述符数据的起始位置。例如：k表示从第k个字节开始写，server端回复响应时需填写相同的offset。
isPrep	boolean	是	否	表示写请求是否立即执行。
needRsp	boolean	是	否	表示是否要给client端回复响应。
value	ArrayBuffer	是	否	表示写入的描述符二进制数据。
descriptorUuid	string	是	否	表示描述符（descriptor）的UUID，例如：00002902-0000-1000-8000-00805f9b34fb。
characteristicUuid	string	是	否	特定特征（characteristic）的UUID，例如：00002a11-0000-1000-8000-00805f9b34fb。
serviceUuid	string	是	否	特定服务（service）的UUID，例如：00001888-0000-1000-8000-00805f9b34fb。

ServerResponse

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

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

名称	参数类型	可读	可写	说明
deviceId	string	是	否	表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。
transId	number	是	否	表示请求的传输ID，与订阅的读/写请求事件携带的ID保持一致。
status	number	是	否	表示响应的状态，设置为0即可，表示正常。
offset	number	是	否	表示请求的读/写起始位置，与订阅的读/写请求事件携带的offset保持一致。
value	ArrayBuffer	是	否	表示回复响应的二进制数据。

BLEConnectChangedState

描述Gatt profile连接状态。

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

名称	参数类型	可读	可写	说明
deviceId	string	是	否	表示远端设备地址，例如："XX:XX:XX:XX:XX:XX"。
state	[ProfileConnectionState]	是	是	表示BLE连接状态的枚举。

ProfileConnectionState

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

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

名称	默认值	说明
STATE_DISCONNECTED	0	表示profile已断连。
STATE_CONNECTING	1	表示profile正在连接。
STATE_CONNECTED	2	表示profile已连接。
STATE_DISCONNECTING	3	表示profile正在断连。

ScanFilter

扫描过滤参数。

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

名称	参数类型	可读	可写	说明
deviceId	string	是	是	表示过滤的BLE设备地址，例如："XX:XX:XX:XX:XX:XX"。
name	string	是	是	表示过滤的BLE设备名。
serviceUuid	string	是	是	表示过滤包含该UUID服务的设备，例如：00001888-0000-1000-8000-00805f9b34fb。

ScanOptions

扫描的配置参数。

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

名称	参数类型	可读	可写	说明
interval	number	是	是	表示扫描结果上报延迟时间，默认值为0。
dutyMode	[ScanDuty]	是	是	表示扫描模式，默认值为SCAN_MODE_LOW_POWER。
matchMode	[MatchMode]	是	是	表示硬件的过滤匹配模式，默认值为MATCH_MODE_AGGRESSIVE。

ScanDuty

枚举，扫描模式。

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

名称	默认值	说明
SCAN_MODE_LOW_POWER	0	表示低功耗模式，默认值。
SCAN_MODE_BALANCED	1	表示均衡模式。
SCAN_MODE_LOW_LATENCY	2	表示低延迟模式。

MatchMode

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

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

名称	默认值	说明
MATCH_MODE_AGGRESSIVE	1	表示硬件上报扫描结果门限较低，比如扫描到的功率较低或者一段时间扫描到的次数较少也触发上报，默认值。
MATCH_MODE_STICKY	2	表示硬件上报扫描结果门限较高，更高的功率门限以及扫描到多次才会上报。

ScanResult

扫描结果上报数据。

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

名称	参数类型	可读	可写	说明
deviceId	string	是	否	表示扫描到的设备地址，例如："XX:XX:XX:XX:XX:XX"。
rssi	number	是	否	表示扫描到的设备的rssi值。
data	ArrayBuffer	是	否	表示扫描到的设备发送的广播包。

BluetoothState

枚举，蓝牙开关状态。

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

名称	默认值	说明
STATE_OFF	0	表示蓝牙已关闭。
STATE_TURNING_ON	1	表示蓝牙正在打开。
STATE_ON	2	表示蓝牙已打开。
STATE_TURNING_OFF	3	表示蓝牙正在关闭。
STATE_BLE_TURNING_ON	4	表示蓝牙正在打开LE-only模式。
STATE_BLE_ON	5	表示蓝牙正处于LE-only模式。
STATE_BLE_TURNING_OFF	6	表示蓝牙正在关闭LE-only模式。

AdvertiseSetting

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

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

名称	参数类型	可读	可写	说明
interval	number	是	是	表示广播间隔，最小值设置32个slot表示20ms，最大值设置16384个slot，默认值设置为1600个slot表示1s。
txPower	number	是	是	表示发送功率，最小值设置-127，最大值设置1，默认值设置-7，单位dbm。
connectable	boolean	是	是	表示是否是可连接广播，默认值设置为true。

AdvertiseData

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

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

名称	参数类型	可读	可写	说明
serviceUuids	Array	是	是	表示要广播的服务 UUID 列表。
manufactureData	Array<[ManufactureData]>	是	是	表示要广播的广播的制造商信息列表。
serviceData	Array<[ServiceData]>	是	是	表示要广播的服务数据列表。

ManufactureData

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

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

名称	参数类型	可读	可写	说明
manufactureId	Array	是	是	表示制造商的ID，由蓝牙SIG分配。
manufactureValue	ArrayBuffer	是	是	表示制造商发送的制造商数据。

ServiceData

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

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

名称	参数类型	可读	可写	说明
serviceUuid	string	是	是	表示服务的UUID。
serviceValue	ArrayBuffer	是	是	表示服务数据。

PinRequiredParam8+[]()

描述配对请求参数。

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

名称	参数类型	可读	可写	说明
deviceId	string	是	否	表示要配对的设备ID。
pinCode	string	是	否	表示要配对的密钥。

StateChangeParam8+[]()

描述profile状态改变参数。

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

名称	参数类型	可读	可写	说明
deviceId	string	是	否	表示蓝牙设备地址。
state	[ProfileConnectionState]	是	否	表示蓝牙设备的profile连接状态。

DeviceClass8+[]()

描述蓝牙设备的类别。

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

名称	参数类型	可读	可写	说明
majorClass	[MajorClass]	是	否	表示蓝牙设备主要类别的枚举。
majorMinorClass	[MajorMinorClass]	是	否	表示主要次要蓝牙设备类别的枚举。
classOfDevice	number	是	否	表示设备类别。

MajorClass8+[]()

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

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

名称	默认值	说明
MAJOR_MISC	0x0000	表示杂项设备。
MAJOR_COMPUTER	0x0100	表示计算机设备。
MAJOR_PHONE	0x0200	表示手机设备。
MAJOR_NETWORKING	0x0300	表示网络设备。
MAJOR_AUDIO_VIDEO	0x0400	表示音频和视频设备。
MAJOR_PERIPHERAL	0x0500	表示外围设备。
MAJOR_IMAGING	0x0600	表示成像设备。
MAJOR_WEARABLE	0x0700	表示可穿戴设备。
MAJOR_TOY	0x0800	表示玩具设备。
MAJOR_HEALTH	0x0900	表示健康设备。
MAJOR_UNCATEGORIZED	0x1F00	表示未分类设备。

MajorMinorClass8+[]()

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

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

名称	默认值	说明
COMPUTER_UNCATEGORIZED	0x0100	表示未分类计算机设备。
COMPUTER_DESKTOP	0x0104	表示台式计算机设备。
COMPUTER_SERVER	0x0108	表示服务器设备。
COMPUTER_LAPTOP	0x010C	表示便携式计算机设备。
COMPUTER_HANDHELD_PC_PDA	0x0110	表示手持式计算机设备。
COMPUTER_PALM_SIZE_PC_PDA	0x0114	表示掌上电脑设备。
COMPUTER_WEARABLE	0x0118	表示可穿戴计算机设备。
COMPUTER_TABLET	0x011C	表示平板电脑设备。
PHONE_UNCATEGORIZED	0x0200	表示未分类手机设备。
PHONE_CELLULAR	0x0204	表示便携式手机设备。
PHONE_CORDLESS	0x0208	表示无线电话设备。
PHONE_SMART	0x020C	表示智能手机设备。
PHONE_MODEM_OR_GATEWAY	0x0210	表示调制解调器或网关手机设备。
PHONE_ISDN	0x0214	表示ISDN手机设备。
NETWORK_FULLY_AVAILABLE	0x0300	表示网络完全可用设备。
NETWORK_1_TO_17_UTILIZED	0x0320	表示使用网络1到17设备。
NETWORK_17_TO_33_UTILIZED	0x0340	表示使用网络17到33设备。
NETWORK_33_TO_50_UTILIZED	0x0360	表示使用网络33到50设备。
NETWORK_60_TO_67_UTILIZED	0x0380	表示使用网络60到67设备。
NETWORK_67_TO_83_UTILIZED	0x03A0	表示使用网络67到83设备。
NETWORK_83_TO_99_UTILIZED	0x03C0	表示使用网络83到99设备。
NETWORK_NO_SERVICE	0x03E0	表示网络无服务设备。
AUDIO_VIDEO_UNCATEGORIZED	0x0400	表示未分类音频视频设备。
AUDIO_VIDEO_WEARABLE_HEADSET	0x0404	表示可穿戴式音频视频设备。
AUDIO_VIDEO_HANDSFREE	0x0408	表示免提音频视频设备。
AUDIO_VIDEO_MICROPHONE	0x0410	表示麦克风音频视频设备。
AUDIO_VIDEO_LOUDSPEAKER	0x0414	表示扬声器音频视频设备。
AUDIO_VIDEO_HEADPHONES	0x0418	表示头戴式音频视频设备。
AUDIO_VIDEO_PORTABLE_AUDIO	0x041C	表示便携式音频视频设备。
AUDIO_VIDEO_CAR_AUDIO	0x0420	表示汽车音频视频设备。
AUDIO_VIDEO_SET_TOP_BOX	0x0424	表示机顶盒音频视频设备。
AUDIO_VIDEO_HIFI_AUDIO	0x0428	表示高保真音响设备。
AUDIO_VIDEO_VCR	0x042C	表示录像机音频视频设备。
AUDIO_VIDEO_VIDEO_CAMERA	0x0430	表示照相机音频视频设备。
AUDIO_VIDEO_CAMCORDER	0x0434	表示摄像机音频视频设备。
AUDIO_VIDEO_VIDEO_MONITOR	0x0438	表示监视器音频视频设备。
AUDIO_VIDEO_VIDEO_DISPLAY_AND_LOUDSPEAKER	0x043C	表示视频显示器和扬声器设备。
AUDIO_VIDEO_VIDEO_CONFERENCING	0x0440	表示音频视频会议设备。
AUDIO_VIDEO_VIDEO_GAMING_TOY	0x0448	表示游戏玩具音频视频设备。
PERIPHERAL_NON_KEYBOARD_NON_POINTING	0x0500	表示非键盘非指向外围设备。
PERIPHERAL_KEYBOARD	0x0540	表示外设键盘设备。
PERIPHERAL_POINTING_DEVICE	0x0580	表示定点装置外围设备。
PERIPHERAL_KEYBOARD_POINTING	0x05C0	表示键盘指向外围设备。
PERIPHERAL_UNCATEGORIZED	0x0500	表示未分类外围设备。
PERIPHERAL_JOYSTICK	0x0504	表示周边操纵杆设备。
PERIPHERAL_GAMEPAD	0x0508	表示周边游戏板设备。
PERIPHERAL_REMOTE_CONTROL	0x05C0	表示远程控制外围设备。
PERIPHERAL_SENSING_DEVICE	0x0510	表示外围传感设备设备。
PERIPHERAL_DIGITIZER_TABLET	0x0514	表示外围数字化仪平板电脑设备。
PERIPHERAL_CARD_READER	0x0518	表示外围读卡器设备。
PERIPHERAL_DIGITAL_PEN	0x051C	表示外设数码笔设备。
PERIPHERAL_SCANNER_RFID	0x0520	表示射频识别扫描仪外围设备。
PERIPHERAL_GESTURAL_INPUT	0x0522	表示手势输入外围设备。
IMAGING_UNCATEGORIZED	0x0600	表示未分类的图像设备。
IMAGING_DISPLAY	0x0610	表示图像显示设备。
IMAGING_CAMERA	0x0620	表示成像照相机设备。
IMAGING_SCANNER	0x0640	表示成像扫描仪设备。
IMAGING_PRINTER	0x0680	表示成像打印机设备。
WEARABLE_UNCATEGORIZED	0x0700	表示未分类的可穿戴设备。
WEARABLE_WRIST_WATCH	0x0704	表示可穿戴腕表设备。
WEARABLE_PAGER	0x0708	表示可穿戴寻呼机设备。
WEARABLE_JACKET	0x070C	表示夹克可穿戴设备。
WEARABLE_HELMET	0x0710	表示可穿戴头盔设备。
WEARABLE_GLASSES	0x0714	表示可穿戴眼镜设备。
TOY_UNCATEGORIZED	0x0800	表示未分类的玩具设备。
TOY_ROBOT	0x0804	表示玩具机器人设备。
TOY_VEHICLE	0x0808	表示玩具车设备。
TOY_DOLL_ACTION_FIGURE	0x080C	表示人形娃娃玩具设备。
TOY_CONTROLLER	0x0810	表示玩具控制器设备。
TOY_GAME	0x0814	表示玩具游戏设备。
HEALTH_UNCATEGORIZED	0x0900	表示未分类健康设备。
HEALTH_BLOOD_PRESSURE	0x0904	表示血压健康设备。
HEALTH_THERMOMETER	0x0908	表示温度计健康设备。
HEALTH_WEIGHING	0x090C	表示体重健康设备。
HEALTH_GLUCOSE	0x0910	表示葡萄糖健康设备。
HEALTH_PULSE_OXIMETER	0x0914	表示脉搏血氧仪健康设备。
HEALTH_PULSE_RATE	0x0918	表示脉搏率健康设备。
HEALTH_DATA_DISPLAY	0x091C	表示数据显示健康设备。
HEALTH_STEP_COUNTER	0x0920	表示阶梯计数器健康设备。
HEALTH_BODY_COMPOSITION_ANALYZER	0x0924	表示身体成分分析仪健康设备。
HEALTH_PEAK_FLOW_MOITOR	0x0928	表示湿度计健康设备。
HEALTH_MEDICATION_MONITOR	0x092C	表示药物监视仪健康设备。
HEALTH_KNEE_PROSTHESIS	0x0930	表示膝盖假肢健康设备。
HEALTH_ANKLE_PROSTHESIS	0x0934	表示脚踝假肢健康设备。
HEALTH_GENERIC_HEALTH_MANAGER	0x0938	表示通用健康管理设备。
HEALTH_PERSONAL_MOBILITY_DEVICE	0x093C	表示个人移动健康设备。

PlayingState8+[]()

枚举，蓝牙A2DP 播放状态。

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

名称	默认值	说明
STATE_NOT_PLAYING	0x0000	表示未播放。
STATE_PLAYING	0x0001	表示正在播放。`HarmonyOS与OpenHarmony鸿蒙文档籽料：mau123789是v直接拿`

搜狗高速浏览器截图20240326151450.png

ProfileId8+[]()

蓝牙profile枚举，API9新增PROFILE_HID_HOST。

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

名称	默认值	说明
PROFILE_A2DP_SOURCE	0x0001	表示A2DP profile。
PROFILE_HANDS_FREE_AUDIO_GATEWAY	0x0004	表示HFP profile。
PROFILE_HID_HOST9+	0x0006	表示HID profile。

审核编辑黄宇

声明：本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人，不代表电子发烧友网立场。文章及其配图仅供工程师学习之用，如有内容侵权或者其他违规问题，请联系本站处理。举报投诉

通信

通信

+关注

关注
18

文章
6024

浏览量
135950
蓝牙

蓝牙

+关注

关注
114

文章
5809

浏览量
170193
API

API

+关注

关注
2

文章
1499

浏览量
61965
鸿蒙

鸿蒙

+关注

关注
57

文章
2339

浏览量
42811

蓝牙BR/EDR 和Bluetooth Smart的十大重要区别

不论你是普通消费者还是科技圈内人士，蓝牙（Bluetooth®）一定是个并不陌生的词汇。但如果你是蓝牙应用开发者或科技发烧友，你就有必要进一步了解蓝

发表于 12-08 17:20 •1.7w次阅读

干货！Android之蓝牙驱动开发经验

干货！Android之蓝牙驱动开发经验目录一 Bluetooth基本概念1二 Android Bluetooth架构12.1 Bluetooth

发表于 02-29 15:53

如何开发蓝牙mesh项目？

最新的蓝牙mesh 1.0规范（Bluetooth mesh 1.0）允许低功耗蓝牙（Bluetooth Low Energy，Bluetooth

发表于 12-29 06:18

如何用Bluetooth Developer Studio缩短70%蓝牙开发时间？

如何用Bluetooth Developer Studio缩短70%蓝牙开发时间？

发表于 05-21 06:30

使用Bluetooth Low Energy（低功耗蓝牙）实现设备间通信

：ohos.permission.USE_BLUETOOTH：允许应用查看蓝牙的配置。ohos.permission.DISCOVER_BLUETOOTH：允许应用配置本地蓝牙，并允许

发表于 08-24 17:27

常见的物联网通信协议蓝牙简单对比

@TOC浅析物联网(智能家居)无线通信协议物联网无线传输方案产品开发，通信协议(生态)选择至关重要，简单对比一下常见的物联网通信协议蓝牙(

发表于 01-11 07:24

如何在鸿蒙2.0系统上移植增加蓝牙驱动？

过来不行，而且对于鸿蒙编译我也特别有，比如这个文件夹，我该在哪个类似的列表中勾选那个东西去添加这个驱动？3.1源码子系统通信蓝牙相关的文件夹/foundation/communication

发表于 05-13 10:13

蓝牙(Bluetooth)技术

蓝牙(Bluetooth)技术所谓蓝牙(Bluetooth)技术，实际上是一种短距离无线电技术，利用"蓝牙"技术，能够有效

发表于 01-06 11:08 •751次阅读

什么是Bluetooth(蓝牙)

无线网络技术。随后成立的蓝牙技术特殊兴趣组织（SIG）来负责该技术的开发和技术协议的制定，如今全世界已有1800多家公司加盟该组织，最近微软公司也正式加盟并成为SIG组织的领导成员之一。蓝牙是无线数据和语音传输的开放式标准，它

发表于 11-24 09:45 •4999次阅读

使用蓝牙开发板连接电脑通信教程资料下载.pdf

蓝牙开发板该怎么连接电脑，这里教你怎样使用蓝牙开发板连接电脑

发表于 04-20 11:34 •19次下载

Bluetooth4_3蓝牙连接APP源码免费下载

本文档的主要内容详细介绍的是Bluetooth4_3 蓝牙连接APP源码免费下载。

发表于 04-15 18:01 •31次下载

openHarmony之蓝牙快速开发框架

Ohos Bluetooth Low Energy 蓝牙快速开发框架。 openHarmonyOs，使用简单的方式进行搜索、连接、读写等一系

发表于 04-13 09:35 •7次下载

鸿蒙开发实战：【蓝牙组件】

蓝牙服务组件为设备提供接入与使用Bluetooth的相关接口，包括BLE设备gatt相关的操作，以及BLE广播、扫描等功能。

发表于 03-13 17:27 •723次阅读

鸿蒙开发通信与连接：ohos.rpc RPC通信

本模块提供进程间通信能力，包括设备内的进程间通信（IPC）和设备间的进程间通信（RPC），前者基于Binder驱动，后者基于软总线驱动。

发表于 06-21 09:40 •538次阅读

鸿蒙语言基础类库：system.bluetooth 蓝牙

开始搜寻附近的低功耗蓝牙外围设备。此操作比较耗费系统资源，请在搜索并连接到设备后调用[bluetooth.stopBLEScan]方法停止搜索。

发表于 07-15 17:28 •389次阅读

搜索历史

鸿蒙开发通信与连接：ohos.bluetooth蓝牙

导入模块

bluetooth.enableBluetooth8+[]()

bluetooth.disableBluetooth8+[]()

bluetooth.getLocalName8+[]()

bluetooth.getState

bluetooth.getBtConnectionState

bluetooth.setLocalName8+[]()

bluetooth.pairDevice

bluetooth.getProfileConnState8+[]()

bluetooth.cancelPairedDevice8+[]()

bluetooth.getRemoteDeviceName8+[]()

bluetooth.getRemoteDeviceClass8+[]()

bluetooth.getPairedDevices8+[]()

bluetooth.setBluetoothScanMode8+[]()

bluetooth.getBluetoothScanMode8+[]()

bluetooth.startBluetoothDiscovery8+[]()

bluetooth.stopBluetoothDiscovery8+[]()

bluetooth.setDevicePairingConfirmation8+[]()

bluetooth.on('bluetoothDeviceFind')8+

bluetooth.off('bluetoothDeviceFind')8+

bluetooth.on('pinRequired')8+

bluetooth.off('pinRequired')8+

bluetooth.on('bondStateChange')8+

bluetooth.off('bondStateChange')8+

bluetooth.on('stateChange')8+

bluetooth.off('stateChange')8+

bluetooth.sppListen8+[]()

bluetooth.sppAccept8+[]()

bluetooth.sppConnect8+[]()

bluetooth.sppCloseServerSocket8+[]()

bluetooth.sppCloseClientSocket8+[]()

bluetooth.sppWrite8+[]()

bluetooth.on('sppRead')8+

bluetooth.off('sppRead')8+

bluetooth.getProfile8+[]()

bluetooth.getProfile9+[]()

bluetooth.BLE

bluetooth.BLE.createGattServer

bluetooth.BLE.createGattClientDevice

bluetooth.BLE.getConnectedBLEDevices

bluetooth.BLE.startBLEScan

bluetooth.BLE.stopBLEScan

bluetooth.BLE.on('BLEDeviceFind')

bluetooth.BLE.off('BLEDeviceFind')

BaseProfile

getConnectionDevices8+[]()

getDeviceState8+[]()

A2dpSourceProfile

connect8+[]()

disconnect8+[]()

on('connectionStateChange')8+

off('connectionStateChange')8+

getPlayingState9+

HandsFreeAudioGatewayProfile

connect8+[]()

disconnect8+[]()

on('connectionStateChange')8+

off('connectionStateChange')8+

HidHostProfile

connect9+[]()

disconnect9+[]()

on('connectionStateChange')9+

off('connectionStateChange')9+

GattServer

startAdvertising

stopAdvertising

addService

removeService

close

notifyCharacteristicChanged

sendResponse

on('characteristicRead')

off('characteristicRead')

on('characteristicWrite')

off('characteristicWrite')

on('descriptorRead')

off('descriptorRead')

on('descriptorWrite')