获取Wi-Fi列表
1.接口描述
接口说明:获取可用的Wi-Fi网络列表。
请求方式:POST [ip]/api/network/wifi-scan-results
管理员权限 | 登录认证 |
---|---|
是 | 是 |
2.输入参数
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
iface | 是 | String | 网卡名称,wlan0 |
3.输出参数
参数名称 | 类型 | 描述 |
---|---|---|
status | Int | 状态码 |
connect | WiFiData | 当前连接的Wi-Fi网络信息 |
user-iterms | WiFiData | 连接过的Wi-Fi网络信息 |
scan-items | WiFiData | 其他可用的Wi-Fi网络信息 |
WiFiData
参数名称 | 类型 | 描述 |
---|---|---|
ssid | String | Wi-Fi网络名称 |
state | Int | 连接状态 0:未连接 1:连接中 2:连接成功 3:密码错误 4:连接失败 5:连接超时 |
bssid | String | Wi-Fi网络的MAC地址 |
frequency | Int | 网络频率 |
signal | Int | 信号强度 |
encryption | String | 加密方式 NONE:不加密 WEP:WEP 加密方式 WPAPSK:WPAPSK 加密方式, WPA2PSK:WPA2PSK 加密方式 |
is-auto | Boolean | 是否允许自动连接 true:是;false:否 |
is-used | Boolean | 是否连接成功 true:是;false:否 |
use-dhcp | Boolean | 是否使用DHCP获取IP地址 true:是;false:否 |
ipaddr | String | IP地址 |
netmask | String | 子网掩码 |
gateway | String | 网关地址 |
dns | String | DNS信息 |
4.示例
获取可用的Wi-Fi网络列表。
输入示例
{
"iface": "wlan0"
}
输出示例
{
"connect": {
"ssid": "magewell-GUEST",
"state": 2
},
"user-items": [
{
"ssid": "magewell-GUEST",
"bssid": "9e:a6:7e:5d:8f:66",
"frequency": 5220,
"signal": -36,
"encryption": "WPA2PSK",
"is-auto": false,
"is-used": true,
"use-dhcp": true,
"ipaddr": "192.168.21.215",
"netmask": "255.255.255.0",
"gateway": "192.168.21.1",
"dns": ""
}
],
"scan-items": [
{
"ssid": "magewell009",
"bssid": "8c:53:c3:3a:a0:da",
"frequency": 2422,
"signal": -66,
"encryption": "WPAPSK",
"is-auto": false,
"is-used": false
}
],
"status": 0
}
5.错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 定义 | 说明 |
---|---|---|
7 | MW_STATUS_INVALID_ARG | 参数缺失 |
11 | MW_STATUS_DEVICE_BUSY | 操作内容不是无线网卡 |