Module gpsv3

模块功能:GPS模块管理

Info:

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

Functions

close () 关闭GPS
restart (r) 重启GPS模块
noLog (v) 关闭日志开关
setReport (tm) 设置NMEA消息上报的间隔
isOpen () 获取GPS模块是否处于开启状态
isFix () 获取GPS模块是否定位成功
getMaxCno () 获取GSV解析后的最大Cno
getSateSn () 获取所有可用卫星号
getBDGsv () 获取BDGSV解析结果
getGPGsv () 获取GPGSV解析结果
sumViewSate () 统计GSA语句中的可见卫星数量
sumUsedSate () 获取定位使用的卫星个数
getUtcTime () 获取RMC语句中的UTC时间
getDop () 获取位置,水平,垂直精度
getSep () 获取定位使用的大地高 地球椭球面相对大地水准面的高度
getAltitude () 获取海拔
getAzimuth () 获取方向角
getSpeed () 获取速度
getCentLocation () 获取度分格式的经纬度信息ddmm.mmmm
getIntLocation () 获取返回值为度的10^7方的整数值(度*10^7的值)
getDegLocation () 获取度格式的经纬度信息dd.dddddd
getAllMsg () 获取打包的GPS信息 return number,定位成功1,失败0, 经度,纬度,速度,海拔,方位角度,定位卫星数量,可见卫星数量,最大信噪比,UTC时间戳


Functions

close ()
关闭GPS

Returns:

Usage:

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

Parameters:

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

Returns:

Usage:

  • gpsv3.restart()
noLog (v)
关闭日志开关

Parameters:

  • v
     boolean值 true 表示关闭,其他表示打开

Returns:

Usage:

  • gpsv3.noLog(true)
setReport (tm)
设置NMEA消息上报的间隔

Parameters:

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

Returns:

Usage:

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

Returns:

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

Usage:

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

Returns:

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

Usage:

  • gpsv3.isFix()
getMaxCno ()
获取GSV解析后的最大Cno

Returns:

  • number,Cno 最大值

Usage:

  • gpsv3.getMaxCno()
getSateSn ()
获取所有可用卫星号

Returns:

  • table 卫星号的数组

Usage:

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

Returns:

  • table, GSV解析后的数组

Usage:

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

Returns:

  • table, GSV解析后的数组

Usage:

  • gpsv3.getGPGsv()
sumViewSate ()
统计GSA语句中的可见卫星数量

Returns:

  • number, 可见卫星数量

Usage:

  • gpsv3.sumViewSate()
sumUsedSate ()
获取定位使用的卫星个数

Returns:

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

Usage:

  • gpsv3.sumUsedSate()
getUtcTime ()
获取RMC语句中的UTC时间

Returns:

  • number utc 时间戳

Usage:

  • gpsv3.getUtcTime()
getDop ()
获取位置,水平,垂直精度

Returns:

  • number 多参数 pdop,hdop,vodp

Usage:

  • gpsv3.getDop()
getSep ()
获取定位使用的大地高
 地球椭球面相对大地水准面的高度

Returns:

  • number sep,大地高

Usage:

  • gpsv3.getSep()
getAltitude ()
获取海拔

Returns:

  • number altitude,海拔,单位米

Usage:

  • gpsv3.getAltitude()
getAzimuth ()
获取方向角

Returns:

  • number Azimuth,方位角

Usage:

  • gpsv3.getAzimuth()
getSpeed ()
获取速度

Returns:

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

Usage:

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

Returns:

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

Usage:

  • gpsv3.getCentLocation()
getIntLocation ()
获取返回值为度的10^7方的整数值(度*10^7的值)

Returns:

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

Usage:

  • gpsv2.getIntLocation()
getDegLocation ()
获取度格式的经纬度信息dd.dddddd

Returns:

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

Usage:

  • gpsv2.getLocation()
getAllMsg ()
获取打包的GPS信息
 return number,定位成功1,失败0, 经度,纬度,速度,海拔,方位角度,定位卫星数量,可见卫星数量,最大信噪比,UTC时间戳

Usage:

  • local fix,lng,lat,speed,alt = getAllMsg()
  • local fix,lng,lat,speed,alt,azi,used,view,cno = getAllMsg()
generated by LDoc 1.4.6 Last updated 2019-11-19 10:46:53