xref: /freebsd/contrib/ntp/html/drivers/driver20.html (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
3<html>
4
5    <head>
6        <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
7        <meta name="GENERATOR" content="Mozilla/4.76 [en] (X11; U; Linux 2.2.16-22 i586) [Netscape]">
8        <title>Generic NMEA GPS Receiver</title>
9        <link href="../scripts/style.css" type="text/css" rel="stylesheet">
10    </head>
11
12    <body>
13        <h3>Generic NMEA GPS Receiver</h3>
14        <hr>
15        <h4>Synopsis</h4>
16        <p>Address: 127.127.20.<i>u</i><br>
17            Reference ID: <tt>GPS</tt><br>
18            Driver ID: <tt>GPS_NMEA</tt><br>
19            Serial Port: <tt>/dev/gps<i>u</i></tt>; 4800 baud, 8-bits, no parity<br>
20            Features: <tt>tty_clk</tt></p>
21        <h4>Description</h4>
22        <p>This driver supports GPS receivers with the <tt>$GPRMC</tt> NMEA output string by default.&nbsp; Alternately the <tt>$GPGGA</tt> or <tt>$GPGLL </tt>may be selected.</p>
23        <p>The driver expects the receiver to be set up to transmit a <tt>$GPRMC</tt> message every second.</p>
24        <p>The accuracy depend on the receiver used. Inexpesive GPS models are available with a claimed PPS signal accuracy of 1 <font face="Symbol">m</font>s or better relative to the broadcast signal. However, in most cases the actual accuracy is limited by the precision of the timecode and the latencies of the serial interface and operating system.</p>
25        <p>If the Operating System supports the PPSAPI, RFC-2783, it will be used.<br>
26            &nbsp;</p>
27        <p>The various GPS sentences that this driver recognises look like this:<br>
28            (others quietly ignored)</p>
29        <pre><tt>$GPRMC,POS_UTC,POS_STAT,LAT,LAT_REF,LON,LON_REF,SPD,HDG,DATE,MAG_VAR,MAG_REF*CC&lt;cr&gt;&lt;lf&gt;
30$GPGLL,LAT,LAT_REF,LONG,LONG_REF,POS_UTC,POS_STAT*CC&lt;cr&gt;&lt;lf&gt;
31$GPGGA,POS_UTC,LAT,LAT_REF,LONG,LONG_REF,FIX_MODE,SAT_USED,HDOP,ALT,ALT_UNIT,GEO,G_UNIT,D_AGE,D_REF*CC&lt;cr&gt;&lt;lf&gt;
32
33&nbsp; POS_UTC&nbsp; - UTC of position. Hours, minutes and seconds [fraction (opt.)]. (hhmmss[.fff])
34&nbsp; POS_STAT - Position status. (A = Data valid, V = Data invalid)
35&nbsp; LAT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Latitude (llll.ll)
36&nbsp; LAT_REF&nbsp; - Latitude direction. (N = North, S = South)
37&nbsp; LON&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Longitude (yyyyy.yy)
38&nbsp; LON_REF&nbsp; - Longitude direction (E = East, W = West)
39&nbsp; SPD&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Speed over ground. (knots) (x.x)
40&nbsp; HDG&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Heading/track made good (degrees True) (x.x)
41&nbsp; DATE&nbsp;&nbsp;&nbsp;&nbsp; - Date (ddmmyy)
42&nbsp; MAG_VAR&nbsp; - Magnetic variation (degrees) (x.x)
43&nbsp; MAG_REF&nbsp; - Magnetic variation (E = East, W = West)
44&nbsp; FIX_MODE - Position Fix Mode ( 0 = Invalid, &gt;0 = Valid)
45&nbsp; SAT_USED - Number Satellites used in solution
46&nbsp; HDOP&nbsp;&nbsp;&nbsp;&nbsp; - Horizontal Dilution of Precision
47&nbsp; ALT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Antenna Altitude
48&nbsp; ALT_UNIT - Altitude Units (Metres/Feet)
49&nbsp; GEO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Geoid/Elipsoid separation
50&nbsp; G_UNIT&nbsp;&nbsp; - Geoid units (M/F)
51&nbsp; D_AGE&nbsp;&nbsp;&nbsp; - Age of last DGPS Fix
52&nbsp; D_REF&nbsp;&nbsp;&nbsp; - Reference ID of DGPS station
53&nbsp; CC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; - Checksum (optional)
54&nbsp; &lt;cr&gt;&lt;lf&gt; - Sentence terminator.</tt></pre>
55        Alternate GPS sentences (other than <tt>$GPRMC</tt> - the default) may be enabled by setting the relevent bits of 'mode' in the server configuration line<br>
56        &nbsp;* server 127.127.20.x mode X<br>
57        &nbsp;&nbsp;&nbsp; bit 0 - enables RMC&nbsp;&nbsp;&nbsp; ( value = 1)<br>
58        &nbsp;&nbsp;&nbsp; bit 1 - enables GGA&nbsp;&nbsp;&nbsp; ( value = 2)<br>
59        &nbsp;&nbsp;&nbsp; bit 2 - enables GLL&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ( value = 4)<br>
60        multiple sentences may be selected<br>
61        <p>The driver will send a <tt>$PMOTG,RMC,0000*1D&lt;cr&gt;&lt;lf&gt;</tt> message each time a <tt>$GPRMC</tt> string is needed. This is not needed on most GPS receivers because they automatically send the <tt>$GPRMC</tt> string every second and will only work on GPS receivers that understand the <tt>$PMOTG</tt> string. Others will just ignore it.</p>
62        <h4>Setting up the Garmin GPS-25XL</h4>
63        Switch off all output with by sending it the following string.
64        <pre>&quot;$PGRMO,,2&lt;cr&gt;&lt;lf&gt;&quot;</pre>
65        <p>Now switch only $GPRMC on by sending it the following string.</p>
66        <pre>&quot;$PGRMO,GPRMC,1&lt;cr&gt;&lt;lf&gt;&quot;</pre>
67        <p>On some systems the PPS signal isn't switched on by default. It can be switched on by sending the following string.</p>
68        <pre>&quot;$PGRMC,,,,,,,,,,,,2&lt;cr&gt;&lt;lf&gt;&quot;</pre>
69        <h4>Monitor Data</h4>
70        <p>The GPS sentence(s) that is used is written to the clockstats file.</p>
71        <h4>Fudge Factors</h4>
72        <dl>
73            <dt><tt>time1 <i>time</i></tt>
74            <dd>Specifies the time offset calibration factor, in seconds and fraction, with default 0.0.
75            <dt><tt>time2 <i>time</i></tt>
76            <dd>Not used by this driver.
77            <dt><tt>stratum <i>number</i></tt>
78            <dd>Specifies the driver stratum, in decimal from 0 to 15, with default 0.
79            <dt><tt>refid <i>string</i></tt>
80            <dd>Specifies the driver reference identifier, an ASCII string from one to four characters, with default <tt>GPS</tt>.
81            <dt><tt>flag1 0 | 1</tt>
82            <dd>Not used by this driver.
83            <dt><tt>flag2 0 | 1</tt>
84            <dd>Specifies the PPS signal on-time edge: 0 for assert (default), 1 for clear.
85            <dt><tt>flag3 0 | 1</tt>
86            <dd>Controls the kernel PPS discipline: 0 for disable (default), 1 for enable.
87            <dt><tt>flag4 0 | 1</tt>
88            <dd>Not used by this driver.
89        </dl>
90        <p>Additional Information</p>
91        <p><a href="../refclock.html">Reference Clock Drivers</a></p>
92        <hr>
93        <script type="text/javascript" language="javascript" src="../scripts/footer.txt"></script>
94    </body>
95
96</html>