• uni.openBluetoothAdapter(OBJECT)
    • 错误
  • uni.startBluetoothDevicesDiscovery(OBJECT)
    • 错误
  • uni.onBluetoothDeviceFound(CALLBACK)
  • uni.stopBluetoothDevicesDiscovery(OBJECT)
    • 错误
  • uni.onBluetoothAdapterStateChange(CALLBACK)
  • uni.getConnectedBluetoothDevices(OBJECT)
    • 错误
  • uni.getBluetoothDevices(OBJECT)
    • 错误
  • uni.getBluetoothAdapterState(OBJECT)
    • 错误
  • uni.closeBluetoothAdapter(OBJECT)
    • 错误

    蓝牙 API 平台差异说明

    5+AppH5微信小程序支付宝小程序百度小程序头条小程序
    xxx

    uni.openBluetoothAdapter(OBJECT)

    初始化蓝牙模块

    OBJECT 参数说明

    属性类型默认值必填说明
    successfunction接口调用成功的回调函数
    failfunction接口调用失败的回调函数
    completefunction接口调用结束的回调函数(调用成功、失败都会执行)

    错误

    错误码错误信息说明
    0ok正常
    10000not init未初始化蓝牙适配器
    10001not available当前蓝牙适配器不可用
    10002no device没有找到指定设备
    10003connection fail连接失败
    10004no service没有找到指定服务
    10005no characteristic没有找到指定特征值
    10006no connection当前连接已断开
    10007property not support当前特征值不支持此操作
    10008system error其余所有系统上报的异常
    10009system not supportAndroid 系统特有,系统版本低于 4.3 不支持 BLE

    注意

    • 其他蓝牙相关 API 必须在 uni.openBluetoothAdapter 调用之后使用。否则 API 会返回错误(errCode=10000)。
    • 在用户蓝牙开关未开启或者手机不支持蓝牙功能的情况下,调用 uni.openBluetoothAdapter 会返回错误(errCode=10001),表示手机蓝牙功能不可用。此时APP蓝牙模块已经初始化完成,可通过 uni.onBluetoothAdapterStateChange 监听手机蓝牙状态的改变,也可以调用蓝牙模块的所有API。示例代码
    1. uni.openBluetoothAdapter({
    2. success(res) {
    3. console.log(res)
    4. }
    5. })

    uni.startBluetoothDevicesDiscovery(OBJECT)

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

    OBJECT 参数说明

    属性类型默认值必填说明
    servicesArray<String>要搜索但蓝牙设备主 service 的 uuid 列表。某些蓝牙设备会广播自己的主 service 的 uuid。如果设置此参数,则只搜索广播包有对应 uuid 的主服务的蓝牙设备。建议主要通过该参数过滤掉周边不需要处理的其他蓝牙设备。
    allowDuplicatesKeybooleanfalse是否允许重复上报同一设备。如果允许重复上报,则 uni.onBlueToothDeviceFound 方法会多次上报同一设备,但是 RSSI 值会有不同。
    intervalnumber0上报设备的间隔。0 表示找到新设备立即上报,其他数值根据传入的间隔上报。
    successfunction接口调用成功的回调函数
    failfunction接口调用失败的回调函数
    completefunction接口调用结束的回调函数(调用成功、失败都会执行)

    错误

    错误码错误信息说明
    0ok正常
    10000not init未初始化蓝牙适配器
    10001not available当前蓝牙适配器不可用
    10002no device没有找到指定设备
    10003connection fail连接失败
    10004no service没有找到指定服务
    10005no characteristic没有找到指定特征值
    10006no connection当前连接已断开
    10007property not support当前特征值不支持此操作
    10008system error其余所有系统上报的异常
    10009system not supportAndroid 系统特有,系统版本低于 4.3 不支持 BLE

    注意:

    • App 端目前仅支持发现ble蓝牙设备,更多蓝牙设备发现需使用 Native.js,参考:https://ask.dcloud.net.cn/article/114。示例代码
    1. // 以微信硬件平台的蓝牙智能灯为例,主服务的 UUID 是 FEE7。传入这个参数,只搜索主服务 UUID 为 FEE7 的设备
    2. uni.startBluetoothDevicesDiscovery({
    3. services: ['FEE7'],
    4. success(res) {
    5. console.log(res)
    6. }
    7. })

    uni.onBluetoothDeviceFound(CALLBACK)

    监听寻找到新设备的事件

    CALLBACK 返回参数

    属性类型说明
    devicesArray<Object>新搜索到的设备列表

    devices 的结构

    属性类型说明
    namestring蓝牙设备名称,某些设备可能没有
    deviceIdstring用于区分设备的 id
    RSSInumber当前蓝牙设备的信号强度
    advertisDataArrayBuffer当前蓝牙设备的广播数据段中的 ManufacturerData 数据段。
    advertisServiceUUIDsArray<String>当前蓝牙设备的广播数据段中的 ServiceUUIDs 数据段
    localNamestring当前蓝牙设备的广播数据段中的 LocalName 数据段
    serviceDataObject当前蓝牙设备的广播数据段中的 ServiceData 数据段

    注意

    • 若在 uni.onBluetoothDeviceFound 回调了某个设备,则此设备会添加到 uni.getBluetoothDevices 接口获取到的数组中。示例代码
    1. // ArrayBuffer转16进度字符串示例
    2. function ab2hex(buffer) {
    3. const hexArr = Array.prototype.map.call(
    4. new Uint8Array(buffer),
    5. function (bit) {
    6. return ('00' + bit.toString(16)).slice(-2)
    7. }
    8. )
    9. return hexArr.join('')
    10. }
    11. uni.onBluetoothDeviceFound(function (devices) {
    12. console.log('new device list has founded')
    13. console.dir(devices)
    14. console.log(ab2hex(devices[0].advertisData))
    15. })

    uni.stopBluetoothDevicesDiscovery(OBJECT)

    停止搜寻附近的蓝牙外围设备。若已经找到需要的蓝牙设备并不需要继续搜索时,建议调用该接口停止蓝牙搜索。

    OBJECT 参数说明

    属性类型默认值必填说明
    successfunction接口调用成功的回调函数
    failfunction接口调用失败的回调函数
    completefunction接口调用结束的回调函数(调用成功、失败都会执行)

    错误

    错误码错误信息说明
    0ok正常
    10000not init未初始化蓝牙适配器
    10001not available当前蓝牙适配器不可用
    10002no device没有找到指定设备
    10003connection fail连接失败
    10004no service没有找到指定服务
    10005no characteristic没有找到指定特征值
    10006no connection当前连接已断开
    10007property not support当前特征值不支持此操作
    10008system error其余所有系统上报的异常
    10009system not supportAndroid 系统特有,系统版本低于 4.3 不支持 BLE

    示例代码

    1. uni.stopBluetoothDevicesDiscovery({
    2. success(res) {
    3. console.log(res)
    4. }
    5. })

    uni.onBluetoothAdapterStateChange(CALLBACK)

    监听蓝牙适配器状态变化事件

    CALLBACK 返回参数

    属性类型说明
    availableboolean蓝牙适配器是否可用
    discoveringboolean蓝牙适配器是否处于搜索状态

    示例代码

    1. uni.onBluetoothAdapterStateChange(function (res) {
    2. console.log('adapterState changed, now is', res)
    3. })

    uni.getConnectedBluetoothDevices(OBJECT)

    根据 uuid 获取处于已连接状态的设备。

    OBJECT 参数说明

    属性类型默认值必填说明
    servicesArray<String>蓝牙设备主 service 的 uuid 列表
    successfunction接口调用成功的回调函数
    failfunction接口调用失败的回调函数
    completefunction接口调用结束的回调函数(调用成功、失败都会执行)

    success 返回参数说明:

    属性类型说明
    devicesArray<Object>搜索到的设备列表

    res.devices 的结构

    属性类型说明
    namestring蓝牙设备名称,某些设备可能没有
    deviceIdstring用于区分设备的 id

    错误

    错误码错误信息说明
    0ok正常
    10000not init未初始化蓝牙适配器
    10001not available当前蓝牙适配器不可用
    10002no device没有找到指定设备
    10003connection fail连接失败
    10004no service没有找到指定服务
    10005no characteristic没有找到指定特征值
    10006no connection当前连接已断开
    10007property not support当前特征值不支持此操作
    10008system error其余所有系统上报的异常
    10009system not supportAndroid 系统特有,系统版本低于 4.3 不支持 BLE

    示例代码

    1. uni.getConnectedBluetoothDevices({
    2. success(res) {
    3. console.log(res)
    4. }
    5. })

    uni.getBluetoothDevices(OBJECT)

    获取在蓝牙模块生效期间所有已发现的蓝牙设备。包括已经和本机处于连接状态的设备。

    OBJECT 参数说明

    属性类型默认值必填说明
    successfunction接口调用成功的回调函数
    failfunction接口调用失败的回调函数
    completefunction接口调用结束的回调函数(调用成功、失败都会执行)

    success 返回参数说明:

    属性类型说明
    devicesArray<Object>uuid 对应的的已连接设备列表

    res.devices 的结构

    属性类型说明
    namestring蓝牙设备名称,某些设备可能没有
    deviceIdstring用于区分设备的 id
    RSSInumber当前蓝牙设备的信号强度
    advertisDataArrayBuffer当前蓝牙设备的广播数据段中的 ManufacturerData 数据段。
    advertisServiceUUIDsArray<String>当前蓝牙设备的广播数据段中的 ServiceUUIDs 数据段
    localNamestring当前蓝牙设备的广播数据段中的 LocalName 数据段
    serviceDataObject当前蓝牙设备的广播数据段中的 ServiceData 数据段

    错误

    错误码错误信息说明
    0ok正常
    10000not init未初始化蓝牙适配器
    10001not available当前蓝牙适配器不可用
    10002no device没有找到指定设备
    10003connection fail连接失败
    10004no service没有找到指定服务
    10005no characteristic没有找到指定特征值
    10006no connection当前连接已断开
    10007property not support当前特征值不支持此操作
    10008system error其余所有系统上报的异常
    10009system not supportAndroid 系统特有,系统版本低于 4.3 不支持 BLE

    示例代码

    1. // ArrayBuffer转16进度字符串示例
    2. function ab2hex(buffer) {
    3. const hexArr = Array.prototype.map.call(
    4. new Uint8Array(buffer),
    5. function (bit) {
    6. return ('00' + bit.toString(16)).slice(-2)
    7. }
    8. )
    9. return hexArr.join('')
    10. }
    11. uni.getBluetoothDevices({
    12. success(res) {
    13. console.log(res)
    14. if (res.devices[0]) {
    15. console.log(ab2hex(res.devices[0].advertisData))
    16. }
    17. }
    18. })

    注意

    • 该接口获取到的设备列表为蓝牙模块生效期间所有搜索到的蓝牙设备,若在蓝牙模块使用流程结束后未及时调用 uni.closeBluetoothAdapter 释放资源,会存在调用该接口会返回之前的蓝牙使用流程中搜索到的蓝牙设备,可能设备已经不在用户身边,无法连接。
    • 蓝牙设备在被搜索到时,系统返回的 name 字段一般为广播包中的 LocalName 字段中的设备名称,而如果与蓝牙设备建立连接,系统返回的 name 字段会改为从蓝牙设备上获取到的 GattName。若需要动态改变设备名称并展示,建议使用 localName 字段。

    uni.getBluetoothAdapterState(OBJECT)

    获取本机蓝牙适配器状态。

    OBJECT 参数说明

    属性类型默认值必填说明
    successfunction接口调用成功的回调函数
    failfunction接口调用失败的回调函数
    completefunction接口调用结束的回调函数(调用成功、失败都会执行)

    success 返回参数说明:

    属性类型说明
    discoveringboolean是否正在搜索设备
    availableboolean蓝牙适配器是否可用

    错误

    错误码错误信息说明
    0ok正常
    10000not init未初始化蓝牙适配器
    10001not available当前蓝牙适配器不可用
    10002no device没有找到指定设备
    10003connection fail连接失败
    10004no service没有找到指定服务
    10005no characteristic没有找到指定特征值
    10006no connection当前连接已断开
    10007property not support当前特征值不支持此操作
    10008system error其余所有系统上报的异常
    10009system not supportAndroid 系统特有,系统版本低于 4.3 不支持 BLE

    示例代码

    1. uni.getBluetoothAdapterState({
    2. success(res) {
    3. console.log(res)
    4. }
    5. })

    uni.closeBluetoothAdapter(OBJECT)

    关闭蓝牙模块。调用该方法将断开所有已建立的连接并释放系统资源。建议在使用蓝牙流程后,与 uni.openBluetoothAdapter 成对调用。

    OBJECT 参数说明

    属性类型默认值必填说明
    successfunction接口调用成功的回调函数
    failfunction接口调用失败的回调函数
    completefunction接口调用结束的回调函数(调用成功、失败都会执行)

    错误

    错误码错误信息说明
    0ok正常
    10000not init未初始化蓝牙适配器
    10001not available当前蓝牙适配器不可用
    10002no device没有找到指定设备
    10003connection fail连接失败
    10004no service没有找到指定服务
    10005no characteristic没有找到指定特征值
    10006no connection当前连接已断开
    10007property not support当前特征值不支持此操作
    10008system error其余所有系统上报的异常
    10009system not supportAndroid 系统特有,系统版本低于 4.3 不支持 BLE

    示例代码

    1. uni.closeBluetoothAdapter({
    2. success(res) {
    3. console.log(res)
    4. }
    5. })

    发现错误?想参与编辑?在 GitHub 上编辑此页面!