driver20.html:

  note fudge flag1 now enables/disables (default) PPSAPI support
  make bitrate setting values more obvious to those not fluent in binary shifting
ChangeLog:
  punctuation

bk: 4a49c5den58nFV2drOpY20VcXdQlfQ

diff --git a/ChangeLog b/ChangeLog
index 3d5ad48f251d1e518ffaab961ced3ab9f5fe4fa7..148319f4c8758c31adfb39147557460991d53c77 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,4 +1,4 @@
-* [Bug 1234] convert NMEA driver to use common PPSAPI code
+* [Bug 1234] convert NMEA driver to use common PPSAPI code.
 * timepps-Solaris.h pps_handle_t changed from pointer to scalar
 * Spectracom refclock added to Windows port of ntpd
 (4.2.5p184) 2009/06/24 Released by Harlan Stenn <stenn@ntp.org>

diff --git a/html/drivers/driver20.html b/html/drivers/driver20.html
index f85dab653adcb7ba114ab8a9cf8a0a263c479f89..c6837439082579002f814d99005377b6011305f3 100644 (file)
--- a/html/drivers/driver20.html
+++ b/html/drivers/driver20.html
@@ -22,7 +22,7 @@
                <p>This driver supports GPS receivers with the <tt>$GPRMC, $GPGLL, $GPGGA, $GPZDA, and $GPZDG</tt> NMEA sentences by default.&nbsp; Note that Accord's custom NMEA sentence <tt>$GPZDG</tt> reports using the GPS timescale, while the rest of the sentences report UTC.&nbsp; The difference between the two is a whole number of seconds which increases with each leap second insertion in UTC.&nbsp; To avoid problems mixing UTC and GPS timescales, the driver disables processing of UTC sentences once <tt>$GPZDG</tt> is received.</p>
                <p>The driver expects the receiver to be set up to transmit at least one supported sentence every second.</p>
                <p>The accuracy depends on the receiver used. Inexpensive 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>
-               <p>If the Operating System supports the PPSAPI, RFC-2783, it will be used.<br>&nbsp;</p>
+               <p>If the Operating System supports PPSAPI (<a href="http://www.ietf.org/rfc/rfc2783.txt">RFC 2783</a>), fudge flag1 1 enables its use.<br>&nbsp;</p>
                <p>The various GPS sentences that this driver recognises look like this:<br>
                        (others quietly ignored)</p>
                <pre><tt>$GPRMC,UTC,POS_STAT,LAT,LAT_REF,LON,LON_REF,SPD,HDG,DATE,MAG_VAR,MAG_REF*CS&lt;cr&gt;&lt;lf&gt;
@@ -64,9 +64,9 @@ $GPZDG,GPSTIME,DD,MM,YYYY,AA.BB,V*CS&lt;cr&gt;&lt;lf&gt;
 &nbsp; &lt;cr&gt;&lt;lf&gt; - Sentence terminator.</tt></pre>
 
 <p>Specific GPS sentences and bitrates may be selected by setting bits of the 'mode' in the server configuration line:<br>
-  &nbsp;&nbsp;<tt>server 127.127.20.x mode X</tt><br>&nbsp;&nbsp;&nbsp; bit 0 - process <tt>$GPMRC</tt>&nbsp;&nbsp;&nbsp; (value = 1)<br>&nbsp;&nbsp;&nbsp; bit 1 - process <tt>$GPGGA</tt>&nbsp;&nbsp;&nbsp; (value = 2)<br>&nbsp;&nbsp;&nbsp; bit 2 - process <tt>$GPGLL</tt>&nbsp;&nbsp;&nbsp;&nbsp; (value = 4)<br>&nbsp;&nbsp;&nbsp; bit 4 - process <tt>$GPZDA</tt> or <tt>$GPZDG</tt>&nbsp;&nbsp;&nbsp; (value = 8)<br> 
+  &nbsp;&nbsp;<tt>server 127.127.20.x mode X</tt><br>&nbsp;&nbsp;&nbsp; bit 0 - process <tt>$GPMRC</tt>&nbsp;&nbsp;&nbsp; (value = 1)<br>&nbsp;&nbsp;&nbsp; bit 1 - process <tt>$GPGGA</tt>&nbsp;&nbsp;&nbsp; (value = 2)<br>&nbsp;&nbsp;&nbsp; bit 2 - process <tt>$GPGLL</tt>&nbsp;&nbsp;&nbsp; (value = 4)<br>&nbsp;&nbsp;&nbsp; bit 4 - process <tt>$GPZDA</tt> or <tt>$GPZDG</tt>&nbsp;&nbsp;&nbsp; (value = 8)<br> 
 <p>The default (mode 0) is to process all supported sentences, which results in the last received each cycle being used.&nbsp; Multiple sentences may be selected by adding their mode bit values.&nbsp; The driver uses 4800 bits per second by default.&nbsp; Faster bitrates can be selected using bits 4, 5, and 6 of the mode field:<br><br>
-               &nbsp;&nbsp;&nbsp; bits 4/5/6 - select serial bitrate&nbsp;&nbsp; ( 0 for 4800 - the default, 1 for 9600, 2 for 19200, 3 for 38400, 4 for 57600, 5 for 115200 )<br></p>
+               &nbsp;&nbsp;&nbsp; bits 4/5/6 - select serial bitrate&nbsp;&nbsp; (0 for 4800 - the default, 16 for 9600, 32 for 19200, 48 for 38400, 64 for 57600, 80 for 115200)<br></p>
                <p>The driver will send a <tt>$PMOTG,RMC,0000*1D&lt;cr&gt;&lt;lf&gt;</tt> command each poll interval.&nbsp; This is not needed on most GPS receivers because they automatically send <tt>$GPRMC</tt> every second, but helps a Motorola GPS receiver that is otherwise silent.&nbsp; NMEA devices ignore commands they do not understand.</p>
                <h4>Setting up the Garmin GPS-25XL</h4>
                Switch off all output with by sending it the following string.
@@ -88,11 +88,11 @@ $GPZDG,GPSTIME,DD,MM,YYYY,AA.BB,V*CS&lt;cr&gt;&lt;lf&gt;
                        <dt><tt>refid <i>string</i></tt>
                        <dd>Specifies the driver reference identifier, an ASCII string from one to four characters, with default <tt>GPS</tt>.
                        <dt><tt>flag1 0 | 1</tt>
-                       <dd>Not used by this driver.
+                       <dd>Disable PPS signal processing if 0 (default); enable PPS signal processing if 1.
                        <dt><tt>flag2 0 | 1</tt>
-                       <dd>Specifies the PPS signal on-time edge: 0 for assert (default), 1 for clear.
+                       <dd>If PPS signal processing is enabled, capture the pulse on the rising edge if 0 (default); capture on the falling edge if 1.
                        <dt><tt>flag3 0 | 1</tt>
-                       <dd>Controls the kernel PPS discipline: 0 for disable (default), 1 for enable.
+                       <dd>If PPS signal processing is enabled, use the <tt>ntpd</tt> clock discipline if 0 (default); use the kernel discipline if 1.
                        <dt><tt>flag4 0 | 1</tt>
                        <dd>Obscures location in timecode: 0 for disable (default), 1 for enable.
                </dl>