Initial import from FreeBSD RELENG_4:
[dragonfly.git] / contrib / ntp / html / driver4.htm
1 <HTML><HEAD><TITLE>
2 Spectracom 8170 and Netclock/2 WWVB Receivers
3 </TITLE></HEAD><BODY><H3>
4 Spectracom 8170 and Netclock/2 WWVB Receivers
5 </H3><HR>
6
7 <H4>Synopsis</H4>
8
9 Address: 127.127.4.<I>u</I>
10 <BR>Reference ID: <TT>WWVB</TT>
11 <BR>Driver ID: <TT>WWVB_SPEC</TT>
12 <BR>Serial Port: <TT>/dev/wwvb<I>u</I></TT>; 9600 baud, 8-bits, no
13 parity
14 <BR>Features: <TT>tty_clk</TT>
15
16 <H4>Description</H4>
17
18 This driver supports all known Spectracom radio and satellite clocks,
19 including the Model 8170 and Netclock/2 WWVB Synchronized Clocks and the
20 Netclock/GPS GPS Master Clock. The claimed accuracy of the WWVB clocks
21 is 100 usec relative to the broadcast signal. These clocks have proven a
22 reliable source of time, except in some parts of the country with high
23 levels of conducted RF interference. WIth the GPS clock the claimed
24 accuracy is 130 ns. However, in most cases the actual accuracy is
25 limited by the precision of the timecode and the latencies of the serial
26 interface and operating system.
27
28 <P>The DIPswitches on these clocks should be set to 24-hour display,
29 AUTO DST off, data format 0 or 2 (see below) and baud rate 9600. If this
30 clock is used as the source for the IRIG Audio Decoder
31 (<tt>refclock_irig.c</tt> in this distribution), set the DIPswitches for
32 AM IRIG output and IRIG format 1 (IRIG B with signature control).
33
34 <P>There are two timecode formats used by these clocks. Format 0, which
35 is available with all clocks, and format 2, which is available with all
36 clocks except the original (unmodified) Model 8170.
37
38 <P>Format 0 (22 ASCII printing characters):
39 <br>&lt;cr&gt;&lt;lf&gt;i ddd hh:mm:ss TZ=zz&lt;cr&gt;&lt;lf&gt;
40
41 <p>on-time = first &lt;cr&gt;
42 <br>i = synchronization flag (' ' = in synch, '?' = out synch)
43 <br>hh:mm:ss = hours, minutes, seconds</PRE>
44
45 <p>The alarm condition is indicated by other than ' ' at <TT>i</TT>,
46 which occurs during initial synchronization and when received signal is
47 lost for about ten hours.
48
49 <P>Format 2 (24 ASCII printing characters):
50 <br>lt;cr&gt;lf&gt;iqyy ddd hh:mm:ss.fff ld
51
52 <p>on-time = &lt;cr>
53 <br>i = synchronization flag (' ' = in synch, '?' = out synch)
54 <br>q = quality indicator (' ' = locked, 'A'...'D' = unlocked)
55 <br>yy = year (as broadcast)
56 <br>ddd = day of year
57 <br>hh:mm:ss.fff = hours, minutes, seconds, milliseconds</PRE>
58
59 <p>The alarm condition is indicated by other than ' ' at <TT>i</TT>,
60 which occurs during initial synchronization and when received signal is
61 lost for about ten hours. The unlock condition is indicated by other
62 than ' ' at <TT>q</TT>.
63
64 <P>The <TT>q</TT> is normally ' ' when the time error is less than 1 ms
65 and a character in the set <TT>A...D</TT> when the time error is less
66 than 10, 100, 500 and greater than 500 ms respectively. The <TT>l</TT>
67 is normally ' ', but is set to <TT>L</TT> early in the month of an
68 upcoming UTC leap second and reset to ' ' on the first day of the
69 following month. The <TT>d</TT> is set to <TT>S</TT> for standard time
70 <TT>S</TT>, <TT>I</TT> on the day preceding a switch to daylight time,
71 <TT>D</TT> for daylight time and <TT>O</TT> on the day preceding a
72 switch to standard time. The start bit of the first
73 &lt;cr&gt; is synchronized to the indicated time as returned.
74
75 <P>This driver does not need to be told which format is in use - it
76 figures out which one from the length of the message. A three-stage
77 median filter is used to reduce jitter and provide a dispersion measure.
78 The driver makes no attempt to correct for the intrinsic jitter of the
79 radio itself, which is a known problem with the older radios.
80
81 <H4>Monitor Data</H4>
82
83 The driver writes each timecode as received to the <TT>clockstats</TT>
84 file. When enabled by the <TT>flag4</TT> fudge flag, a table of quality
85 data maintained internally by the Netclock/2 is retrieved and written to
86 the <TT>clockstats</TT> file when the first timecode message of a new
87 dayis received.
88
89 <H4>Fudge Factors</H4>
90
91 <DL>
92
93 <DT><TT>time1 <I>time</I></TT></DT>
94 <DD>Specifies the time offset calibration factor, in seconds and
95 fraction,
96 with default 0.0.</DD>
97
98 <DT><TT>time2 <I>time</I></TT></DT>
99 <DD>Not used by this driver.</DD>
100
101 <DT><TT>stratum <I>number</I></TT></DT>
102 <DD>Specifies the driver stratum, in decimal from 0 to 15, with default
103 0.</DD>
104
105 <DT><TT>refid <I>string</I></TT></DT>
106 <DD>Specifies the driver reference identifier, an ASCII string from one
107 to four characters, with default <TT>WWVB</TT>.</DD>
108
109 <DT><TT>flag1 0 | 1</TT></DT>
110 <DD>Not used by this driver.</DD>
111
112 <DT><TT>flag2 0 | 1</TT></DT>
113 <DD>Not used by this driver.</DD>
114
115 <DT><TT>flag3 0 | 1</TT></DT>
116 <DD>Not used by this driver.</DD>
117
118 <DT><TT>flag4 0 | 1</TT></DT>
119 <DD>Enable verbose <TT>clockstats</TT> recording if set.</DD>
120
121 </DL>
122
123 Additional Information
124
125 <P><A HREF="refclock.htm">Reference Clock Drivers</A>
126 <HR><ADDRESS>David L. Mills (mills@udel.edu)</ADDRESS></BODY></HTML>