Wi-Fi 1020+

接口声明

  1. { "name": "system.wifi" }

导入模块

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

接口定义

方法

wifi.connect(OBJECT)

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

权限要求

粗略设备定位

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

wifi.scan(OBJECT)

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

权限要求

粗略设备定位

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

wifi.getConnectedWifi(OBJECT)

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

权限要求

粗略设备定位

参数:
参数名类型必填说明
successFunction成功回调
failFunction失败回调
completeFunction执行结束后的回调
success 返回值:
参数类型说明
SSIDStringWi-Fi 的 SSID
BSSIDStringWi-Fi 的 BSSID
secureBooleanWi-Fi 是否安全
signalStrengthNumberWi-Fi 信号强度
fail 返回错误代码:
错误码说明
200当前没有 Wi-Fi 连接
500应用在后台无法进行操作
1003未打开 Wi-Fi 开关
示例:
  1. wifi.getConnectedWifi({
  2. success: function(data) {
  3. console.log(`handling success: ${data.SSID}`)
  4. },
  5. fail: function(data, code) {
  6. console.log(`handling fail, code = ${code}`)
  7. }
  8. })

事件

wifi.onscanned = function(data)

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

权限要求

粗略设备定位

返回参数说明:
参数类型说明
wifiListArrayWi-Fi 列表数据
Wi-Fi 列表项说明:
参数类型说明
SSIDStringWi-Fi 的 SSID
BSSIDStringWi-Fi 的 BSSID
secureBooleanWi-Fi 是否安全
signalStrengthNumberWi-Fi 信号强度
示例:
  1. wifi.onscanned = function(data) {
  2. for (const i in data.wifiList) {
  3. console.log(`wifi: ${data.wifiList[i].SSID}`)
  4. }
  5. }

wifi.onstatechanged = function(data)

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

权限要求

粗略设备定位

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

后台运行限制

禁止使用。后台运行详细用法参见后台运行 脚本