GPS Receiver Metrics

For setup and configuration, see GPS Receiver.

Provided by the gps subagent for a serial GPS receiver producing NMEA sentences. Metrics return the latest parsed values and do not initiate a read from the receiver. Old values remain available after serial communication stops; check GPS.Fix, GPS.QualityIndicator, and the timestamp in GPS.LocationData before relying on a position.

GPS.Direction

Ground track angle in degrees relative to true north.

Data Type

Float

Platforms

Windows, UNIX-like systems

GPS.Elevation

Antenna altitude above or below mean sea level in meters.

Data Type

Float

Platforms

Windows, UNIX-like systems

GPS.Fix

Operating mode: 1 = no fix, 2 = 2D fix, 3 = 3D fix.

Data Type

Integer

Platforms

Windows, UNIX-like systems

GPS.HDOP

Horizontal dilution of precision reported by the NMEA parser.

Data Type

Float

Platforms

Windows, UNIX-like systems

GPS.Latitude

Latitude in decimal degrees; negative values are south of the equator.

Data Type

Float

Platforms

Windows, UNIX-like systems

GPS.LatitudeText

Latitude as text in degrees, minutes, and seconds with the hemisphere letter, for example 56°56'51.000"N.

Data Type

String

Platforms

Windows, UNIX-like systems

GPS.Location

Formatted latitude and longitude separated by a space.

Data Type

String

Platforms

Windows, UNIX-like systems

GPS.LocationData

Comma-separated fields: quality indicator, fix, latitude, longitude, accuracy in meters, elevation in meters, speed in km/h, direction in degrees, HDOP, and UNIX timestamp. Accuracy is the integer part of HDOP * UERE. The timestamp is agent time when a supported NMEA sentence was parsed, including satellite or velocity sentences that do not update the coordinates. It is not the time of the last valid position fix.

Data Type

String

Platforms

Windows, UNIX-like systems

GPS.Longitude

Longitude in decimal degrees; negative values are west of Greenwich.

Data Type

Float

Platforms

Windows, UNIX-like systems

GPS.LongitudeText

Longitude as text in degrees, minutes, and seconds with the hemisphere letter, for example 24°06'21.000"E.

Data Type

String

Platforms

Windows, UNIX-like systems

GPS.QualityIndicator

Position quality value maintained by the NMEA parser. A value of 0 indicates an invalid position. GGA data supplies its quality field; RMC data can set this value to 2 for an active position or 0 for a void position.

Data Type

Integer

Platforms

Windows, UNIX-like systems

GPS.Satellites.InUse

Number of satellites used for the position fix.

Data Type

Integer

Platforms

Windows, UNIX-like systems

GPS.Satellites.InView

Number of satellites in view.

Data Type

Integer

Platforms

Windows, UNIX-like systems

GPS.Speed

Speed over the ground in kilometers per hour.

Data Type

Float

Platforms

Windows, UNIX-like systems

GPS.SerialConfig

Configured Device string, as supplied in [GPS]; this is not a live serial-port health check.

Data Type

String

Platforms

Windows, UNIX-like systems

GPS.VDOP

Vertical dilution of precision reported by the NMEA parser.

Data Type

Float

Platforms

Windows, UNIX-like systems