小程序API能力集成指南——配网能力API汇总(二)

2024-03-08 09:04

本文主要是介绍小程序API能力集成指南——配网能力API汇总(二),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

ty.playnet.isSystemPopupInAutoConnectAp

在自动连接热点场景下,是否是系统控制弹窗的

需引入PlayNetKit,且在>=1.1.0版本才可使用

请求参数

Object object

属性类型默认值必填说明
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

返回结果

  • success

Boolean boolean

  • fail
属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {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

属性类型默认值必填说明
homeIdnumber/stringhomeid
pairTypestring配网类型,后续新流程添加在这里 AP -> "AP" WIFI_BLE -> "WIFI_BLE"
bleWifiPairParamsScanDevicePacket蓝牙扫描出来的广播包,目前只有wifi双模需要填写
timeoutnumber超时时间
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

ScanDevicePacket

属性类型默认值必填说明
uuidstringuuid
flagnumberflag
rssinumberrssi
productIdstringproductId
isSharebooleanisShare
isbindbooleanisbind
deviceTypenumberdeviceType

返回结果

  • success

Array<Object>

  • fail
属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {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

属性类型默认值必填说明
permissionstring"WIFI" or "BLE" 权限
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

返回结果

  • success

  • fail
属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

ty.playnet.requestPermission({permission: 'WIFI'
}).then(() => {}).catch((error) => {console.log(error);});

ty.playnet.resetDevice

重置设备

需引入PlayNetKit,且在>=1.1.0版本才可使用

请求参数

Object object

属性类型默认值必填说明
pairTypestring配网类型,后续新流程添加在这里 AP -> "AP" WIFI_BLE -> "WIFI_BLE", 蓝牙配网需要填uuid
uuidstringuuid 根据uuid来匹配找到对应的蓝牙配网设备
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

返回结果

  • success

  • fail
属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

ty.playnet.resetDevice({pairType: 'AP'
}).then(() => {}).catch();

ty.playnet.startActivator

开始配网

需引入PlayNetKit,且在>=1.1.0版本才可使用

请求参数

Object object

属性类型默认值必填说明
pairTypestring配网类型,后续新流程添加在这里 AP -> "AP" WIFI_BLE -> "WIFI_BLE"
apActivatorParamsApActivatorParamAP 模式下AP配网参数
bleWifiActivatorParamsBleWifiActivatorParamWIFI双模 模式下配网参数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数

ApActivatorParam

属性类型默认值必填说明
ssidstringssid
pwdstringpwd
tokenstringtoken
timeoutnumber配网超时时间
isRecoveryboolean是否为密码错误恢复配网
securityConfigstringsecurityConfig use getDeviceSecurityConfigs() method to get

BleWifiActivatorParam

属性类型默认值必填说明
uuidstringuuid
ssidstringssid
pwdstringpwd
tokenstringtoken
timeoutnumbertimeout
isRecoveryboolean是否为密码错误恢复配网
phase1Timeoutnumberthe 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
属性类型说明
devIdstring设备id
namestring设备名称
roomIdstring设备房间id
iconUrlstring设备图标url
  • fail
属性类型说明
errorMsgstring插件错误信息
errorCodestring错误码
innerErrorobject插件外部依赖错误信息 {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汇总(二)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/786612

相关文章

PostgreSQL中rank()窗口函数实用指南与示例

《PostgreSQL中rank()窗口函数实用指南与示例》在数据分析和数据库管理中,经常需要对数据进行排名操作,PostgreSQL提供了强大的窗口函数rank(),可以方便地对结果集中的行进行排名... 目录一、rank()函数简介二、基础示例:部门内员工薪资排名示例数据排名查询三、高级应用示例1. 每

SpringBoot结合Docker进行容器化处理指南

《SpringBoot结合Docker进行容器化处理指南》在当今快速发展的软件工程领域,SpringBoot和Docker已经成为现代Java开发者的必备工具,本文将深入讲解如何将一个SpringBo... 目录前言一、为什么选择 Spring Bootjavascript + docker1. 快速部署与

golang程序打包成脚本部署到Linux系统方式

《golang程序打包成脚本部署到Linux系统方式》Golang程序通过本地编译(设置GOOS为linux生成无后缀二进制文件),上传至Linux服务器后赋权执行,使用nohup命令实现后台运行,完... 目录本地编译golang程序上传Golang二进制文件到linux服务器总结本地编译Golang程序

Spring Boot集成Druid实现数据源管理与监控的详细步骤

《SpringBoot集成Druid实现数据源管理与监控的详细步骤》本文介绍如何在SpringBoot项目中集成Druid数据库连接池,包括环境搭建、Maven依赖配置、SpringBoot配置文件... 目录1. 引言1.1 环境准备1.2 Druid介绍2. 配置Druid连接池3. 查看Druid监控

创建Java keystore文件的完整指南及详细步骤

《创建Javakeystore文件的完整指南及详细步骤》本文详解Java中keystore的创建与配置,涵盖私钥管理、自签名与CA证书生成、SSL/TLS应用,强调安全存储及验证机制,确保通信加密和... 目录1. 秘密键(私钥)的理解与管理私钥的定义与重要性私钥的管理策略私钥的生成与存储2. 证书的创建与

Python包管理工具pip的升级指南

《Python包管理工具pip的升级指南》本文全面探讨Python包管理工具pip的升级策略,从基础升级方法到高级技巧,涵盖不同操作系统环境下的最佳实践,我们将深入分析pip的工作原理,介绍多种升级方... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

PowerShell中15个提升运维效率关键命令实战指南

《PowerShell中15个提升运维效率关键命令实战指南》作为网络安全专业人员的必备技能,PowerShell在系统管理、日志分析、威胁检测和自动化响应方面展现出强大能力,下面我们就来看看15个提升... 目录一、PowerShell在网络安全中的战略价值二、网络安全关键场景命令实战1. 系统安全基线核查

使用Docker构建Python Flask程序的详细教程

《使用Docker构建PythonFlask程序的详细教程》在当今的软件开发领域,容器化技术正变得越来越流行,而Docker无疑是其中的佼佼者,本文我们就来聊聊如何使用Docker构建一个简单的Py... 目录引言一、准备工作二、创建 Flask 应用程序三、创建 dockerfile四、构建 Docker

Java操作Word文档的全面指南

《Java操作Word文档的全面指南》在Java开发中,操作Word文档是常见的业务需求,广泛应用于合同生成、报表输出、通知发布、法律文书生成、病历模板填写等场景,本文将全面介绍Java操作Word文... 目录简介段落页头与页脚页码表格图片批注文本框目录图表简介Word编程最重要的类是org.apach

Knife4j+Axios+Redis前后端分离架构下的 API 管理与会话方案(最新推荐)

《Knife4j+Axios+Redis前后端分离架构下的API管理与会话方案(最新推荐)》本文主要介绍了Swagger与Knife4j的配置要点、前后端对接方法以及分布式Session实现原理,... 目录一、Swagger 与 Knife4j 的深度理解及配置要点Knife4j 配置关键要点1.Spri