gpsZkw¶
gpsZkw¶
模块功能：GPS模块管理
-- 注意：此功能模块中的功能接口可以分为四大类：
-- 1、GPS开启
-- 2、GPS关闭
-- 3、GPS定位数据读取
-- 4、GPS参数和功能设置
-- 1、2、3是通用功能，除了支持合宙的Air530Z和Air82X系列模块，理论上也支持其他厂家的串口GPS模块
-- 4是专用功能，仅支持合宙的Air530Z和Air82X系列模块
gpsZkw.DEFAULT¶
常量值，GPS应用模式1.
打开GPS后，GPS定位成功时，如果有回调函数，会调用回调函数
使用此应用模式调用gps.open打开的“GPS应用”，必须主动调用gps.close或者gps.closeAll才能关闭此“GPS应用”,主动关闭时，即使有回调函数，也不会调用回调函数
gpsZkw.TIMERORSUC¶
常量值，GPS应用模式2.
打开GPS后，如果在GPS开启最大时长到达时，没有定位成功，如果有回调函数，会调用回调函数，然后自动关闭此“GPS应用”
打开GPS后，如果在GPS开启最大时长内，定位成功，如果有回调函数，会调用回调函数，然后自动关闭此“GPS应用”
打开GPS后，在自动关闭此“GPS应用”前，可以调用gps.close或者gps.closeAll主动关闭此“GPS应用”，主动关闭时，即使有回调函数，也不会调用回调函数
gpsZkw.TIMER¶
常量值，GPS应用模式3.
打开GPS后，在GPS开启最大时长时间到达时，无论是否定位成功，如果有回调函数，会调用回调函数，然后自动关闭此“GPS应用”
打开GPS后，在自动关闭此“GPS应用”前，可以调用gps.close或者gps.closeAll主动关闭此“GPS应用”，主动关闭时，即使有回调函数，也不会调用回调函数
gpsZkw.open(mode, para)¶
打开一个“GPS应用”
“GPS应用”：指的是使用GPS功能的一个应用例如，假设有如下3种需求，要打开GPS，则一共有3个“GPS应用”：“GPS应用1”：每隔1分钟打开一次GPS“GPS应用2”：设备发生震动时打开GPS“GPS应用3”：收到一条特殊短信时打开GPS只有所有“GPS应用”都关闭了，才会去真正关闭GPS每个“GPS应用”打开或者关闭GPS时，最多有4个参数，其中 GPS应用模式和GPS应用标记 共同决定了一个唯一的“GPS应用”：1、GPS应用模式(必选)2、GPS应用标记(必选)3、GPS开启最大时长[可选]4、回调函数[可选]例如gps.open(gps.TIMERORSUC,{tag=“TEST”,val=120,cb=testGpsCb})gps.TIMERORSUC为GPS应用模式，“TEST”为GPS应用标记，120秒为GPS开启最大时长，testGpsCb为回调函数
参数
传入值类型 |
释义 |
|---|---|
number |
mode，GPS应用模式，支持gps.DEFAU LT，gps.TIMERORSUC，gps.TIMER三种 |
param |
para，table类型，GPS应用参数para .tag：string类型，GPS应用标记para .val：number类型，GPS应用开启最大 时长，mode参数为gps.TIMERORSUC或 者gps.TIMER时，此值才有意义para. cb：GPS应用结束时的回调函数，回调 函数的调用形式为para.cb(para.tag) |
返回值
nil
例子
gps.open(gps.DEFAULT,{tag="TEST1",cb=test1Cb})
gps.open(gps.TIMERORSUC,{tag="TEST2",val=60,cb=test2Cb})
gps.open(gps.TIMER,{tag="TEST3",val=120,cb=test3Cb})
--另见：DEFAULT,TIMERORSUC,TIMER
gpsZkw.close(mode, para)¶
关闭一个“GPS应用”
只是从逻辑上关闭一个GPS应用，并不一定真正关闭GPS，是有所有的GPS应用都处于关闭状态，才回去真正关闭GPS
参数
传入值类型 |
释义 |
|---|---|
number |
mode，GPS应用模式，支持gps.DEFAU LT，gps.TIMERORSUC，gps.TIMER三种 |
param |
p ara，table类型，GPS应用参数para.t ag：string类型，GPS应用标记para.v al：number类型，GPS应用开启最大时 长，mode参数为gps.TIMERORSUC或者g ps.TIMER时，此值才有意义；使用clo se接口时，不需要传入此参数para.cb ：GPS应用结束时的回调函数，回调函 数的调用形式为para.cb(para.tag)； 使用close接口时，不需要传入此参数 |
返回值
nil
例子
GPS应用模式和GPS应用标记唯一确定一个“GPS应用”，调用本接口关闭时，mode和para.tag要和gps.open打开一个“GPS应用”时传入的mode和para.tag保持一致
gps.close(gps.DEFAULT,{tag="TEST1"})
gps.close(gps.TIMERORSUC,{tag="TEST2"})
gps.close(gps.TIMER,{tag="TEST3"})
--另见：open,DEFAULT,TIMERORSUC,TIMER
gpsZkw.isActive(mode, para)¶
判断一个“GPS应用”是否处于激活状态
参数
传入值类型 |
释义 |
|---|---|
number |
mode，GPS应用模式，支持gps.DEFAU LT，gps.TIMERORSUC，gps.TIMER三种 |
param |
para，ta ble类型，GPS应用参数para.tag：str ing类型，GPS应用标记para.val：num ber类型，GPS应用开启最大时长，mod e参数为gps.TIMERORSUC或者gps.TIME R时，此值才有意义；使用isActive接 口时，不需要传入此参数para.cb：GP S应用结束时的回调函数，回调函数的 调用形式为para.cb(para.tag)；使用 isActive接口时，不需要传入此参数 |
返回值
bool result，处于激活状态返回true，否则返回nil
例子
GPS应用模式和GPS应用标记唯一确定一个“GPS应用”，调用本接口查询状态时，mode和para.tag要和gps.open打开一个“GPS应用”时传入的mode和para.tag保持一致
gps.isActive(gps.DEFAULT,{tag="TEST1"})
gps.isActive(gps.TIMERORSUC,{tag="TEST2"})
gps.isActive(gps.TIMER,{tag="TEST3"})
--另见：open,DEFAULT,TIMERORSUC,TIMER
gpsZkw.setPowerCbFnc(cbFnc)¶
设置GPS模块供电控制的回调函数
如果使用的是Air800，或者供电控制使用的是LDO_VCAM，则打开GPS应用前不需要调用此接口进行设置否则在调用gps.open前，使用此接口，传入自定义的供电控制函数cbFnc，GPS开启时，gps.lua自动执行cbFnc(true)，GPS关闭时，gps.lua自动执行cbFnc(false)
参数
传入值类型 |
释义 |
|---|---|
param |
cbFnc，function类型，用户自定义的GPS供电控制函数 |
返回值
nil
例子
gps.setPowerCbFnc(cbFnc)
gpsZkw.setUart(id, baudrate, databits, parity, stopbits)¶
设置GPS模块和GSM模块之间数据通信的串口参数
如果使用的是Air800，或者使用的UART2(波特率115200，数据位8，无检验位，停止位1)，则打开GPS应用前不需要调用此接口进行设置否则在调用gps.open前，使用此接口，传入UART参数
参数
传入值类型 |
释义 |
|---|---|
number |
id，UART ID， 支持1和2，1表示UART1，2表示UART2 |
number |
ba udrate，波特率，支持1200,2400,480 0,9600,10400,14400,19200,28800,38 400,57600,76800,115200,230400,460 800,576000,921600,1152000,4000000 |
number |
databits，数据位，支持7,8 |
number |
parity，校验位，支持uart.PA R_NONE,uart.PAR_EVEN,uart.PAR_ODD |
number |
stopbits，停 止位，支持uart.STOP_1,uart.STOP_2 |
返回值
nil
例子
gps.setUart(2,115200,8,uart.PAR_NONE,uart.STOP_1)
gpsZkw.setAerialMode(gps, beidou, glonass)¶
设置GPS模块搜星模式.
如果使用的是Air820，不调用此接口配置，则默认同时开启GPS、北斗和glonass定位
参数
传入值类型 |
释义 |
|---|---|
number |
gps，GPS定位系统，1是打开，0是关闭 |
number |
beidou，中国北斗定位系统，1是打开，0是关闭 |
number |
glonass，俄罗斯Glonass定位系统，1是打开，0是关闭 |
返回值
nil
例子
gps.setAeriaMode(1,1,0)
gpsZkw.setNmeaMode(mode, cbFnc)¶
设置NMEA数据处理模式.
如果不调用此接口配置，则默认仅gps.lua内部处理NMEA数据
参数
传入值类型 |
释义 |
|---|---|
number |
mode，NMEA数据处理模式，0表示仅gps.lua内部 处理，1表示仅用户自己处理，2表示gps.lua和用户同时处理 |
param |
cbFnc，function类型，用户 处理一条NMEA数据的回调函数，mode为1和2时，此值才有意义 |
返回值
nil
例子
gps.setNmeaMode(0)
gps.setNmeaMode(1,cbFnc)
gps.setNmeaMode(2,cbFnc)
gpsZkw.setRunMode(mode, runTm, sleepTm)¶
设置GPS模块的运行模式.
如果不调用此接口配置，则默认为正常运行模式
参数
传入值类型 |
释义 |
|---|---|
number |
m ode，运行模式0：正常运行模式1：周 期超低功耗跟踪模式2：周期低功耗模 式4：直接进入超低功耗跟踪模式8： 自动低功耗模式，可以通过串口唤醒9 ：自动超低功耗跟踪模式，需要force on来唤醒 |
number |
runTm，单位毫秒，mode为0时表示NEM A数据的上报间隔，mode为1或者2时表 示运行时长，其余mode时此值无意义 |
number |
sl eepTm，单位毫秒，mode为1或者2时表 示运行时长，其余mode时此值无意义 |
返回值
nil
例子
gps.setRunMode(0,1000)
gps.setRunMode(1,5000,2000)
gpsZkw.setNemaReportFreq(rmc, gga, gsa, gsv, vtg, gll)¶
设置NEMA语句的输出频率.
参数
传入值类型 |
释义 |
|---|---|
number |
可选参数，默认为``1``，rmc，单位秒 ，RMC语句输出频率，取值范围0到9之间的整数，0表示不输出 |
number |
可选参数，默认为``1``，gga，单位秒 ，GGA语句输出频率，取值范围0到9之间的整数，0表示不输出 |
number |
可选参数，默认为``1``，gsa，单位秒 ，GSA语句输出频率，取值范围0到9之间的整数，0表示不输出 |
number |
可选参数，默认为``1``，gsv，单位秒 ，GSV语句输出频率，取值范围0到9之间的整数，0表示不输出 |
number |
可选参数，默认为``0``，vtg，单位秒 ，VTG语句输出频率，取值范围0到9之间的整数，0表示不输出 |
number |
可选参数，默认为``0``，gll，单位秒 ，GLL语句输出频率，取值范围0到9之间的整数，0表示不输出 |
返回值
nil
例子
gps.setNemaReportFreq(5,0,0,0,0,0)
gpsZkw.setLocationFilter(seconds)¶
设置GPS定位成功后经纬度的过滤时间.
参数
传入值类型 |
释义 |
|---|---|
number |
可选参数，默认为``0``，sec onds，单位秒，GPS定位成功后，丢弃前seconds秒的位置信息 |
返回值
nil
例子
gps.setLocationFilter(2)
gpsZkw.getLocation(typ)¶
获取度格式的经纬度信息
参数
传入值类型 |
释义 |
|---|---|
string |
可选参 数，默认为``nil``，typ，返回的经纬度格式，typ为 “DEGREE_MINUTE”时表示返回度分格式，其余表示返回度格式 |
返回值
table location例如typ为“DEGREE_MINUTE”时返回{lngType=“E”,lng=“12128.44954”,latType=“N”,lat=“3114.50931”}例如typ不是“DEGREE_MINUTE”时返回{lngType=“E”,lng=“121.123456”,latType=“N”,lat=“31.123456”}lngType：string类型，表示经度类型，取值“E”，“W”lng：string类型，表示度格式的经度值，无效时为”“latType：string类型，表示纬度类型，取值”N“，”S“lat：string类型，表示度格式的纬度值，无效时为””
例子
gps.getLocation()
gpsZkw.getSpeed()¶
获取速度
参数
无
返回值
number kmSpeed，第一个返回值为公里每小时的速度 number nmSpeed，第二个返回值为海里每小时的速度
例子
gps.getSpeed()
gpsZkw.getGgaloc()¶
获取GGA语句中度分格式的经纬度信息
参数
无
返回值
string lng，度分格式的经度值(dddmm.mmmm)，西经会添加一个-前缀，无效时为”“；例如”12112.3456“表示东经121度12.3456分，”-12112.3456“表示西经121度12.3456分 string lat，度分格式的纬度值(ddmm.mmmm)，南纬会添加一个-前缀，无效时为”“；例如”3112.3456“表示北纬31度12.3456分，”-3112.3456”表示南纬31度12.3456分
例子
gps.getGgaloc()
gpsZkw.getUtcTime()¶
获取RMC语句中的UTC时间
只有同时满足如下两个条件，返回值才有效1、开启了GPS，并且定位成功2、调用setParseItem接口，第一个参数设置为true
参数
无
返回值
table utcTime，UTC时间，nil表示无效，例如{year=2018,month=4,day=24,hour=11,min=52,sec=10}
例子
gps.getUtcTime()
gpsZkw.getSateSn()¶
获取GSA语句中的可见卫星号
只有同时满足如下两个条件，返回值才有效1、开启了GPS，并且定位成功2、调用setParseItem接口，第三个参数设置为true
参数
无
返回值
string viewedSateId，可用卫星号，””表示无效
例子
gps.getSateSn()
gpsZkw.getGsv()¶
获取GSV语句中的可见卫星的信噪比
只有同时满足如下两个条件，返回值才有效1、开启了GPS，并且定位成功2、调用setParseItem接口，第二个参数设置为true
参数
无
返回值
string gsv，信噪比
例子
gps.getGsv()
gpsZkw.setParseItem(utcTime, gsv, gsaId)¶
设置是否需要解析的字段
参数
传入值类型 |
释义 |
|---|---|
bool |
可选参数，默认为``nil``，utcTime，是否解 析RMC语句中的UTC时间，true表示解析，false或者nil不解析 |
bool |
可选参数，默认为``nil``， gsv，是否解析GSV语句，true表示解析，false或者nil不解析 |
bool |
可选参数，默认为``nil``，gsaId，是否解 析GSA语句中的卫星ID，true表示解析，false或者nil不解析 |
返回值
无
例子
gps.setParseItem(true,true,true)