tt.getBLEDeviceCharacteristics
基础库 1.0.0 开始支持本方法,这是一个异步方法。
获取蓝牙设备某个服务中的所有特征值。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 | 1. 必须先成功调用tt.getBLEDeviceServices获取服务后才能使用此接口。
2. 在进行读写操作前,应先检查特征值的properties是否支持相应操作。
3. 抖音 36.1.0 版本修正了 36.0.0 版本的部分错误码双端不一致问题。 |
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt.getBLEDeviceCharacteristics(options)
参数说明
options 为 object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| deviceId | string | 是 | 蓝牙设备ID。 | 3.87.0 | |
| serviceId | string | 是 | 蓝牙服务UUID。 | 3.87.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 1.0.0 |
回调成功
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| characteristics | array | 特征值列表。 | 3.87.0 |
| errMsg | string | "getBLEDeviceCharacteristics:ok" | 3.87.0 |
| errorCode | string | 错误码信息 | 3.87.0 |
characteristics 类型说明
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| uuid | string | 特征值 UUID。 | 3.87.0 |
| properties | object | 特征值支持的操作类型。 | 3.87.0 |
properties 类型说明
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| read | boolean | 是否支持读操作。 | 3.87.0 |
| write | boolean | 是否支持写操作。 | 3.87.0 |
| notify | boolean | 是否支持通知。 | 3.87.0 |
| indicate | boolean | 是否支持indicate操作。 | 3.87.0 |
| writeNoResponse | boolean | 该特征是否支持无回复写操作。 | 3.87.0 |
| writeDefault | boolean | 该特征是否支持有回复写操作。 | 3.87.0 |
回调失败
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "getBLEDeviceCharacteristics:fail" + 详细错误信息 | 3.87.0 |
| errorCode | string | 错误码信息 | 3.87.0 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 188001 | getBLEDeviceCharacteristics:fail not init | D | 未初始化蓝牙适配器 | 3.87.0 |
| 188003 | getBLEDeviceCharacteristics:fail no device | F | 小程序框架内部错误,有需要请创建工单咨询 | 3.87.0 |
| 188005 | getBLEDeviceCharacteristics:fail no servic | D | 没有找到指定服务 | 3.87.0 |
| 188007 | getBLEDeviceCharacteristics:fail not connected | F | 小程序框架内部错误,有需要请创建工单咨询 | 3.87.0 |
| 188002 | getBLEDeviceCharacteristics:fail not available | F | 小程序框架内部错误,有需要请创建工单咨询 | 3.87.0 |
| 188099 | getBLEDeviceCharacteristics:fail invalid_data | U | 设备ID或服 务ID为空或者是格式不正确 | 3.87.0 |
代码示例
tt.getBLEDeviceCharacteristics({ // 这里的 deviceId 需要已经通过 tt.createBLEConnection 与对应设备建立链接 deviceId, // 这里的 serviceId 需要在 tt.getBLEDeviceServices 接口中获取 serviceId, success(res) { console.log('device getBLEDeviceCharacteristics:', res.characteristics) } })
