第三方应用开发 客户端API JS-SDK 设备 Wi-Fi
Wi-Fi

目录

  • 注意事项
  • 初始化 Wi-Fi 模块
  • 关闭 Wi-Fi 模块
  • 连接 Wi-Fi
  • 请求获取 Wi-Fi 列表
  • 监听获取到 Wi-Fi 列表事件
  • 监听连接上 Wi-Fi 的事件
  • 获取已连接中的 Wi-Fi 信息
  • Wi-Fi接口错误码列表
  • 注意事项

    在小程序中支持搜索周边的 Wi-Fi,同时可以针对指定 Wi-Fi,传入密码发起连接。
    该系列接口为系统原生能力。

    连接指定 Wi-Fi 接口调用时序:

    Android:startWifi —> connectWifi —> onWifiConnected
    iOS(仅iOS 11及以上版本支持):startWifi —> connectWifi —> onWifiConnected

     

    连周边 Wi-Fi 接口调用时序:

    Android:startWifi —> getWifiList —> onGetWifiList —> connectWifi —> onWifiConnected
    iOS(iOS 11.0及11.1版本因系统原因暂不支持):startWifi —> getWifiList —> onGetWifiList —> setWifiList —> onWifiConnected

    注意:

    Wi-Fi 相关接口暂不可用 wx.canIUse 接口判断。
    Wi-Fi接口仅企业微信andriod 2.4.16版本及以上支持,微信端不支持(微信开发者工具也不支持)
    Android 6.0 以上版本,在没有打开定位开关的时候会导致设备不能正常获取周边的 Wi-Fi 信息。

    初始化 Wi-Fi 模块

    wx.startWifi({
      success: function(res) {
        console.log(res.errMsg)
      }
    })

    请求参数说明

    参数类型必填说明
    successFunction接口调用成功的回调函数
    failFunction接口调用失败的回调函数
    completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

     

    关闭 Wi-Fi 模块

    wx.stopWifi({
      success: function(res) {
        console.log(res.errMsg)
      }
    })

    请求参数说明

    参数类型必填说明
    successFunction接口调用成功的回调函数
    failFunction接口调用失败的回调函数
    completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

    连接 Wi-Fi

    若已知 Wi-Fi 信息,可以直接利用该接口连接。

    wx.connectWifi({
      SSID: 'vincenthome',  // 设备SSID
      BSSID: '8c:a6:df:c8:f7:4b',  // 设备BSSID
      password: 'test1234',  // 设备密码
      success: function(res) {
        console.log(res.errMsg)
      }
    })

    请求参数说明

    参数类型必填说明
    SSIDStringWi-Fi 设备SSID
    BSSIDStringWi-Fi 设备BSSID
    passwordStringWi-Fi 设备密码
    successFunction接口调用成功的回调函数
    failFunction接口调用失败的回调函数
    completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

    请求获取 Wi-Fi 列表

    请求获取 Wi-Fi 列表,在 onGetWifiList 注册的回调中返回 wifiList 数据。

    wx.getWifiList({
      success: function(res) {
          console.log(res.errMsg)
      }
    })

    请求参数说明

    参数类型必填说明
    successFunction接口调用成功的回调函数
    failFunction接口调用失败的回调函数
    completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

    监听获取到 Wi-Fi 列表事件

    监听在获取到 Wi-Fi 列表数据时的事件,在回调中将返回 wifiList。

    wx.onGetWifiList(function(res) {
      if (res.wifiList.length) {
           for(var i = 0; i < res.wifiList.length; i++)
           {
               console.log("=====wifiList======")
               console.log("SSID:"  +  res.wifiList[i].SSID)
               console.log("BSSID:" + res.wifiList[i].BSSID)
               console.log("secure:" + res.wifiList[i].secure)
               console.log("secure:" + res.wifiList[i].signalStrength)
               console.log("====================")
            }
      }
    })

    CALLBACK 返回参数说明

    参数类型说明
    wifiListArrayWi-Fi 列表数据

    Wi-Fi 列表项说明:

    参数类型说明
    SSIDStringWi-Fi 的SSID
    BSSIDStringWi-Fi 的BSSID
    secureBooleanWi-Fi 是否安全
    signalStrengthNumberWi-Fi 信号强度

    监听连接上 Wi-Fi 的事件

    wx.onWifiConnected(function(res) {
       console.log(res.wifi)
    })

    CALLBACK 返回参数说明

    参数类型说明
    wifiObjectWi-Fi 信息

    Wi-Fi 信息说明:

    参数类型说明
    SSIDStringWi-Fi 的SSID
    BSSIDStringWi-Fi 的BSSID
    secureBooleanWi-Fi 是否安全
    signalStrengthNumberWi-Fi 信号强度

    获取已连接中的 Wi-Fi 信息

    wx.getConnectedWifi({
       success: function(res){
           console.log(res.wifi)
       }
    })

    请求参数说明

    参数类型必填说明
    successFunction接口调用成功的回调函数
    failFunction接口调用失败的回调函数
    completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

    success返回参数说明:

    参数类型说明
    wifiObjectWi-Fi 信息

    Wi-Fi 信息说明:

    参数类型说明
    SSIDStringWi-Fi 的SSID
    BSSIDStringWi-Fi 的BSSID
    secureBooleanWi-Fi 是否安全
    signalStrengthNumberWi-Fi 信号强度

    Wi-Fi接口错误码列表

    错误码错误码说明
    0正常
    12000未先调用startWifi接口
    12001当前系统不支持相关能力
    12002Wi-Fi 密码错误
    12003连接超时
    12004重复连接 Wi-Fi
    12005Android特有,未打开 Wi-Fi 开关
    12006Android特有,未打开 GPS 定位开关
    12007用户拒绝授权连接 Wi-Fi
    12008无效SSID
    12009系统运营商配置拒绝连接 Wi-Fi
    12010系统其他错误,需要在errmsg打印具体的错误原因
    12011应用在后台无法配置 Wi-Fi
    上一篇
    文件接口
    下一篇
    蓝牙