小程序开发——设备连接通信 API汇总（一）

BT配对API

ty.device.connectBTBond

打开 BT 配对窗口 (仅 Android 端实现)

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

参数

Object object

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

ty.device.disconnectBTBond

移除 BT 配对 (仅 Android 端实现)

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

参数

Object object

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

ty.device.getBTDeviceInfo

获取设备 BT 信息

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

参数

Object object

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

object.success 回调参数

参数

Object res

属性	类型	说明
deviceName	string	设备名称
isConnected	boolean	是否连接
isBond	boolean	是否配对
mac	string	mac

object.fail 回调参数

参数

Object res

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

 👉 立即开发。 

连云激活API

ty.device.getDeviceWifiActivatorStatus

连云激活-WiFi 的激活状态

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

参数

Object object

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

object.success 回调参数

参数

Object res

属性	类型	说明
wifiActivator	boolean	设备是否 WiFi 激活

object.fail 回调参数

参数

Object res

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

ty.device.startDeviceWifiActivator

连云激活-进行 wifi 激活

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

参数

Object object

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

object.success 回调参数

参数

Object res

属性	类型	说明
wifiActivator	boolean	设备是否 WiFi 激活

object.fail 回调参数

参数

Object res

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

免配网API 

ty.device.startDirectlyConnectedDeviceActivator

免配网-开始设备激活

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

参数

Object object

属性	类型	默认值	必填	说明
device	Device		是	设备 Id device Device 设备模型
timeout	number		是	timeout 超时时间设定（秒），建议值 120
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

Device

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id

ty.device.startDirectlyConnectedSearchDevice

免配网-开始设备扫描

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

参数

Object object

属性	类型	默认值	必填	说明
device	Device		是	设备 Id device Device 设备模型
timeout	number		是	timeout 超时时间设定（秒），建议值 120
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

Device

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id

ty.device.stopDirectlyConnectedDeviceActivator

免配网-停止设备激活

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

参数

Object object

属性	类型	默认值	必填	说明
device	Device		是	设备 Id device Device 设备模型
timeout	number		是	timeout 超时时间设定（秒），建议值 120
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

Device

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id

ty.device.stopDirectlyConnectedSearchDevice

免配网-结束设备扫描

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

参数

Object object

属性	类型	默认值	必填	说明
device	Device		是	设备 Id device Device 设备模型
timeout	number		是	timeout 超时时间设定（秒），建议值 120
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

Device

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id

ty.device.onDirectlyConnectedSearchDeviceEvent

免配网-设备扫描结果事件

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

参数

function callback

免配网-设备扫描结果事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
isActive	boolean		是	设备是否激活 isActive 激活结果

ty.device.offDirectlyConnectedSearchDeviceEvent

取消监听：免配网-设备扫描结果事件

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

参数

function callback

取消监听：免配网-设备扫描结果事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
isActive	boolean		是	设备是否激活 isActive 激活结果

👉 立即开发。