【小程序开发】蓝牙设备API——单点蓝牙应用程序编程接口整理（三）

ty.device.postBLEBigDataChannelWithProgress

大数据通道操作，支持进度反馈

需引入DeviceKit，且在>=3.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	deviceId 设备 id
requestParams	any		是	建立数据传输所需相关参数 command：通道操作的具体指令；start/stop：开启/关闭大数据通道；type：要上传的数据类型 requestParams 通道指令集 { "command": "start", "type": "1" }
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
deviceId	string	deviceId 设备 id
resultParams	any	数据传输完毕相关参数（type dps fileUrl） resultParams 数据传输完毕相关参数

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

ty.device.postBLEFileTransfer

传输文件到蓝牙设备

需引入DeviceKit，且在>=3.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 设备 id
fileId	number		是	文件 id
fileIdentifier	string		是	文件标识符
fileVersion	number		是	文件版本
filePath	string		是	文件地址
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
result	boolean	true/false 传输成功/传输失败

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

ty.device.publishBLETransparentData

BLE(thing)下发透传数据

需引入DeviceKit，且在>=3.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	蓝牙透传数据 deviceId: 设备 id
data	string		是	data: 透传内容
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

 👉 立即开发。 

ty.device.startBLEScan

iOS 单端插件方法。调用 connectBLEDevice 连接蓝牙设备前需要先调用该方法开启扫描。

开启扫描

需引入DeviceKit，且在>=2.1.6版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

ty.device.startBLEScanBindDevice

在指定时间内扫描已配网设备

需引入DeviceKit，且在>=2.1.6版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
interval	number		是	间隔扫描时间。如果<0，则返回错误
scanType	string		是	扫描类型 SINGLE -> "SINGLE" SINGLE_QR -> "SINGLE_QR" MESH -> "MESH" SIG_MESH -> "SIG_MESH" NORMAL -> "NORMAL" Thing_BEACON -> "Thing_BEACON"
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

ty.device.startBLEScanSync

iOS 单端插件方法。调用 connectBLEDevice 连接蓝牙设备前需要先调用该方法开启扫描。

开启扫描同步方法

需引入DeviceKit，且在>=2.1.6版本才可使用

startBLEScan 的同步版本

ty.device.stopBLEScan

iOS 单端插件方法。不需要连接设备时调用该方法关闭扫描。

关闭扫描

需引入DeviceKit，且在>=2.1.6版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

ty.device.stopBLEScanSync

iOS 单端插件方法。不需要连接设备时调用该方法关闭扫描。

关闭扫描同步方法

需引入DeviceKit，且在>=2.1.6版本才可使用

stopBLEScan 的同步版本

ty.device.subscribeBLEConnectStatus

开始监听 BLE(thing)连接状态

需引入DeviceKit，且在>=3.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

ty.device.subscribeBLETransparentDataReport

开始监听 BLE(thing)设备数据透传通道上报

需引入DeviceKit，且在>=3.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

ty.device.unsubscribeBLEConnectStatus

停止监听 BLE(thing)连接状态

需引入DeviceKit，且在>=3.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

ty.device.unsubscribeBLETransparentDataReport

停止监听 BLE(thing)设备数据透传通道上报

需引入DeviceKit，且在>=3.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

ty.device.offFileTransferProgress

取消监听：传输文件的到蓝牙设备的进度事件

需引入DeviceKit，且在>=2.4.0版本才可使用

参数

function callback

取消监听：传输文件的到蓝牙设备的进度事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 设备 id
fileId	number		是	文件 id
fileIdentifier	string		是	文件标识符
fileVersion	number		是	文件版本
filePath	string		是	文件地址
progress	number		是	传输进度

ty.device.onFileTransferProgress

传输文件的到蓝牙设备的进度事件

需引入DeviceKit，且在>=2.4.0版本才可使用

参数

function callback

传输文件的到蓝牙设备的进度事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 设备 id
fileId	number		是	文件 id
fileIdentifier	string		是	文件标识符
fileVersion	number		是	文件版本
filePath	string		是	文件地址
progress	number		是	传输进度

 👉 立即开发。