docs/driver_truetime.adoc

   1 = TrueTime GPS/GOES Receivers
   2 include::include-html.ad[]
   3
   4 == Synopsis
   5
   6 ["verse",subs="normal"]
   7 Name: truetime
   8 Reference ID: TRUE
   9 Serial Port: +/dev/true+'u'; 9600 bps 8N1
  10 Features: +tty_clk+
  11
  12 == Deprecation warning
  13
  14 This refclock is deprecated and obsolete. The NTPsec maintainers plan
  15 to remove it in a future release.  If you have a requirement for it,
  16 please make this known to us.
  17
  18 This driver reports only two-digit years, and is thus reliant on the
  19 system clock to be near correct before samples will be processed
  20 properly. You will not be able to use it to run autonomously, nor will
  21 it reliably recover from a trashed or zeroed system clock.
  22
  23 It is likely any surving instances of this hardware will have
  24 era-rollover issues when reporting dates. One or more "g" suffixes
  25 on your 'time1' option may be useful as a workaround.
  26
  27 == Description
  28
  29 This driver supports several models of Kinemetrics/TrueTime
  30 timing receivers, including GPS- DC MK III and GPS/TM-TMD GPS
  31 Synchronized Clock, XL-DC (a 151-602-210, reported by the driver as a
  32 GPS/TM-TMD), GPS-800 TCU (an 805-957 with the RS232 Talker/Listener
  33 module), and very likely others in the same model families that use
  34 the same timecode formats.
  35
  36 Most of this code is originally from refclock_wwvb.c (now
  37 refclock_spectracom.c) with thanks. It has been so mangled that wwvb is
  38 not a recognizable ancestor.
  39
  40 [literal]
  41 Timecode format: ADDD:HH:MM:SSQCL
  42 A - control A (this is stripped before we see it)
  43 Q - Quality indication (see below)
  44 C - Carriage return
  45 L - Line feed
  46
  47
  48 Quality codes indicate possible error of:
  49
  50 --------------------------------------------------
  51 GPS-TM/TMD Receiver
  52     ? +/- 500 milliseconds # +/- 50 milliseconds
  53     * +/- 5 milliseconds . +/- 1 millisecond
  54     space less than 1 millisecond
  55 --------------------------------------------------
  56
  57 In general, an alarm condition is indicated by ? at A, which occurs during
  58 initial synchronization and when received signal is lost for an
  59 extended period; unlock condition is indicated by other than <SP>
  60 in the quality field.
  61
  62 == Notes on the TL-3 receiver:
  63
  64 The mini-DIN RS-232 port uses the Apple pinout.
  65
  66 Send the clock ST1 to turn on continuous (1/s) timecodes. You can
  67 also enable "mode C" via the front panel. ST0 turns off this mode.
  68
  69 QV will return the firmware revision (and is useful in identifying
  70 this clock.)
  71
  72 QW will return its weekly signal log, useful if you're testing
  73 antennas. You may wish to turn the loss interval down from 4 h (04) to 1 h
  74 (01), so the receiver declares itself unlocked sooner. When in holdover,
  75 drift can be on the order of 10 ms/hr since there is no high quality
  76 reference oscillator.
  77
  78 == Monitor Data
  79
  80 When enabled by the +flag4+ option, every received timecode is
  81 written as-is to the +clockstats+ file.
  82
  83 == Driver Options
  84
  85 +unit+ 'number'::
  86   The driver unit number, defaulting to 0. Used as a distinguishing
  87   suffix in the driver device name.
  88 +time1+ 'time'::
  89    Specifies the time offset calibration factor, in seconds and fraction,
  90    to be used for the West satellite, with default 0.0.
  91 +time2 time+::
  92    Specifies the time offset calibration factor, in seconds and fraction,
  93    to be used for the East satellite, with default 0.0.
  94 +stratum+ 'number'::
  95    Specifies the driver stratum, in decimal from 0 to 15, with default 0.
  96 +refid+ 'string'::
  97    Specifies the driver reference identifier, an ASCII string from one to
  98    four characters, with default +TRUE+.
  99 +flag1 {0 | 1}+::
 100    Silence the clock side of ntpd, just reading the clock without trying to
 101    write to it.
 102 +flag2 {0 | 1}+::
 103    Generate a debug file /tmp/true%d.
 104 +flag3 {0 | 1}+::
 105    Not used by this driver.
 106 +flag4 {0 | 1}+::
 107    Enable verbose +clockstats+ recording if set.
 108 +subtype+::
 109    Not used by this driver.
 110 +mode+::
 111    Not used by this driver.
 112 +path+ 'filename'::
 113   Overrides the default device path.
 114 +ppspath+ 'filename'::
 115   Not used by this driver.
 116 +baud+ 'number'::
 117   Overrides the default baud rate.
 118
 119 == Configuration Example
 120
 121 ----------------------------------------------------------------------------
 122 refclock truetime
 123 ----------------------------------------------------------------------------
 124
 125 == Additional Information
 126
 127 link:refclock.html[Reference Clock Drivers]
 128
 129 '''''
 130
 131 include::includes/footer.adoc[]