跳到主要内容
版本:3.x

BLEPeripheralServer

外围设备的服务端

支持情况:

参考文档

方法

addService

添加服务

支持情况:

参考文档

(option: Option) => Promise<TaroGeneral.BluetoothError>
参数类型
optionOption

close

关闭当前服务端

支持情况:

参考文档

(option: Option) => Promise<TaroGeneral.BluetoothError>
参数类型
optionOption

offCharacteristicReadRequest

取消监听已连接的设备请求读当前外围设备的特征值事件

支持情况:

参考文档

(callback?: Callback) => void
参数类型说明
callbackCallback已连接的设备请求读当前外围设备的特征值事件的回调函数

offCharacteristicSubscribed

取消监听特征订阅事件

支持情况:

参考文档

(callback?: Callback) => void
参数类型说明
callbackCallback特征订阅事件的回调函数

offCharacteristicUnsubscribed

取消监听取消特征订阅事件

支持情况:

参考文档

(callback?: Callback) => void
参数类型说明
callbackCallback取消特征订阅事件的回调函数

offCharacteristicWriteRequest

取消监听已连接的设备请求写当前外围设备的特征值事件

支持情况:

参考文档

(callback?: Callback) => void
参数类型说明
callbackCallback已连接的设备请求写当前外围设备的特征值事件的回调函数

onCharacteristicReadRequest

监听已连接的设备请求读当前外围设备的特征值事件

收到该消息后需要立刻调用 writeCharacteristicValue 写回数据,否则主机不会收到响应。

支持情况:

参考文档

(callback: Callback) => void
参数类型说明
callbackCallback已连接的设备请求读当前外围设备的特征值事件的回调函数

onCharacteristicSubscribed

监听特征订阅事件,仅 iOS 支持

支持情况:

参考文档

(callback: Callback) => void
参数类型说明
callbackCallback特征订阅事件的回调函数

onCharacteristicUnsubscribed

监听取消特征订阅事件,仅 iOS 支持

支持情况:

参考文档

(callback: Callback) => void
参数类型说明
callbackCallback取消特征订阅事件的回调函数

onCharacteristicWriteRequest

监听已连接的设备请求写当前外围设备的特征值事件

支持情况:

参考文档

(callback: Callback) => void
参数类型说明
callbackCallback已连接的设备请求写当前外围设备的特征值事件的回调函数

removeService

移除服务

支持情况:

参考文档

(option: Option) => Promise<TaroGeneral.BluetoothError>
参数类型
optionOption

startAdvertising

开始广播本地创建的外围设备

支持情况:

参考文档

(option: Option) => Promise<TaroGeneral.BluetoothError>
参数类型
optionOption

stopAdvertising

停止广播

支持情况:

参考文档

(option: Option) => Promise<TaroGeneral.BluetoothError>
参数类型
optionOption

writeCharacteristicValue

往指定特征写入二进制数据值,并通知已连接的主机,从机的特征值已发生变化,该接口会处理是走回包还是走订阅

支持情况:

参考文档

(option: Option) => Promise<TaroGeneral.BluetoothError>
参数类型
optionOption

参数

addService

Option

参数类型必填说明
serviceservice描述 service 的 Object
complete(res: TaroGeneral.BluetoothError) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.BluetoothError) => void接口调用失败的回调函数
success(res: TaroGeneral.BluetoothError) => void接口调用成功的回调函数

service

参数类型说明
uuidstring蓝牙服务的 UUID
characteristicscharacteristic[]characteristics 列表

characteristic

参数类型必填说明
uuidstringcharacteristic 的 UUID
propertiesproperties特征支持的操作
permissioncharacteristicPermission特征权限
valueArrayBuffer特征对应的二进制值
descriptorsdescriptor[]描述符数据

properties

特征支持的操作

参数类型默认值必填说明
writebooleanfalse
writeNoResponsebooleanfalse无回复写
readbooleanfalse
notifybooleanfalse订阅
indicatebooleanfalse回包

characteristicPermission

特征权限

参数类型默认值必填说明
readablebooleanfalse可读
writeablebooleanfalse可写
readEncryptionRequiredbooleanfalse加密读请求
writeEncryptionRequiredbooleanfalse加密写请求

descriptor

描述符数据

参数类型必填说明
uuidstringDescriptor 的 UUID
permissiondescriptorPermission描述符的权限
valueArrayBuffer描述符数据

descriptorPermission

描述符的权限

参数类型默认值必填说明
writebooleanfalse
readbooleanfalse

close

Option

参数类型必填说明
complete(res: TaroGeneral.BluetoothError) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.BluetoothError) => void接口调用失败的回调函数
success(res: TaroGeneral.BluetoothError) => void接口调用成功的回调函数

onCharacteristicReadRequest

Callback

已连接的设备请求读当前外围设备的特征值事件的回调函数

(result: CallbackResult) => void
参数类型
resultCallbackResult

CallbackResult

参数类型说明
serviceIdstring蓝牙特征对应服务的 UUID
characteristicIdstring蓝牙特征的 UUID
callbackIdnumber唯一标识码,调用 writeCharacteristicValue 时使用

onCharacteristicSubscribed

Callback

特征订阅事件的回调函数

(result: CallbackResult) => void
参数类型
resultCallbackResult

CallbackResult

参数类型说明
serviceIdstring蓝牙特征对应服务的 UUID
characteristicIdstring蓝牙特征的 UUID

onCharacteristicUnsubscribed

Callback

取消特征订阅事件的回调函数

(result: CallbackResult) => void
参数类型
resultCallbackResult

CallbackResult

参数类型说明
serviceIdstring蓝牙特征对应服务的 UUID
characteristicIdstring蓝牙特征的 UUID

onCharacteristicWriteRequest

Callback

已连接的设备请求写当前外围设备的特征值事件的回调函数

(result: CallbackResult) => void
参数类型
resultCallbackResult

CallbackResult

参数类型说明
serviceIdstring蓝牙特征对应服务的 UUID
characteristicIdstring蓝牙特征的 UUID
callbackIdnumber唯一标识码,调用 writeCharacteristicValue 时使用
valueArrayBuffer请求写入特征的二进制数据值

removeService

Option

参数类型必填说明
serviceIdstringservice 的 UUID
complete(res: TaroGeneral.BluetoothError) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.BluetoothError) => void接口调用失败的回调函数
success(res: TaroGeneral.BluetoothError) => void接口调用成功的回调函数

startAdvertising

Option

参数类型默认值必填说明
advertiseRequestadvertiseRequest广播自定义参数
powerLevelkeyof PowerLevel"medium"广播功率
complete(res: TaroGeneral.BluetoothError) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.BluetoothError) => void接口调用失败的回调函数
success(res: TaroGeneral.BluetoothError) => void接口调用成功的回调函数

advertiseRequest

广播自定义参数

参数类型默认值必填说明
connectablebooleantrue当前设备是否可连接
deviceNamestring""广播中 deviceName 字段,默认为空
serviceUuidsstring[]要广播的服务 UUID 列表。使用 16/32 位 UUID 时请参考注意事项。
manufacturerDatamanufacturerData[]广播的制造商信息。仅安卓支持,iOS 因系统限制无法定制。
beaconbeacon以 beacon 设备形式广播的参数。

manufacturerData

广播的制造商信息。仅安卓支持,iOS 因系统限制无法定制。

参数类型必填说明
manufacturerIdstring制造商ID,0x 开头的十六进制
manufacturerSpecificDataArrayBuffer制造商信息

beacon

以 beacon 设备形式广播的参数。

参数类型必填说明
uuidstringBeacon 设备广播的 UUID
majornumberBeacon 设备的主 ID
minornumberBeacon 设备的次 ID
measuredPowernumber用于判断距离设备 1 米时 RSSI 大小的参考值

PowerLevel

广播功率合法值

参数说明
low功率低
medium功率适中
high功率高

stopAdvertising

Option

参数类型必填说明
complete(res: TaroGeneral.BluetoothError) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.BluetoothError) => void接口调用失败的回调函数
success(res: TaroGeneral.BluetoothError) => void接口调用成功的回调函数

writeCharacteristicValue

Option

参数类型必填说明
serviceIdstring蓝牙特征对应服务的 UUID
characteristicIdstring蓝牙特征的 UUID
valueArrayBuffercharacteristic 对应的二进制值
needNotifyboolean是否需要通知主机 value 已更新
callbackIdnumber可选,处理回包时使用
complete(res: TaroGeneral.BluetoothError) => void接口调用结束的回调函数(调用成功、失败都会执行)
fail(res: TaroGeneral.BluetoothError) => void接口调用失败的回调函数
success(res: TaroGeneral.BluetoothError) => void接口调用成功的回调函数

API 支持度

API微信小程序京东小程序H5React NativeHarmony
BLEPeripheralServer✔️
BLEPeripheralServer.addService✔️✔️
BLEPeripheralServer.close✔️
BLEPeripheralServer.offCharacteristicReadRequest✔️✔️
BLEPeripheralServer.offCharacteristicSubscribed✔️✔️
BLEPeripheralServer.offCharacteristicUnsubscribed✔️
BLEPeripheralServer.offCharacteristicWriteRequest✔️✔️
BLEPeripheralServer.onCharacteristicReadRequest✔️✔️
BLEPeripheralServer.onCharacteristicSubscribed✔️✔️
BLEPeripheralServer.onCharacteristicUnsubscribed✔️✔️
BLEPeripheralServer.onCharacteristicWriteRequest✔️✔️
BLEPeripheralServer.removeService✔️✔️
BLEPeripheralServer.startAdvertising✔️✔️
BLEPeripheralServer.stopAdvertising✔️✔️
BLEPeripheralServer.writeCharacteristicValue✔️✔️