xref: /src/external/bsd/ntp/dist/html/parsedata.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>

	<head>
		<meta http-equiv="content-type" content="text/html;charset=iso-8859-1">
		<meta name="generator" content="HTML Tidy, see www.w3.org">
		<title>NTP PARSE clock data formats</title>
		<link href="scripts/style.css" type="text/css" rel="stylesheet">
	</head>

	<body>
		<h3>NTP PARSE clock data formats</h3>
		<p>The parse driver currently supports several clocks with different query mechanisms. In order for you to find a sample that might be similar to a clock you might want to integrate into parse I'll sum up the major features of the clocks (this information is distributed in the parse/clk_*.c and ntpd/refclock_parse.c files).</p>
		<hr>
		<h4>Meinberg clocks</h4>
		<pre>
Meinberg: start=&lt;STX&gt;, end=&lt;ETX&gt;, sync on start
      pattern=&quot;\2D:  .  .  ;T: ;U:  .  .  ;    \3&quot;
      pattern=&quot;\2  .  .  ;  ;   :  :  ;        \3&quot;
      pattern=&quot;\2  .  .  ;  ;   :  :  ;    :  ;        ;   .         .       &quot;
</pre>
		<p>Meinberg is a German manufacturer of time code receivers. Those clocks have a pretty common output format in the stock version. In order to support NTP Meinberg was so kind to produce some special versions of the firmware for the use with NTP. So, if you are going to use a Meinberg clock please ask whether there is a special Uni Erlangen version. You can reach <a href="http://www.meinberg.de/">Meinberg</a> via the Web. Information can also be ordered via eMail from <a href="mailto:%20info (a] meinberg.de">info (a] meinberg.de</a></p>
		<p>General characteristics:<br>
			Meinberg clocks primarily output pulse per second and a describing ASCII string. This string can be produced in two modes: either upon the reception of a question mark or every second. NTP uses the latter mechanism. DCF77 AM clocks have a limited accuracy of a few milliseconds. The DCF77 PZF5xx variants provide higher accuracy and have a pretty good relationship between RS232 time code and the PPS signal. Except for early versions of the old GPS166 receiver type, Meinberg GPS receivers have a very good timing relationship between the datagram and the pulse. The beginning of the start bit of the first character has basically the same accuracy as the PPS signal, plus a jitter of up to 1 bit time depending on the selected baud rate, i.e. 52 &mu;s @ 19200. PPS support should always be used, if possible, in order to yield the highest possible accuracy.</p>
		<p>The preferred tty setting for Meinberg DCF77 receivers is 9600/7E2:</p>
		<pre>
		CFLAG		(B9600|CS7|PARENB|CREAD|HUPCL)
		IFLAG		(IGNBRK|IGNPAR|ISTRIP)
		OFLAG		0
		LFLAG		0
        </pre>
		<p>The tty setting for Meinberg GPS16x/17x receivers is 19200/8N1:</p>
		<pre>
		CFLAG		(B19200|CS8|PARENB|CREAD|HUPCL)
		IFLAG		(IGNBRK|IGNPAR|ISTRIP)
		OFLAG		0
		LFLAG		0
        </pre>
		<p>All clocks should be run at datagram once per second.<br><br></p>
		<p>Format of the Meinberg standard time string:</p>
<pre>
        <b><i>&lt;STX&gt;</i>D:<i>dd.mm.yy</i>;T:<i>w</i>;U:<i>hh.mm.ss</i>;<i>uvxy</i><i>&lt;ETX&gt;</i></b>
    pos:  0  000000001111111111222222222233  3
          1  234567890123456789012345678901  2

    <i>&lt;STX&gt;</i>         = start-of-text, ASCII code 0x02
    <i>dd.mm.yy</i>      = day of month, month, year of the century, separated by dots
    <i>w</i>             = day of week (1..7, Monday = 1)
    <i>hh:mm:ss</i>      = hour, minute, second, separated by dots
    <i>u</i>             = '#' for GPS receivers: time is <b>not</b> synchronized
                           '#' for older PZF5xx receivers: no correlation, not synchronized
                           '#' for other devices: never sync'ed since powerup
                           ' ' if nothing of the above applies
    <i>v</i>             = '*' for GPS receivers: position has <b>not</b> been verified
                           '*' for other devices: freewheeling based on internal quartz
                           ' ' if nothing of the above applies
    <i>x</i>             = 'U' if UTC time is transmitted
                           'S' if daylight saving time is active
                           ' ' if nothing of the above applies
    <i>y</i>             = '!' during the hour preceding start or end of daylight saving time
                           'A' during the hour preceding a leap second
                           ' ' if nothing of the above applies
    <i>&lt;ETX&gt;</i>         = end-of-text, ASCII code 0x03
</pre>
		<p>Format of the Uni Erlangen time string for PZF5xx receivers:</p>
<pre>
        <b><i>&lt;STX&gt;</i><i>dd.mm.yy</i>; <i>w</i>; <i>hh:mm:ss</i>; <i>tuvxyza</i><i>&lt;ETX&gt;</i></b>
    pos:  0  000000001111111111222222222233  3
          1  234567890123456789012345678901  2

    <i>&lt;STX&gt;</i>         = start-of-text, ASCII code 0x02
    <i>dd.mm.yy</i>      = day of month, month, year of the century, separated by dots
    <i>w</i>             = day of week (1..7, Monday = 1)
    <i>hh:mm:ss</i>      = hour, minute, second, separated by colons

    <i>t</i>             = 'U' if UTC time is transmitted, else ' '
    <i>u</i>             = '#' for older PZF5xx receivers: no correlation, not synchronized
                           '#' for PZF511 and newer: never sync'ed since powerup
                           ' ' if nothing of the above applies
    <i>v</i>             = '*' if freewheeling based on internal quartz, else ' '
    <i>x</i>             = 'S' if daylight saving time is active, else ' '
    <i>y</i>             = '!' during the hour preceding start or end of daylight saving time, else ' '
    <i>z</i>             = 'A' during the hour preceding a leap second, else ' '
    <i>a</i>             = 'R' alternate antenna (reminiscent of PZF5xx), usually ' ' for GPS receivers
    <i>&lt;ETX&gt;</i>         = end-of-text, ASCII code 0x03
</pre>
		<p>Format of the Uni Erlangen time string for GPS16x/GPS17x receivers:</p>
<pre>
        <b><i>&lt;STX&gt;</i><i>dd.mm.yy</i>; <i>w</i>; <i>hh:mm:ss</i>; <i>+uu:uu</i>; <i>uvxyzab</i>; <i>ll.lllln</i> <i>lll.lllle</i> <i>hhhh</i>m<i>&lt;ETX&gt;</i></b>
    pos:  0  0000000011111111112222222222333333333344444444445555555555666666  6
          1  2345678901234567890123456789012345678901234567890123456789012345  6

    <i>&lt;STX&gt;</i>         = start-of-text, ASCII code 0x02
    <i>dd.mm.yy</i>      = day of month, month, year of the century, separated by dots
    <i>w</i>             = day of week (1..7, Monday = 1)
    <i>hh:mm:ss</i>      = hour, minute, second, separated by colons
    <i>+uu:uu</i>        = offset to UTC in hours and minutes, preceded by + or -
    <i>u</i>             = '#' if time is <b>not</b> synchronized, else ' '
    <i>v</i>             = '*' if position has <b>not</b> been verified, else ' '
    <i>x</i>             = 'S' if daylight saving time is active, else ' '
    <i>y</i>             = '!' during the hour preceding start or end of daylight saving time, else ' '
    <i>z</i>             = 'A' during the hour preceding a leap second, else ' '
    <i>a</i>             = 'R' alternate antenna (reminiscent of PZF5xx), usually ' ' for GPS receivers
    <i>b</i>             = 'L' during a leap second, i.e. if the seconds field is 60, else ' '
    <i>ll.lllln</i>      = position latitude in degrees, 'n' can actually be 'N' or 'S', i.e. North or South
    <i>lll.lllle</i>     = position longitude in degrees, 'e' can actually be 'E' or 'W', i.e. East or West
    <i>hhhh</i>          = position altitude in meters, always followed by 'm'
    <i>&lt;ETX&gt;</i>         = end-of-text, ASCII code 0x03
</pre>
		<p>Examples for Uni Erlangen strings from GPS receivers:</p>
<pre>
        \x02 09.07.93; 5; 08:48:26; +00:00;        ; 49.5736N  11.0280E  373m \x03
        \x02 08.11.06; 3; 14:39:39; +00:00;        ; 51.9828N   9.2258E  176m \x03
</pre>
		<p>The Uni Erlangen formats should be used preferably. Newer Meinberg GPS receivers can be configured to transmit that format, for older devices there may be a special firmware version available.</p>
		<p>For the Meinberg parse look into clk_meinberg.c<br><br></p>
		<hr>
		<h4>Raw DCF77 Data via serial line</h4>
		<p>RAWDCF: end=TIMEOUT&gt;1.5s, sync each char (any char),generate psuedo time codes, fixed format</p>
		<p>direct DCF77 code input</p>
		<p>In Europe it is relatively easy/cheap the receive the german time code transmitter DCF77. The simplest version to process its signal is to feed the 100/200ms pulse of the demodulated AM signal via a level converter to an RS232 port at 50Baud. parse/clk_rawdcf.c holds all necessary decoding logic for the time code which is transmitted each minute for one minute. A bit of the time code is sent once a second.</p>
		<pre>
	The preferred tty setting is:
		CFLAG           (B50|CS8|CREAD|CLOCAL)
		IFLAG		0
		OFLAG		0
 		LFLAG		0
</pre>
		<h4>DCF77 raw time code</h4>
		<p>From &quot;Zur Zeit&quot;, Physikalisch-Technische Bundesanstalt (PTB), Braunschweig und Berlin, M&auml;rz 1989<br>
		</p>
		<p>Timecode transmission:</p>
		<pre>
	AM:

	time marks are send every second except for the second before the
	next minute mark
	time marks consist of a reduction of transmitter power to 25%
	of the nominal level
	the falling edge is the time indication (on time)
	time marks of a 100ms duration constitute a logical 0
	time marks of a 200ms duration constitute a logical 1
</pre>
		<p>see the spec. (basically a (non-)inverted psuedo random phase shift) encoding:</p>
		<pre>
	FM:

	Second	Contents
	0  - 10	AM: free, FM: 0
	11 - 14	free
	15		R     - alternate antenna
	16		A1    - expect zone change (1 hour before)
	17 - 18	Z1,Z2 - time zone
		 0  0 illegal
		 0  1 MEZ  (MET)
		 1  0 MESZ (MED, MET DST)
		 1  1 illegal
	19	A2    - expect leap insertion/deletion (1 hour before)
	20	S     - start of time code (1)
	21 - 24	M1    - BCD (lsb first) Minutes
	25 - 27	M10   - BCD (lsb first) 10 Minutes
	28	P1    - Minute Parity (even)
	29 - 32	H1    - BCD (lsb first) Hours
	33 - 34	H10   - BCD (lsb first) 10 Hours
	35	P2    - Hour Parity (even)
	36 - 39	D1    - BCD (lsb first) Days
	40 - 41	D10   - BCD (lsb first) 10 Days
	42 - 44	DW    - BCD (lsb first) day of week (1: Monday -&gt; 7: Sunday)
	45 - 49	MO1   - BCD (lsb first) Month
	50	MO10  - 10 Months
	51 - 53	Y1    - BCD (lsb first) Years
	54 - 57	Y10   - BCD (lsb first) 10 Years
	58 	P3    - Date Parity (even)
	59	      - usually missing (minute indication), except for leap insertion
</pre>
		<hr>
		<h4>Schmid clock</h4>
		<p>Schmid clock: needs poll, binary input, end='\xFC', sync start</p>
		<p>The Schmid clock is a DCF77 receiver that sends a binary time code at the reception of a flag byte. The contents if the flag byte determined the time code format. The binary time code is delimited by the byte 0xFC.</p>
		<pre>
	TTY setup is:
		CFLAG		(B1200|CS8|CREAD|CLOCAL)
		IFLAG		0
		OFLAG		0
 		LFLAG		0

</pre>
		<p>The command to Schmid's DCF77 clock is a single byte; each bit allows the user to select some part of the time string, as follows (the output for the lsb is sent first).</p>
		<pre>
	Bit 0:	time in MEZ, 4 bytes *binary, not BCD*; hh.mm.ss.tenths
	Bit 1:	date 3 bytes *binary, not BCD: dd.mm.yy
	Bit 2:	week day, 1 byte (unused here)
	Bit 3:	time zone, 1 byte, 0=MET, 1=MEST. (unused here)
	Bit 4:	clock status, 1 byte,	0=time invalid,
					1=time from crystal backup,
					3=time from DCF77
	Bit 5:	transmitter status, 1 byte,
					bit 0: backup antenna
					bit 1: time zone change within 1h
					bit 3,2: TZ 01=MEST, 10=MET
					bit 4: leap second will be
						added within one hour
					bits 5-7: Zero
	Bit 6:	time in backup mode, units of 5 minutes (unused here)
</pre>
		<hr>
		<h4>Trimble SV6 ASCII time code (TAIP)</h4>
		<p>Trimble SV6: needs poll, ascii timecode, start='&gt;', end='&lt;', query='&gt;QTM&lt;', eol='&lt;'</p>
		<p>Trimble SV6 is a GPS receiver with PPS output. It needs to be polled. It also need a special tty mode setup (EOL='&lt;').</p>
		<pre>
	TTY setup is:
		CFLAG            (B4800|CS8|CREAD)
		IFLAG            (BRKINT|IGNPAR|ISTRIP|ICRNL|IXON)
		OFLAG            (OPOST|ONLCR)
		LFLAG            (ICANON|ECHOK)
</pre>
		<p>Special flags are:</p>
		<pre>		PARSE_F_PPSPPS	    - use CIOGETEV for PPS time stamping
		PARSE_F_PPSONSECOND - the time code is not related to
				      the PPS pulse (so use the time code
				      only for the second epoch)

	Timecode
	0000000000111111111122222222223333333	/ char
	0123456789012345678901234567890123456	\ posn
	&gt;RTMhhmmssdddDDMMYYYYoodnnvrrrrr;*xx&lt;	Actual
	----33445566600112222BB7__-_____--99-	Parse
	&gt;RTM                      1     ;*  &lt; 	Check
</pre>
		<hr>
		<h4>ELV DCF7000</h4>
		<p>ELV DCF7000: end='\r', pattern=&quot; - - - - - - - \r&quot;</p>
		<p>The ELV DCF7000 is a cheap DCF77 receiver sending each second a time code (though not very precise!) delimited by '`r'</p>
		<pre>
	Timecode
	  YY-MM-DD-HH-MM-SS-FF\r

		FF&amp;0x1	- DST
		FF&amp;0x2	- DST switch warning
		FF&amp;0x4  - unsynchronised
</pre>
		<hr>
		<h4>HOPF 6021 und Kompatible</h4>
		<p>HOPF Funkuhr 6021 mit serieller Schnittstelle Created by F.Schnekenbuehl &lt;frank (a] comsys.dofn.de&gt; from clk_rcc8000.c Nortel DASA Network Systems GmbH, Department: ND250 A Joint venture of Daimler-Benz Aerospace and Nortel.</p>
		<pre>
 hopf Funkuhr 6021 
      used with 9600,8N1,
      UTC via serial line
      &quot;Sekundenvorlauf&quot; ON
      ETX zum Sekundenvorlauf ON
      dataformat 6021
      output time and date
      transmit with control characters
      transmit evry second
 </pre>
		<p>Type 6021 Serial Output format</p>
		<pre>
      000000000011111111 / char
      012345678901234567 \ position
      sABHHMMSSDDMMYYnre  Actual
       C4110046231195     Parse
      s              enr  Check

  s = STX (0x02), e = ETX (0x03)
  n = NL  (0x0A), r = CR  (0x0D)

  A B - Status and weekday
 
  A - Status

      8 4 2 1
      x x x 0  - no announcement
      x x x 1  - Summertime - wintertime - summertime announcement
      x x 0 x  - Wintertime
      x x 1 x  - Summertime
      0 0 x x  - Time/Date invalid
      0 1 x x  - Internal clock used 
      1 0 x x  - Radio clock
      1 1 x x  - Radio clock highprecision

  B - 8 4 2 1
      0 x x x  - MESZ/MEZ
      1 x x x  - UTC
      x 0 0 1  - Monday
      x 0 1 0  - Tuesday
      x 0 1 1  - Wednesday
      x 1 0 0  - Thursday
      x 1 0 1  - Friday
      x 1 1 0  - Saturday
      x 1 1 1  - Sunday
</pre>
		<hr>
		<h4>Diem Computime Clock</h4>
		<p>The Computime receiver sends a datagram in the following format every minute</p>
		<pre>   
   Timestamp	T:YY:MM:MD:WD:HH:MM:SSCRLF 
   Pos          0123456789012345678901 2 3
		0000000000111111111122 2 2
   Parse        T:  :  :  :  :  :  :  \r\n
   
   T	Startcharacter &quot;T&quot; specifies start of the timestamp 
   YY	Year MM	Month 1-12 
   MD	Day of the month 
   WD	Day of week 
   HH	Hour 
   MM   Minute 
   SS   Second
   CR   Carriage return 
   LF   Linefeed
</pre>
		<hr>
		<h4>WHARTON 400A Series Clock with a 404.2 Serial interface</h4>
		<p>The WHARTON 400A Series clock is able to send date/time serial messages in 7 output formats. We use format 1 here because it is the shortest. We set up the clock to send a datagram every second. For use with this driver, the WHARTON 400A Series clock must be set-up as follows :</p>
		<pre>
  					Programmable	Selected
  					Option No	Option
	BST or CET display		3		9 or 11
	No external controller		7		0
	Serial Output Format 1		9		1
	Baud rate 9600 bps		10		96
	Bit length 8 bits		11		8
	Parity even			12		E
</pre>
		<p>WHARTON 400A Series output format 1 is as follows :</p>
		<pre>
   Timestamp	STXssmmhhDDMMYYSETX
   Pos		0  12345678901234
  		0  00000000011111
  
   STX	start transmission (ASCII 0x02)
   ETX	end transmission (ASCII 0x03)
   ss	Second expressed in reversed decimal (units then tens)
   mm	Minute expressed in reversed decimal
   hh	Hour expressed in reversed decimal
   DD	Day of month expressed in reversed decimal
   MM	Month expressed in reversed decimal (January is 1)
   YY	Year (without century) expressed in reversed decimal
   S	Status byte : 0x30 +
		bit 0	0 = MSF source		1 = DCF source
		bit 1	0 = Winter time		1 = Summer time
		bit 2	0 = not synchronised	1 = synchronised
		bit 3	0 = no early warning	1 = early warning
</pre>
		<hr>
		<script type="text/javascript" language="javascript" src="scripts/footer.txt"></script>
	</body>

</html>