低功耗蓝牙

优质
小牛编辑
136浏览
2023-12-01

jd.readBLECharacteristicValue(Object object)

读取低功耗蓝牙设备的特征值的二进制数据值。注意:必须设备的特征值支持 read 才可以成功调用。

参数名类型默认值必填说明
deviceIdstring蓝牙设备 id
serviceIdstring蓝牙特征值对应服务的 uuid
characteristicIdstring蓝牙特征值的 uuid
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
10010already connect当前设备已连接
10011need pin配对设备需要Pin码
10012operate time out连接超时
10013invalid_data连接 deviceId 为空或者是格式不正确

注意

  • 接口读取到的信息需要在 onBLECharacteristicValueChange 方法注册的回调中获取。

jd.onBLEConnectionStateChange(function callback)

监听低功耗蓝牙连接状态的改变事件。包括开发者主动连接或断开连接,设备丢失,连接异常断开等等

参数

function callback

低功耗蓝牙连接状态的改变事件的回调函数

参数

Object res

属性类型说明
deviceIdstring蓝牙设备ID
connectedboolean是否处于已连接状态

jd.onBLECharacteristicValueChange(function callback)

监听低功耗蓝牙设备的特征值变化事件。必须先启用 notifyBLECharacteristicValueChange 接口才能接收到设备推送的 notification。

参数

function callback

低功耗蓝牙设备的特征值变化事件的回调函数

参数

Object res

属性类型说明
deviceIdstring蓝牙设备 id
serviceIdstring蓝牙特征值对应服务的 uuid
characteristicIdstring蓝牙特征值的 uuid
valueArrayBuffer特征值最新的值

jd.notifyBLECharacteristicValueChange(Object object)

启用低功耗蓝牙设备特征值变化时的 notify 功能,订阅特征值。 注意:必须设备的特征值支持 notify 或者 indicate 才可以成功调用。 另外,必须先启用 notifyBLECharacteristicValueChange 才能监听到设备 characteristicValueChange 事件

参数名类型默认值必填说明
deviceIdstring蓝牙设备 id
serviceIdstring蓝牙特征值对应服务的 uuid
characteristicIdstring蓝牙特征值的 uuid
stateboolean是否启用 notify
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

错误

错误码错误信息说明
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
10010already connect当前设备已连接
10011need pin配对设备需要Pin码
10012operate time out连接超时
10013invalid_data连接 deviceId 为空或者是格式不正确

注意

  • 订阅操作成功后需要设备主动更新特征值的 value,才会触发 jd.onBLECharacteristicValueChange 回调

jd.getBLEDeviceServices(Object object)

获取蓝牙设备所有服务(service)。

参数

Object object

参数名类型默认值必填说明
deviceIdstring蓝牙设备 id
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

success参数说明

属性类型说明
servicesArray.<Object>设备服务列表
services结构说明
属性类型说明
uuidstring蓝牙设备服务的 uuid
isPrimaryboolean该服务是否为主服务

错误

错误码错误信息说明
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
10010already connect当前设备已连接
10011need pin配对设备需要Pin码
10012operate time out连接超时
10013invalid_data连接 deviceId 为空或者是格式不正确

jd.getBLEDeviceCharacteristics(Object object)

获取蓝牙设备某个服务中所有特征值(characteristic)。

参数

Object object

参数名类型默认值必填说明
deviceIdstring蓝牙设备 id
serviceIdstring蓝牙服务 uuid,需要使用 getBLEDeviceServices 获取
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

success参数说明

属性类型说明
characteristicsArray.<Object>设备服务列表
characteristics结构说明
属性类型说明
uuidstring蓝牙设备特征值的 uuid
propertiesObject该特征值支持的操作类型
properties结构说明
属性类型说明
readboolean该特征值是否支持 read 操作
writeboolean该特征值是否支持 write 操作
notifyboolean该特征值是否支持 notify 操作
indicateboolean该特征值是否支持 indicate 操作

错误

错误码错误信息说明
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
10010already connect当前设备已连接
10011need pin配对设备需要Pin码
10012operate time out连接超时
10013invalid_data连接 deviceId 为空或者是格式不正确

jd.createBLEConnection(Object object)

连接低功耗蓝牙设备。 若小程序在之前已有搜索过某个蓝牙设备,并成功建立连接,可直接传入之前搜索获取的 deviceId 直接尝试连接该设备,无需进行搜索操作。

参数

Object object

参数名类型默认值必填说明
deviceIdstring用于区分设备的id
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
10010already connect当前设备已连接
10011need pin配对设备需要Pin码
10012operate time out连接超时
10013invalid_data连接 deviceId 为空或者是格式不正确

注意

  • 请保证尽量成对的调用 createBLEConnectioncloseBLEConnection 接口。安卓如果多次调用 createBLEConnection 创建连接,有可能导致系统持有同一设备多个连接的实例,导致调用 closeBLEConnection 的时候并不能真正的断开与设备的连接。
  • 蓝牙连接随时可能断开,建议监听 jd.onBLEConnectionStateChange 回调事件,当蓝牙设备断开时按需执行重连操作
  • 若对未连接的设备或已断开连接的设备调用数据读写操作的接口,会返回 10006 错误,建议进行重连操作。

jd.closeBLEConnection(Object object)

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

参数

Object object

参数名类型默认值必填说明
deviceIdstring用于区分设备的id
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
10010already connect当前设备已连接
10011need pin配对设备需要Pin码
10012operate time out连接超时
10013invalid_data连接 deviceId 为空或者是格式不正确

jd.writeBLECharacteristicValue(Object object)

向低功耗蓝牙设备特征值中写入二进制数据。注意:必须设备的特征值支持 write 才可以成功调用。

参数

Object object

参数名类型默认值必填说明
deviceIdstring蓝牙设备 id
serviceIdstring蓝牙特征值对应服务的 uuid
characteristicIdstring蓝牙特征值的 uuid
valueArrayBuffer蓝牙设备特征值对应的二进制值
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
10010already connect当前设备已连接
10011need pin配对设备需要Pin码
10012operate time out连接超时
10013invalid_data连接 deviceId 为空或者是格式不正确

注意

  • 并行调用多次会存在写失败的可能性。
  • 小程序不会对写入数据包大小做限制,但系统与蓝牙设备会限制蓝牙4.0单次传输的数据大小,超过最大字节数后会发生写入错误,建议每次写入不超过20字节。
  • 若单次写入数据过长,iOS 上存在系统不会有任何回调的情况(包括错误回调)。
  • 安卓平台上,在调用 notifyBLECharacteristicValueChange 成功后立即调用 writeBLECharacteristicValue 接口,在部分机型上会发生 10008 系统错误