Wi-Fi 1020+

接口声明

{"name": "system.wifi"}

导入模块

import wifi from '@system.wifi'const wifi = require('@system.wifi')

接口定义

方法

wifi.connect(OBJECT)

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

参数:
参数名 类型 必填 说明
SSID String Wi-Fi设备的SSID
BSSID String Wi-Fi设备的BSSID
password String Wi-Fi设备密码
success Function 成功回调,此时Wi-Fi已经成功连接上
fail Function 失败回调
complete Function 执行结束后的回调
fail返回错误代码:
错误码 说明
500 应用在后台无法进行操作
1000 Wi-Fi密码错误
1001 连接超时
1002 重复连接Wi-Fi
1003 未打开Wi-Fi开关
1005 无效SSID
示例:
wifi.connect({
  SSID: '',
  BSSID: '',
  success: function() {
    console.log('connect wifi success')
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

wifi.scan(OBJECT)

请求获取Wi-Fi列表,在onscanned事件中返回Wi-Fi列表数据。

参数:
参数名 类型 必填 说明
success Function 扫描请求发起成功
fail Function 扫描请求发起失败
complete Function 执行结束后的回调
fail返回错误代码:
错误码 说明
500 应用在后台无法进行操作
1003 未打开Wi-Fi开关
1004 未打开位置服务开关。Android 6.0及以上版本,没有打开位置服务开关会导致无法正常扫描周边的Wi-Fi信息
示例:
wifi.scan({
  success: function() {
    console.log('scan success')
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

wifi.getConnectedWifi(OBJECT)

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

参数:
参数名 类型 必填 说明
success Function 成功回调
fail Function 失败回调
complete Function 执行结束后的回调
success返回值:
参数 类型 说明
SSID String Wi-Fi的SSID
BSSID String Wi-Fi的BSSID
secure Boolean Wi-Fi是否安全
signalStrength Number Wi-Fi信号强度
fail返回错误代码:
错误码 说明
200 当前没有Wi-Fi连接
500 应用在后台无法进行操作
1003 未打开Wi-Fi开关
示例:
wifi.getConnectedWifi({
  success: function(data) {
    console.log(`handling success: ${data.SSID}`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

事件

wifi.onscanned = function(data)

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

返回参数说明:
参数 类型 说明
wifiList Array Wi-Fi列表数据
Wi-Fi列表项说明:
参数 类型 说明
SSID String Wi-Fi的SSID
BSSID String Wi-Fi的BSSID
secure Boolean Wi-Fi是否安全
signalStrength Number Wi-Fi信号强度
示例:
wifi.onscanned = function(data) {
  for (const i in data.wifiList) {
    console.log(`wifi: ${data.wifiList[i].SSID}`)
  }
}

wifi.onstatechanged = function(data)

监听连接和断开Wi-Fi的事件。

返回参数说明:
参数 类型 说明
state Number Wi-Fi是否连接的状态标识。连接断开:0;连接成功:1
SSID String Wi-Fi的SSID。连接成功时有效
BSSID String Wi-Fi的BSSID。连接成功时有效
secure Boolean Wi-Fi是否安全。连接成功时有效
signalStrength Number Wi-Fi信号强度。连接成功时有效
示例:
wifi.onstatechanged = function(data) {
  console.log(`handling wifi state changed: ${data.state}`)
}

条匹配 "" 的结果

    没有搜索到与 "" 相关的内容