19c2daa00SOllivier Robert<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> 29c2daa00SOllivier Robert 39c2daa00SOllivier Robert<html> 49c2daa00SOllivier Robert 59c2daa00SOllivier Robert <head> 6ea906c41SOllivier Robert <meta http-equiv="content-type" content="text/html;charset=iso-8859-1"> 79c2daa00SOllivier Robert <title>Generic Reference Driver</title> 8ea906c41SOllivier Robert <link href="scripts/style.css" type="text/css" rel="stylesheet"> 99c2daa00SOllivier Robert </head> 109c2daa00SOllivier Robert 119c2daa00SOllivier Robert <body> 129c2daa00SOllivier Robert <h3>Generic Reference Driver</h3> 13*2b15cb3dSCy Schubert<p>Last update: 14*2b15cb3dSCy Schubert <!-- #BeginDate format:En2m -->27-Jan-2014 05:31<!-- #EndDate --> 15*2b15cb3dSCy Schubert UTC</p> 169c2daa00SOllivier Robert <hr> 179c2daa00SOllivier Robert <h4>Synopsis</h4> 18*2b15cb3dSCy Schubert Address: 127.127.8.<em>u</em><br> 19*2b15cb3dSCy Schubert Reference ID: PARSE<br> 20*2b15cb3dSCy Schubert Driver ID: GENERIC<br> 21*2b15cb3dSCy Schubert Serial Port: /dev/refclock-<em>u</em>; TTY mode according to clock type<br> 22*2b15cb3dSCy Schubert PPS device: /dev/refclockpps-<em>u</em>; alternate PPS device (if not available via the serial port) 239c2daa00SOllivier Robert <h4>Description</h4> 24ea906c41SOllivier Robert The PARSE driver supports 20 different clock types/configurations. PARSE is actually a multi-clock driver.<br> 25ea906c41SOllivier Robert <br> 26*2b15cb3dSCy Schubert <p>The actual receiver status is mapped into various synchronization states generally used by receivers. The driver is configured to interpret the time codes of Meinberg DCF77 AM receivers, DCF77 FM receivers, Meinberg GPS16x/17x receivers, Trimble SV6 GPS, ELV DCF7000, Schmid, Wharton 400A and low cost receivers (see <a href="imap://mills@mail.eecis.udel.edu:993/fetch%3EUID%3E.INBOX%3E67132?part=1.3&type=text/html&filename=driver8.html#clocklist">list below</a>).</p> 27ea906c41SOllivier Robert <p>The reference clock support in NTP contains the necessary configuration tables for those receivers. In addition to supporting several different clock types and up to 4 devices, the processing of a PPS signal is also provided as a configuration option. The PPS configuration option uses the receiver-generated time stamps for feeding the PPS loopfilter control for much finer clock synchronization.</p> 289c2daa00SOllivier Robert <p>CAUTION: The PPS configuration option is different from the hardware PPS signal, which is also supported (see below), as it controls the way ntpd is synchronized to the reference clock, while the hardware PPS signal controls the way time offsets are determined.</p> 299c2daa00SOllivier Robert <p>The use of the PPS option requires receivers with an accuracy of better than 1ms.</p> 30ea906c41SOllivier Robert <h4>Timecode variables listed by ntpq (8)</h4> 31ea906c41SOllivier Robert <p>The ntpq program can read and display several clock variables. These hold the following information:</p> 32ea906c41SOllivier Robert <dl> 33*2b15cb3dSCy Schubert <dt>refclock_format</dt> 34ea906c41SOllivier Robert <dd>A qualification of the decoded time code format.</dd> 35*2b15cb3dSCy Schubert <dt>refclock_states</dt> 36ea906c41SOllivier Robert <dd>The overall running time and the accumulated times for the clock event states.</dd> 37*2b15cb3dSCy Schubert <dt>refclock_status</dt> 38ea906c41SOllivier Robert <dd>Lists the currently active receiver flags. Additional feature flags for the receiver are optionally listed in parentheses.</dd> 39*2b15cb3dSCy Schubert <dt>refclock_time</dt> 40ea906c41SOllivier Robert <dd>The local time with the offset to UTC (format HHMM).</dd> 41*2b15cb3dSCy Schubert <dt>timecode</dt> 42ea906c41SOllivier Robert <dd>The actual time code.</dd> 43ea906c41SOllivier Robert </dl> 44ea906c41SOllivier Robert <p>If PPS information is present, additional variables are available:</p> 45ea906c41SOllivier Robert <dl> 46*2b15cb3dSCy Schubert <dt>refclock_ppsskew</dt> 47ea906c41SOllivier Robert <dd>The difference between the RS-232-derived timestamp and the PPS timestamp.</dd> 48*2b15cb3dSCy Schubert <dt>refclock_ppstime</dt> 49ea906c41SOllivier Robert <dd>The PPS timestamp.</dd> 50ea906c41SOllivier Robert </dl> 51ea906c41SOllivier Robert <h4>Supported Devices</h4> 52*2b15cb3dSCy Schubert <p>Currently, twenty-four clock types are supported by the PARSE driver and up to four (devices /dev/refclock-0 - /dev/refclock-3) of these clocks may be operational at any one time.<br> 539c2daa00SOllivier Robert A note on the implementations:</p> 549c2daa00SOllivier Robert <ul> 55*2b15cb3dSCy Schubert <li>These implementations were mainly done without actual access to the hardware, thus not all implementations provide full support. The development was done with the help of many kind souls who had the hardware and kindly lent me their time and patience during the development and debugging cycle. Thus for continued support and quality, direct access to the receivers is a big help. Nevertheless I am not prepared to buy these reference clocks - donations to (<a href="mailto:kardel%20%3CAT%3E%20ntp.org">kardel <AT> ntp.org</a>) are welcome as long as they work within Europe 8-). 569c2daa00SOllivier Robert <p>Verified implementations are:</p> 579c2daa00SOllivier Robert <ul> 589c2daa00SOllivier Robert <li>RAWDCF variants 59ea906c41SOllivier Robert <p>These variants have been tested for correct decoding with my own homegrown receivers. Interfacing with specific commercial products may involve some fiddling with cables. In particular, commercial RAWDCF receivers have a seemingly unlimited number of ways to draw power from the RS-232 port and to encode the DCF77 datastream. You are mainly on your own here unless I have a sample of the receiver.</p> 60*2b15cb3dSCy Schubert </li> 619c2daa00SOllivier Robert <li><a href="http://www.meinberg.de">Meinberg clocks</a> 62ea906c41SOllivier Robert <p>These implementations have been verified by the Meinberg people themselves and I have access to one of these clocks.</p> 63*2b15cb3dSCy Schubert </li> 64*2b15cb3dSCy Schubert <li><a href="http://www.selinc.com">Schweitzer Engineering 65*2b15cb3dSCy Schubert Laboratories SEL-240x clocks</a> 66*2b15cb3dSCy Schubert <p>This implementation was provided and verified by SEL and <a 67*2b15cb3dSCy Schubert href="http://networktimefoundation.org">Network Time Foundation</a> 68*2b15cb3dSCy Schubert has an SEL-2407 in one of its development labs.</p> 69*2b15cb3dSCy Schubert </li> 709c2daa00SOllivier Robert </ul> 71*2b15cb3dSCy Schubert </li> 729c2daa00SOllivier Robert </ul> 73ea906c41SOllivier Robert <p>The pictures below have been taken from and are linked to the vendors' web pages.</p> 74ea906c41SOllivier Robert <a name="clocklist"></a> 759c2daa00SOllivier Robert <ul> 76*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 0</strong> 77*2b15cb3dSCy Schubert <p><strong><a href="http://www.meinberg.de">Meinberg</a> <a href="http://www.meinberg.de/english/products/timesource.htm#dcf---freq_sync">PZF5xx receiver family</a> (FM demodulation/TCXO / 50μs)</strong><br> 78*2b15cb3dSCy Schubert <br> 79*2b15cb3dSCy Schubert </p> 80*2b15cb3dSCy Schubert </li> 81*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 1</strong> 82*2b15cb3dSCy Schubert <p><strong><a href="http://www.meinberg.de">Meinberg</a> <a href="http://www.meinberg.de/english/products/timesource.htm#dcf---freq_sync">PZF5xx receiver family</a> (FM demodulation/OCXO / 50μs)</strong><br> 83*2b15cb3dSCy Schubert <a href="http://www.meinberg.de/english/products/pzf-eurocard.htm"><img src="../pic/pzf511.jpg" alt="Image PZF511" align="top" border="0" height="300" width="260"></a><br> 84*2b15cb3dSCy Schubert <br> 85*2b15cb3dSCy Schubert </p> 86*2b15cb3dSCy Schubert </li> 87*2b15cb3dSCy Schubert <li><a name="mode2"></a><strong>server 127.127.8.0-3 mode 2</strong> 88*2b15cb3dSCy Schubert <p><strong><a href="http://www.meinberg.de">Meinberg</a> <a href="http://www.meinberg.de/english/products/c51.htm">DCF C51 receiver and similar</a> (AM demodulation / 4ms)</strong><br> 89*2b15cb3dSCy Schubert <a href="http://www.meinberg.de/english/products/c51.htm"><img src="../pic/c51.jpg" alt="Image C51" align="top" border="0" height="239" width="330"></a><br> 909c2daa00SOllivier Robert </p> 91ea906c41SOllivier Robert <p>This mode expects the Meinberg standard time string format with 9600/7E2.</p> 92*2b15cb3dSCy Schubert <p><strong>Note:</strong> mode 2 must also be used for <a href="http://www.meinberg.de/english/products/formfactor.htm#slot_card">Meinberg PCI cards</a> under Linux, e.g. <a href="http://www.meinberg.de/english/products/gps-pcicard.htm">the GPS PCI card</a> or <a href="http://www.meinberg.de/english/products/dcf-pcicard.htm">the DCF77 PCI card</a>. Please note the <a href="http://www.meinberg.de/english/sw/#linux">Meinberg Linux driver</a> must be installed. That driver emulates a refclock device in order to allow ntpd to access those cards. For details, please refer to the README file that comes with the Meinberg driver package.<br> 93*2b15cb3dSCy Schubert <br> 94*2b15cb3dSCy Schubert </p> 95*2b15cb3dSCy Schubert </li> 96*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 3</strong> 97*2b15cb3dSCy Schubert <p><strong><a href="http://www.elv.de">ELV</a> DCF7000 (sloppy AM demodulation / 50ms)</strong><br> 98*2b15cb3dSCy Schubert <br> 99*2b15cb3dSCy Schubert </p> 100*2b15cb3dSCy Schubert </li> 101*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 4</strong> 102*2b15cb3dSCy Schubert <p><strong>Walter Schmid DCF receiver Kit (AM demodulation / 1ms)</strong><br> 103*2b15cb3dSCy Schubert <br> 104*2b15cb3dSCy Schubert </p> 105*2b15cb3dSCy Schubert </li> 106*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 5</strong> 107*2b15cb3dSCy Schubert <p><strong>RAW DCF77 100/200ms pulses (Conrad DCF77 receiver module / 5ms)</strong><br> 108*2b15cb3dSCy Schubert <br> 109*2b15cb3dSCy Schubert </p> 110*2b15cb3dSCy Schubert </li> 111*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 6</strong> 112*2b15cb3dSCy Schubert <p><strong>RAW DCF77 100/200ms pulses (TimeBrick DCF77 receiver module / 5ms)</strong><br> 113*2b15cb3dSCy Schubert <br> 114*2b15cb3dSCy Schubert </p> 115*2b15cb3dSCy Schubert </li> 116*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 7</strong> 117*2b15cb3dSCy Schubert <p><strong><a href="http://www.meinberg.de">Meinberg</a> <a href="http://www.meinberg.de/english/products/timesource.htm#gps---freq_sync">GPS16x/GPS17x receivers</a> (GPS / <<1μs)</strong><br> 118*2b15cb3dSCy Schubert <a href="http://www.meinberg.de/english/products/gps-eurocard.htm"><img src="../pic/gps167.jpg" alt="Image GPS167" align="top" border="0" height="300" width="280"></a><br> 1199c2daa00SOllivier Robert </p> 120ea906c41SOllivier Robert <p>This mode expects either the University of Erlangen time string format or the Meinberg standard time string format at 19200/8N1.</p> 121ea906c41SOllivier Robert <p>The University of Erlangen format is preferred. Newer Meinberg GPS receivers can be configured to transmit that format; for older devices, a special firmware version may be available.</p> 122*2b15cb3dSCy Schubert <p>In this mode some additional GPS receiver status information is also read. However, this requires a point-to-point connection. <a href="imap://mills@mail.eecis.udel.edu:993/fetch%3EUID%3E.INBOX%3E67132?part=1.3&type=text/html&filename=driver8.html#mode18">Mode 18</a> should be used if the device is accessed by a multidrop connection.</p> 123*2b15cb3dSCy Schubert <p><strong>Note:</strong> mode 7 must not be used with Meinberg PCI cards; use <a href="imap://mills@mail.eecis.udel.edu:993/fetch%3EUID%3E.INBOX%3E67132?part=1.3&type=text/html&filename=driver8.html#mode2">mode 2</a> instead.<br> 124*2b15cb3dSCy Schubert <br> 125*2b15cb3dSCy Schubert </p> 126*2b15cb3dSCy Schubert </li> 127*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 8</strong> 128*2b15cb3dSCy Schubert <p><strong><a href="http://www.igel.de">IGEL</a> <a href="http://www.igel.de/eigelmn.html">clock</a></strong><br> 129*2b15cb3dSCy Schubert <a href="http://www.igel.de/eigelmn.html"><img src="../pic/igclock.gif" alt="Image IGEL clock" border="0" height="174" width="200"></a><br> 130*2b15cb3dSCy Schubert <br> 131*2b15cb3dSCy Schubert </p> 132*2b15cb3dSCy Schubert </li> 133*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 9</strong> 134*2b15cb3dSCy Schubert <p><strong><a href="http://www.trimble.com">Trimble</a> <a href="http://www.trimble.com/cgi/omprod.cgi/pd_om011.html">SVeeSix GPS receiver</a> TAIP protocol (GPS / <<1μs)</strong><br> 135*2b15cb3dSCy Schubert <br> 136*2b15cb3dSCy Schubert </p> 137*2b15cb3dSCy Schubert </li> 138*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 10</strong> 139*2b15cb3dSCy Schubert <p><strong><a href="http://www.trimble.com">Trimble</a> <a href="http://www.trimble.com/cgi/omprod.cgi/pd_om011.html">SVeeSix GPS receiver</a> TSIP protocol (GPS / <<1μs) (no kernel support yet)</strong><br> 140*2b15cb3dSCy Schubert <a href="http://www.trimble.com/cgi/omprod.cgi/pd_om011.html"><img src="../pic/pd_om011.gif" alt="Image SVeeSix-CM3" align="top" border="0" height="100" width="420"></a><br> 141*2b15cb3dSCy Schubert <a href="http://www.trimble.com/cgi/omprod.cgi/pd_om006.html"><img src="../pic/pd_om006.gif" alt="Image Lassen-SK8" border="0" height="100" width="420"></a><br> 142*2b15cb3dSCy Schubert <br> 143*2b15cb3dSCy Schubert </p> 144*2b15cb3dSCy Schubert </li> 145*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 11</strong> 146*2b15cb3dSCy Schubert <p><strong>Radiocode Clocks Ltd RCC 8000 Intelligent Off-Air Master Clock support </strong><br> 147*2b15cb3dSCy Schubert <br> 148*2b15cb3dSCy Schubert </p> 149*2b15cb3dSCy Schubert </li> 150*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 12</strong> 151*2b15cb3dSCy Schubert <p><strong><a href="http://www.hopf-time.com">HOPF</a> <a href="http://www.hopf-time.com/kart6021.html">Funkuhr 6021</a></strong><br> 152*2b15cb3dSCy Schubert <a href="http://www.hopf-time.com/engl/kart6021.html"><img src="../pic/fg6021.gif" alt="Image DCF77 Interface Board" align="top" border="0" height="207" width="238"></a><br> 153*2b15cb3dSCy Schubert <br> 154*2b15cb3dSCy Schubert </p> 155*2b15cb3dSCy Schubert </li> 156*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 13</strong> 157*2b15cb3dSCy Schubert <p><strong>Diem's Computime Radio Clock</strong><br> 158*2b15cb3dSCy Schubert <br> 159*2b15cb3dSCy Schubert </p> 160*2b15cb3dSCy Schubert </li> 161*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 14</strong> 162*2b15cb3dSCy Schubert <p><strong>RAWDCF receiver (DTR=high/RTS=low)</strong><br> 163*2b15cb3dSCy Schubert <br> 164*2b15cb3dSCy Schubert </p> 165*2b15cb3dSCy Schubert </li> 166*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 15</strong> 167*2b15cb3dSCy Schubert <p><strong>WHARTON 400A Series Clocks with a 404.2 Serial Interface</strong><br> 168*2b15cb3dSCy Schubert <br> 169*2b15cb3dSCy Schubert </p> 170*2b15cb3dSCy Schubert </li> 171*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 16</strong> 172*2b15cb3dSCy Schubert <p><strong>RAWDCF receiver (DTR=low/RTS=high) </strong><br> 173*2b15cb3dSCy Schubert <br> 174*2b15cb3dSCy Schubert </p> 175*2b15cb3dSCy Schubert </li> 176*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 17</strong> 177*2b15cb3dSCy Schubert <p><strong>VARITEXT Receiver (MSF) </strong><br> 178*2b15cb3dSCy Schubert <br> 179*2b15cb3dSCy Schubert </p> 180*2b15cb3dSCy Schubert </li> 181*2b15cb3dSCy Schubert <li><a name="mode18"></a><strong>server 127.127.8.0-3 mode 18</strong> 182*2b15cb3dSCy Schubert <p><strong><a href="http://www.meinberg.de">Meinberg </a><a href="http://www.meinberg.de/english/products/timesource.htm#gps---freq_sync">GPS16x/GPS17x receivers</a> (GPS / <<1μs)</strong><br> 183ea906c41SOllivier Robert </p> 184ea906c41SOllivier Robert <p>This mode works without additional data communication (version, GPS status etc.) and thus should be used with multidrop, heterogeneous multiclient operation.</p> 185*2b15cb3dSCy Schubert <p><strong>Note:</strong> mode 18 must not be used with Meinberg PCI cards, use mode 2 instead.<br> 186*2b15cb3dSCy Schubert <br> 187*2b15cb3dSCy Schubert </p> 188*2b15cb3dSCy Schubert </li> 189*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 19</strong> 190*2b15cb3dSCy Schubert <p><strong>Gude Analog- und Digitalsystem GmbH 'Expert mouseCLOCK USB v2.0'</strong><br> 191*2b15cb3dSCy Schubert <br> 192*2b15cb3dSCy Schubert </p> 193*2b15cb3dSCy Schubert </li> 194*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 20</strong> 195*2b15cb3dSCy Schubert <p><strong>RAWDCF receiver similar to mode 14, but operating @ 75 baud (DTR=high/RTS=low)</strong><br> 196*2b15cb3dSCy Schubert </p> 197*2b15cb3dSCy Schubert <p>Driving the DCF clocks at 75 baud may help to get them to work with a bunch of common USB serial converters, that do 75 but cannot do 50 baud at all, e.g. those based on Prolific PL2303. <br> 198*2b15cb3dSCy Schubert </p> 199*2b15cb3dSCy Schubert </li> 200*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 21</strong> 201*2b15cb3dSCy Schubert <p><strong>RAWDCF receiver similar to mode 16, but operating @ 75 baud (DTR=low/RTS=high) </strong><br> 202*2b15cb3dSCy Schubert </p> 203*2b15cb3dSCy Schubert <p>See comment from mode 20 clock. <br> 204*2b15cb3dSCy Schubert </p> 205*2b15cb3dSCy Schubert </li> 206*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 22</strong> 207*2b15cb3dSCy Schubert <p><strong>MEINBERG, mode 2 but with POWERUP trust </strong><br> 208*2b15cb3dSCy Schubert </p> 209*2b15cb3dSCy Schubert </li> 210*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 23</strong> 211*2b15cb3dSCy Schubert <p><strong>MEINBERG, mode 7 but with POWERUP trust </strong><br> 212*2b15cb3dSCy Schubert </p> 213*2b15cb3dSCy Schubert </li> 214*2b15cb3dSCy Schubert <li><strong>server 127.127.8.0-3 mode 24</strong> 215*2b15cb3dSCy Schubert <p><strong><a href="http://www.selinc.com/">Schweitzer Engineering Laboratories</a></strong><br> 216*2b15cb3dSCy Schubert </p> 217*2b15cb3dSCy Schubert </li> 2189c2daa00SOllivier Robert </ul> 219ea906c41SOllivier Robert <p>Actual data formats and setup requirements of the various clocks can be found in <a href="../parsedata.html">NTP PARSE clock data formats</a>.</p> 220ea906c41SOllivier Robert <h4>Operation</h4> 221ea906c41SOllivier Robert <p>The reference clock support software carefully monitors the state transitions of the receiver. All state changes and exceptional events (such as loss of time code transmission) are logged via the syslog facility. Every hour a summary of the accumulated times for the clock states is listed via syslog.</p> 222ea906c41SOllivier Robert <p>PPS support is only available when the receiver is completely synchronized. The receiver is believed to deliver correct time for an additional period of time after losing synchronization, unless a disruption in time code transmission is detected (possible power loss). The trust period is dependent on the receiver oscillator and thus is a function of clock type.</p> 223ea906c41SOllivier Robert <p>Raw DCF77 pulses can be fed via a level converter to the RXD pin of an RS-232 serial port (pin 3 of a 25-pin connector or pin 2 of a 9-pin connector). The telegrams are decoded and used for synchronization. DCF77 AM receivers can be bought for as little as $25. The accuracy is dependent on the receiver and is somewhere between 2ms (expensive) and 10ms (cheap). Synchronization ceases when reception of the DCF77 signal deteriorates, since no backup oscillator is available as usually found in other reference clock receivers. So it is important to have a good place for the DCF77 antenna. During transmitter shutdowns you are out of luck unless you have other NTP servers with alternate time sources available.</p> 224*2b15cb3dSCy Schubert <p>In addition to the PPS loopfilter control, a true PPS hardware signal can be utilized via the PPSAPI interface. PPS pulses are usually fed via a level converter to the DCD pin of an RS-232 serial port (pin 8 of a 25-pin connector or pin 1 of a 9-pin connector). To select PPS support, the mode parameter is the mode value as above plus 128. If 128 is not added to the mode value, PPS will be detected to be available but will not be used. </p> 225ea906c41SOllivier Robert <h4>Hardware PPS support<br> 226ea906c41SOllivier Robert </h4> 227ea906c41SOllivier Robert <p>For PPS to be used, add 128 to the mode parameter.</p> 228ea906c41SOllivier Robert <p>If the PPS signal is fed in from a device different from the device providing the serial communication (/dev/refclock-{0..3}), this device is configured as /dev/refclockpps-{0..3}. This allows the PPS information to be fed in e.g. via the parallel port (if supported by the underlying operation system) and the date/time telegrams to be handled via the serial port.</p> 2299c2daa00SOllivier Robert <h4>Monitor Data</h4> 230*2b15cb3dSCy Schubert <p>Clock state statistics are written hourly to the syslog service. Online information can be found by examining the clock variables via the ntpq cv command.<br> 231*2b15cb3dSCy Schubert Some devices have quite extensive additional information (GPS16x/GPS17x, Trimble). The driver reads out much of the internal GPS data and makes it accessible via clock variables. To find out about additional variable names, query for the clock_var_list variable on a specific clock association as shown below. </p> 232*2b15cb3dSCy Schubert <p>First let ntpq display the table of associations:</p> 233*2b15cb3dSCy Schubert <pre> ntpq> as ind assID status conf reach auth condition last_event cnt =========================================================== 1 19556 9154 yes yes none falsetick reachable 5 2 19557 9435 yes yes none candidat clock expt 3 3 19558 9714 yes yes none pps.peer reachable 1 </pre> 234ea906c41SOllivier Robert <p>Then switch to raw output. This may be required because of display limitations in ntpq/ntpd - so large lists need to be retrieved in several queries.</p> 235*2b15cb3dSCy Schubert <pre> ntpq> raw Output set to raw </pre> 236ea906c41SOllivier Robert <p>Use the cv command to read the list of clock variables of a selected association:</p> 237*2b15cb3dSCy Schubert <pre> ntpq> cv 19557 clock_var_list </pre> 238ea906c41SOllivier Robert <p>The long output of the command above looks similar to:</p> 239*2b15cb3dSCy Schubert <pre> assID=19557 status=0x0000, clock_var_list="type,timecode,poll,noreply,badformat,baddata,fudgetime1, fudgetime2,stratum,refid,flags,device,clock_var_list,refclock_time,refclock_status, refclock_format,refclock_states,refclock_id,refclock_iomode,refclock_driver_version, meinberg_gps_status,gps_utc_correction,gps_message,meinberg_antenna_status,gps_tot_51, gps_tot_63,gps_t0a,gps_cfg[1],gps_health[1],gps_cfg[2],gps_health[2],gps_cfg[3], gps_health[3],gps_cfg[4],gps_health[4],gps_cfg[5]" </pre> 240ea906c41SOllivier Robert <p>Then use the cv command again to list selected clock variables. The following command must be entered as a single line:</p> 241*2b15cb3dSCy Schubert <pre> ntpq> cv 19557 refclock_status,refclock_format,refclock_states,refclock_id, refclock_iomode,refclock_driver_version,meinberg_gps_status,gps_utc_correction, gps_message,meinberg_antenna_status,gps_tot_51,gps_tot_63,gps_t0a,gps_cfg[1], gps_health[1],gps_cfg[2],gps_health[2],gps_cfg[3],gps_health[3],gps_cfg[4], gps_health[4],gps_cfg[5] </pre> 242ea906c41SOllivier Robert <p>The output of the command above is wrapped around depending on the screen width and looks similar to:</p> 243*2b15cb3dSCy Schubert <pre> status=0x0003, refclock_status="UTC DISPLAY; TIME CODE; PPS; POSITION; (LEAP INDICATION; PPS SIGNAL; POSITION)", refclock_format="Meinberg GPS Extended", refclock_states="*NOMINAL: 21:21:36 (99.99%); FAULT: 00:00:03 (0.00%); running time: 21:21:39", refclock_id="GPS", refclock_iomode="normal", refclock_driver_version="refclock_parse.c,v 4.77 2006/08/05 07:44:49 kardel RELEASE_20060805_A", meinberg_gps_status="[0x0000] <OK>", gps_utc_correction="current correction 14 sec, last correction on c7619a00.00000000 Sun, Jan 1 2006 0:00:00.000", gps_message="/PFU3SOP-4WG14EPU0V1KA", meinberg_antenna_status="RECONNECTED on 2006-07-18 08:13:20.0000000 (+0000) UTC CORR, LOCAL TIME, reconnect clockoffset +0.0000000 s, disconnect time 0000-00-00 00:00:00.0000000 (+0000) ", gps_tot_51="week 1400 + 3 days + 42300.0000000 sec", gps_tot_63="week 1400 + 3 days + 42294.0000000 sec", gps_t0a="week 1400 + 5 days + 71808.0000000 sec", gps_cfg[1]="[0x9] BLOCK II", gps_health[1]="[0x0] OK;SIGNAL OK", gps_cfg[2]="[0x0] BLOCK I", gps_health[2]="[0x3f] PARITY;MULTIPLE ERRS", gps_cfg[3]="[0x9] BLOCK II", gps_health[3]="[0x0] OK;SIGNAL OK", gps_cfg[4]="[0x9] BLOCK II", gps_health[6]="[0x0] OK;SIGNAL OK", gps_cfg[5]="[0x9] BLOCK II" </pre> 2449c2daa00SOllivier Robert <h4>Fudge Factors</h4> 2459c2daa00SOllivier Robert <dl> 246*2b15cb3dSCy Schubert <dt>time1 <em>time</em> </dt> 247*2b15cb3dSCy Schubert <dd>Specifies the time offset calibration factor, in seconds and fraction. The default value depends on the clock type. </dd> 248*2b15cb3dSCy Schubert <dt>time2 <em>time</em> </dt> 249*2b15cb3dSCy Schubert <dd> If flag1 is 0, time2 specifies the offset of the PPS signal from the actual time (PPS fine tuning). </dd> 250*2b15cb3dSCy Schubert <dd> If flag1 is 1, time2 specifies the number of seconds a receiver with a premium local oscillator can be trusted after losing synchronisation. </dd> 251*2b15cb3dSCy Schubert <dt>stratum <em>stratum</em> </dt> 252*2b15cb3dSCy Schubert <dd>The stratum for this reference clock. </dd> 253*2b15cb3dSCy Schubert <dt>refid <em>refid</em> </dt> 254*2b15cb3dSCy Schubert <dd>The refid for this reference clock. </dd> 255ea906c41SOllivier Robert </dl> 256ea906c41SOllivier Robert <dl> 257*2b15cb3dSCy Schubert <dt>flag1 { 0 | 1 } </dt> 258*2b15cb3dSCy Schubert <dd>If 0, the fudge factor time2 refers to the PPS offset. </dd> 259*2b15cb3dSCy Schubert <dd>If 1, time2 refers to the TRUST TIME. </dd> 260*2b15cb3dSCy Schubert <dt>flag2 { 0 | 1 } </dt> 261*2b15cb3dSCy Schubert <dd>If flag2 is 1, sample PPS on CLEAR instead of on ASSERT. </dd> 262*2b15cb3dSCy Schubert <dt>flag3 { 0 | 1 } </dt> 263*2b15cb3dSCy Schubert <dd>If flag3 is 1, link kernel PPS tracking to this refclock instance. </dd> 264*2b15cb3dSCy Schubert <dt>flag4 { 0 | 1 } </dt> 265*2b15cb3dSCy Schubert <dd>Delete next leap second instead of adding it. (You'll need to wait a bit for that to happen 8-) </dd> 266ea906c41SOllivier Robert </dl> 267*2b15cb3dSCy Schubert Note about auxiliary Sun STREAMS modules (SunOS and Solaris):<br> 268ea906c41SOllivier Robert <dl> 269*2b15cb3dSCy Schubert <dt>The timecode of these receivers can be sampled via a STREAMS module in the kernel. (The STREAMS module has been designed for use with Sun systems under SunOS 4.1.x or Solaris 2.3 - 2.8. It can be linked directly into the kernel or loaded via the loadable driver mechanism.) This STREAMS module can be adapted to convert different time code formats. Nowadays the PPSAPI mechanism is usually used. </dt> 2709c2daa00SOllivier Robert </dl> 2719c2daa00SOllivier Robert <h4>Making your own PARSE clocks</h4> 272ea906c41SOllivier Robert <p>The parse clock mechanism deviates from the way other NTP reference clocks work. For a short description of how to build parse reference clocks, see <a href="../parsenew.html">making PARSE clocks</a>.</p> 2739c2daa00SOllivier Robert <p>Additional Information</p> 2749c2daa00SOllivier Robert <p><a href="../refclock.html">Reference Clock Drivers</a></p> 2759c2daa00SOllivier Robert <hr> 276ea906c41SOllivier Robert <script type="text/javascript" language="javascript" src="scripts/footer.txt"></script> 2779c2daa00SOllivier Robert </body> 2789c2daa00SOllivier Robert</html> 279
