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   # See collectd.conf(5)
  10   LoadPlugin gps
  11   <Plugin "gps">
  12     Host "localhost"
  13     Port "2947"
  14     Timeout 1000
  15   </Plugin>
  16
  17 =head1 DESCRIPTION
  18
  19 The C<gps plugin> connects to gpsd on the host machine.
  20 The port and the timeout are configurable.
  21
  22
  23 =head1 OPTIONS
  24
  25 =over 4
  26
  27 =item B<Host>
  28
  29 The host on which gpsd runs.
  30
  31 =item B<Port>
  32
  33 Port to connect to gpsd on the host machine.
  34
  35 =item B<Timeout>
  36
  37 Timeout in ms.
  38
  39 =back
  40
  41 =head1 NOTIFICATION DATA FORMAT
  42
  43 =over 4
  44
  45 =item B<gps_sat>
  46
  47 Number of satelites in view.
  48 0 means no GPS are visible.
  49
  50 =item B<gps_hdop>
  51
  52 Horizontal dilution.
  53 It should be between 0 and 3.
  54 Look at the documentaiton of your GPS.
  55
  56 =item B<gps_vdop>
  57
  58 Vertical dilution.
  59 Same as above.
  60
  61 =head1 SEE ALSO
  62
  63 L<collectd(1)>,
  64 L<collectd.conf(5)>,
  65 gpsd
  66
  67 =head1 AUTHOR
  68
  69 Nicolas Jourden E<lt>nicolas.jourden@laposte.netE<gt>
  70
  71 =cut