接口声明

{ "name": "system.wifi" }

导入模块

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

接口定义

方法

wifi.connect(OBJECT)

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

权限要求

粗略设备定位

参数：

fail 返回错误代码：

示例：

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 列表数据。

权限要求

粗略设备定位

参数：

fail 返回错误代码：

示例：

wifi.scan({
  success: function() {
    console.log('scan success')
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

wifi.getConnectedWifi(OBJECT)

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

权限要求

粗略设备定位

参数：

success 返回值：

fail 返回错误代码：

示例：

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。

权限要求

粗略设备定位

返回参数说明：

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 的事件。

权限要求

粗略设备定位

返回参数说明：

示例：

wifi.onstatechanged = function(data) {
  console.log(`handling wifi state changed: ${data.state}`)
}

后台运行限制

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