xref: /freebsd/contrib/ntp/html/drivers/driver5.html (revision 0b3105a37d7adcadcb720112fed4dc4e8040be99)
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		<title>TrueTime GPS/GOES/OMEGA/WWV Receivers</title>
8		<link href="scripts/style.css" type="text/css" rel="stylesheet">
9	</head>
10
11	<body>
12		<h3>TrueTime GPS/GOES/OMEGA/WWV Receivers</h3>
13		<hr>
14		<h4>Synopsis</h4>
15		Address: 127.127.5.<i>u</i><br>
16		Reference ID: <tt>GPS, OMEGA, GOES, WWV</tt><br>
17		Driver ID: <tt>TRUETIME</tt><br>
18		Serial Port: <tt>/dev/true<i>u</i></tt>; 9600 baud, 8-bits, no parity<br>
19		Features: <tt>tty_clk</tt>
20		<h4>Description</h4>
21		<p>This driver supports several models models of Kinemetrics/TrueTime timing receivers, including 468-DC MK III GOES Synchronized Clock, GPS- DC MK III and GPS/TM-TMD GPS Synchronized Clock, XL-DC (a 151-602-210, reported by the driver as a GPS/TM-TMD), GPS-800 TCU (an 805-957 with the RS232 Talker/Listener module), OM-DC OMEGA Synchronized Clock, the TL-3 WWV receiver, and very likely others in the same model families that use the same timecode formats.</p>
22		<p>Most of this code is originally from refclock_wwvb.c with thanks. It has been so mangled that wwvb is not a recognizable ancestor.</p>
23		<p>Timcode format: <tt>ADDD:HH:MM:SSQCL</tt><br>
24A - control A (this is stripped before we see it) Q - Quality indication (see below) C - Carriage return L - Line feed</p><br>
25Quality codes indicate possible error of:
26		<dl>
27			<dt>468-DC GOES Receiver<br>
28				GPS-TM/TMD Receiver
29			<dd>? +/- 500 milliseconds # +/- 50 milliseconds<br>
30				* +/- 5 milliseconds . +/- 1 millisecond<br>
31				space less than 1 millisecond
32			<dt>OM-DC OMEGA Receiver:
33			<dd>&gt; +/- 5 seconds<br>
34				? +/- 500 milliseconds # +/- 50 milliseconds<br>
35				* +/- 5 milliseconds . +/- 1 millisecond<br>
36				A-H less than 1 millisecond. Character indicates which station is being received as follows<br>
37				A = Norway, B = Liberia, C = Hawaii, D = North Dakota, E = La Reunion, F = Argentina, G = Australia, H = Japan<br>
38				The carriage return start bit begins on 0 seconds and extends to 1 bit time.
39                        <dt>TL-3 WWV Receiver:
40                        <dd>? receiver is unlocked<br>
41                        <dd>space +/- 5 milliseconds<br>
42		</dl>
43		<h4>Notes on 468-DC and OMEGA receiver:</h4>
44		<p>Send the clock a <tt>R</tt> or <tt>C</tt> and once per second a timestamp will appear. Send a <tt>R</tt> to get the satellite position once (GOES only).</p>
45		<h4>Notes on the 468-DC receiver:</h4>
46		<p>Since the old east/west satellite locations are only historical, you can't set your clock propagation delay settings correctly and still use automatic mode. The manual says to use a compromise when setting the switches. This results in significant errors. The solution; use fudge time1 and time2 to incorporate corrections. If your clock is set for 50 and it should be 58 for using the west and 46 for using the east, use the line</p>
47		<p><tt>fudge 127.127.5.0 time1 +0.008 time2 -0.004</tt></p>
48		<p>This corrects the 4 milliseconds advance and 8 milliseconds retard needed. The software will ask the clock which satellite it sees.</p>
49		<p>The PCL720 from PC Labs has an Intel 8253 look-alike, as well as a bunch of TTL input and output pins, all brought out to the back panel. If you wire a PPS signal (such as the TTL PPS coming out of a GOES or other Kinemetrics/Truetime clock) to the 8253's GATE0, and then also wire the 8253's OUT0 to the PCL720's INPUT3.BIT0, then we can read CTR0 to get the number of microseconds since the last PPS upward edge, mediated by reading OUT0 to find out if the counter has wrapped around (this happens if more than 65535us (65ms) elapses between the PPS event and our being called.)</p>
50                <h4>Notes on the TL-3 receiver:</h4>
51                <p>The mini-DIN RS-232 port uses the Apple pinout.<br>
52                Send the clock ST1 to turn on continuous (1/sec) timecodes.
53You can also enable "mode C" via the front panel.  ST0 turns off this mode.<br>
54QV will return the firmware revision (and is useful in identifying this clock.)<br>
55QW will return its weekly signal log, useful if you're testing antennas.  You may wish to turn the loss interval down from 4h (04) to 1h (01), so the receiver declares itself unlocked sooner.  When in holdover, drift can be on the order of 10 ms/hr since there is no high quality reference oscillator.</p>
56		<h4>Monitor Data</h4>
57		<p>When enabled by the <tt>flag4</tt> fudge flag, every received timecode is written as-is to the <tt>clockstats</tt> file.</p>
58		<h4>Fudge Factors</h4>
59		<dl>
60			<dt><tt>time1 <i>time</i></tt>
61			<dd>Specifies the time offset calibration factor, in seconds and fraction, to be used for the West satellite, with default 0.0.
62			<dt><tt>time2 <i>time</i></tt>
63			<dd>. Specifies the time offset calibration factor, in seconds and fraction, to be used for the East satellite, with default 0.0.
64			<dt><tt>stratum <i>number</i></tt>
65			<dd>Specifies the driver stratum, in decimal from 0 to 15, with default 0.
66			<dt><tt>refid <i>string</i></tt>
67			<dd>Specifies the driver reference identifier, an ASCII string from one to four characters, with default <tt>TRUE</tt>.
68			<dt><tt>flag1 0 | 1</tt>
69			<dd>Silence the clock side of ntpd, just reading the clock without trying to write to it.
70			<dt><tt>flag2 0 | 1</tt>
71			<dd>Generate a debug file /tmp/true%d.
72			<dt><tt>flag3 0 | 1</tt>
73			<dd>Not used by this driver.
74			<dt><tt>flag4 0 | 1</tt>
75			<dd>Enable verbose <tt>clockstats</tt> recording if set.
76		</dl>
77		<h4>Additional Information</h4>
78		<p><a href="../refclock.html">Reference Clock Drivers</a></p>
79		<hr>
80		<script type="text/javascript" language="javascript" src="scripts/footer.txt"></script>
81	</body>
82
83</html>
84