tt.writeBLECharacteristicValue
基础库 1.0.0 开始支持本方法,这是一个异步方法。
向低功耗蓝牙设备的特定特征值中写入二进制数据。使用此接口的前提是,目标设备的特征值必须支持写入操作。
| 前提条件 | 无 |
| 业务背景 | 无 |
| 使用限制 | 无 |
| 注意事项 | 1. 在调用此接口之前,必须先成功调用tt.createBLEConnection与设备建立连接。
2. 请确保目标特征值支持write(写入)操作。
3. 写入的数据value必须是ArrayBuffer类型。
4. 部分蓝牙设备对单次写入的数据长度有限制,建议将数据长度控制在20字节以内。
5. 抖音 36.1.0 版本修正了 36.0.0 版本的部分错误码双端不一致问题。 |
| 支持沙盒 | 否 |
| 相关教程 | 无 |
语法
tt.writeBLECharacteristicValue(options)
参数说明
options 为 object 类型,属性如下:
| 属性名 | 类型 | 默认值 | 必填 | 说明 | 最低支持版本 |
|---|---|---|---|---|---|
| deviceId | string | 是 | 蓝牙设备 ID。 | 3.87.0 | |
| serviceId | string | 是 | 蓝牙特征值所属服务的 UUID。 | 3.87.0 | |
| characteristicId | string | 是 | 蓝牙特征值的 UUID。 | 3.87.0 | |
| value | arrayBuffer | 是 | 需要写入的二进制数据值。 | 3.87.0 | |
| writeType | enum | 否 | 蓝牙特征值的写模式设置,有两种模式,iOS 优先 write,安卓优先 writeNoResponse 。 | 3.87.0 | |
| success | function | 否 | 接口调用成功的回调函数 | 1.0.0 | |
| fail | function | 否 | 接口调用失败的回调函数 | 1.0.0 | |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | 1.0.0 |
writeType 的合法值
| 值 | 说明 | 最低支持版本 |
|---|---|---|
| write | write 模式 | 3.87.0 |
| writeNoResponse | writeNoResponse 模式 | 3.87.0 |
回调成功
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "writeBLECharacteristicValue:ok" | 3.87.0 |
| errorCode | string | 错误码信息 | 3.87.0 |
回调失败
object 类型,属性如下:
| 属性名 | 类型 | 说明 | 最低支持版本 |
|---|---|---|---|
| errMsg | string | "writeBLECharacteristicValue:fail" + 详细错误信息 | 3.87.0 |
| errorCode | string | 错误码信息 | 3.87.0 |
错误码
| errorCode | errMsg | errorType | 说明 | 最低支持版本 |
|---|---|---|---|---|
| 188101 | writeBLECharacteristicValue:fail not init | D | 未初始化蓝牙适配器 | 3.87.0 |
| 188103 | writeBLECharacteristicValue:fail no device | F | 小程序框架内部错误,有需要请创建工单咨询 | 3.87.0 |
| 188105 | writeBLECharacteristicValue:fail no service found | D | 没有找到指定服务 | 3.87.0 |
| 188106 | writeBLECharacteristicValue:fail no characteristic found | D | 没有找到指定特征 | 3.87.0 |
| 188107 | writeBLECharacteristicValue:fail not connection | F | 小程序框架内部错误,有需要请创建工单咨询 | 3.87.0 |
| 188108 | writeBLECharacteristicValue:fail property not support | D | 当前特征不支持此操作 | 3.87.0 |
| 188109 | writeBLECharacteristicValue:fail system error | F | 小程序框架内部错误,有需要请创建工单咨询 | 3.87.0 |
| 188199 | writeBLECharacteristicValue:fail invalid_data | U | 连接deviceId为空或者是格式不正确 | 3.87.0 |
| 188102 | writeBLECharacteristicValue:fail not available | F | 小程序框架内部错误,有需要请创建工单咨询 | 3.87.0 |
代码示例
let buffer = new ArrayBuffer(1) let dataView = new DataView(buffer) dataView.setUint8(0, 0) tt.writeBLECharacteristicValue({ // 这里的 deviceId 需要在 getBluetoothDevices 或 onBluetoothDeviceFound 接口中获取 deviceId, // 这里的 serviceId 需要在 getBLEDeviceServices 接口中获取 serviceId, // 这里的 characteristicId 需要在 getBLEDeviceCharacteristics 接口中获取 characteristicId, // 这里的value是ArrayBuffer类型 value: buffer, success(res) { console.log('writeBLECharacteristicValue success', res.errMsg) } })
