[Git][NTPsec/ntpsec][master] Fix driver_jjy formatting
Richard Laager
gitlab at mg.gitlab.com
Mon Dec 30 00:16:07 UTC 2019
Richard Laager pushed to branch master at NTPsec / ntpsec
Commits:
fbde514d by Richard Laager at 2019-12-29T18:15:41-06:00
Fix driver_jjy formatting
- - - - -
1 changed file:
- docs/driver_jjy.adoc
Changes:
=====================================
docs/driver_jjy.adoc
=====================================
@@ -32,23 +32,23 @@ sold in Japan, and the time service through a telephone line.
* [[subtype-1]]Tristate Ltd. TS-JJY01, TS-JJY02 https://www.tristate.ne.jp/ (Japanese only)
+
-NTP configuration ( {ntpconf} )::
+NTP configuration ({ntpconf})::
+
--
-refclock jjy unit X subtype 1 time1 0.NNN flag1 {0|1};;
- Time1 may specify a constant to be added to the time offset for the
+`refclock` _jjy_ `unit` _X_ `subtype` _1_ `time1` _0.NNN_ `flag1 {0 | 1}`;;
+ `time1` may specify a constant to be added to the time offset for the
time from the receiver, a fixed-point decimal number in seconds. You
- may specify the time offset from several tens of milliseconds (
- 0.0NN seconds ) to a hundred and several tens of milliseconds (
- 0.1NN seconds ) for this clock. +
- Flag1 has no effect for time synchronization. When flag1 is set to
- 1, status commands are issued before DATE and STIM commands, and
- write a response text into the clockstats file.
+ may specify the time offset from several tens of milliseconds (0.0NN
+ seconds) to a hundred and several tens of milliseconds (0.1NN seconds)
+ for this clock. +
+ `flag1` has no effect for time synchronization. When `flag1` is set to
+ 1, status commands are issued before `DATE` and `STIM` commands, and
+ write a response text into the `clockstats` file.
+
[width="100%",cols="<50%,<50%",]
|====================================
-|0 (Default) | DCST and STUS commands are not issued
-|1 | DCST and STUS commands are issued
+|0 (Default) | `DCST` and `STUS` commands are not issued
+|1 | `DCST` and `STUS` commands are issued
|====================================
--
+
@@ -57,12 +57,15 @@ RS-232C, 9600 bps, 8-bits, no parity, 1 stop bit;;
Time code format::
+
-Command -\-> Reply
-+dcst{CR}{LF}+ -\-> +valid{CR}{LF} | invalid{CR}{LF}+
-+stus{CR}{LF}+ -\-> +adjusted{CR}{LF} | unadjusted{CR}{LF}+
-+time{CR}{LF}+ -\-> +HH:MM:SS{CR}{LF}+
-+date{CR}{LF}+ -\-> +YYYY/MM/DD WWW{CR}{LF}+
-+stim{CR}{LF}+ -\-> +HH:MM:SS{CR}{LF}+
+[width="100%",cols="<25%,<10%,<65%",]
+|==================================================
+|Command | -\-> |Reply
+|`dcst{CR}{LF}`| -\-> |`valid{CR}{LF} \| invalid{CR}{LF}`
+|`stus{CR}{LF}`| -\-> |`adjusted{CR}{LF} \| unadjusted{CR}{LF}`
+|`time{CR}{LF}`| -\-> |`HH:MM:SS{CR}{LF}`
+|`date{CR}{LF}`| -\-> |`YYYY/MM/DD WWW{CR}{LF}`
+|`stim{CR}{LF}`| -\-> |`HH:MM:SS{CR}{LF}`
+|==================================================
+
The date and time are requested separately. The time is requested
before and after the date request to check uncertainty of the date
@@ -70,10 +73,10 @@ whether it's before or after midnight.
* [[subtype-2]]C-DEX Co.,Ltd. JST2000 http://www.c-dex.co.jp/ (Japanese only)
+
-NTP configuration ( {ntpconf} )::
+NTP configuration ({ntpconf})::
+
--
-refclock jjy unit X subtype 2 time1 0.NNN;;
+`refclock` _jjy_ `unit` _X_ `subtype` _2_ `time1` _0.NNN_;;
--
+
Interface::
@@ -81,15 +84,18 @@ RS-232C, 9600 bps, 8-bits, no parity, 1 stop bit;;
Time code format::
+
-Command -\-> Reply +
-+{ENQ}1J{ETX}+ -\-> +{STX}JYYMMDDWHHMMSSS{ETX}+
-
+[width="100%",cols="<25%,<10%,<65%",]
+|==================================================
+|Command | -\-> |Reply
+|`{ENQ}1J{ETX}`| -\-> |`{STX}JYYMMDDWHHMMSSS{ETX}`
+|==================================================
++
* [[subtype-3]]Echo Keisokuki Co.,Ltd. LT-2000
+
-NTP configuration ( {ntpconf} )::
+NTP configuration ({ntpconf})::
+
--
-refclock jjy unit X subtype 3 time1 0.NNN;;
+`refclock` _jjy_ `unit` _X_ `subtype` _3_ `time1` _0.NNN_;;
--
+
Interface::
@@ -97,22 +103,22 @@ RS-232C, 9600 bps, 8-bits, no parity, 1 stop bit;;
Time code format::
+
-[width="100%",cols="<45%,<10%,<45%",grid="none",frame="none"]
-|===================================================================
-|Command | -\-> | Reply
-|C | -\-> | ( Subtype 2 : Continuous )
-|( Every second before 0.5 second )| | +YYMMDDWHHMMSS{ST1}{ST2}{ST3}{ST4}{CR}+
-|# | -\-> | ( Subtype 1 : Request&Send )
-|===================================================================
+[width="100%",cols="<25%,<10%,<65%",]
+|==================================================
+|Command | -\-> |Reply
+|C | -\-> | (Subtype 2: Continuous)
+|(Every second before 0.5 second)| | `YYMMDDWHHMMSS{ST1}{ST2}{ST3}{ST4}{CR}`
+|# | -\-> | (Subtype 1: Request & Send)
+|==================================================
+
Note: Echo Keisokuki has been dissolved. Some business of the company was taken over by FreqTime Co., Ltd. in July, 2015.
* [[subtype-4]]CITIZEN T.I.C. CO.,LTD. JJY-200 http://www.tic-citizen.co.jp/ (Japanese only)
+
-NTP configuration ( {ntpconf} )::
+NTP configuration ({ntpconf})::
+
--
-refclock jjy unit X subtype 4 time1 0.NNN;;
+`refclock` _jjy_ `unit` _X_ `subtype` _4_ `time1` _0.NNN_;;
--
+
Interface::
@@ -120,12 +126,12 @@ RS-232C, 4800 bps, 8-bits, no parity, 1 stop bit;;
Time code format::
+
-[width="100%",cols="<45%,<10%,<45%",frame="none",grid="none"]
-|======================================
+[width="100%",cols="<25%,<10%,<65%",]
+|==================================================
|Command | -\-> |Reply
-|(Every second)| -\-> |+'XX YY/MM/DD W HH:MM:SS{CR}+
-|======================================
-
+|(Every second)| -\-> |`XX YY/MM/DD W HH:MM:SS{CR}`
+|==================================================
++
* [[subtype-5]]Tristate Ltd. TS-GPSclock-01 https://www.tristate.ne.jp/ (Japanese only)
+
This driver supports the Tristate TS-GPSclock-01 in command/response
@@ -136,35 +142,35 @@ command/response mode and JUST time zone.
Besides this driver, link:driver_nmea.html[the generic NMEA
GPS driver] supports the TS-GPSclock-01 in NMEA mode.
+
-NTP configuration ( {ntpconf} )::
+NTP configuration ({ntpconf})::
+
--
-refclock jjy unit X subtype 5 time1 0.NNN flag1 {0|1};;
- Time1 may specify a constant to be added to the time offset for the
+`refclock` _jjy_ `unit` _X_ `subtype` _5_ `time1` _0.NNN_ `flag1 {0 | 1}`;;
+ `time1` may specify a constant to be added to the time offset for the
time from the receiver, a fixed-point decimal number in seconds. +
- Flag1 has no effect for time synchronization. When a flag1 is set to
- 1, status command is issued before DATE and TIME commands, and write
- a response text into a clockstats file.
+ `flag1` has no effect for time synchronization. When a `flag1` is set to
+ 1, status command is issued before `DATE` and `TIME` commands, and write
+ a response text into a `clockstats` file.
+
[width="100%",cols="<50%,<50%",]
|=========================
-|0 (Default)|STUS command is not issued
-|1 |STUS command is issued
+|0 (Default)|`STUS` command is not issued
+|1 |`STUS` command is issued
|=========================
--
+
Interface::
-USB ( /dev/ttyACM_0_ );;
+USB (/dev/ttyACM_0_);;
Time code format::
+
[width="100%",cols="<25%,<10%,<65%",]
|==================================================
|Command | -\-> |Reply
-|+stus{CR}{LF}+| -\-> |+*R{CR}{LF} \| *G{CR}{LF} \| *U{CR}{LF} \| +U{CR}{LF}+
-|+time{CR}{LF}+| -\-> |+HH:MM:SS{CR}{LF}+
-|+date{CR}{LF}+| -\-> |+YYYY/MM/DD{CR}{LF}+
-|+time{CR}{LF}+| -\-> |+HH:MM:SS{CR}{LF}+
+|`stus{CR}{LF}`| -\-> |`*R{CR}{LF} \| *G{CR}{LF} \| *U{CR}{LF} \| +U{CR}{LF}`
+|`time{CR}{LF}`| -\-> |`HH:MM:SS{CR}{LF}`
+|`date{CR}{LF}`| -\-> |`YYYY/MM/DD{CR}{LF}`
+|`time{CR}{LF}`| -\-> |`HH:MM:SS{CR}{LF}`
|==================================================
+
The date and time are requested separately. The time is requested
@@ -176,10 +182,10 @@ whether it's before or after midnight.
The TDC-300 must be set to the type 3 data format using the front panel
menu display and the switches.
+
-NTP configuration ( {ntpconf} )::
+NTP configuration ({ntpconf})::
+
--
-refclock jjy unit X subtype 6 time1 0.NNN;;
+`refclock` _jjy_ `unit` _X_ `subtype` _6_ `time1` _0.NNN_;;
--
+
Interface::
@@ -187,13 +193,13 @@ RS-232C, 2400 bps, 8-bits, no parity, 1 stop bit;;
Time code format::
+
-[width="100%",cols="<45%,<10%,<45%",frame="none",grid="none"]
-|============================================================================
-|Command | -\-> |Reply
-| | |+{STX}YYMMDDWHHMMSS{ETX}+
-|( 5 to 10 mSec. before second )| |+{STX}{xE5}{ETX}+
-|============================================================================
-
+[width="100%",cols="<25%,<10%,<65%",]
+|==================================================
+|Command | -\-> |Reply
+| | -\-> |`{STX}YYMMDDWHHMMSS{ETX}`
+|(5 to 10 mSec. before second)| -\-> |`{STX}{xE5}{ETX}`
+|==================================================
++
* [[subtype-100]]Telephone JJY http://jjy.nict.go.jp/ (English and Japanese)
+
The telephone JJY is the time service through a public telephone line. +
@@ -201,19 +207,19 @@ The service is provided by the National Institute of Information and
Communications Technology in Japan.
+
ATTENTION; This subtype, the telephone JJY, can not be used with the
-refclock_modem driver at the same time. Because the "phone"
+refclock_modem driver at the same time. Because the `phone`
statement in the configuration file is not involved with the
-"server" statement, so the both the refclock_modem and this
-refclock_jjy ( subtype 100 to 180 ) can not recognize the
-appropriate "phone" statement among the "phone" statements.
+`server` statement, so the both the refclock_modem and this
+refclock_jjy (subtype 100 to 180) can not recognize the
+appropriate `phone` statement among the `phone` statements.
+
-NTP configuration ( {ntpconf} )::
+NTP configuration ({ntpconf})::
+
--
-refclock jjy unit X subtype (100, 101 to 180) minpoll N (N >= 8);;
+`refclock` _jjy_ `unit` _X_ `subtype` _(100, 101 to 180)_ `minpoll` _N (N >= 8)_;;
The subtype 100 is specified, this driver does not issue the loopback
command in order to measure the delay, and the delay of the
- telephone line and the system processing is not adjusted.
+ telephone line and the system processing is not adjusted.
+
The subtype 101 to 180 is specified, this driver issues the loopback
command and measures the delay of the telephone line and the system
@@ -222,66 +228,66 @@ processing through the Telephone JJY loopback circuit.
The round trip time through the Telephone JJY loopback circuit is
measured 5 times, and each delay time is greater than 700
milliseconds, that delay time is ignored during average delay time
-calculation. Also, if the valid delay time ( <= 700 mS. ) is
+calculation. Also, if the valid delay time (<= 700 ms) is
measured more than 3 times, the maximum delay time among the valid
delay times is ignored, and if the valid delay time is measured more
than 4 times, the minimum delay time among them is ignored, like
marking/grading sports judgment.
+
-The adjustment time is calculated by the formula, multiply ( the
-measured round trip time ) by ( ( the subtype number ) - 100 ) %,
+The adjustment time is calculated by the formula, multiply (the
+measured round trip time) by ((the subtype number) - 100) %,
and the adjustment delay time is added to the synchronizing time.
+
If you choose the automatic delay adjustment, in other words, the subtype
101 to 180 is specified, the recommended subtype number is 145 to 165.
+
-The default polling interval 6 ( 64 seconds ) is too short for this
-subtype. The "minpoll" should be set to greater than or equal to 8 ( 256
-seconds, about 4 minutes ).
+The default polling interval 6 (64 seconds) is too short for this
+subtype. The `minpoll` should be set to greater than or equal to 8 (256
+seconds, about 4 minutes).
+
The interval time is given the value in second power of 2. The
-minpoll value 12 is 4096 seconds interval ( about 1 hour ), 14 is
-16384 seconds interval ( about 4.5 hours ), 16 is 65536 seconds (
-about 18 hours ), respectively.
+minpoll value 12 is 4096 seconds interval (about 1 hour), 14 is
+16384 seconds interval (about 4.5 hours), 16 is 65536 seconds (about
+18 hours), respectively.
-flag1 {0|1} flag2 {0|1} flag3 {0|1} flag4 {0|1};;
- Time1 may specify a constant to be added to the time offset for
+`flag1 {0 | 1}` `flag2` _{0|1}_ `flag3` _{0|1}_ `flag4` _{0|1}_;;
+ `time1` may specify a constant to be added to the time offset for
the time from the receiver, a fixed-point decimal number in
- seconds. When the subtype 100 is specified, the time1 may be
+ seconds. When the subtype 100 is specified, the `time1` may be
specified in order to adjust the time offset. When the subtype 101
- to 180 is specified, the time1 should not be specified because
+ to 180 is specified, the `time1` should not be specified because
this driver adds some percentage of the measured loopback delay,
depending on the value of the subtype number.
+
.Flag1 is the modem dialing type
[width="100%",cols="<34%,<33%,<33%",]
|=================================
-|0 (Default)|Tone |ATDWTnn...nn
-|1 |Pulse|ATDWPnn...nn
+|0 (Default)|Tone |`ATDWTnn...nn`
+|1 |Pulse|`ATDWPnn...nn`
|=================================
+
.Flag2 is the modem error correction type.
[width="100%",cols="<34%,<33%,<33%",]
|=======================================
-|0 (Default)|Normal |AT\N0
-|1 |Auto V42, MNP, Normal|AT\N3
+|0 (Default)|Normal |`AT\N0`
+|1 |Auto V42, MNP, Normal|`AT\N3`
|=======================================
+
.Flag3 is the modem speaker switch.
[width="100%",cols="<34%,<33%,<33%",]
|=======================================
-|0 (Default)|Off |ATM0Ln
-|1 |On |ATM2Ln
+|0 (Default)|Off |`ATM0Ln`
+|1 |On |`ATM2Ln`
|=======================================
+
.Flag4 is the modem speaker volume.
[width="100%",cols="<34%,<33%,<33%",]
|=======================================
-|0 (Default) |Low |ATMnL1
-|1 |Middle |ATMnL2
+|0 (Default) |Low |`ATMnL1`
+|1 |Middle |`ATMnL2`
|=======================================
-phone 042NNNNNNN;;
+`phone` _042NNNNNNN_;;
The phone number is available at http://jjy.nict.go.jp/time/teljjy (Japanese and English) +
The number of digits of the phone number is checked. If the
international access number and the country number are added in
@@ -292,7 +298,7 @@ The first 2 or 3 digits are checked. The emergency service number
and the special service number in Japan are not allowed.
+
Calling from extension line, the number for an outside line should
-be prefix "0," ( Zero, Comma ). The prefix is also checked, and no
+be prefix "0," (Zero, Comma). The prefix is also checked, and no
other outside access number is allowed.
--
+
@@ -304,18 +310,19 @@ Modem control commands:;;
Time code format::
+
-----------------------------------------------------------------
-Prompt --> Command --> Reply
-Name{SP}?{SP} --> TJJY{CR} --> Welcome messages
-> --> LOOP{CR} --> ( Switch to the loopback circuit )
- ( One char. ) --> ( One char. )
- COM{CR} --> ( Exit from the loopback circuit )
-> --> TIME{CR} --> HHMMSS{CR}HHMMSS{CR}HHMMSS{CR} 3 times on second
-> --> 4DATE{CR} --> YYYYMMDD{CR}
-> --> LEAPSEC{CR} --> {SP}0{CR} | +1{CR} | -1{CR}
-> --> TIME{CR} --> HHMMSS{CR}HHMMSS{CR}HHMMSS{CR} 3 times on second
-> --> BYE{CR} --> Sayounara messages
-----------------------------------------------------------------
+[width="100%",cols="<15%,<10%,<15%,<10%,<50%",]
+|==================================================
+|Prompt | -\-> |Command | -\-> |Reply
+|`Name{SP}?{SP}`| -\-> |`TJJY{CR}` | -\-> |Welcome messages
+|> | -\-> |`LOOP{CR}` | -\-> |(Switch to the loopback circuit)
+| | -\-> |(One char.) | -\-> |(One char.)
+| | -\-> |`COM{CR}` | -\-> |(Exit from the loopback circuit)
+|> | -\-> |`TIME{CR}` | -\-> |`HHMMSS{CR}HHMMSS{CR}HHMMSS{CR}` 3 times on second
+|> | -\-> |`4DATE{CR}` | -\-> |`YYYYMMDD{CR}`
+|> | -\-> |`LEAPSEC{CR}`| -\-> |`{SP}0{CR}` \| `+1{CR}` \| `-1{CR}`
+|> | -\-> |`TIME{CR}` | -\-> |`HHMMSS{CR}HHMMSS{CR}HHMMSS{CR}` 3 times on second
+|> | -\-> |`BYE{CR}` | -\-> |Sayounara messages
+|==================================================
+
The date and time are requested separately. The time is requested
before and after the date request to check uncertainty of the date
@@ -360,11 +367,11 @@ filegen clockstats file clockstats type day enable
.Mark of the clockstats record
[width="100%",cols="<50%,<50%",]
|============================================================
-|+JJY+ | Information message ( This refclock starts or stops. )
+|+JJY+ | Information message (This refclock starts or stops.)
|+-->+ | Sent data
|+<--+ | Received data
|+---+ | Information message
-|+===+ | Information message ( Start of each polling, and sync. time. )
+|+===+ | Information message (Start of each polling, and sync. time.)
|+-W-+ | Warning message
|+-X-+ | Error message
|============================================================
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/fbde514d1db5bd0e8297caf71602b4324214c7ed
--
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/fbde514d1db5bd0e8297caf71602b4324214c7ed
You're receiving this email because of your account on gitlab.com.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ntpsec.org/pipermail/vc/attachments/20191230/55cbd881/attachment-0001.htm>
More information about the vc
mailing list