wlan - wifi操作#
已适配 Air101/Air103 Air601 ESP32C3 ESP32S3 Air780E/Air700E Air780EP
备注
本页文档由这个文件自动生成。如有错误，请提交issue或帮忙修改后pr，谢谢！
小技巧
本库有专属demo，点此链接查看wlan的demo例子
示例
--[[
提醒:
对于仅支持wifiscan的模块, 仅 init/scan/scanResult 函数是可用的
例如: Air780E/Air600E/Air780EG等仅支持wifiscan
]]
常量#
常量 |
类型 |
解释 |
|---|---|---|
wlan.ESPTOUCH |
esptouch配网, |
V1 |
wlan.AIRKISS |
Airkiss配网, |
微信常用 |
wlan.ESPTOUCH_V2 |
esptouch配网, |
V2, 未测试 |
wlan.init()#
初始化
参数
无
返回值
返回值类型 |
解释 |
|---|---|
bool |
成功返回true,否则返回false |
例子
无
wlan.setMode(mode)#
设置wifi模式
参数
传入值类型 |
解释 |
|---|---|
int |
wifi模式 |
返回值
返回值类型 |
解释 |
|---|---|
bool |
成功返回true,否则返回false |
例子
-- 设置为AP模式, 广播ssid, 接收wifi客户端的链接
wlan.setMode(wlan.AP)
-- 设置为STATION模式, 也是初始化后的默认模式
wlan.setMode(wlan.STATION)
-- 混合模式, 做AP又做STATION
wlan.setMode(wlan.APSTA)
wlan.ready()#
作为STATION时,是否已经连接上AP,且获取IP成功
参数
无
返回值
返回值类型 |
解释 |
|---|---|
bool |
已经连接成功返回true,否则返回false |
例子
无
wlan.connect(ssid, password, auto_reconnect)#
作为STATION时,连接到指定AP
参数
传入值类型 |
解释 |
|---|---|
string |
AP的ssid |
string |
AP的password,可选 |
int |
0关闭自动重连,1开启自动重连.当前强制开启自动重连 |
返回值
返回值类型 |
解释 |
|---|---|
bool |
发起连接成功返回true,否则返回false.注意,不代表连接AP成功!! |
例子
-- 普通模式,带密码
wlan.connect("myap", "12345678")
-- 普通模式,不带密码
wlan.connect("myap")
-- 特殊模式, 重用之前的ssid和密码,本次直接连接
-- 注意, 前提是本次上电后已经传过ssid和或password,否则必失败
wlan.connect()
wlan.disconnect()#
作为STATION时,断开AP
参数
无
返回值
无
例子
无
wlan.scan()#
扫描wifi频段
参数
无
返回值
无
例子
-- 注意, wlan.scan()是异步API,启动扫描后会马上返回
-- wifi扫描成功后, 会有WLAN_SCAN_DONE消息, 读取即可
sys.subscribe("WLAN_SCAN_DONE", function ()
local results = wlan.scanResult()
log.info("scan", "results", #results)
for k,v in pairs(results) do
log.info("scan", v["ssid"], v["rssi"], (v["bssid"]:toHex()))
end
end)
-- 下面演示的是初始化wifi后定时扫描,请按实际业务需求修改
sys.taskInit(function()
sys.wait(1000)
wlan.init()
while 1 do
wlan.scan()
sys.wait(15000)
end
end)
wlan.scanResult()#
获取wifi扫描结果
参数
无
返回值
返回值类型 |
解释 |
|---|---|
table |
扫描结果 |
例子
-- 用法请查阅 wlan.scan() 函数
wlan.smartconfig(mode)#
配网
参数
传入值类型 |
解释 |
|---|---|
int |
配网模式, 默认为esptouch, 若传0则主动停止配网 |
返回值
返回值类型 |
解释 |
|---|---|
bool |
启动成功或停止成功, 返回true, 否则返回false |
例子
wlan.smartconfig()
local ret, ssid, passwd = sys.waitUntil("SC_RESULT", 180*1000) -- 最多等3分钟
log.info("sc", ret, ssid, passwd)
-- 详细用法请查看demo
wlan.getMac(tp, hexstr)#
获取mac
参数
传入值类型 |
解释 |
|---|---|
int |
设置何种mac地址,对ESP32系列来说,只能设置STA的地址,即0,默认值也是0 |
bool |
是否转HEX字符, 默认是true,即输出hex字符串 |
返回值
返回值类型 |
解释 |
|---|---|
string |
MAC地址,十六进制字符串形式 “AABBCCDDEEFF” 或原始数据 |
例子
无
wlan.setMac(tp, mac)#
设置mac
参数
传入值类型 |
解释 |
|---|---|
int |
设置何种mac地址,对ESP32系列来说,只能设置STA的地址,即0 |
string |
待设置的MAC地址,长度6字节 |
返回值
返回值类型 |
解释 |
|---|---|
bool |
成功返回true,否则返回false |
例子
-- 设置MAC地址, 2023-03-01之后编译的固件可用
local mac = string.fromHex("F01122334455")
wlan.setMac(0, mac)
-- 部分模块支持恢复默认MAC, 例如esp32系列
-- 在2023-11-01 之后编译的固件可用
local mac = string.fromHex("000000000000")
wlan.setMac(0, mac)
wlan.getIP()#
获取ip,仅STATION或APSTA模式下有意义
参数
无
返回值
返回值类型 |
解释 |
|---|---|
string |
ip地址,当前仅返回ipv4地址,例如 “192.168.1.25” |
例子
无
wlan.createAP(ssid, passwd, gateway, netmask, channel)#
启动AP
参数
传入值类型 |
解释 |
|---|---|
string |
AP的SSID,必填 |
string |
AP的密码,可选 |
string |
AP的网关地址, 默认192.168.4.1 |
string |
AP的网关掩码, 默认255.255.255.0 |
int |
AP建立的通道, 默认6 |
返回值
返回值类型 |
解释 |
|---|---|
bool |
成功创建返回true,否则返回false |
例子
-- 注意, 调用本AP时,若wifi模式为STATION,会自动切换成 APSTA
wlan.createAP("uiot", "12345678")
-- 设置网关IP,掩码, 通道, 2023.7.13 新增, BSP未必支持
-- wlan.createAP("uiot", "12345678", "192.168.4.1", "255.255.255.0", 6)
wlan.stopAP()#
关闭AP功能
参数
无
返回值
返回值类型 |
解释 |
|---|---|
bool |
成功创建返回true,否则返回false |
例子
wlan.stopAP()
wlan.getInfo()#
获取信息,如AP的bssid,信号强度
参数
无
返回值
返回值类型 |
解释 |
|---|---|
table |
详情,键值对形式 |
例子
log.info("wlan", "info", json.encode(wlan.getInfo()))
--[[
典型输出
{
"bssid" : "xxxxxx",
"rssi" : -89,
"gw" : "192.168.1.1"
}
]]
wlan.powerSave(mode)#
读取或设置省电模式
参数
传入值类型 |
解释 |
|---|---|
int |
省电模式,可选, 传入就是设置, 例如wlan.PS_NONE |
返回值
返回值类型 |
解释 |
|---|---|
int |
当前省电模式/设置后的省电模式 |
例子
-- 请查阅常量表 PS_NONE/PS_MIN_MODEM/PS_MAX_MODEM
log.info("wlan", "PS", wlan.powerSave(wlan.PS_NONE))
-- 本API于 2023.03.31 新增
wlan.hostname(new_name)#
读取或设置Hostname
参数
传入值类型 |
解释 |
|---|---|
string |
新的hostname,可选, 传入就是设置 |
返回值
返回值类型 |
解释 |
|---|---|
string |
当前的hostname或者设置后的hostname |
例子
-- 本API于 2023.07.23 新增
-- 本函数应该在wlan.init之前设置好, 最晚应早于wlan.connect
-- hostname的默认值是 "LUATOS_" + 设备的MAC值
-- 例如: LUATOS_0022EECC2399
wlan.hostname("我的wifi物联网设备")
wlan.staIp(dhcp_enable, ip, netmask, gateway)#
设置Station模式下的IP获取模式
参数
传入值类型 |
解释 |
|---|---|
bool |
是否启用DHCP,默认是true |
string |
本机IP地址,例如192.168.2.200, 禁用DHCP时必填 |
string |
本机IP掩码,例如255.255.255.0, 禁用DHCP时必填 |
string |
本机IP网关,例如192.168.2.1, 禁用DHCP时必填 |
返回值
返回值类型 |
解释 |
|---|---|
bool |
成功返回true,否则返回false |
例子
-- 本API于 2023.10.06 新增
-- 本函数需要在wlan.init之后才允许调用
-- 启用DHCP, 默认也是启用DHCP,这里是演示API使用
wlan.staIp(true)
-- 禁用DHCP,自行设置IP/掩码/网关
wlan.staIp(false, "192.168.2.200", "255.255.255.0", "192.168.2.1")