Skip to content

wifi配网

说明:主要对 wifi 配网进行一些基础操作,例如搜索 wifi、连接 wifi、获取配网信息等。

注意事项

  • 配网时确保锁板亮屏
  • 确保连接的 wifi 是 2.4GHz 的 wifi

搜索wifi

搜索大约4秒返回结果

  • 调用方法
javascript
// 1. 选择锁
await plugin.selectLock(params)

// 2. 启动搜索wifi
await plugin.startSearchWiFi(params)
  • 参数说明
名称类型是否必需示例描述
connectedBooleanNfalse是否已经连接,默认 false
disconnectBooleanNfalse应答成功后是否自动断开连接,默认 false
  • 返回

通过事件监听搜索结果的返回值:

javascript
// wifi搜索结果事件回调
plugin.starEventOn('searchWiFiResult', async (data) => {
  // TODO
})

// 移除监听器
plugin.starEventOff('searchWiFiResult')

事件返回的数据结构请参考 监听相关事件 中的 searchWiFiResult 事件说明。

连接wifi

  • 调用方法
javascript
// 1. 选择锁
await plugin.selectLock(params)

// 2. 连接wifi
const params = {
  ssid: 'wifi昵称',
  password: 'wifi密码',
  clientId: '', // 创建应用时提供
  starLockPeerId: '', // 创建应用时提供
}
const result = await plugin.connectWiFi(params)
  • 参数说明
名称类型是否必需示例描述
ssidStringY"TLINKTECH02"wifi昵称
passwordStringY"ABCD2345678"wifi密码
clientIdStringY"your-client-id"创建应用时提供
starLockPeerIdStringY"your-peer-id"创建应用时提供
  • 返回

返回结果遵循 Result 方法的统一返回结构,成功时 data 为 null,message 为 "配网成功"。

获取配网信息

  • 调用方法
javascript
// 1. 选择锁
await plugin.selectLock(params)

// 2. 获取配网信息
const params = {
  uid: -1,
  deviceMac: '锁mac地址',
}
const result = await plugin.getLockNetworkInfo(params)
  • 参数说明
名称类型是否必需示例描述
uidStringY"123"用户id
deviceMacStringY"C2:4D:68:B7:2F:ED"锁mac地址
  • 返回

返回结果遵循 Result 方法的统一返回结构,data 中包含:

名称类型描述
wifiNameStringwifi名称
networkMacString网络MAC地址
secretKeyString密钥
peerIdString用于对讲

物联网设备通信协议文档