gps plugin¶

See this section in the full configuration reference

The gps plugin connects to gpsd on the host machine. The host, port, timeout and pause are configurable.

This is useful if you run an NTP server using a GPS for source and you want to monitor it.

Mind your GPS must send $--GSA for having the data reported!

The following elements are collected:

satellites

Number of satellites used for fix (type instance "used") and in view (type instance "visible"). 0 means no GPS satellites are visible.

dilution_of_precision

Vertical and horizontal dilution (type instance "horizontal" or "vertical"). It should be between 0 and 3. Look at the documentation of your GPS to know more.

Synopsis:

LoadPlugin gps
<Plugin "gps">
  # Connect to localhost on gpsd regular port:
  Host "127.0.0.1"
  Port "2947"
  # 15 ms timeout
  Timeout 0.015
  # PauseConnect of 5 sec. between connection attempts.
  PauseConnect 5
</Plugin>

Available configuration options:

Host Host

The host on which gpsd daemon runs. Defaults to localhost.

Port Port

Port to connect to gpsd on the host machine. Defaults to 2947.

Timeout Seconds

Timeout in seconds (default 0.015 sec).

The GPS data stream is fetch by the plugin form the daemon. It waits for data to be available, if none arrives it times out and loop for another reading. Mind to put a low value gpsd expects value in the micro-seconds area (recommended is 500 us) since the waiting function is blocking. Value must be between 500 us and 5 sec., if outside that range the default value is applied.

This only applies from gpsd release-2.95.

PauseConnect Seconds

Pause to apply between attempts of connection to gpsd in seconds (default 5 sec).