Просмотр исходного кода

add: dhcpsrv,补充create函数返回值的描述

Wendal Chen 4 месяцев назад
Родитель
Сommit
80b9b13697

+ 3 - 3
script/libs/air153C_wtd.lua

@@ -19,7 +19,7 @@ air153C_wtd={}
 初始化引脚
 @api air153C_wtd.init(watchdogPin)
 @int 看门狗控制引脚
-@return nil
+@return nil 无返回值
 @usage
 air153C_wtd.init(28)
 ]]
@@ -34,7 +34,7 @@ end
 调用此函数进行喂狗
 @api air153C_wtd.feed_dog(watchdogPin)
 @int watchdogPin设置看门狗控制引脚
-@return nil
+@return nil 无返回值
 @usage
 air153C_wtd.feed_dog(28)
 ]]
@@ -47,7 +47,7 @@ end
 调用此函数关闭喂狗,谨慎使用!
 @api air153C_wtd.close_watch_dog(watchdogPin)
 @int watchdogPin设置看门狗控制引脚
-@return nil
+@return nil 无返回值
 @usage
 air153C_wtd.close_watch_dog(28)
 ]]

+ 16 - 3
script/libs/dhcpsrv.lua

@@ -293,7 +293,7 @@ end
 创建一个dhcp服务器
 @api dhcpsrv.create(opts)
 @table 选项,参考库的说明, 及demo的用法
-@return 服务器对象
+@return table 服务器对象
 @usage
 -- 创建一个dhcp服务器, 最简介的版本
 dhcpsrv.create({adapter=socket.LWIP_AP})
@@ -307,9 +307,22 @@ local dhcpsrv_opts = {
     ip_end = 200, -- ip结束地址, 默认200
     ack_cb = function(ip, mac) end, -- ack回调, 有客户端连接上来时触发, ip和mac地址会传进来
 }
-dhcpsrv.create(dhcpsrv_opts)
+local mydhcpsrv = dhcpsrv.create(dhcpsrv_opts)
+
+-- 以下是一个打印客户端列表的例子, 非必选, 仅供参考
+-- clients是一个table, 包含MAC和IP的对应关系, 注意, IP只记录了最后一段数字, 非完整IP
+-- 注意, clients是动态变化的过程, mydhcpsrv对象的其他属性切勿修改, 仅提供clients的只读功能
+sys.taskInit(function()
+    while true do
+        sys.wait(10000)
+        -- 这里可以打印一下当前的客户端列表
+        for ip, client in pairs(mydhcpsrv.clients) do
+            log.info(TAG, "client", ip, client.mac:toHex(), client.tm, client.stat)
+        end
+    end
+end)
 
--- 自动功能说明:
+-- 自动分配网段功能说明:
 -- 如果不指定gw参数,系统会自动获取网卡IP作为网关地址
 -- 这样可以确保DHCP分配的IP与网卡IP在同一网段
 ]]

+ 4 - 4
script/libs/exgnss.lua

@@ -552,7 +552,7 @@ uart:GNSS串口配置,780EGH和8000默认为uart2,可不填
 uartbaud:GNSS串口波特率,780EGH和8000默认为115200,可不填
 bind:绑定uart端口进行GNSS数据读取,是否设置串口转发,指定串口号,不需要转发可不填
 rtc:定位成功后自动设置RTC true开启,flase关闭,默认为flase,不需要可不填
-@return nil
+@return nil 无返回值
 @usage
 local gnssotps={
         gnssmode=1, --1为卫星全定位,2为单北斗
@@ -594,7 +594,7 @@ end
 @api exgnss.open(mode,para)
 @number mode gnss应用模式,支持gnss.DEFAULT,gnss.TIMERORSUC,gnss.TIMER三种
 @param para table类型,gnss应用参数,para.tag:string类型,gnss应用标记,para.val:number类型,gnss应用开启最大时长,单位:秒,mode参数为gnss.TIMERORSUC或者gnss.TIMER时,此值才有意义;使用close接口时,不需要传入此参数,para.cb:gnss应用结束时的回调函数,回调函数的调用形式为para.cb(para.tag);使用close接口时,不需要传入此参数
-@return nil
+@return nil 无返回值
 @usage
 -- “gnss应用”:指的是使用gnss功能的一个应用
 -- 例如,假设有如下3种需求,要打开gnss,则一共有3个“gnss应用”:
@@ -639,7 +639,7 @@ end
 @api exgnss.close()
 @number mode gnss应用模式,支持gnss.DEFAULT,gnss.TIMERORSUC,gnss.TIMER三种
 @param para table类型,gnss应用参数,para.tag:string类型,gnss应用标记,para.val:number类型,gnss应用开启最大时长,单位:秒,mode参数为gnss.TIMERORSUC或者gnss.TIMER时,此值才有意义;使用close接口时,不需要传入此参数,para.cb:gnss应用结束时的回调函数,回调函数的调用形式为para.cb(para.tag);使用close接口时,不需要传入此参数
-@return nil
+@return nil 无返回值
 @usage
 exgnss.open(exgnss.TIMER,{tag="MODE1",val=60,cb=mode1_cb})
 exgnss.close(exgnss.TIMER,{tag="MODE1"})
@@ -662,7 +662,7 @@ end
 --[[
 关闭所有“gnss应用”
 @api exgnss.close_all()
-@return nil
+@return nil 无返回值
 @usage
 exgnss.open(exgnss.TIMER,{tag="MODE1",val=60,cb=mode1_cb})
 exgnss.open(exgnss.DEFAULT,{tag="MODE2",cb=mode2_cb})

+ 2 - 2
script/libs/exremotefile.lua

@@ -948,7 +948,7 @@ end
 @table ap_opts 可选,AP配置选项表
 @table sdcard_opts 可选,TF/SD卡挂载配置选项表
 @table server_opts 可选,服务器配置选项表
-@return 无
+@return 无 无返回值
 @usage
 -- 一、使用默认参数创建server服务器
 -- 启动后连接默认AP热点,直接访问日志中默认的地址"http://192.168.4.1:80/explorer.html"来访问文件管理服务器。
@@ -1060,7 +1060,7 @@ end
 --[[
 关闭文件管理系统,包括停止HTTP文件服务器、取消TF/SD卡挂载和停止AP热点
 @api exremotefile.close()
-@return 无
+@return 无 无返回值
 @usage
 -- 关闭文件管理系统
 -- exremotefile.close()

+ 2 - 2
script/libs/exvib.lua

@@ -255,7 +255,7 @@ end
 @number da221模式设置,1,微小震动检测,用于检测轻微震动的场景,例如用手敲击桌面;加速度量程2g;
                         2,运动检测,用于电动车或汽车行驶时的检测和人行走和跑步时的检测;加速度量程4g;
                         3,跌倒检测,用于人或物体瞬间跌倒时的检测;加速度量程8g;
-@return nil
+@return nil 无返回值
 @usage
     exvib.open(1)
 ]]
@@ -289,7 +289,7 @@ end
 --[[
     关闭da221
 @api exvib.close()
-@return nil
+@return nil 无返回值
 @usage
     exvib.close()
 ]]

+ 1 - 1
script/libs/lbsLoc.lua

@@ -272,7 +272,7 @@ end
 @string productKey IOT网站上的产品KEY,如果在main.lua中定义了PRODUCT_KEY变量,则此参数可以传nil
 @string host 服务器域名, 默认 "bs.openluat.com" ,可选备用服务器(不保证可用) "bs.air32.cn"
 @string port 服务器端口,默认"12411",一般不需要设置
-@return nil
+@return nil 无返回值
 @usage
 -- 提醒: 返回的坐标值, 是WGS84坐标系
 ]]