src/gps.pod

   1 =encoding UTF-8
   2
   3 =head1 NAME
   4
   5 gps - Documentation of collectd's C<gps plugin>
   6
   7 =head1 SYNOPSIS
   8
   9 LoadPlugin gps
  10 <Plugin "gps">
  11   # Connect to localhost on gpsd regular port:
  12   Host "127.0.0.1"
  13   Port "2947"
  14   # 15 seconds timeout
  15   Timeout 15
  16   # Pause of 1 second between readings:
  17   Pause 1
  18 </Plugin>
  19
  20
  21 =head1 DESCRIPTION
  22
  23 The C<gps plugin> connects to gpsd on the host machine.
  24 The host, port, timeout and pause are configurable.
  25
  26 This is useful if you run an NTP server using a GPS for source and you want to monitor it.
  27
  28 Mind your GPS must send $--GSA for having the data reported !
  29
  30
  31 =head1 OPTIONS
  32
  33 =over 4
  34
  35 =item B<Host>
  36
  37 The host on which gpsd runs (default localhost).
  38
  39 =item B<Port>
  40
  41 Port to connect to gpsd on the host machine (with quotes), (default 2947).
  42
  43 =item B<Timeout>
  44
  45 Timeout in seconds (default 15 sec).
  46
  47 =item B<Pause>
  48
  49 Pause to apply between readings in seconds (default 1 sec).
  50
  51 =back
  52
  53 =head1 NOTIFICATION DATA FORMAT
  54
  55 =over 4
  56
  57 =item B<satellites>
  58
  59 Number of satellites in view.
  60 0 means no GPS are visible.
  61
  62 =item B<dilution_of_precision>
  63
  64 Vertical or horizontal dilution.
  65 It should be between 0 and 3.
  66 Look at the documentaiton of your GPS to know more.
  67
  68
  69 =head1 SEE ALSO
  70
  71 L<collectd(1)>,
  72 L<collectd.conf(5)>,
  73 gpsd
  74
  75 =head1 AUTHOR
  76
  77 Nicolas JOURDEN E<lt>nicolas.jourden at laposte.netE<gt>
  78
  79 =cut