tencent cloud

文档反馈

蓝牙-低功耗外围设备

最后更新时间:2024-03-04 23:07:33

    onBLEPeripheralConnectionStateChanged

    该 API 使用方法为 wx.onBLEPeripheralConnectionStateChanged(function listener)。
    功能说明:监听当前外围设备被连接或断开连接事件。
    参数及说明:Object res 参数,function listener,当前外围设备被连接或断开连接事件的监听函数。
    属性
    类型
    说明
    deviceId
    String
    连接状态变化的设备 id
    serverId
    String
    server 的 UUID
    connected
    Boolean
    连接目前状态

    offBLEPeripheralConnectionStateChanged

    该 API 使用方法为 wx.offBLEPeripheralConnectionStateChanged(function listener)
    功能说明:移除当前外围设备被连接或断开连接事件的监听函数。
    参数及说明:function listener,onBLEPeripheralConnectionStateChanged 传入的监听函数。不传此参数则移除所有监听函数。
    示例代码
    const listener = function (res) { console.log(res) }
    
    wx.onBLEPeripheralConnectionStateChanged(listener)
    wx.offBLEPeripheralConnectionStateChanged(listener) // 需传入与监听时同一个的函数对象

    createBLEPeripheralServer

    该 API 使用方法为 wx.createBLEPeripheralServer(Object object)
    功能说明:建立本地作为蓝牙低功耗外围设备的服务端,可创建多个。
    参数及说明:Object object。
    属性
    类型
    默认值
    必填
    说明
    success
    function
    -
    接口调用成功的回调函数
    fail
    function
    -
    接口调用失败的回调函数
    complete
    function
    -
    接口调用结束的回调函数(调用成功、失败都会执行)
    object.success 回调函数参数:Object res。
    属性
    类型
    说明
    server
    BLEPeripheralServer
    外围设备的服务端

    BLEPeripheralServer

    说明:
    外围设备的服务端。

    .addService

    该 方法 使用方式为 BLEPeripheralServer.addService(Object object)
    功能说明:添加服务。
    参数及说明:Object object。
    属性
    类型
    必填
    说明
    service
    Object
    描述service的Object
    success
    function
    接口调用成功的回调函数
    fail
    function
    接口调用失败的回调函数
    complete
    function
    接口调用结束的回调函数(调用成功、失败都会执行)
    service 结构属性
    结构属性
    类型
    必填
    说明
    uuid
    string
    蓝牙服务的 UUID
    characteristics
    Array.<Object>
    characteristics 列表
    characteristics 结构属性
    结构属性
    类型
    必填
    说明
    uuid
    string
    characteristic 的 UUID
    properties
    Object
    特征支持的操作
    permission
    Object
    特征权限
    value
    Array.<Object>
    特征对应的二进制值
    descriptors
    Array.<Object>
    描述符数据
    properties 结构属性
    结构属性
    类型
    默认值
    必填
    说明
    write
    boolean
    false
    writeNoResponse
    boolean
    false
    无回复写
    read
    boolean
    false
    notify
    boolean
    false
    订阅
    indicate
    boolean
    false
    回包
    permission 结构属性
    结构属性
    类型
    默认值
    必填
    说明
    readable
    boolean
    false
    可读
    writeable
    boolean
    false
    可写
    readEncryptionRequired
    boolean
    false
    加密读请求
    writeEncryptionRequired
    boolean
    false
    加密写请求
    descriptors 结构属性
    结构属性
    类型
    必填
    说明
    uuid
    string
    Descriptors 的 UUID
    permission
    Object
    描述符的权限
    value
    ArrayBuffer
    描述符数据
    permission 结构属性
    结构属性
    类型
    默认值
    必填
    说明
    write
    boolean
    false
    read
    boolean
    false

    .removeService

    该 方法 使用方式为 BLEPeripheralServer.removeService(Object object)
    功能说明:移除服务。
    参数及说明:Object object。
    属性
    类型
    默认值
    必填
    说明
    serviceId
    String
    -
    service 的 UUID
    success
    function
    -
    接口调用成功的回调函数
    fail
    function
    -
    接口调用失败的回调函数
    complete
    function
    -
    接口调用结束的回调函数(调用成功、失败都会执行)

    .startAdvertising

    该 方法 使用方式为 BLEPeripheralServer.startAdvertising(Object Object)
    功能说明:开始广播本地创建的外围设备。
    参数及说明:Object Object。
    属性
    类型
    默认值
    必填
    说明
    advertiseRequest
    object
    -
    广播自定义参数
    powerLevel
    string
    medium
    广播功率,合法值为
    low:功率低
    medium:功率适中
    high:功率高
    success
    function
    -
    接口调用成功的回调函数
    fail
    function
    -
    接口调用失败的回调函数
    complete
    function
    -
    接口调用结束的回调函数(调用成功、失败都会执行)
    advertiseRequest 结构属性
    结构属性
    类型
    默认值
    必填
    说明
    connectable
    boolean
    ture
    当前设备是否可连接
    deviceName
    string
    -
    广播中 deviceName 字段,默认为空
    serviceUuids
    Array.<string>
    -
    要广播的服务 UUID 列表。使用 16/32 位 UUID 时请参考注意事项
    manufactureData
    Array.<Object>
    -
    广播的制造商信息。仅 Android 支持,iOS 因系统限制无法定制
    beacon
    object
    -
    以 beacon 设备形式广播的参数
    manufactureData 结构属性
    结构属性
    类型
    必填
    说明
    manufacturerId
    String
    制造商ID,0x 开头的十六进制
    manufacturerSpecificData
    ArrayBuffer
    制造商信息
    beacon 结构属性
    结构属性
    类型
    必填
    说明
    uuid
    number
    Beacon 设备广播的 UUID
    major
    number
    Beacon 设备的主 ID
    minor
    number
    Beacon 设备的次 ID
    measurePower
    number
    用于判断距离设备 1 米时 RSSI 大小的参考值

    .stopAdvertising

    该 方法 使用方式为 BLEPeripheralServer.stopAdvertising()
    功能说明:停止广播。
    参数及说明:Object object。
    属性
    类型
    默认值
    必填
    说明
    success
    function
    -
    接口调用成功的回调函数
    fail
    function
    -
    接口调用失败的回调函数
    complete
    function
    -
    接口调用结束的回调函数(调用成功、失败都会执行)

    .writeCharacteristicValue

    该 方法 使用方式为 BLEPeripheralServer.writeCharacteristicValue(Object Object)
    功能说明:往指定特征写入二进制数据值,并通知已连接的主机。从机的特征值已发生变化,该接口会处理是走回包还是走订阅。
    参数及说明:Object Object。
    属性
    类型
    默认值
    必填
    说明
    serviceId
    string
    -
    蓝牙特征对应服务的 UUID
    characteristicId
    string
    -
    蓝牙特征的 UUID
    value
    ArrayBuffer
    -
    characteristic 对应的二进制值
    needNotify
    boolean
    -
    是否需要通知主机 value 已更新
    callbackId
    number
    -
    可选,处理回包时使用
    success
    function
    -
    接口调用成功的回调函数
    fail
    function
    -
    接口调用失败的回调函数
    complete
    function
    -
    接口调用结束的回调函数(调用成功、失败都会执行)

    .onCharacteristicWriteRequest

    该 方法 使用方式为 BLEPeripheralServer.onCharacteristicWriteRequest(function listener)
    功能说明:监听已连接的设备请求写当前外围设备的特征值事件。收到该消息后需要立刻调用 writeCharacteristicValue 写回数据,否则主机不会收到响应。
    参数及说明:Object res。
    属性
    类型
    说明
    serviceId
    String
    蓝牙特征对应服务的 UUID
    characteristicId
    String
    蓝牙特征的 UUID
    callbackId
    Number
    唯一标识码,调用 writeCharacteristicValue 时使用
    value
    ArrayBuffer
    请求写入特征的二进制数据值

    .offCharacteristicWriteRequest

    该 方法 使用方式为 BLEPeripheralServer.offCharacteristicWriteRequest(function listener)
    功能说明:移除已连接的设备请求写当前外围设备的特征值事件的监听函数,使用方法为 。
    参数及说明:function listener,onCharacteristicWriteRequest 传入的监听函数。不传此参数则移除所有监听函数。

    .onCharacteristicReadRequest

    该 方法 使用方式为 BLEPeripheralServer.onCharacteristicReadRequest(function listener)
    功能说明:监听已连接的设备请求读当前外围设备的特征值事件。收到该消息后需要立刻调用 writeCharacteristicValue 写回数据,否则主机不会收到响应。
    参数及说明:Object res。
    属性
    类型
    说明
    serviceId
    String
    蓝牙特征对应服务的 UUID
    characteristicId
    String
    蓝牙特征的 UUID
    callbackId
    Number
    唯一标识码,调用 writeCharacteristicValue 时使用

    .offCharacteristicReadRequest

    该 方法 使用方式为 BLEPeripheralServer.offCharacteristicReadRequest(function listener)
    功能说明:移除已连接的设备请求读当前外围设备的特征值事件的监听函数。
    参数及说明:function listener,onCharacteristicReadRequest 传入的监听函数。不传此参数则移除所有监听函数。
    示例代码
    const listener = function (res) { console.log(res) }
    
    BLEPeripheralServer.onCharacteristicReadRequest(listener)
    BLEPeripheralServer.offCharacteristicReadRequest(listener) // 需传入与监听时同一个的函数对象

    .onCharacteristicSubscribed

    该 方法 使用方式为 BLEPeripheralServer.onCharacteristicSubscribed(function listener)
    功能说明:监听特征订阅事件,仅 iOS 支持。
    参数及说明:Object res 参数,function listener,特征订阅事件的监听函数。
    属性
    类型
    说明
    serviceId
    String
    蓝牙特征对应服务的 UUID
    characteristicId
    String
    蓝牙特征的 UUID

    .offCharacteristicSubscribed

    该 方法 使用方式为 BLEPeripheralServer.offCharacteristicSubscribed(function listener)
    功能说明:移除特征订阅事件的监听函数。
    参数及说明:function listener,onCharacteristicSubscribed 传入的监听函数。不传此参数则移除所有监听函数。
    示例代码
    const listener = function (res) { console.log(res) }
    
    BLEPeripheralServer.onCharacteristicSubscribed(listener)
    BLEPeripheralServer.offCharacteristicSubscribed(listener) // 需传入与监听时同一个的函数对象

    .onCharacteristicUnsubscribed

    该 方法 使用方式为 BLEPeripheralServer.onCharacteristicUnsubscribed(function listener)
    功能说明:监听取消特征订阅事件,仅 iOS 支持。
    参数及说明:Object res 参数,function listener,取消特征订阅事件的监听函数。
    属性
    类型
    说明
    serviceId
    String
    蓝牙特征对应服务的 UUID
    characteristicId
    String
    蓝牙特征的 UUID

    .offCharacteristicUnsubscribed

    该 方法 使用方式为 BLEPeripheralServer.offCharacteristicUnsubscribed(function listener)
    功能说明:移除取消特征订阅事件的监听函数。
    参数及说明:function listener,onCharacteristicUnsubscribed 传入的监听函数。不传此参数则移除所有监听函数。
    示例代码
    const listener = function (res) { console.log(res) }
    
    BLEPeripheralServer.onCharacteristicUnsubscribed(listener)
    BLEPeripheralServer.offCharacteristicUnsubscribed(listener) // 需传入与监听时同一个的函数对象
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持