Module gpsv2

模块功能：GPS模块管理

Info:

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

Functions

open (id, baudrate, sleepTm, fnc) 打开GPS模块
close (fnc) 关闭GPS模块
restart (r) 重启GPS模块
setAerialMode (gps, beidou, glonass, galieo) 设置GPS模块搜星模式.
setRunMode (mode, runTm, sleepTm) 设置GPS模块的运行模式.
setReport (tm) 设置NMEA消息上报的间隔
isOpen () 获取GPS模块是否处于开启状态
isFix () 获取GPS模块是否定位成功
getIntLocation () 获取返回值为度的10&7方的整数值（度*10^7的值）
getDeglbs () 获取基站定位的经纬度信息dd.dddd
getDegLocation () 获取度格式的经纬度信息dd.dddddd
getCentLocation () 获取度分格式的经纬度信息ddmm.mmmm
getAltitude () 获取海拔
getSpeed () 获取速度
getKmHour () 获取时速(KM/H)的整数型和浮点型(字符串)
getAzimuth () 获取方向角
getViewedSateCnt () 获取可见卫星的个数
getUsedSateCnt () 获取定位使用的卫星个数
getUtcTime () 获取RMC语句中的UTC时间 只有同时满足如下两个条件，返回值才有效 1、开启了GPS，并且定位成功 2、调用setParseItem接口，第一个参数设置为true
getSep () 获取定位使用的大地高
getSateSn () 获取GSA语句中的可见卫星号 只有同时满足如下两个条件，返回值才有效 1、开启了GPS，并且定位成功 2、调用setParseItem接口，第三个参数设置为true
getBDGsv () 获取BDGSV解析结果
getGPGsv () 获取GPGSV解析结果
getCno () 获取GPSGSV解析后的CNO数据
openLog (v) 是否显示日志


Functions

open (id, baudrate, sleepTm, fnc) 
打开GPS模块

Parameters:

  • id number 
    UART ID，支持1和2，1表示UART1，2表示UART2
  • baudrate number 
    波特率，支持1200,2400,4800,9600,10400,14400,19200,28800,38400,57600,76800,115200,230400,460800,576000,921600,1152000,4000000
  • sleepTm number 
    间隔唤醒的时间 秒
  • fnc 
    外部模块使用的电源管理函数

Returns:

  • 无

Usage:

  • gpsv2.open()
  • gpsv2.open(2, 115200, 0, 1)  -- 打开GPS，串口2，波特率115200，正常功耗模式，1秒1个点
  • gpsv2.open(2, 115200, 2, 5) -- 打开GPS，串口2，波特率115200，周期低功耗模式1秒输出，5秒睡眠
close (fnc) 
关闭GPS模块

Parameters:

  • fnc 
    外部模块使用的电源管理函数

Returns:

  • 无

Usage:

  • gpsv2.close()
restart (r) 
重启GPS模块

Parameters:

  • r number 
    重启方式-0:外部电源重置; 1:热启动; 2:温启动; 3:冷启动

Returns:

  • 无

Usage:

  • gpsv2.restart()
setAerialMode (gps, beidou, glonass, galieo) 
设置GPS模块搜星模式.
 如果使用的是Air800或者Air530，不调用此接口配置，则默认同时开启GPS和北斗定位

Parameters:

  • gps number 
    GPS定位系统，1是打开，0是关闭
  • beidou number 
    中国北斗定位系统，1是打开，0是关闭
  • glonass number 
    俄罗斯Glonass定位系统，1是打开，0是关闭
  • galieo number 
    欧盟伽利略定位系统，1是打开，0是关闭

Returns:

  • nil

Usage:

  • gpsv2.setAeriaMode(1,1,0,0)
setRunMode (mode, runTm, sleepTm) 
设置GPS模块的运行模式.
 如果不调用此接口配置，则默认为正常运行模式

Parameters:

  • mode number 
    运行模式
 0：正常运行模式
 1：周期超低功耗跟踪模式
 2：周期低功耗模式
 4：直接进入超低功耗跟踪模式
 8：自动低功耗模式，可以通过串口唤醒
 9：自动超低功耗跟踪模式，需要force on来唤醒
  • runTm number 
    单位毫秒，mode为1或者2时表示运行时长，其余mode时此值无意义
  • sleepTm number 
    单位毫秒，mode为1或者2时表示睡眠时长，其余mode时此值无意义

Returns:

  • nil

Usage:

  • gpsv2.setRunMode(0,1000)
  • gpsv2.setRunMode(1,5000,2000)
setReport (tm) 
设置NMEA消息上报的间隔

Parameters:

  • tm number 
    上报消息的间隔时间

Returns:

  • 无

Usage:

  • gpsv2.setReport(tm)
isOpen () 
获取GPS模块是否处于开启状态

Returns:

  • bool result，true表示开启状态，false或者nil表示关闭状态

Usage:

  • gpsv2.isOpen()
isFix () 
获取GPS模块是否定位成功

Returns:

  • bool result，true表示定位成功，false或者nil表示定位失败

Usage:

  • gpsv2.isFix()
getIntLocation () 
获取返回值为度的10&7方的整数值（度*10^7的值）

Returns:

  • number,number,INT32整数型,经度,维度,符号(正东负西,正北负南)

Usage:

  • gpsv2.getIntLocation()
getDeglbs () 
获取基站定位的经纬度信息dd.dddd
getDegLocation () 
获取度格式的经纬度信息dd.dddddd

Returns:

  1. string,string,固件为非浮点时返回度格式的字符串经度,维度,符号(正东负西,正北负南)
  2. float,float,固件为浮点的时候，返回浮点类型

Usage:

  • gpsv2.getLocation()
getCentLocation () 
获取度分格式的经纬度信息ddmm.mmmm

Returns:

  • string,string,返回度格式的字符串经度,维度,符号(正东负西,正北负南)

Usage:

  • gpsv2.getCentLocation()
getAltitude () 
获取海拔

Returns:

  • number altitude，海拔，单位米

Usage:

  • gpsv2.getAltitude()
getSpeed () 
获取速度

Returns:

  1. number kmSpeed，第一个返回值为公里每小时的速度
  2. number nmSpeed，第二个返回值为海里每小时的速度

Usage:

  • gpsv2.getSpeed()
getKmHour () 
获取时速(KM/H)的整数型和浮点型(字符串)
getAzimuth () 
获取方向角

Returns:

  • number Azimuth，方位角

Usage:

  • gpsv2.getAzimuth()
getViewedSateCnt () 
获取可见卫星的个数

Returns:

  • number count，可见卫星的个数

Usage:

  • gpsv2.getViewedSateCnt()
getUsedSateCnt () 
获取定位使用的卫星个数

Returns:

  • number count，定位使用的卫星个数

Usage:

  • gpsv2.getUsedSateCnt()
getUtcTime () 
获取RMC语句中的UTC时间
 只有同时满足如下两个条件，返回值才有效
 1、开启了GPS，并且定位成功
 2、调用setParseItem接口，第一个参数设置为true

Returns:

  • table utcTime，UTC时间，nil表示无效，例如{year=2018,month=4,day=24,hour=11,min=52,sec=10}

Usage:

  • gpsv2.getUtcTime()
getSep () 
获取定位使用的大地高

Returns:

  • number sep，大地高

Usage:

  • gpsv2.getSep()
getSateSn () 
获取GSA语句中的可见卫星号
 只有同时满足如下两个条件，返回值才有效
 1、开启了GPS，并且定位成功
 2、调用setParseItem接口，第三个参数设置为true

Returns:

  • string viewedSateId，可用卫星号，""表示无效

Usage:

  • gpsv2.getSateSn()
getBDGsv () 
获取BDGSV解析结果

Returns:

  • table, GSV解析后的数组

Usage:

  • gpsv2.getBDGsv()
getGPGsv () 
获取GPGSV解析结果

Returns:

  • table, GSV解析后的数组

Usage:

  • gpsv2.getGPGsv()
getCno () 
获取GPSGSV解析后的CNO数据
openLog (v) 
是否显示日志

Parameters:

  • v 
    
        
    • 
    













 

 


generated by LDoc 1.4.6
Last updated 2019-10-22 16:00:46