【鸿蒙next开发】短距离通信开发：@ohos.bluetooth.ble (蓝牙ble模块)_鸿蒙ble蓝牙

技术文档

往期鸿蒙5.0全套实战文章必看：（文中附带鸿蒙5.0全栈学习资料）

鸿蒙开发核心知识点，看这篇文章就够了
最新版！鸿蒙HarmonyOS Next应用开发实战学习路线
鸿蒙HarmonyOS NEXT开发技术最全学习路线指南
鸿蒙应用开发实战项目，看这一篇文章就够了（部分项目附源码）

@ohos.bluetooth.ble (蓝牙ble模块)

ble模块提供了对蓝牙操作和管理的方法。

说明

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

导入模块

import { ble } from \'@kit.ConnectivityKit\';

ProfileConnectionState

type ProfileConnectionState = constant.ProfileConnectionState

蓝牙设备的profile连接状态。

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

类型说明 constant.ProfileConnectionState 蓝牙设备的profile连接状态。

ble.createGattServer

createGattServer(): GattServer

创建GattServer实例。

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

返回值：

类型说明 GattServer 返回一个Gatt服务的实例。

示例：

let gattServer: ble.GattServer = ble.createGattServer();console.info(\'gatt success\');

ble.createGattClientDevice

createGattClientDevice(deviceId: string): GattClientDevice

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

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

返回值：

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

错误码：

以下错误码的详细介绍。

错误码ID 错误信息 401 Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed. 801 Capability not supported.

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\');} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.getConnectedBLEDevices

getConnectedBLEDevices(): Array

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

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

返回值：

类型说明 Array 返回当前设备作为Server端时连接BLE设备地址集合。基于信息安全考虑，此处获取的设备地址为随机MAC地址。配对成功后，该地址不会变更；已配对设备取消配对后重新扫描或蓝牙服务下电时，该随机地址会变更。

错误码：

以下错误码的详细介绍。

错误码ID 错误信息 201 Permission denied. 801 Capability not supported. 2900001 Service stopped. 2900003 Bluetooth disabled. 2900099 Operation failed.

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let result: Array = ble.getConnectedBLEDevices();} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.startBLEScan

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

发起BLE扫描流程。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

参数名类型必填说明 filters Array 是表示扫描结果过滤策略集合，符合过滤条件的设备发现会保留。如果不使用过滤的方式，该参数设置为null。 options ScanOptions 否表示扫描的参数配置，可选参数。

错误码：

以下错误码的详细介绍。

错误码ID 错误信息 201 Permission denied. 401 Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 3. Parameter verification failed. 801 Capability not supported. 2900001 Service stopped. 2900003 Bluetooth disabled. 2900099 Operation failed.

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';function onReceiveEvent(data: Array) { console.info(\'BLE scan device find result = \'+ JSON.stringify(data));}try { ble.on(\"BLEDeviceFind\", onReceiveEvent); let scanFilter: ble.ScanFilter = { deviceId:\"XX:XX:XX:XX:XX:XX\", name:\"test\", serviceUuid:\"00001888-0000-1000-8000-00805f9b34fb\" }; let scanOptions: ble.ScanOptions = { interval: 500, dutyMode: ble.ScanDuty.SCAN_MODE_LOW_POWER, matchMode: ble.MatchMode.MATCH_MODE_AGGRESSIVE } ble.startBLEScan([scanFilter],scanOptions);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.stopBLEScan

stopBLEScan(): void

停止BLE扫描流程。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

错误码：

以下错误码的详细介绍。

错误码ID 错误信息 201 Permission denied. 801 Capability not supported. 2900001 Service stopped. 2900003 Bluetooth disabled. 2900099 Operation failed.

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { ble.stopBLEScan();} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.startAdvertising

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

开始发送BLE广播。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';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));try { let setting: ble.AdvertiseSetting = { interval:150, txPower:0, connectable:true }; let manufactureDataUnit: ble.ManufactureData = { manufactureId:4567, manufactureValue:manufactureValueBuffer.buffer }; let serviceDataUnit: ble.ServiceData = { serviceUuid:\"00001888-0000-1000-8000-00805f9b34fb\", serviceValue:serviceValueBuffer.buffer }; let advData: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advResponse: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; ble.startAdvertising(setting, advData ,advResponse);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.stopAdvertising

stopAdvertising(): void

停止发送BLE广播。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

错误码：

以下错误码的详细介绍。

错误码ID 错误信息 201 Permission denied. 801 Capability not supported. 2900001 Service stopped. 2900003 Bluetooth disabled. 2900099 Operation failed.

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { ble.stopAdvertising();} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.startAdvertising11+

startAdvertising(advertisingParams: AdvertisingParams, callback: AsyncCallback): void

开始发送BLE广播。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

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

参数：

参数名类型必填说明 advertisingParams AdvertisingParams 是启动BLE广播的相关参数。 callback AsyncCallback 是广播ID标识，通过注册回调函数获取。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';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));try { let setting: ble.AdvertiseSetting = { interval:150, txPower:0, connectable:true, }; let manufactureDataUnit: ble.ManufactureData = { manufactureId:4567, manufactureValue:manufactureValueBuffer.buffer }; let serviceDataUnit: ble.ServiceData = { serviceUuid:\"00001888-0000-1000-8000-00805f9b34fb\", serviceValue:serviceValueBuffer.buffer }; let advData: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advResponse: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advertisingParams: ble.AdvertisingParams = { advertisingSettings: setting, advertisingData: advData, advertisingResponse: advResponse, duration: 0 } let advHandle = 0xFF; ble.startAdvertising(advertisingParams, (err, outAdvHandle) => { if (err) { return; } else { advHandle = outAdvHandle; console.info(\"advHandle: \" + advHandle); } });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.startAdvertising11+

startAdvertising(advertisingParams: AdvertisingParams): Promise

开始发送BLE广播。使用Promise异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

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

参数：

参数名类型必填说明 advertisingParams AdvertisingParams 是启动BLE广播的相关参数。

返回值：

类型说明 Promise 广播ID标识，通过promise形式获取。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';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));try { let setting: ble.AdvertiseSetting = { interval:150, txPower:0, connectable:true }; let manufactureDataUnit: ble.ManufactureData = { manufactureId:4567, manufactureValue:manufactureValueBuffer.buffer }; let serviceDataUnit: ble.ServiceData = { serviceUuid:\"00001888-0000-1000-8000-00805f9b34fb\", serviceValue:serviceValueBuffer.buffer }; let advData: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advResponse: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advertisingParams: ble.AdvertisingParams = { advertisingSettings: setting, advertisingData: advData, advertisingResponse: advResponse, duration: 0 } let advHandle = 0xFF; ble.startAdvertising(advertisingParams) .then(outAdvHandle => { advHandle = outAdvHandle; });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.enableAdvertising11+

enableAdvertising(advertisingEnableParams: AdvertisingEnableParams, callback: AsyncCallback): void

临时启动BLE广播。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

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

参数：

参数名类型必填说明 advertisingEnableParams AdvertisingEnableParams 是临时启动BLE广播的相关参数。 callback AsyncCallback 是回调函数。

错误码：

以下错误码的详细介绍。

错误码ID 错误信息 201 Permission denied. 401 Invalid parameter. Possible causes: 1. Mandatory parameters are left unspecified. 2. Incorrect parameter types. 801 Capability not supported. 2900001 Service stopped. 2900003 Bluetooth disabled. 2900099 Operation failed.

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';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));try { let setting: ble.AdvertiseSetting = { interval:150, txPower:0, connectable:true }; let manufactureDataUnit: ble.ManufactureData = { manufactureId:4567, manufactureValue:manufactureValueBuffer.buffer }; let serviceDataUnit: ble.ServiceData = { serviceUuid:\"00001888-0000-1000-8000-00805f9b34fb\", serviceValue:serviceValueBuffer.buffer }; let advData: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advResponse: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advertisingParams: ble.AdvertisingParams = { advertisingSettings: setting, advertisingData: advData, advertisingResponse: advResponse, duration: 300 } let advHandle = 0xFF; ble.startAdvertising(advertisingParams, (err, outAdvHandle) => { if (err) { return; } else { advHandle = outAdvHandle; console.info(\"advHandle: \" + advHandle); } }); let advertisingEnableParams: ble.AdvertisingEnableParams = { advertisingId: advHandle, duration: 0 } // after 3s, advertising disabled, then enable the advertising ble.enableAdvertising(advertisingEnableParams, (err) => { if (err) { return; } });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.enableAdvertising11+

enableAdvertising(advertisingEnableParams: AdvertisingEnableParams): Promise

临时启动BLE广播。使用Promise异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

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

参数：

参数名类型必填说明 advertisingEnableParams AdvertisingEnableParams 是临时启动BLE广播的相关参数。

返回值：

类型说明 Promise 回调函数。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';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));try { let setting: ble.AdvertiseSetting = { interval:150, txPower:0, connectable:true }; let manufactureDataUnit: ble.ManufactureData = { manufactureId:4567, manufactureValue:manufactureValueBuffer.buffer }; let serviceDataUnit: ble.ServiceData = { serviceUuid:\"00001888-0000-1000-8000-00805f9b34fb\", serviceValue:serviceValueBuffer.buffer }; let advData: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advResponse: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advertisingParams: ble.AdvertisingParams = { advertisingSettings: setting, advertisingData: advData, advertisingResponse: advResponse, duration: 300 } let advHandle = 0xFF; ble.startAdvertising(advertisingParams, (err, outAdvHandle) => { if (err) { return; } else { advHandle = outAdvHandle; console.info(\"advHandle: \" + advHandle); } }); let advertisingEnableParams: ble.AdvertisingEnableParams = { advertisingId: advHandle, duration: 0 } // after 3s, advertising disabled, then enable the advertising ble.enableAdvertising(advertisingEnableParams) .then(() => { console.info(\"enable success\"); });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.disableAdvertising11+

disableAdvertising(advertisingDisableParams: AdvertisingDisableParams, callback: AsyncCallback): void

临时停止BLE广播。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

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

参数：

参数名类型必填说明 advertisingDisableParams AdvertisingDisableParams 是临时停止BLE广播的相关参数。 callback AsyncCallback 是回调函数。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';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));try { let setting: ble.AdvertiseSetting = { interval:150, txPower:0, connectable:true }; let manufactureDataUnit: ble.ManufactureData = { manufactureId:4567, manufactureValue:manufactureValueBuffer.buffer }; let serviceDataUnit: ble.ServiceData = { serviceUuid:\"00001888-0000-1000-8000-00805f9b34fb\", serviceValue:serviceValueBuffer.buffer }; let advData: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advResponse: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advertisingParams: ble.AdvertisingParams = { advertisingSettings: setting, advertisingData: advData, advertisingResponse: advResponse, duration: 0 } let advHandle = 0xFF; ble.startAdvertising(advertisingParams, (err, outAdvHandle) => { if (err) { return; } else { advHandle = outAdvHandle; console.info(\"advHandle: \" + advHandle); } }); let advertisingDisableParams: ble.AdvertisingDisableParams = { advertisingId: advHandle } ble.disableAdvertising(advertisingDisableParams, (err) => { if (err) { return; } });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.disableAdvertising11+

disableAdvertising(advertisingDisableParams: AdvertisingDisableParams): Promise

临时停止BLE广播。使用Promise异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

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

参数：

参数名类型必填说明 advertisingDisableParams AdvertisingDisableParams 是临时停止BLE广播的相关参数。

返回值：

类型说明 Promise 回调函数。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';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));try { let setting: ble.AdvertiseSetting = { interval:150, txPower:0, connectable:true }; let manufactureDataUnit: ble.ManufactureData = { manufactureId:4567, manufactureValue:manufactureValueBuffer.buffer }; let serviceDataUnit: ble.ServiceData = { serviceUuid:\"00001888-0000-1000-8000-00805f9b34fb\", serviceValue:serviceValueBuffer.buffer }; let advData: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advResponse: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advertisingParams: ble.AdvertisingParams = { advertisingSettings: setting, advertisingData: advData, advertisingResponse: advResponse, duration: 0 } let advHandle = 0xFF; ble.startAdvertising(advertisingParams, (err, outAdvHandle) => { if (err) { return; } else { advHandle = outAdvHandle; console.info(\"advHandle: \" + advHandle); } }); let advertisingDisableParams: ble.AdvertisingDisableParams = { advertisingId: advHandle } ble.disableAdvertising(advertisingDisableParams) .then(() => { console.info(\"enable success\"); });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.stopAdvertising11+

stopAdvertising(advertisingId: number, callback: AsyncCallback): void

停止发送BLE广播。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

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

参数：

参数名类型必填说明 advertisingId number 是需要停止的广播ID标识。 callback AsyncCallback 是回调函数。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';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));try { let setting: ble.AdvertiseSetting = { interval:150, txPower:0, connectable:true }; let manufactureDataUnit: ble.ManufactureData = { manufactureId:4567, manufactureValue:manufactureValueBuffer.buffer }; let serviceDataUnit: ble.ServiceData = { serviceUuid:\"00001888-0000-1000-8000-00805f9b34fb\", serviceValue:serviceValueBuffer.buffer }; let advData: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advResponse: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advertisingParams: ble.AdvertisingParams = { advertisingSettings: setting, advertisingData: advData, advertisingResponse: advResponse, duration: 0 } let advHandle = 0xFF; ble.startAdvertising(advertisingParams, (err, outAdvHandle) => { if (err) { return; } else { advHandle = outAdvHandle; console.info(\"advHandle: \" + advHandle); } }); ble.stopAdvertising(advHandle, (err) => { if (err) { return; } });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.stopAdvertising11+

stopAdvertising(advertisingId: number): Promise

停止发送BLE广播。使用Promise异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

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

参数：

参数名类型必填说明 advertisingId number 是需要停止的广播ID标识。

返回值：

类型说明 Promise 回调函数。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';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));try { let setting: ble.AdvertiseSetting = { interval:150, txPower:0, connectable:true }; let manufactureDataUnit: ble.ManufactureData = { manufactureId:4567, manufactureValue:manufactureValueBuffer.buffer }; let serviceDataUnit: ble.ServiceData = { serviceUuid:\"00001888-0000-1000-8000-00805f9b34fb\", serviceValue:serviceValueBuffer.buffer }; let advData: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advResponse: ble.AdvertiseData = { serviceUuids:[\"00001888-0000-1000-8000-00805f9b34fb\"], manufactureData:[manufactureDataUnit], serviceData:[serviceDataUnit] }; let advertisingParams: ble.AdvertisingParams = { advertisingSettings: setting, advertisingData: advData, advertisingResponse: advResponse, duration: 0 } let advHandle = 0xFF; ble.startAdvertising(advertisingParams, (err, outAdvHandle) => { if (err) { return; } else { advHandle = outAdvHandle; console.info(\"advHandle: \" + advHandle); } }); ble.stopAdvertising(advHandle) .then(() => { console.info(\"enable success\"); });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.on(\'advertisingStateChange\')11+

on(type: \'advertisingStateChange\', callback: Callback): void

订阅BLE广播状态。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

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

参数：

参数名类型必填说明 type string 是填写\"advertisingStateChange\"字符串，表示广播状态事件。 callback Callback 是表示回调函数的入参，广播状态。回调函数由用户创建通过该接口注册。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';function onReceiveEvent(data: ble.AdvertisingStateChangeInfo) { console.info(\'bluetooth advertising state = \' + JSON.stringify(data));}try { ble.on(\'advertisingStateChange\', onReceiveEvent);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.off(\'advertisingStateChange\')11+

off(type: \'advertisingStateChange\', callback?: Callback): void

取消订阅BLE广播状态。

需要权限：ohos.permission.ACCESS_BLUETOOTH

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

参数：

参数名类型必填说明 type string 是填写\"advertisingStateChange\"字符串，表示广播状态事件。 callback Callback 否表示取消订阅广播状态上报。不填该参数则取消订阅该type对应的所有回调。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';function onReceiveEvent(data: ble.AdvertisingStateChangeInfo) { console.info(\'bluetooth advertising state = \' + JSON.stringify(data));}try { ble.on(\'advertisingStateChange\', onReceiveEvent); ble.off(\'advertisingStateChange\', onReceiveEvent);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.on(\'BLEDeviceFind\')

on(type: \'BLEDeviceFind\', callback: Callback<Array>): void

订阅BLE设备发现上报事件。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';function onReceiveEvent(data: Array) { console.info(\'bluetooth device find = \'+ JSON.stringify(data));}try { ble.on(\'BLEDeviceFind\', onReceiveEvent);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

ble.off(\'BLEDeviceFind\')

off(type: \'BLEDeviceFind\', callback?: Callback<Array>): void

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';function onReceiveEvent(data: Array) { console.info(\'bluetooth device find = \'+ JSON.stringify(data));}try { ble.on(\'BLEDeviceFind\', onReceiveEvent); ble.off(\'BLEDeviceFind\', onReceiveEvent);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

GattServer

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

addService

addService(service: GattService): void

server端添加服务。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';// 创建descriptorslet descriptors: Array = [];let arrayBuffer = new ArrayBuffer(8);let descV = new Uint8Array(arrayBuffer);descV[0] = 11;let descriptor: ble.BLEDescriptor = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', descriptorUuid: \'00002902-0000-1000-8000-00805F9B34FB\', descriptorValue: arrayBuffer};descriptors[0] = descriptor;// 创建characteristicslet characteristics: Array = [];let arrayBufferC = new ArrayBuffer(8);let cccV = new Uint8Array(arrayBufferC);cccV[0] = 1;let characteristic: ble.BLECharacteristic = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', characteristicValue: arrayBufferC, descriptors:descriptors};characteristics[0] = characteristic;// 创建gattServicelet gattService: ble.GattService = {serviceUuid:\'00001810-0000-1000-8000-00805F9B34FB\', isPrimary: true, characteristics:characteristics, includeServices:[]};try { let gattServer: ble.GattServer = ble.createGattServer(); gattServer.addService(gattService);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

removeService

removeService(serviceUuid: string): void

删除已添加的服务。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';let server: ble.GattServer = ble.createGattServer();try { // 调用removeService接口前需要完成server端和client端的配对及连接。 server.removeService(\'00001810-0000-1000-8000-00805F9B34FB\');} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

close

close(): void

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

错误码：

以下错误码的详细介绍。

错误码ID 错误信息 201 Permission denied. 801 Capability not supported. 2900001 Service stopped. 2900003 Bluetooth disabled. 2900099 Operation failed.

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';let server: ble.GattServer = ble.createGattServer();try { server.close();} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

notifyCharacteristicChanged

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

server端特征值发生变化时，主动通知已连接的client设备。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

参数名类型必填说明 deviceId string 是接收通知的client端设备地址，例如“XX:XX:XX:XX:XX:XX”。 notifyCharacteristic NotifyCharacteristic 是通知的特征值数据。 callback AsyncCallback 是回调函数。当通知成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';let arrayBufferC = new ArrayBuffer(8);let notifyCharacter: ble.NotifyCharacteristic = { serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', characteristicValue: arrayBufferC, confirm: true};try { let gattServer: ble.GattServer = ble.createGattServer(); gattServer.notifyCharacteristicChanged(\'XX:XX:XX:XX:XX:XX\', notifyCharacter, (err: BusinessError) => { if (err) { console.info(\'notifyCharacteristicChanged callback failed\'); } else { console.info(\'notifyCharacteristicChanged callback successful\'); } });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

notifyCharacteristicChanged

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

server端特征值发生变化时，主动通知已连接的client设备。使用Promise异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

返回值：

类型说明 Promise 返回promise对象。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';let arrayBufferC = new ArrayBuffer(8);let notifyCharacter: ble.NotifyCharacteristic = { serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', characteristicValue: arrayBufferC, confirm: true};try { let gattServer: ble.GattServer = ble.createGattServer(); gattServer.notifyCharacteristicChanged(\'XX:XX:XX:XX:XX:XX\', notifyCharacter).then(() => { console.info(\'notifyCharacteristicChanged promise successful\'); });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

sendResponse

sendResponse(serverResponse: ServerResponse): void

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';/* send response */let arrayBufferCCC = new ArrayBuffer(8);let cccValue = new Uint8Array(arrayBufferCCC);cccValue[0] = 1123;let serverResponse: ble.ServerResponse = { deviceId: \'XX:XX:XX:XX:XX:XX\', transId: 0, status: 0, offset: 0, value: arrayBufferCCC};try { let gattServer: ble.GattServer = ble.createGattServer(); gattServer.sendResponse(serverResponse);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

on(\'characteristicRead\')

on(type: \'characteristicRead\', callback: Callback): void

server端订阅特征值读请求事件。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';let arrayBufferCCC = new ArrayBuffer(8);let cccValue = new Uint8Array(arrayBufferCCC);cccValue[0] = 1123;let gattServer: ble.GattServer = ble.createGattServer();function ReadCharacteristicReq(characteristicReadRequest: ble.CharacteristicReadRequest) { let deviceId: string = characteristicReadRequest.deviceId; let transId: number = characteristicReadRequest.transId; let offset: number = characteristicReadRequest.offset; let characteristicUuid: string = characteristicReadRequest.characteristicUuid; let serverResponse: ble.ServerResponse = {deviceId: deviceId, transId: transId, status: 0, offset: offset, value:arrayBufferCCC}; try { gattServer.sendResponse(serverResponse); } catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message); }}gattServer.on(\'characteristicRead\', ReadCharacteristicReq);

off(\'characteristicRead\')

off(type: \'characteristicRead\', callback?: Callback): void

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let gattServer: ble.GattServer = ble.createGattServer(); gattServer.off(\'characteristicRead\');} catch (err) { console.error(\"errCode:\" + (err as BusinessError).code + \",errMessage:\" + (err as BusinessError).message);}

on(\'characteristicWrite\')

on(type: \'characteristicWrite\', callback: Callback): void

server端订阅特征值写请求事件。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';let arrayBufferCCC = new ArrayBuffer(8);let cccValue = new Uint8Array(arrayBufferCCC);let gattServer: ble.GattServer = ble.createGattServer();function WriteCharacteristicReq(characteristicWriteRequest: ble.CharacteristicWriteRequest) { let deviceId: string = characteristicWriteRequest.deviceId; let transId: number = characteristicWriteRequest.transId; let offset: number = characteristicWriteRequest.offset; let isPrepared: boolean = characteristicWriteRequest.isPrepared; let needRsp: boolean = characteristicWriteRequest.needRsp; let value: Uint8Array = new Uint8Array(characteristicWriteRequest.value); let characteristicUuid: string = characteristicWriteRequest.characteristicUuid; cccValue[0] = value[0]; let serverResponse: ble.ServerResponse = {deviceId: deviceId, transId: transId, status: 0, offset: offset, value:arrayBufferCCC}; try { gattServer.sendResponse(serverResponse); } catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message); }}gattServer.on(\'characteristicWrite\', WriteCharacteristicReq);

off(\'characteristicWrite\')

off(type: \'characteristicWrite\', callback?: Callback): void

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let gattServer: ble.GattServer = ble.createGattServer(); gattServer.off(\'characteristicWrite\');} catch (err) { console.error(\"errCode:\" + (err as BusinessError).code + \",errMessage:\" + (err as BusinessError).message);}

on(\'descriptorRead\')

on(type: \'descriptorRead\', callback: Callback): void

server端订阅描述符读请求事件。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';let arrayBufferDesc = new ArrayBuffer(8);let descValue = new Uint8Array(arrayBufferDesc);descValue[0] = 1101;let gattServer: ble.GattServer = ble.createGattServer();function ReadDescriptorReq(descriptorReadRequest: ble.DescriptorReadRequest) { let deviceId: string = descriptorReadRequest.deviceId; let transId: number = descriptorReadRequest.transId; let offset: number = descriptorReadRequest.offset; let descriptorUuid: string = descriptorReadRequest.descriptorUuid; let serverResponse: ble.ServerResponse = {deviceId: deviceId, transId: transId, status: 0, offset: offset, value:arrayBufferDesc}; try { gattServer.sendResponse(serverResponse); } catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message); }}gattServer.on(\'descriptorRead\', ReadDescriptorReq);

off(\'descriptorRead\')

off(type: \'descriptorRead\', callback?: Callback): void

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let gattServer: ble.GattServer = ble.createGattServer(); gattServer.off(\'descriptorRead\');} catch (err) { console.error(\"errCode:\" + (err as BusinessError).code + \",errMessage:\" + (err as BusinessError).message);}

on(\'descriptorWrite\')

on(type: \'descriptorWrite\', callback: Callback): void

server端订阅描述符写请求事件。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';let arrayBufferDesc = new ArrayBuffer(8);let descValue = new Uint8Array(arrayBufferDesc);let gattServer: ble.GattServer = ble.createGattServer();function WriteDescriptorReq(descriptorWriteRequest: ble.DescriptorWriteRequest) { let deviceId: string = descriptorWriteRequest.deviceId; let transId: number = descriptorWriteRequest.transId; let offset: number = descriptorWriteRequest.offset; let isPrepared: boolean = descriptorWriteRequest.isPrepared; let needRsp: boolean = descriptorWriteRequest.needRsp; let value: Uint8Array = new Uint8Array(descriptorWriteRequest.value); let descriptorUuid: string = descriptorWriteRequest.descriptorUuid; descValue[0] = value[0]; let serverResponse: ble.ServerResponse = {deviceId: deviceId, transId: transId, status: 0, offset: offset, value:arrayBufferDesc}; try { gattServer.sendResponse(serverResponse); } catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message); }}gattServer.on(\'descriptorWrite\', WriteDescriptorReq);

off(\'descriptorWrite\')

off(type: \'descriptorWrite\', callback?: Callback): void

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try {let gattServer: ble.GattServer = ble.createGattServer();gattServer.off(\'descriptorWrite\');} catch (err) { console.error(\"errCode:\" + (err as BusinessError).code + \",errMessage:\" + (err as BusinessError).message);}

on(\'connectionStateChange\')

on(type: \'connectionStateChange\', callback: Callback): void

server端订阅BLE连接状态变化事件。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';import { constant } from \'@kit.ConnectivityKit\';let Connected = (bleConnectionChangeState: ble.BLEConnectionChangeState) => { let deviceId: string = bleConnectionChangeState.deviceId; let status: constant.ProfileConnectionState = bleConnectionChangeState.state;}try { let gattServer: ble.GattServer = ble.createGattServer(); gattServer.on(\'connectionStateChange\', Connected);} catch (err) { console.error(\"errCode:\" + (err as BusinessError).code + \",errMessage:\" + (err as BusinessError).message);}

off(\'connectionStateChange\')

off(type: \'connectionStateChange\', callback?: Callback): void

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let gattServer: ble.GattServer = ble.createGattServer(); gattServer.off(\'connectionStateChange\');} catch (err) { console.error(\"errCode:\" + (err as BusinessError).code + \",errMessage:\" + (err as BusinessError).message);}

on(\'BLEMtuChange\')

on(type: \'BLEMtuChange\', callback: Callback): void

server端订阅MTU状态变化事件。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

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

参数：

参数名类型必填说明 type string 是必须填写\"BLEMtuChange\"字符串，表示MTU状态变化事件。填写不正确将导致回调无法注册。 callback Callback 是返回MTU字节数的值，通过注册回调函数获取。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let gattServer: ble.GattServer = ble.createGattServer(); gattServer.on(\'BLEMtuChange\', (mtu: number) => { console.info(\'BLEMtuChange, mtu: \' + mtu); });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

off(\'BLEMtuChange\')

off(type: \'BLEMtuChange\', callback?: Callback): void

server端取消订阅MTU状态变化事件。

需要权限：ohos.permission.ACCESS_BLUETOOTH

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

参数：

参数名类型必填说明 type string 是必须填写\"BLEMtuChange\"字符串，表示MTU状态变化事件。填写不正确将导致回调无法注册。 callback Callback 否返回MTU字节数的值，通过注册回调函数获取。不填该参数则取消订阅该type对应的所有回调。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let gattServer: ble.GattServer = ble.createGattServer(); gattServer.off(\'BLEMtuChange\');} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

GattClientDevice

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

connect

connect(): void

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

错误码：

以下错误码的详细介绍。

错误码ID 错误信息 201 Permission denied. 801 Capability not supported. 2900001 Service stopped. 2900003 Bluetooth disabled. 2900099 Operation failed.

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.connect();} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

disconnect

disconnect(): void

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

错误码：

以下错误码的详细介绍。

错误码ID 错误信息 201 Permission denied. 801 Capability not supported. 2900001 Service stopped. 2900003 Bluetooth disabled. 2900099 Operation failed.

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.disconnect();} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

close

close(): void

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

错误码：

以下错误码的详细介绍。

错误码ID 错误信息 201 Permission denied. 801 Capability not supported. 2900001 Service stopped. 2900003 Bluetooth disabled. 2900099 Operation failed.

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.close();} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

getDeviceName

getDeviceName(callback: AsyncCallback): void

client获取远端蓝牙低功耗设备名。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';// callbacktry { let gattClient: ble.GattClientDevice = ble.createGattClientDevice(\"XX:XX:XX:XX:XX:XX\"); gattClient.connect(); gattClient.getDeviceName((err: BusinessError, data: string)=> { console.info(\'device name err \' + JSON.stringify(err)); console.info(\'device name\' + JSON.stringify(data)); })} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

getDeviceName

getDeviceName(): Promise

client获取远端蓝牙低功耗设备名。使用Promise异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

返回值：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';// promisetry { let gattClient: ble.GattClientDevice = ble.createGattClientDevice(\"XX:XX:XX:XX:XX:XX\"); gattClient.connect(); gattClient.getDeviceName().then((data: string) => { console.info(\'device name\' + JSON.stringify(data)); })} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

getServices

getServices(callback: AsyncCallback<Array>): void

client端获取蓝牙低功耗设备的所有服务，即服务发现。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';// callback 模式let getServices = (code: BusinessError, gattServices: Array) => { if (code && code.code != 0) { console.info(\'bluetooth code is \' + code.code); return; } let services: Array = gattServices; console.info(\'bluetooth services size is \', services.length); for (let i = 0; i < services.length; i++) { console.info(\'bluetooth serviceUuid is \' + services[i].serviceUuid); }}try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.connect(); device.getServices(getServices);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

getServices

getServices(): Promise<Array>

client端获取蓝牙低功耗设备的所有服务，即服务发现。使用Promise异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

返回值：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';// Promise 模式try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.connect(); device.getServices().then((result: Array) => { console.info(\'getServices successfully:\' + JSON.stringify(result)); });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

readCharacteristicValue

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

client端读取蓝牙低功耗设备特定服务的特征值。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';function readCcc(code: BusinessError, BLECharacteristic: ble.BLECharacteristic) { if (code.code != 0) { return; } console.info(\'bluetooth characteristic uuid: \' + BLECharacteristic.characteristicUuid); let value = new Uint8Array(BLECharacteristic.characteristicValue); console.info(\'bluetooth characteristic value: \' + value[0] +\',\'+ value[1]+\',\'+ value[2]+\',\'+ value[3]);}let descriptors: Array = [];let bufferDesc = new ArrayBuffer(8);let descV = new Uint8Array(bufferDesc);descV[0] = 11;let descriptor: ble.BLEDescriptor = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\',characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\',descriptorUuid: \'00002903-0000-1000-8000-00805F9B34FB\', descriptorValue: bufferDesc};descriptors[0] = descriptor;let bufferCCC = new ArrayBuffer(8);let cccV = new Uint8Array(bufferCCC);cccV[0] = 1;let characteristic: ble.BLECharacteristic = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\',characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\',characteristicValue: bufferCCC, descriptors:descriptors};try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.readCharacteristicValue(characteristic, readCcc);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

readCharacteristicValue

readCharacteristicValue(characteristic: BLECharacteristic): Promise

client端读取蓝牙低功耗设备特定服务的特征值。使用Promise异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

返回值：

类型说明 Promise client读取特征值，通过promise形式获取。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';let descriptors: Array = [];let bufferDesc = new ArrayBuffer(8);let descV = new Uint8Array(bufferDesc);descV[0] = 11;let descriptor: ble.BLEDescriptor = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\',characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\',descriptorUuid: \'00002903-0000-1000-8000-00805F9B34FB\', descriptorValue: bufferDesc};descriptors[0] = descriptor;let bufferCCC = new ArrayBuffer(8);let cccV = new Uint8Array(bufferCCC);cccV[0] = 1;let characteristic: ble.BLECharacteristic = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\',characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\',characteristicValue: bufferCCC, descriptors:descriptors};try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.readCharacteristicValue(characteristic);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

readDescriptorValue

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

client端读取蓝牙低功耗设备特定的特征包含的描述符。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';function readDesc(code: BusinessError, BLEDescriptor: ble.BLEDescriptor) { if (code.code != 0) { return; } console.info(\'bluetooth descriptor uuid: \' + BLEDescriptor.descriptorUuid); let value = new Uint8Array(BLEDescriptor.descriptorValue); console.info(\'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: ble.BLEDescriptor = { serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', descriptorUuid: \'00002903-0000-1000-8000-00805F9B34FB\', descriptorValue: bufferDesc};try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.readDescriptorValue(descriptor, readDesc);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

readDescriptorValue

readDescriptorValue(descriptor: BLEDescriptor): Promise

client端读取蓝牙低功耗设备特定的特征包含的描述符。使用Promise异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

返回值：

类型说明 Promise client读取描述符，通过promise形式获取。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';let bufferDesc = new ArrayBuffer(8);let descV = new Uint8Array(bufferDesc);descV[0] = 11;let descriptor: ble.BLEDescriptor = { serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', descriptorUuid: \'00002903-0000-1000-8000-00805F9B34FB\', descriptorValue: bufferDesc};try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.readDescriptorValue(descriptor);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

writeCharacteristicValue

writeCharacteristicValue(characteristic: BLECharacteristic, writeType: GattWriteType, callback: AsyncCallback): void

client端向低功耗蓝牙设备写入特定的特征值。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

参数名类型必填说明 characteristic BLECharacteristic 是蓝牙设备特征对应的二进制值及其它参数。 writeType GattWriteType 是蓝牙设备特征的写入类型。 callback AsyncCallback 是回调函数。当写入成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';let descriptors: Array = [];let bufferDesc = new ArrayBuffer(8);let descV = new Uint8Array(bufferDesc);descV[0] = 11;let descriptor: ble.BLEDescriptor = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', descriptorUuid: \'00002903-0000-1000-8000-00805F9B34FB\', descriptorValue: bufferDesc};descriptors[0] = descriptor;let bufferCCC = new ArrayBuffer(8);let cccV = new Uint8Array(bufferCCC);cccV[0] = 1;let characteristic: ble.BLECharacteristic = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', characteristicValue: bufferCCC, descriptors:descriptors};function writeCharacteristicValueCallBack(code: BusinessError) { if (code != null) { return; } console.info(\'bluetooth writeCharacteristicValue success\');}try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.writeCharacteristicValue(characteristic, ble.GattWriteType.WRITE, writeCharacteristicValueCallBack);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

writeCharacteristicValue

writeCharacteristicValue(characteristic: BLECharacteristic, writeType: GattWriteType): Promise

client端向低功耗蓝牙设备写入特定的特征值。使用Promise异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

返回值：

类型说明 Promise client读取描述符，通过promise形式获取。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';let descriptors: Array = [];let bufferDesc = new ArrayBuffer(8);let descV = new Uint8Array(bufferDesc);descV[0] = 11;let descriptor: ble.BLEDescriptor = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', descriptorUuid: \'00002903-0000-1000-8000-00805F9B34FB\', descriptorValue: bufferDesc};descriptors[0] = descriptor;let bufferCCC = new ArrayBuffer(8);let cccV = new Uint8Array(bufferCCC);cccV[0] = 1;let characteristic: ble.BLECharacteristic = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', characteristicValue: bufferCCC, descriptors:descriptors};try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.writeCharacteristicValue(characteristic, ble.GattWriteType.WRITE);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

writeDescriptorValue

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

client端向低功耗蓝牙设备特定的描述符写入二进制数据。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

参数名类型必填说明 descriptor BLEDescriptor 是蓝牙设备描述符的二进制值及其它参数。 callback AsyncCallback 是回调函数。当写入成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';let bufferDesc = new ArrayBuffer(8);let descV = new Uint8Array(bufferDesc);descV[0] = 22;let descriptor: ble.BLEDescriptor = { serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', descriptorUuid: \'00002903-0000-1000-8000-00805F9B34FB\', descriptorValue: bufferDesc};try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.writeDescriptorValue(descriptor, (err: BusinessError) => { if (err) { console.info(\'notifyCharacteristicChanged callback failed\'); } else { console.info(\'notifyCharacteristicChanged callback successful\'); } });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

writeDescriptorValue

writeDescriptorValue(descriptor: BLEDescriptor): Promise

client端向低功耗蓝牙设备特定的描述符写入二进制数据。使用Promise异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

返回值：

类型说明 Promise client读取描述符，通过promise形式获取。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';let bufferDesc = new ArrayBuffer(8);let descV = new Uint8Array(bufferDesc);descV[0] = 22;let descriptor: ble.BLEDescriptor = { serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', descriptorUuid: \'00002903-0000-1000-8000-00805F9B34FB\', descriptorValue: bufferDesc};try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.writeDescriptorValue(descriptor).then(() => { console.info(\'writeDescriptorValue promise success\'); });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

getRssiValue

getRssiValue(callback: AsyncCallback): void

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';// callbacktry { let gattClient: ble.GattClientDevice = ble.createGattClientDevice(\"XX:XX:XX:XX:XX:XX\"); gattClient.connect(); let rssi = gattClient.getRssiValue((err: BusinessError, data: number)=> { console.info(\'rssi err \' + JSON.stringify(err)); console.info(\'rssi value\' + JSON.stringify(data)); })} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

getRssiValue

getRssiValue(): Promise

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

返回值：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';// promisetry { let gattClient: ble.GattClientDevice = ble.createGattClientDevice(\"XX:XX:XX:XX:XX:XX\"); gattClient.getRssiValue().then((data: number) => { console.info(\'rssi\' + JSON.stringify(data)); })} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

setBLEMtuSize

setBLEMtuSize(mtu: number): void

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.setBLEMtuSize(128);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

setCharacteristicChangeNotification

setCharacteristicChangeNotification(characteristic: BLECharacteristic, enable: boolean, callback: AsyncCallback): void

向服务端发送设置通知此特征值请求。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

参数名类型必填说明 characteristic BLECharacteristic 是蓝牙低功耗特征。 enable boolean 是启用接收notify设置为true，否则设置为false。 callback AsyncCallback 是回调函数。当发送成功，err为undefined，否则为错误对象。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';// 创建descriptorslet descriptors: Array = [];let arrayBuffer = new ArrayBuffer(8);let descV = new Uint8Array(arrayBuffer);descV[0] = 11;let descriptor: ble.BLEDescriptor = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', descriptorUuid: \'00002902-0000-1000-8000-00805F9B34FB\', descriptorValue: arrayBuffer};descriptors[0] = descriptor;let arrayBufferC = new ArrayBuffer(8);let characteristic: ble.BLECharacteristic = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', characteristicValue: arrayBufferC, descriptors:descriptors};try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.setCharacteristicChangeNotification(characteristic, false, (err: BusinessError) => { if (err) { console.info(\'notifyCharacteristicChanged callback failed\'); } else { console.info(\'notifyCharacteristicChanged callback successful\'); } });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

setCharacteristicChangeNotification

setCharacteristicChangeNotification(characteristic: BLECharacteristic, enable: boolean): Promise

向服务端发送设置通知此特征值请求。使用Promise异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

返回值：

类型说明 Promise 返回Promise对象。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';// 创建descriptorslet descriptors: Array = [];let arrayBuffer = new ArrayBuffer(8);let descV = new Uint8Array(arrayBuffer);descV[0] = 11;let descriptor: ble.BLEDescriptor = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', descriptorUuid: \'00002902-0000-1000-8000-00805F9B34FB\', descriptorValue: arrayBuffer};descriptors[0] = descriptor;let arrayBufferC = new ArrayBuffer(8);let characteristic: ble.BLECharacteristic = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', characteristicValue: arrayBufferC, descriptors:descriptors};try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.setCharacteristicChangeNotification(characteristic, false);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

setCharacteristicChangeIndication

setCharacteristicChangeIndication(characteristic: BLECharacteristic, enable: boolean, callback: AsyncCallback): void

向服务端发送设置通知此特征值请求，需要对端设备的回复。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';// 创建descriptorslet descriptors: Array = [];let arrayBuffer = new ArrayBuffer(8);let descV = new Uint8Array(arrayBuffer);descV[0] = 11;let descriptor: ble.BLEDescriptor = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', descriptorUuid: \'00002902-0000-1000-8000-00805F9B34FB\', descriptorValue: arrayBuffer};descriptors[0] = descriptor;let arrayBufferC = new ArrayBuffer(8);let characteristic: ble.BLECharacteristic = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', characteristicValue: arrayBufferC, descriptors:descriptors};try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.setCharacteristicChangeIndication(characteristic, false, (err: BusinessError) => { if (err) { console.info(\'notifyCharacteristicChanged callback failed\'); } else { console.info(\'notifyCharacteristicChanged callback successful\'); } });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

setCharacteristicChangeIndication

setCharacteristicChangeIndication(characteristic: BLECharacteristic, enable: boolean): Promise

向服务端发送设置通知此特征值请求，需要对端设备的回复。使用Promise异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

返回值：

类型说明 Promise 返回Promise对象。

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';// 创建descriptorslet descriptors: Array = [];let arrayBuffer = new ArrayBuffer(8);let descV = new Uint8Array(arrayBuffer);descV[0] = 11;let descriptor: ble.BLEDescriptor = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', descriptorUuid: \'00002902-0000-1000-8000-00805F9B34FB\', descriptorValue: arrayBuffer};descriptors[0] = descriptor;let arrayBufferC = new ArrayBuffer(8);let characteristic: ble.BLECharacteristic = {serviceUuid: \'00001810-0000-1000-8000-00805F9B34FB\', characteristicUuid: \'00001820-0000-1000-8000-00805F9B34FB\', characteristicValue: arrayBufferC, descriptors:descriptors};try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.setCharacteristicChangeIndication(characteristic, false);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

on(\'BLECharacteristicChange\')

on(type: \'BLECharacteristicChange\', callback: Callback): void

订阅蓝牙低功耗设备的特征值变化事件。需要先调用setCharacteristicChangeNotification接口或setCharacteristicChangeIndication接口才能接收server端的通知。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';function CharacteristicChange(characteristicChangeReq: ble.BLECharacteristic) { let serviceUuid: string = characteristicChangeReq.serviceUuid; let characteristicUuid: string = characteristicChangeReq.characteristicUuid; let value: Uint8Array = new Uint8Array(characteristicChangeReq.characteristicValue);}try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.on(\'BLECharacteristicChange\', CharacteristicChange);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

off(\'BLECharacteristicChange\')

off(type: \'BLECharacteristicChange\', callback?: Callback): void

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.off(\'BLECharacteristicChange\');} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

on(\'BLEConnectionStateChange\')

on(type: \'BLEConnectionStateChange\', callback: Callback): void

client端订阅蓝牙低功耗设备的连接状态变化事件。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';function ConnectStateChanged(state: ble.BLEConnectionChangeState) { console.info(\'bluetooth connect state changed\'); let connectState: ble.ProfileConnectionState = state.state;}try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.on(\'BLEConnectionStateChange\', ConnectStateChanged);} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

off(\'BLEConnectionStateChange\')

off(type: \'BLEConnectionStateChange\', callback?: Callback): void

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

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

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

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.off(\'BLEConnectionStateChange\');} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

on(\'BLEMtuChange\')

on(type: \'BLEMtuChange\', callback: Callback): void

client端订阅MTU状态变化事件。使用Callback异步回调。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let gattClient: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); gattClient.on(\'BLEMtuChange\', (mtu: number) => { console.info(\'BLEMtuChange, mtu: \' + mtu); });} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

off(\'BLEMtuChange\')

off(type: \'BLEMtuChange\', callback?: Callback): void

client端取消订阅MTU状态变化事件。

需要权限：ohos.permission.ACCESS_BLUETOOTH

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

参数：

错误码：

以下错误码的详细介绍。

示例：

import { AsyncCallback, BusinessError } from \'@kit.BasicServicesKit\';try { let device: ble.GattClientDevice = ble.createGattClientDevice(\'XX:XX:XX:XX:XX:XX\'); device.off(\'BLEMtuChange\');} catch (err) { console.error(\'errCode: \' + (err as BusinessError).code + \', errMessage: \' + (err as BusinessError).message);}

GattService

描述service的接口参数定义。

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

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

BLECharacteristic

描述characteristic的接口参数定义。

元服务API：从API version 12开始，该接口支持在元服务中使用。

系统能力：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 是是特定特征的描述符列表。 properties GattProperties 是是特定特征的属性描述。

BLEDescriptor

描述descriptor的接口参数定义。

元服务API：从API version 12开始，该接口支持在元服务中使用。

系统能力：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端特征值变化时发送的特征通知参数定义。

元服务API：从API version 12开始，该接口支持在元服务中使用。

系统能力：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 是是如果是indication，对端需要回复确认，则设置为true；如果是notification，对端不需要回复确认，则设置为false。

CharacteristicReadRequest

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

元服务API：从API version 12开始，该接口支持在元服务中使用。

系统能力：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。

CharacteristicWriteRequest

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

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

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

DescriptorReadRequest

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

元服务API：从API version 12开始，该接口支持在元服务中使用。

系统能力：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。

DescriptorWriteRequest

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

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

名称类型可读可写说明 deviceId string 是否表示发送描述符写请求的远端设备地址，例如：\"XX:XX:XX:XX:XX:XX\"。 transId number 是否表示写请求的传输ID，server端回复响应时需填写相同的传输ID。 offset number 是否表示写描述符数据的起始位置。例如：k表示从第k个字节开始写，server端回复响应时需填写相同的offset。 isPrepared 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端读/写请求的响应参数结构。

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

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

BLEConnectionChangeState

描述Gatt profile连接状态。

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

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

ScanResult

扫描结果上报数据。

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

名称类型可读可写说明 deviceId string 是否表示扫描到的设备地址，例如：\"XX:XX:XX:XX:XX:XX\"。基于信息安全考虑，此处获取的设备地址为随机MAC地址。配对成功后，该地址不会变更；已配对设备取消配对后重新扫描或蓝牙服务下电时，该随机地址会变更。 rssi number 是否表示扫描到的设备的rssi值。 data ArrayBuffer 是否表示扫描到的设备发送的广播包。 deviceName string 是否表示扫描到的设备名称。 connectable boolean 是否表示扫描到的设备是否可连接。true表示可连接，false表示不可连接。

AdvertiseSetting

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

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

名称类型可读可写说明 interval number 是是表示广播间隔，最小值设置32个slot表示20ms，最大值设置16777215个slot，默认值设置为1600个slot表示1s。(传统广播模式下最大值为16384个slot表示10.24s) txPower number 是是表示发送功率，最小值设置-127，最大值设置1，默认值设置-7，单位dbm。推荐值：高档（1），中档（-7），低档（-15）。 connectable boolean 是是表示是否是可连接广播，默认值设置为true，表示可连接，false表示不可连接。

AdvertiseData

描述BLE广播数据包的内容，广播包数据长度为31个字节。

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

名称类型可读可写说明 serviceUuids Array 是是表示要广播的服务 UUID 列表。 manufactureData Array 是是表示要广播的广播的制造商信息列表。 serviceData Array 是是表示要广播的服务数据列表。 includeDeviceName boolean 是是表示是否携带设备名，可选参数。true表示携带，false或未设置此参数表示不携带。注意带上设备名时广播包长度不能超出31个字节。

AdvertisingParams11+

描述首次启动广播设置的参数。

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

名称类型可读可写说明 advertisingSettings11+ AdvertiseSetting 是是表示发送广播的相关参数。 advertisingData11+ AdvertiseData 是是表示广播的数据包内容。 advertisingResponse11+ AdvertiseData 是是表示回复扫描请求的响应内容。 duration11+ number 是是表示发送广播持续的时间。单位为10ms，有效范围为1(10ms)到65535(655350ms)，如果未指定此参数或者将其设置为0，则会连续发送广播。

AdvertisingEnableParams11+

描述临时启动广播设置的参数。

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

名称类型可读可写说明 advertisingId11+ number 是是表示当前广播的ID标识。 duration11+ number 是是表示发送广播持续的时间。单位为10ms，有效范围为1(10ms)到65535(655350ms)，如果未指定此参数或者将其设置为0，则会连续发送广播。

AdvertisingDisableParams11+

描述临时停止广播设置的参数。

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

名称类型可读可写说明 advertisingId11+ number 是是表示当前广播的ID标识。

AdvertisingStateChangeInfo11+

描述广播启动、停止等状态信息。

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

名称类型可读可写说明 advertisingId11+ number 是是表示广播ID标识。 state11+ AdvertisingState 是是表示广播状态。

ManufactureData

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

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

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

ServiceData

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

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

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

ScanFilter

扫描过滤参数。

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

名称类型必填说明 deviceId string 否表示过滤的BLE设备地址，例如：\"XX:XX:XX:XX:XX:XX\"。 name string 否表示过滤的BLE设备名。 serviceUuid string 否表示过滤包含该UUID服务的设备，例如：00001888-0000-1000-8000-00805f9b34fb。 serviceUuidMask string 否表示过滤包含该UUID服务掩码的设备，例如：FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF。 serviceSolicitationUuid string 否表示过滤包含该UUID服务请求的设备，例如：00001888-0000-1000-8000-00805F9B34FB。 serviceSolicitationUuidMask string 否表示过滤包含该UUID服务请求掩码的设备，例如：FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF。 serviceData ArrayBuffer 否表示过滤包含该服务相关数据的设备，例如：[0x90,0x00,0xF1,0xF2]。 serviceDataMask ArrayBuffer 否表示过滤包含该服务相关数据掩码的设备，例如：[0xFF,0xFF,0xFF,0xFF]。 manufactureId number 否表示过滤包含该制造商ID的设备，例如：0x0006。 manufactureData ArrayBuffer 否表示过滤包含该制造商相关数据的设备，例如：[0x1F,0x2F,0x3F]。 manufactureDataMask ArrayBuffer 否表示过滤包含该制造商相关数据掩码的设备，例如：[0xFF,0xFF,0xFF]。

ScanOptions

扫描的配置参数。

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

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

GattProperties

描述gatt characteristic的属性。

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

名称类型必填说明 write boolean 否表示该特征支持写操作，true表示需要对端设备的回复。 writeNoResponse boolean 否 true表示该特征支持写操作，无需对端设备回复。 read boolean 否 true表示该特征支持读操作。 notify boolean 否 true表示该特征可通知对端设备。 indicate boolean 否 true表示该特征可通知对端设备，需要对端设备的回复。

GattWriteType

枚举，表示gatt写入类型。

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

名称值说明 WRITE 1 表示写入特征值，需要对端设备的回复。 WRITE_NO_RESPONSE 2 表示写入特征值，不需要对端设备的回复。

ScanDuty

枚举，扫描模式。

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

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

MatchMode

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

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

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

AdvertisingState11+

枚举，广播状态。

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

名称值说明 STARTED11+ 1 表示首次启动广播后的状态。 ENABLED11+ 2 表示临时启动广播后的状态。 DISABLED11+ 3 表示临时停止广播后的状态。 STOPPED11+ 4 表示完全停止广播后的状态。

PhyType12+

枚举，扫描中使用的PHY类型。

元服务API：从API version 12开始，该接口支持在元服务中使用。

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

名称值说明 PHY_LE_1M12+ 1 表示扫描中使用1M PHY。 PHY_LE_ALL_SUPPORTED12+ 255 表示扫描中使用蓝牙协议支持的PHY模式。