socket - 网络接口

常量

常量	类型	解释
socket.ETH0	number	带硬件协议栈的ETH0，值为5
socket.LWIP_ETH	number	使用LWIP协议栈的以太网卡，值为4
socket.LWIP_STA	number	使用LWIP协议栈的WIFI STA，值为2
socket.LWIP_AP	number	使用LWIP协议栈的WIFI AP，值为3
socket.LWIP_GP	number	使用LWIP协议栈的移动蜂窝模块，值为1
socket.USB	number	使用LWIP协议栈的USB网卡，值为6
socket.LINK	number	LINK事件
socket.ON_LINE	number	ON_LINE事件
socket.EVENT	number	EVENT事件
socket.TX_OK	number	TX_OK事件
socket.CLOSED	number	CLOSED事件
socket.LWIP_SPI	number	使用LWIP协议栈的SPI网络
socket.LWIP_UART	number	使用LWIP协议栈的UART网络
socket.LWIP_USER0	number	使用LWIP协议栈的自定义网卡0, 2025.1.12新增
socket.LWIP_USER1	number	使用LWIP协议栈的自定义网卡1, 2025.1.12新增
socket.LWIP_USER2	number	使用LWIP协议栈的自定义网卡2, 2025.1.12新增
socket.LWIP_USER3	number	使用LWIP协议栈的自定义网卡3, 2025.1.12新增
socket.LWIP_USER4	number	使用LWIP协议栈的自定义网卡4, 2025.1.12新增
socket.LWIP_USER5	number	使用LWIP协议栈的自定义网卡5, 2025.1.12新增
socket.LWIP_USER6	number	使用LWIP协议栈的自定义网卡6, 2025.1.12新增
socket.LWIP_USER7	number	使用LWIP协议栈的自定义网卡7, 2025.1.12新增

socket.localIP(adapter)

获取本地ip

参数

传入值类型	解释
int	适配器序号， 只能是socket.ETH0（外置以太网），socket.LWIP_ETH（内置以太网），socket.LWIP_STA（内置WIFI的STA），socket.LWIP_AP（内置WIFI的AP），socket.LWIP_GP（内置蜂窝网络的GPRS），socket.USB（外置USB网卡），如果不填，优先选择soc平台自带能上外网的适配器，若仍然没有，选择最后一个注册的适配器

返回值

返回值类型	解释
string	通常是内网ip, 也可能是外网ip, 取决于运营商的分配
string	网络掩码
string	网关IP

例子

sys.taskInit(function()
    while 1 do
        sys.wait(3000)
        log.info("socket", "ip", socket.localIP())
        -- 输出示例
        -- 62.39.244.10    255.255.255.255    0.0.0.0
    end
end)

---

socket.create(adapter, cb)

在某个适配的网卡上申请一个socket_ctrl

参数

传入值类型	解释
int	适配器序号， 只能是socket.ETH0（外置以太网），socket.LWIP_ETH（内置以太网），socket.LWIP_STA（内置WIFI的STA），socket.LWIP_AP（内置WIFI的AP），socket.LWIP_GP（内置蜂窝网络的GPRS），socket.USB（外置USB网卡），如果不填，优先选择soc平台自带能上外网的适配器，若仍然没有，选择最后一个注册的适配器
string	or function string为消息通知的taskName，function则为回调函数，如果固件没有内置sys_wait，则必须是function

返回值

无

例子

无

---

socket.debug(ctrl, onoff)

配置是否打开debug信息

参数

传入值类型	解释
user_data	socket.create得到的ctrl
boolean	true 打开debug开关

返回值

返回值类型	解释
nil	无返回值

例子

-- 打开调试信息,默认是关闭状态
socket.debug(ctrl, true)

---

socket.config(ctrl, local_port, is_udp, is_tls, keep_idle, keep_interval, keep_cnt, server_cert, client_cert, client_key, client_password)

配置network一些信息，

参数

传入值类型	解释
user_data	socket.create得到的ctrl
int	本地端口号，小端格式，如果不写，则自动分配一个，如果用户填了端口号则需要小于60000, 默认不写
boolean	是否是UDP，默认false
boolean	是否是加密传输，默认false
int	tcp keep live模式下的idle时间（秒），如果留空则表示不启用，如果是不支持标准posix接口的网卡（比如W5500），则为心跳间隔
int	tcp keep live模式下的探测间隔时间（秒）
int	tcp keep live模式下的探测次数
string	TCP模式下的服务器ca证书数据，UDP模式下的PSK，不需要加密传输写nil，后续参数也全部nil
string	TCP模式下的客户端ca证书数据，UDP模式下的PSK-ID，TCP模式下如果不需要验证客户端证书时，忽略，一般不需要验证客户端证书
string	TCP模式下的客户端私钥加密数据
string	TCP模式下的客户端私钥口令数据

返回值

返回值类型	解释
boolean	成功返回true，失败返回false

例子

--最普通的TCP传输
socket.config(ctrl)
--最普通的加密TCP传输，证书都不用验证的那种
socket.config(ctrl, nil, nil ,true)

---

socket.linkup(ctrl)

等待网卡linkup

参数

传入值类型	解释
user_data	socket.create得到的ctrl

返回值

返回值类型	解释
boolean	true没有异常发生，false失败了，如果false则不需要看下一个返回值了
boolean	true已经linkup，false没有linkup，之后需要接收socket.LINK消息

例子

-- 判断一下是否已经联网
local succ, result = socket.linkup(ctrl)

---

socket.connect(ctrl, ip, remote_port, need_ipv6_dns)

作为客户端连接服务器

参数

传入值类型	解释
user_data	socket.create得到的ctrl
string	or int ip或者域名，如果是IPV4，可以是大端格式的int值
int	服务器端口号，小端格式
boolean	域名解析是否要IPV6，true要，false不要，默认false不要，只有支持IPV6的协议栈才有效果

返回值

返回值类型	解释
boolean	true没有异常发生，false失败了，如果false则不需要看下一个返回值了，如果有异常，后续要close
boolean	true已经connect，false没有connect，之后需要接收socket.ON_LINE消息

例子

local succ, result = socket.connect(ctrl, "netlab.luatos.com", 40123)

--[[
常见的连接失败的code值, 会在日志中显示
-1 底层内存不足
-3 超时
-8 端口已经被占用
-11 链接未建立
-13 模块主动断开连接
-14 服务器主动断开连接
]]

---

socket.discon(ctrl)

作为客户端断开连接

参数

传入值类型	解释
user_data	socket.create得到的ctrl

返回值

返回值类型	解释
boolean	true没有异常发生，false失败了，如果false则不需要看下一个返回值了
boolean	true已经断开，false没有断开，之后需要接收socket.CLOSED消息

例子

local succ, result = socket.discon(ctrl)

---

socket.close(ctrl)

强制关闭socket

参数

传入值类型	解释
user_data	socket.create得到的ctrl

返回值

返回值类型	解释
nil	无返回值

例子

无

---

socket.tx(ctrl, data, ip, port, flag)

发送数据给对端，UDP单次发送不要超过1460字节，否则很容易失败

参数

传入值类型	解释
user_data	socket.create得到的ctrl
string	or user_data zbuff 要发送的数据
string	or int 对端IP，如果是TCP应用则忽略，如果是UDP，如果留空则用connect时候的参数，如果是IPV4，可以是大端格式的int值
int	对端端口号，小端格式，如果是TCP应用则忽略，如果是UDP，如果留空则用connect时候的参数
int	发送参数，目前预留，不起作用

返回值

返回值类型	解释
boolean	true没有异常发生，false失败了，如果false则不需要看下一个返回值了，如果false，后续要close
boolean	true缓冲区满了，false没有满，如果true，则需要等待一段时间或者等到socket.TX_OK消息后再尝试发送，同时忽略下一个返回值
boolean	true已经收到应答，false没有收到应答，之后需要接收socket.TX_OK消息， 也可以忽略继续发送，直到full==true

例子

local succ, full, result = socket.tx(ctrl, "123456", "xxx.xxx.xxx.xxx", xxxx)

---

socket.rx(ctrl, buff, flag, limit)

接收对端发出的数据，注意数据已经缓存在底层，使用本函数只是提取出来，UDP模式下一次只会取出一个数据包

参数

传入值类型	解释
user_data	socket.create得到的ctrl
user_data	zbuff 存放接收的数据，如果缓冲区不够大会自动扩容
int	接收参数，目前预留，不起作用
int	接收数据长度限制，如果指定了，则只取前N个字节. 2024.1.5 新增

返回值

返回值类型	解释
boolean	true没有异常发生，false失败了，如果false则不需要看下一个返回值了，如果false，后续要close
int	本次接收到数据长度
string	对端IP，只有UDP模式下才有意义，TCP模式返回nil，注意返回的格式，如果是IPV4，1byte 0x00 + 4byte地址 如果是IPV6，1byte 0x01 + 16byte地址
int	对端port，只有UDP模式下才有意义，TCP模式返回0

例子

-- 从socket中读取数据, ctrl是socket.create返回的, 请查阅demo/socket
local buff = zbuff.create(2048)
local succ, data_len, remote_ip, remote_port = socket.rx(ctrl, buff)

-- 限制读取长度, 2024.1.5 新增
-- 注意
-- 如果是UDP数据, 如果limit小于UDP数据包长度, 只会取前limit个字节, 剩余数据会丢弃
-- 如果是TCP数据, 如果有剩余数据, 不会丢弃, 可继续读取.
-- 有新的数据到来才会有新的EVENT数据, 未读取完成的数据不会触发新EVENT事件
local succ, data_len, remote_ip, remote_port = socket.rx(ctrl, buff, 1500)

-- 读取缓冲区大小, 2024.1.5 新增, 注意,老版本固件不传buff参数会报错的
-- 对于TCP数据, 这里返回的是待读取的数据的总长度
-- 对于UDP数据, 这里返回的是单个UDP数据包的长度
local succ, data_len = socket.rx(ctrl)
if succ then
    log.info("待收取数据长度", data_len)
end

---

socket.read(netc, len)

读取数据(非zbuff版本)

参数

传入值类型	解释
userdata	socket.create得到的ctrl
int	限制读取数据长度,可选,不传就是读出全部

返回值

返回值类型	解释
boolean	读取成功与否
string	读取的数据,仅当读取成功时有效
string	对方IP地址,仅当读取成功且UDP通信时有效
int	对方端口,仅当读取成功且UDP通信时有效

例子

-- 本函数于2024.4.8添加, 用于简易读取不大的数据
-- 请优先使用socket.rx函数, 本函数主要用于固件不含zbuff库时的变通调用
local ok, data = socket.read(netc, 1500)
if ok and #data > 0 then
    log.info("读取到的数据", data)
end

---

socket.wait(ctrl)

等待新的socket消息，在连接成功和发送数据成功后，使用一次将network状态转换到接收新数据

参数

传入值类型	解释
user_data	socket.create得到的ctrl

返回值

返回值类型	解释
boolean	true没有异常发生，false失败了，如果false则不需要看下一个返回值了，如果false，后续要close
boolean	true有新的数据需要接收，false没有数据，之后需要接收socket.EVENT消息

例子

local succ, result = socket.wait(ctrl)

---

socket.listen(ctrl)

作为服务端开始监听

参数

传入值类型	解释
user_data	socket.create得到的ctrl

返回值

返回值类型	解释
boolean	true没有异常发生，false失败了，如果false则不需要看下一个返回值了，如果false，后续要close
boolean	true已经connect，false没有connect，之后需要接收socket.ON_LINE消息

例子

local succ, result = socket.listen(ctrl)

---

socket.accept(ctrl)

作为服务端接收到一个新的客户端，注意，如果是类似W5500的硬件协议栈不支持1对多，则不需要第二个参数

参数

传入值类型	解释
user_data	socket.create得到的ctrl，这里是服务器端
string	or function or nil string为消息通知的taskName，function则为回调函数，和socket.create参数一致

返回值

返回值类型	解释
boolean	true没有异常发生，false失败了，如果false则不需要看下一个返回值了，如果false，后续要close
user_data	or nil 如果支持1对多，则会返回新的ctrl，自动create，如果不支持则返回nil

例子

local succ, new_netc = socket.accept(ctrl, cb)

---

socket.state(ctrl)

获取socket当前状态

参数

传入值类型	解释
user_data	socket.create得到的ctrl

返回值

返回值类型	解释
int	or nil,输入参数正确的情况下，返回状态的数值，否则返回nil
string	or nil,输入参数正确的情况下，返回状态的中文描述，否则返回nil

例子

local state, str = socket.state(ctrl)
log.info("state", state, str)
state    0    "硬件离线",
        1    "离线",
        2    "等待DNS",
        3    "正在连接",
        4    "正在TLS握手",
        5    "在线",
        6    "在监听",
        7    "正在离线",
        8    "未知"

---

socket.release(ctrl)

主动释放掉network_ctrl

参数

传入值类型	解释
user_data	socket.create得到的ctrl

返回值

无

例子

-- 释放后就不能再使用了
socket.release(ctrl)

---

socket.setDNS(adapter_index, dns_index, ip)

设置DNS服务器

参数

传入值类型	解释
int	适配器序号， 只能是socket.ETH0，socket.STA，socket.AP，如果不填，会选择最后一个注册的适配器
int	dns服务器序号，从1开始
string	or int dns，如果是IPV4，可以是大端格式的int值

返回值

返回值类型	解释
boolean	成功返回true，失败返回false

例子

-- 设置默认网络适配器的DNS配置
socket.setDNS(nil, 1, "114.114.114.114")
-- 设置制定网络适配器的DNS配置
socket.setDNS(socket.ETH0, 1, "114.114.114.114")

---

socket.sslLog(log_level)

设置SSL的log登记

参数

传入值类型	解释
int	mbedtls log等级

返回值

返回值类型	解释
nil	无返回值

例子

--[[
SSL/TLS log级别说明
0不打印
1只打印错误和警
2大部分info
3及3以上详细的debug

过多的信息可能会造成内存碎片化
]]
-- 打印大部分info日志
socket.sslLog(2)

---

socket.adapter(index)

查看网卡适配器的联网状态

参数

传入值类型	解释
int	需要查看的适配器序号，可以留空会查看全部网卡，直到遇到IP READY的，如果指定网卡，只能是socket.ETH0（外置以太网），socket.LWIP_ETH（内置以太网），socket.LWIP_STA（内置WIFI的STA），socket.LWIP_AP（内置WIFI的AP），socket.LWIP_GP（内置蜂窝网络的GPRS），socket.USB（外置USB网卡）

返回值

返回值类型	解释
boolean	被查看的适配器是否IP READY,true表示已经准备好可以联网了,false暂时不可以联网
int	最后一个被查看的适配器序号

例子

-- 查看全部网卡，直到找到一个是IP READY的
local isReady,index = socket.adapter() --如果isReady为true,则index为IP READY的网卡适配器序号
--查看外置以太网（比如W5500）是否IP READY
local isReady,default = socket.adapter(socket.ETH0)

---

socket.remoteIP(ctrl)

获取对端ip

参数

传入值类型	解释
user_data	socket.create得到的ctrl

返回值

返回值类型	解释
string	IP1，如果为nil，则表示没有获取到IP地址
string	IP2，如果为nil，则表示没有IP2
string	IP3，如果为nil，则表示没有IP3
string	IP4，如果为nil，则表示没有IP4

例子

-- 注意: ，必须在接收到socket.ON_LINE消息之后才可能获取到，最多返回4个IP。
-- socket.connect里如果remote_port设置成0，则当DNS完成时就返回socket.ON_LINE消息
local ip1,ip2,ip3,ip4 = socket.remoteIP(ctrl)

---

socket.dft(id)

设置默认网络适配器编号

参数

传入值类型	解释
int	默认适配器编号,若不传,则打包获取

返回值

返回值类型	解释
int	默认适配器编号

例子

-- 本函数于 2025.1.6 新增
-- 获取当前默认适配器编号
local id = socket.dft()

-- 设置默认适配器编号
socket.dft(socket.LWIP_ETH)

---

socket.sntp(sntp_server)

适配状态未知

sntp时间同步

参数

传入值类型	解释
string/table	sntp服务器地址 选填
int	适配器序号， 只能是socket.ETH0（外置以太网），socket.LWIP_ETH（内置以太网），socket.LWIP_STA（内置WIFI的STA），socket.LWIP_AP（内置WIFI的AP），socket.LWIP_GP（内置蜂窝网络的GPRS），socket.USB（外置USB网卡），如果不填，优先选择soc平台自带能上外网的适配器，若仍然没有，选择最后一个注册的适配器

返回值

无

例子

socket.sntp()
--socket.sntp("ntp.aliyun.com") --自定义sntp服务器地址
--socket.sntp({"ntp.aliyun.com","ntp1.aliyun.com","ntp2.aliyun.com"}) --sntp自定义服务器地址
--socket.sntp(nil, socket.ETH0) --sntp自定义适配器序号
sys.subscribe("NTP_UPDATE", function()
    log.info("sntp", "time", os.date())
end)
sys.subscribe("NTP_ERROR", function()
    log.info("socket", "sntp error")
    socket.sntp()
end)

---

socket.ntptm()

网络对时后的时间戳(ms级别)

参数

无

返回值

返回值类型	解释
table	包含时间信息的数据

例子

-- 本API于 2023.11.15 新增
-- 注意, 本函数在执行socket.sntp()且获取到NTP时间后才有效
-- 而且是2次sntp之后才是比较准确的值
-- 网络波动越小, 该时间戳越稳定
local tm = socket.ntptm()

-- 对应的table包含多个数据, 均为整数值

-- 标准数据
-- tsec 当前秒数,从1900.1.1 0:0:0 开始算, UTC时间
-- tms  当前毫秒数
-- vaild 是否有效, true 或者 nil

-- 调试数据, 调试用,一般用户不用管
-- ndelay 网络延时平均值,单位毫秒
-- ssec 系统启动时刻与1900.1.1 0:0:0的秒数偏移量
-- sms 系统启动时刻与1900.1.1 0:0:0的毫秒偏移量
-- lsec 本地秒数计数器,基于mcu.tick64()
-- lms 本地毫秒数计数器,基于mcu.tick64()

log.info("tm数据", json.encode(tm))
log.info("时间戳", string.format("%u.%03d", tm.tsec, tm.tms))

---

socket.sntp_port(port)

设置SNTP服务器的端口号

参数

传入值类型	解释
int	port 端口号, 默认123

返回值

返回值类型	解释
int	返回当前的端口号

例子

-- 本函数于2024.5.17新增
-- 大部分情况下不需要设置NTP服务器的端口号,默认123即可

---