Module misc

模块功能:配置管理-序列号、IMEI、底层软件版本号、时钟、是否校准、飞行模式、查询电池电量等功能

Info:

  • Copyright: openLuat
  • Release: 2017.10.20
  • License: MIT
  • Author: openLuat

Functions

setClock (t[, cbFnc=nil]) 设置系统时间
getClock () 获取系统时间
getWeek () 获取星期
getCalib () 获取校准标志
setSn (s[, cbFnc=nil]) 设置SN
getSn () 获取模块序列号
setImei (s[, cbFnc=nil]) 设置IMEI
getImei () 获取模块IMEI
getVbatt () 获取VBAT的电池电压
getVbus () 获取VBUS连接状态
getMuid () 获取模块MUID
openPwm (id, para1, para2) 打开并且配置PWM(支持2路PWM,仅支持输出)
closePwm (id) 关闭PWM


Functions

setClock (t[, cbFnc=nil])
设置系统时间

Parameters:

  • t table
    系统时间,格式参考:{year=2017,month=2,day=14,hour=14,min=2,sec=58}
  • cbFnc function [此参数可选,默认值为: nil]
    设置结果回调函数,回调函数的调用形式为:
     cnFnc(time,result),result为true表示成功,false或者nil为失败;time表示设置之后的系统时间,table类型,例如{year=2017,month=2,day=14,hour=14,min=19,sec=23}

Returns:

  • nil

Usage:

  • misc.setClock({year=2017,month=2,day=14,hour=14,min=2,sec=58})
getClock ()
获取系统时间

Returns:

  • table time,{year=2017,month=2,day=14,hour=14,min=19,sec=23}

Usage:

  • time = getClock()
getWeek ()
获取星期

Returns:

  • number week,1-7分别对应周一到周日

Usage:

  • week = misc.getWeek()
getCalib ()
获取校准标志

Returns:

  • bool calib, true表示已校准,false或者nil表示未校准

Usage:

  • calib = misc.getCalib()
setSn (s[, cbFnc=nil])
设置SN

Parameters:

  • s string
    新sn的字符串
  • cbFnc function [此参数可选,默认值为: nil]
    设置结果回调函数,回调函数的调用形式为:
     cnFnc(result),result为true表示成功,false或者nil为失败

Returns:

  • nil

Usage:

  • misc.setSn("1234567890")
    misc.setSn("1234567890",cbFnc)
getSn ()
获取模块序列号

Returns:

  • string sn,序列号,如果未获取到返回""
     注意:开机lua脚本运行之后,会发送at命令去查询sn,所以需要一定时间才能获取到sn。开机后立即调用此接口,基本上返回""

Usage:

  • sn = misc.getSn()
setImei (s[, cbFnc=nil])
设置IMEI

Parameters:

  • s string
    新IMEI字符串
  • cbFnc function [此参数可选,默认值为: nil]
    设置结果回调函数,回调函数的调用形式为:
     cnFnc(result),result为true表示成功,false或者nil为失败

Returns:

  • nil

Usage:

  • misc.setImei(”359759002514931”)
getImei ()
获取模块IMEI

Returns:

  • string,IMEI号,如果未获取到返回""
     注意:开机lua脚本运行之后,会发送at命令去查询imei,所以需要一定时间才能获取到imei。开机后立即调用此接口,基本上返回""

Usage:

  • imei = misc.getImei()
getVbatt ()
获取VBAT的电池电压

Returns:

  • number,电池电压,单位mv

Usage:

  • vb = getVbatt()
getVbus ()
获取VBUS连接状态

Returns:

  • boolean,true表示VBUS连接,false表示未连接

Usage:

  • vbus = getVbus()
getMuid ()
获取模块MUID

Returns:

  • string,MUID号,如果未获取到返回""
     注意:开机lua脚本运行之后,会发送at命令去查询muid,所以需要一定时间才能获取到muid。开机后立即调用此接口,基本上返回""

Usage:

  • muid = misc.getMuid()
openPwm (id, para1, para2)
打开并且配置PWM(支持2路PWM,仅支持输出)

Parameters:

  • id number
    PWM输出通道,仅支持0和1
     0使用MODULE_STATUS/GPIO_5引脚
     1使用GPIO_13引脚,注意:上电的时候不要把 GPIO_13 拉高到V_GLOBAL_1V8,否则模块会进入校准模式,不正常开机
  • para1 number
     当id为0时,para1表示分频系数,最大值为1024;分频系数和频率的换算关系为:频率=25000000/para1;例如para1为500时,频率为50000Hz
     当id为1时,para1表示时钟周期,取值范围为0-7,仅支持整数
                                             0-7分别对应125、250、500、1000、1500、2000、2500、3000毫秒
  • para2 number
     当id为0时,para2表示占空比计算系数,最大值为512;占空比计算系数和占空比的计算关系为:占空比=para2/para1
     当id为1时,para2表示一个时钟周期内的高电平时间,取值范围为1-15,仅支持整数
                                                               1-15分别对应15.6、31.2、46.8、62、78、94、110、125、140、156、172、188、200、218、234毫秒

Returns:

  • nil

Usage:

  • 通道0,频率为50000Hz,占空比为0.2:
    misc.openPwm(0,500,100)
    
    通道1,时钟周期为500ms,高电平时间为125毫秒:
    misc.openPwm(1,2,8)
closePwm (id)
关闭PWM

Parameters:

  • id number
    PWM输出通道,仅支持0和1
     0使用MODULE_STATUS/GPIO_5引脚
     1使用GPIO_13引脚,注意:上电的时候不要把 GPIO_13 拉高到V_GLOBAL_1V8,否则模块会进入校准模式,不正常开机

Returns:

  • nil
generated by LDoc 1.4.6 Last updated 2020-10-30 13:25:18