本文主要是介绍小程序API能力集成指南——配网能力API汇总(二),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
ty.playnet.isSystemPopupInAutoConnectAp
在自动连接热点场景下,是否是系统控制弹窗的
需引入
PlayNetKit
,且在>=1.1.0
版本才可使用
请求参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
返回结果
- success
Boolean boolean
- fail
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
请求示例
ty.playnet.isSystemPopupInAutoConnectAp().then((res) => {console.log(res);}).catch((error) => {console.log(error);});
返回示例
true
ty.playnet.queryDeviceConfigState
蓝牙连接 / AP监听广播包后 并查询状态 然后再开始查询wifi列表
需引入
PlayNetKit
,且在>=1.1.0
版本才可使用
请求参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
homeId | number/string | 是 | homeid | |
pairType | string | 是 | 配网类型,后续新流程添加在这里 AP -> "AP" WIFI_BLE -> "WIFI_BLE" | |
bleWifiPairParams | ScanDevicePacket | 是 | 蓝牙扫描出来的广播包,目前只有wifi双模需要填写 | |
timeout | number | 否 | 超时时间 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ScanDevicePacket
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
uuid | string | 是 | uuid | |
flag | number | 是 | flag | |
rssi | number | 是 | rssi | |
productId | string | 是 | productId | |
isShare | boolean | 是 | isShare | |
isbind | boolean | 是 | isbind | |
deviceType | number | 是 | deviceType |
返回结果
- success
Array<Object>
- fail
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
请求示例
ty.playnet.queryDeviceConfigState({homeId: '26725023',pairType: 'WIFI_BLE',bleWifiPairParams: {"uuid": "bb768f78f8151037","flag": 0,"rssi": 0,"productId": "key8u54q9dtru5jw","isShare": false,"isbind": false,"deviceType": 0},
}).then((res) => {console.log(res);}).catch((error) => {console.log(error);});
返回示例
[{"rssi": -60,"sec": 5,"ssid": "Tuya-AutoPi-b196"
}, {"rssi": -61,"sec": 5,"ssid": "A001"
}, {"rssi": -64,"sec": 5,"ssid": "Matter_Test"
}, {"rssi": -64,"sec": 5,"ssid": "11S 11-11-11"
}, {"rssi": -65,"sec": 5,"ssid": "11F-N-01-12"
}, {"rssi": -68,"sec": 5,"ssid": "11-SF-13-06-2.4G"
}, {"rssi": -68,"sec": 5,"ssid": "phi_847A19509887"
}, {"rssi": -69,"sec": 5,"ssid": "11F-S-05-14"
}, {"rssi": -73,"sec": 5,"ssid": "Tuya-Test"
}, {"rssi": -73,"sec": 5,"ssid": "Godzilla-MiniApp"
}, {"rssi": -74,"sec": 5,"ssid": "ll"
}, {"rssi": -76,"sec": 5,"ssid": "ABCD-4G"
}, {"rssi": -83,"sec": 6,"ssid": "JC2902790010000B07250016"
}, {"rssi": -86,"sec": 0,"ssid": "GW_TEST_AP-63C5"
}, {"rssi": -88,"sec": 5,"ssid": "11J"
}, {"rssi": -88,"sec": 6,"ssid": "OS-家电_2.4G"
}, {"rssi": -90,"sec": 5,"ssid": "2g"
}]
👉 立即开发。
ty.playnet.requestPermission
请求获取这个权限 WIFI or BLE
需引入
PlayNetKit
,且在>=1.1.0
版本才可使用
请求参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
permission | string | 是 | "WIFI" or "BLE" 权限 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
返回结果
- success
无
- fail
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
请求示例
ty.playnet.requestPermission({permission: 'WIFI'
}).then(() => {}).catch((error) => {console.log(error);});
ty.playnet.resetDevice
重置设备
需引入
PlayNetKit
,且在>=1.1.0
版本才可使用
请求参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
pairType | string | 是 | 配网类型,后续新流程添加在这里 AP -> "AP" WIFI_BLE -> "WIFI_BLE", 蓝牙配网需要填uuid | |
uuid | string | 否 | uuid 根据uuid来匹配找到对应的蓝牙配网设备 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
返回结果
- success
无
- fail
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
请求示例
ty.playnet.resetDevice({pairType: 'AP'
}).then(() => {}).catch();
ty.playnet.startActivator
开始配网
需引入
PlayNetKit
,且在>=1.1.0
版本才可使用
请求参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
pairType | string | 是 | 配网类型,后续新流程添加在这里 AP -> "AP" WIFI_BLE -> "WIFI_BLE" | |
apActivatorParams | ApActivatorParam | 否 | AP 模式下AP配网参数 | |
bleWifiActivatorParams | BleWifiActivatorParam | 否 | WIFI双模 模式下配网参数 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ApActivatorParam
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
ssid | string | 是 | ssid | |
pwd | string | 是 | pwd | |
token | string | 是 | token | |
timeout | number | 是 | 配网超时时间 | |
isRecovery | boolean | 是 | 是否为密码错误恢复配网 | |
securityConfig | string | 是 | securityConfig use getDeviceSecurityConfigs() method to get |
BleWifiActivatorParam
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
uuid | string | 是 | uuid | |
ssid | string | 是 | ssid | |
pwd | string | 是 | pwd | |
token | string | 是 | token | |
timeout | number | 是 | timeout | |
isRecovery | boolean | 是 | 是否为密码错误恢复配网 | |
phase1Timeout | number | 是 | the phase 1 timeout value, in milliseconds. Default 60000 Note <p> For devices with WiFi and Bluetooth capabilities, use WiFi to activate in the first stage, if it fails, use Bluetooth to activate. |
返回结果
- success
属性 | 类型 | 说明 |
---|---|---|
devId | string | 设备id |
name | string | 设备名称 |
roomId | string | 设备房间id |
iconUrl | string | 设备图标url |
- fail
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
请求示例
ty.playnet.startActivator({pairType: 'WIFI_BLE',bleWifiActivatorParams: {uuid: 'bb768f78f8151037',ssid: '11J',pwd: '123456',timeout: 120,token: 'AYAwOJZ4GQpr_0',isRecovery: false,phase1Timeout: 120},
}).then((res) => {console.log(res);}).catch((error) => {console.log(error);});
返回示例
{devId: '6c6746d578027d7cf3p9nj',name: '球泡灯样品'roomId: '26255936',iconUrl: 'https://images.tuyacn.com/smart/solution/143006/37e69c2be34b7642_cover.png'
}
👉 立即开发。
这篇关于小程序API能力集成指南——配网能力API汇总(二)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!