Change the default for ntpd back to -s, the bug which triggered this
[dragonfly.git] / contrib / ntp / html / driver5.htm
1 <HTML>
2 <HEAD>
3    <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
4    <META NAME="GENERATOR" CONTENT="Mozilla/4.01 [en] (Win95; I) [Netscape]">
5    <TITLE>TrueTime GPS/GOES/OMEGA Receivers
6 </TITLE>
7 </HEAD>
8 <BODY>
9
10 <H3>
11 TrueTime GPS/GOES/OMEGA Receivers</H3>
12
13 <HR>
14 <H4>
15 Synopsis</H4>
16 Address: 127.127.5.<I>u</I>
17 <BR>Reference ID: <TT>GPS, OMEGA, GOES</TT>
18 <BR>Driver ID: <TT>TRUETIME</TT>
19 <BR>Serial Port: <TT>/dev/true<I>u</I></TT>; 9600 baud, 8-bits, no parity
20 <BR>Features: <TT>tty_clk</TT>
21 <H4>
22 Description</H4>
23 This driver supports several models models of Kinemetrics/TrueTime timing
24 receivers, including 468-DC MK III GOES Synchronized Clock, GPS- DC MK
25 III and GPS/TM-TMD GPS Synchronized Clock, XL-DC (a 151-602-210, reported
26 by the driver as a GPS/TM-TMD), GPS-800 TCU (an 805-957 with the RS232
27 Talker/Listener module), OM-DC OMEGA Synchronized Clock, and very likely
28 others in the same model family that use the same timecode formats.
29
30 <P>Most of this code is originally from refclock_wwvb.c with thanks. It
31 has been so mangled that wwvb is not a recognizable ancestor.
32 <PRE>Timcode format: ADDD:HH:MM:SSQCL
33
34 A - control A (this is stripped before we see it)
35 Q - Quality indication (see below)
36 C - Carriage return
37 L - Line feed
38
39 Quality codes indicate possible error of
40
41 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; 468-DC GOES Receiver:
42 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; GPS-TM/TMD Receiver:
43 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ? +/- 500 milliseconds&nbsp; # +/- 50 milliseconds
44 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; * +/- 5 milliseconds&nbsp;&nbsp;&nbsp; . +/- 1 millisecond
45 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; space less than 1 millisecond
46
47 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; OM-DC OMEGA Receiver:
48
49 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; > +/- 5 seconds
50
51 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; ? +/- 500 milliseconds&nbsp; # +/- 50 milliseconds
52 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; * +/- 5 milliseconds&nbsp;&nbsp;&nbsp; . +/- 1 millisecond
53
54 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; A-H less than 1 millisecond. Character indicates which
55 station
56 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; is being received as follows: A = Norway, B = Liberia,
57 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; C = Hawaii, D = North Dakota, E = La Reunion, F =
58 Argentina,
59 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; G = Australia, H = Japan.</PRE>
60 The carriage return start bit begins on 0 seconds and extends to 1 bit
61 time.
62
63 <P>Notes on 468-DC and OMEGA receiver:
64
65 <P>Send the clock a <TT>R</TT> or <TT>C</TT> and once per second a timestamp
66 will appear. Send a <TT>R</TT> to get the satellite position once (GOES
67 only).
68
69 <P>Notes on the 468-DC receiver:
70
71 <P>Since the old east/west satellite locations are only historical, you
72 can't set your clock propagation delay settings correctly and still use
73 automatic mode. The manual says to use a compromise when setting the switches.
74 This results in significant errors. The solution; use fudge time1 and time2
75 to incorporate corrections. If your clock is set for 50 and it should be
76 58 for using the west and 46 for using the east, use the line
77
78 <P><TT>fudge 127.127.5.0 time1 +0.008 time2 -0.004</TT>
79
80 <P>This corrects the 4 milliseconds advance and 8 milliseconds retard needed.
81 The software will ask the clock which satellite it sees.
82
83 <P>The PCL720 from PC Labs has an Intel 8253 look-alike, as well as a bunch
84 of TTL input and output pins, all brought out to the back panel. If you
85 wire a PPS signal (such as the TTL PPS coming out of a GOES or other Kinemetrics/Truetime
86 clock) to the 8253's GATE0, and then also wire the 8253's OUT0 to the PCL720's
87 INPUT3.BIT0, then we can read CTR0 to get the number of microseconds since
88 the last PPS upward edge, mediated by reading OUT0 to find out if the counter
89 has wrapped around (this happens if more than 65535us (65ms) elapses between
90 the PPS event and our being called.)
91 <H4>
92 Monitor Data</H4>
93 When enabled by the <TT>flag4</TT> fudge flag, every received timecode
94 is written as-is to the <TT>clockstats</TT> file.
95 <H4>
96 Fudge Factors</H4>
97
98 <DL>
99 <DT>
100 <TT>time1 <I>time</I></TT></DT>
101
102 <DD>
103 Specifies the time offset calibration factor, in seconds and fraction,
104 to be used for the West satellite, with default 0.0.</DD>
105
106 <DT>
107 <TT>time2 <I>time</I></TT></DT>
108
109 <DD>
110 . Specifies the time offset calibration factor, in seconds and fraction,
111 to be used for the East satellite, with default 0.0.</DD>
112
113 <DT>
114 <TT>stratum <I>number</I></TT></DT>
115
116 <DD>
117 Specifies the driver stratum, in decimal from 0 to 15, with default 0.</DD>
118
119 <DT>
120 <TT>refid <I>string</I></TT></DT>
121
122 <DD>
123 Specifies the driver reference identifier, an ASCII string from one to
124 four characters, with default <TT>TRUE</TT>.</DD>
125
126 <DT>
127 <TT>flag1 0 | 1</TT></DT>
128
129 <DD>
130 Silence the clock side of ntpd, just reading the clock without trying to
131 write to it.</DD>
132
133 <DT>
134 <TT>flag2 0 | 1</TT></DT>
135
136 <DD>
137 Generate a debug file /tmp/true%d.</DD>
138
139 <DT>
140 <TT>flag3 0 | 1</TT></DT>
141
142 <DD>
143 Not used by this driver.</DD>
144
145 <DT>
146 <TT>flag4 0 | 1</TT></DT>
147
148 <DD>
149 Not used by this driver.</DD>
150 </DL>
151 Additional Information
152
153 <P><A HREF="refclock.htm">Reference Clock Drivers</A>&nbsp;
154 <HR>
155 <ADDRESS>
156 David L. Mills (mills@udel.edu)</ADDRESS>
157
158 </BODY>
159 </HTML>